From: Jason Edgecombe Date: Sat, 18 Aug 2007 00:35:44 +0000 (+0000) Subject: man-page-updates-20070817 X-Git-Tag: BP-openafs-windows-kdfs-ifs~554 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=87efbab4e8c0dc37c1938503eea88f7f319b7e5d;p=packages%2Fo%2Fopenafs.git man-page-updates-20070817 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. --- diff --git a/doc/man-pages/README b/doc/man-pages/README index 9d39703f8..258410723 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -205,10 +205,6 @@ Known Problems fs rxstatproc fs setcbaddr kseal - pts interactive - pts quit - pts sleep - pts source read_tape restorevol rmtsysd diff --git a/doc/man-pages/pod1/fs_getcrypt.pod b/doc/man-pages/pod1/fs_getcrypt.pod index 1b33bc2d7..a1402f5aa 100644 --- a/doc/man-pages/pod1/fs_getcrypt.pod +++ b/doc/man-pages/pod1/fs_getcrypt.pod @@ -58,8 +58,6 @@ There is only one way to invoke B: % fs getcrypt -=back - =head1 PRIVILEGE REQUIRED No special priviledges are required for this command. diff --git a/doc/man-pages/pod1/fs_listaliases.pod b/doc/man-pages/pod1/fs_listaliases.pod index bb1ec4519..225aa42bf 100644 --- a/doc/man-pages/pod1/fs_listaliases.pod +++ b/doc/man-pages/pod1/fs_listaliases.pod @@ -43,8 +43,6 @@ There is only one way to invoke B: % fs listaliases -=back - =head1 PRIVILEGE REQUIRED No special priviledges are required for this command. diff --git a/doc/man-pages/pod1/pts.pod b/doc/man-pages/pod1/pts.pod index 8c31340e7..476117485 100644 --- a/doc/man-pages/pod1/pts.pod +++ b/doc/man-pages/pod1/pts.pod @@ -52,6 +52,15 @@ and groups: B and B. =item * +Commands to run commands interactively: B, B, and B. + +=item * + +A command to run commands from a file: B. + +=item * + Commands to obtain help: B and B. =back @@ -136,14 +145,18 @@ L, L, L, L, +L, L, L, L, L, +L, L, L, L, -L +L, +L, +L =head1 COPYRIGHT diff --git a/doc/man-pages/pod1/pts_interactive.pod b/doc/man-pages/pod1/pts_interactive.pod new file mode 100644 index 000000000..9d6257246 --- /dev/null +++ b/doc/man-pages/pod1/pts_interactive.pod @@ -0,0 +1,119 @@ +=head1 NAME + +pts interactive - Enters interactive mode + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-cell>] > >>> [B<-noauth>] + [B<-force>] + +B S<<< [B<-c>] > >>> [B<-n>] [B<-f>] + +=for html +
+ +=head1 DESCRIPTION + +The B command allows the user to enter an interactive +mode, useful for running bulk commands like creating new users or groups. + +=head1 CAUTIONS + +Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B 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. + +Running bulk B commands may degrade the performance of the Protection +Server while they are run and server resources may not be released +immediately after commands are run. The B command can be used +in interactive mode or with B to give the Protection Server a +change to catch up. + +=head1 OPTIONS + +B only takes the standard B options. + +=over 4 + +=item B<-cell> > + +Names the cell in which to run the command. For more details, see +L. + +=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. +This is useful for bulk operations where you would like to continue even +if one of many operations fails. + +=item B<-noauth> + +Assigns the unprivileged identity anonymous to the issuer. For more +details, see L. + +=back + +=head1 OUTPUT + +The output is the same as if each individual command were run from the +command line. + +=head1 EXAMPLES + +Here is an example of a B session: + + % pts interactive + pts> examine admin + Name: admin, id: 1, owner: system:administrators, creator: anonymous, + membership: 2, flags: S----, group quota: 20. + pts> help + pts: Commands are: + adduser add a user to a group + apropos search by help text + chown change ownership of a group + creategroup create a new group + createuser create a new user + delete delete a user or group from database + examine examine an entry + help get help on commands + interactive enter interactive mode + listentries list users/groups in the protection database + listmax list max id + listowned list groups owned by an entry or zero id gets orphaned groups + membership list membership of a user or group + quit exit program + removeuser remove a user from a group + rename rename user or group + setfields set fields for an entry + setmax set max id + sleep pause for a bit + source read commands from file + pts> quit + % + +=head1 PRIVILEGE REQUIRED + +The same privilege is required to run the command in interactive mode as +is required to run the command by itself on the command line. Some +commands such as B require that the user belong to the +system:administrators group, while others do not. + +=head1 SEE ALSO + +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/pts_quit.pod b/doc/man-pages/pod1/pts_quit.pod new file mode 100644 index 000000000..4f8abfa2e --- /dev/null +++ b/doc/man-pages/pod1/pts_quit.pod @@ -0,0 +1,76 @@ +=head1 NAME + +pts quit - Exit from pts interactive mode + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-cell>] > >>> [B<-noauth>] [B<-force>] + +B S<<< [B<-c>] > >>> [B<-n>] [B<-f>] + +=for html +
+ +=head1 DESCRIPTION + +The B command exits from B 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 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 takes the following standard +B options: + +=over 4 + +=item B<-cell> > + +Names the cell in which to run the command. For more details, see +L. + +=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. + +=back + +=head1 OUTPUT + +This command produces no output. + +=head1 EXAMPLES + +Here is an example of a B session: + + % pts interactive + pts> quit + % + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/pts_sleep.pod b/doc/man-pages/pod1/pts_sleep.pod new file mode 100644 index 000000000..23db3b547 --- /dev/null +++ b/doc/man-pages/pod1/pts_sleep.pod @@ -0,0 +1,81 @@ +=head1 NAME + +pts sleep - Pauses for a few seconds + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-delay>] > >>> + S<<< [B<-cell>] > >>> [B<-noauth>] [B<-force>] + +B S<<< [B<-d>] > >>> S<<< [B<-c>] > >>> + [B<-n>] [B<-f>] + +=for html +
+ +=head1 DESCRIPTION + +The B pauses for a specified number of seconds. The command can +be run from the command line or interactively, although from the command +line it's essentially equivalent to the B command. It is intended +for use in interactive mode to pause for a few seconds between batch +commands to allow the Protection Server to catch up. + +=head1 CAUTIONS + +Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B 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 takes the following standard +B options: + +=over 4 + +=item B<-cell> > + +Names the cell in which to run the command. For more details, see +L. + +=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. + +=back + +=head1 OUTPUT + +This command produces no output. + +=head1 EXAMPLES + +Here is an example of a B session: + + % pts interactive + pts> sleep 5 + pts> quit + % + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/pts_source.pod b/doc/man-pages/pod1/pts_source.pod new file mode 100644 index 000000000..a03b431f7 --- /dev/null +++ b/doc/man-pages/pod1/pts_source.pod @@ -0,0 +1,86 @@ +=head1 NAME + +pts source - Read pts commands from a file + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-file>] > >>> S<<< [B<-cell>] > >>> + [B<-noauth>] [B<-force>] + +B S<<< [B<-f>] > >>> S<<< [B<-c>] > >>> + [B<-n>] [B<-f>] + +=for html +
+ +=head1 DESCRIPTION + +The B runs commands from a file as if they were typed in B 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 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 takes the following options: + +=over 4 + +=item B<-cell> > + +Names the cell in which to run the command. For more details, see +L. + +=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. +This is useful for bulk operations where you would like to continue even +if one of many operations fails. + +=item B<-noauth> + +Assigns the unprivileged identity anonymous to the issuer. For more +details, see L. + +=back + +=head1 OUTPUT + +This command shows the output of each comand in the file as if it were +run normally. + +=head1 EXAMPLES + +Here is an example of using B in a B 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, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/vos_backupsys.pod b/doc/man-pages/pod1/vos_backupsys.pod index cea4a3068..e430f6d26 100644 --- a/doc/man-pages/pod1/vos_backupsys.pod +++ b/doc/man-pages/pod1/vos_backupsys.pod @@ -109,7 +109,7 @@ volumes that have the string C 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 diff --git a/doc/man-pages/pod1/vos_size.pod b/doc/man-pages/pod1/vos_size.pod index 702074486..8465d9ff9 100644 --- a/doc/man-pages/pod1/vos_size.pod +++ b/doc/man-pages/pod1/vos_size.pod @@ -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 file on the