DEVEL15-man-page-name-underscore-20071111
[openafs.git] / doc / man-pages / pod1 / fs_apropos.pod
1 =head1 NAME
2
3 fs apropos - Displays each help entry containing a keyword string
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs apropos> S<<< B<-topic> <I<help string>> >>> [B<-help>]
11
12 B<fs ap> S<<< B<-t> <I<help string>> >>> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs apropos> command displays the first line of the online help entry
20 for any B<fs> command that has in its name or short description the string
21 specified by the B<-topic> argument.
22
23 To display the syntax for a command, use the B<fs 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 ("") or
33 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 B<fs>
46 command where the string specified with the B<-topic> argument is part of
47 the command name or first line.
48
49 =head1 EXAMPLES
50
51 The following command lists all fs commands that include the word C<cache>
52 in their names or short online descriptions:
53
54    % fs apropos cache
55    setcachesize: set cache size
56    flush: flush file from cache
57    getcacheparms: get cache usage info
58    monitor: set cache monitor host address
59
60 =head1 PRIVILEGE REQUIRED
61
62 None
63
64 =head1 SEE ALSO
65
66 L<fs(1)>,
67 L<fs_help(1)>
68
69 =head1 COPYRIGHT
70
71 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
72
73 This documentation is covered by the IBM Public License Version 1.0.  It was
74 converted from HTML to POD by software written by Chas Williams and Russ
75 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.