doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_online.pod
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 =item B<-cell> <I<cell name>>
63
64 Names the cell in which to run the command. Do not combine this argument
65 with the B<-localauth> flag. For more details, see L<vos(1)>.
66
67 =item B<-noauth>
68
69 Assigns the unprivileged identity anonymous to the issuer. Do not combine
70 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
71
72 =item B<-localauth>
73
74 Constructs a server ticket using a key from the local
75 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
76 to the Volume Server and Volume Location Server during mutual
77 authentication. Do not combine this flag with the B<-cell> argument or
78 B<-noauth> flag. For more details, see L<vos(1)>.
79
80 =item B<-verbose>
81
82 Produces on the standard output stream a detailed trace of the command's
83 execution. If this argument is omitted, only warnings and error messages
84 appear.
85
86 =item B<-encrypt>
87
88 Encrypts the command so that the operation's results are not transmitted
89 across the network in clear text. This option is available in OpenAFS
90 versions 1.4.11 or later and 1.5.60 or later.
91
92 =item B<-noresolve>
93
94 Shows all servers as IP addresses instead of the DNS name. This is very
95 useful when the server address is registered as 127.0.0.1 or when dealing
96 with multi-homed servers. This option is available in OpenAFS
97 versions 1.4.8 or later and 1.5.35 or later.
98
99 =item B<-help>
100
101 Prints the online help for this command. All other valid options are
102 ignored.
103
104 =back
105
106 =head1 EXAMPLES
107
108 The following example brings an offline volume online:
109
110    % vos online -server sv7.example.org -partition /vicepb -id root.afs
111
112 =head1 PRIVILEGE REQUIRED
113
114 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
115 machine specified with the B<-server> argument and on each database server
116 machine. If the B<-localauth> flag is included, the issuer must instead be
117 logged on to a server machine as the local superuser C<root>.
118
119 =head1 SEE ALSO
120
121 L<vos(1)>,
122 L<vos_offline(1)>,
123 L<bos_salvage(8)>,
124
125 =head1 COPYRIGHT
126
127 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
128
129 This man page was created by Steven Jenkins.