3002f80e151945b84f4e2ce4a3c4a2539b1b3306
[openafs.git] / doc / man-pages / pod8 / fileserver.pod.in
1 =head1 NAME
2
3 fileserver - Initializes the File Server component of the fs process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 =include fragments/fileserver-synopsis.pod
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<fileserver> command initializes the File 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<fileserver> command is not normally issued at the command shell
22 prompt, but rather placed into a database 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 file server machine as the local superuser C<root>.
26
27 =include fragments/fileserver-description.pod
28
29 =head1 CAUTIONS
30
31 =include fragments/fileserver-cautions.pod
32
33 =head1 OPTIONS
34
35 =include fragments/fileserver-options.pod
36 =back
37
38 =head1 EXAMPLES
39
40 The following B<bos create> command creates a traditional fs process on
41 the file server machine C<fs2.abc.com> that uses the large configuration
42 size, and allows volumes to exceed their quota by 10%. Type the command on
43 a single line:
44
45    % bos create -server fs2.abc.com -instance fs -type fs \
46                 -cmd "/usr/afs/bin/fileserver -pctspare 10 -L" \
47                 /usr/afs/bin/volserver /usr/afs/bin/salvager
48
49 =head1 TROUBLESHOOTING
50
51 =include fragments/fileserver-troubleshooting.pod
52
53 =head1 PRIVILEGE REQUIRED
54
55 =include fragments/fileserver-privilege.pod
56
57 =head1 SEE ALSO
58
59 =include fragments/fileserver-also.pod
60 L<dafileserver(8)>,
61
62 =head1 COPYRIGHT
63
64 =include fragments/fileserver-copyright.pod