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