doc: fs examine no longer requires read rights on the volume root vnode
[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>]
14     S<<< [B<-config> <I<config directory>>] >>>
15     [B<-help>]
16
17 B<vos backup> S<<< B<-i> <I<volume name or ID>> >>> [B<-c> <I<cell name>>]
18     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
19     S<<< [B<-co> <I<config directory>>] >>>
20     [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<vos backup> command clones the indicated read/write volume to create
28 a backup version, placing it at the same site as the read/write
29 version. The backup volume's name is the same as the read/write source's
30 with the addition of the C<.backup> extension. Its volume ID number is the
31 one allocated for it in the Volume Location Database (VLDB) when the
32 read/write source was created with the B<vos create> command. If a backup
33 version already exists, the new clone replaces it.
34
35 To create a backup version of multiple volumes, use the B<vos backupsys>
36 command.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-id> <I<volume name or ID>>
43
44 Specifies either the complete name or volume ID number of the read/write
45 source volume.
46
47 =include fragments/vos-common.pod
48
49 =back
50
51 =head1 OUTPUT
52
53 The following message confirms that the command succeeded:
54
55    Created backup volume for I<volume name>
56
57 =head1 EXAMPLES
58
59 The following example creates a backup version of the volume
60 C<user.smith>.
61
62    % vos backup user.smith
63    Created backup volume for user.smith
64
65 =head1 PRIVILEGE REQUIRED
66
67 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
68 machine specified with the B<-server> argument and on each database server
69 machine. If the B<-localauth> flag is included, the issuer must instead be
70 logged on to a server machine as the local superuser C<root>.
71
72 =head1 SEE ALSO
73
74 L<vos(1)>,
75 L<vos_backupsys(1)>
76
77 =head1 COPYRIGHT
78
79 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
80
81 This documentation is covered by the IBM Public License Version 1.0.  It was
82 converted from HTML to POD by software written by Chas Williams and Russ
83 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.