man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / backup_apropos.pod
1 =head1 NAME
2
3 backup apropos - Displays each help entry containing a keyword string
4
5 =head1 SYNOPSIS
6
7 B<backup apropos> B<-topic> <I<help string>> [B<-help>] 
8
9 B<backup ap> B<-t> <I<help string>> [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<backup apropos> command displays the first line of the online help
14 entry for any B<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 B<backup help> command.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-topic> <I<help string>>
24
25 Specifies the keyword string to match, in lowercase letters only.  If the
26 string is more than a single word, surround it with double quotes (C<" ">)
27 or other delimiters.
28
29 =item B<-help>
30
31 Prints the online help for this command. All other valid options are
32 ignored.
33
34 =back
35
36 =head1 OUTPUT
37
38 The first line of a command's online help entry names it and briefly
39 describes its function. This command displays the first line for any
40 B<backup> command where the string specified with the B<-topic> argument
41 is part of the command name or first line.
42
43 =head1 EXAMPLES
44
45 The following example lists all backup commands that include the word
46 C<tape> in their names or short descriptions:
47
48    % backup apropos tape
49    labeltape: label a tape
50    readlabel: read the label on tape
51    scantape: dump information recovery from tape
52    status: get tape coordinator status
53
54 =head1 PRIVILEGE REQUIRED
55
56 None
57
58 =head1 SEE ALSO
59
60 L<backup(8)>,
61 L<backup_help(8)>
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.