694c98e639800cae3d2c030996095a4a660cefdf
[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 -topic> <I<help string>>  [-help] 
8
9 B<backup ap -t> <I<help string>>  [-h]
10
11 =head1 DESCRIPTION
12
13 The backup apropos command displays the first line of the online
14 help entry for any B<backup> command that has in its name or short
15 description the string specified by the B<-topic> argument.
16
17 To display the syntax for a command, use the backup help
18 command.
19
20 =head1 OPTIONS
21
22 =over 4
23
24 =item -topic
25
26 Specifies the keyword string to match, in lowercase letters only.
27 If the string is more than a single word, surround it with double quotes
28 (B<" ">) or other delimiters.
29
30 =item -help
31
32 Prints the online help for this command. All other valid options
33 are ignored.
34
35 =back
36
37 =head1 OUTPUT
38
39 The first line of a command's online help entry names it and briefly
40 describes its function. This command displays the first line for any
41 B<backup> command where the string specified with the
42 B<-topic> argument is part of the command name or first line.
43
44 =head1 EXAMPLES
45
46 The following example lists all backup commands that include the
47 word B<tape> in their names or short descriptions:
48
49    % backup apropos tape
50    labeltape: label a tape
51    readlabel: read the label on tape
52    scantape: dump information recovery from tape
53    status: get tape coordinator status
54
55 =head1 PRIVILEGE REQUIRED
56
57 None
58
59 =head1 SEE ALSO
60
61 L<backup(1)>,
62 L<backup_help(1)>
63
64 =head1 COPYRIGHT
65
66 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
67
68 This documentation is covered by the IBM Public License Version 1.0.  It was
69 converted from HTML to POD by software written by Chas Williams and Russ
70 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.