From: Erez Zadok Date: Sat, 6 Aug 2005 18:58:45 +0000 (+0000) Subject: * doc/am-utils.texi (sun_map_syntax Parameter): document new X-Git-Tag: before-clocktime-fixes~57 X-Git-Url: https://git.fsl.cs.sunysb.edu/?a=commitdiff_plain;h=6126140a23938533e0d74810365749b63b074daf;p=am-utils-6.1.git * doc/am-utils.texi (sun_map_syntax Parameter): document new common parameter. * scripts/amd.conf.5: selectors_in_defaults is a common parameter, not just [global]. Use consistent capitalization of Amd/Amq. Document new sun_map_syntax parameter. * scripts/amd.conf-sample: properly list all of the parameters which are common to both the [global] and the per-map sections. (sun_map_syntax): example of new parameter. * doc/am-utils.texi (Common Parameters): selectors_in_defaults is a common parameter, not just [global]. * scripts/amd.conf-sample (sun_map_syntax): example of new flag. * amd/conf.c ({ropt,gopt}_sun_map_syntax): new function to parse sun_map_syntax flag (global or per map). * amd/amd.h (CFM_SUN_MAP_SYNTAX): new flag for users to say if the map uses Sun automounter syntax. --- diff --git a/ChangeLog b/ChangeLog index 93f5777..81035a3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,27 @@ 2005-08-06 Erez Zadok + * doc/am-utils.texi (sun_map_syntax Parameter): document new + common parameter. + + * scripts/amd.conf.5: selectors_in_defaults is a common parameter, + not just [global]. Use consistent capitalization of Amd/Amq. + Document new sun_map_syntax parameter. + + * scripts/amd.conf-sample: properly list all of the parameters + which are common to both the [global] and the per-map sections. + (sun_map_syntax): example of new parameter. + + * doc/am-utils.texi (Common Parameters): selectors_in_defaults is + a common parameter, not just [global]. + + * scripts/amd.conf-sample (sun_map_syntax): example of new flag. + + * amd/conf.c ({ropt,gopt}_sun_map_syntax): new function to parse + sun_map_syntax flag (global or per map). + + * amd/amd.h (CFM_SUN_MAP_SYNTAX): new flag for users to say if the + map uses Sun automounter syntax. + * cvs-server.txt: update instructions after branching 6.1-stable. 2005-08-02 Erez Zadok diff --git a/NEWS b/NEWS index 4ab75b0..98f8b7b 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,8 @@ +*** Notes specific to am-utils version 6.2a1 + +XXX: Dan, document sun_map_syntax flag in more detail in am-utils.texi and +(more briefly) in amd.conf.5. And in this NEWS file, also briefly. + *** Notes specific to am-utils version 6.1.1 New amd.conf global parameter: forced_unmounts (default to "no"). If set to diff --git a/amd/amd.h b/amd/amd.h index 723ad91..3c94988 100644 --- a/amd/amd.h +++ b/amd/amd.h @@ -76,6 +76,7 @@ #define CFM_NORMALIZE_SLASHES 0x00008000 /* normalize slashes? */ #define CFM_FORCED_UNMOUNTS 0x00010000 /* forced unmounts? */ #define CFM_TRUNCATE_LOG 0x00020000 /* truncate log file? */ +#define CFM_SUN_MAP_SYNTAX 0x00040000 /* Sun map syntax? */ /* defaults global flags: plock, tcpwrappers, and autofs/lofs */ #define CFM_DEFAULT_FLAGS (CFM_PROCESS_LOCK|CFM_USE_TCPWRAPPERS|CFM_AUTOFS_USE_LOFS|CFM_DOMAIN_STRIP|CFM_NORMALIZE_SLASHES) diff --git a/amd/conf.c b/amd/conf.c index 3124332..514375e 100644 --- a/amd/conf.c +++ b/amd/conf.c @@ -129,6 +129,7 @@ static int gopt_restart_mounts(const char *val); static int gopt_search_path(const char *val); static int gopt_selectors_in_defaults(const char *val); static int gopt_show_statfs_entries(const char *val); +static int gopt_sun_map_syntax(const char *val); static int gopt_truncate_log(const char *val); static int gopt_unmount_on_exit(const char *val); static int gopt_use_tcpwrappers(const char *val); @@ -143,6 +144,7 @@ static int ropt_map_options(const char *val, cf_map_t *cfm); static int ropt_map_type(const char *val, cf_map_t *cfm); static int ropt_mount_type(const char *val, cf_map_t *cfm); static int ropt_search_path(const char *val, cf_map_t *cfm); +static int ropt_sun_map_syntax(const char *val, cf_map_t *cfm); static int ropt_tag(const char *val, cf_map_t *cfm); static void init_cf_map(cf_map_t *cfm); @@ -209,6 +211,7 @@ static struct _func_map glob_functable[] = { {"selectors_on_default", gopt_selectors_in_defaults}, {"selectors_in_defaults", gopt_selectors_in_defaults}, {"show_statfs_entries", gopt_show_statfs_entries}, + {"sun_map_syntax", gopt_sun_map_syntax}, {"truncate_log", gopt_truncate_log}, {"unmount_on_exit", gopt_unmount_on_exit}, {"use_tcpwrappers", gopt_use_tcpwrappers}, @@ -249,12 +252,14 @@ init_cf_map(cf_map_t *cfm) cfm->cfm_search_path = gopt.search_path; /* - * Initialize flags that are common both to [global] and a local map. + * Initialize flags that are common both to [global] and a local map + * (that is, they could be inherited from the global section). */ cfm->cfm_flags = gopt.flags & (CFM_BROWSABLE_DIRS | CFM_BROWSABLE_DIRS_FULL | CFM_MOUNT_TYPE_AUTOFS | - CFM_SELECTORS_IN_DEFAULTS); + CFM_SELECTORS_IN_DEFAULTS | + CFM_SUN_MAP_SYNTAX ); } @@ -1083,6 +1088,22 @@ gopt_show_statfs_entries(const char *val) } +static int +gopt_sun_map_syntax(const char *val) +{ + if (STREQ(val, "yes")) { + gopt.flags |= CFM_SUN_MAP_SYNTAX; + return 0; + } else if (STREQ(val, "no")) { + gopt.flags &= ~CFM_SUN_MAP_SYNTAX; + return 0; + } + + fprintf(stderr, "conf: unknown value to sun_map_syntax \"%s\"\n", val); + return 1; /* unknown value */ +} + + static int gopt_truncate_log(const char *val) { @@ -1185,6 +1206,9 @@ process_regular_option(const char *section, const char *key, const char *val, cf if (STREQ(key, "search_path")) return ropt_search_path(val, cfm); + if (STREQ(key, "sun_map_syntax")) + return ropt_sun_map_syntax(val, cfm); + if (STREQ(key, "tag")) return ropt_tag(val, cfm); @@ -1280,6 +1304,23 @@ ropt_search_path(const char *val, cf_map_t *cfm) } +static int +ropt_sun_map_syntax(const char *val, cf_map_t *cfm) +{ + if (STREQ(val, "yes")) { + cfm->cfm_flags |= CFM_SUN_MAP_SYNTAX; + return 0; + + } else if (STREQ(val, "no")) { + cfm->cfm_flags &= ~CFM_SUN_MAP_SYNTAX; + return 0; + } + + fprintf(stderr, "conf: unknown value to sun_map_syntax \"%s\"\n", val); + return 1; /* unknown value */ +} + + static int ropt_tag(const char *val, cf_map_t *cfm) { diff --git a/doc/am-utils.texi b/doc/am-utils.texi index 28c5004..07978ae 100644 --- a/doc/am-utils.texi +++ b/doc/am-utils.texi @@ -36,9 +36,8 @@ @c LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY @c OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF @c -@c %W% (Berkeley) %G% @c -@c $Id: am-utils.texi,v 1.106 2005/07/26 01:48:13 ezk Exp $ +@c File: am-utils/doc/am-utils.texi @c @setfilename am-utils.info @@ -4136,6 +4135,8 @@ sections that follow. * map_type Parameter:: * mount_type Parameter:: * search_path Parameter:: +* selectors_in_defaults Parameter:: +* sun_map_syntax Parameter:: @end menu @c ---------------------------------------------------------------- @@ -4248,7 +4249,7 @@ host it is running on. If @samp{autofs} is specified, @i{Amd} will be an autofs server for those mount points. @c ---------------------------------------------------------------- -@node search_path Parameter, , mount_type Parameter, Common Parameters +@node search_path Parameter, selectors_in_defaults Parameter, mount_type Parameter, Common Parameters @comment node-name, next, previous, up @subsection @t{search_path} Parameter @cindex search_path Parameter @@ -4258,6 +4259,37 @@ an autofs server for those mount points. sites can allow for local map customizations and overrides, and can distributed maps in several locations as needed. +@c ---------------------------------------------------------------- +@node selectors_in_defaults Parameter, sun_map_syntax Parameter, search_path Parameter, Common Parameters +@comment node-name, next, previous, up +@subsection @t{selectors_in_defaults} Parameter +@cindex selectors_in_defaults Parameter + +(type=boolean, default=@samp{no}). If @samp{yes}, then the +@samp{/defaults} entry of maps will search for and process any +selectors before setting defaults for all other keys in that map. +Useful when you want to set different options for a complete map based +on some parameters. For example, you may want to better the NFS +performance over slow slip-based networks as follows: + +@example +/defaults \ + wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \ + wire!=slip-net;opts:=intr,rsize=8192,wsize=8192 +@end example + +Deprecated form: selectors_on_default. + +@c ---------------------------------------------------------------- +@node sun_map_syntax Parameter, , selectors_in_defaults Parameter, Common Parameters +@comment node-name, next, previous, up +@subsection @t{sun_map_syntax} Parameter +@cindex sun_map_syntax Parameter + +(type=boolean, default=@samp{no}). If @samp{yes}, then @i{Amd} will +parse the map according to the Sun Automount syntax. + + @c ================================================================ @node Global Parameters, Regular Map Parameters, Common Parameters, Amd Configuration File @comment node-name, next, previous, up @@ -4313,7 +4345,6 @@ The following parameters are applicable to the @samp{[global]} section only. * print_pid Parameter:: * print_version Parameter:: * restart_mounts Parameter:: -* selectors_in_defaults Parameter:: * show_statfs_entries Parameter:: * truncate_log Parameter:: * unmount_on_exit Parameter:: @@ -4931,7 +4962,7 @@ will print its version information string, which includes some configuration and compilation values. @c ---------------------------------------------------------------- -@node restart_mounts Parameter, selectors_in_defaults Parameter, print_version Parameter, Global Parameters +@node restart_mounts Parameter, show_statfs_entries Parameter, print_version Parameter, Global Parameters @comment node-name, next, previous, up @subsection @t{restart_mounts} Parameter @cindex restart_mounts Parameter @@ -4942,28 +4973,7 @@ systems are currently mounted. Whenever one of these would have been auto-mounted, @i{Amd} inherits it. @c ---------------------------------------------------------------- -@node selectors_in_defaults Parameter, show_statfs_entries Parameter, restart_mounts Parameter, Global Parameters -@comment node-name, next, previous, up -@subsection @t{selectors_in_defaults} Parameter -@cindex selectors_in_defaults Parameter - -(type=boolean, default=@samp{no}). If @samp{yes}, then the @samp{/defaults} entry of -maps will search for and process any selectors before setting defaults -for all other keys in that map. Useful when you want to set different -options for a complete map based on some parameters. For example, you -may want to better the NFS performance over slow slip-based networks as -follows: - -@example -/defaults \ - wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \ - wire!=slip-net;opts:=intr,rsize=8192,wsize=8192 -@end example - -Deprecated form: selectors_on_default. - -@c ---------------------------------------------------------------- -@node show_statfs_entries Parameter, truncate_log Parameter, selectors_in_defaults Parameter, Global Parameters +@node show_statfs_entries Parameter, truncate_log Parameter, restart_mounts Parameter, Global Parameters @comment node-name, next, previous, up @subsection @t{show_statfs_entries} Parameter @cindex show_statfs_entries Parameter diff --git a/scripts/amd.conf-sample b/scripts/amd.conf-sample index bee8b35..799f41c 100644 --- a/scripts/amd.conf-sample +++ b/scripts/amd.conf-sample @@ -64,8 +64,6 @@ debug_options = all,amq,daemon,fork,full,hrtime,info,mem,mtab,\ debug_mtab_file = /tmp/mnttab # (amd -S) plock = yes | no -# selectors are not recognized by default in the /defaults entry -selectors_in_defaults = no | yes # should browsable maps show number of entries to df/statfs (default=no) show_statfs_entries = no | yes # (hpux) cluster name (amd -C) @@ -80,15 +78,6 @@ ldap_proto_version = 2 hesiod_base = automount # interval to check if a reload of any maps is needed map_reload_interval = 3600 -# these 5 options can be overridden by each map individually -browsable_dirs = no | yes | full -map_options = cache:=all -map_type = file|hesiod|ndbm|nis|nisplus|passwd|union|ldap -# any string that will be used to override to the map /defaults entry -map_defaults = opts:=nosuid,rw,intr,bg,noquota;type:=link -mount_type = nfs | autofs -autofs_use_lofs = yes | no -search_path = /etc/local:/etc/amdmaps:/misc/yp # alternate RPC program number to register with the port mapper portmap_program = 300019-300029 # Ask for a different Amq RPC port (both UDP and TCP). @@ -110,6 +99,22 @@ exec_map_timeout = 10 # normalize multiple/trailing slashes or not? normalize_slashes = yes | no +############################################################################## +# these 9 global options can be overridden by each map individually +browsable_dirs = no | yes | full +map_options = cache:=all +map_type = file|hesiod|ndbm|nis|nisplus|passwd|union|ldap +# any string that will be used to override to the map /defaults entry +map_defaults = opts:=nosuid,rw,intr,bg,noquota;type:=link +mount_type = nfs | autofs +autofs_use_lofs = yes | no +search_path = /etc/local:/etc/amdmaps:/misc/yp +# selectors are not recognized by default in the /defaults entry +selectors_in_defaults = no | yes +# does this map use Sun Automounter map syntax? +sun_map_syntax = no | yes +############################################################################## + ############################################################################## # DEFINE AN AMD MOUNT POINT [ /home ] @@ -144,3 +149,10 @@ map_name = /etc/lookup-entry.sh map_type = exec ############################################################################## +# DEFINE A SUN SYNTAX MOUNT POINT +[ /proj ] +map_name = /etc/amd.proj +# does this map use Sun Automounter map syntax? +sun_map_syntax = yes + +############################################################################## diff --git a/scripts/amd.conf.5 b/scripts/amd.conf.5 index f613d14..d904121 100644 --- a/scripts/amd.conf.5 +++ b/scripts/amd.conf.5 @@ -38,21 +38,21 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: amd.conf.5,v 1.39 2005/07/26 01:48:13 ezk Exp $ +.\" $Id: amd.conf.5,v 1.40 2005/08/06 18:58:45 ezk Exp $ .\" .TH AMD.CONF 5 "7 August 1997" .SH NAME -amd.conf \- amd configuration file +amd.conf \- Amd configuration file .SH SYNOPSIS .B amd.conf .SH DESCRIPTION The .B amd.conf -file is the configuration file for amd, as part of the am-utils suite. +file is the configuration file for Amd, as part of the am-utils suite. .P .B amd.conf contains runtime configuration information for the -.B amd +.B Amd automounter program. .\" ************************************************************************** .SH FILE FORMAT @@ -85,7 +85,7 @@ cache timeouts are numeric. .\" ************************************************************************** .SH SECTIONS .SS The [global] section -Parameters in this section either apply to amd as a whole, or to all other +Parameters in this section either apply to Amd as a whole, or to all other regular map sections which follow. There should be only one global section defined in one configuration file. .P @@ -99,7 +99,7 @@ For example, if the map section .B [/homes] is defined, then all parameters following it will be applied to the .I /homes -amd-managed mount point. +Amd-managed mount point. .\" ************************************************************************** .SH PARAMETERS .SS Parameters common to all sections @@ -111,7 +111,7 @@ sections that follow. .\" ************************************************************************** .TP .BR browsable_dirs " (string, default=no)" -If "yes," then amd's top-level mount points will be browsable to +If "yes," then Amd's top-level mount points will be browsable to .BR readdir (3) calls. This means you could run for example .BR ls (1) @@ -121,10 +121,10 @@ entries, and those with a "/" in them are not included. If you specify "full" to this option, all but "/default" will be visible. Note that if you run a command which will attempt to .BR stat (2) -the entries, such as often done by "ls -l" or "ls -F," amd will attempt to +the entries, such as often done by "ls -l" or "ls -F," Amd will attempt to mount .I every -entry in that map. This is often called a ``mount storm''. +entry in that map. This is often called a ``mount storm.'' .TP .BR map_defaults " (string, default to empty)" @@ -135,12 +135,12 @@ override map defaults without modifying maps globally. .TP .BR map_options " (string, default no options)" This option is the same as specifying map options on the command line to -amd, such as "cache:=all". +Amd, such as "cache:=all". .TP .BR map_type " (string, default search all map types)" -If specified, amd will initialize the map only for the type given. This is -useful to avoid the default map search type used by amd which takes longer +If specified, Amd will initialize the map only for the type given. This is +useful to avoid the default map search type used by Amd which takes longer and can have undesired side-effects such as initializing NIS even if not used. Possible values are @@ -158,9 +158,9 @@ used. Possible values are .TP .BR mount_type " (string, default=nfs)" -All amd mount types default to NFS. That is, amd is an NFS server on the +All Amd mount types default to NFS. That is, Amd is an NFS server on the map mount points, for the local host it is running on. If "autofs" is -specified, amd will be an autofs server for those mount points. +specified, Amd will be an autofs server for those mount points. .TP .BR autofs_use_lofs " (string, default=yes)" @@ -176,6 +176,26 @@ This provides a (colon-delimited) search path for file maps. Using a search path, sites can allow for local map customizations and overrides, and can distributed maps in several locations as needed. +.TP +.BR selectors_in_defaults " (boolean, default=no)" +If "yes," then the /defaults entry of maps will search for and process any +selectors before setting defaults for all other keys in that map. Useful +when you want to set different options for a complete map based on some +parameters. For example, you may want to better the NFS performance over +slow slip-based networks as follows: + +.nf +/defaults \\ + wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\ + wire!=slip-net;opts:=intr,rsize=8192,wsize=8192 +.fi + +Deprecated form: selectors_on_default + +.TP +.BR sun_map_syntax " (boolean, default=no)" +If "yes," then Amd will parse the map according to the Sun Automount syntax. + .\" ************************************************************************** .SS Parameters applicable to the global section only @@ -183,15 +203,15 @@ distributed maps in several locations as needed. .BR arch " (string, default to compiled in value)" Same as the .B \-A -option to amd. Allows you to override the value of the +option to Amd. Allows you to override the value of the .I arch -amd variable. +Amd variable. .TP .BR auto_attrcache " (numeric, default=0)" -Specify in seconds, the (kernel-side) NFS attribute cache timeout for amd's +Specify in seconds, the (kernel-side) NFS attribute cache timeout for Amd's own automount points. A value of 0 turns off attribute caching, meaning -that amd will be consulted via a kernel-RPC each time someone stat's the +that Amd will be consulted via a kernel-RPC each time someone stat's the mount point (which could be abused as a denial-of-service attack). Warning: if you set this option to any non-zero value, especially a large value, and you get ESTALE errors on your particular OS , then set this value back to 0 @@ -201,21 +221,21 @@ seconds. .BR auto_dir " (string, default=/a)" Same as the .B \-a -option to amd. This sets the private directory where amd will create +option to Amd. This sets the private directory where Amd will create sub-directories for its real mount points. .TP .BR cache_duration " (numeric, default=300)" Same as the .B \-c -option to amd. Sets the duration in seconds that looked-up or mounted map +option to Amd. Sets the duration in seconds that looked-up or mounted map entries remain in the cache. .TP .BR cluster " (string, default no cluster)" Same as the .B \-C -option to amd. Specifies the alternate HP-UX cluster to use. +option to Amd. Specifies the alternate HP-UX cluster to use. .TP .BR debug_mtab_file " (string, default=/tmp/mnttab)" @@ -228,12 +248,12 @@ to systems that store mtab information on disk. .BR debug_options " (string, default no debug options)" Same as the .B \-D -option to amd. Specify any debugging options for amd. Works only if +option to Amd. Specify any debugging options for Amd. Works only if am-utils was configured for debugging using the --enable-debug option. The "mem" option, as well as all other options, can be turned on via --enable-debug=mem. Otherwise debugging options are ignored. Options are comma delimited, and can be preceded by the string "no" to negate their -meaning. You can get the list of supported debugging options by running amd +meaning. You can get the list of supported debugging options by running Amd \-H. Possible values are: .nf @@ -257,7 +277,7 @@ meaning. You can get the list of supported debugging options by running amd .BR dismount_interval " (numeric, default=120)" Same as the .B \-w -option to amd. Specify in seconds, the time between attempts to dismount +option to Amd. Specify in seconds, the time between attempts to dismount file systems that have exceeded their cached times. .TP @@ -321,13 +341,13 @@ Specify the base name for hesiod maps. .BR karch " (string, default to karch of the system)" Same as the .B \-k -option to amd. Allows you to override the kernel-architecture of your +option to Amd. Allows you to override the kernel-architecture of your system. Useful for example on Sun (Sparc) machines, where you can build one -amd binary, and run it on multiple machines, yet you want each one to get +Amd binary, and run it on multiple machines, yet you want each one to get the correct .I karch variable set (for example, sun4c, sun4m, sun4u, etc.) Note that if not -specified, amd will use uname(3) to figure out the kernel architecture of +specified, Amd will use uname(3) to figure out the kernel architecture of the machine. .TP @@ -337,7 +357,7 @@ values such as country and organization. .TP .BR ldap_cache_maxmem " (numeric, default=131072)" -Specify the maximum memory amd should use to cache LDAP entries. +Specify the maximum memory Amd should use to cache LDAP entries. .TP .BR ldap_cache_seconds " (numeric, default=0)" @@ -355,29 +375,29 @@ Specify the version of the LDAP protocol to use. .BR local_domain " (string, default no sub-domain)" Same as the .B \-d -option to amd. Specify the local domain name. If this option is not given +option to Amd. Specify the local domain name. If this option is not given the domain name is determined from the hostname, by removing the first component of the fully-qualified host name. .TP .BR localhost_address " (string, default to localhost or 127.0.0.1)" -Specify the name or IP address for amd to use when connecting the sockets +Specify the name or IP address for Amd to use when connecting the sockets for the local NFS server and the RPC server. This defaults to 127.0.0.1 or whatever the host reports as its local address. This parameter is useful on -hosts with multiple addresses where you want to force amd to connect to a +hosts with multiple addresses where you want to force Amd to connect to a specific address. .TP .BR log_file " (string, default=/dev/stderr)" Same as the .B \-l -option to amd. Specify a file name to log amd events to. +option to Amd. Specify a file name to log Amd events to. If the string .B /dev/stderr -is specified, amd will send its events to the standard error file descriptor. +is specified, Amd will send its events to the standard error file descriptor. If the string .B syslog -is given, amd will record its events with the system logger +is given, Amd will record its events with the system logger .BR syslogd (8). The default syslog facility used is LOG_DAEMON. If you wish to change it, append its name to the log file name, delimited by a @@ -385,7 +405,7 @@ single colon. For example, if .I logfile is the string .B syslog:local7 -then amd will log messages via +then Amd will log messages via .IR syslog (3) using the LOG_LOCAL7 facility (if it exists on the system). @@ -393,11 +413,14 @@ using the LOG_LOCAL7 facility (if it exists on the system). .BR log_options " (string, default no logging options)" Same as the .B \-x -option to amd. Specify any logging options for amd. Options are comma +option to Amd. Specify any logging options for Amd. Options are comma delimited, and can be preceded by the string "no" to negate their meaning. The "debug" logging option is only available if am-utils was configured with --enable-debug. You can get the list of supported debugging and logging -options by running amd \-H. Possible values are: +options by running +.B amd +.BR \-H . +Possible values are: .nf \fBall\fR all messages @@ -414,29 +437,29 @@ options by running amd \-H. Possible values are: .TP .BR map_reload_interval " (numeric, default=3600)" -The number of seconds that amd will wait before it checks to see if any maps +The number of seconds that Amd will wait before it checks to see if any maps have changed at their source (NIS servers, LDAP servers, files, etc.). Amd will reload only those maps that have changed. .TP .BR nfs_allow_insecure_port " (string, default=no)" -Normally amd will refuse requests coming from unprivileged ports (i.e. +Normally Amd will refuse requests coming from unprivileged ports (i.e. ports >= 1024 on Unix systems), so that only privileged users and the kernel can send NFS requests to it. However, some kernels (certain versions of Darwin, MacOS X, and Linux) have bugs that cause them to use unprivileged -ports in certain situations, which causes amd to stop dead in its -tracks. This parameter allows amd to operate normally even on such systems, +ports in certain situations, which causes Amd to stop dead in its +tracks. This parameter allows Amd to operate normally even on such systems, at the expense of a slight decrease in the security of its operations. If you see messages like "ignoring request from foo:1234, port not reserved" -in your amd log, try enabling this parameter and give it another go. +in your Amd log, try enabling this parameter and give it another go. .TP .BR nfs_proto " (string, default to trying version tcp then udp)" -By default, amd tries TCP and then UDP. This option forces the overall NFS -protocol used to TCP or UDP. It overrides what is in the amd maps, and is -useful when amd is compiled with NFSv3 support that may not be stable. With +By default, Amd tries TCP and then UDP. This option forces the overall NFS +protocol used to TCP or UDP. It overrides what is in the Amd maps, and is +useful when Amd is compiled with NFSv3 support that may not be stable. With this option you can turn off the complete usage of NFSv3 dynamically -(without having to recompile amd) until such time as NFSv3 support is +(without having to recompile Amd) until such time as NFSv3 support is desired again. .TP @@ -445,9 +468,9 @@ Same as the .I retransmit part of the .BI \-t " timeout.retransmit" -option to amd. +option to Amd. Specifies the number of NFS retransmissions that the kernel will use to -communicate with amd. +communicate with Amd. .TP .BR nfs_retransmit_counter_udp " (numeric, default=11)" @@ -467,11 +490,11 @@ Same as the .I timeout part of the .BI \-t " timeout.retransmit" -option to amd. Specifies the NFS timeout interval, in +option to Amd. Specifies the NFS timeout interval, in .I tenths of seconds, between NFS/RPC retries (for UDP and TCP). This is the value that the kernel will use to -communicate with amd. +communicate with Amd. Amd relies on the kernel RPC retransmit mechanism to trigger mount retries. The values of the @@ -495,18 +518,18 @@ option, but for all TCP mounts only. .TP .BR nfs_vers " (numeric, default to trying version 3 then 2)" -By default, amd tries version 3 and then version 2. This option forces the +By default, Amd tries version 3 and then version 2. This option forces the overall NFS protocol used to version 3 or 2. It overrides what is in the -amd maps, and is useful when amd is compiled with NFSv3 support that may not +Amd maps, and is useful when Amd is compiled with NFSv3 support that may not be stable. With this option you can turn off the complete usage of NFSv3 -dynamically (without having to recompile amd) until such time as NFSv3 +dynamically (without having to recompile Amd) until such time as NFSv3 support is desired again. .TP .BR nis_domain " (string, default to local NIS domain name)" Same as the .B \-y -option to amd. Specify an alternative NIS domain from which to fetch the +option to Amd. Specify an alternative NIS domain from which to fetch the NIS maps. The default is the system domain name. This option is ignored if NIS support is not available. @@ -514,15 +537,15 @@ NIS support is not available. .BR normalize_hostnames " (boolean, default=no)" Same as the .B \-n -option to amd. If "yes," then the name refereed to by ${rhost} is +option to Amd. If "yes," then the name refereed to by ${rhost} is normalized relative to the host database before being used. The effect is to translate aliases into ``official'' names. .TP .BR normalize_slashes " (boolean, default=yes)" -If "yes," then amd will condense all multiple ``/'' (slash) characters into -one and remove all trailing slashes. If "no," then amd will not touch +If "yes," then Amd will condense all multiple ``/'' (slash) characters into +one and remove all trailing slashes. If "no," then Amd will not touch strings that may contain repeated or trailing slashes. The latter is sometimes useful with SMB mounts, which often require multiple slash characters in pathnames. @@ -531,7 +554,7 @@ characters in pathnames. .BR os " (string, default to compiled in value)" Same as the .B \-O -option to amd. Allows you to override the compiled-in name of the operating +option to Amd. Allows you to override the compiled-in name of the operating system. Useful when the built-in name is not desired for backward compatibility reasons. For example, if the build in name is ``sunos5'', you can override it to ``sos5'', and use older maps which were written with the @@ -541,7 +564,7 @@ latter in mind. .BR osver " (string, default to compiled in value)" Same as the .B \-o -option to amd. Overrides the compiled-in version number of the operating +option to Amd. Overrides the compiled-in version number of the operating system. Useful when the built in version is not desired for backward compatibility reasons. For example, if the build in version is ``2.5.1'', you can override it to ``5.5.1'', and use older maps that were written with @@ -550,8 +573,8 @@ the latter in mind. .TP .BR pid_file " (string, default=/dev/stdout)" Specify a file to store the process ID of the running daemon into. If not -specified, amd will print its process id onto the standard output. Useful -for killing amd after it had run. Note that the PID of a running amd can +specified, Amd will print its process id onto the standard output. Useful +for killing Amd after it had run. Note that the PID of a running Amd can also be retrieved via .B amq .BR \-p . @@ -561,86 +584,70 @@ This file is used only if the print_pid option is on. .BR plock " (boolean, default=yes)" Same as the .B \-S -option to amd. -If "yes," lock the running executable pages of amd into memory. To improve -amd's performance, systems that support the +option to Amd. +If "yes," lock the running executable pages of Amd into memory. To improve +Amd's performance, systems that support the .BR plock (3) or .BR mlockall (2) -call can lock the amd process into memory. This way there is less chance it -the operating system will schedule, page out, and swap the amd process as -needed. This improves amd's performance, at the cost of reserving the -memory used by the amd process (making it unavailable for other processes). +call can lock the Amd process into memory. This way there is less chance it +the operating system will schedule, page out, and swap the Amd process as +needed. This improves Amd's performance, at the cost of reserving the +memory used by the Amd process (making it unavailable for other processes). .TP .BR portmap_program " (numeric, default=300019)" Specify an alternate Port-mapper RPC program number, other than the official -number. This is useful when running multiple amd processes. For example, -you can run another amd in "test" mode, without affecting the primary amd +number. This is useful when running multiple Amd processes. For example, +you can run another Amd in "test" mode, without affecting the primary Amd process in any way. For safety reasons, the alternate program numbers that can be specified must be in the range 300019-300029, inclusive. -.B amq +Amq has an option .B -P -which can be used to specify an alternate program number of an amd to -contact. In this way, amq can fully control any number of amd processes +which can be used to specify an alternate program number of an Amd to +contact. In this way, amq can fully control any number of Amd processes running on the same host. .TP .BR preferred_amq_port " (numeric, default=0)" Specify an alternate Port-mapper RPC port number for Amd's -.B amq +Amq service. This is used for both UDP and TCP. Setting this value to 0 (or not defining it) will cause -.B amd +Amd to select an arbitrary port number. Setting the -.B amq +Amq RPC service port to a specific number is useful in firewalled or NAT'ed environments, where you need to know which port -.B amd +Amd will listen on. .TP .BR print_pid " (boolean, default=no)" Same as the .B \-p -option to amd. If "yes," amd will print its process ID upon starting. +option to Amd. If "yes," Amd will print its process ID upon starting. .TP .BR print_version " (boolean, default=no)" Same as the .B \-v -option to amd, but the version prints and amd continues to run. If "yes," -amd will print its version information string, which includes some +option to Amd, but the version prints and Amd continues to run. If "yes," +Amd will print its version information string, which includes some configuration and compilation values. .TP .BR restart_mounts " (boolean, default=no)" Same as the .B \-r -option to amd. If "yes" -.B amd +option to Amd. If "yes" +Amd will scan the mount table to determine which file systems are currently mounted. Whenever one of these would have been auto-mounted, -.B amd +Amd inherits it. -.TP -.BR selectors_in_defaults " (boolean, default=no)" -If "yes," then the /defaults entry of maps will search for and process any -selectors before setting defaults for all other keys in that map. Useful -when you want to set different options for a complete map based on some -parameters. For example, you may want to better the NFS performance over -slow slip-based networks as follows: - -.nf -/defaults \\ - wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\ - wire!=slip-net;opts:=intr,rsize=8192,wsize=8192 -.fi - -Deprecated form: selectors_on_default - .TP .BR show_statfs_entries " (boolean), default=no)" If "yes," then all maps which are browsable will also show the number of @@ -654,18 +661,18 @@ upon startup. .TP .BR unmount_on_exit " (boolean), default=no)" -If "yes," then amd will attempt to unmount all file systems which it knows -about. Normally amd leaves all (esp. NFS) mounted file systems intact. -Note that amd does not know about file systems mounted before it starts up, +If "yes," then Amd will attempt to unmount all file systems which it knows +about. Normally Amd leaves all (esp. NFS) mounted file systems intact. +Note that Amd does not know about file systems mounted before it starts up, unless the restart_mounts option or .B \-r flag are used. .TP .BR use_tcpwrappers " (boolean), default=yes)" -If "yes," then amd will use the tcpd/librwap tcpwrappers library +If "yes," then Amd will use the tcpd/librwap tcpwrappers library (if available) to control -access to amd via the /etc/hosts.allow and /etc/hosts.deny files. +access to Amd via the /etc/hosts.allow and /etc/hosts.deny files. .TP .BR vendor " (string, default to compiled in value)" @@ -684,15 +691,15 @@ Name of the map where the keys are located. .TP .BR tag " (string, default no tag)" Each map entry in the configuration file can be tagged. If no tag is -specified, that map section will always be processed by amd. If it is -specified, then amd will process the map if the +specified, that map section will always be processed by Amd. If it is +specified, then Amd will process the map if the .B -T -option was given to amd, and the value given to that command-line option +option was given to Amd, and the value given to that command-line option matches that in the map section. .\" ************************************************************************** .SH EXAMPLES -Here is a real amd configuration file I use daily. +Here is a real Amd configuration file I use daily. .P .nf # GLOBAL OPTIONS SECTION @@ -739,6 +746,7 @@ map_name = amd.tftpboot .BR amd (8), .BR amq (8), .BR ctl-amd (8), +.BR automount (8), .BR hosts_access (5). .LP ``am-utils''