OPENAFS-SA-2018-001 backup: use authenticated connection to butc
[openafs.git] / doc / man-pages / pod8 / volserver.pod.in
1 =head1 NAME
2
3 volserver - Initializes the Volume Server component of the fs process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 =include fragments/volserver-synopsis.pod
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<volserver> command initializes the Volume Server component of the
18 C<fs> process. In the conventional configuration, its binary file is
19 located in the F</usr/afs/bin> directory on a file server machine.
20
21 The B<volserver> command is not normally issued at the command shell
22 prompt but rather placed into a file server machine's
23 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
24 ever issued at the command shell prompt, the issuer must be logged onto a
25 database server machine as the local superuser C<root>.
26
27 =include fragments/volserver-description.pod
28
29 =head1 OPTIONS
30
31 =include fragments/volserver-options.pod
32
33 =head1 EXAMPLES
34
35 The following B<bos create> command creates a C<volserver> process on the
36 machine C<fs2.example.com> as part of the fs process:
37
38    % bos create -server fs2.example.com -instance fs -type fs \
39                 -cmd "/usr/afs/bin/fileserver" \
40                 /usr/afs/bin/volserver /usr/afs/bin/salvager
41
42 =head1 PRIVILEGE REQUIRED
43
44 =include fragments/volserver-privilege.pod
45
46 =head1 SEE ALSO
47
48 =include fragments/volserver-also.pod
49 L<davolserver(8)>,
50
51 =head1 COPYRIGHT
52
53 =include fragments/fileserver-copyright.pod