Document sensitive gids

[nfs-utils.git] / utils / exportfs / exports.man

diff --git a/utils/exportfs/exports.man b/utils/exportfs/exports.man
index 2b316f546bd95187622a4697d750f3410850adf4..d57b8b41cccaf302be0b00cdf752177bf59763cf 100644 (file)
--- a/utils/exportfs/exports.man
+++ b/utils/exportfs/exports.man
@@ -88,7 +88,7 @@ rpcsec_gss and to make requirements on the IP address of the client.
 understands the following export options:
 .TP
 .IR secure "\*d
 understands the following export options:
 .TP
 .IR secure "\*d

-This option requires that requests originate on an internet port less
+This option requires that requests originate on an Internet port less

 than IPPORT_RESERVED (1024). This option is on by default. To turn it
 off, specify
 .IR insecure .
 than IPPORT_RESERVED (1024). This option is on by default. To turn it
 off, specify
 .IR insecure .


@@ -109,13 +109,20 @@ Using this option usually improves performance, but at the cost that
 an unclean server restart (i.e. a crash) can cause data to be lost or
 corrupted.
 
 an unclean server restart (i.e. a crash) can cause data to be lost or
 corrupted.
 

-In releases of nfs-utils upto and including 1.0.0, this option was the
-default.  In this and future releases,
+.TP
+.IR sync
+Reply to requests only after the changes have been committed to stable
+storage (see
+.IR async
+above).
+
+In releases of nfs-utils up to and including 1.0.0, this option was the
+default.  In all subsequence releases,

 .I sync
 is the default, and
 .I async
 must be explicit requested if needed.
 .I sync
 is the default, and
 .I async
 must be explicit requested if needed.

-To help make system adminstrators aware of this change, 'exportfs'
+To help make system administrators aware of this change, 'exportfs'

 will issue a warning if neither
 .I sync
 nor
 will issue a warning if neither
 .I sync
 nor


@@ -168,6 +175,14 @@ copes with the situation effectively.
 The option can be explicitly disabled with
 .IR hide .
 .TP
 The option can be explicitly disabled with
 .IR hide .
 .TP

+.IR crossmnt
+This option is similar to
+.I nohide
+but it makes it possible for clients to move from the filesystem marked
+with crossmnt to exported filesystems mounted on it.  Thus when a child
+filesystem "B" is mounted on a parent "A", setting crossmnt on "A" has
+the same effect as setting "nohide" on B.
+.TP

 .IR no_subtree_check
 This option disables subtree checking, which has mild security
 implications, but can improve reliability in some circumstances.
 .IR no_subtree_check
 This option disables subtree checking, which has mild security
 implications, but can improve reliability in some circumstances.


@@ -202,6 +217,16 @@ The default of having subtree checks enabled, can be explicitly
 requested with
 .IR subtree_check .
 
 requested with
 .IR subtree_check .
 

+From release 1.1.0 of nfs-utils onwards, the default will be
+.I no_subtree_check
+as subtree_checking tends to cause more problems than it is worth.
+If you genuinely require subtree checking, you should explicitly put
+that option in the
+.B exports
+file.  If you put neither option,
+.I exportfs
+will warn you that the change is pending.
+

 .TP
 .IR insecure_locks
 .TP
 .TP
 .IR insecure_locks
 .TP


@@ -272,7 +297,7 @@ if, for example, the filesystem failed to mount due to a disc error.
 
 If a path is given (e.g.
 .IR mountpoint= "/path or " mp= /path)
 
 If a path is given (e.g.
 .IR mountpoint= "/path or " mp= /path)

-then the nominted path must be a mountpoint for the exportpoint to be
+then the nominated path must be a mountpoint for the exportpoint to be

 exported.
 
 .TP
 exported.
 
 .TP


@@ -323,7 +348,7 @@ By default,
 '''in the password file at startup time. If it isn't found, a uid and gid
 .I exportfs
 chooses a uid and gid
 '''in the password file at startup time. If it isn't found, a uid and gid
 .I exportfs
 chooses a uid and gid

-of -2 (i.e. 65534) for squashed access. These values can also be overridden by
+of 65534 for squashed access. These values can also be overridden by

 the
 .IR anonuid " and " anongid
 options.
 the
 .IR anonuid " and " anongid
 options.


@@ -377,8 +402,11 @@ Here's the complete list of mapping options:
 .TP
 .IR root_squash
 Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does
 .TP
 .IR root_squash
 Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does

-not apply to any other uids that might be equally sensitive, such as user
-.IR bin .
+not apply to any other uids or gids that might be equally sensitive, such as
+user
+.IR bin 
+or group
+.IR staff .

 .TP
 .IR no_root_squash
 Turn off root squashing. This option is mainly useful for diskless clients.
 .TP
 .IR no_root_squash
 Turn off root squashing. This option is mainly useful for diskless clients.