Update backup suite manpages
authorDavor Ocelic <docelic@spinlocksolutions.com>
Thu, 8 Oct 2009 21:01:39 +0000 (23:01 +0200)
committerJeffrey Altman <jaltman|account-1000011@unknown>
Thu, 8 Oct 2009 22:40:35 +0000 (15:40 -0700)
 -- Add missing POD links (L<>)

 -- Verify all subcommands and options

 -- Format > 80 columns synopsis lines

Reviewed-on: http://gerrit.openafs.org/617
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>

20 files changed:
doc/man-pages/pod8/backup.pod
doc/man-pages/pod8/backup_addhost.pod
doc/man-pages/pod8/backup_addvolentry.pod
doc/man-pages/pod8/backup_dbverify.pod
doc/man-pages/pod8/backup_deletedump.pod
doc/man-pages/pod8/backup_delhost.pod
doc/man-pages/pod8/backup_delvolentry.pod
doc/man-pages/pod8/backup_diskrestore.pod
doc/man-pages/pod8/backup_dump.pod
doc/man-pages/pod8/backup_help.pod
doc/man-pages/pod8/backup_kill.pod
doc/man-pages/pod8/backup_labeltape.pod
doc/man-pages/pod8/backup_readlabel.pod
doc/man-pages/pod8/backup_restoredb.pod
doc/man-pages/pod8/backup_savedb.pod
doc/man-pages/pod8/backup_setexp.pod
doc/man-pages/pod8/backup_status.pod
doc/man-pages/pod8/backup_volinfo.pod
doc/man-pages/pod8/backup_volrestore.pod
doc/man-pages/pod8/backup_volsetrestore.pod

index c199d90..4cb65af 100644 (file)
@@ -13,42 +13,64 @@ commands in the suite:
 =item *
 
 Commands to copy data from AFS volumes to tape or a backup data file, and
-to restore it to the file system: B<backup diskrestore>, B<backup dump>,
-B<backup volrestore>, and B<backup volsetrestore>.
+to restore it to the file system:
+L<B<backup diskrestore>|backup_diskrestore(8)>,
+L<B<backup dump>|backup_dump(8)>,
+L<B<backup volrestore>|backup_volrestore(8)>,
+and L<B<backup volsetrestore>|backup_volsetrestore(8)>.
 
 =item *
 
-Commands to administer the records in the Backup Database: B<backup
-adddump>, B<backup addhost>, B<backup addvolentry>, B<backup addvolset>,
-B<backup deldump>, B<backup deletedump>, B<backup delhost>, B<backup
-delvolentry>, B<backup delvolset>, B<backup dumpinfo>, B<backup
-listdumps>, B<backup listhosts>, B<backup listvolsets>, B<backup
-scantape>, B<backup setexp>, and B<backup volinfo>.
+Commands to administer the records in the Backup Database:
+L<B<backup adddump>|backup_adddump(8)>,
+L<B<backup addhost>|backup_addhost(8)>,
+L<B<backup addvolentry>|backup_addvolentry(8)>,
+L<B<backup addvolset>|backup_addvolset(8)>,
+L<B<backup deldump>|backup_deldump(8)>,
+L<B<backup deletedump>|backup_deletedump(8)>,
+L<B<backup delhost>|backup_delhost(8)>,
+L<B<backup delvolentry>|backup_delvolentry(8)>,
+L<B<backup delvolset>|backup_delvolset(8)>,
+L<B<backup dumpinfo>|backup_dumpinfo(8)>,
+L<B<backup listdumps>|backup_listdumps(8)>,
+L<B<backup listhosts>|backup_listhosts(8)>,
+L<B<backup listvolsets>|backup_listvolsets(8)>,
+L<B<backup scantape>|backup_scantape(8)>,
+L<B<backup setexp>|backup_setexp(8)>,
+and L<B<backup volinfo>|backup_volinfo(8)>.
 
 =item *
 
-Commands to write and read tape labels: B<backup labeltape> and B<backup
-readlabel>.
+Commands to write and read tape labels:
+L<B<backup labeltape>|backup_labeltape(8)>
+and L<B<backup readlabel>|backup_readlabel(8)>.
 
 =item *
 
 Commands to list and change the status of backup operations and the
-machines performing them: B<backup jobs>, B<backup kill>, and B<backup
-status>.
+machines performing them:
+L<B<backup jobs>|backup_jobs(8)>,
+L<B<backup kill>|backup_kill(8)>,
+and L<B<backup status>|backup_status(8)>.
 
 =item *
 
