man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod1 / vos_backup.pod
1 =head1 NAME
2
3 vos backup - Creates a backup volume for a single read/write volume
4
5 =head1 SYNOPSIS
6
7 B<vos backup> B<-id> <I<volume name or ID>> [B<-cell> <I<cell name>>]
8     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
9    
10 B<vos backup> B<-i> <I<volume name or ID>> [B<-c><I<cell name>>]
11     [B<-n>] [B<-l>] [B<-v>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<vos backup> command clones the indicated read/write volume to create
16 a backup version, placing it at the same site as the read/write
17 version. The backup volume's name is the same as the read/write source's
18 with the addition of the C<.backup> extension. Its volume ID number is the
19 one allocated for it in the Volume Location Database (VLDB) when the
20 read/write source was created with the B<vos create> command. If a backup
21 version already exists, the new clone replaces it.
22
23 To create a backup version of multiple volumes, use the B<vos backupsys>
24 command.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-id> <I<volume name or ID>>
31
32 Specifies either the complete name or volume ID number of the read/write
33 source volume.
34
35 =item B<-cell> <I<cell name>>
36
37 Names the cell in which to run the command. Do not combine this argument
38 with the B<-localauth> flag. For more details, see L<vos(1)>.
39
40 =item B<-noauth>
41
42 Assigns the unprivileged identity anonymous to the issuer. Do not combine
43 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
44
45 =item B<-localauth>
46
47 Constructs a server ticket using a key from the local
48 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
49 to the Volume Server and Volume Location Server during mutual
50 authentication. Do not combine this flag with the B<-cell> argument or
51 B<-noauth> flag. For more details, see L<vos(1)>.
52
53 =item B<-verbose>
54
55 Produces on the standard output stream a detailed trace of the command's
56 execution. If this argument is omitted, only warnings and error messages
57 appear.
58
59 =item B<-help>
60
61 Prints the online help for this command. All other valid options are
62 ignored.
63
64 =back
65
66 =head1 OUTPUT
67
68 The following message confirms that the command succeeded:
69
70    Created backup volume for I<volume name>
71
72 =head1 EXAMPLES
73
74 The following example creates a backup version of the volume
75 C<user.smith>.
76
77    % vos backup user.smith
78    Created backup volume for user.smith
79
80 =head1 PRIVILEGE REQUIRED
81
82 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
83 machine specified with the B<-server> argument and on each database server
84 machine. If the B<-localauth> flag is included, the issuer must instead be
85 logged on to a server machine as the local superuser C<root>.
86
87 =head1 SEE ALSO
88
89 L<vos(1)>,
90 L<vos_backupsys(1)>
91
92 =head1 COPYRIGHT
93
94 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
95
96 This documentation is covered by the IBM Public License Version 1.0.  It was
97 converted from HTML to POD by software written by Chas Williams and Russ
98 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.