mount.nfs: Update description of clientaddr= in nfs(5)
[nfs-utils.git] / utils / mount / nfs.man
1 .\" nfs.5 "Rick Sladkey" <jrs@world.std.com>
2 .\" Wed Feb  8 12:52:42 1995, faith@cs.unc.edu: updates for Ross Biro's
3 .\" patches. "
4 .TH NFS 5 "20 November 1993" "Linux 0.99" "Linux Programmer's Manual"
5 .SH NAME
6 nfs \- nfs and nfs4 fstab format and options
7 .SH SYNOPSIS
8 .B /etc/fstab
9 .SH DESCRIPTION
10 The
11 .I fstab
12 file contains information about which filesystems
13 to mount where and with what options.
14 For NFS mounts, it contains the server name and
15 exported server directory to mount from,
16 the local directory that is the mount point,
17 and the NFS specific options that control
18 the way the filesystem is mounted.
19 .P
20 Three different versions of the NFS protocol are
21 supported by the Linux NFS client:
22 NFS version 2, NFS version 3, and NFS version 4.
23 To mount via NFS version 2, use the
24 .BR nfs
25 file system type and specify
26 .BR nfsvers=2 .
27 To mount via NFS version 3, use the
28 .BR nfs
29 file system type and specify
30 .BR nfsvers=3 .
31 Version 3 is the default protocol version for the
32 .BR nfs
33 file system type when
34 .BR nfsvers=
35 is not specified on the mount command and both client and server
36 support it.
37 To mount via NFS version 4, use the
38 .BR nfs4
39 file system type.
40 The
41 .BR nfsvers=
42 keyword is not supported for the
43 .BR nfs4
44 file system type.
45 .P
46 These file system types share similar mount options;
47 the differences are listed below.
48 .P
49 Here is an example from an \fI/etc/fstab\fP file for an NFSv3 mount
50 over TCP.
51 .sp
52 .nf
53 .ta 2.5i +0.75i +0.75i +1.0i
54 server:/usr/local/pub   /pub    nfs     rsize=32768,wsize=32768,timeo=14,intr
55 .fi
56 .P
57 Here is an example for an NFSv4 mount over TCP using Kerberos
58 5 mutual authentication.
59 .sp
60 .nf
61 .ta 2.5i +0.75i +0.75i +1.0i
62 server:/usr/local/pub   /pub    nfs4    proto=tcp,sec=krb5,hard,intr
63 .fi
64 .DT
65 .SS Options for the nfs file system type
66 .TP 1.5i
67 .I rsize=n
68 The number of bytes NFS uses when reading files from an NFS server.
69 The rsize is negotiated between the server and client to determine 
70 the largest block size that both can support.
71 The value specified by this option is the maximum size that could 
72 be used; however, the actual size used may be smaller.
73 Note: Setting this size to a value less than the largest supported
74 block size will adversely affect performance.
75 .TP 1.5i
76 .I wsize=n
77 The number of bytes NFS uses when writing files to an NFS server.
78 The wsize is negotiated between the server and client to determine 
79 the largest block size that both can support.
80 The value specified by this option is the maximum size that could 
81 be used; however, the actual size used may be smaller.
82 Note: Setting this size to a value less than the largest supported
83 block size will adversely affect performance.
84 .TP 1.5i
85 .I timeo=n
86 The value in tenths of a second before sending the
87 first retransmission after an RPC timeout.
88 The default value is 7 tenths of a second.  After the first timeout,
89 the timeout is doubled after each successive timeout until a maximum
90 timeout of 60 seconds is reached or the enough retransmissions
91 have occured to cause a major timeout.  Then, if the filesystem
92 is hard mounted, each new timeout cascade restarts at twice the
93 initial value of the previous cascade, again doubling at each
94 retransmission.  The maximum timeout is always 60 seconds.
95 Better overall performance may be achieved by increasing the
96 timeout when mounting on a busy network, to a slow server, or through
97 several routers or gateways.
98 .TP 1.5i
99 .I retrans=n
100 The number of minor timeouts and retransmissions that must occur before
101 a major timeout occurs.  The default is 3 timeouts.  When a major timeout
102 occurs, the file operation is either aborted or a "server not responding"
103 message is printed on the console.
104 .TP 1.5i
105 .I acregmin=n
106 The minimum time in seconds that attributes of a regular file should
107 be cached before requesting fresh information from a server.
108 The default is 3 seconds.
109 .TP 1.5i
110 .I acregmax=n
111 The maximum time in seconds that attributes of a regular file can
112 be cached before requesting fresh information from a server.
113 The default is 60 seconds.
114 .TP 1.5i
115 .I acdirmin=n
116 The minimum time in seconds that attributes of a directory should
117 be cached before requesting fresh information from a server.
118 The default is 30 seconds.
119 .TP 1.5i
120 .I acdirmax=n
121 The maximum time in seconds that attributes of a directory can
122 be cached before requesting fresh information from a server.
123 The default is 60 seconds.
124 .TP 1.5i
125 .I actimeo=n
126 Using actimeo sets all of
127 .I acregmin,
128 .I acregmax,
129 .I acdirmin,
130 and
131 .I acdirmax
132 to the same value.
133 There is no default value.
134 .TP 1.5i
135 .I retry=n
136 The number of minutes to retry an NFS mount operation
137 in the foreground or background before giving up.
138 The default value for forground mounts is 2 minutes.  
139 The default value for background mounts is 10000 minutes, 
140 which is roughly one week.
141 .TP 1.5i
142 .I namlen=n
143 When an NFS server does not support version two of the
144 RPC mount protocol, this option can be used to specify
145 the maximum length of a filename that is supported on
146 the remote filesystem.  This is used to support the
147 POSIX pathconf functions.  The default is 255 characters.
148 .TP 1.5i
149 .I port=n
150 The numeric value of the port to connect to the NFS server on.
151 If the port number is 0 (the default) then query the
152 remote host's portmapper for the port number to use.
153 If the remote host's NFS daemon is not registered with
154 its portmapper, the standard NFS port number 2049 is
155 used instead.
156 .TP 1.5i
157 .I mountport=n
158 The numeric value of the
159 .B mountd
160 port.
161 .TP 1.5i
162 .I mounthost=name
163 The name of the host running
164 .B mountd .
165 .TP 1.5i
166 .I mountprog=n
167 Use an alternate RPC program number to contact the
168 mount daemon on the remote host.  This option is useful
169 for hosts that can run multiple NFS servers.
170 The default value is 100005 which is the standard RPC
171 mount daemon program number.
172 .TP 1.5i
173 .I mountvers=n
174 Use an alternate RPC version number to contact the
175 mount daemon on the remote host.  This option is useful
176 for hosts that can run multiple NFS servers.
177 The default value depends on which kernel you are using.
178 .TP 1.5i
179 .I nfsprog=n
180 Use an alternate RPC program number to contact the
181 NFS daemon on the remote host.  This option is useful
182 for hosts that can run multiple NFS servers.
183 The default value is 100003 which is the standard RPC
184 NFS daemon program number.
185 .TP 1.5i
186 .I nfsvers=n
187 Use an alternate RPC version number to contact the
188 NFS daemon on the remote host.  This option is useful
189 for hosts that can run multiple NFS servers.
190 The default value depends on which kernel you are using.
191 .TP 1.5i
192 .I vers=n
193 vers is an alternative to nfsvers and is compatible with
194 many other operating systems.
195 .TP 1.5i
196 .I nolock
197 Disable NFS locking. Do not start lockd.
198 This is appropriate for mounting the root filesystem or
199 .B /usr
200 or
201 .BR /var .
202 These filesystems are typically either read-only or not shared, and in
203 those cases, remote locking is not needed.
204 This also needs to be used with some old NFS servers
205 that don't support locking.
206 .br
207 Note that applications can still get locks on files, but the locks
208 only provide exclusion locally.  Other clients mounting the same
209 filesystem will not be able to detect the locks.
210 .TP 1.5i
211 .I bg
212 If the first NFS mount attempt times out, retry the mount
213 in the background.
214 After a mount operation is backgrounded, all subsequent mounts
215 on the same NFS server will be backgrounded immediately, without
216 first attempting the mount.
217 A missing mount point is treated as a timeout,
218 to allow for nested NFS mounts.
219 .TP 1.5i
220 .I fg
221 If the first NFS mount attempt times out, retry the mount
222 in the foreground.
223 This is the complement of the
224 .I bg
225 option, and also the default behavior.
226 .TP 1.5i
227 .I soft
228 If an NFS file operation has a major timeout then report an I/O error to
229 the calling program.
230 The default is to continue retrying NFS file operations indefinitely.
231 .TP 1.5i
232 .I hard
233 If an NFS file operation has a major timeout then report
234 "server not responding" on the console and continue retrying indefinitely.
235 This is the default.
236 .TP 1.5i
237 .I intr
238 If an NFS file operation has a major timeout and it is hard mounted,
239 then allow signals to interupt the file operation and cause it to
240 return EINTR to the calling program.  The default is to not
241 allow file operations to be interrupted.
242 .TP 1.5i
243 .I posix
244 Mount the NFS filesystem using POSIX semantics.  This allows
245 an NFS filesystem to properly support the POSIX pathconf
246 command by querying the mount server for the maximum length
247 of a filename.  To do this, the remote host must support version
248 two of the RPC mount protocol.  Many NFS servers support only
249 version one.
250 .TP 1.5i
251 .I nocto
252 Suppress the retrieval of new attributes when creating a file.
253 .TP 1.5i
254 .I noac
255 Disable all forms of attribute caching entirely.  This extracts a
256 significant performance penalty but it allows two different NFS clients
257 to get reasonable results when both clients are actively
258 writing to a common export on the server.
259 .TP 1.5i
260 .I noacl
261 Disables Access Control List (ACL) processing.
262 .TP 1.5i
263 .I sec=mode
264 Set the security flavor for this mount to "mode".
265 The default setting is \f3sec=sys\f1, which uses local
266 unix uids and gids to authenticate NFS operations (AUTH_SYS).
267 Other currently supported settings are:
268 \f3sec=krb5\f1, which uses Kerberos V5 instead of local unix uids
269 and gids to authenticate users;
270 \f3sec=krb5i\f1, which uses Kerberos V5 for user authentication
271 and performs integrity checking of NFS operations using secure
272 checksums to prevent data tampering; and
273 \f3sec=krb5p\f1, which uses Kerberos V5 for user authentication
274 and integrity checking, and encrypts NFS traffic to prevent
275 traffic sniffing (this is the most secure setting).
276 Note that there is a performance penalty when using integrity
277 or privacy.
278 .TP 1.5i
279 .I tcp
280 Mount the NFS filesystem using the TCP protocol.  This is the default
281 if it is supported by both client and server.  Many NFS servers only
282 support UDP.
283 .TP 1.5i
284 .I udp
285 Mount the NFS filesystem using the UDP protocol.
286 .TP 1.5i
287 .I nordirplus
288 Disables NFSv3 READDIRPLUS RPCs. Use this option when
289 mounting servers that don't support or have broken
290 READDIRPLUS implementations.
291 .TP 1.5i
292 .I nosharecache
293 As of kernel 2.6.18, it is no longer possible to mount the same
294 same filesystem with different mount options to a new mountpoint.
295 It was deemed unsafe to do so, since cached data cannot be shared
296 between the two mountpoints. In consequence, files or directories
297 that were common to both mountpoint subtrees could often be seen to
298 be out of sync following an update.
299 .br
300 This option allows administrators to select the pre-2.6.18 behaviour,
301 permitting the same filesystem to be mounted with different mount
302 options.
303 .br
304 .B Beware:
305 Use of this option is not recommended unless you are certain that there
306 are no hard links or subtrees of this mountpoint that are mounted
307 elsewhere.
308 .P
309 All of the non-value options have corresponding nooption forms.
310 For example, nointr means don't allow file operations to be
311 interrupted.
312 .SS Options for the nfs4 file system type
313 .TP 1.5i
314 .I rsize=n
315 The number of bytes nfs4 uses when reading files from the server.
316 The rsize is negotiated between the server and client to determine 
317 the largest block size that both can support.
318 The value specified by this option is the maximum size that could 
319 be used; however, the actual size used may be smaller.
320 Note: Setting this size to a value less than the largest supported
321 block size will adversely affect performance.
322 .TP 1.5i
323 .I wsize=n
324 The number of bytes nfs4 uses when writing files to the server.
325 The wsize is negotiated between the server and client to determine 
326 the largest block size that both can support.
327 The value specified by this option is the maximum size that could 
328 be used; however, the actual size used may be smaller.
329 Note: Setting this size to a value less than the largest supported
330 block size will adversely affect performance.
331 .TP 1.5i
332 .I timeo=n
333 The value in tenths of a second before sending the
334 first retransmission after an RPC timeout.
335 The default value depends on whether
336 .IR proto=udp
337 or
338 .IR proto=tcp
339 is in effect (see below).
340 The default value for UDP is 7 tenths of a second.
341 The default value for TCP is 60 seconds.
342 After the first timeout,
343 the timeout is doubled after each successive timeout until a maximum
344 timeout of 60 seconds is reached or the enough retransmissions
345 have occured to cause a major timeout.  Then, if the filesystem
346 is hard mounted, each new timeout cascade restarts at twice the
347 initial value of the previous cascade, again doubling at each
348 retransmission.  The maximum timeout is always 60 seconds.
349 .TP 1.5i
350 .I retrans=n
351 The number of minor timeouts and retransmissions that must occur before
352 a major timeout occurs.  The default is 5 timeouts for
353 .IR proto=udp
354 and 2 timeouts for
355 .IR proto=tcp .
356 When a major timeout
357 occurs, the file operation is either aborted or a "server not responding"
358 message is printed on the console.
359 .TP 1.5i
360 .I acregmin=n
361 The minimum time in seconds that attributes of a regular file should
362 be cached before requesting fresh information from a server.
363 The default is 3 seconds.
364 .TP 1.5i
365 .I acregmax=n
366 The maximum time in seconds that attributes of a regular file can
367 be cached before requesting fresh information from a server.
368 The default is 60 seconds.
369 .TP 1.5i
370 .I acdirmin=n
371 The minimum time in seconds that attributes of a directory should
372 be cached before requesting fresh information from a server.
373 The default is 30 seconds.
374 .TP 1.5i
375 .I acdirmax=n
376 The maximum time in seconds that attributes of a directory can
377 be cached before requesting fresh information from a server.
378 The default is 60 seconds.
379 .TP 1.5i
380 .I actimeo=n
381 Using actimeo sets all of
382 .I acregmin,
383 .I acregmax,
384 .I acdirmin,
385 and
386 .I acdirmax
387 to the same value.
388 There is no default value.
389 .TP 1.5i
390 .I retry=n
391 The number of minutes to retry an NFS mount operation
392 in the foreground or background before giving up.
393 The default value for forground mounts is 2 minutes.  
394 The default value for background mounts is 10000 minutes, 
395 which is roughly one week.
396 .TP 1.5i
397 .I port=n
398 The numeric value of the port to connect to the NFS server on.
399 If the port number is 0 (the default) then query the
400 remote host's portmapper for the port number to use.
401 If the remote host's NFS daemon is not registered with
402 its portmapper, the standard NFS port number 2049 is
403 used instead.
404 .TP 1.5i
405 .I proto=n
406 Mount the NFS filesystem using a specific network protocol
407 instead of the default UDP protocol.
408 Many NFS version 4 servers only support TCP.
409 Valid protocol types are
410 .IR udp
411 and
412 .IR tcp .
413 .TP 1.5i
414 .I clientaddr=n.n.n.n
415 Specifies a single IPv4 address in dotted-quad form that
416 the NFS client advertises to allow servers to perform
417 NFSv4 callback requests against files on this mount point.
418 If the server is not able to establish callback connections
419 to clients, performance may degrade, or accesses to
420 files may temporarily hang.
421 .IP
422 If this option is not specified, the
423 .BR mount (8)
424 command attempts to discover an appropriate callback
425 address automatically.
426 The automatic discovery process is not perfect, however.
427 In the presence of multiple client network interfaces, special
428 routing policies, or atypical network topologies, the exact
429 address to use for callbacks may be nontrivial to determine,
430 and should be explicitly set using this mount option.
431 .TP 1.5i
432 .I sec=mode
433 Same as \f3sec=mode\f1 for the nfs filesystem type (see above).
434 .TP 1.5i
435 .I bg
436 If an NFS mount attempt times out, retry the mount
437 in the background.
438 After a mount operation is backgrounded, all subsequent mounts
439 on the same NFS server will be backgrounded immediately, without
440 first attempting the mount.
441 A missing mount point is treated as a timeout,
442 to allow for nested NFS mounts.
443 .TP 1.5i
444 .I fg
445 If the first NFS mount attempt times out, retry the mount
446 in the foreground.
447 This is the complement of the
448 .I bg
449 option, and also the default behavior.
450 .TP 1.5i
451 .I soft
452 If an NFS file operation has a major timeout then report an I/O error to
453 the calling program.
454 The default is to continue retrying NFS file operations indefinitely.
455 .TP 1.5i
456 .I hard
457 If an NFS file operation has a major timeout then report
458 "server not responding" on the console and continue retrying indefinitely.
459 This is the default.
460 .TP 1.5i
461 .I intr
462 If an NFS file operation has a major timeout and it is hard mounted,
463 then allow signals to interupt the file operation and cause it to
464 return EINTR to the calling program.  The default is to not
465 allow file operations to be interrupted.
466 .TP 1.5i
467 .I nocto
468 Suppress the retrieval of new attributes when creating a file.
469 .TP 1.5i
470 .I noac
471 Disable attribute caching, and force synchronous writes.
472 This extracts a
473 server performance penalty but it allows two different NFS clients
474 to get reasonable good results when both clients are actively
475 writing to common filesystem on the server.
476 .TP 1.5i
477 .I nosharecache
478 As of kernel 2.6.18, it is no longer possible to mount the same
479 same filesystem with different mount options to a new mountpoint.
480 It was deemed unsafe to do so, since cached data cannot be shared
481 between the two mountpoints. In consequence, files or directories
482 that were common to both mountpoint subtrees could often be seen to
483 be out of sync following an update.
484 .br
485 This option allows administrators to select the pre-2.6.18 behaviour,
486 permitting the same filesystem to be mounted with different mount
487 options.
488 .br
489 .B Beware:
490 Use of this option is not recommended unless you are certain that there
491 are no hard links or subtrees of this mountpoint that are mounted
492 elsewhere.
493 .P
494 All of the non-value options have corresponding nooption forms.
495 For example, nointr means don't allow file operations to be
496 interrupted.
497 .SH FILES
498 .I /etc/fstab
499 .SH "SEE ALSO"
500 .BR fstab "(5), " mount "(8), " umount "(8), " exports (5)
501 .SH AUTHOR
502 "Rick Sladkey" <jrs@world.std.com>
503 .SH BUGS
504 .P
505 Checking files on NFS filesystem referenced by file descriptors (i.e. the 
506 .BR fcntl 
507 and 
508 .BR ioctl
509 families of functions) may lead to inconsistent result due to the lack of
510 consistency check in kernel even if noac is used.