mirror of
https://git.openafs.org/openafs.git
synced 2025-01-20 07:51:00 +00:00
a792acdadc
Add a preprocessor for POD documentation that handles a custom =include directive. Demonstrate how to use the preprocessor by factoring out all the standard PTS options into a separate POD fragment and including that fragment in all the PTS commands that take the standard options instead of including that documentation in each separate file. Change-Id: If5255efc6d3fc670b38a9898b3d7d3c60af04fcf Reviewed-on: http://gerrit.openafs.org/2440 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
73 lines
1.6 KiB
Plaintext
73 lines
1.6 KiB
Plaintext
=head1 NAME
|
|
|
|
pts_source - Read pts commands from a file
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<pts source> S<<< [B<-file>] <I<file name>> >>> S<<< [B<-cell>] <I<cell name>> >>>
|
|
[B<-noauth>] [B<-localauth>] [B<-force>]
|
|
|
|
B<pts so> S<<< [B<-f>] <I<file name>> >>> S<<< [B<-c>] <I<cell name>> >>>
|
|
[B<-n>] [B<-l>] [B<-f>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<pts source> runs commands from a file as if they were typed in B<pts
|
|
interactive> mode. The command can be run from the command line or
|
|
interactively.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts source> command was
|
|
only available on Unix or Linux and when OpenAFS was compiled with the
|
|
supergroups option (disabled by default). As of OpenAFS 1.4.5 and 1.5.23,
|
|
it is always available.
|
|
|
|
=head1 OPTIONS
|
|
|
|
B<pts source> takes the following options:
|
|
|
|
=over 4
|
|
|
|
=include fragments/pts-common.pod
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
This command shows the output of each command in the file as if it were
|
|
run normally.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Here is an example of using B<pts source> in a B<pts interactive> session:
|
|
|
|
% echo examine admin > /tmp/commands.txt
|
|
% pts interactive
|
|
pts> source /tmp/commands.txt
|
|
Name: admin, id: 1, owner: system:administrators, creator: anonymous,
|
|
membership: 2, flags: S----, group quota: 20.
|
|
pts> quit
|
|
%
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<pts(1)>,
|
|
L<pts_interactive(1)>,
|
|
L<pts_quit(1)>,
|
|
L<pts_sleep(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
|
|
|
|
This documentation is covered by the BSD License as written in the
|
|
doc/LICENSE file. This man page was written by Jason Edgecombe for
|
|
OpenAFS.
|