mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +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>
66 lines
1.3 KiB
Plaintext
66 lines
1.3 KiB
Plaintext
=head1 NAME
|
|
|
|
pts_quit - Exit from pts interactive mode
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<pts quit> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-localauth>]
|
|
[B<-force>]
|
|
|
|
B<pts q> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-l>] [B<-f>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<pts quit> command exits from B<pts interactive> mode. The command
|
|
can be run from the command line or interactively, but on the command line
|
|
it does nothing and is therefore of questionable utility.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts quit> 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
|
|
|
|
Although they have no effect, B<pts quit> takes the following standard
|
|
B<pts> options:
|
|
|
|
=over 4
|
|
|
|
=include fragments/pts-common.pod
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
This command produces no output.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Here is an example of a B<pts interactive> session:
|
|
|
|
% pts interactive
|
|
pts> quit
|
|
%
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<pts(1)>,
|
|
L<pts_interactive(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.
|