-Commands to enter and leave interactive mode: B<backup interactive> and
-B<backup quit>.
+Commands to enter and leave interactive mode:
+L<B<backup interactive>|backup_interactive(8)>
+and L<B<backup quit>|backup_quit(8)>.
 
 =item *
 
 Commands to check for and repair corruption in the Backup Database:
-B<backup dbverify>, B<backup restoredb>, and B<backup savedb>.
+L<B<backup dbverify>|backup_dbverify(8)>,
+L<B<backup restoredb>|backup_restoredb(8)>,
+and L<B<backup savedb>|backup_savedb(8)>.
 
 =item *
 
-Commands to obtain help: B<backup apropos> and B<backup help>.
+Commands to obtain help:
+L<B<backup apropos>|backup_apropos(8)>
+and L<B<backup help>|backup_help(8)>.
 
 =back
 
@@ -86,8 +108,10 @@ information used to automate its operation.
 In addition to the standard command line interface, the B<backup> command
 suite provides an I<interactive> interface, which has several useful
 features described in L<backup_interactive(8)>.  Three of the commands in
-the suite are available only in interactive mode: B<backup jobs>, B<backup
-kill>, and B<backup quit>.
+the suite are available only in interactive mode:
+L<B<backup jobs>|backup_jobs(8)>,
+L<B<backup kill>|backup_kill(8)>,
+and L<B<backup quit>|backup_quit(8)>
 
 =head1 OPTIONS
 
@@ -209,8 +233,10 @@ simultaneously is 64.
 
 The maximum number of tape devices that can work together on a restore
 operation is 128 (that is the maximum number of values that can be
-provided for the B<-portoffset> argument to the B<backup diskrestore>,
-B<backup volrestore>, or B<backup volsetrestore> command).
+provided for the B<-portoffset> argument to the
+L<B<backup diskrestore>|backup_diskrestore(8)>,
+L<B<backup volrestore>|backup_volrestore(8)>,
+or L<B<backup volsetrestore>|backup_volsetrestore(8)> command).
 
 =back
 
@@ -254,6 +280,7 @@ L<backup_adddump(8)>,
 L<backup_addhost(8)>,
 L<backup_addvolentry(8)>,
 L<backup_addvolset(8)>,
+L<backup_apropos(8)>,
 L<backup_dbverify(8)>,
 L<backup_deldump(8)>,
 L<backup_deletedump(8)>,
index aa3e26a..e237bed 100644 (file)
@@ -11,7 +11,8 @@ B<backup addhost> S<<< B<-tapehost> <I<tape machine name>> >>>
     S<<< [B<-portoffset> <I<TC port offset>>] >>>
     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup addh> S<<< B<-t> <I<tape machine name>> >>> S<<< [B<-p> <I<TC port offset>>] >>>
+B<backup addh> S<<< B<-t> <I<tape machine name>> >>>
+    S<<< [B<-p> <I<TC port offset>>] >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index ccf1d6f..7373d6b 100644 (file)
@@ -8,12 +8,15 @@ backup_addvolentry - Defines a volume entry in a volume set
 <div class="synopsis">
 
 B<backup addvolentry> S<<< B<-name> <I<volume set name>> >>>
-    S<<< B<-server> <I<machine name>> >>> S<<< B<-partition> <I<partition name>> >>>
+    S<<< B<-server> <I<machine name>> >>>
+    S<<< B<-partition> <I<partition name>> >>>
     S<<< B<-volumes> <I<volume name (regular expression)>> >>>
     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup addvole> S<<< B<-n> <I<volume set name>> >>> S<<< B<-s> <I<machine name>> >>>
-    S<<< B<-p> <I<partition name>> >>> S<<< B<-v> <I<volume name (regular expression)>> >>>
+B<backup addvole> S<<< B<-n> <I<volume set name>> >>>
+    S<<< B<-s> <I<machine name>> >>>
+    S<<< B<-p> <I<partition name>> >>>
+    S<<< B<-v> <I<volume name (regular expression)>> >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index 0ec5db3..1592a23 100644 (file)
@@ -7,7 +7,8 @@ backup_dbverify - Checks the integrity of the Backup Database
 =for html
 <div class="synopsis">
 
