Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / sbin / nfsiod / nfsiod.8
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 .\"     From: @(#)nfsiod.8      8.2 (Berkeley) 2/22/94
29 .\" $FreeBSD: src/sbin/nfsiod/nfsiod.8,v 1.9.2.3 2003/02/23 20:50:43 trhodes Exp $
30 .\" $DragonFly: src/sbin/nfsiod/nfsiod.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
31 .\"
32 .Dd September 22, 1994
33 .Dt NFSIOD 8
34 .Os
35 .Sh NAME
36 .Nm nfsiod
37 .Nd local
38 .Tn NFS
39 asynchronous I/O server
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl n Ar num_servers
43 .Sh DESCRIPTION
44 .Nm Nfsiod
45 runs on an
46 .Tn NFS
47 client machine to service asynchronous I/O requests to its server.
48 It improves performance but is not required for correct operation.
49 .Pp
50 Unless otherwise specified, a single server is started.
51 .Pp
52 The options are as follows:
53 .Bl -tag -width indent
54 .It Fl n
55 Specify how many servers are to be started.
56 .El
57 .Pp
58 A client should run enough daemons to handle its maximum
59 level of concurrency, typically four to six.
60 .Pp
61 If
62 .Nm
63 detects that the running kernel does not include
64 .Tn NFS
65 support, it will attempt to load a loadable kernel module containing
66 .Tn NFS
67 code, using
68 .Xr kldload 8
69 by way of
70 .Xr vfsload 3 .
71 If this fails, or no
72 .Tn NFS
73 KLD was available,
74 The
75 .Nm
76 utility exits with an error.
77 .Sh EXIT STATUS
78 .Ex -std
79 .Sh SEE ALSO
80 .Xr nfsstat 1 ,
81 .Xr nfssvc 2 ,
82 .Xr kldload 8 ,
83 .Xr mountd 8 ,
84 .Xr nfsd 8 ,
85 .Xr rpcbind 8
86 .Sh HISTORY
87 The
88 .Nm
89 utility first appeared in
90 .Bx 4.4 .