xref: /dragonfly/share/man/man5/nfs.5 (revision 37de577a)
1.\"
2.\" Copyright (c) 2018 The DragonFly Project.
3.\" All rights reserved.
4.\"
5.\" 1. Redistributions of source code must retain the above copyright
6.\"    notice, this list of conditions and the following disclaimer.
7.\" 2. Redistributions in binary form must reproduce the above copyright
8.\"    notice, this list of conditions and the following disclaimer in
9.\"    the documentation and/or other materials provided with the
10.\"    distribution.
11.\" 3. Neither the name of The DragonFly Project nor the names of its
12.\"    contributors may be used to endorse or promote products derived
13.\"    from this software without specific, prior written permission.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\"
28.Dd February 17, 2018
29.Dt NFS 5
30.Os
31.Sh NAME
32.Nm nfs
33.Nd nfs network filesystem
34.Sh DESCRIPTION
35The
36.Nm
37implements the mount protocol as per in RFC 1094, Appendix A and
38.%T "NFS: Network File System Version 3 Protocol Specification" ,
39Appendix I.
40.Sh SYSCTL VARIABLES
41The following
42.Xr sysctl 8
43MIBs are defined for use with
44.Nm :
45.Bl -tag -width "xxxxxx"
46.It Va vfs.nfs.access_cache_timeout
47.Nm
48access cache timeout.
49.It Va vfs.nfs.async
50Enables unstable and fast writes.
51.It Va vfs.nfs.commit_blks
52Number of committed blocks.
53.It Va vfs.nfs.commit_miss
54Number of nfs blocks committed from dirty buffers.
55.It vfs.nfs.diskless_rootpath
56Prints the host name for mount point.
57.It Va vfs.nfs.diskless_swappath
58Prints the host name for mount point to swap.
59.It Va vfs.nfs.diskless_valid
60Prints if diskless params were obtained.
61.It Va vfs.nfs.flush_on_hlink
62Controls fvp flushing prior to hard link.
63.It Va vfs.nfs.flush_on_rename
64Controls fvp flushing prior to rename.
65.It Va vfs.nfs.gatherdelay
66Enables NFS request procrastination.
67.It Va vfs.nfs.gatherdelay_v3
68Enables NFSv3 request procrastination.
69.It Va vfs.nfs.maxasyncbio
70Controls maximum number of asynchronous bio's.
71.It Va vfs.nfs.neg_cache_timeout
72.Nm
73negative namecache timeout.
74.It Va vfs.nfs.nfs_io_size
75Controls the
76.Nm
77optimal I/O unit size.
78.It Va vfs.nfs.nfs_ip_paranoia
79Enables no-connection mode for protocols that support no-connection mode.
80.It Va vfs.nfs.nfs_privport
81Enables privileged source port checks.
82.It Va vfs.nfs.nfsv3_commit_on_close
83If set, write and commit on close.
84If not set, only write on close.
85.It Va vfs.nfs.pos_cache_timeout
86.Nm
87positive namecache timeout.
88.It Va vfs.nfs.realign_count
89Number of realignments for badly aligned mbuf data.
90.It Va vfs.nfs.realign_test
91Number of times mbufs have been tested for bad alignment.
92.It Va vfs.nfs.showrexmit
93Enables retransmits debug prints.
94.It Va vfs.nfs.showrtt
95Enables round trip time output debug printing.
96.It Va vfs.nfs.soreserve
97Controls minimum
98.Nm
99socket buffer size reservation.
100.El
101.Sh SEE ALSO
102.Xr vfs 7 ,
103.Xr mountd 8 ,
104.Xr mount_nfs 8
105.Sh HISTORY
106The
107.Nm
108manual first appeared in
109.Dx 5.1 .
110