~ubuntu-branches/ubuntu/dapper/openafs/dapper

« back to all changes in this revision

Viewing changes to doc/man-pages/man8/volserver.8

  • Committer: Package Import Robot
  • Author(s): Russ Allbery
  • Date: 2006-04-15 15:47:04 UTC
  • Revision ID: package-import@ubuntu.com-20060415154704-xavpx3mx6bygfc3s
* Exit successfully in the openafs-client init script if no module is
  installed, since otherwise openafs-client will fail to install until
  one builds a module.  This restores previous accidental behavior due
  to a bug in debhelper.  (Closes: #362695)
* libopenafs-dev must conflict with liblwp-dev since they both provide
  liblwp.a.  Thanks, Justin Pryzby.  (Closes: #362842)
* openafs-client recommends lsof, since the init script uses it for
  cleaner shutdown.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.rn '' }`
 
2
''' $RCSfile$$Revision$$Date$
 
3
'''
 
4
''' $Log$
 
5
'''
 
6
.de Sh
 
7
.br
 
8
.if t .Sp
 
9
.ne 5
 
10
.PP
 
11
\fB\\$1\fR
 
12
.PP
 
13
..
 
14
.de Sp
 
15
.if t .sp .5v
 
16
.if n .sp
 
17
..
 
18
.de Ip
 
19
.br
 
20
.ie \\n(.$>=3 .ne \\$3
 
21
.el .ne 3
 
22
.IP "\\$1" \\$2
 
23
..
 
24
.de Vb
 
25
.ft CW
 
26
.nf
 
27
.ne \\$1
 
28
..
 
29
.de Ve
 
30
.ft R
 
31
 
 
32
.fi
 
33
..
 
34
'''
 
35
'''
 
36
'''     Set up \*(-- to give an unbreakable dash;
 
37
'''     string Tr holds user defined translation string.
 
38
'''     Bell System Logo is used as a dummy character.
 
39
'''
 
40
.tr \(*W-|\(bv\*(Tr
 
41
.ie n \{\
 
42
.ds -- \(*W-
 
43
.ds PI pi
 
44
.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
45
.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
 
46
.ds L" ""
 
47
.ds R" ""
 
48
'''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
 
49
'''   \*(L" and \*(R", except that they are used on ".xx" lines,
 
50
'''   such as .IP and .SH, which do another additional levels of
 
51
'''   double-quote interpretation
 
52
.ds M" """
 
53
.ds S" """
 
54
.ds N" """""
 
55
.ds T" """""
 
56
.ds L' '
 
57
.ds R' '
 
58
.ds M' '
 
59
.ds S' '
 
60
.ds N' '
 
61
.ds T' '
 
62
'br\}
 
63
.el\{\
 
64
.ds -- \(em\|
 
65
.tr \*(Tr
 
66
.ds L" ``
 
67
.ds R" ''
 
68
.ds M" ``
 
69
.ds S" ''
 
70
.ds N" ``
 
71
.ds T" ''
 
72
.ds L' `
 
73
.ds R' '
 
74
.ds M' `
 
75
.ds S' '
 
76
.ds N' `
 
77
.ds T' '
 
78
.ds PI \(*p
 
79
'br\}
 
80
.\"     If the F register is turned on, we'll generate
 
81
.\"     index entries out stderr for the following things:
 
82
.\"             TH      Title 
 
83
.\"             SH      Header
 
84
.\"             Sh      Subsection 
 
85
.\"             Ip      Item
 
86
.\"             X<>     Xref  (embedded
 
87
.\"     Of course, you have to process the output yourself
 
88
.\"     in some meaninful fashion.
 
89
.if \nF \{
 
90
.de IX
 
91
.tm Index:\\$1\t\\n%\t"\\$2"
 
92
..
 
93
.nr % 0
 
94
.rr F
 
95
.\}
 
96
.TH volserver 8 "OpenAFS" "1/Mar/2006" "AFS Command Reference"
 
97
.UC
 
98
.if n .hy 0
 
99
.if n .na
 
100
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
101
.de CQ          \" put $1 in typewriter font
 
102
.ft CW
 
103
'if n "\c
 
104
'if t \\&\\$1\c
 
105
'if n \\&\\$1\c
 
106
'if n \&"
 
107
\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 
108
'.ft R
 
109
..
 
110
.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 
111
.       \" AM - accent mark definitions
 
112
.bd B 3
 
113
.       \" fudge factors for nroff and troff
 
114
.if n \{\
 
115
.       ds #H 0
 
116
.       ds #V .8m
 
117
.       ds #F .3m
 
118
.       ds #[ \f1
 
119
.       ds #] \fP
 
120
.\}
 
121
.if t \{\
 
122
.       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
123
.       ds #V .6m
 
124
.       ds #F 0
 
125
.       ds #[ \&
 
126
.       ds #] \&
 
127
.\}
 
128
.       \" simple accents for nroff and troff
 
129
.if n \{\
 
130
.       ds ' \&
 
131
.       ds ` \&
 
132
.       ds ^ \&
 
133
.       ds , \&
 
134
.       ds ~ ~
 
135
.       ds ? ?
 
136
.       ds ! !
 
137
.       ds /
 
138
.       ds q
 
139
.\}
 
140
.if t \{\
 
141
.       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
142
.       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
143
.       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
144
.       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
145
.       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
146
.       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 
147
.       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 
148
.       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
149
.       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 
150
.\}
 
151
.       \" troff and (daisy-wheel) nroff accents
 
152
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
153
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
154
.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 
155
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 
156
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 
157
.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 
158
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
159
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
160
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
161
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
162
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
163
.ds ae a\h'-(\w'a'u*4/10)'e
 
164
.ds Ae A\h'-(\w'A'u*4/10)'E
 
165
.ds oe o\h'-(\w'o'u*4/10)'e
 
166
.ds Oe O\h'-(\w'O'u*4/10)'E
 
167
.       \" corrections for vroff
 
168
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
169
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
170
.       \" for low resolution devices (crt and lpr)
 
171
.if \n(.H>23 .if \n(.V>19 \
 
172
\{\
 
173
.       ds : e
 
174
.       ds 8 ss
 
175
.       ds v \h'-1'\o'\(aa\(ga'
 
176
.       ds _ \h'-1'^
 
177
.       ds . \h'-1'.
 
178
.       ds 3 3
 
179
.       ds o a
 
180
.       ds d- d\h'-1'\(ga
 
181
.       ds D- D\h'-1'\(hy
 
182
.       ds th \o'bp'
 
183
.       ds Th \o'LP'
 
184
.       ds ae ae
 
185
.       ds Ae AE
 
186
.       ds oe oe
 
187
.       ds Oe OE
 
188
.\}
 
189
.rm #[ #] #H #V #F C
 
190
.SH "NAME"
 
191
volserver \- Initializes the Volume Server component of the fs process
 
192
.SH "SYNOPSIS"
 
193
\fBvolserver\fR [\fB\-log\fR] <<\ [\fB\-p\fR\ <\fInumber\ of\ processes\fR] >>>
 
194
    <<\ [\fB\-udpsize\fR\ <\fIsize\ of\ socket\ buffer\ in\ bytes\fR] >>>
 
195
    [\fB\-enable_peer_stats\fR] [\fB\-enable_process_stats\fR] [\fB\-help\fR]
 
196
.SH "DESCRIPTION"
 
197
The \fBvolserver\fR command initializes the Volume Server component of the
 
198
\f(CWfs\fR process. In the conventional configuration, its binary file is
 
199
located in the \fI/usr/afs/bin\fR directory on a file server machine.
 
200
.PP
 
201
The \fBvolserver\fR command is not normally issued at the command shell
 
202
prompt but rather placed into a file server machine's
 
203
\fI/usr/afs/local/BosConfig\fR file with the \fBbos create\fR command. If it is
 
204
ever issued at the command shell prompt, the issuer must be logged onto a
 
205
database server machine as the local superuser \f(CWroot\fR.
 
206
.PP
 
207
The Volume Server records a trace of its activity in the
 
208
\fI/usr/afs/logs/VolserLog\fR file. Use the \fBbos getlog\fR command to display
 
209
the contents of the file.
 
210
.PP
 
211
The Volume Server processes the \fBvos\fR commands that administrators use to
 
212
create, delete, move, and replicate volumes, as well as prepare them for
 
213
archiving to tape or other media.
 
214
.PP
 
215
By default, the VL Server runs nine lightweight processes (LWPs). To
 
216
change the number, use the \fB\-p\fR argument.
 
217
.PP
 
218
This command does not use the syntax conventions of the AFS command
 
219
suites. Provide the command name and all option names in full.
 
220
.SH "OPTIONS"
 
221
.Ip "\fB\-log\fR" 4
 
222
Records in the /usr/afs/logs/VolserLog file the names of all users who
 
223
successfully initiate a \fBvos\fR command. The Volume Server also records any
 
224
file removals that result from issuing the \fBvos release\fR command with the
 
225
\fB\-f\fR flag.
 
226
.Ip "\fB\-p\fR <\fInumber of processes\fR>" 4
 
227
Sets the number of server lightweight processes (LWPs) to run.  Provide an
 
228
integer between \f(CW4\fR and \f(CW16\fR. The default is \f(CW9\fR.
 
229
.Ip "\fB\-udpsize\fR <\fIsize of socket buffer\fR>" 4
 
230
Sets the size of the \s-1UDP\s0 buffer in bytes, which is 64 \s-1KB\s0 by
 
231
default. Provide a positive integer, preferably larger than the default.
 
232
.Ip "\fB\-enable_peer_stats\fR" 4
 
233
Activates the collection of Rx statistics and allocates memory for their
 
234
storage. For each connection with a specific \s-1UDP\s0 port on another machine,
 
235
a separate record is kept for each type of \s-1RPC\s0 (FetchFile, GetStatus, and
 
236
so on) sent or received. To display or otherwise access the records, use
 
237
the Rx Monitoring \s-1API\s0.
 
238
.Ip "\fB\-enable_process_stats\fR" 4
 
239
Activates the collection of Rx statistics and allocates memory for their
 
240
storage. A separate record is kept for each type of \s-1RPC\s0 (FetchFile,
 
241
GetStatus, and so on) sent or received, aggregated over all connections to
 
242
other machines. To display or otherwise access the records, use the Rx
 
243
Monitoring \s-1API\s0.
 
244
.Ip "\fB\-help\fR" 4
 
245
Prints the online help for this command. All other valid options are
 
246
ignored.
 
247
.SH "EXAMPLES"
 
248
The following \fBbos create\fR command creates a \f(CWvolserver\fR process on the
 
249
machine \f(CWfs2.abc.com\fR:
 
250
.PP
 
251
.Vb 2
 
252
\&   % bos create -server fs2.abc.com -instance volserver -type simple \e
 
253
\&                 -cmd /usr/afs/bin/volserver
 
254
.Ve
 
255
.SH "PRIVILEGE REQUIRED"
 
256
The issuer must be logged in as the superuser \f(CWroot\fR on a file server
 
257
machine to issue the command at a command shell prompt. It is conventional
 
258
instead to create and start the process by issuing the \fBbos create\fR
 
259
command.
 
260
.SH "SEE ALSO"
 
261
the \fIBosConfig(5)\fR manpage,
 
262
the \fIVolserLog(5)\fR manpage,
 
263
the \fIbos_create(8)\fR manpage,
 
264
the \fIbos_getlog(8)\fR manpage,
 
265
the \fIvos(1)\fR manpage
 
266
.SH "COPYRIGHT"
 
267
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 
268
.PP
 
269
This documentation is covered by the IBM Public License Version 1.0.  It was
 
270
converted from HTML to POD by software written by Chas Williams and Russ
 
271
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
 
272
 
 
273
.rn }` ''
 
274
.IX Title "volserver 8"
 
275
.IX Name "volserver - Initializes the Volume Server component of the fs process"
 
276
 
 
277
.IX Header "NAME"
 
278
 
 
279
.IX Header "SYNOPSIS"
 
280
 
 
281
.IX Header "DESCRIPTION"
 
282
 
 
283
.IX Header "OPTIONS"
 
284
 
 
285
.IX Item "\fB\-log\fR"
 
286
 
 
287
.IX Item "\fB\-p\fR <\fInumber of processes\fR>"
 
288
 
 
289
.IX Item "\fB\-udpsize\fR <\fIsize of socket buffer\fR>"
 
290
 
 
291
.IX Item "\fB\-enable_peer_stats\fR"
 
292
 
 
293
.IX Item "\fB\-enable_process_stats\fR"
 
294
 
 
295
.IX Item "\fB\-help\fR"
 
296
 
 
297
.IX Header "EXAMPLES"
 
298
 
 
299
.IX Header "PRIVILEGE REQUIRED"
 
300
 
 
301
.IX Header "SEE ALSO"
 
302
 
 
303
.IX Header "COPYRIGHT"
 
304