doc/man-pages/pod1/fs_help.pod

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