Debian Codegraph @

upstream/debian-unstable/man5/nfsmount.conf.5

raw
1 .\" @(#)nfsmount.conf.5"
2 .TH NFSMOUNT.CONF 5 "16 December 2020"
3 .SH NAME
4 nfsmount.conf - Configuration file for NFS mounts
5 .SH SYNOPSIS
6 Configuration file for NFS mounts that allows options
7 to be set globally, per server or per mount point.
8 .SH DESCRIPTION
9 The configuration file is made up of multiple section headers
10 followed by variable assignments associated with that section.
11 A section header is defined by a string enclosed by
12 .BR [
13 and
14 .BR ]
15 brackets.
16 Variable assignments are assignment statements that assign values
17 to particular variables using the
18 .BR =
19 operator, as in
20 .BR Proto=Tcp .
21 The variables that can be assigned are the set of NFS specific
22 mount options listed in
23 .BR nfs (5)
24 together with the filesystem-independant mount options listed in
25 .BR mount (8)
26 and three additions:
27 .B Sloppy=True
28 has the same effect as the
29 .B -s
30 option to
31 .IR mount ,
32 and
33 .B Foreground=True
34 and
35 .B Background=True
36 have the same effect as
37 .B bg
38 and
39 .BR fg .
40 .PP
41 Options in the config file may be given in upper, lower, or mixed case
42 and will be shifted to lower case before being passed to the filesystem.
43 .PP
44 Boolean mount options which do not need an equals sign must be given as
45 .RI \[dq] option =True".
46 Instead of preceding such an option with
47 .RB \[dq] no \[dq]
48 its negation must be given as
49 .RI \[dq] option =False".
50 .PP
51 Sections are broken up into three basic categories:
52 Global options, Server options and Mount Point options.
53 .HP
54 .B [ NFSMount_Global_Options ]
55 - This statically named section
56 defines all of the global mount options that can be
57 applied to every NFS mount.
58 .HP
59 .B [ Server \[dq]Server_Name\[dq] ]
60 - This section defines all the mount options that should
61 be used on mounts to a particular NFS server. The
62 .I \[dq]Server_Name\[dq]
63 strings needs to be surrounded by '\[dq]' and be an exact match
64 (ignoring case) of the server name used in the
65 .B mount
66 command.
67 .HP
68 .B [ MountPoint \[dq]Mount_Point\[dq] ]
69 - This section defines all the mount options that
70 should be used on a particular mount point.
71 The
72 .I \[dq]Mount_Point\[dq]
73 string needs to be surrounded by '\[dq]' and be an
74 exact match of the mount point used in the
75 .BR mount
76 command. Though path names are usually case-sensitive, the Mount_Point
77 name is matched insensitive to case.
78 .PP
79 The sections are processed in the reverse of the order listed above, and
80 any options already seen, either in a previous section or on the
81 command line, will be ignored when seen again.
82 .SH EXAMPLES
83 .PP
84 These are some example lines of how sections and variables
85 are defined in the configuration file.
86 .PP
87 [ NFSMount_Global_Options ]
88 .br
89 Proto=Tcp
90 .RS
91 .PP
92 The TCP/IPv4 protocol will be used on every NFS mount.
93 .RE
94 .PP
95 [ Server \[dq]nfsserver.foo.com\[dq] ]
96 .br
97 rsize=32k
98 .br
99 wsize=32k
100 .br
101 proto=udp6
102 .RS
103 .PP
104 A 32k (32768 bytes) block size will be used as the read and write
105 size on all mounts to the 'nfsserver.foo.com' server. UDP/IPv6
106 is the protocol to be used.
107 .RE
108 .PP
109 [ MountPoint \[dq]/export/home\[dq] ]
110 .br
111 Background=True
112 .RS
113 .PP
114 All mounts to the '/export/home' export will be performed in
115 the background (i.e. done asynchronously).
116 .RE
117 .SH FILES
118 .I /usr/etc/nfsmount.conf
119 .br
120 .I /usr/etc/nfsmount.conf.d/*.conf
121 .br
122 .I /etc/nfsmount.conf
123 .br
124 .I /etc/nfsmount.conf.d/*.conf
125 .br
126 .IP
127 Default NFS mount configuration files, variables set in the later file
128 over-ride those in the earlier file.
129 .PD
130 .SH SEE ALSO
131 .BR nfs (5),
132 .BR mount (8),