doc/man-pages/pod1/vos_apropos.pod

   1 =head1 NAME
   2
   3 vos apropos - Displays each help entry containing a keyword string
   4
   5 =head1 SYNOPSIS
   6
   7 B<vos apropos -topic> <I<help string>>  [-help]
   8
   9 B<vos ap -t> <I<help string>>  [-h]
  10
  11 =head1 DESCRIPTION
  12
  13 The vos apropos command displays the first line of the online
  14 help entry for any B<vos> command that has in its name or short
  15 description the string specified by the B<-topic> argument.
  16
  17 To display the syntax for a command, use the vos help
  18 command.
  19
  20 =head1 OPTIONS
  21
  22 =over 4
  23
  24 =item -topic
  25
  26 Specifies the keyword string to match. Use lowercase letters only,
  27 except for the acronym B<VLDB>. If the string is more than a
  28 single word, surround it with double quotes ("") or other delimiters.
  29
  30 =item -help
  31
  32 Prints the online help for this command. All other valid options
  33 are ignored.
  34
  35 =back
  36
  37 =head1 OUTPUT
  38
  39 The first line of a command's online help entry names it and briefly
  40 describes its function. This command displays the first line for any
  41 B<vos> command where the string specified with the B<-topic>
  42 argument is part of the command name or first line.
  43
  44 =head1 EXAMPLES
  45
  46 The following command displays all vos commands that include the
  47 word B<lock> in their names or short descriptions:
  48
  49    % vos apropos lock
  50    lock: lock VLDB entry for a volume
  51    unlock: release lock on VLDB entry for a volume
  52    unlockvldb: unlock all the locked entries in the VLDB
  53
  54 =head1 PRIVILEGE REQUIRED
  55
  56 None
  57
  58 =head1 SEE ALSO
  59
  60 L<vos(1)>,
  61 L<vos_help(1)>
  62
  63 =head1 COPYRIGHT
  64
  65 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  66
  67 This documentation is covered by the IBM Public License Version 1.0.  It was
  68 converted from HTML to POD by software written by Chas Williams and Russ
  69 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.