Cleaned up the wording in the rpc.nfsd(8) manpage
[nfs-utils.git] / utils / nfsd / nfsd.man
1 .\"
2 .\" nfsd(8)
3 .\"
4 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
5 .TH rpc.nfsd 8 "7 Aug 2006"
6 .SH NAME
7 rpc.nfsd \- NFS server process
8 .SH SYNOPSIS
9 .BI "/usr/sbin/rpc.nfsd [" options "]" " "nproc
10 .SH DESCRIPTION
11 The
12 .B rpc.nfsd
13 program implements the user level part of the NFS service. The
14 main functionality is handled by the
15 .B nfsd
16 kernel module; the user space program merely starts the specified
17 number of kernel threads.
18 .P
19 The
20 .B rpc.mountd
21 server provides an ancillary service needed to satisfy mount requests
22 by NFS clients.
23 .SH OPTIONS
24 .TP
25 .B \-H " or " \-\-host  hostname
26 specify a particular hostname (or address) that NFS requests will
27 be accepted on. By default,
28 .B rpc.nfsd
29 will accept NFS requests on all known network addresses.
30 Note that
31 .B lockd
32 (which performs file locking services for NFS) may still accept
33 request on all known network addresses.  This may change in future
34 releases of the Linux Kernel.
35 .TP
36 .B \-p " or " \-\-port  port
37 specify a diferent port to listen on for NFS requests. By default,
38 .B rpc.nfsd
39 will listen on port 2049.
40 .TP
41 .B \-N " or " \-\-no-nfs-version vers
42 This option can be used to request that 
43 .B rpc.nfsd
44 does not offer certain versions of NFS. The current version of
45 .B rpc.nfsd
46 can support both NFS version 2,3 and the newer version 4.
47 .TP
48 .B \-T " or " \-\-no-tcp
49 Disable 
50 .B rpc.nfsd 
51 from accepting TCP connections from clients.
52 .TP
53 .B \-U " or " \-\-no-udp
54 Disable
55 .B rpc.nfsd
56 from accepting UDP connections from clients.
57 .TP
58 .I nproc
59 specify the number of NFS server threads. By default, just one
60 thread is started. However, for optimum performance several threads
61 should be used. The actual figure depends on the number of and the work
62 load created by the NFS clients, but a useful starting point is
63 8 threads. Effects of modifying that number can be checked using
64 the
65 .BR nfsstat (8)
66 program.
67 .P
68 Note that if the NFS server is already running, then the options for
69 specifying host, port, and protocol will be ignored.  The number of
70 processes given will be the only option considered, and the number of
71 active
72 .B nfsd
73 processes will be increased or decreased to match this number.
74 In particular
75 .B rpc.nfsd 0
76 will stop all threads and thus close any open connections.
77
78 .SH SEE ALSO
79 .BR rpc.mountd (8),
80 .BR exports (5),
81 .BR exportfs (8),
82 .BR rpc.rquotad (8),
83 .BR nfsstat (8).
84 .SH AUTHOR
85 Olaf Kirch, Bill Hawes, H. J. Lu, G. Allan Morris III,
86 and a host of others.