doc/man-pages/pod/backup_help.pod

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