[dragonfly.git] / sbin / mountd / mountd.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.
.\"
.\"     @(#)mountd.8	8.4 (Berkeley) 4/28/95
.\" $FreeBSD: src/sbin/mountd/mountd.8,v 1.16.2.2 2000/12/08 14:04:02 ru Exp $
.\" $DragonFly: src/sbin/mountd/mountd.8,v 1.4 2007/11/23 23:16:36 swildner Exp $
.\"
.Dd April 28, 1995
.Dt MOUNTD 8
.Os
.Sh NAME
.Nm mountd
.Nd service remote
.Tn NFS
mount requests
.Sh SYNOPSIS
.Nm
.Op Fl 2dlnr
.Op Ar exportsfile
.Sh DESCRIPTION
.Nm Mountd
is the server for
.Tn NFS
mount requests from other client machines.
It listens for service requests at the port indicated in the
.Tn NFS
server specification; see
.%T "Network File System Protocol Specification" ,
RFC 1094, Appendix A and
.%T "NFS: Network File System Version 3 Protocol Specification" ,
Appendix I.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl 2
Allow the administrator to force clients to use only the
version 2
.Tn NFS
protocol to mount filesystems from this server.
.It Fl d
Output debugging information.
.It Fl l
Cause all succeeded
.Nm
requests to be logged.
.It Fl n
Allow non-root mount requests to be served.
This should only be specified if there are clients such as PC's,
that require it.
It will automatically clear the
.Va vfs.nfs.nfs_privport
sysctl flag, which
controls if the kernel will accept NFS requests from reserved ports only.
.It Fl r
Allow mount RPCs requests for regular files to be served.
Although this seems to violate the mount protocol specification,
some diskless workstations do mount requests for
their swapfiles and expect them to be regular files.
Since a regular file cannot be specified in
.Pa /etc/exports ,
the entire file system in which the swapfiles resides
will have to be exported with the
.Fl alldirs
flag.
.It Ar exportsfile
Specify an alternate location
for the exports file.
.El
.Pp
When
.Nm
is started,
it loads the export host addresses and options into the kernel
using the
.Xr mount 2
system call.
After changing the exports file,
a hangup signal should be sent to the
.Nm
daemon
to get it to reload the export information.
After sending the SIGHUP
(kill \-s HUP `cat /var/run/mountd.pid`),
check the syslog output to see if
.Nm
logged any parsing
errors in the exports file.
.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,
.Nm
exits with an error.
.Sh FILES
.Bl -tag -width /var/run/mountd.pid -compact
.It Pa /etc/exports
the list of exported filesystems
.It Pa /var/run/mountd.pid
the pid of the currently running mountd
.It Pa /var/db/mountdtab
the current list of remote mounted filesystems
.El
.Sh SEE ALSO
.Xr nfsstat 1 ,
.Xr exports 5 ,
.Xr kldload 8 ,
.Xr nfsd 8 ,
.Xr portmap 8 ,
.Xr showmount 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	.\" @(#)mountd.8 8.4 (Berkeley) 4/28/95
	33	.\" $FreeBSD: src/sbin/mountd/mountd.8,v 1.16.2.2 2000/12/08 14:04:02 ru Exp $
cabeba47	34	.\" $DragonFly: src/sbin/mountd/mountd.8,v 1.4 2007/11/23 23:16:36 swildner Exp $
984263bc MD	35	.\"
	36	.Dd April 28, 1995
	37	.Dt MOUNTD 8
	38	.Os
	39	.Sh NAME
	40	.Nm mountd
	41	.Nd service remote
	42	.Tn NFS
	43	mount requests
	44	.Sh SYNOPSIS
	45	.Nm
	46	.Op Fl 2dlnr
	47	.Op Ar exportsfile
	48	.Sh DESCRIPTION
	49	.Nm Mountd
	50	is the server for
	51	.Tn NFS
	52	mount requests from other client machines.
	53	It listens for service requests at the port indicated in the
	54	.Tn NFS
	55	server specification; see
	56	.%T "Network File System Protocol Specification" ,
cabeba47	57	RFC 1094, Appendix A and
984263bc MD	58	.%T "NFS: Network File System Version 3 Protocol Specification" ,
	59	Appendix I.
	60	.Pp
	61	The following options are available:
	62	.Bl -tag -width indent
	63	.It Fl 2
	64	Allow the administrator to force clients to use only the
	65	version 2
	66	.Tn NFS
	67	protocol to mount filesystems from this server.
	68	.It Fl d
	69	Output debugging information.
	70	.It Fl l
	71	Cause all succeeded
	72	.Nm
	73	requests to be logged.
	74	.It Fl n
	75	Allow non-root mount requests to be served.
	76	This should only be specified if there are clients such as PC's,
	77	that require it.
e9c76aaf SW	78	It will automatically clear the
	79	.Va vfs.nfs.nfs_privport
	80	sysctl flag, which
984263bc MD	81	controls if the kernel will accept NFS requests from reserved ports only.
	82	.It Fl r
	83	Allow mount RPCs requests for regular files to be served.
	84	Although this seems to violate the mount protocol specification,
	85	some diskless workstations do mount requests for
	86	their swapfiles and expect them to be regular files.
	87	Since a regular file cannot be specified in
	88	.Pa /etc/exports ,
	89	the entire file system in which the swapfiles resides
	90	will have to be exported with the
	91	.Fl alldirs
	92	flag.
	93	.It Ar exportsfile
	94	Specify an alternate location
	95	for the exports file.
	96	.El
	97	.Pp
	98	When
	99	.Nm
	100	is started,
	101	it loads the export host addresses and options into the kernel
	102	using the
	103	.Xr mount 2
	104	system call.
	105	After changing the exports file,
	106	a hangup signal should be sent to the
	107	.Nm
	108	daemon
	109	to get it to reload the export information.
	110	After sending the SIGHUP
	111	(kill \-s HUP `cat /var/run/mountd.pid`),
	112	check the syslog output to see if
	113	.Nm
	114	logged any parsing
	115	errors in the exports file.
	116	.Pp
	117	If
	118	.Nm
	119	detects that the running kernel does not include
	120	.Tn NFS
	121	support, it will attempt to load a loadable kernel module containing
	122	.Tn NFS
	123	code, using
	124	.Xr kldload 8
	125	by way of
	126	.Xr vfsload 3 .
	127	If this fails, or no
	128	.Tn NFS
	129	KLD was available,
	130	.Nm
	131	exits with an error.
	132	.Sh FILES
	133	.Bl -tag -width /var/run/mountd.pid -compact
	134	.It Pa /etc/exports
	135	the list of exported filesystems
	136	.It Pa /var/run/mountd.pid
	137	the pid of the currently running mountd
	138	.It Pa /var/db/mountdtab
	139	the current list of remote mounted filesystems
	140	.El
	141	.Sh SEE ALSO
	142	.Xr nfsstat 1 ,
	143	.Xr exports 5 ,
	144	.Xr kldload 8 ,
145	.Xr nfsd 8 ,
146	.Xr portmap 8 ,
147	.Xr showmount 8
148	.Sh HISTORY
149	The
150	.Nm
151	utility first appeared in
152	.Bx 4.4 .