doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / vos_online.pod.in
1 =head1 NAME
2
3 vos_online - Brings a volume online
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos online> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-partition> <I<partition name>> >>> 
12     S<<< B<-id> <I<volume name or ID>> >>>
13     S<<< [B<-cell> <I<cell name>>] >>>
14     [B<-noauth>] B<-localauth>]
15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
16     S<<< [B<-config> <I<config directory>>] >>>
17     [B<-help>]
18
19 B<vos on> S<<< B<-s> <I<machine name>> >>>
20     S<<< B<-p> <I<partition name>> >>> 
21     S<<< B<-i> <I<volume name or ID>> >>>
22     S<<< [B<-c> <I<cell name>>] >>>
23     [B<-noa>] B<-l>] [B<-v>] [B<-e>] [B<-nor>]
24     S<<< [B<-co> <I<config directory>>] >>>
25     [B<-h>]
26
27 =for html
28 </div>
29
30 =head1 DESCRIPTION
31
32 The B<vos online> command brings an offline volume on line with the 
33 B<fileserver>.
34
35 =head1 CAUTIONS
36
37 None.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<-server> <I<machine name>>
44
45 Identifies the file server machine where the volume resides. 
46 Provide the machine's IP address or its host name (either fully
47 qualified or using an unambiguous abbreviation). For details, see
48 L<vos(1)>.
49
50 =item B<-partition> <I<partition name>>
51
52 Identifies the partition where the volume resides, on the
53 file server machine named by the B<-server> argument. Provide the
54 partition's complete name with preceding slash (for example, C</vicepa>)
55 or use one of the three acceptable abbreviated forms. For details, see
56 L<vos(1)>.
57
58 =item B<-id> <I<volume name or ID>>
59
60 Specifies either the complete name or volume ID number of the volume.
61
62 =include fragments/vos-common.pod
63
64 =back
65
66 =head1 EXAMPLES
67
68 The following example brings an offline volume online:
69
70    % vos online -server sv7.example.org -partition /vicepb -id root.afs
71
72 =head1 PRIVILEGE REQUIRED
73
74 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
75 machine specified with the B<-server> argument and on each database server
76 machine. If the B<-localauth> flag is included, the issuer must instead be
77 logged on to a server machine as the local superuser C<root>.
78
79 =head1 SEE ALSO
80
81 L<vos(1)>,
82 L<vos_offline(1)>,
83 L<bos_salvage(8)>,
84
85 =head1 COPYRIGHT
86
87 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
88
89 This man page was created by Steven Jenkins.