nfsd: Add support for the -V and --nfs-version optional arguments
[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 specifies what sort of sockets
17 the kernel service should listen on, what NFS versions it should support, and
18 how many kernel threads it should use.
19 .P
20 The
21 .B rpc.mountd
22 server provides an ancillary service needed to satisfy mount requests
23 by NFS clients.
24 .SH OPTIONS
25 .TP
26 .B \-d " or " \-\-debug
27 enable logging of debugging messages
28 .TP
29 .B \-H " or " \-\-host  hostname
30 specify a particular hostname (or address) that NFS requests will
31 be accepted on. By default,
32 .B rpc.nfsd
33 will accept NFS requests on all known network addresses.
34 Note that
35 .B lockd
36 (which performs file locking services for NFS) may still accept
37 request on all known network addresses.  This may change in future
38 releases of the Linux Kernel.
39 .TP
40 .B \-p " or " \-\-port  port
41 specify a different port to listen on for NFS requests. By default,
42 .B rpc.nfsd
43 will listen on port 2049.
44 .TP
45 .B \-N " or " \-\-no-nfs-version vers
46 This option can be used to request that 
47 .B rpc.nfsd
48 does not offer certain versions of NFS. The current version of
49 .B rpc.nfsd
50 can support NFS versions 2,3,4 and the newer version 4.1.
51 .TP
52 .B \-s " or " \-\-syslog
53 By default,
54 .B rpc.nfsd
55 logs error messages (and debug messages, if enabled) to stderr. This option makes 
56 .B rpc.nfsd
57 log these messages to syslog instead. Note that errors encountered during
58 option processing will still be logged to stderr regardless of this option.
59 .TP
60 .B \-T " or " \-\-no-tcp
61 Disable 
62 .B rpc.nfsd 
63 from accepting TCP connections from clients.
64 .TP
65 .B \-U " or " \-\-no-udp
66 Disable
67 .B rpc.nfsd
68 from accepting UDP connections from clients.
69 .TP
70 .B \-V " or " \-\-nfs-version vers
71 This option can be used to request that 
72 .B rpc.nfsd
73 offer certain versions of NFS. The current version of
74 .B rpc.nfsd
75 can support NFS versions 2,3,4 and the newer version 4.1.
76 .TP
77 .I nproc
78 specify the number of NFS server threads. By default, just one
79 thread is started. However, for optimum performance several threads
80 should be used. The actual figure depends on the number of and the work
81 load created by the NFS clients, but a useful starting point is
82 8 threads. Effects of modifying that number can be checked using
83 the
84 .BR nfsstat (8)
85 program.
86 .P
87 Note that if the NFS server is already running, then the options for
88 specifying host, port, and protocol will be ignored.  The number of
89 processes given will be the only option considered, and the number of
90 active
91 .B nfsd
92 processes will be increased or decreased to match this number.
93 In particular
94 .B rpc.nfsd 0
95 will stop all threads and thus close any open connections.
96
97 .SH NOTES
98 If the program is built with TI-RPC support, it will enable any protocol and
99 address family combinations that are marked visible in the
100 .B netconfig
101 database.
102
103 .SH SEE ALSO
104 .BR rpc.mountd (8),
105 .BR exports (5),
106 .BR exportfs (8),
107 .BR rpc.rquotad (8),
108 .BR nfsstat (8),
109 .BR netconfig(5).
110 .SH AUTHOR
111 Olaf Kirch, Bill Hawes, H. J. Lu, G. Allan Morris III,
112 and a host of others.