src/man/fs_apropos.1

   1 fs apropos                 AFS Commands              fs apropos
   2
   3
   4 NAME
   5
   6    fs apropos -- show each help entry containing keyword.
   7
   8
   9    fs apropos  -topic <help string>  [-help]
  10
  11 ACCEPTABLE ABBREVIATIONS/ALIASES
  12
  13    fs ap  -t <help string>  [-h]
  14
  15 DESCRIPTION
  16
  17    Displays  the first line of the online help entry for any fs
  18    command  that  has  help  string  in  its  name   or   short
  19    description.
  20
  21 ARGUMENTS
  22
  23    -topic
  24          specifies the keyword string for which to search.   If
  25          it is more than a single word, surround it with double
  26          quotes  or  other  delimiters.    This   argument   is
  27          case-sensitive;  type  help strings for fs commands in
  28          lowercase letters.
  29
  30    -help prints the online help entry for this command.  Do not
  31          provide  any  other  arguments or flags with this one.
  32          See section 3.1  in  the  Reference  Manual  for  more
  33          details.
  34
  35 OUTPUT
  36
  37    The  first  line  of a command's online help entry names the
  38    command and briefly describes what it does.  The  fs apropos
  39    command  displays  that  first line for any fs command where
  40    help string is part of the command name or first line.
  41
  42    To see the remaining lines in a help  entry,  which  provide
  43    the  command's  alias  (if  any) and syntax, use the fs help
  44    command.
  45
  46 EXAMPLES
  47
  48    The following lists all  fs  commands  that  have  the  word
  49    "cache"   in   their   operation   codes   or  short  online
  50    descriptions:
  51
  52        % fs apropos -topic cache
  53        setcachesize: set cache size
  54        flush: flush file from cache
  55        getcacheparms: get cache usage info
  56        monitor: set cache monitor host address
  57
  58
  59
  60 PRIVILEGE REQUIRED
  61
  62    None.
  63
  64 MORE INFORMATION
  65
  66    fs help