Blame SOURCES/autofs-5.0.9-amd-lookup-update-man-pages.patch

304803
autofs-5.0.9 - amd lookup update man pages
304803
304803
From: Ian Kent <raven@themaw.net>
304803
304803
Update man pages to reflect the addition of the amd map format
304803
parser, move configuration to it's own man page and update with
304803
amd options descriptions.
304803
---
304803
 man/auto.master.5.in           |  183 ++----------------
304803
 man/autofs.5                   |  346 +++++++++++++++++++++++++++++++++-
304803
 man/autofs.8.in                |    1 
304803
 man/autofs.conf.5.in           |  412 ++++++++++++++++++++++++++++++++++++++++
304803
 man/autofs_ldap_auth.conf.5.in |    1 
304803
 man/automount.8                |    1 
304803
 6 files changed, 782 insertions(+), 162 deletions(-)
304803
 create mode 100644 man/autofs.conf.5.in
304803
304803
diff --git a/man/auto.master.5.in b/man/auto.master.5.in
304803
index 59df04f..2267550 100644
304803
--- a/man/auto.master.5.in
304803
+++ b/man/auto.master.5.in
304803
@@ -122,14 +122,18 @@ will be ignored if its name is not ended with the suffix. In addition a dot file
304803
 which name is started with "." is also ignored.
304803
 .RE
304803
 .TP
304803
-\fBformat\fP
304803
-Format of the map data; currently the only formats
304803
-recognized are \fBsun\fP, which is a subset of the Sun automounter map
304803
-format, and \fBhesiod\fP, for hesiod filesys entries.  If the format is
304803
-left unspecified, it defaults to \fBsun\fP for all map types except
304803
-\fBhesiod\fP.
304803
-.TP
304803
-\fBmap\fP
304803
+.B format
304803
+.br
304803
+Format of the map data; currently the formats recognized are \fBsun\fP,
304803
+which is a subset of the Sun automounter map format, \fBhesiod\fP, for
304803
+hesiod filesys entries and \fBamd\fP for amd formated map entries.
304803
+If the format is left unspecified, it defaults to \fBsun\fP for all map
304803
+types except \fBhesiod\fP unless it is a top level \fBamd\fP mount that
304803
+has a configuration entry for the mount point path, in which case the
304803
+format used is \fBamd\fP.
304803
+.TP
304803
+.B map
304803
+.br
304803
 Name of the map to use.  This is an absolute UNIX pathname
304803
 for maps of types \fBfile\fP, \fBdir\fP, or \fBprogram\fP, and the name of a database
304803
 in the case for maps of type \fByp\fP, \fBnisplus\fP, or \fBhesiod\fP or
304803
@@ -205,87 +209,6 @@ or in the configuration.
304803
 Set the timeout for caching failed key lookups. This option can be
304803
 used to override the global default given either on the command line
304803
 or in the configuration.
304803
-.SH AUTOFS CONFIGURATION
304803
-.P
304803
-There are two files that amy contain configuration settings
304803
-.nh
304803
-.BR @@autofsmapdir@@/autofs.conf .
304803
-.hy
304803
-and
304803
-.BR @@autofsconfdir@@/autofs .
304803
-.hy
304803
-The former contains the bulk of configuration options while the later
304803
-contains entries to be set in the environment for use by the init
304803
-sub-system.
304803
-.TP
304803
-The only entry currently present in the init system configuration
304803
-is OPTIONS which may be used to specify options to be used when
304803
-starting
304803
-.BR automount (8) .
304803
-.TP
304803
-Previously all configuration entries were located in the init system
304803
-configuration file and their values were set in the environment for
304803
-later use by autofs. Configuration entries that were set in the
304803
-environment continue to be set in the environment at program startup
304803
-and any setting already present in the environment takes precedence.
304803
-.SH SYSTEM DEFAULTS CONFIGURATION
304803
-.P
304803
-The value of most settings may be set in the configuration file
304803
-.nh
304803
-.BR @@autofsmapdir@@/autofs.conf .
304803
-.hy
304803
-Configuration entries are "name = value" pairs and the name is case
304803
-insensitive. Older configuration names had a DEFAULTS_ prefix which
304803
-is appended to the configuration name when a value isn't found and
304803
-the search repeated.
304803
-.TP
304803
-An optional section name
304803
-.nh
304803
-.BR [ autofs ]
304803
-.hy
304803
-may also be given.
304803
-.TP
304803
-The available configuration entries are:
304803
-.TP
304803
-.B timeout
304803
-Sets the default mount timeout in seconds. The internal program
304803
-default is 10 minutes, but the default installed configuration
304803
-overrides this and sets the timeout to 5 minutes to be consistent
304803
-with earlier autofs releases.
304803
-.TP
304803
-.B negative_timeout
304803
-Set the default timeout for caching failed key lookups (program default
304803
-60). If the equivalent command line option is given it will override this
304803
-setting.
304803
-.TP
304803
-.B mount_wait
304803
-Set the default time to wait for a response from a spawned mount(8)
304803
-before sending it a SIGTERM. Note that we still need to wait for the
304803
-RPC layer to timeout before the sub-process exits so this isn't ideal
304803
-but it is the best we can do. The default is to wait until mount(8)
304803
-returns without intervention.
304803
-.TP
304803
-.B umount_wait
304803
-Set the default time to wait for a response from a spawned umount(8)
304803
-before sending it a SIGTERM. Note that we still need to wait for the
304803
-RPC layer to timeout before the sub-process exits so this isn't ideal
304803
-but it is the best we can do.
304803
-.TP
304803
-.B browse_mode
304803
-Maps are browsable by default (program default "yes").
304803
-.TP
304803
-.B mount_nfs_default_protocol
304803
-Specify the default protocol used by mount.nfs(8) (program default 3). Since
304803
-we can't identify this default automatically we need to set it in the autofs
304803
-configuration.
304803
-.TP
304803
-.B append_options
304803
-Determine whether global options, given on the command line or per mount
304803
-in the master map, are appended to map entry options or if the map entry
304803
-options replace the global options (program default "yes", append options).
304803
-.TP
304803
-.B logging
304803
-set default log level "none", "verbose" or "debug" (program default "none").
304803
 .SH BUILTIN MAP -hosts
