man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / backup_delvolset.pod
1 =head1 NAME
2
3 backup delvolset - Deletes one or more volume sets from the Backup Database
4
5 =head1 SYNOPSIS
6
7 B<backup delvolset> B<-name> <I<volume set name>>+ [B<-localauth>]
8     [B<-cell> <I<cell name>>] [B<-help>]
9
10 B<backup delvols> 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 delvolset> command deletes each volume set named by the
16 B<-name> argument, and the volume entries each contains, from the Backup
17 Database. The B<backup listvolsets> command lists the volume sets (and
18 their volume entries) currently defined in the Backup Database.
19
20 =head1 CAUTIONS
21
22 Deleting a temporary volume set is possible only within the interactive
23 session in which it was created. Exiting the interactive session also
24 destroys the temporary volume set automatically.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-name> <I<volume set name>>+
31
32 Names each volume set to delete.
33
34 =item B<-localauth>
35
36 Constructs a server ticket using a key from the local
37 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
38 it to the Backup Server, Volume Server and VL Server during mutual
39 authentication. Do not combine this flag with the B<-cell> argument. For
40 more details, see L<backup(8)>.
41
42 =item B<-cell> <I<cell name>>
43
44 Names the cell in which to run the command. Do not combine this argument
45 with the B<-localauth> flag. For more details, see L<backup(8)>.
46
47 =item B<-help>
48
49 Prints the online help for this command. All other valid options are
50 ignored.
51
52 =back
53
54 =head1 EXAMPLES
55
56 The following command deletes the volume set called user and all volume
57 entries in it:
58
59    % backup delvolset user
60
61 =head1 PRIVILEGE REQUIRED
62
63 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
64 machine where the Backup Server is running, or must be logged onto a
65 server machine as the local superuser C<root> if the B<-localauth> flag is
66 included.
67
68 =head1 SEE ALSO
69
70 L<backup(8)>,
71 L<backup_addvolentry(8)>,
72 L<backup_addvolset(8)>,
73 L<backup_delvolentry(8)>,
74 L<backup_listvolsets(8)>
75
76 =head1 COPYRIGHT
77
78 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
79
80 This documentation is covered by the IBM Public License Version 1.0.  It was
81 converted from HTML to POD by software written by Chas Williams and Russ
82 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.