-B<backup dbverify> [B<-detail>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>>
+B<backup dbverify> [B<-detail>] [B<-localauth>]
+    S<<< [B<-cell> <I<cell name>>] >>>
     [B<-help>]
 
 B<backup db> [B<-d>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
index adc78e8..465ec0e 100644 (file)
@@ -7,12 +7,23 @@ backup_deletedump - Deletes one or more dump records from the Backup Database
 =for html
 <div class="synopsis">
 
-B<backup deletedump> S<<< [B<-dumpid> <I<dump id>>+] >>> S<<< [B<-from> <I<date time>>+] >>>
-    S<<< [B<-to> <I<date time>>+] >>> [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>>
+B<backup deletedump> S<<< [B<-dumpid> <I<dump id>>+] >>>
+    S<<< [B<-from> <I<date time>>+] >>>
+    S<<< [B<-to> <I<date time>>+] >>>
+    S<<< [B<-port> <I<TC port offset>>] >>>
+    S<<< [B<-groupid> <I<group ID>>] >>>
+    [B<-dbonly>] [B<-force>] [B<-noexecute>] [B<-localauth>]
+    S<<< [B<-cell> <I<cell name>>] >>>
     [B<-help>]
 
-B<backup dele> S<<< [B<-d> <I<dump id>>+] >>> S<<< [B<-f> <I<date time>>+] >>>
-    [-t <I<date time>>+] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
+B<backup dele> S<<< [B<-d> <I<dump id>>+] >>>
+    S<<< [B<-fr> <I<date time>>+] >>>
+    [-t <I<date time>>+]
+    S<<< [B<-p> <I<TC port offset>>] >>>
+    S<<< [B<-g> <I<group ID>>] >>>
+    [B<-db>] [B<-fo>] [B<-n>] [B<-l>]
+    S<<< [B<-c> <I<cell name>>] >>>
+    [B<-h>]
 
 =for html
 </div>
index fac5dbe..d205212 100644 (file)
@@ -11,7 +11,8 @@ B<backup delhost> S<<< B<-tapehost> <I<tape machine name>> >>>
     S<<< [B<-portoffset> <I<TC port offset>>] >>> [B<-localauth>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup delh> S<<< B<-t> <I<tape machine name>> >>> S<<< [B<-p> <I<TC port offset>>] >>>
+B<backup delh> S<<< B<-t> <I<tape machine name>> >>>
+    S<<< [B<-p> <I<TC port offset>>] >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index cb50628..1be39dc 100644 (file)
@@ -11,7 +11,8 @@ B<backup delvolentry> S<<< B<-name> <I<volume set name>> >>>
     S<<< B<-entry> <I<volume set index>> >>> [B<-localauth>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup delvole> S<<< B<-n> <I<volume set name>> >>> S<<< B<-e> <I<volume set index>> >>>
+B<backup delvole> S<<< B<-n> <I<volume set name>> >>>
+    S<<< B<-e> <I<volume set index>> >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index 30f6413..27f5336 100644 (file)
@@ -15,8 +15,10 @@ B<backup diskrestore> S<<< B<-server> <I<machine to restore>> >>>
     S<<< [B<-extension> <I<new volume name extension>>] >>>
     [B<-n>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup di> S<<< B<-s> <I<machine to restore>> >>> S<<< B<-pa> <I<partition to restore>> >>>
-    S<<< [B<-po> <I<TC port offset>>+] >>> S<<< [B<-news> <I<destination machine>>] >>>
+B<backup di> S<<< B<-s> <I<machine to restore>> >>>
+    S<<< B<-pa> <I<partition to restore>> >>>
+    S<<< [B<-po> <I<TC port offset>>+] >>>
+    S<<< [B<-news> <I<destination machine>>] >>>
     S<<< [B<-newp> <I<destination partition>>] >>>
     S<<< [B<-e> <I<new volume name extension>>] >>> [B<-n>] [B<-l>]
     S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
index aa1c952..b64ebc9 100644 (file)
@@ -10,7 +10,8 @@ backup_dump - Creates a dump (dumps a volume set at a particular dump level)
 B<backup dump> S<<< [B<-volumeset> <I<volume set name>>] >>>
     S<<< [B<-dump> <I<dump level name>>] >>> 
     S<<< [B<-portoffset> <I<TC port offset>>] >>>
-    S<<< [B<-at> <I<date/time to start dump>>+] >>> [B<-append>] [B<-n>]
+    S<<< [B<-at> <I<date/time to start dump>>+] >>>
+    [B<-append>] [B<-n>]
     S<<< [B<-file> <I<load file>>] >>> [B<-localauth>] 
     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
index 58e18de..5f96b9c 100644 (file)
@@ -7,9 +7,9 @@ backup_help - Displays help for backup commands
 =for html
 <div class="synopsis">
 
-B<backup help> S<<< [B<-topic> <I<help string>>+] >>> [B<-help>]
+B<backup help> S<<< [B<-topic> <I<help string>>+] >>> [B<-admin>] [B<-help>]
 
-B<backup h> S<<< [B<-t> <I<help string>>+] >>> [B<-h>]
+B<backup h> S<<< [B<-t> <I<help string>>+] >>> [B<-a>] [B<-h>]
 
 =for html
 </div>
index 8cc1eff..d3f4e95 100644 (file)
@@ -7,9 +7,9 @@ backup_kill - Terminates a pending or running operation
 =for html
 <div class="synopsis">
 
-B<kill> S<<< B<-id> <I<job ID or dump set name>> >>> [B<-help>]
+B<backup kill> S<<< B<-id> <I<job ID or dump set name>> >>> [B<-help>]
 
-S<<< B<k -i> <I<job ID or dump set name>> >>> [B<-h>]
+B<backup k> S<<< B<k -i> <I<job ID or dump set name>> >>> [B<-h>]
 
 =for html
 </div>
index 8e9655d..57e3ed4 100644 (file)
@@ -9,12 +9,14 @@ backup_labeltape - Creates the magnetic label on a tape
 
 B<backup labeltape> S<<< [B<-name> <I<AFS tape name, defaults to NULL>>] >>>
     S<<< [B<-size> <I<tape size in Kbytes, defaults to size in tapeconfig>>] >>>
-    S<<< [B<-portoffset> <I<TC port offset>>] >>> S<<< [B<-pname> <I<permanent tape name>>] >>>
+    S<<< [B<-portoffset> <I<TC port offset>>] >>>
+    S<<< [B<-pname> <I<permanent tape name>>] >>>
     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
 B<backup la> S<<< [B<-n> <I<AFS tape name, defaults to NULL>>] >>>
     S<<< [B<-s> <I<tape size in Kbytes, defaults to size in tapeconfig>>] >>>
-    S<<< [B<-po> <I<TC port offset>>] >>> S<<< [B<-pn> <I<permanent tape name>>] >>>
+    S<<< [B<-po> <I<TC port offset>>] >>>
+    S<<< [B<-pn> <I<permanent tape name>>] >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index a317c6b..b686c59 100644 (file)
@@ -7,11 +7,11 @@ backup_readlabel - Reads and displays a tape's label
 =for html
 <div class="synopsis">
 
-B<backup readlabel> S<<< [B<-portoffset> <I<TC port offset>>] >>> [B<-localauth>]
-    S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
+B<backup readlabel> S<<< [B<-portoffset> <I<TC port offset>>] >>>
+    [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup rea> S<<< [B<-p> <I<TC port offset>>] >>> [B<-l>] S<<< [B<-c> <I<cell name>>] >>>
-    [B<-h>]
+B<backup rea> S<<< [B<-p> <I<TC port offset>>] >>>
+    [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
 </div>
index 68a2fa2..6ab75ef 100644 (file)
@@ -7,11 +7,11 @@ backup_restoredb - Restores a saved copy of the Backup Database
 =for html
 <div class="synopsis">
 
-B<backup restoredb> S<<< [B<-portoffset> <I<TC port offset>>] >>> [B<-localauth>]
-    S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
+B<backup restoredb> S<<< [B<-portoffset> <I<TC port offset>>] >>>
+    [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup res> S<<< [B<-p> <I<TC port offset>>] >>> [B<-l>] S<<< [B<-c> <I<cell name>>] >>>
-    [B<-h>]
+B<backup res> S<<< [B<-p> <I<TC port offset>>] >>>
+    [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
 </div>
index 15ee221..4cba6bf 100644 (file)
@@ -11,7 +11,8 @@ B<backup savedb> S<<< [B<-portoffset> <I<TC port offset>>] >>>
     S<<< [B<-archive> <I<date time>>+] >>> [B<-localauth>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup sa> S<<< [B<-p> <I<TC port offset>>] >>> S<<< [B<-a> <I<date time>>+] >>>
+B<backup sa> S<<< [B<-p> <I<TC port offset>>] >>>
+    S<<< [B<-a> <I<date time>>+] >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index 7f74141..b6ad5f5 100644 (file)
@@ -11,7 +11,8 @@ B<backup setexp> S<<< B<-dump> <I<dump level name>>+ >>>
     S<<< [B<-expires> <I<expiration date>>+] >>> [B<-localauth>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup se> S<<< B<-d> <I<dump level name>>+ >>> S<<< [B<-e> <I<expiration date>>+] >>>
+B<backup se> S<<< B<-d> <I<dump level name>>+ >>>
+    S<<< [B<-e> <I<expiration date>>+] >>>
     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index ba8a5ee..f24309f 100644 (file)
@@ -7,11 +7,11 @@ backup_status - Reports a Tape Coordinator's status
 =for html
 <div class="synopsis">
 
-B<backup status> S<<< [B<-portoffset> <I<TC port offset>>] >>> [B<-localauth>]
-    S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
+B<backup status> S<<< [B<-portoffset> <I<TC port offset>>] >>>
+    [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup st> S<<< [B<-p> <I<TC port offset>>] >>> [B<-l>] S<<< [B<-c> <I<cell name>>] >>>
-    [B<-h>]
+B<backup st> S<<< [B<-p> <I<TC port offset>>] >>>
+    [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
 </div>
index d1a55e8..29010d3 100644 (file)
@@ -10,7 +10,8 @@ backup_volinfo - Displays a volume's dump history from the Backup Database
 B<backup volinfo> S<<< B<-volume> <I<volume name>> >>> [B<-localauth>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup voli> S<<< B<-v> <I<volume name>> >>> [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
+B<backup voli> S<<< B<-v> <I<volume name>> >>>
+    [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
 </div>
index e52896b..8aecafa 100644 (file)
@@ -13,12 +13,16 @@ B<backup volrestore> S<<< B<-server> <I<destination machine>> >>>
     S<<< [B<-extension> <I<new volume name extension>>] >>>
     S<<< [B<-date> <I<date from which to restore>>+] >>>
     S<<< [B<-portoffset> <I<TC port offsets>>+] >>> [B<-n>]
+    S<<< [B<-usedump> <I<specify the dumpID to restore from>>] >>>
     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
 B<backup volr> S<<< B<-s> <I<destination machine>> >>>
-    S<<< B<-pa> <I<destination partition>> >>> S<<< B<-v> <I<volume(s) to restore>>+ >>>
+    S<<< B<-pa> <I<destination partition>> >>>
+    S<<< B<-v> <I<volume(s) to restore>>+ >>>
     S<<< [B<-e> <I<new volume name extension>>] >>>
-    S<<< [B<-d> <I<date from which to restore>>+] >>> S<<< [B<-po> <I<TC port offsets>>+] >>>
+    S<<< [B<-d> <I<date from which to restore>>+] >>>
+    S<<< [B<-po> <I<TC port offsets>>+] >>>
+    S<<< [B<-u> <I<specify the dumpID to restore from>>] >>>
     [B<-n>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html
index fcac347..0dcc242 100644 (file)
@@ -8,12 +8,15 @@ backup_volsetrestore - Restores all volumes in a volume set
 <div class="synopsis">
 
 B<backup volsetrestore> S<<< [B<-name> <I<volume set name>>] >>>
-    S<<< [B<-file> <I<file name>>] >>> S<<< [B<-portoffset> <I<TC port offset>>+] >>>
+    S<<< [B<-file> <I<file name>>] >>>
+    S<<< [B<-portoffset> <I<TC port offset>>+] >>>
     S<<< [B<-extension> <I<new volume name extension>>] >>> [B<-n>]
     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
 
-B<backup vols> S<<< [B<-na> <I<volume set name>>] >>> S<<< [B<-f> <I<file name>>] >>>
-    S<<< [B<-p> <I<TC port offset>>+] >>> S<<< [B<-e> <I<new volume name extension>>] >>>
+B<backup vols> S<<< [B<-na> <I<volume set name>>] >>>
+    S<<< [B<-f> <I<file name>>] >>>
+    S<<< [B<-p> <I<TC port offset>>+] >>>
+    S<<< [B<-e> <I<new volume name extension>>] >>>
     [B<-n>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
 
 =for html