]> git.decadent.org.uk Git - nfs-utils.git/blob - utils/mount/nfsmount.conf.man
mount.nfs mapage: clear up confusion between 'proto' and 'transport'
[nfs-utils.git] / utils / mount / nfsmount.conf.man
1 .\"@(#)nfsmount.conf.5"
2 .TH NFSMOUNT.CONF 5 "9 October 2012"
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 sections 
10 followed by variables associated with that section.
11 A section is defined by a string enclosed by 
12 .BR [
13 and 
14 .BR ]
15 branches.
16 Variables 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 exactly the set of NFS specific
22 mount options listed in
23 .BR nfs (5).
24 .PP
25 Sections are broken up into three basic categories:
26 Global options, Server options and Mount Point options.
27 .HP
28 .B [ NFSMount_Global_Options ]
29 - This statically named section
30 defines all of the global mount options that can be 
31 applied to every NFS mount.
32 .HP
33 .B [ Server \(lqServer_Name\(rq ] 
34 - This section defines all the mount options that should 
35 be used on mounts to a particular NFS server. The 
36 .I \(lqServer_Name\(rq
37 strings needs to be surrounded by '\(lq' and 
38 be an exact match of the server name used in the 
39 .B mount
40 command. 
41 .HP
42 .B [ MountPoint \(lqMount_Point\(rq ]
43 - This section defines all the mount options that 
44 should be used on a particular mount point.
45 The 
46 .I \(lqMount_Point\(rq
47 string needs to be surrounded by '\(lq' and be an 
48 exact match of the mount point used in the 
49 .BR mount 
50 command.
51 .SH EXAMPLES
52 .PP
53 These are some example lines of how sections and variables
54 are defined in the configuration file.
55 .PP
56 [ NFSMount_Global_Options ]
57 .br
58     Proto=Tcp
59 .RS
60 .HP
61 The TCP/IPv4 protocol will be used on every NFS mount.
62 .HP
63 .RE
64 [ Server \(lqnfsserver.foo.com\(rq ]
65 .br
66     rsize=32k
67 .br
68     wsize=32k
69 .br
70     proto=udp6
71 .HP
72 .RS
73 A 32k (32768 bytes) block size will be used as the read and write
74 size on all mounts to the 'nfsserver.foo.com' server.  UDP/IPv6
75 is the protocol to be used.
76 .HP
77 .RE
78 .BR 
79 [ MountPoint \(lq/export/home\(rq ]
80 .br
81     Background=True
82 .RS
83 .HP
84 All mounts to the '/export/home' export will be performed in
85 the background (i.e. done asynchronously).
86 .HP
87 .SH FILES
88 .TP 10n
89 .I /etc/nfsmount.conf
90 Default NFS mount configuration file
91 .PD
92 .SH SEE ALSO
93 .BR nfs (5),
94 .BR mount (8),