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