doc/man-pages/pod8/package_apropos.pod

   1 =head1 NAME
   2
   3 package apropos - Displays each help entry containing a keyword string
   4
   5 =head1 SYNOPSIS
   6
   7 B<package apropos> [B<-topic> <I<help string>>]  [-help]
   8
   9 B<package a> [B<-t> <I<help string>>]  [-h]
  10
  11 =head1 DESCRIPTION
  12
  13 The package apropos command displays the first line of the
  14 online help entry for any B<package> command that has in its name or
  15 short description the string specified by the B<-topic>
  16 argument.
  17
  18 To display the syntax for a command, use the package help
  19 command.
  20
  21 =head1 OPTIONS
  22
  23 =over 4
  24
  25 =item -topic
  26
  27 Specifies the keyword string to match, in lowercase letters only.
  28 If the string is more than a single word, surround it with double quotes ("")
  29 or other delimiters.
  30
  31 =item -help
  32
  33 Prints the online help for this command. All other valid options
  34 are ignored.
  35
  36 =back
  37
  38 =head1 OUTPUT
  39
  40 The first line of a command's online help entry names it and briefly
  41 describes its function. This command displays the first line for any
  42 B<package> command where the string specified with the
  43 B<-topic> argument is part of the command name or first line.
  44
  45 =head1 EXAMPLES
  46
  47 The following command lists all package commands that include
  48 the word B<help> in their names or short descriptions:
  49
  50    % package apropos help
  51    apropos: search by help text
  52    help: get help on commands
  53
  54 =head1 PRIVILEGE REQUIRED
  55
  56 None
  57
  58 =head1 SEE ALSO
  59
  60 L<package(1)>,
  61 L<package_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.