f83cad76d6bc7078c42c8b96f15c3358b3a4c542
[openafs.git] / src / man / fileserver.1
1 fileserver                 AFS Commands              fileserver
2
3
4 NAME
5
6    fileserver -- initialize   File   Server  component  of  fs
7
8                        process.
9
10
11    /usr/afs/bin/fileserver [-b <buffers>]  [-banner]  [-cb
12    <callbacks>]
13    [-d <debug level>]  [-k <stack size>]  [-l <large vnodes>]
14             [-oldvldb]  [-pctspare <percent>]  [-rxdbg]
15    [-rxdbge]  [-rxpck]
16    [-s <small vnodes>]  [-spare <kilobyte blocks>]
17    [-w <callback wait interval>]
18    [-c <check interval>]  [-ftpck <r ftp packets>]  [-noauth]
19             [-p <LWPs>]  [-r <r retry count>]  [-rpck <r
20    packets
21
22 DESCRIPTION
23
24    Initializes the File Server component of the fs process.
25
26    The arguments on fileserver allow the issuer to control many
27    aspects  of  its  behavior,  as  detailed  in  the ARGUMENTS
28    section.
29
30    Perhaps  the  most  important  aspect  to  control  from  an
31    administrative standpoint is that by default the File Server
32    allows users to store up to a megabyte (1024  kilobytes)  of
33    data  in a volume after the volume's quota is exceeded.  The
34    user still cannot create new files after quota is  exceeded.
35    The  issuer  of this command can change the default with the
36    -spare or -pctspare arguments:
37
38       - -spare specifies  the  number  of  kilobytes  over
39         quota  the  File Server will allow.  To make users
40         unable to store files after the quota is exceeded,
41         specify a value of 0.
42
43       - -pctspare  expresses the amount of excess the File
44         Server will allow as a percentage of the  volume's
45         quota.
46
47 WARNING
48
49    This  command  is  not  normally issued at the command shell
50    prompt, but rather  placed  into  a  file  server  machine's
51    /usr/afs/local/BosConfig with the bos create command.  If it
52    is ever issued at the command shell prompt, the issuer  must
53    be working on a file server machine.
54
55    Several  of this command's arguments are intended for use by
56    AFS developers only.    Changing  them  from  their  default
57    values   is   strongly   discouraged   and   may  result  in
58    unpredictable File Server behavior.  The relevant  arguments
59    are marked in the ARGUMENTS section.
60
61    This  command does not use the syntax conventions of the AFS
62    command suites, so the command  and  switch  names  must  be
63    typed in full.
64
65    Do  not  specify both -spare and -pctspare.  Doing so causes
66
67
68
69    the File  Server  to  exit,  leaving  an  error  message  in
70    /usr/afs/logs/FileLog.
71
72 ARGUMENTS
73
74    -b           sets the number of directory buffers, which are
75                 2 kilobytes each.  Provide a positive  integer.
76                 The default is 70.
77
78    -banner      causes  the File Server to prints the following
79                 banner to /dev/console about every 10 minutes.
80
81                     File Server is running at time.
82
83    -cb          sets the number of callbacks  the  File  Server
84                 can  track.    Provide a positive integer.  The
85                 default is 20,000.
86
87    -d           sets the detail level for the  debugging  trace
88                 the      File      Server      produces      in
89                 /usr/afs/logs/FileLog.    Provide  a   positive
90                 integer;  higher values (up to a point) produce
91                 greater  detail.    The  default  level  of   0
92                 produces no trace.
93
94    -k           sets the LWP stack size in units of 1 kilobyte.
95                 Provide a positive integer.  The default is  24
96                 (kilobytes).    Do  not set this argument lower
97                 than the default.
98
99    -l           sets the number of large  vnodes  to  use  (for
100                 tracking   directory   elements).    Provide  a
101                 positive integer.  The default is 200.
102
103    -oldvldb     directs the File Server to use  the  pre-AFS  3
104                 volume  location  facility rather than the VLDB
105                 and VL Server.
106
107    -pctspare    specifies the amount by which the  File  Server
108                 will  allow  a volume to exceed its quota, as a
109                 percentage of the quota.   Provide  an  integer
110                 between  0  and  99.  A value of 0 prevents the
111                 volume from ever exceeding its quota.   Do  not
112                 combine this argument with -spare.
113
114    -rxdbg       sends  an Rx debugging trace to the rx_dbg file
115                 in the current working directory.
116
117    -rxdbge      sends an Rx event debugging trace to the rx_dbg
118                 file in the current working directory.
119
120    -rxpck       sets the number of extra Rx packets to reserve.
121                 Provide a positive integer.    The  default  is
122                 100.    Do  not use this argument; changing its
123                 default may cause unpredictable behavior.
124
125    -s           sets the number of small  vnodes  to  use  (for
126                 tracking  file  elements).   Provide a positive
127                 integer. The default is 200.
128
129    -spare       specifies the number  of  extra  kilobytes  the
130
131
132
133                 File  Server  will  allow  users  to store in a
134                 volume after its quota is exceeded.  Provide  a
135                 positive  integer.    A value of 0 prevents the
136                 volume from ever exceeding its quota.   Do  not
137                 combine this argument with -pctspare.
138
139    -w           sets  the  interval at which daemons spawned by
140                 the  File  Server  perform  their   maintenance
141                 tasks.  The default is 300 seconds (5 minutes).
142                 Do not use this argument; changing its  default
143                 may cause unpredictable behavior.
144
145    -c           is not implemented.
146
147    -ftpck       is obsolete.
148
149    -noauth      is obsolete.
150
151    -p           is obsolete.
152
153    -r           is obsolete.
154
155    -rpck        is obsolete.
156
157 EXAMPLES
158
159    The  following  bos create  command creates an fs process on
160    fs2.transarc.com that allows volumes to exceed  their  quota
161    by 10%.
162
163    Type the command on a single line.
164
165    % bos create fs2.transarc.com fs fs "/usr/afs/bin/fileserver
166    -pctspare 10"
167    /usr/afs/bin/volserver  /usr/afs/bin/salvager
168
169 PRIVILEGE REQUIRED
170
171    Issuer must be listed in /usr/afs/etc/UserList to place this
172    command in /usr/afs/local/BosConfig,  because  that  is  the
173    privilege required to issue bos create.
174
175 MORE INFORMATION
176
177    bos create