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