DEVEL15-man-pages-allow-dots-consistent-20090505
[openafs.git] / doc / man-pages / pod8 / volserver.pod
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 B<volserver> [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
11     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
12     S<<< [B<-d> <I<debug level>>] >>>
13     [B<-nojumbo>] [B<-jumbo>] 
14     [B<-enable_peer_stats>] [B<-enable_process_stats>] 
15     [B<-allow-dotted-principals>] [B<-help>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<volserver> command initializes the Volume Server component of the
23 C<fs> process. In the conventional configuration, its binary file is
24 located in the F</usr/afs/bin> directory on a file server machine.
25
26 The B<volserver> command is not normally issued at the command shell
27 prompt but rather placed into a file server machine's
28 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
29 ever issued at the command shell prompt, the issuer must be logged onto a
30 database server machine as the local superuser C<root>.
31
32 The Volume Server records a trace of its activity in the
33 F</usr/afs/logs/VolserLog> file. Use the B<bos getlog> command to display
34 the contents of the file.
35
36 The Volume Server processes the B<vos> commands that administrators use to
37 create, delete, move, and replicate volumes, as well as prepare them for
38 archiving to tape or other media.
39
40 By default, the VL Server runs nine lightweight processes (LWPs). To
41 change the number, use the B<-p> argument.
42
43 This command does not use the syntax conventions of the AFS command
44 suites. Provide the command name and all option names in full.
45
46 =head1 OPTIONS
47
48 =over 4
49
50 =item B<-d> <I<debug level>>
51
52 Sets the detail level for the debugging trace written to the
53 F</usr/afs/logs/VolserLog> file. Provide one of the following values, each
54 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
55 and C<125>. 
56
57 =item B<-log>
58
59 Records in the /usr/afs/logs/VolserLog file the names of all users who
60 successfully initiate a B<vos> command. The Volume Server also records any
61 file removals that result from issuing the B<vos release> command with the
62 B<-f> flag.
63
64 =item B<-p> <I<number of processes>>
65
66 Sets the number of server lightweight processes (LWPs) to run.  Provide an
67 integer between C<4> and C<16>. The default is C<9>.
68
69 =item B<-udpsize> <I<size of socket buffer>>
70
71 Sets the size of the UDP buffer in bytes, which is 64 KB by
72 default. Provide a positive integer, preferably larger than the default.
73
74 =item B<-jumbo>
75
76 Allows the server to send and receive jumbograms. A jumbogram is
77 a large-size packet composed of 2 to 4 normal Rx data packets that share
78 the same header. The volserver does not use jumbograms by default, as some
79 routers are not capable of properly breaking the jumbogram into smaller
80 packets and reassembling them.
81
82 =item B<-nojumbo>
83
84 Deprecated; jumbograms are disabled by default.
85
86 =item B<-enable_peer_stats>
87
88 Activates the collection of Rx statistics and allocates memory for their
89 storage. For each connection with a specific UDP port on another machine,
90 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
91 so on) sent or received. To display or otherwise access the records, use
92 the Rx Monitoring API.
93
94 =item B<-enable_process_stats>
95
96 Activates the collection of Rx statistics and allocates memory for their
97 storage. A separate record is kept for each type of RPC (FetchFile,
98 GetStatus, and so on) sent or received, aggregated over all connections to
99 other machines. To display or otherwise access the records, use the Rx
100 Monitoring API.
101
102 =item B<-allow-dotted-principals>
103
104 By default, the RXKAD security layer will disallow access by Kerberos
105 principals with a dot in the first component of their name. This is to avoid
106 the confusion where principals user/admin and user.admin are both mapped to the
107 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
108 between principal names may disable this check by starting the server
109 with this option.
110
111 =item B<-help>
112
113 Prints the online help for this command. All other valid options are
114 ignored.
115
116 =back
117
118 =head1 EXAMPLES
119
120 The following B<bos create> command creates a C<volserver> process on the
121 machine C<fs2.abc.com>:
122
123    % bos create -server fs2.abc.com -instance volserver -type simple \
124                  -cmd /usr/afs/bin/volserver
125
126 =head1 PRIVILEGE REQUIRED
127
128 The issuer must be logged in as the superuser C<root> on a file server
129 machine to issue the command at a command shell prompt. It is conventional
130 instead to create and start the process by issuing the B<bos create>
131 command.
132
133 =head1 SEE ALSO
134
135 L<BosConfig(5)>,
136 L<VolserLog(5)>,
137 L<bos_create(8)>,
138 L<bos_getlog(8)>,
139 L<vos(1)>
140
141 =head1 COPYRIGHT
142
143 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
144
145 This documentation is covered by the IBM Public License Version 1.0.  It was
146 converted from HTML to POD by software written by Chas Williams and Russ
147 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.