xref: /freebsd/sbin/nfsiod/nfsiod.8 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (c) 1989, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd December 26, 2009
29.Dt NFSIOD 8
30.Os
31.Sh NAME
32.Nm nfsiod
33.Nd local
34.Tn NFS
35asynchronous I/O server
36.Sh SYNOPSIS
37.Nm
38.Op Fl n Ar num_servers
39.Sh DESCRIPTION
40The
41.Nm
42utility controls the maximum number of
43.Nm
44kernel processes which run on an
45.Tn NFS
46client machine to service asynchronous I/O requests to its server.
47Having
48.Nm
49kernel processes
50improves performance but is not required for correct operation.
51.Pp
52The option is as follows:
53.Bl -tag -width indent
54.It Fl n
55Specify how many processes are permitted to be started.
56.El
57.Pp
58Without an option,
59.Nm
60displays the current settings.
61A client should allow enough number of processes to handle its maximum
62level of concurrency, typically four to six.
63.Pp
64If
65.Nm
66detects that the running kernel does not include
67.Tn NFS
68support, it will attempt to load a kernel module containing
69.Tn NFS
70code, using
71.Xr kldload 2 .
72If this fails, or no
73.Tn NFS
74module was available,
75.Nm
76exits with an error.
77.Sh EXIT STATUS
78.Ex -std
79.Sh SEE ALSO
80.Xr nfsstat 1 ,
81.Xr kldload 2 ,
82.Xr nfssvc 2 ,
83.Xr mountd 8 ,
84.Xr nfsd 8 ,
85.Xr rpcbind 8
86.Sh HISTORY
87The
88.Nm
89utility first appeared in
90.Bx 4.4 .
91.Pp
92Starting with
93.Fx 5.0 ,
94the utility no longer starts daemons, but only serves as a vfs
95loader and
96.Xr sysctl 3
97wrapper.
98