From 53a50414c23dd8b045eca6b58d4be13707f2f36d Mon Sep 17 00:00:00 2001 From: Andrew Deason Date: Thu, 7 Nov 2013 00:05:39 -0600 Subject: [PATCH] doc: backup manpage fixes - Consistently specify -dryrun and -n across various subcommands. Many did not list -n, some listed -n but no -dryrun, and some listed -noexecute instead. - backup_volrestore: Add missing option -usedump - backup_deletedump: Add missing options -groupid, -dbonly, -force, and -portoffset Change-Id: Iec1c36cba0ad0e61d7e6215c9cba81228b95a81f Reviewed-on: http://gerrit.openafs.org/10441 Tested-by: BuildBot Reviewed-by: Derrick Brashear --- doc/man-pages/pod8/backup_deletedump.pod | 34 +++++++++++++++++++-- doc/man-pages/pod8/backup_diskrestore.pod | 6 ++-- doc/man-pages/pod8/backup_dump.pod | 16 +++++----- doc/man-pages/pod8/backup_volrestore.pod | 12 ++++++-- doc/man-pages/pod8/backup_volsetrestore.pod | 6 ++-- 5 files changed, 55 insertions(+), 19 deletions(-) diff --git a/doc/man-pages/pod8/backup_deletedump.pod b/doc/man-pages/pod8/backup_deletedump.pod index 465ec0e88..551f7fffd 100644 --- a/doc/man-pages/pod8/backup_deletedump.pod +++ b/doc/man-pages/pod8/backup_deletedump.pod @@ -10,9 +10,9 @@ backup_deletedump - Deletes one or more dump records from the Backup Database B S<<< [B<-dumpid> >+] >>> S<<< [B<-from> >+] >>> S<<< [B<-to> >+] >>> - S<<< [B<-port> >] >>> + S<<< [B<-portoffset> >] >>> S<<< [B<-groupid> >] >>> - [B<-dbonly>] [B<-force>] [B<-noexecute>] [B<-localauth>] + [B<-dbonly>] [B<-force>] [B<-dryrun> | B<-n>] [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] @@ -22,6 +22,7 @@ B S<<< [B<-d> >+] >>> S<<< [B<-p> >] >>> S<<< [B<-g> >] >>> [B<-db>] [B<-fo>] [B<-n>] [B<-l>] + [B<-dryrun> | B<-n>] S<<< [B<-c> >] >>> [B<-h>] @@ -124,6 +125,35 @@ B<-from> argument is omitted deletes all dump records from the Backup Database (except for Backup Database dump records created with the B command). +=item B<-groupid> > + +Delete all dumps associated with the given group ID. If B<-from> and B<-to> are +also given, then we only delete dumps that are both a part of this group ID, +and fall within the time range specified by B<-from> and B<-to>. + +=item B<-dbonly> + +If this option is specified, only delete the dump from the budb; do not contact +the Tape Coordinator at all. + +=item B<-force> + +By default, we attempt to delete the specified dumps from the Tape Coordinator +before deleting the dumps from the budb. If the Tape Coordinator operation +fails, then we do not delete the dumps from the budb. If the B<-force> option +is given, we will delete the specified dumps from the budb, even if deleting +the dumps on the Tape Coordinator fails. + +=item B<-portoffset> > + +Specifies the port offset number of the Tape Coordinator to contact for this +operation. + +=item B<-dryrun> | B<-n> + +Prints out information about what actions would be taken to run this command, +but do not actually perform those actions. + =item B<-localauth> Constructs a server ticket using a key from the local diff --git a/doc/man-pages/pod8/backup_diskrestore.pod b/doc/man-pages/pod8/backup_diskrestore.pod index 808a2c7c4..c7620ff3c 100644 --- a/doc/man-pages/pod8/backup_diskrestore.pod +++ b/doc/man-pages/pod8/backup_diskrestore.pod @@ -13,14 +13,14 @@ B S<<< B<-server> > >>> S<<< [B<-newserver> >] >>> S<<< [B<-newpartition> >] >>> S<<< [B<-extension> >] >>> - [B<-dryrun>] [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] + [B<-dryrun> | B<-n>] [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] B S<<< B<-s> > >>> S<<< B<-pa> > >>> S<<< [B<-po> >+] >>> S<<< [B<-news> >] >>> S<<< [B<-newp> >] >>> - S<<< [B<-e> >] >>> [B<-dryrun>] [B<-l>] + S<<< [B<-e> >] >>> [B<-dryrun> | B<-n>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html @@ -179,7 +179,7 @@ name and extension cannot exceed 22 characters in length. To use a period to separate the extension from the name, specify it as the first character of the string (as in C<.rst>, for example). -=item B<-dryrun> +=item B<-dryrun> | B<-n> Displays a list of the tapes necessary to perform the requested restore, without actually performing the operation. diff --git a/doc/man-pages/pod8/backup_dump.pod b/doc/man-pages/pod8/backup_dump.pod index 94a615bde..a5a633bb8 100644 --- a/doc/man-pages/pod8/backup_dump.pod +++ b/doc/man-pages/pod8/backup_dump.pod @@ -11,14 +11,14 @@ B S<<< [B<-volumeset> >] >>> S<<< [B<-dump> >] >>> S<<< [B<-portoffset> >] >>> S<<< [B<-at> >+] >>> - [B<-append>] [B<-n>] + [B<-append>] [B<-dryrun> | B<-n>] S<<< [B<-file> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] B S<<< [B<-v> >] >>> S<<< [B<-d> >] >>> S<<< [B<-p> >] >>> - S<<< [B<-at> >+] >>> [B<-ap>] [B<-n>] + S<<< [B<-at> >+] >>> [B<-ap>] [B<-dryrun> | B<-n>] S<<< [B<-f> >] >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] @@ -110,13 +110,13 @@ To schedule multiple dump operations, list the operations in the file named by the B<-file> argument. Optionally include the B<-at> argument to specify when the B command interpreter reads the file; otherwise it reads it immediately. Do not combine the B<-file> argument with the -command's first three arguments or the B<-append> or B<-n> flags. The +command's first three arguments or the B<-append> or B<-dryrun> flags. The commands in the file can include any of the B command's arguments, including the B<-at> argument to schedule them to run even later in the future. To generate a list of the volumes included in a dump, without actually -dumping them, combine the B<-n> flag with the options to be used on the +dumping them, combine the B<-dryrun> flag with the options to be used on the actual command. =head2 How the Backup System executes a dump operation @@ -381,7 +381,7 @@ dump. If the tape is not the last tape in the dump set, the Tape Coordinator prompts for insertion of the appropriate tape. Do not combine this argument with the B<-file> argument. -=item B<-n> +=item B<-dryrun> | B<-n> Displays the names of volumes to be included in the indicated dump, without actually performing the dump operation. Do not combine this @@ -410,7 +410,7 @@ date and time at which the Backup System reads the file. dump sun4x_55 /sunday1/friday -port 2 -at 04/08/1999 02:00 -append Do not combine this argument with the B<-volumeset>, B<-dump>, -B<-portoffset>, B<-append>, or B<-n> options. +B<-portoffset>, B<-append>, or B<-dryrun> options. =item B<-localauth> @@ -447,7 +447,7 @@ processing: Starting dump. -If the issuer includes the B<-n> flag, the output is of the following +If the issuer includes the B<-dryrun> flag, the output is of the following form: Starting dump of volume set '' (dump set '') @@ -479,7 +479,7 @@ tapes in the device with port offset 5. The following command displays the list of volumes to be dumped when the user dumps the C volume set at the C dump level. - % backup dump -volumeset sys_sun -dump /full -n + % backup dump -volumeset sys_sun -dump /full -dryrun Starting dump of volume set 'sys_sun' (dump set '/full') Total number of volumes: 24 Would have dumped the following volumes: diff --git a/doc/man-pages/pod8/backup_volrestore.pod b/doc/man-pages/pod8/backup_volrestore.pod index 40411588d..76ebb755d 100644 --- a/doc/man-pages/pod8/backup_volrestore.pod +++ b/doc/man-pages/pod8/backup_volrestore.pod @@ -12,7 +12,7 @@ B S<<< B<-server> > >>> S<<< B<-volume> >+ >>> S<<< [B<-extension> >] >>> S<<< [B<-date> >+] >>> - S<<< [B<-portoffset> >+] >>> [B<-dryrun>] + S<<< [B<-portoffset> >+] >>> [B<-dryrun> | B<-n>] S<<< [B<-usedump> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] @@ -23,7 +23,7 @@ B S<<< B<-s> > >>> S<<< [B<-d> >+] >>> S<<< [B<-po> >+] >>> S<<< [B<-u> >] >>> - [B<-dryrun>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] + [B<-dryrun> | B<-n>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html @@ -216,6 +216,12 @@ reduces any later date to the maximum value. If this argument is omitted, the Backup System restores all possible dumps including the most recently created. +=item B<-usedump> > + +Specifies the dumpID of the specific dump to use to restore the volume. If this +option is not specified, we will find the appropriate dump to restore, +according to the logic in the B<-date> option. + =item B<-portoffset> >+ Specifies one or more port offset numbers (up to a maximum of 128), each @@ -230,7 +236,7 @@ Provide this argument unless the default value of 0 (zero) is appropriate for all dumps. If C<0> is just one of the values in the list, provide it explicitly in the appropriate order. -=item B<-dryrun> +=item B<-dryrun> | B<-n> Displays the list of tapes that contain the dumps required by the restore operation, without actually performing the operation. diff --git a/doc/man-pages/pod8/backup_volsetrestore.pod b/doc/man-pages/pod8/backup_volsetrestore.pod index 717638d6d..2589def0e 100644 --- a/doc/man-pages/pod8/backup_volsetrestore.pod +++ b/doc/man-pages/pod8/backup_volsetrestore.pod @@ -10,14 +10,14 @@ backup_volsetrestore - Restores all volumes in a volume set B S<<< [B<-name> >] >>> S<<< [B<-file> >] >>> S<<< [B<-portoffset> >+] >>> - S<<< [B<-extension> >] >>> [B<-dryrun>] + S<<< [B<-extension> >] >>> [B<-dryrun> | B<-n>] [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] B S<<< [B<-na> >] >>> S<<< [B<-f> >] >>> S<<< [B<-p> >+] >>> S<<< [B<-e> >] >>> - [B<-dryrun>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] + [B<-dryrun> | B<-n>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html @@ -225,7 +225,7 @@ Provide this argument unless the default value of 0 (zero) is appropriate for all dumps. If C<0> is just one of the values in the list, provide it explicitly in the appropriate order. -=item B<-dryrun> +=item B<-dryrun> | B<-n> Displays a list of the volumes to be restored if the flag were not included, without actually restoring them. L details the format of -- 2.39.5