DEVEL15-man-page-updates-20070817
authorJason Edgecombe <jason@rampaginggeek.com>
Sat, 18 Aug 2007 02:46:24 +0000 (02:46 +0000)
committerRuss Allbery <rra@stanford.edu>
Sat, 18 Aug 2007 02:46:24 +0000 (02:46 +0000)
Add new man pages for pts interactive, quit, sleep, and source.  Fix POD
errors in a few other man pages and update the to-do list in README.

(cherry picked from commit 87efbab4e8c0dc37c1938503eea88f7f319b7e5d)

doc/man-pages/README
doc/man-pages/pod1/fs_getcrypt.pod
doc/man-pages/pod1/fs_listaliases.pod
doc/man-pages/pod1/pts.pod
doc/man-pages/pod1/pts_quit.pod [new file with mode: 0644]
doc/man-pages/pod1/vos_backupsys.pod
doc/man-pages/pod1/vos_size.pod

index bbe7ffa..3704e6c 100644 (file)
@@ -205,10 +205,6 @@ Known Problems
        fs rxstatproc
        fs setcbaddr
        kseal
-       pts interactive
-       pts quit
-       pts sleep
-       pts source
        read_tape
        restorevol
        rmtsysd
index 1b33bc2..a1402f5 100644 (file)
@@ -58,8 +58,6 @@ There is only one way to invoke B<fs getcrypt>:
 
    % fs getcrypt
 
-=back
-
 =head1 PRIVILEGE REQUIRED
 
 No special priviledges are required for this command.
index bb1ec45..225aa42 100644 (file)
@@ -43,8 +43,6 @@ There is only one way to invoke B<fs listaliases>:
 
    % fs listaliases
 
-=back
-
 =head1 PRIVILEGE REQUIRED
 
 No special priviledges are required for this command.
index 8c31340..4761174 100644 (file)
@@ -52,6 +52,15 @@ and groups: B<pts listmax> and B<pts setmax>.
 
 =item *
 
+Commands to run commands interactively: B<pts interactive>, B<pts
+sleep>, and B<pts quit>.
+
+=item *
+
+A command to run commands from a file: B<pts source>.
+
+=item *
+
 Commands to obtain help: B<pts apropos> and B<pts help>.
 
 =back
@@ -136,14 +145,18 @@ L<pts_createuser(1)>,
 L<pts_delete(1)>,
 L<pts_examine(1)>,
 L<pts_help(1)>,
+L<pts_interactive(1)>,
 L<pts_listentries(1)>,
 L<pts_listmax(1)>,
 L<pts_listowned(1)>,
 L<pts_membership(1)>,
+L<pts_quit(1)>,
 L<pts_removeuser(1)>,
 L<pts_rename(1)>,
 L<pts_setfields(1)>,
-L<pts_setmax(1)>
+L<pts_setmax(1)>,
+L<pts_sleep(1)>,
+L<pts_source(1)>
 
 =head1 COPYRIGHT
 
diff --git a/doc/man-pages/pod1/pts_quit.pod b/doc/man-pages/pod1/pts_quit.pod
new file mode 100644 (file)
index 0000000..4f8abfa
--- /dev/null
@@ -0,0 +1,76 @@
+=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<-force>]
+
+B<pts q> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [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
+
+=item B<-cell> <I<cell name>>
+
+Names the cell in which to run the command. For more details, see
+L<pts(1)>.
+
+=item B<-force>
+
+Enables the command to continue executing as far as possible when errors
+or other problems occur, rather than halting execution at the first error.
+
+=item B<-noauth>
+
+Assigns the unprivileged identity anonymous to the issuer. For more
+details, see L<pts(1)>.
+
+=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 IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.
index cea4a30..e430f6d 100644 (file)
@@ -109,7 +109,7 @@ volumes that have the string C<aix> anywhere in their names:
 
    -prefix  '^.*aix'
 
-=back 4
+=back
 
 To display a list of the volumes to be cloned, without actually cloning
 them, include the B<-dryrun> flag. To display a statement that summarizes
index 7020744..8465d9f 100644 (file)
@@ -125,8 +125,6 @@ Sizing an incremental dump for the same volume:
    Volume: user.thoron
    dump_size: 21095
 
-=back
-
 =head1 PRIVILEGE REQUIRED
 
 The issuer must be listed in the F</usr/afs/etc/UserList> file on the