From 04fa499ac9285f51fdbc2ff724c2a1bd7f0e5d58 Mon Sep 17 00:00:00 2001 From: Davor Ocelic Date: Thu, 8 Oct 2009 23:01:39 +0200 Subject: [PATCH] Update backup suite manpages -- 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 Reviewed-by: Jeffrey Altman --- doc/man-pages/pod8/backup.pod | 67 ++++++++++++++++++++--------- doc/man-pages/pod8/backup_addhost.pod | 3 +- doc/man-pages/pod8/backup_addvolentry.pod | 9 ++-- doc/man-pages/pod8/backup_dbverify.pod | 3 +- doc/man-pages/pod8/backup_deletedump.pod | 19 ++++++-- doc/man-pages/pod8/backup_delhost.pod | 3 +- doc/man-pages/pod8/backup_delvolentry.pod | 3 +- doc/man-pages/pod8/backup_diskrestore.pod | 6 ++- doc/man-pages/pod8/backup_dump.pod | 3 +- doc/man-pages/pod8/backup_help.pod | 4 +- doc/man-pages/pod8/backup_kill.pod | 4 +- doc/man-pages/pod8/backup_labeltape.pod | 6 ++- doc/man-pages/pod8/backup_readlabel.pod | 8 ++-- doc/man-pages/pod8/backup_restoredb.pod | 8 ++-- doc/man-pages/pod8/backup_savedb.pod | 3 +- doc/man-pages/pod8/backup_setexp.pod | 3 +- doc/man-pages/pod8/backup_status.pod | 8 ++-- doc/man-pages/pod8/backup_volinfo.pod | 3 +- doc/man-pages/pod8/backup_volrestore.pod | 8 +++- doc/man-pages/pod8/backup_volsetrestore.pod | 9 ++-- 20 files changed, 120 insertions(+), 60 deletions(-) diff --git a/doc/man-pages/pod8/backup.pod b/doc/man-pages/pod8/backup.pod index c199d90..4cb65af 100644 --- a/doc/man-pages/pod8/backup.pod +++ b/doc/man-pages/pod8/backup.pod @@ -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, B, -B, and B. +to restore it to the file system: +L|backup_diskrestore(8)>, +L|backup_dump(8)>, +L|backup_volrestore(8)>, +and L|backup_volsetrestore(8)>. =item * -Commands to administer the records in the Backup Database: B, B, B, B, -B, B, B, B, B, B, B, B, B, B, B, and B. +Commands to administer the records in the Backup Database: +L|backup_adddump(8)>, +L|backup_addhost(8)>, +L|backup_addvolentry(8)>, +L|backup_addvolset(8)>, +L|backup_deldump(8)>, +L|backup_deletedump(8)>, +L|backup_delhost(8)>, +L|backup_delvolentry(8)>, +L|backup_delvolset(8)>, +L|backup_dumpinfo(8)>, +L|backup_listdumps(8)>, +L|backup_listhosts(8)>, +L|backup_listvolsets(8)>, +L|backup_scantape(8)>, +L|backup_setexp(8)>, +and L|backup_volinfo(8)>. =item * -Commands to write and read tape labels: B and B. +Commands to write and read tape labels: +L|backup_labeltape(8)> +and L|backup_readlabel(8)>. =item * Commands to list and change the status of backup operations and the -machines performing them: B, B, and B. +machines performing them: +L|backup_jobs(8)>, +L|backup_kill(8)>, +and L|backup_status(8)>. =item * -Commands to enter and leave interactive mode: B and -B. +Commands to enter and leave interactive mode: +L|backup_interactive(8)> +and L|backup_quit(8)>. =item * Commands to check for and repair corruption in the Backup Database: -B, B, and B. +L|backup_dbverify(8)>, +L|backup_restoredb(8)>, +and L|backup_savedb(8)>. =item * -Commands to obtain help: B and B. +Commands to obtain help: +L|backup_apropos(8)> +and L|backup_help(8)>. =back @@ -86,8 +108,10 @@ information used to automate its operation. In addition to the standard command line interface, the B command suite provides an I interface, which has several useful features described in L. Three of the commands in -the suite are available only in interactive mode: B, B, and B. +the suite are available only in interactive mode: +L|backup_jobs(8)>, +L|backup_kill(8)>, +and L|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, -B, or B command). +provided for the B<-portoffset> argument to the +L|backup_diskrestore(8)>, +L|backup_volrestore(8)>, +or L|backup_volsetrestore(8)> command). =back @@ -254,6 +280,7 @@ L, L, L, L, +L, L, L, L, diff --git a/doc/man-pages/pod8/backup_addhost.pod b/doc/man-pages/pod8/backup_addhost.pod index aa3e26a..e237bed 100644 --- a/doc/man-pages/pod8/backup_addhost.pod +++ b/doc/man-pages/pod8/backup_addhost.pod @@ -11,7 +11,8 @@ B S<<< B<-tapehost> > >>> S<<< [B<-portoffset> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-t> > >>> S<<< [B<-p> >] >>> +B S<<< B<-t> > >>> + S<<< [B<-p> >] >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_addvolentry.pod b/doc/man-pages/pod8/backup_addvolentry.pod index ccf1d6f..7373d6b 100644 --- a/doc/man-pages/pod8/backup_addvolentry.pod +++ b/doc/man-pages/pod8/backup_addvolentry.pod @@ -8,12 +8,15 @@ backup_addvolentry - Defines a volume entry in a volume set
B S<<< B<-name> > >>> - S<<< B<-server> > >>> S<<< B<-partition> > >>> + S<<< B<-server> > >>> + S<<< B<-partition> > >>> S<<< B<-volumes> > >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-n> > >>> S<<< B<-s> > >>> - S<<< B<-p> > >>> S<<< B<-v> > >>> +B S<<< B<-n> > >>> + S<<< B<-s> > >>> + S<<< B<-p> > >>> + S<<< B<-v> > >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_dbverify.pod b/doc/man-pages/pod8/backup_dbverify.pod index 0ec5db3..1592a23 100644 --- a/doc/man-pages/pod8/backup_dbverify.pod +++ b/doc/man-pages/pod8/backup_dbverify.pod @@ -7,7 +7,8 @@ backup_dbverify - Checks the integrity of the Backup Database =for html
-B [B<-detail>] [B<-localauth>] S<<< [B<-cell> >] >>> +B [B<-detail>] [B<-localauth>] + S<<< [B<-cell> >] >>> [B<-help>] B [B<-d>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] diff --git a/doc/man-pages/pod8/backup_deletedump.pod b/doc/man-pages/pod8/backup_deletedump.pod index adc78e8..465ec0e 100644 --- a/doc/man-pages/pod8/backup_deletedump.pod +++ b/doc/man-pages/pod8/backup_deletedump.pod @@ -7,12 +7,23 @@ backup_deletedump - Deletes one or more dump records from the Backup Database =for html
-B S<<< [B<-dumpid> >+] >>> S<<< [B<-from> >+] >>> - S<<< [B<-to> >+] >>> [B<-localauth>] S<<< [B<-cell> >] >>> +B S<<< [B<-dumpid> >+] >>> + S<<< [B<-from> >+] >>> + S<<< [B<-to> >+] >>> + S<<< [B<-port> >] >>> + S<<< [B<-groupid> >] >>> + [B<-dbonly>] [B<-force>] [B<-noexecute>] [B<-localauth>] + S<<< [B<-cell> >] >>> [B<-help>] -B S<<< [B<-d> >+] >>> S<<< [B<-f> >+] >>> - [-t >+] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] +B S<<< [B<-d> >+] >>> + S<<< [B<-fr> >+] >>> + [-t >+] + S<<< [B<-p> >] >>> + S<<< [B<-g> >] >>> + [B<-db>] [B<-fo>] [B<-n>] [B<-l>] + S<<< [B<-c> >] >>> + [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_delhost.pod b/doc/man-pages/pod8/backup_delhost.pod index fac5dbe..d205212 100644 --- a/doc/man-pages/pod8/backup_delhost.pod +++ b/doc/man-pages/pod8/backup_delhost.pod @@ -11,7 +11,8 @@ B S<<< B<-tapehost> > >>> S<<< [B<-portoffset> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-t> > >>> S<<< [B<-p> >] >>> +B S<<< B<-t> > >>> + S<<< [B<-p> >] >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_delvolentry.pod b/doc/man-pages/pod8/backup_delvolentry.pod index cb50628..1be39dc 100644 --- a/doc/man-pages/pod8/backup_delvolentry.pod +++ b/doc/man-pages/pod8/backup_delvolentry.pod @@ -11,7 +11,8 @@ B S<<< B<-name> > >>> S<<< B<-entry> > >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-n> > >>> S<<< B<-e> > >>> +B S<<< B<-n> > >>> + S<<< B<-e> > >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_diskrestore.pod b/doc/man-pages/pod8/backup_diskrestore.pod index 30f6413..27f5336 100644 --- a/doc/man-pages/pod8/backup_diskrestore.pod +++ b/doc/man-pages/pod8/backup_diskrestore.pod @@ -15,8 +15,10 @@ B S<<< B<-server> > >>> S<<< [B<-extension> >] >>> [B<-n>] [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-s> > >>> S<<< B<-pa> > >>> - S<<< [B<-po> >+] >>> S<<< [B<-news> >] >>> +B S<<< B<-s> > >>> + S<<< B<-pa> > >>> + S<<< [B<-po> >+] >>> + S<<< [B<-news> >] >>> S<<< [B<-newp> >] >>> S<<< [B<-e> >] >>> [B<-n>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] diff --git a/doc/man-pages/pod8/backup_dump.pod b/doc/man-pages/pod8/backup_dump.pod index aa1c952..b64ebc9 100644 --- a/doc/man-pages/pod8/backup_dump.pod +++ b/doc/man-pages/pod8/backup_dump.pod @@ -10,7 +10,8 @@ backup_dump - Creates a dump (dumps a volume set at a particular dump level) B S<<< [B<-volumeset> >] >>> S<<< [B<-dump> >] >>> S<<< [B<-portoffset> >] >>> - S<<< [B<-at> >+] >>> [B<-append>] [B<-n>] + S<<< [B<-at> >+] >>> + [B<-append>] [B<-n>] S<<< [B<-file> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] diff --git a/doc/man-pages/pod8/backup_help.pod b/doc/man-pages/pod8/backup_help.pod index 58e18de..5f96b9c 100644 --- a/doc/man-pages/pod8/backup_help.pod +++ b/doc/man-pages/pod8/backup_help.pod @@ -7,9 +7,9 @@ backup_help - Displays help for backup commands =for html
-B S<<< [B<-topic> >+] >>> [B<-help>] +B S<<< [B<-topic> >+] >>> [B<-admin>] [B<-help>] -B S<<< [B<-t> >+] >>> [B<-h>] +B S<<< [B<-t> >+] >>> [B<-a>] [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_kill.pod b/doc/man-pages/pod8/backup_kill.pod index 8cc1eff..d3f4e95 100644 --- a/doc/man-pages/pod8/backup_kill.pod +++ b/doc/man-pages/pod8/backup_kill.pod @@ -7,9 +7,9 @@ backup_kill - Terminates a pending or running operation =for html
-B S<<< B<-id> > >>> [B<-help>] +B S<<< B<-id> > >>> [B<-help>] -S<<< B > >>> [B<-h>] +B S<<< B > >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_labeltape.pod b/doc/man-pages/pod8/backup_labeltape.pod index 8e9655d..57e3ed4 100644 --- a/doc/man-pages/pod8/backup_labeltape.pod +++ b/doc/man-pages/pod8/backup_labeltape.pod @@ -9,12 +9,14 @@ backup_labeltape - Creates the magnetic label on a tape B S<<< [B<-name> >] >>> S<<< [B<-size> >] >>> - S<<< [B<-portoffset> >] >>> S<<< [B<-pname> >] >>> + S<<< [B<-portoffset> >] >>> + S<<< [B<-pname> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] B S<<< [B<-n> >] >>> S<<< [B<-s> >] >>> - S<<< [B<-po> >] >>> S<<< [B<-pn> >] >>> + S<<< [B<-po> >] >>> + S<<< [B<-pn> >] >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_readlabel.pod b/doc/man-pages/pod8/backup_readlabel.pod index a317c6b..b686c59 100644 --- a/doc/man-pages/pod8/backup_readlabel.pod +++ b/doc/man-pages/pod8/backup_readlabel.pod @@ -7,11 +7,11 @@ backup_readlabel - Reads and displays a tape's label =for html
-B S<<< [B<-portoffset> >] >>> [B<-localauth>] - S<<< [B<-cell> >] >>> [B<-help>] +B S<<< [B<-portoffset> >] >>> + [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< [B<-p> >] >>> [B<-l>] S<<< [B<-c> >] >>> - [B<-h>] +B S<<< [B<-p> >] >>> + [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_restoredb.pod b/doc/man-pages/pod8/backup_restoredb.pod index 68a2fa2..6ab75ef 100644 --- a/doc/man-pages/pod8/backup_restoredb.pod +++ b/doc/man-pages/pod8/backup_restoredb.pod @@ -7,11 +7,11 @@ backup_restoredb - Restores a saved copy of the Backup Database =for html
-B S<<< [B<-portoffset> >] >>> [B<-localauth>] - S<<< [B<-cell> >] >>> [B<-help>] +B S<<< [B<-portoffset> >] >>> + [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< [B<-p> >] >>> [B<-l>] S<<< [B<-c> >] >>> - [B<-h>] +B S<<< [B<-p> >] >>> + [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_savedb.pod b/doc/man-pages/pod8/backup_savedb.pod index 15ee221..4cba6bf 100644 --- a/doc/man-pages/pod8/backup_savedb.pod +++ b/doc/man-pages/pod8/backup_savedb.pod @@ -11,7 +11,8 @@ B S<<< [B<-portoffset> >] >>> S<<< [B<-archive> >+] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< [B<-p> >] >>> S<<< [B<-a> >+] >>> +B S<<< [B<-p> >] >>> + S<<< [B<-a> >+] >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_setexp.pod b/doc/man-pages/pod8/backup_setexp.pod index 7f74141..b6ad5f5 100644 --- a/doc/man-pages/pod8/backup_setexp.pod +++ b/doc/man-pages/pod8/backup_setexp.pod @@ -11,7 +11,8 @@ B S<<< B<-dump> >+ >>> S<<< [B<-expires> >+] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-d> >+ >>> S<<< [B<-e> >+] >>> +B S<<< B<-d> >+ >>> + S<<< [B<-e> >+] >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_status.pod b/doc/man-pages/pod8/backup_status.pod index ba8a5ee..f24309f 100644 --- a/doc/man-pages/pod8/backup_status.pod +++ b/doc/man-pages/pod8/backup_status.pod @@ -7,11 +7,11 @@ backup_status - Reports a Tape Coordinator's status =for html
-B S<<< [B<-portoffset> >] >>> [B<-localauth>] - S<<< [B<-cell> >] >>> [B<-help>] +B S<<< [B<-portoffset> >] >>> + [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< [B<-p> >] >>> [B<-l>] S<<< [B<-c> >] >>> - [B<-h>] +B S<<< [B<-p> >] >>> + [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_volinfo.pod b/doc/man-pages/pod8/backup_volinfo.pod index d1a55e8..29010d3 100644 --- a/doc/man-pages/pod8/backup_volinfo.pod +++ b/doc/man-pages/pod8/backup_volinfo.pod @@ -10,7 +10,8 @@ backup_volinfo - Displays a volume's dump history from the Backup Database B S<<< B<-volume> > >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< B<-v> > >>> [B<-l>] S<<< [B<-c> >] >>> [B<-h>] +B S<<< B<-v> > >>> + [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/backup_volrestore.pod b/doc/man-pages/pod8/backup_volrestore.pod index e52896b..8aecafa 100644 --- a/doc/man-pages/pod8/backup_volrestore.pod +++ b/doc/man-pages/pod8/backup_volrestore.pod @@ -13,12 +13,16 @@ B S<<< B<-server> > >>> S<<< [B<-extension> >] >>> S<<< [B<-date> >+] >>> S<<< [B<-portoffset> >+] >>> [B<-n>] + S<<< [B<-usedump> >] >>> [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] B S<<< B<-s> > >>> - S<<< B<-pa> > >>> S<<< B<-v> >+ >>> + S<<< B<-pa> > >>> + S<<< B<-v> >+ >>> S<<< [B<-e> >] >>> - S<<< [B<-d> >+] >>> S<<< [B<-po> >+] >>> + S<<< [B<-d> >+] >>> + S<<< [B<-po> >+] >>> + S<<< [B<-u> >] >>> [B<-n>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/backup_volsetrestore.pod b/doc/man-pages/pod8/backup_volsetrestore.pod index fcac347..0dcc242 100644 --- a/doc/man-pages/pod8/backup_volsetrestore.pod +++ b/doc/man-pages/pod8/backup_volsetrestore.pod @@ -8,12 +8,15 @@ backup_volsetrestore - Restores all volumes in a volume set
B S<<< [B<-name> >] >>> - S<<< [B<-file> >] >>> S<<< [B<-portoffset> >+] >>> + S<<< [B<-file> >] >>> + S<<< [B<-portoffset> >+] >>> S<<< [B<-extension> >] >>> [B<-n>] [B<-localauth>] S<<< [B<-cell> >] >>> [B<-help>] -B S<<< [B<-na> >] >>> S<<< [B<-f> >] >>> - S<<< [B<-p> >+] >>> S<<< [B<-e> >] >>> +B S<<< [B<-na> >] >>> + S<<< [B<-f> >] >>> + S<<< [B<-p> >+] >>> + S<<< [B<-e> >] >>> [B<-n>] [B<-l>] S<<< [B<-c> >] >>> [B<-h>] =for html -- 1.9.4