304803
 If "-hosts" is given as the map then accessing a key under the mount point
304803
 which corresponds to a hostname will allow access to the exports of that
304803
@@ -341,76 +264,21 @@ The object classes and attributes used for accessing automount maps in
304803
 LDAP can be changed by setting entries in the autofs configuration
304803
 located in
304803
 .nh
304803
-.BR @@autofsmapdir@@/autofs.conf .
304803
+.BR @@autofsconfdir@@/autofs.conf .
304803
 .hy
304803
 .TP
304803
 .B NOTE:
304803
 If a schema is given in the configuration then all the schema configuration
304803
 values must be set, any partial schema specification will be ignored.
304803
-.P
304803
-The configuration settings available are:
304803
-.TP
304803
-.B ldap_timeout
304803
-Set the network response timeout (default 8).
304803
-Set timeout value for the synchronous API  calls. The default is the LDAP
304803
-library default of an infinite timeout.
304803
 .TP
304803
-.B ldap_network_timeout
304803
-Set the network response timeout (default 8).
304803
-.TP
304803
-.B ldap_uri
304803
-A space seperated list of server uris of the form <proto>://<server>[/]
304803
-where <proto> can be ldap or ldaps. The option can be given multiple times.
304803
-Map entries that include a server name override this option and it is then
304803
-not used. Default is an empty list in which case either the server given
304803
-in a map entry or the LDAP configured default is used. This uri list is read at
304803
-startup and whenever the daemon receives a HUP signal.
304803
-.P
304803
-This configuration option can also be used to request autofs lookup SRV RRs
304803
-for a domain of the form <proto>:///[<domain dn>]. Note that a trailing
304803
-"/" is not allowed when using this form. If the domain dn is not specified
304803
-the dns domain name (if any) is used to construct the domain dn for the
304803
-SRV RR lookup. The server list returned from an SRV RR lookup is refreshed
304803
-according to the minimum ttl found in the SRV RR records or after one hour,
304803
-whichever is less.
304803
+For \fBamd\fP format maps a different schema is used:
304803
 .TP
304803
-.B search_base
304803
-The base dn to use when searching for amap base dn. This entry may be
304803
-given multiple times and each will be checked for a map base dn in
304803
-the order they occur in the configuration. The search base list is read
304803
-at startup and whenever the daemon recieves a HUP signal.
304803
-.TP
304803
-.B map_object_class
304803
-The map object class. In the \fBnisMap\fP schema this corresponds to the class
304803
-\fBnisMap\fP and in the \fBautomountMap\fP schema it corresponds to the class
304803
-\fBautomountMap\fP.
304803
-.TP
304803
-.B entry_object_class
304803
-The map entry object class. In the \fBnisMap\fP schema this corresponds
304803
-to the class \fBnisObject\fP and in the \fBautomountMap\fP schema it
304803
-corresponds to the class \fBautomount\fP.
304803
-.TP
304803
-.B map_attribute
304803
-The attribute used to identify the name of the map to which this
304803
-entry belongs.  In the \fBnisMap\fP schema this corresponds to the attribute
304803
-\fBnisMapName\fP and in the \fBautomountMap\fP schema it corresponds to the
304803
-attribute \fBou\fP or \fBautomountMapName\fP.
304803
-.TP
304803
-.B entry_attribute
304803
-The attribute used to identify a map key. In the \fBnisMap\fP schema this
304803
-corresponds to the attribute \fBcn\fP and in the \fBautomountMap\fP schema
304803
-it corresponds to the attribute \fBautomountKey\fP.
304803
-.TP
304803
-.B value_attribute
304803
-The attribute used to identify the value of the map entry. In the \fBnisMap\fP
304803
-schema this corresponds to the attribute \fBnisMapEntry\fP and in the \fBautomountMap\fP
304803
-schema it corresponds to the attribute \fBautomountInformation\fP.
304803
-.TP
304803
-.B NOTE:
304803
-It is essential that entries use class and attribute in a consistent
304803
-manner for correct operation of autofs. For example mixing \fBcn\fP and
304803
-\fBautomountKey\fP attributes in \fBautomount\fP schema map entries won't
304803
-work as expected.
304803
+.I amdMap
304803
+.br
304803
+The \fBamdmap\fP schema contains attributes \fBamdmapName\fP, \fBamdmapKey\fP
304803
+and \fBamdmapValue\fP where \fBamdmapName\fP contains the name of the containing
304803
+map, \fBamdmapKey\fP contains the map key and \fBamdmapValue\fP contains the
304803
+map entry.
304803
 .SH LDAP AUTHENTICATION, ENCRYPTED AND CERTIFIED CONNECTIONS
304803
 LDAP authenticated binds, TLS encrypted connections and certification
304803
 may be used by setting appropriate values in the autofs authentication
304803
@@ -419,10 +287,6 @@ settings.  The default location of this file is
304803
 .nh
304803
 .BR @@autofsmapdir@@/autofs_ldap_auth.conf .
304803
 .hy
304803
-.TP
304803
-.B auth_conf_file
304803
-This configuration option may be used to specify an alternate location
304803
-for the ldap authentication file
304803
 .P
304803
 If this file exists it will be used to establish whether TLS or authentication
304803
 should be used.
304803
@@ -458,7 +322,9 @@ in the per-user configuration. The location of these files and the configuration
304803
 entry requirements is system dependent so the documentation for your
304803
 installation will need to be consulted to get further information.
304803
 .P
