2 .\" Copyright (c) 1997-1999 Erez Zadok
3 .\" Copyright (c) 1990 Jan-Simon Pendry
4 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
5 .\" Copyright (c) 1990 The Regents of the University of California.
6 .\" All rights reserved.
8 .\" This code is derived from software contributed to Berkeley by
9 .\" Jan-Simon Pendry at Imperial College, London.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. All advertising materials mentioning features or use of this software
20 .\" must display the following acknowledgment:
21 .\" This product includes software developed by the University of
22 .\" California, Berkeley and its contributors.
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\" may be used to endorse or promote products derived from this software
25 .\" without specific prior written permission.
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 .\" %W% (Berkeley) %G%
41 .\" $Id: amd.conf.5,v 1.3 1999/03/30 17:23:08 ezk Exp $
42 .\" $FreeBSD: src/contrib/amd/scripts/amd.conf.5,v 1.9.2.3 2001/08/16 10:53:40 ru Exp $
49 .Nd amd configuration file
55 file is the configuration file for amd, as part of the am-utils suite.
58 contains runtime configuration information for the
62 The file consists of sections and parameters. A section begins with the
63 name of the section in square brackets and continues until the next section
64 begins or the end of the file is reached. Sections contain parameters of
68 The file is line-based - that is, each newline-terminated line represents
69 either a comment, a section name or a parameter. No line-continuation
72 Section, parameter names and their values are case sensitive.
74 Only the first equals sign in a parameter is significant. Whitespace before
75 or after the first equals sign is discarded. Leading, trailing and
76 internal whitespace in section and parameter names is irrelevant. Leading
77 and trailing whitespace in a parameter value is discarded. Internal
78 whitespace within a parameter value is not allowed, unless the whole
79 parameter value is quoted with double quotes as in
80 .Sq name = Qq some\ value .
82 Any line beginning with a pound sign (#) is ignored, as are lines containing
85 The values following the equals sign in parameters are all either a string
86 (no quotes needed if string does not include spaces) or a boolean, which may
87 be given as yes/no. Case is significant in all values. Some items such as
88 cache timeouts are numeric.
90 .Ss "The [global] section"
91 Parameters in this section either apply to
93 as a whole, or to all other regular map sections which follow. There
94 should be only one global section defined in one configuration file.
96 It is highly recommended that this section be specified first in the
97 configuration file. If it is not, then regular map sections which precede
98 it will not use global values defined later.
99 .Ss "Regular [/map] sections"
100 Parameters in regular (non-global) sections apply to a single map entry.
101 For example, if the map section
103 is defined, then all parameters following it will be applied to the
105 amd-managed mount point.
107 .Ss "Parameters common to all sections"
108 These parameters can be specified either in the global or a map specific
109 section. Entries specified in a map-specific section override the default
110 value or one defined in the global section. If such a common parameter is
111 specified only in the global section, it is applicable to all regular map
112 sections that follow.
114 .It Ic browsable_dirs Xo
119 then amd's top-level mount points will be browsable to
121 calls. This means you could run for example
123 and see what keys are available to mount in that directory. Not all entries
128 entry, wildcardentries, and those with a
130 in them are not included. If you specify
132 to this option, all but
134 will be visible. Note that if you run a command which will attempt to
136 the entries, such as often done by
141 will attempt to mount
143 entry in that map. This is often called a
145 .It Ic map_options Xo
146 (string, default no options)
148 This option is the same as specifying map options on the command line to
153 (string, default search all map types)
155 If specified, amd will initialize the map only for the type given.
156 This is useful to avoid the default map search type used by amd which
157 takes longer and can have undesired side-effects such as initializing
158 NIS even if not used. Possible values are:
160 .Bl -tag -width "nisplus" -compact
164 Hesiod name service from MIT
166 Lightweight Directory Access Protocol
168 (New) dbm style hash files
170 Network Information Services (version 2)
172 Network Information Services Plus (version 3)
179 (string, default=nfs)
181 All amd mount types default to
187 server on the map mount points, for the local host it is running on. If
189 is specified, amd will be an autofs server for those mount points.
190 .It Ic search_path Xo
191 (string, default no search path)
195 search path for file maps. Using a search path, sites can allow for
196 local map customizations and overrides, and can distributed maps in
197 several locations as needed.
199 .Ss "Parameters applicable to the global section only"
202 (string, default to compiled in value)
204 Allows you to override the value of the
215 This sets the private directory where amd will create sub-directories for its
217 .It Ic cache_duration Xo
218 (numeric, default=300)
224 Sets the duration in seconds that looked up map entries remain in the cache.
226 (string, default no cluster)
232 Specifies the alternate
235 .It Ic debug_options Xo
236 (string, default no debug options)
242 Specify any debugging options for
244 Works only if am-utils was configured for debugging using the
249 option alone can be turned on via
250 .Fl -enable-debug Ns = Ns Ic mem .
251 Otherwise debugging options are ignored. Options are comma delimited, and can
252 be preceded by the string
254 to negate their meaning. You can get the list of supported debugging options
259 .Bl -tag -width "daemon" -compact
272 info service specific debugging
275 trace memory allocations
283 full debug but no daemon
287 .It Ic dismount_interval Xo
288 (numeric, default=120)
294 Specify, in seconds, the time between attempts to dismount file systems that
295 have exceeded their cached times.
296 .It Ic fully_qualified_hosts Xo
302 will perform RPC authentication using fully-qualified host names. This is
303 necessary for some systems, and especially when performing cross-domain
304 mounting. For this function to work, the
308 is used, requiring that
311 .It Ic hesiod_base Xo
312 (string, default=automount)
314 Specify the base name for hesiod maps.
316 (string, default to karch of the system)
322 Allows you to override the kernel-architecture of your system. Useful for
325 machines, where you can build one
327 binary and run it on multiple machines, yet you want each one to get the
331 (for example, sun4c, sun4m, sun4u, etc.)
337 to figure out the kernel architecture of the machine.
339 (string, default not set)
341 Specify the base name for LDAP.
342 .It Ic ldap_cache_maxmem Xo
343 (numeric, default=131072)
345 Specify the maximum memory amd should use to cache LDAP entries.
346 .It Ic ldap_cache_seconds Xo
349 Specify the number of seconds to keep entries in the cache.
350 .It Ic ldap_hostports Xo
351 (string, default not set)
353 Specify LDAP-specific values such as country and organization.
354 .It Ic local_domain Xo
355 (string, default no sub-domain)
361 Specify the local domain name. If this option is not given the domain name is
362 determined from the hostname by removing the first component of the
363 fully-qualified host name.
365 (string, default=/dev/stderr)
371 Specify a file name to log
373 events to. If the string
377 will send its events to the standard error file descriptor. IF the string
381 will record its events with the system logger
383 The default syslog facility used is
385 If you wish to change it, append its name to the log file name, delimited by a
386 single colon. For example, if
392 will log messages via
397 (if it exists on the system).
398 .It Ic log_options Xo
399 (string, default no logging options)
405 Specify any logging options for
407 Options are comma delimited, and can be preceded by the string
409 to negate their meaning. The
411 logging option is only available if am-utils was configured with
413 You can get the list of supported debugging options by running
417 .Bl -tag -width "warning" -compact
423 non-fatal system errors
431 additional statistical information
433 non-fatal user errors
439 .It Ic nfs_retransmit_counter Xo
440 (numeric, default=110)
445 .Fl t Ar interval.counter
448 Specifies the retransmit counter's value in tenths of seconds.
449 .It Ic nfs_retry_interval Xo
455 .Fl t Ar interval.counter
458 Specifies the interval in tenths of seconds, between NFS/RPC/UDP retries.
460 (string, default to local NIS domain name)
466 Specify an alternative
468 domain from which to fetch the
470 maps. The default is the system domain name. This option is ignored if
472 support is not available.
473 .It Ic normalize_hostnames Xo
474 (boolean, default=no)
482 then the name refereed to by
484 is normalized relative to the host database before being used. The effect is
485 to translate aliases into
489 (string, default to compiled in value)
495 Allows you to override the compiled-in name of the operating
496 system. Useful when the built-in name is not desired for backward
497 compatibility reasons. For example, if the build in name is
499 you can override it to
501 and use older maps which were written with the latter in mind.
503 (string, default to compiled in value)
509 Override the compiled-in version number of the operating
510 system. Useful when the built in version is not desired for backward
511 compatibility reasons. For example, if the build in version is
513 you can override it to
515 and use older maps that were written with the latter in mind.
517 (string, default=/dev/stdout)
519 Specify a file to store the process ID of the running daemon into. If not
522 will print its process id only the standard output. Useful for killing
524 after it had run. Note that the PID of a running
526 can also be retrieved via
528 This file is used only if the
532 (boolean, default=yes)
540 lock the running executable pages of
542 into memory. To improve
544 performance, systems that support the
548 process into memory. This way there is less chance it that the operating
549 system will schedule, page out, and swap the
551 process as needed. This improves
553 performance, at the cost of reserving the memory used by the
556 (making it unavailable for other processes).
557 .It Ic portmap_program Xo
558 (numeric, default=300019)
560 Specify an alternate Port-mapper RPC program number, other than the official
561 number. This is useful when running multiple
563 processes. For example, you can run another
567 mode, without affecting the primary
569 process in any way. For safety reasons, the alternate program numbers that
570 can be specified must be in the range 300019-300029, inclusive.
574 which can be used to specify an alternate program number of an
576 to contact. In this way,
578 can fully control any number of
580 processes running on the same host.
582 (boolean, default=no)
591 will print its process ID upon starting.
592 .It Ic print_version Xo
593 (boolean, default=no)
599 but the version prints and
604 will print its version information string, which includes some configuration
605 and compilation values.
606 .It Ic restart_mounts Xo
607 (boolean, default=no)
616 will scan the mount table to determine which file systems are currently
617 mounted. Whenever one of these would have been auto-mounted,
620 .It Ic selectors_on_default Xo
621 (boolean, default=no)
627 entry of maps will be looked for and process any selectors before setting
628 defaults for all other keys in that map. Useful when you want to set
629 different options for a complete map based on some parameters. For example,
630 you may want to better the
632 performance over slow slip-based networks as
637 wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
638 wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
640 .It Ic show_statfs_entries Xo
641 (boolean, default=no)
645 then all maps which are browsable will also show the number of entries
650 (This is accomplished by returning non-zero values to the
653 .It Ic unmount_on_exit Xo
654 (boolean, default=no)
660 will attempt to unmount all file systems which it knows about. Normally
665 mounted filesystems intact. Note that
667 does not know about file systems mounted before it starts up, unless the
673 .Ss "Parameters applicable to regular map sections"
676 (string, must be specified)
678 Name of the map where the keys are located.
680 (string, default no tag)
682 Each map entry in the configuration file can be tagged. If no tag is
683 specified, that map section will always be processed by
685 If it is specified, then
687 will process the map if the
691 and the value given to that command-line option matches that in the map
697 configuration I use daily.
699 # GLOBAL OPTIONS SECTION
701 normalize_hostnames = no
705 log_file = /var/log/amd
709 selectors_on_default = yes
710 # config.guess picks up "sunos5" and I don't want to edit my maps yet
712 # if you print_version after setting up "os", it will show it.
715 search_path = /etc/amdmaps:/usr/lib/amd:/usr/local/AMD/lib
718 # DEFINE AN AMD MOUNT POINT
732 map_name = amd.import
736 map_name = amd.tftpboot
742 .An Erez Zadok Aq ezk@cs.columbia.edu ,
743 Department of Computer Science, Columbia University, New York, USA.
745 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
746 Department of Computing, Imperial College, London, UK.
748 Other authors and contributers to am-utils are listed in the
750 file distributed with am-utils.
754 utility first appeared in
projects / dragonfly.git / blob