ac694967e903a617a05ac90badc25cfb1abd9074
[openafs.git] / doc / man-pages / pod / backup_apropos.pod
1 =head1 NAME
2
3 backup apropos - Displays each help entry containing a keyword string
4
5 =head1 SYNOPSIS
6
7 backup apropos B<-topic> I<help string>  [B<-help>]
8
9 backup ap B<-t> I<help string>  [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The C<backup apropos> command displays the first line of the online help
14 entry for any C<backup> command that has in its name or short description
15 the string specified by the B<-topic> argument.
16
17 To display the syntax for a command, use the C<backup help> command.
18
19 =head1 OPTIONS
20
21 =over 4
22
23
24 =item B<-topic> I<help string>
25
26 Specifies the keyword string to match, in lowercase letters
27 only. If the string is more than a single word, surround it
28 with double quotes (" ") or other delimiters.
29
30
31 =item B<-help>
32
33 Prints the online help for this command. All other valid
34 options 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 C<backup> command where the string specified with the B<-topic> argument is
43 part of the command name or first line.
44
45 =head1 EXAMPLES
46
47 The following example lists all C<backup> commands that include the word
48 B<tape> in their names or short descriptions:
49
50    backup apropos tape
51    labeltape: label a tape
52    readlabel: read the label on tape
53    scantape: dump information recovery from tape
54    status: get tape coordinator status
55
56 =head1 PRIVILEGE REQUIRED
57
58 None
59
60 =head1 COPYRIGHT
61
62 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
63
64 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
65 Stanford Linear Accelerator Center, a department of Stanford University.
66
67 =head1 SEE ALSO
68
69 L<backup(1)>,
70 L<backup_help(1)>
71
72 =cut