usr.sbin/nfsd/nfsd.8

   1 .\"   $NetBSD: nfsd.8,v 1.20 2006/01/01 17:03:54 yamt Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)nfsd.8      8.4 (Berkeley) 3/29/95
  31 .\"
  32 .Dd March 17, 2008
  33 .Dt NFSD 8
  34 .Os
  35 .Sh NAME
  36 .Nm nfsd
  37 .Nd remote
  38 .Tn NFS
  39 server
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl 6rut
  43 .Op Fl n Ar num_threads
  44 .Sh DESCRIPTION
  45 .Nm
  46 runs on a server machine to service
  47 .Tn NFS
  48 requests from client machines.
  49 At least one
  50 .Nm
  51 must be running for a machine to operate as a server.
  52 .Pp
  53 Unless otherwise specified, four servers for
  54 .Tn UDP
  55 transport are started.
  56 .Pp
  57 The following options are available:
  58 .Bl -tag -width Ds
  59 .It Fl r
  60 Register the
  61 .Tn NFS
  62 service with
  63 .Xr rpcbind 8
  64 without creating any servers.
  65 This option can be used along with the
  66 .Fl u
  67 or
  68 .Fl t
  69 options to re-register NFS if the portmap server is restarted.
  70 .It Fl n
  71 Specifies how many server threads to create.
  72 The default is 4.
  73 A server should run enough threads to handle
  74 the maximum level of concurrency from its clients.
  75 .It Fl 6
  76 Listen to IPv6 requests as well as IPv4 requests. If IPv6 support is not
  77 available, nfsd will silently continue and just use IPv4.
  78 .It Fl t
  79 Serve
  80 .Tn TCP NFS
  81 clients.
  82 .It Fl u
  83 Serve
  84 .Tn UDP NFS
  85 clients.
  86 .El
  87 .Pp
  88 For example,
  89 .Dq Li "nfsd -t -u -n 6"
  90 serves
  91 .Tn UDP
  92 and
  93 .Tn TCP
  94 transports using six threads.
  95 .Pp
  96 .Nm
  97 listens for service requests at the port indicated in the
  98 .Tn NFS
  99 server specification; see
 100 .%T "Network File System Protocol Specification" ,
 101 RFC 1094 and
 102 .%T "NFS: Network File System Version 3 Protocol Specification" .
 103 .Pp
 104 The
 105 .Nm
 106 utility exits 0 on success, and \*[Gt]0 if an error occurs.
 107 .Sh SEE ALSO
 108 .Xr nfsstat 1 ,
 109 .Xr nfssvc 2 ,
 110 .Xr mountd 8 ,
 111 .Xr rpcbind 8
 112 .Sh HISTORY
 113 The
 114 .Nm
 115 utility first appeared in
 116 .Bx 4.4 .