NetBSD/usr.sbin/mountd/mountd.8

.\"	$NetBSD: mountd.8,v 1.23 2002/09/21 20:35:00 christos Exp $
.\"
.\" 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
.\"
.Dd April 28, 1995
.Dt MOUNTD 8
.Os
.Sh NAME
.Nm mountd
.Nd service remote
.Tn NFS
mount requests
.Sh SYNOPSIS
.Nm
.Op Fl P Ar policy
.Op Fl dn
.Op Ar exportsfile
.Sh DESCRIPTION
.Nm
is the server for
.Tn NFS
mount requests from other client machines.
.Nm
listens for service requests at the port indicated in the
.Tn NFS
server specification; see
.%T "Network File System Protocol Specification" ,
RFC1094, Appendix A and
.%T "NFS: Network File System Version 3 Protocol Specification" ,
Appendix I.
.Pp
Options and operands available for
.Nm mountd :
.Bl -tag -width Ds
.It Fl P Ar policy
IPsec 
.Ar policy
string,
as described in
.Xr ipsec_set_policy 3 .
Multiple IPsec policy strings may be specified by using a semicolon as
a separator. If conflicting policy strings are found in a single line,
the last string will take effect. If an invalid IPsec policy string is used
.Nm
logs an error message and terminates itself.
.It Fl d
Enable debugging mode.
.Nm
will not detach from the controlling terminal and will print
debugging messages to stderr.
.It Fl n
This flag used to indicate that clients were required to make requests
from reserved ports, but it is now no longer functional. It
is only provided for backwards compatibility. Requests
are checked for reserved ports on a per-export basis, see
.Xr exports 5 .
.It Ar exportsfile
The
.Ar exportsfile
argument specifies an alternative 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
After receiving SIGTERM,
.Nm
sends a broadcast request to remove the mount list from all the clients.
This can take a long time, since the broadcast request waits for each
client to respond.
.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
.Nm
.El
.Sh SEE ALSO
.Xr nfsstat 1 ,
.Xr exports 5 ,
.Xr nfsd 8 ,
.Xr rpcbind 8 ,
.Xr showmount 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
PR/15692: Love: specify ipsec policy for mountd. 2002-09-22 00:35:00 +04:00			`.\" $NetBSD: mountd.8,v 1.23 2002/09/21 20:35:00 christos Exp $`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\"`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`.\" Copyright (c) 1989, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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.`
			`.\"`
Bring in NFSv3 code by Rick Macklem (from Lite2) 1996-02-18 14:57:50 +03:00			`.\" @(#)mountd.8 8.4 (Berkeley) 4/28/95`
added rcs ids to all files 1993-03-22 11:04:00 +03:00			`.\"`
Bring in NFSv3 code by Rick Macklem (from Lite2) 1996-02-18 14:57:50 +03:00			`.Dd April 28, 1995`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt MOUNTD 8`
			`.Os`
			`.Sh NAME`
			`.Nm mountd`
			`.Nd service remote`
			`.Tn NFS`
			`mount requests`
			`.Sh SYNOPSIS`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`.Nm`
PR/15692: Love: specify ipsec policy for mountd. 2002-09-22 00:35:00 +04:00			`.Op Fl P Ar policy`
Don't require compiling with -DDEBUG to enable debugging messages. Instead, add a new option flag "-d", which enables debugging output. Compile all of the code that used to be enabled with -DDEBUG unconditionally. The amount of extra code is negligable, and all of the tests to check if debugging is enabled were done regardless of -DDEBUG anyway. Adjust SYSLOG() to DTRT if debugging is not enabled. 1995-11-06 10:00:07 +03:00			`.Op Fl dn`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Op Ar exportsfile`
			`.Sh DESCRIPTION`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`is the server for`
			`.Tn NFS`
			`mount requests from other client machines.`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`listens for service requests at the port indicated in the`
			`.Tn NFS`
			`server specification; see`
			`.%T "Network File System Protocol Specification" ,`
Bring in NFSv3 code by Rick Macklem (from Lite2) 1996-02-18 14:57:50 +03:00			`RFC1094, Appendix A and`
			`.%T "NFS: Network File System Version 3 Protocol Specification" ,`
			`Appendix I.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Pp`
			`Options and operands available for`
			`.Nm mountd :`
			`.Bl -tag -width Ds`
