]> git.decadent.org.uk Git - nfs-utils.git/blobdiff - utils/exportfs/exports.man
* utils/exportfs/exports.man: Comment out a leftover TP that
[nfs-utils.git] / utils / exportfs / exports.man
index b256e4f6182c18b41260af9b3519cefa177339ef..5dcc809361d6002df79eb3f76b0f43392116b832 100644 (file)
@@ -8,7 +8,7 @@ exports \- NFS file systems being exported (for Kernel based NFS)
 The file
 .I /etc/exports
 serves as the access control list for file systems which may be
-exported to NFS clients.  It it used by
+exported to NFS clients.  It is used by
 .IR exportfs (8)
 to give information to
 .IR mountd (8)
@@ -17,12 +17,18 @@ and to the kernel based NFS file server daemon
 .PP
 The file format is similar to the SunOS
 .I exports
-file, except that several additional options are permitted.  Each line
-contains an export point and a list of machine or netgroup names allowed
-to mount the file system at that point.  An optional parenthesized list
-of export parameters may follow each machine name.  Blank lines are
-ignored, and a # introduces a comment to the end of the line. Entries may
-be continued across newlines using a backslash.
+file. Each line contains an export point and a whitespace-separated list
+of clients allowed to mount the file system at that point. Each listed
+client may be immediately followed by a parenthesized, comma-separated
+list of export options for that client. No whitespace is permitted
+between a client and its option list.
+.PP
+Blank lines are ignored.  A pound sign ("#") introduces a comment to the
+end of the line. Entries may be continued across newlines using a
+backslash. If an export name contains spaces it should be quoted using
+double quotes. You can also specify spaces or other unusual character in
+the export name using a backslash followed by the character code as three
+octal digits.
 .PP
 .SS Machine Name Formats
 NFS clients may be specified in a number of ways:
@@ -46,8 +52,13 @@ above pattern does not include hosts such as \fIa.b.cs.foo.edu\fR.
 You can also export directories to all hosts on an IP (sub-) network
 simultaneously. This is done by specifying an IP address and netmask pair
 as
-.IR address/netmask .
-.TP
+.IR address/netmask
+where the netmask can be specified in dotted-decimal format, or as a
+contiguous mask length (for example, either `/255.255.252.0' or `/22' appended
+to the network base address result in identical subnetworks with 10 bits of
+host). Wildcard characters generally do not work on IP addresses, though they
+may work by accident when reverse DNS lookups fail.
+'''.TP
 '''.B =public
 '''This is a special ``hostname'' that identifies the given directory name
 '''as the public root directory (see the section on WebNFS in
@@ -124,6 +135,13 @@ However, some NFS clients do not cope well with this situation as, for
 instance, it is then possible for two files in the one apparent
 filesystem to have the same inode number.
 
+The
+.I nohide
+option is currently only effective on
+.I "single host
+exports.  It does not work reliably with netgroup, subnet, or wildcard
+exports. 
+
 This option can be very useful in some situations, but it should be
 used with due care, and only after confirming that the client system
 copes with the situation effectively.
@@ -164,6 +182,28 @@ exported with subtree checks enabled.
 The default of having subtree checks enabled, can be explicitly
 requested with
 .IR subtree_check .
+
+.TP
+.IR insecure_locks
+.TP
+.IR no_auth_nlm
+This option (the two names are synonymous) tells the NFS server not to require authentication of
+locking requests (i.e. requests which use the NLM protocol).  Normally
+the NFS server will require a lock request to hold a credential for a
+user who has read access to the file.  With this flag no access checks
+will be performed.
+
+Early NFS client implementations did not send credentials with lock
+requests, and many current NFS clients still exist which are based on
+the old implementations.  Use this flag if you find that you can only
+lock files which are world readable.
+
+The default behaviour of requiring authentication for NLM requests can
+be explicitly requested with either of the synonymous
+.IR auth_nlm ,
+or
+.IR secure_locks .
+
 '''.TP
 '''.I noaccess
 '''This makes everything below the directory inaccessible for the named
@@ -306,7 +346,7 @@ which is the default setting.
 '''# Mapping for client foobar:
 '''#    remote     local
 '''uid  0-99       -       # squash these
-'''uid  100-500    1000    # map 100-500 to 1000-1500
+'''uid  100-500    1000    # map 100-500 to 1000-1400
 '''gid  0-49       -       # squash these
 '''gid  50-100     700     # map 50-100 to 700-750
 '''.fi