[dragonfly.git] / sbin / nfsiod / nfsiod.8

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     From: @(#)nfsiod.8	8.2 (Berkeley) 2/22/94
.\" $FreeBSD: src/sbin/nfsiod/nfsiod.8,v 1.9.2.3 2003/02/23 20:50:43 trhodes Exp $
.\" $DragonFly: src/sbin/nfsiod/nfsiod.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
.\"
.Dd September 22, 1994
.Dt NFSIOD 8
.Os
.Sh NAME
.Nm nfsiod
.Nd local
.Tn NFS
asynchronous I/O server
.Sh SYNOPSIS
.Nm
.Op Fl n Ar num_servers
.Sh DESCRIPTION
.Nm Nfsiod
runs on an
.Tn NFS
client machine to service asynchronous I/O requests to its server.
It improves performance but is not required for correct operation.
.Pp
Unless otherwise specified, a single server is started.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl n
Specify how many servers are to be started.
.El
.Pp
A client should run enough daemons to handle its maximum
level of concurrency, typically four to six.
.Pp
If
.Nm
detects that the running kernel does not include
.Tn NFS
support, it will attempt to load a loadable kernel module containing
.Tn NFS
code, using
.Xr kldload 8
by way of
.Xr vfsload 3 .
If this fails, or no
.Tn NFS
KLD was available,
The
.Nm
utility exits with an error.
.Sh DIAGNOSTICS
.Ex -std
.Sh SEE ALSO
.Xr nfsstat 1 ,
.Xr nfssvc 2 ,
.Xr kldload 8 ,
.Xr mountd 8 ,
.Xr nfsd 8 ,
.Xr rpcbind 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
Commit	Line	Data
984263bc MD	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. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" From: @(#)nfsiod.8 8.2 (Berkeley) 2/22/94
	33	.\" $FreeBSD: src/sbin/nfsiod/nfsiod.8,v 1.9.2.3 2003/02/23 20:50:43 trhodes Exp $
1de703da	34	.\" $DragonFly: src/sbin/nfsiod/nfsiod.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
984263bc MD	35	.\"
	36	.Dd September 22, 1994
	37	.Dt NFSIOD 8
	38	.Os
	39	.Sh NAME
	40	.Nm nfsiod
	41	.Nd local
	42	.Tn NFS
	43	asynchronous I/O server
	44	.Sh SYNOPSIS
	45	.Nm
	46	.Op Fl n Ar num_servers
	47	.Sh DESCRIPTION
	48	.Nm Nfsiod
	49	runs on an
	50	.Tn NFS
	51	client machine to service asynchronous I/O requests to its server.
	52	It improves performance but is not required for correct operation.
	53	.Pp
	54	Unless otherwise specified, a single server is started.
	55	.Pp
	56	The options are as follows:
	57	.Bl -tag -width indent
	58	.It Fl n
	59	Specify how many servers are to be started.
	60	.El
	61	.Pp
	62	A client should run enough daemons to handle its maximum
	63	level of concurrency, typically four to six.
	64	.Pp
	65	If
	66	.Nm
	67	detects that the running kernel does not include
	68	.Tn NFS
	69	support, it will attempt to load a loadable kernel module containing
	70	.Tn NFS
	71	code, using
	72	.Xr kldload 8
	73	by way of
	74	.Xr vfsload 3 .
	75	If this fails, or no
	76	.Tn NFS
	77	KLD was available,
	78	The
	79	.Nm
	80	utility exits with an error.
	81	.Sh DIAGNOSTICS
	82	.Ex -std
	83	.Sh SEE ALSO
	84	.Xr nfsstat 1 ,
	85	.Xr nfssvc 2 ,
	86	.Xr kldload 8 ,
	87	.Xr mountd 8 ,
	88	.Xr nfsd 8 ,
3b813696	89	.Xr rpcbind 8
984263bc MD	90	.Sh HISTORY
	91	The
	92	.Nm
	93	utility first appeared in
	94	.Bx 4.4 .