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