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