304803
-See \fBautofs_ldap_auth.conf\fP(5) for more information.
304803
+See
304803
+.B autofs_ldap_auth.conf (5)
304803
+for more information.
304803
 .SH EXAMPLE
304803
 .sp
304803
 .RS +.2i
304803
@@ -492,7 +358,8 @@ configuration will be used to locate the source of the map
304803
 .SH "SEE ALSO"
304803
 .BR automount (8),
304803
 .BR autofs (5),
304803
-.BR autofs (8).
304803
+.BR autofs (8),
304803
+.BR autofs.conf (5),
304803
 .BR autofs_ldap_auth.conf (5)
304803
 .SH AUTHOR
304803
 This manual page was written by Christoph Lameter <chris@waterf.org>,
304803
diff --git a/man/autofs.5 b/man/autofs.5
304803
index c3a1611..81ae375 100644
304803
--- a/man/autofs.5
304803
+++ b/man/autofs.5
304803
@@ -1,6 +1,5 @@
304803
 .\" t
304803
-.TH AUTOFS 5 "6 Apr 1998"
304803
-.TH AUTOFS 5 "14 Jan 2000"
304803
+.TH AUTOFS 5 "9 Feb 2014"
304803
 .SH NAME
304803
 autofs \- Format of the automounter maps
304803
 .SH "DESCRIPTION"
