nfsd.8: Fix mandoc -Tlint and igor warnings
- Remove Tn macros - Refernce sysctl(8) instead of sysctl(1) - Start new sentences on new lines - Capitalize NFS where needed - Use Fx for FreeBSD - Remove a list block (Bl) that was added to the manual page by accident in r335174 Reviewed by: bcr Approved by: doc (bcr) Differential Revision: https://reviews.freebsd.org/D20215
This commit is contained in:
parent
16760d8e28
commit
bc562d41f2
@ -34,8 +34,7 @@
|
||||
.Sh NAME
|
||||
.Nm nfsd
|
||||
.Nd remote
|
||||
.Tn NFS
|
||||
server
|
||||
NFS server
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl ardute
|
||||
@ -49,23 +48,18 @@ server
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
utility runs on a server machine to service
|
||||
.Tn NFS
|
||||
requests from client machines.
|
||||
utility runs on a server machine to service NFS requests from client machines.
|
||||
At least one
|
||||
.Nm
|
||||
must be running for a machine to operate as a server.
|
||||
.Pp
|
||||
Unless otherwise specified, eight servers per CPU for
|
||||
.Tn UDP
|
||||
transport are started.
|
||||
Unless otherwise specified, eight servers per CPU for UDP transport are
|
||||
started.
|
||||
.Pp
|
||||
The following options are available:
|
||||
.Bl -tag -width Ds
|
||||
.It Fl r
|
||||
Register the
|
||||
.Tn NFS
|
||||
service with
|
||||
Register the NFS service with
|
||||
.Xr rpcbind 8
|
||||
without creating any servers.
|
||||
This option can be used along with the
|
||||
@ -74,16 +68,15 @@ or
|
||||
.Fl t
|
||||
options to re-register NFS if the rpcbind server is restarted.
|
||||
.It Fl d
|
||||
Unregister the
|
||||
.Tn NFS
|
||||
service with
|
||||
Unregister the NFS service with
|
||||
.Xr rpcbind 8
|
||||
without creating any servers.
|
||||
.It Fl V Ar virtual_hostname
|
||||
Specifies a hostname to be used as a principal name, instead of
|
||||
the default hostname.
|
||||
.It Fl n Ar threads
|
||||
Specifies how many servers to create. This option is equivalent to specifying
|
||||
Specifies how many servers to create.
|
||||
This option is equivalent to specifying
|
||||
.Fl Fl maxthreads
|
||||
and
|
||||
.Fl Fl minthreads
|
||||
@ -114,13 +107,14 @@ Enables pNFS support in the server and specifies the information that the
|
||||
daemon needs to start it.
|
||||
This option can only be used on one server and specifies that this server
|
||||
will be the MetaData Server (MDS) for the pNFS service.
|
||||
This can only be done if there is at least one FreeBSD system configured
|
||||
This can only be done if there is at least one
|
||||
.Fx
|
||||
system configured
|
||||
as a Data Server (DS) for it to use.
|
||||
.Pp
|
||||
The
|
||||
.Ar pnfs_setup
|
||||
string is a set of fields separated by ',' characters:
|
||||
.Bl -tag -width Ds
|
||||
Each of these fields specifies one DS.
|
||||
It consists of a server hostname, followed by a ':'
|
||||
and the directory path where the DS's data storage file system is mounted on
|
||||
@ -159,7 +153,6 @@ data files for
|
||||
.Dq /export1
|
||||
and nfsv4-data1 will be used to store data files for
|
||||
.Dq /export2 .
|
||||
.El
|
||||
.sp
|
||||
When using IPv6 addresses for DSs
|
||||
be wary of using link local addresses.
|
||||
@ -201,28 +194,20 @@ If mirroring is enabled, the server must use the Flexible File
|
||||
layout.
|
||||
If mirroring is not enabled, the server will use the File layout
|
||||
by default, but this default can be changed to the Flexible File layout if the
|
||||
.Xr sysctl 1
|
||||
.Xr sysctl 8
|
||||
vfs.nfsd.default_flexfile
|
||||
is set non-zero.
|
||||
.It Fl t
|
||||
Serve
|
||||
.Tn TCP NFS
|
||||
clients.
|
||||
Serve TCP NFS clients.
|
||||
.It Fl u
|
||||
Serve
|
||||
.Tn UDP NFS
|
||||
clients.
|
||||
Serve UDP NFS clients.
|
||||
.It Fl e
|
||||
Ignored; included for backward compatibility.
|
||||
.El
|
||||
.Pp
|
||||
For example,
|
||||
.Dq Li "nfsd -u -t -n 6"
|
||||
serves
|
||||
.Tn UDP
|
||||
and
|
||||
.Tn TCP
|
||||
transports using six daemons.
|
||||
serves UDP and TCP transports using six daemons.
|
||||
.Pp
|
||||
A server should run enough daemons to handle
|
||||
the maximum level of concurrency from its clients,
|
||||
@ -231,8 +216,7 @@ typically four to six.
|
||||
The
|
||||
.Nm
|
||||
utility listens for service requests at the port indicated in the
|
||||
.Tn NFS
|
||||
server specification; see
|
||||
NFS server specification; see
|
||||
.%T "Network File System Protocol Specification" ,
|
||||
RFC1094,
|
||||
.%T "NFS: Network File System Version 3 Protocol Specification" ,
|
||||
@ -245,15 +229,10 @@ RFC5661.
|
||||
If
|
||||
.Nm
|
||||
detects that
|
||||
.Tn NFS
|
||||
is not loaded in the running kernel, it will attempt
|
||||
to load a loadable kernel module containing
|
||||
.Tn NFS
|
||||
support using
|
||||
NFS is not loaded in the running kernel, it will attempt
|
||||
to load a loadable kernel module containing NFS support using
|
||||
.Xr kldload 2 .
|
||||
If this fails, or no
|
||||
.Tn NFS
|
||||
KLD is available,
|
||||
If this fails, or no NFS KLD is available,
|
||||
.Nm
|
||||
will exit with an error.
|
||||
.Pp
|
||||
@ -271,7 +250,7 @@ that the NFS sockets can only be accessed by the inside interface.
|
||||
The
|
||||
.Nm ipfw
|
||||
utility
|
||||
would then be used to block nfs-related packets that come in on the outside
|
||||
would then be used to block NFS-related packets that come in on the outside
|
||||
interface.
|
||||
.Pp
|
||||
If the server has stopped servicing clients and has generated a console message
|
||||
@ -337,8 +316,8 @@ If
|
||||
.Nm
|
||||
is started when
|
||||
.Xr gssd 8
|
||||
is not running, it will service AUTH_SYS requests only. To fix the problem
|
||||
you must kill
|
||||
is not running, it will service AUTH_SYS requests only.
|
||||
To fix the problem you must kill
|
||||
.Nm
|
||||
and then restart it, after the
|
||||
.Xr gssd 8
|
||||
@ -351,6 +330,6 @@ need to be patched to support the
|
||||
.Dq tightly coupled
|
||||
variant of
|
||||
the Flexible File layout or the
|
||||
.Xr sysctl 1
|
||||
.Xr sysctl 8
|
||||
vfs.nfsd.flexlinuxhack
|
||||
must be set to one on the MDS as a workaround.
|
||||
|
Loading…
x
Reference in New Issue
Block a user