Imported Debian patch 1.0.10-4

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

diff --git a/utils/exportfs/exports.man b/utils/exportfs/exports.man
index 7a032bc9609453e3295e84b891c742dc2cfe84a5..7a3e6ae4275fdd9a9d7f8f82bf348ebabe37ca24 100644 (file)
--- a/utils/exportfs/exports.man
+++ b/utils/exportfs/exports.man
@@ -1,5 +1,4 @@
-.TH EXPORTS 5 "28 October 1999"
-.UC 5
+.TH EXPORTS 5 "4 March 2005" "Linux" "Linux File Formats Manual"

 .SH NAME
 exports \- NFS file systems being exported (for Kernel based NFS)
 .SH SYNOPSIS
 .SH NAME
 exports \- NFS file systems being exported (for Kernel based NFS)
 .SH SYNOPSIS


@@ -30,6 +29,9 @@ 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
 the export name using a backslash followed by the character code as three
 octal digits.
 .PP

+To apply changes to this file, run exportfs \-ra or /etc/init.d/nfs-kernel-server
+reload (the latter being a distribution-specific extension).
+.PP

 .SS Machine Name Formats
 NFS clients may be specified in a number of ways:
 .IP "single host
 .SS Machine Name Formats
 NFS clients may be specified in a number of ways:
 .IP "single host


@@ -110,12 +112,19 @@ 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.
 

+.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 upto and including 1.0.0, this option was the
 In releases of nfs-utils upto and including 1.0.0, this option was the

-default.  In this and future releases,
+default.  In all subsequence releases,

 .I sync
 is the default, and
 .I async
 .I sync
 is the default, and
 .I async

-must be explicit requested if needed.
+must be explicitly requested if needed.

 To help make system adminstrators aware of this change, 'exportfs'
 will issue a warning if neither
 .I sync
 To help make system adminstrators aware of this change, 'exportfs'
 will issue a warning if neither
 .I sync


@@ -169,9 +178,17 @@ 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
 .IR no_subtree_check
 This option disables subtree checking, which has mild security

-implications, but can improve reliability is some circumstances.
+implications, but can improve reliability in some circumstances.

 
 If a subdirectory of a filesystem is exported, but the whole
 filesystem isn't then whenever a NFS request arrives, the server must
 
 If a subdirectory of a filesystem is exported, but the whole
 filesystem isn't then whenever a NFS request arrives, the server must


@@ -190,7 +207,7 @@ subtree checking is also used to make sure that files inside
 directories to which only root has access can only be accessed if the
 filesystem is exported with
 .I no_root_squash
 directories to which only root has access can only be accessed if the
 filesystem is exported with
 .I no_root_squash

-(see below), even the file itself allows more general access.
+(see below), even if the file itself allows more general access.

 
 As a general guide, a home directory filesystem, which is normally
 exported at the root and may see lots of file renames, should be
 
 As a general guide, a home directory filesystem, which is normally
 exported at the root and may see lots of file renames, should be


@@ -203,6 +220,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


@@ -223,6 +250,21 @@ be explicitly requested with either of the synonymous
 .IR auth_nlm ,
 or
 .IR secure_locks .
 .IR auth_nlm ,
 or
 .IR secure_locks .

+.TP
+.IR no_acl
+On some specially patched kernels, and when exporting filesystems that
+support ACLs, this option tells nfsd not to reveal ACLs to clients, so
+they will see only a subset of actual permissions on the given file
+system.  This option is safe for filesystems used by NFSv2 clients and
+old NFSv3 clients that perform access decisions locally.  Current
+NFSv3 clients use the ACCESS RPC to perform all access decisions on
+the server.  Note that the
+.I no_acl
+option only has effect on kernels specially patched to support it, and
+when exporting filesystems with ACL support.  The default is to export
+with ACL support (i.e. by default,
+.I no_acl
+is off).

 
 '''.TP
 '''.I noaccess
 
 '''.TP
 '''.I noaccess


@@ -309,7 +351,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.


@@ -363,8 +405,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.


@@ -487,6 +532,12 @@ don't use a reserved port for NFS.
 '''entry.
 .SH FILES
 /etc/exports
 '''entry.
 .SH FILES
 /etc/exports

+.SH SEE ALSO
+.BR exportfs (8),
+.BR netgroup (5),
+.BR mountd (8),
+.BR nfsd (8),
+.BR showmount (8).

 '''.SH DIAGNOSTICS
 '''An error parsing the file is reported using syslogd(8) as level NOTICE from
 '''a DAEMON whenever nfsd(8) or mountd(8) is started up.  Any unknown
 '''.SH DIAGNOSTICS
 '''An error parsing the file is reported using syslogd(8) as level NOTICE from
 '''a DAEMON whenever nfsd(8) or mountd(8) is started up.  Any unknown