openafs/doc/man-pages/pod1/pts_quit.pod.in
Andrew Deason f69bf0b194 doc: pts manpage fixes
- Mention the -help, -auth, -encrypt, and -config options for all pts
   commands in their synopsis

 - Add the -auth option to the pts.pod page

 - Reference the -auth, -encrypt, and -config options from all
   subcommand pts pages

 - pts_removeuser: Replace -name with -user

 - pts_sleep: Add missing -delay

 - pts_source: Add missing -file

Change-Id: I4f0889d661c46f6bdd2a9604d8423d809a632d2d
Reviewed-on: http://gerrit.openafs.org/10387
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
2013-11-03 20:36:16 -08:00

68 lines
1.5 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<-help>] [B<-auth>] [B<-encrypt>]
S<<< [B<-config> <I<config directory>>] >>>
B<pts q> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
[B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
=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.