vol: Remove unneeded braces
[openafs.git] / doc / man-pages / pod1 / vos_backup.pod.in
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 =include fragments/vos-common.pod
44
45 =back
46
47 =head1 OUTPUT
48
49 The following message confirms that the command succeeded:
50
51    Created backup volume for I<volume name>
52
53 =head1 EXAMPLES
54
55 The following example creates a backup version of the volume
56 C<user.smith>.
57
58    % vos backup user.smith
59    Created backup volume for user.smith
60
61 =head1 PRIVILEGE REQUIRED
62
63 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
64 machine specified with the B<-server> argument and on each database server
65 machine. If the B<-localauth> flag is included, the issuer must instead be
66 logged on to a server machine as the local superuser C<root>.
67
68 =head1 SEE ALSO
69
70 L<vos(1)>,
71 L<vos_backupsys(1)>
72
73 =head1 COPYRIGHT
74
75 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
76
77 This documentation is covered by the IBM Public License Version 1.0.  It was
78 converted from HTML to POD by software written by Chas Williams and Russ
79 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.