Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / fileserver.pod.in
blobcc239b777853af61dea6cd14849d9e5a387f8269
1 =head1 NAME
3 fileserver - Initializes the File Server component of the fs process
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 =include fragments/fileserver-synopsis.pod
12 =for html
13 </div>
15 =head1 DESCRIPTION
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.
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>.
27 =include fragments/fileserver-description.pod
29 =head1 CAUTIONS
31 =include fragments/fileserver-cautions.pod
33 =head1 OPTIONS
35 =include fragments/fileserver-options.pod
37 =back
39 =head1 EXAMPLES
41 The following B<bos create> command creates a traditional fs process on
42 the file server machine C<fs2.example.com> that uses the large configuration
43 size, and allows volumes to exceed their quota by 10%. Type the command on
44 a single line:
46    % bos create -server fs2.example.com -instance fs -type fs \
47                 -cmd "/usr/afs/bin/fileserver -pctspare 10 -L" \
48                 /usr/afs/bin/volserver /usr/afs/bin/salvager
50 =head1 TROUBLESHOOTING
52 =include fragments/fileserver-troubleshooting.pod
54 =head1 PRIVILEGE REQUIRED
56 =include fragments/fileserver-privilege.pod
58 =head1 SEE ALSO
60 =include fragments/fileserver-also.pod
61 L<dafileserver(8)>,
63 =head1 COPYRIGHT
65 =include fragments/fileserver-copyright.pod