doc/man-pages/pod8/backup_help.pod

   1 =head1 NAME
   2
   3 backup help - Displays help for backup commands
   4
   5 =head1 SYNOPSIS
   6
   7 B<backup help> [B<-topic> <I<help string>>+] [B<-help>]
   8
   9 B<backup h> [B<-t> <I<help string>>+] [B<-h>]
  10
  11 =head1 DESCRIPTION
  12
  13 The B<backup help> command displays the complete online help entry (short
  14 description and syntax statement) for each operation code specified by the
  15 B<-topic> argument. If the B<-topic> argument is omitted, the output
  16 includes the first line (name and short description) of the online help
  17 entry for every B<backup> command.
  18
  19 To list every backup command whose name or short description includes a
  20 specified keyword, use the B<backup apropos> command.
  21
  22 =head1 OPTIONS
  23
  24 =over 4
  25
  26 =item B<-topic> <I<help string>>+
  27
  28 Indicates each command for which to display the complete online help
  29 entry. Omit the B<backup> part of the command name, providing only the
  30 operation code (for example, specify B<dump>, not B<backup dump>). If this
  31 argument is omitted, the output briefly describes every B<backup> command.
  32
  33 =item B<-help>
  34
  35 Prints the online help for this command. All other valid options are
  36 ignored.
  37
  38 =back
  39
  40 =head1 OUTPUT
  41
  42 The online help entry for each backup command consists of the following
  43 two or three lines:
  44
  45 =over 4
  46
  47 =item *
  48
  49 The first line names the command and briefly describes its function.
  50
  51 =item *
  52
  53 The second line lists aliases for the command, if any.
  54
  55 =item *
  56
  57 The final line, which begins with the string C<Usage>, lists the command's
  58 options in the prescribed order. Online help entries use the same symbols
  59 (for example, brackets) as the reference pages in this document.
  60
  61 =back
  62
  63 =head1 EXAMPLES
  64
  65 The following example displays the online help entry for the B<backup
  66 dump> command:
  67
  68    % backup help dump
  69    backup dump: start dump
  70    Usage: backup dump -volumeset <volume set name> -dump <dump level name>
  71    [-portoffset <TC port offset>]  [-at <Date/time to start dump>+]
  72    [-append]  [-n]  [-file <load file>]  [-help]
  73
  74 =head1 PRIVILEGE REQUIRED
  75
  76 None
  77
  78 =head1 SEE ALSO
  79
  80 L<backup(8)>,
  81 L<backup_apropos(8)>
  82
  83 =head1 COPYRIGHT
  84
  85 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  86
  87 This documentation is covered by the IBM Public License Version 1.0.  It was
  88 converted from HTML to POD by software written by Chas Williams and Russ
  89 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.