PR/15692: Love: specify ipsec policy for mountd. 2002-09-22 00:35:00 +04:00			`.It Fl P Ar policy`
			`IPsec`
			`.Ar policy`
			`string,`
			`as described in`
			`.Xr ipsec_set_policy 3 .`
			`Multiple IPsec policy strings may be specified by using a semicolon as`
			`a separator. If conflicting policy strings are found in a single line,`
			`the last string will take effect. If an invalid IPsec policy string is used`
			`.Nm`
			`logs an error message and terminates itself.`
Don't require compiling with -DDEBUG to enable debugging messages. Instead, add a new option flag "-d", which enables debugging output. Compile all of the code that used to be enabled with -DDEBUG unconditionally. The amount of extra code is negligable, and all of the tests to check if debugging is enabled were done regardless of -DDEBUG anyway. Adjust SYSLOG() to DTRT if debugging is not enabled. 1995-11-06 10:00:07 +03:00			`.It Fl d`
			`Enable debugging mode.`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`.Nm`
Don't require compiling with -DDEBUG to enable debugging messages. Instead, add a new option flag "-d", which enables debugging output. Compile all of the code that used to be enabled with -DDEBUG unconditionally. The amount of extra code is negligable, and all of the tests to check if debugging is enabled were done regardless of -DDEBUG anyway. Adjust SYSLOG() to DTRT if debugging is not enabled. 1995-11-06 10:00:07 +03:00			`will not detach from the controlling terminal and will print`
			`debugging messages to stderr.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl n`
Clarify -n comment. 1998-07-16 02:00:59 +04:00			`This flag used to indicate that clients were required to make requests`
			`from reserved ports, but it is now no longer functional. It`
			`is only provided for backwards compatibility. Requests`
Checking for the use reserved ports by clients (both for mount/umount and individual NFS requests) now depends on the '-noresport' option in the exports file. Checking for reserved ports is the default. The -n option has become obsolete but is maintained for backwards compatibility. 1997-03-23 23:58:14 +03:00			`are checked for reserved ports on a per-export basis, see`
			`.Xr exports 5 .`
Fix spelling mistake. 1993-11-19 20:24:58 +03:00			`.It Ar exportsfile`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`The`
			`.Ar exportsfile`
alternate -> alternative, per PR 2643 1997-03-08 16:47:08 +03:00			`argument specifies an alternative location`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`for the exports file.`
			`.El`
			`.Pp`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`When`
			`.Nm`
			`is started,`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`it loads the export host addresses and options into the kernel`
Principally, change foo(N) to .Xr foo N Also, do some other mdoc tagging. 1998-04-28 08:07:04 +04:00			`using the`
			`.Xr mount 2`
			`system call.`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`After changing the exports file,`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`a hangup signal should be sent to the`
			`.Nm`
			`daemon to get it to reload the export information.`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`After sending the SIGHUP`
Changes to match POSIXication of kill(1). 1994-09-24 03:18:36 +04:00			(kill \-s HUP `cat /var/run/mountd.pid`),
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`check the syslog output to see if`
			`.Nm`
			`logged any parsing errors in the exports file.`
Explains what happens when we get SIGTERM... 1998-10-07 18:51:36 +04:00			`.Pp`
			`After receiving SIGTERM,`
			`.Nm`
			`sends a broadcast request to remove the mount list from all the clients.`
			`This can take a long time, since the broadcast request waits for each`
			`client to respond.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh FILES`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`.Bl -tag -width /var/run/mountd.pid -compact`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Pa /etc/exports`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`the list of exported filesystems`
			`.It Pa /var/run/mountd.pid`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`the pid of the currently running`
			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.El`
			`.Sh SEE ALSO`
			`.Xr nfsstat 1 ,`
			`.Xr exports 5 ,`
			`.Xr nfsd 8 ,`
Substitute the cross reference to portmap(8) with rpcbind(8). 2000-07-03 14:06:24 +04:00			`.Xr rpcbind 8 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr showmount 8`
			`.Sh HISTORY`
			`The`
- use .Nm instead of .Xr - don't refer to the command as /sbin/mountd - it's not there anymore 1997-09-14 06:26:14 +04:00			`.Nm`
macroize BSD, NetBSD, FreeBSD and misc cleanup 1998-02-06 08:54:12 +03:00			`utility first appeared in`
			`.Bx 4.4 .`