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