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