man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / backup_listvolsets.pod
1 =head1 NAME
2
3 backup listvolsets - Lists volume set entries from the Backup Database
4
5 =head1 SYNOPSIS
6
7 B<backup listvolsets> [B<-name> <I<volume set name>>] [B<-localauth>]
8     [B<-cell> <I<cell name>>] [B<-help>]
9
10 B<backup listv> [B<-n> <I<volume set name>>] [B<-l>]
11     [B<-c> <I<cell name>>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<backup listvolsets> command displays the Backup Database records for
16 either
17
18 =over 4
19
20 =item *
21
22 All volume sets and their volume entries, if the B<-name> argument is
23 omitted.
24
25 =item *
26
27 The volume set specified by the B<-name> argument, along with its volume
28 entries.
29
30 =back
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-name> <I<volume set name>>
37
38 Names the volume set to display. If this argument is omitted, the output
39 lists all volume sets defined in the Backup Database.
40
41 =item B<-localauth>
42
43 Constructs a server ticket using a key from the local
44 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
45 it to the Backup Server, Volume Server and VL Server during mutual
46 authentication. Do not combine this flag with the B<-cell> argument. For
47 more details, see L<backup(8)>.
48
49 =item B<-cell> <I<cell name>>
50
51 Names the cell in which to run the command. Do not combine this argument
52 with the B<-localauth> flag. For more details, see L<backup(8)>.
53
54 =item B<-help>
55
56 Prints the online help for this command. All other valid options are
57 ignored.
58
59 =back
60
61 =head1 OUTPUT
62
63 The entry for each volume set begins with the C<Volume set> header and the
64 volume set's name. A temporary volume set's name is followed by the string
65 C< (temporary)>. Each volume entry follows on a separate line, indicating
66 the entry's index number and the server, partition, and volume names it
67 matches. The output uses the metacharacter notation described on the
68 B<backup addvolentry> reference page. Use the index number to identify
69 volume entries when deleting them with the B<backup delvolentry> command.
70
71 =head1 EXAMPLES
72
73 The following example shows the volume entries in the three volume sets
74 currently defined in the Backup Database:
75
76    % backup listvolsets
77    Volume set user:
78        Entry   1: server .*, partition .*, volumes: user.*\.backup
79    Volume set sun
80        Entry   1: server .*, partition .*, volumes: sun4x_55\..*
81        Entry   2: server .*, partition .*, volumes: sun4x_56\..*
82    Volume set rs
83        Entry   1: server .*, partition .*, volumes: rs_aix42\..*
84
85 =head1 PRIVILEGE REQUIRED
86
87 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
88 machine where the Backup Server is running, or must be logged onto a
89 server machine as the local superuser C<root> if the B<-localauth> flag is
90 included.
91
92 =head1 SEE ALSO
93
94 L<backup(8)>,
95 L<backup_addvolentry(8)>,
96 L<backup_addvolset(8)>,
97 L<backup_delvolentry(8)>,
98 L<backup_delvolset(8)>
99
100 =head1 COPYRIGHT
101
102 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
103
104 This documentation is covered by the IBM Public License Version 1.0.  It was
105 converted from HTML to POD by software written by Chas Williams and Russ
106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.