No empty .Rs/.Re
[netbsd-mini2440.git] / external / bsd / am-utils / dist / scripts / amd.conf.5
blob60fea7dd22178a2a2b95e7f5debed163bc6966ba
1 .\"     $NetBSD$
2 .\"
3 .\"
4 .\" Copyright (c) 1997-2009 Erez Zadok
5 .\" Copyright (c) 1990 Jan-Simon Pendry
6 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
7 .\" Copyright (c) 1990 The Regents of the University of California.
8 .\" All rights reserved.
9 .\"
10 .\" This code is derived from software contributed to Berkeley by
11 .\" Jan-Simon Pendry at Imperial College, London.
12 .\"
13 .\" Redistribution and use in source and binary forms, with or without
14 .\" modification, are permitted provided that the following conditions
15 .\" are met:
16 .\" 1. Redistributions of source code must retain the above copyright
17 .\"    notice, this list of conditions and the following disclaimer.
18 .\" 2. Redistributions in binary form must reproduce the above copyright
19 .\"    notice, this list of conditions and the following disclaimer in the
20 .\"    documentation and/or other materials provided with the distribution.
21 .\" 3. All advertising materials mentioning features or use of this software
22 .\"    must display the following acknowledgment:
23 .\"      This product includes software developed by the University of
24 .\"      California, Berkeley and its contributors.
25 .\" 4. Neither the name of the University nor the names of its contributors
26 .\"    may be used to endorse or promote products derived from this software
27 .\"    without specific prior written permission.
28 .\"
29 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 .\" SUCH DAMAGE.
40 .\"
41 .\"
42 .\" File: am-utils/scripts/amd.conf.5
43 .\"
44 .TH AMD.CONF 5 "7 August 1997"
45 .SH NAME
46 amd.conf \- Amd configuration file
47 .SH SYNOPSIS
48 .B amd.conf
49 .SH DESCRIPTION
50 The
51 .B amd.conf
52 file is the configuration file for Amd, as part of the am-utils suite.
54 .B amd.conf
55 contains runtime configuration information for the
56 .B Amd
57 automounter program.
58 .\" **************************************************************************
59 .SH FILE FORMAT
61 The file consists of sections and parameters.  A section begins with the
62 name of the section in square brackets and continues until the next section
63 begins or the end the file is reached.  Sections contain parameters of the
64 form 'name = value'.
66 The file is line-based - that is, each newline-terminated line represents
67 either a comment, a section name or a parameter.  No line-continuation
68 syntax is available.
70 Section, parameter names and their values are case sensitive.
72 Only the first equals sign in a parameter is significant.  Whitespace before
73 or after the first equals sign is discarded.  Leading, trailing and
74 internal whitespace in section and parameter names is irrelevant.  Leading
75 and trailing whitespace in a parameter value is discarded.  Internal
76 whitespace within a parameter value is not allowed, unless the whole
77 parameter value is quoted with double quotes as in 'name = "some value"'.
79 Any line beginning with a pound sign (#) is ignored, as are lines containing
80 only whitespace.
82 The values following the equals sign in parameters are all either a string
83 (no quotes needed if string does not include spaces) or a boolean, which may
84 be given as yes/no.  Case is significant in all values.  Some items such as
85 cache timeouts are numeric.
86 .\" **************************************************************************
87 .SH SECTIONS
88 .SS The [global] section
89 Parameters in this section either apply to Amd as a whole, or to all other
90 regular map sections which follow.  There should be only one global section
91 defined in one configuration file.
93 It is highly recommended that this section be specified first in the
94 configuration file.  If it is not, then regular map sections which precede
95 it will not use global values defined later.
97 .SS Regular [/map] sections
98 Parameters in regular (non-global) sections apply to a single map entry.
99 For example, if the map section
100 .B [/homes]
101 is defined, then all parameters following it will be applied to the
102 .I /homes
103 Amd-managed mount point.
104 .\" **************************************************************************
105 .SH PARAMETERS
106 .SS Parameters common to all sections
107 These parameters can be specified either in the global or a map specific
108 section.  Entries specified in a map-specific section override the default
109 value or one defined in the global section.   If such a common parameter is
110 specified only in the global section, it is applicable to all regular map
111 sections that follow.
112 .\" **************************************************************************
114 .BR browsable_dirs " (string, default=no)"
115 If "yes," then Amd's top-level mount points will be browsable to
116 .BR readdir (3)
117 calls.  This means you could run for example
118 .BR ls (1)
119 and see what keys are available to mount in that directory.  Not all entries
120 are made visible to readdir(3): the "/default" entry, wildcard
121 entries, and those with a "/" in them are not included.  If you specify
122 "full" to this option, all but "/default" will be visible.
123 Note that if you run a command which will attempt to
124 .BR stat (2)
125 the entries, such as often done by "ls -l" or "ls -F," Amd will attempt to
126 mount
127 .I every
128 entry in that map.  This is often called a ``mount storm.''
131 .BR map_defaults " (string, default to empty)"
132 This option sets a string to be used as the map's /defaults entry,
133 overriding any /defaults specified in the map.  This allows local users to
134 override map defaults without modifying maps globally.
137 .BR map_options " (string, default no options)"
138 This option is the same as specifying map options on the command line to
139 Amd, such as "cache:=all".
142 .BR map_type " (string, default search all map types)"
143 If specified, Amd will initialize the map only for the type given.  This is
144 useful to avoid the default map search type used by Amd which takes longer
145 and can have undesired side-effects such as initializing NIS even if not
146 used.  Possible values are
149 \fBexec\fR      executable maps
150 \fBfile\fR      plain files
151 \fBhesiod\fR    Hesiod name service from MIT
152 \fBldap\fR      Lightweight Directory Access Protocol
153 \fBndbm\fR      (New) dbm style hash files
154 \fBnis\fR       Network Information Services (version 2)
155 \fBnisplus\fR   Network Information Services Plus (version 3)
156 \fBpasswd\fR    local password files
157 \fBunion\fR     union maps
161 .BR mount_type " (string, default=nfs)"
162 All Amd mount types default to NFS.  That is, Amd is an NFS server on the
163 map mount points, for the local host it is running on.  If "autofs" is
164 specified, Amd will be an autofs server for those mount points.
167 .BR autofs_use_lofs " (string, default=yes)"
168 When set to "yes" and using Autofs, Amd will use lofs-type (loopback) mounts
169 for type:=link mounts.  This has the advantage of mounting in place, and
170 users get to the see the same pathname that they chdir'ed into.  If this
171 option is set to "no," then Amd will use symlinks instead: that code is more
172 tested, but negates autofs's big advantage of in-place mounts.
175 .BR search_path " (string, default no search path)"
176 This provides a (colon-delimited) search path for file maps.  Using a search
177 path, sites can allow for local map customizations and overrides, and can
178 distributed maps in several locations as needed.
181 .BR selectors_in_defaults " (boolean, default=no)"
182 If "yes," then the /defaults entry of maps will search for and process any
183 selectors before setting defaults for all other keys in that map.  Useful
184 when you want to set different options for a complete map based on some
185 parameters.  For example, you may want to better the NFS performance over
186 slow slip-based networks as follows:
189 /defaults \\
190     wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
191     wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
194 Deprecated form: selectors_on_default
197 .BR sun_map_syntax " (boolean, default=no)"
198 If "yes," then Amd will parse the map according to the Sun Automount syntax.
200 .\" **************************************************************************
201 .SS Parameters applicable to the global section only
204 .BR arch " (string, default to compiled in value)"
205 Same as the
206 .B \-A
207 option to Amd.  Allows you to override the value of the
208 .I arch
209 Amd variable.
212 .BR auto_attrcache " (numeric, default=0)"
213 Specify in seconds (or units of 0.1 seconds, depending on the OS), what is
214 the (kernel-side) NFS attribute cache timeout for @i{Amd}'s own automount
215 points.  A value of 0 is supposed to turn off attribute caching, meaning
216 that @i{Amd} will be consulted via a kernel-RPC each time someone stat()'s
217 the mount point (which could be abused as a denial-of-service attack).
218 Warning: some OSs are incapable of turning off the NFS attribute cache
219 reliably.  On such systems, Amd may not work reliably under heavy load.  See
220 the README.attrcache document in the Am-utils distribution for more details.
223 .BR auto_dir " (string, default=/a)"
224 Same as the
225 .B \-a
226 option to Amd.  This sets the private directory where Amd will create
227 sub-directories for its real mount points.
230 .BR cache_duration " (numeric, default=300)"
231 Same as the
232 .B \-c
233 option to Amd.  Sets the duration in seconds that looked-up or mounted map
234 entries remain in the cache.
237 .BR cluster " (string, default no cluster)"
238 Same as the
239 .B \-C
240 option to Amd.  Specifies the alternate HP-UX cluster to use.
243 .BR debug_mtab_file " (string, default=/tmp/mnttab)"
244 Path to mtab file that is used by Amd to store a list of mounted
245 file systems during debug-mtab mode.  This option only applies
246 to systems that store mtab information on disk.
250 .BR debug_options " (string, default no debug options)"
251 Same as the
252 .B \-D
253 option to Amd.  Specify any debugging options for Amd.  Works only if
254 am-utils was configured for debugging using the --enable-debug option.  The
255 "mem" option, as well as all other options, can be turned on via
256 --enable-debug=mem.  Otherwise debugging options are ignored.  Options are
257 comma delimited, and can be preceded by the string "no" to negate their
258 meaning.  You can get the list of supported debugging options by running Amd
259 \-H.  Possible values are:
262 \fBall\fR       all options (excludes hrtime and mtab)
263 \fBdefaults\fR  "sensible" default options (all--excluding hrtime, mtab, and xdrtrace)
264 \fBtest\fR      full debug options plus mtab,nodaemon,nofork,noamq
265 \fBamq\fR       register for amq
266 \fBdaemon\fR    enter daemon mode
267 \fBfork\fR      fork server
268 \fBfull\fR      program trace
269 \fBhrtime\fR    print high resolution time stamps (only if syslog(3) is not used)
270 \fBinfo\fR      info service specific debugging (hesiod, nis, etc.)
271 \fBmem\fR       trace memory allocations
272 \fBmtab\fR      use local "/tmp/mtab" file
273 \fBreaddir\fR   show browsable_dirs progress
274 \fBstr\fR       debug string munging
275 \fBtrace\fR     trace protocol and NFS mount arguments
276 \fBxdrtrace\fR  trace XDR routines
280 .BR dismount_interval " (numeric, default=120)"
281 Same as the
282 .B \-w
283 option to Amd.  Specify in seconds, the time between attempts to dismount
284 file systems that have exceeded their cached times.
287 .BR domain_strip " (boolean, default=yes)"
288 If "yes," then the domain
289 name part referred to by ${rhost} is stripped off.  This is
290 useful to keep logs and smaller.  If "no," then the domain name
291 part is left changed.  This is useful when using multiple domains with
292 the same maps (as you may have hosts whose domain-stripped name is
293 identical).
296 .BR exec_map_timeout " (numeric, default=10)"
297 The timeout in seconds that
298 .I Amd
299 will wait for an executable map program before an answer is returned from
300 that program (or script).  This value should be set to as small as possible
301 while still allowing normal replies to be returned before the timer expires,
302 because during the time that the executable map program is queried,
303 .I Amd
304 is essentially waiting and is thus not responding to any other queries.
307 .BR forced_unmounts " (boolean, default=no)"
308 If set to "yes," and the client OS supports forced or lazy unmounts, then
309 .I Amd
310 will attempt to use them if it gets any of three serious error conditions
311 when trying to unmount an existing mount point or mount on top of one: EIO,
312 ESTALE, or EBUSY.
314 This could be useful to recover from serious conditions such as hardware
315 failure of mounted disks, or NFS servers which are down permanently, were
316 migrated, or changed their IP address.  Only "type:=toplvl" mounts hung with
317 EBUSY are forcibly unmounted using this option, which is useful to recover
318 from a hung
319 .IR Amd ).
322 .BR full_os " (string, default to compiled in value)"
323 The full name of the operating system, along with its version.  Allows you
324 to override the compiled-in full name and version of the operating system.
325 Useful when the compiled-in name is not desired.  For example, the full
326 operating system name on linux comes up as ``linux'', but you can override
327 it to ``linux-2.2.5.''
330 .BR fully_qualified_hosts " (string, default=no)"
331 If "yes,"
332 .I Amd
333 will perform RPC authentication using fully-qualified host names.  This is
334 necessary for some systems, and especially when performing cross-domain
335 mounting.  For this function to work, the
336 .I Amd
337 variable ${hostd} is used, requiring that ${domain} not be null.
340 .BR hesiod_base " (string, default=automount)"
341 Specify the base name for hesiod maps.
344 .BR karch " (string, default to karch of the system)"
345 Same as the
346 .B \-k
347 option to Amd.  Allows you to override the kernel-architecture of your
348 system.  Useful for example on Sun (Sparc) machines, where you can build one
349 Amd binary, and run it on multiple machines, yet you want each one to get
350 the correct
351 .I karch
352 variable set (for example, sun4c, sun4m, sun4u, etc.)  Note that if not
353 specified, Amd will use uname(3) to figure out the kernel architecture of
354 the machine.
357 .BR ldap_base " (string, default not set)"
358 Specify the base name for LDAP.  This often includes LDAP-specific
359 values such as country and organization.
362 .BR ldap_cache_maxmem " (numeric, default=131072)"
363 Specify the maximum memory Amd should use to cache LDAP entries.
366 .BR ldap_cache_seconds " (numeric, default=0)"
367 Specify the number of seconds to keep entries in the cache.
370 .BR ldap_hostports " (string, default not set)"
371 Specify the LDAP host and port values.
374 .BR ldap_proto_version " (numeric, default=2)"
375 Specify the version of the LDAP protocol to use.
378 .BR local_domain " (string, default no sub-domain)"
379 Same as the
380 .B \-d
381 option to Amd.  Specify the local domain name.  If this option is not given
382 the domain name is determined from the hostname, by removing the first
383 component of the fully-qualified host name.
386 .BR localhost_address " (string, default to localhost or 127.0.0.1)"
387 Specify the name or IP address for Amd to use when connecting the sockets
388 for the local NFS server and the RPC server.  This defaults to 127.0.0.1 or
389 whatever the host reports as its local address.  This parameter is useful on
390 hosts with multiple addresses where you want to force Amd to connect to a
391 specific address.
394 .BR log_file " (string, default=/dev/stderr)"
395 Same as the
396 .B \-l
397 option to Amd.  Specify a file name to log Amd events to.
398 If the string
399 .B /dev/stderr
400 is specified, Amd will send its events to the standard error file descriptor.
401 If the string
402 .B syslog
403 is given, Amd will record its events with the system logger
404 .BR syslogd (8).
405 The default syslog facility used is LOG_DAEMON.  If you
406 wish to change it, append its name to the log file name, delimited by a
407 single colon.  For example, if
408 .I logfile
409 is the string
410 .B syslog:local7
411 then Amd will log messages via
412 .IR syslog (3)
413 using the LOG_LOCAL7 facility (if it exists on the system).
416 .BR log_options " (string, default=defaults)"
417 Same as the
418 .B \-x
419 option to Amd.  Specify any logging options for Amd.  Options are comma
420 delimited, and can be preceded by the string "no" to negate their meaning.
421 The "debug" logging option is only available if am-utils was configured with
422 --enable-debug.  You can get the list of supported debugging and logging
423 options by running
424 .B amd
425 .BR \-H .
426 Possible values are:
429 \fBall\fR       all messages
430 \fBdefaults\fR  default messages (fatal,error,user,warning,info)
431 \fBdebug\fR     debug messages
432 \fBerror\fR     non-fatal system errors (cannot be turned off)
433 \fBfatal\fR     fatal errors (cannot be turned off)
434 \fBinfo\fR      information
435 \fBmap\fR       map errors
436 \fBstats\fR     additional statistical information
437 \fBuser\fR      non-fatal user errors
438 \fBwarn\fR      warnings
439 \fBwarning\fR   warnings
443 .BR map_reload_interval " (numeric, default=3600)"
444 The number of seconds that Amd will wait before it checks to see if any maps
445 have changed at their source (NIS servers, LDAP servers, files, etc.).  Amd
446 will reload only those maps that have changed.
449 .BR nfs_allow_any_interface " (string, default=no)"
450 Normally Amd accepts local NFS packets only from 127.0.0.1.  If this
451 parameter is set to "yes" then Amd will accept local NFS packets from any
452 local interface; this is useful on hosts that may have multiple interfaces
453 where the system is forced to send all outgoing packets (even those bound to
454 the same host) via an address other than 127.0.0.1.
457 .BR nfs_allow_insecure_port " (string, default=no)"
458 Normally Amd will refuse requests coming from unprivileged ports (i.e.
459 ports >= 1024 on Unix systems), so that only privileged users and the kernel
460 can send NFS requests to it.  However, some kernels (certain versions of
461 Darwin, MacOS X, and Linux) have bugs that cause them to use unprivileged
462 ports in certain situations, which causes Amd to stop dead in its tracks.
463 This parameter allows Amd to operate normally even on such systems, at the
464 expense of a slight decrease in the security of its operations.  If you see
465 messages like "ignoring request from foo:1234, port not reserved" in your
466 Amd log, try enabling this parameter and give it another go.
469 .BR nfs_proto " (string, default to trying version tcp then udp)"
470 By default, Amd tries TCP and then UDP.  This option forces the overall NFS
471 protocol used to TCP or UDP.  It overrides what is in the Amd maps, and is
472 useful when Amd is compiled with NFSv3 support that may not be stable.  With
473 this option you can turn off the complete usage of NFSv3 dynamically
474 (without having to recompile Amd) until such time as NFSv3 support is
475 desired again.
478 .BR nfs_retransmit_counter " (numeric, default=11)"
479 Same as the
480 .I retransmit
481 part of the
482 .BI \-t " timeout.retransmit"
483 option to Amd.
484 Specifies the number of NFS retransmissions that the kernel will use to
485 communicate with Amd.
488 .BR nfs_retransmit_counter_udp " (numeric, default=11)"
489 Same as the
490 .B nfs_retransmit_counter
491 option, but for all UDP mounts only.
494 .BR nfs_retransmit_counter_tcp " (numeric, default=11)"
495 Same as the
496 .B nfs_retransmit_counter
497 option, but for all TCP mounts only.
500 .BR nfs_retransmit_counter_toplvl " (numeric, default=11)"
501 Same as the
502 .B nfs_retransmit_counter
503 option, but only for Amd's top-level UDP mounts.
506 .BR nfs_retry_interval " (numeric, default=8)"
507 Same as the
508 .I timeout
509 part of the
510 .BI \-t " timeout.retransmit"
511 option to Amd.  Specifies the NFS timeout interval, in
512 .I tenths
513 of seconds, between NFS/RPC retries (for UDP and TCP).
514 This is the value that the kernel will use to
515 communicate with Amd.
517 Amd relies on the kernel RPC retransmit mechanism to trigger mount retries.
518 The values of the
519 .B nfs_retransmit_counter
520 and the
521 .B nfs_retry_interval
522 parameters change the overall retry interval.  Too long an interval gives
523 poor interactive response; too short an interval causes excessive retries.
526 .BR nfs_retry_interval_udp " (numeric, default=8)"
527 Same as the
528 .B nfs_retry_interval
529 option, but for all UDP mounts only.
532 .BR nfs_retry_interval_tcp " (numeric, default=8)"
533 Same as the
534 .B nfs_retry_interval
535 option, but for all TCP mounts only.
538 .BR nfs_retry_interval_toplvl " (numeric, default=8)"
539 Same as the
540 .B nfs_retry_interval
541 option, but only for Amd's top-level UDP mounts.
544 .BR nfs_vers " (numeric, default to trying version 3 then 2)"
545 By default, Amd tries version 3 and then version 2.  This option forces the
546 overall NFS protocol used to version 3 or 2.  It overrides what is in the
547 Amd maps, and is useful when Amd is compiled with NFSv3 support that may not
548 be stable.  With this option you can turn off the complete usage of NFSv3
549 dynamically (without having to recompile Amd) until such time as NFSv3
550 support is desired again.
553 .BR nis_domain " (string, default to local NIS domain name)"
554 Same as the
555 .B \-y
556 option to Amd.  Specify an alternative NIS domain from which to fetch the
557 NIS maps.  The default is the system domain name.  This option is ignored if
558 NIS support is not available.
561 .BR normalize_hostnames " (boolean, default=no)"
562 Same as the
563 .B \-n
564 option to Amd.  If "yes," then the name refereed to by ${rhost} is
565 normalized relative to the host database before being used.  The effect is
566 to translate aliases into ``official'' names.
569 .BR normalize_slashes " (boolean, default=yes)"
571 If "yes," then Amd will condense all multiple ``/'' (slash) characters into
572 one and remove all trailing slashes.  If "no," then Amd will not touch
573 strings that may contain repeated or trailing slashes.  The latter is
574 sometimes useful with SMB mounts, which often require multiple slash
575 characters in pathnames.
578 .BR os " (string, default to compiled in value)"
579 Same as the
580 .B \-O
581 option to Amd.  Allows you to override the compiled-in name of the operating
582 system.  Useful when the built-in name is not desired for backward
583 compatibility reasons.  For example, if the build in name is ``sunos5'', you
584 can override it to ``sos5'', and use older maps which were written with the
585 latter in mind.
588 .BR osver " (string, default to compiled in value)"
589 Same as the
590 .B \-o
591 option to Amd.  Overrides the compiled-in version number of the operating
592 system.  Useful when the built in version is not desired for backward
593 compatibility reasons.  For example, if the build in version is ``2.5.1'',
594 you can override it to ``5.5.1'', and use older maps that were written with
595 the latter in mind.
598 .BR pid_file " (string, default=/dev/stdout)"
599 Specify a file to store the process ID of the running daemon into.  If not
600 specified, Amd will print its process id onto the standard output.  Useful
601 for killing Amd after it had run.  Note that the PID of a running Amd can
602 also be retrieved via
603 .B amq
604 .BR \-p .
605 This file is used only if the print_pid option is on.
608 .BR plock " (boolean, default=yes)"
609 Same as the
610 .B \-S
611 option to Amd.
612 If "yes," lock the running executable pages of Amd into memory.  To improve
613 Amd's performance, systems that support the
614 .BR plock (3)
616 .BR mlockall (2)
617 call can lock the Amd process into memory.  This way there is less chance it
618 the operating system will schedule, page out, and swap the Amd process as
619 needed.  This improves Amd's performance, at the cost of reserving the
620 memory used by the Amd process (making it unavailable for other processes).
623 .BR portmap_program " (numeric, default=300019)"
624 Specify an alternate Port-mapper RPC program number, other than the official
625 number.  This is useful when running multiple Amd processes.  For example,
626 you can run another Amd in "test" mode, without affecting the primary Amd
627 process in any way.  For safety reasons, the alternate program numbers that
628 can be specified must be in the range 300019-300029, inclusive.
630 has an option
631 .B -P
632 which can be used to specify an alternate program number of an Amd to
633 contact.  In this way, amq can fully control any number of Amd processes
634 running on the same host.
637 .BR preferred_amq_port " (numeric, default=0)"
638 Specify an alternate Port-mapper RPC port number for Amd's
640 service.  This is used for both UDP and TCP.  Setting this value to 0 (or
641 not defining it) will cause
643 to select an arbitrary port number.  Setting the
645 RPC service port to a specific number is useful in firewalled or NAT'ed
646 environments, where you need to know which port
648 will listen on.
651 .BR print_pid " (boolean, default=no)"
652 Same as the
653 .B \-p
654 option to Amd.  If "yes," Amd will print its process ID upon starting.
657 .BR print_version " (boolean, default=no)"
658 Same as the
659 .B \-v
660 option to Amd, but the version prints and Amd continues to run.  If "yes,"
661 Amd will print its version information string, which includes some
662 configuration and compilation values.
665 .BR restart_mounts " (boolean, default=no)"
666 Same as the
667 .B \-r
668 option to Amd.  If "yes"
670 will scan the mount table to determine which file systems are currently
671 mounted.  Whenever one of these would have been auto-mounted,
673 inherits it.
676 .BR show_statfs_entries " (boolean), default=no)"
677 If "yes," then all maps which are browsable will also show the number of
678 entries (keys) they have when "df" runs. (This is accomplished by returning
679 non-zero values to the statfs(2) system call).
682 .BR truncate_log " (boolean), default=no)"
683 If "yes," then the log file (if it is a regular file), will be truncated
684 upon startup.
687 .BR unmount_on_exit " (boolean), default=no)"
688 If "yes," then Amd will attempt to unmount all file systems which it knows
689 about.  Normally Amd leaves all (esp. NFS) mounted file systems intact.
690 Note that Amd does not know about file systems mounted before it starts up,
691 unless the restart_mounts option or
692 .B \-r
693 flag are used.
696 .BR use_tcpwrappers " (boolean), default=yes)"
697 If "yes," then Amd will use the tcpd/librwap tcpwrappers library
698 (if available) to control
699 access to Amd via the /etc/hosts.allow and /etc/hosts.deny files.
702 .BR vendor " (string, default to compiled in value)"
703 The name of the vendor of the operating system.  Overrides the compiled-in
704 vendor name.  Useful when the compiled-in name is not desired.  For example,
705 most Intel based systems set the vendor name to ``unknown'', but you can set
706 it to ``redhat.''
708 .\" **************************************************************************
709 .SS Parameters applicable to regular map sections
712 .BR map_name " (string, must be specified)"
713 Name of the map where the keys are located.
716 .BR tag " (string, default no tag)"
717 Each map entry in the configuration file can be tagged.  If no tag is
718 specified, that map section will always be processed by Amd.  If it is
719 specified, then Amd will process the map if the
720 .B -T
721 option was given to Amd, and the value given to that command-line option
722 matches that in the map section.
724 .\" **************************************************************************
725 .SH EXAMPLES
726 Here is a real Amd configuration file I use daily.
729 # GLOBAL OPTIONS SECTION
730 [ global ]
731 normalize_hostnames =    no
732 print_pid =              no
733 restart_mounts =         yes
734 auto_dir =               /n
735 log_file =               /var/log/amd
736 log_options =            all
737 #debug_options =         all
738 plock =                  no
739 selectors_in_defaults =  yes
740 # config.guess picks up "sunos5" and I don't want to edit my maps yet
741 os =                     sos5
742 # if you print_version after setting up "os," it will show it.
743 print_version =          no
744 map_type =               file
745 search_path =            /etc/amdmaps:/usr/lib/amd:/usr/local/AMD/lib
746 browsable_dirs =         yes
748 # DEFINE AN AMD MOUNT POINT
749 [ /u ]
750 map_name =               amd.u
752 [ /proj ]
753 map_name =               amd.proj
755 [ /src ]
756 map_name =               amd.src
758 [ /misc ]
759 map_name =               amd.misc
761 [ /import ]
762 map_name =               amd.import
764 [ /tftpboot/.amd ]
765 tag =                    tftpboot
766 map_name =               amd.tftpboot
768 .\" **************************************************************************
769 .SH "SEE ALSO"
770 .BR amd (8),
771 .BR amq (8),
772 .BR ctl-amd (8),
773 .BR automount (8),
774 .BR hosts_access (5).
776 ``am-utils''
777 .BR info (1)
778 entry.
780 .I "Linux NFS and Automounter Administration"
781 by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001).
783 .I http://www.am-utils.org
785 .I "Amd \- The 4.4 BSD Automounter"
786 .SH AUTHORS
787 Erez Zadok <ezk@cs.sunysb.edu>, Computer Science Department, Stony Brook
788 University, Stony Brook, New York, USA.
790 Other authors and contributors to am-utils are listed in the
791 .B AUTHORS
792 file distributed with am-utils.