304803
@@ -10,14 +9,16 @@ the master map of the automounter (see
304803
 These maps describe how file systems below the mount point of the map
304803
 (given in the master map) are to be mounted.  This page describes the
304803
 .B sun
304803
-map format; if another map format is specified (e.g. \fBhesiod\fP),
304803
+map format; if another map format, other than
304803
+.B amd ,
304803
+is specified (e.g. \fBhesiod\fP),
304803
 this documentation does not apply.
304803
 
304803
 Indirect maps, except for the internal hosts map, can be changed on the fly
304803
 and the automouter will recognize those changes on the next operation it
304803
 performs on that map. Direct maps require a HUP signal be sent to the
304803
 daemon to refresh their contents as does the master map.
304803
-.SH "FORMAT"
304803
+.SH "SUN FORMAT"
304803
 This is a description of the text file format.  Other methods of specifying
304803
 these files may exist.  All empty lines or lines beginning with # are
304803
 ignored. The basic format of one line in such maps is:
304803
@@ -245,10 +246,347 @@ Anything else is questionable and unsupported, but these variations will also wo
304803
 .SH UNSUPPORTED
304803
 This version of the automounter supports direct maps stored in FILE, NIS, NISPLUS
304803
 and LDAP only.
304803
+.P
304803
+.SH "AMD FORMAT"
304803
+This is a description of the text file format. Other methods of specifying
304803
+mount map entries may be required for different map sources.  All empty
304803
+lines or lines beginning with # are ignored. The basic format of one
304803
+line in such maps is:
304803
+.P
304803
+.BR key\ location-list
304803
+.TP
304803
+.B key
304803
+.br
304803
+A \fBkey\fP is a path (or a single path component alone) that may end
304803
+in the wildcard key, "*", or the wildcard key alone and must not begin
304803
+with the "/" character.
304803
+.TP
304803
+.B location-list
304803
+Following the \fBkey\fP is a mount \fBlocation-list\fP.
304803
+.TP
304803
+A \fBlocation-list\fP list has the following syntax:
304803
+.TP
304803
+.B location[\ location[\ ...\ ]]\ [||\ location[\ location[\ ...\ ]]
304803
+.P
304803
+A mount \fBlocation-list\fP can use the cut operator, \fB||\fP, to specify
304803
+locations that should be tried if none of the locations to the left of it
304803
+where selected for a mount attempt.
304803
+
304803
+A mount \fBlocation\fP consists of an optional colon seperated list
304803
+of \fBselectors\fP, followed by a colon seperated list of \fBoption:=value\fP
304803
+pairs.
304803
+
304803
+The \fBselectors\fP that may be used return a value or boolean result.
304803
+Those that return a value may be to used with the comparison
304803
+operators \fB==\fP and \fB!=\fP and those that return a boolean result
304803
+may be negated with the \fB!\fP.
304803
+
304803
+For a \fBlocation\fP to be selected for a mount attempt all of its \fBselectors\fP
304803
+must evaluate to true. If a \fBlocation\fP is selected for a mount attempt
304803
+and succeeds the lookup is completed and returns success. If the mount
304803
+attempt fails the proceedure continues with the next \fBlocation\fP until
304803
+they have all been tried.
304803
+
304803
+In addition some \fBselectors\fP take no argumenets, some one argument
304803
+and others optionally take two arguments.
304803
+
304803
+The \fBselectors\fP that take no arguments are:
304803
+.RS
304803
+.TP
304803
+.B arch
304803
+.br
304803
+The machine architecture which, if not set in the confugration, is
304803
+obtained using uname(2).
304803
+.TP
304803
+.B karch
304803
+.br
304803
+The machine kernel architecture which, if not set in the confugration,
304803
+is obtained using uname(2).
304803
+.TP
304803
+.B os
304803
+.br
304803
+The operating system name, if not set in the confugration, is obtained
304803
+using uname(2).
304803
+.TP
304803
+.B osver
304803
+.br
304803
+The operating system version, if not set in the confugration, is obtained
304803
+using uname(2).
304803
+.TP
304803
+.B full_os
304803
+.br
304803
+The full operating system name, if not set in the confugration this selector
304803
+has no value.
304803
+.TP
304803
+.B vendor
304803
+.br
304803
+The operating system vendor name, if not set in the confugration this selector
304803
+has the value "unknown".
304803
+.TP
304803
+.B byte
304803
+.br
304803
+The endianess of the hardware.
304803
+.TP
304803
+.B cluster
304803
+.br
304803
+The name of the local cluster. It has a value only if it is set in the
304803
+configuration.
304803
+.TP
304803
+.B autodir
304803
+.br
304803
+The base path under which external mounts are done if they are needed.
304803
+Most mounts are done in place but some can't be and this is the base
304803
+path under which those mounts will be done.
304803
+.TP
304803
+.B domain
304803
+.br
304803
+The local domain name. It is set to the value of the configuration
304803
+option \fBsub_domain\fP. If sub_domain is not given in the configuration
304803
+it is set to the domain part of the local host name, as given by
304803
+gethostname(2).
304803
+.TP
304803
+.B host
304803
+.br
304803
+The local host name, without the domain part, as given by gethostname(2).
304803
+.TP
304803
+.B hostd
304803
+.br
304803
+The full host name. If \fBsub_domain\fP is given in the configuration
304803
+this is set to the contatenation of \fBhost\fP and \fBsub_domain\fP deperated
304803
+by a \fB.\fP. If \fBsub_domain\fP is not set in the configuration the value
304803
+of \fBdomain\fP is used instead of \fBsub_domain\fP.
304803
+.TP
304803
+.B uid
304803
+.br
304803
+The numeric value of the uid of the user that first requested the mount. Note
304803
+this is usual the same as that used by amd but can be different within autofs.
304803
+.TP
304803
+.B gid
304803
+.br
304803
+The numeric value of the gid of the user that first requested the mount. Note
304803
+this is usual the same as that used by amd but can be different within autofs.
304803
+.TP
304803
+.B key
304803
+.br
304803
+The string value of the key being looked up.
304803
+.TP
304803
+.B map
304803
+.br
304803
+The string value of the map name used to lookup \fBkey\fPs.
304803
+.TP
304803
+.B path
304803
+.br
304803
+The string value of the full path to the mount being requested.
304803
+.TP
304803
+.B dollar
304803
+.br
304803
+Evaluates to the string "$".
304803
+.RE
304803
+.TP
304803
+The \fBselectors\fP that take one argument are:
304803
+.RS
304803
+.TP
304803
+.B in_network(network) ", " network(network) ", " netnumber(network) ", " wire(network)
304803
+.br
304803
+These \fBselectors\fP are all the same. \fBin_network()\fP is the
304803
+preferred usage. The \fBnetwork\fP argument is an address (which may include
304803
+a subnet mask) or network name. The function compares \fBnetwork\fP
304803
+against each interface and returns true if \fBnetwork\fP belongs to
304803
+the network the interface is connected to.
304803
+.TP
304803
+.B xhost(hostname)
304803
+.br
304803
+The \fBxhost()\fP selector compares \fBhostname\fP to the \fB${host}\fP
304803
+and if it doesn't match it attempts to lookup the cannonical name
304803
+of \fBhostname\fP and compares it to \f${host}\fP as well.
304803
+.TP
304803
+.B exists(filename)
304803
+.br
304803
+Returns true if \fBfilename\fP exits as determined by lstat(2).
304803
+.TP
304803
+.B true()
304803
+.br
304803
+Evaluates to true, the argument is ignored and may be empty.
304803
+.TP
304803
+.B false()
304803
+.br
304803
+Evaluates to false, the argument is ignored and may be empty.
304803
+.RE
304803
+.TP
304803
+The \fBselectors\fP that take up to two arguments are:
304803
+.RS
304803
+.TP
304803
+.B netgrp(netgroup[,hostname])
304803
+.br
304803
+The \fBnetgrp()\fP selector returns true if \fPhostname\fP is a member of
304803
+the netgroup \fBnetgroup\fP. If \fBhostname\fP is not given \fB${host}\fP
304803
+is used for the comparison.
304803
+.TP
304803
+.B netgrpd(netgroup[,hostname])
304803
+.br
304803
+The \fBnetgrpd()i\fP selector behaves the same as \fBnetgrp()\fP except
304803
+that if \fBhostname\fP is not given \fB${hostd}\fP, the fully qualified
304803
+hostname, is used instead of \fB${host}\fP.
304803
+.RE
304803
+.TP
304803
+The \fBoptions\fP that may be used are:
304803
+.RS
304803
+.TP
304803
+.B type
304803
+.br
304803
+This is the mount filesystem \fBtype\fP.
304803
+It can have a value of
304803
+.BR auto ", " link ", " linkx ", " host ", " lofs ", " ext2-4 ", "
304803
+.BR xfs ", " nfs ", " nfsl " or " cdfs "."
304803
+Other types that are not yet implemented or are not available iin autofs are
304803
+.BR nfsx ", " lustre ", " jfs ", " program ", " cachefs " and " direct "."
304803
+.TP
304803
+.B maptype
304803
+.br
304803
+The \fBmaptype\fP option specifies the type of the map source and can
304803
+have a value of \fBfile\fP, \fBnis\fP, \fBnisplus\fP, \fBexec\fP, \fBldap\fP
304803
+or \fBhesiod\fP. Map sources either not yet implemented or not available in
304803
+autofs are \fBsss\fP, \fBndbm\fP, \fBpasswd\fP and \fBunion\fP.
304803
+.TP
304803
+.B fs
304803
+.br
304803
+The option \fBfs\fP is used to specify the local filesystem. The meaning of
304803
+this option (and whether or not it is used) is dependent on the mount
304803
+filesystem \fBtype\fP.
304803
+.TP
304803
+.B rhost
304803
+.br
304803
+The remote host name for network mount requests.
304803
+.TP
304803
+.B rfs
304803
+.br
304803
+The remote host filesystem path for network mount requests.
304803
+.TP
304803
+.B dev
304803
+.br
304803
+Must resolve to the device file for local device mount
304803
+requests.
304803
+.TP
304803
+.B sublink
304803
+.br
304803
+The \fBsublink\fP option is used to specify a subdirectory
304803
+within the mount location to which this entry will point.
304803
+.TP
304803
+.B pref
304803
+.br
304803
+The \fBpref\fP option is used to specify a prefix that is
304803
+prepended to the lookup key before looking up the map entry
304803
+key.
304803
+.TP
304803
+.B opts
304803
+.br
304803
+The \fBopts\fP option is used to specify mount options to be
304803
+used for the mount. If a "\fB-\fP" is given it is ignored.
304803
+Options that may be used are dependend on the mount filesystem.
304803
+.TP
304803
+.B addopts
304803
+.br
304803
+The \fBaddopts\fP option is used to specify additional mount
304803
+options used in addition to the default mount options for the
304803
+mount location.
304803
+.TP
304803
+.B remopts
304803
+.br
304803
+The \fBaddopts\fP option is used to specify mount options used
304803
+instead the options given in \fBopts\fP when the mount location
304803
+is on a remote retwork.
304803
+.RE
304803
+.TP
304803
+A number of \fBoptions\fP aren't available or aren't yet implemented
304803
+within autofs, these are:
304803
+.RS
304803
+.TP
304803
+.B cache
304803
+.br
304803
+The \fBcache option\fP isn't used by autofs. The map entry cache is
304803
+continually updated and stale entries cleaned on re-load when map
304803
+changes are detected so these configuration entries are not used.
304803
+The \fBregex\fP map key matching is not implemented and may not be
304803
+due to the potential overhead of the full map scans needed on every
304803
+key lookup.
304803
+.TP
304803
+.B cachedir
304803
+.br
304803
+The \fBcachefs\fP filesystem is not available on Linux, a different
304803
+implementation is used for caching network mounted file systems.
304803
+.TP
304803
+.B mount ", " unmount ", " umount
304803
+.br
304803
+These \fBoptions\fP are used by the amd \fBprogram\fP mount type which
304803
+is not yet implemented.
304803
+.TP
304803
+.B delay
304803
+.br
304803
+This \fBoption\fP is not used by the autofs implementation and is ignored.
304803
+.RE
304803
+.BR
304803
+.SH FEATURES
304803
+.SS Key Matching
304803
+The amd parser key matching is unusual.
304803
+
304803
+The key string to be looked up is constructed by prepending the prefix, if
304803
+there is one.
304803
+
304803
+The resulting relative path string is matched by first trying the sting
304803
+itself. If no match is found the last component of the key string is
304803
+replaced with the wilcard match cahracter ("*") and a wildcard match is
304803
+attemted. This process continues until a match is found or until the
304803
+last match, against the wilcard match key alone, fails to match a map
304803
+entry and the key lookup fails.
304803
+.SS Macro Usage
304803
+Macros are used a lot in the autofs amd implementation.
304803
+
304803
+Many of the option values are set as macro variables corresponding to the
304803
+option name during the map entry parse. So they may be used in subsequent
304803
+option values. Beware though, the order in which option values is not
304803
+necessarily left to right so you may get unexpected results.
304803
+.BR
304803
+.SH EXAMPLE
304803
+Example NFS mount map:
304803
+.P
304803
+Assuming we have the autofs master map entry:
304803
+.sp
304803
+.RS +.2i
304803
+.ta 1.0i 3.0i
304803
+.nf
304803
+/test	file,amd:/etc/amd.test
304803
+.fi
304803
+.RE
304803
+.sp
304803
+And the following map in /etc/amd.test:
304803
+.sp
304803
+.RS +.2i
304803
+.ta 1.0i 3.0i
304803
+.nf
304803
+/defaults	type:=nfs;rhost:=bilbo
304803
+apps	rfs:=/autofs
304803
+util	rhost:=zeus;rfs:=/work/util
304803
+local	rfs:=/shared;sublink:=local
304803
+.fi
304803
+.RE
304803
+.sp
304803
+In the first line we have an NFS remote mount of the exported directory
304803
+/autofs from host bilbo which would be mounted on /test/apps. Next
304803
+another nfs mount for the exported directory /work/util from host zeus.
304803
+This would be mounted on /test/util.
304803
+
304803
+Finally we have an example of the use of the \fBsublink\fP option. In
304803
+this case the filesystem bilbo:/shared would be mounted on a path
304803
+external the automount directory (under the direcory given by
304803
+configuration option auto_dir) and the path /test/local either
304803
+symlinked or bind mounted (depending on the setting autofs_use_lofs)
304803
+to the "local" subdirectory of the external mount.
304803
+.BR
304803
 .SH "SEE ALSO"
304803
 .BR automount (8),
304803
 .BR auto.master (5),
304803
 .BR autofs (8),
304803
+.BR autofs.conf (5),
304803
 .BR mount (8).
304803
 .BR autofs_ldap_auth.conf (5)
304803
 .SH AUTHOR
304803
diff --git a/man/autofs.8.in b/man/autofs.8.in
304803
index fae0b00..7ab4242 100644
304803
--- a/man/autofs.8.in
304803
+++ b/man/autofs.8.in
304803
@@ -49,6 +49,7 @@ will display the status of,
304803
 .SH "SEE ALSO"
304803
 .BR automount (8),
304803
 .BR autofs (5),
304803
+.BR autofs.conf (5),
304803
 .BR auto.master (5).
304803
 .BR autofs_ldap_auth.conf (5)
304803
 .SH AUTHOR
304803
diff --git a/man/autofs.conf.5.in b/man/autofs.conf.5.in
304803
new file mode 100644
304803
index 0000000..aad4143
304803
--- /dev/null
304803
+++ b/man/autofs.conf.5.in
304803
@@ -0,0 +1,412 @@
304803
+.\" t
304803
+.TH AUTOFS.CONF "23 Jan 2014"
304803
+.SH NAME
304803
+autofs.conf \- autofs configuration
304803
+.SH "DESCRIPTION"
304803
+.P
304803
+Configuration settings used by
304803
+.BR automount (8)
304803
+may be changed in the configuration file \fB@@autofsmapdir@@/autofs.conf\fP.
304803
+.P
304803
+This file contains two primary sections, \fBautofs\fP and \fBamd\fP.
304803
+.P
304803
+Configuration entries may be present at the beginning of the
304803
+configuration file without a section header and are implicitly
304803
+included as part of the \fBautofs\fP section.
304803
+.P
304803
+Each section name is enclosed in square brackets with
304803
+spaces between the brackets and the section name. The \fBamd\fP
304803
+section may be followed by further sections, named by the
304803
+top level mount point path, that contain per mount
304803
+configuration settings.
304803
+.SH "SECTION autofs CONFIGURATION OPTIONS"
304803
+.P
304803
+Configuration settings available are:
304803
+.TP
304803
+.B timeout
304803
+.br
304803
+Sets the default mount timeout in seconds. The internal program
304803
+default is 10 minutes, but the default installed configuration
304803
+overrides this and sets the timeout to 5 minutes to be consistent
304803
+with earlier autofs releases.
304803
+.TP
304803
+.B negative_timeout
304803
+.br
304803
+Set the default timeout for caching failed key lookups (program default
304803
+60). If the equivalent command line option is given it will override this
304803
+setting.
304803
+.TP
304803
+.B mount_wait
304803
+.br
304803
+Set the default time to wait for a response from a spawned mount(8)
304803
+before sending it a SIGTERM. Note that we still need to wait for the
304803
+RPC layer to timeout before the sub-process exits so this isn't ideal
304803
+but it is the best we can do. The default is to wait until mount(8)
304803
+returns without intervention.
304803
+.TP
304803
+.B umount_wait
304803
+.br
304803
+Set the default time to wait for a response from a spawned umount(8)
304803
+before sending it a SIGTERM. Note that we still need to wait for the
304803
+RPC layer to timeout before the sub-process exits so this isn't ideal
304803
+but it is the best we can do.
304803
+.TP
304803
+.B browse_mode
304803
+.br
304803
+Maps are browsable by default (program default "yes").
304803
+.TP
304803
+.B mount_nfs_default_protocol
304803
+.br
304803
+Specify the default protocol used by
304803
+.BR mount.nfs (8)
304803
+(program default 3). Since we can't identify this default automatically
304803
+we need to set it in the autofs configuration.
304803
+.TP
304803
+.B append_options
304803
+.br
304803
+Determine whether global options, given on the command line or per mount
304803
+in the master map, are appended to map entry options or if the map entry
304803
+options replace the global options (program default "yes", append options).
304803
+.TP
304803
+.B logging
304803
+.br
304803
+set default log level "none", "verbose" or "debug" (program default "none").
304803
+.SS LDAP Configuration
304803
+.P
304803
+Configuration settings available are:
304803
+.TP
304803
+.B ldap_timeout
304803
+.br
304803
+Set the network response timeout (default 8).
304803
+Set timeout value for the synchronous API  calls. The default is the LDAP
304803
+library default of an infinite timeout.
304803
+.TP
304803
+.B ldap_network_timeout
304803
+.br
304803
+Set the network response timeout (default 8).
304803
+.TP
304803
+.B ldap_uri
304803
+.br
304803
+A space seperated list of server uris of the form <proto>://<server>[/]
304803
+where <proto> can be ldap or ldaps. The option can be given multiple times.
304803
+Map entries that include a server name override this option and it is then
304803
+not used. Default is an empty list in which case either the server given
304803
+in a map entry or the LDAP configured default is used. This uri list is read at
304803
+startup and whenever the daemon receives a HUP signal.
304803
+
304803
+This configuration option can also be used to request autofs lookup SRV RRs
304803
+for a domain of the form <proto>:///[<domain dn>]. Note that a trailing
304803
+"/" is not allowed when using this form. If the domain dn is not specified
304803
+the dns domain name (if any) is used to construct the domain dn for the
304803
+SRV RR lookup. The server list returned from an SRV RR lookup is refreshed
304803
+according to the minimum ttl found in the SRV RR records or after one hour,
304803
+whichever is less.
304803
+.TP
304803
+.B search_base
304803
+.br
304803
+The base dn to use when searching for amap base dn. This entry may be
304803
+given multiple times and each will be checked for a map base dn in
304803
+the order they occur in the configuration. The search base list is read
304803
+at startup and whenever the daemon recieves a HUP signal.
304803
+.TP
304803
+.B map_object_class
304803
+.br
304803
+The map object class. In the \fBnisMap\fP schema this corresponds to the class
304803
+\fBnisMap\fP and in the \fBautomountMap\fP schema it corresponds to the class
304803
+\fBautomountMap\fP.
304803
+.TP
304803
+.B entry_object_class
304803
+.br
304803
+The map entry object class. In the \fBnisMap\fP schema this corresponds
304803
+to the class \fBnisObject\fP and in the \fBautomountMap\fP schema it
304803
+corresponds to the class \fBautomount\fP.
304803
+.TP
304803
+.B map_attribute
304803
+.br
304803
+The attribute used to identify the name of the map to which this
304803
+entry belongs.  In the \fBnisMap\fP schema this corresponds to the attribute
304803
+\fBnisMapName\fP and in the \fBautomountMap\fP schema it corresponds to the
304803
+attribute \fBou\fP or \fBautomountMapName\fP.
304803
+.TP
304803
+.B entry_attribute
304803
+.br
304803
+The attribute used to identify a map key. In the \fBnisMap\fP schema this
304803
+corresponds to the attribute \fBcn\fP and in the \fBautomountMap\fP schema
304803
+it corresponds to the attribute \fBautomountKey\fP.
304803
+.TP
304803
+.B value_attribute
304803
+.br
304803
+The attribute used to identify the value of the map entry. In the \fBnisMap\fP
304803
+schema this corresponds to the attribute \fBnisMapEntry\fP and in the \fBautomountMap\fP
304803
+schema it corresponds to the attribute
304803
+.BR automountInformation .
304803
+.TP
304803
+.B NOTE:
304803
+It is essential that entries use class and attribute in a consistent
304803
+manner for correct operation of autofs. For example mixing \fBcn\fP
304803
+and \fBautomountKey\fP attributes in \fBautomount\fP schema will
304803
+not work as expected.
304803
+.TP
304803
+.B auth_conf_file
304803
+This configuration option may be used to specify an alternate location
304803
+for the ldap authentication configuration file. See
304803
+.BR autofs_ldap_auth.conf (5)
304803
+for more information.
304803
+.SH "SECTION amd CONFIGURATION OPTIONS"
304803
+.P
304803
+A number of the amd configuration options are not used by autofs,
304803
+some because they are not relevant within autofs, some because
304803
+they are done differently in autofs and others that are not yet
304803
+implemented.
304803
+
304803
+Since \fBmount_type\fP is always autofs (because there's no user space
304803
+NFS server) the configuration entries relating to that aren't used.
304803
+Also, server availability is done differently within autofs so the
304803
+options that relate to the amd server monitoring sub-system are
304803
+also not used.
304803
+
304803
+These options are \fBmount_type\fP, \fBauto_attrcache\fP, \fBportmap_program\fP,
304803
+\fBnfs_vers_ping\fP, \fBnfs_allow_any_interface\fP, \fBnfs_allow_insecure_port\fP,
304803
+\fBnfs_proto\fP, \fBnfs_retransmit_counter\fP, \fBnfs_retransmit_counter_udp\fP,
304803
+\fBnfs_retransmit_counter_tcp\fP, \fBnfs_retransmit_counter_toplvl\fP,
304803
+\fBnfs_retry_interval\fP, \fBnfs_retry_interval_udp\fP, \fBnfs_retry_interval_tcp\fP,
304803
+\fBnfs_retry_interval_toplvl\fP and \fBnfs_vers\fP.
304803
+
304803
+Other options that are not used within the autofs implementation:
304803
+.TP
304803
+.BR log_file ", " truncate_log
304803
+.br autofs used either stderr when running in the foreground or
304803
+sends its output to syslog so an alternate log file (or truncating
304803
+the log) can't be used.
304803
+.TP
304803
+.B print_pid
304803
+.br
304803
+There's no corresponding option for this within autofs.
304803
+.TP
304803
+.BR use_tcpwrappers ", " show_statfs_entries
304803
+.br
304803
+There's no user space NFS server to control access to so this
304803
+option isn't relevant. The show_statfs_entries can't be
304803
+implemented for the same reason.
304803
+.TP
304803
+.B debug_mtab_file
304803
+.br
304803
+There's no user space NFS server and autofs avoids using file
304803
+based mtab whenever possible.
304803
+.TP
304803
+.B sun_map_syntax
304803
+.br
304803
+Sun map format is handled by autofs itself.
304803
+.TP
304803
+.BR plock ", " show_statfs_entries ", " preferred_amq_port
304803
+.br
304803
+Are not supported by autofs.
304803
+.TP
304803
+.BR ldap_cache_maxmem ", " ldap_cache_seconds
304803
+.br
304803
+External ldap caching is not used by autofs.
304803
+.TP
304803
+.B ldap_proto_version
304803
+.br
304803
+autofs always attempts to use the highest available ldap
304803
+protocol version.
304803
+.TP
304803
+.BR cache_duration ", " map_reload_interval ", " map_options
304803
+.br
304803
+The map	entry cache is continually updated and stale entries
304803
+cleaned on re-load, which is done when map changes aredetected
304803
+so these configuration entries are not used by autofs.
304803
+.TP
304803
+.B localhost_address
304803
+This is not used within autofs. This configuration option was
304803
+only used in the amd user space server code and is not relevant
304803
+within autofs.
304803
+.P
304803
+Options that are handled differently within autofs:
304803
+.TP
304803
+.B pid_file
304803
+.br
304803
+To specify a pid file name a command line option must be used on startup.
304803
+.TP
304803
+.B print_version
304803
+.br
304803
+Program version and feature information is obtained by using the
304803
+automount command line option "-V".
304803
+.TP
304803
+.B debug_options ", " log_options
304803
+.br
304803
+autofs has somewhat more limited logging and debug logging options.
304803
+When the log_options options is encountered it is converted to the
304803
+nearest matching autofs logging option. Since the configuration
304803
+option debug_options would be handled the same way it is ignored.
304803
+.TP
304803
+.B restart_mounts
304803
+.br
304803
+This option has no sensible meaning within autofs because autofs
304803
+always tries to re-connect to existing mounts. While this has its
304803
+own set of problems not re-connecting to existing mounts always
304803
+results in a non-functional automount tree if mounts were busy at
304803
+the last shutdown (as is also the case with amd when using
304803
+mount_type autofs).
304803
+.TP
304803
+.B forced_unmounts
304803
+.br
304803
+Detaching mounts often causes serious problems for users of
304803
+existing mounts. It is used by autofs in some cases, either at
304803
+the explicit request of the user (with a command line or init
304803
+option) and in some special cases during program operation but
304803
+is avoided whenever possible.
304803
+.P
304803
+A number of configuration options are not yet implemented:
304803
+.TP
304803
+.B search_path
304803
+.br
304803
+Always a little frustrating, the compiled in map location should
304803
+be used to locate maps but isn't in some cases. This requires
304803
+work within autofs itself and that will (obviously) include
304803
+implementing this configuration option for the amd map parser
304803
+as well.
304803
+.TP
304803
+.B fully_qualified_hosts
304803
+Not yet implemented.
304803
+.TP
304803
+.B unmount_on_exit
304803
+.br
304803
+Since autofs always tries to re-connect to mounts left mounted
304803
+from a previous shutdown this is a sensible option to implement
304803
+and that will be done.
304803
+.TP
304803
+.B browsable_dirs
304803
+.br
304803
+Not yet implemented.
304803
+.TP
304803
+.B exec_map_timeout
304803
+.br
304803
+A timeout is not currently used for for program maps, might be
304803
+implemented.
304803
+.TP
304803
+.B tag
304803
+.br
304803
+The tag option is not implemented within autofs.
304803
+.P
304803
+Supported options:
304803
+.TP
304803
+.BR arch ", " karch ", " os ", " osver
304803
+.br
304803
+These options default to what is returned from uname(2) and can
304803
+be overridden if required.
304803
+.TP
304803
+.B full_os
304803
+This option has no default and must be set in the configuration
304803
+if used in maps.
304803
+.TP
304803
+.B cluster
304803
+.br
304803
+If not set defaults to the host domain name. This option corresponds
304803
+to the HP_UX cluster name (according to the amd source) and is
304803
+probably not used in Linux but is set anyway.
304803
+.TP
304803
+.B vendor
304803
+This option has a default value of "unknown", it must be set in the
304803
+configuration if used in maps.
304803
+.TP
304803
+.B auto_dir
304803
+.br
304803
+Is the base name of the mount tree used for external mounts that
304803
+are sometimes needed by amd maps. Its default value is "/a".
304803
+.TP
304803
+.B map_type
304803
+.br
304803
+Specifies the autofs map source, such as file, nis, ldap etc. and
304803
+has no default value set.
304803
+.TP
304803
+.B map_defaults
304803
+.br
304803
+This option is used to override /defaults entries within maps
304803
+and can be used to provide different defaults on specific machines
304803
+without having to modify centrally managed maps. It is empty by
304803
+default.
304803
+.TP
304803
+.B dismount_interval
304803
+.br
304803
+Is equivalent to the autofs timeout option. It is only possible
304803
+to use this with type "auto" mounts due to the way the autofs
304803
+kernel module performs expiry. It takes its default value from
304803
+the autofs internal defaulti of 600 seconds.
304803
+.TP
304803
+.B autofs_use_lofs
304803
+.br
304803
+If set to "yes" autofs will attempt to use bind mounts for type
304803
+"auto" when possible.
304803
+.TP
304803
+.B nis_domain
304803
+.br
304803
+Allows setting of a domain name other than the system default.
304803
+.TP
304803
+.B local_domain
304803
+.br
304803
+Is used to override (or set) the host domain name.
304803
+.TP
304803
+.B normalize_hostnames
304803
+.br
304803
+If set to "yes" then the contents of ${rhost} is translated in
304803
+its official host name.
304803
+.TP
304803
+.B domain_strip
304803
+.br
304803
+If set to "yes" the domain name part of the host is strippped
304803
+when normalizing hostnames. This can be useful when using of
304803
+the same maps in a multiple domain environment.
304803
+.TP
304803
+.B normalize_slashes
304803
+.br
304803
+This option is set to "yes" by default and will collapse
304803
+multiple unescaped occurrences of "/" to a single "/".
304803
+.TP
304803
+.BR selectors_in_defaults ", " selectors_on_default
304803
+.br
304803
+This option has a default value of "no". If set to "yes" then
304803
+any defaults entry will be checked for selectors to determine
304803
+the values to be used. selectors_in_defaults is the preferred
304803
+option to use.
304803
+.TP
304803
+.B ldap_base
304803
+.br
304803
+iThis option has no default value. It must be set to the base dn
304803
+that is used for queries if ldap is to be used as a map source.
304803
+.TP
304803
+.B ldap_hostports
304803
+.br
304803
+This option has no default value set. It must be set to the URI
304803
+of the LDAP server to be used for lookups wheni ldap is used a
304803
+map source. It may contain a comma or space seperated list of
304803
+LDAP URIs.
304803
+.TP
304803
+.B hesiod_base
304803
+.br
304803
+Sets the base name used for hesiod map sources.
304803
+.SH EXAMPLE
304803
+.sp
304803
+.RS +.2i
304803
+.ta 1.0i
304803
+.nf
304803
+[ autofs ]
304803
+timeout = 300
304803
+browse_mode = no
304803
+
304803
+[ amd ]
304803
+dismount_interval = 300
304803
+map_type = nis
304803
+autofs_use_lofs = no
304803
+
304803
+[ /expamle/mount ]
304803
+dismount_interval = 60
304803
+map_type = file
304803
+.fi
304803
+.RE
304803
+.SH "SEE ALSO"
304803
+.BR automount (8),
304803
+.BR auto.master (5),
304803
+.BR autofs_ldap_auth.conf (5)
304803
+.SH AUTHOR
304803
+This manual page was written by Ian Kent <raven@themaw.net>.
304803
diff --git a/man/autofs_ldap_auth.conf.5.in b/man/autofs_ldap_auth.conf.5.in
304803
index fa23ce5..fe5077d 100644
304803
--- a/man/autofs_ldap_auth.conf.5.in
304803
+++ b/man/autofs_ldap_auth.conf.5.in
304803
@@ -113,5 +113,6 @@ externally configured credential cache that is used during authentication.
304803
 By default, autofs will setup a memory based credential cache.
304803
 .SH "SEE ALSO"
304803
 .BR auto.master (5),
304803
+.BR autofs.conf (5),
304803
 .SH AUTHOR
304803
 This manual page was written by Ian Kent <raven@themaw.net>.
304803
diff --git a/man/automount.8 b/man/automount.8
304803
index 79e53f0..130b24c 100644
304803
--- a/man/automount.8
304803
+++ b/man/automount.8
304803
@@ -172,6 +172,7 @@ constructed has been detached from the mount tree.
304803
 .SH "SEE ALSO"
304803
 .BR autofs (5),
304803
 .BR autofs (8),
304803
+.BR autofs.conf (5),
304803
 .BR auto.master (5),
304803
 .BR mount (8).
304803
 .BR autofs_ldap_auth.conf (5)