Branch HEAD

Update llbackup.8 man page to match b1_6.
b=14711

lustre/doc/llbackup.8

@@ -6,8 +6,8 @@
 .SH NAME
 llbackup \- backup a list of files, maybe running on multiple nodes
 .SH SYNOPSIS
-.B llbackup
-.RB [ -chjvxz "] [" -C
+.B llbackup -c
+.RB [ -hjvxz "] [" -C
 .IR directory ]
 .RB [ -e
 .IR rsh ]
@@ -19,9 +19,26 @@ llbackup \- backup a list of files, maybe running on multiple nodes
 .IR nodes ]
 .RB [ -s
 .IR splitmb ]
+.RB [ -S
+.IR splitcount ]
 .RB [ -T
 .IR tar ]
 .BI -f outputfilebase
+.br
+
+.B llbackup
+.RB { -x | -t }
+.RB [ -chjvz "] [" -C
+.IR directory ]
+.RB [ -e
+.IR rsh ]
+.RB [ -l
+.IR logdir ]
+.RB [ -n
+.IR nodes ]
+.RB [ -T
+.IR tar ]
+.BI -f tarfilelist
 .SH DESCRIPTION
 .B llbackup
 takes a list of files to backup or restore, either from standard input, or
@@ -37,21 +54,44 @@ not identical in some cases).  The reason for using llbackup instead of those
 programs directly is that llbackup can run in parallel on multiple
 nodes to do high-speed backups on clustered or distributed filesystems and
 will split the work among multiple client nodes to increase performance.
-The archive files produced are identical to normal tar files (having been
-created by the local tar command) and can be extracted or listed by tar
+.br
+
+The archive files produced by
+.B llbackup
+are identical to normal tar files (having been created by the local tar
+command) and can be extracted or listed by
+.B tar
 directly.
 .br
+
 The clients will pause and print status messages if they think there is not
 enough free space in the output directory to avoid running out of space.
 Backup tarfiles should be moved to offline storage or otherwise purged to
 allow the backups to continue.  If the client is doing a restore it will
 similarly pause and print status messages if the tarfile it was asked to
 restore is not available on that node.
-.sh OPTIONS
+.SH OPERATIONS
+The following options control what operation
+.B llbackup
+will perform:
 .TP
 .B -c
 create archive.  This is the default operation if no other is given.
 .TP
+.B -x
+extract tarfiles from the
+.I tarfilelist
+given to
+.B -f
+instead of backing them up.
+.TP
+.B -t
+list table of contents of the
+.I tarfilelist
+given by
+.BR -f .
+.SH OPTIONS
+.TP
 .BI -C directory
 change the backup command to run in
 .I directory
@@ -73,12 +113,22 @@ specify the passwordless remote shell command (default
 .BI -f outputbase
 specify base output filename for backup tar archives, to which a suffix will
 be appended to ensure that multiple clients doing backup into the same
-directory do not have conflicting filenames.  For restore or list operations
-this is a file containing a list of tarfiles, one per line, to restore or
-list the table of contents of.  The
+directory do not have conflicting filenames.  The
 .I outputbase
 file can be a tape or disk device, but must be the same device on each client
 running the backup, in which case only a single process can run on each client.
+Specifying
+.B -
+means write to standard output.
+.TP
+.BI -f tarfilelist
+specify a file containing a list of tarfiles, one per line, to restore or
+list the table of contents of.  Specifying
+.B -
+means read the list of tarfiles from standard input.  The
+.I tarfilelist
+can also be a tape or disk device, but since the individual tarfiles are
+sent to individual clients, the same files must be accessible on all clients.
 .TP
 .B -h
 print this help message and exit.  Use
@@ -90,8 +140,12 @@ or
 to get the help options for restore or list operations.
 .TP
 .BI -i inputlist
-list of files to backup when creating an archive (default stdin).  The input
-file list is just a list of pathnames, one file per line, as generated by
+list of files to backup when creating an archive.  If no
+.B -i
+option is specified or if
+.I inputlist
+is - then the list of files to back up is read from standard input.  The input
+file list is a list of pathnames, one file per line, as generated by
 .BR find (8),
 .BR "lfs find" (8),
 or
@@ -139,10 +193,6 @@ means nearly every archive will have to be extracted to get only a subset
 of files needed.
 This option has no meaning for restore or list operations.
 .TP
-.B -t
-list table of contents of the list of tarfiles given by
-.BR -f .
-.TP
 .BI -T tar
 specify the backup command (default tar).  Optionally the
 .BI htar (8)
@@ -157,11 +207,6 @@ overall progress would be hard to determine.
 .B -V
 print version number and exit.
 .TP
-.B -x
-extract tarfiles from the list of tarfiles given by
-.B -f
-instead of backing them up.
-.TP
 .B -z
 use gzip compression on input or output tar file(s).  This option is not
 currently supported by the underlying
@@ -179,7 +224,8 @@ and run on client nodes
 .B c1
 nodes, putting the output tar files into the
 .B /bkup
-directory using filenames starting with bk2008-03-15:
+directory using filenames starting with
+.BR bk2008-03-15 .
 .TP
 .B find /bkup -name bk2007-11-28* | llbackup -x -n c1,c1,c2,c2 -C /tmp -f-
 Restore
@@ -195,7 +241,7 @@ and
 reading the list of tar files to restore from standard input and restoring
 into the
 .B /tmp
-directory:
+directory.
 .SH BUGS
 It is currently not possible to extract only a subset of files from the
 tarfiles.  If that is necessary, then tar should be run directly on the