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 $
43 .\" $DragonFly: src/contrib/amd/scripts/amd.conf.5,v 1.2 2003/06/17 04:23:58 dillon Exp $
50 .Nd amd configuration file
56 file is the configuration file for amd, as part of the am-utils suite.
59 contains runtime configuration information for the
63 The file consists of sections and parameters. A section begins with the
64 name of the section in square brackets and continues until the next section
65 begins or the end of the file is reached. Sections contain parameters of
69 The file is line-based - that is, each newline-terminated line represents
70 either a comment, a section name or a parameter. No line-continuation
73 Section, parameter names and their values are case sensitive.
75 Only the first equals sign in a parameter is significant. Whitespace before
76 or after the first equals sign is discarded. Leading, trailing and
77 internal whitespace in section and parameter names is irrelevant. Leading
78 and trailing whitespace in a parameter value is discarded. Internal
79 whitespace within a parameter value is not allowed, unless the whole
80 parameter value is quoted with double quotes as in
81 .Sq name = Qq some\ value .
83 Any line beginning with a pound sign (#) is ignored, as are lines containing
86 The values following the equals sign in parameters are all either a string
87 (no quotes needed if string does not include spaces) or a boolean, which may
88 be given as yes/no. Case is significant in all values. Some items such as
89 cache timeouts are numeric.
91 .Ss "The [global] section"
92 Parameters in this section either apply to
94 as a whole, or to all other regular map sections which follow. There
95 should be only one global section defined in one configuration file.
97 It is highly recommended that this section be specified first in the
98 configuration file. If it is not, then regular map sections which precede
99 it will not use global values defined later.
100 .Ss "Regular [/map] sections"
101 Parameters in regular (non-global) sections apply to a single map entry.
102 For example, if the map section
104 is defined, then all parameters following it will be applied to the
106 amd-managed mount point.
108 .Ss "Parameters common to all sections"
109 These parameters can be specified either in the global or a map specific
110 section. Entries specified in a map-specific section override the default
111 value or one defined in the global section. If such a common parameter is
112 specified only in the global section, it is applicable to all regular map
113 sections that follow.
115 .It Ic browsable_dirs Xo
120 then amd's top-level mount points will be browsable to
122 calls. This means you could run for example
124 and see what keys are available to mount in that directory. Not all entries
129 entry, wildcardentries, and those with a
131 in them are not included. If you specify
133 to this option, all but
135 will be visible. Note that if you run a command which will attempt to
137 the entries, such as often done by
142 will attempt to mount
144 entry in that map. This is often called a
146 .It Ic map_options Xo
147 (string, default no options)
149 This option is the same as specifying map options on the command line to
154 (string, default search all map types)
156 If specified, amd will initialize the map only for the type given.
157 This is useful to avoid the default map search type used by amd which
158 takes longer and can have undesired side-effects such as initializing
159 NIS even if not used. Possible values are:
161 .Bl -tag -width "nisplus" -compact
165 Hesiod name service from MIT
167 Lightweight Directory Access Protocol
169 (New) dbm style hash files
171 Network Information Services (version 2)
173 Network Information Services Plus (version 3)
180 (string, default=nfs)
182 All amd mount types default to
188 server on the map mount points, for the local host it is running on. If
190 is specified, amd will be an autofs server for those mount points.
191 .It Ic search_path Xo
192 (string, default no search path)
196 search path for file maps. Using a search path, sites can allow for
197 local map customizations and overrides, and can distributed maps in
198 several locations as needed.
200 .Ss "Parameters applicable to the global section only"
203 (string, default to compiled in value)
205 Allows you to override the value of the
216 This sets the private directory where amd will create sub-directories for its
218 .It Ic cache_duration Xo
219 (numeric, default=300)
225 Sets the duration in seconds that looked up map entries remain in the cache.
227 (string, default no cluster)
233 Specifies the alternate
236 .It Ic debug_options Xo
237 (string, default no debug options)
243 Specify any debugging options for
245 Works only if am-utils was configured for debugging using the
250 option alone can be turned on via
251 .Fl -enable-debug Ns = Ns Ic mem .
252 Otherwise debugging options are ignored. Options are comma delimited, and can
253 be preceded by the string
255 to negate their meaning. You can get the list of supported debugging options
260 .Bl -tag -width "daemon" -compact
273 info service specific debugging
276 trace memory allocations
284 full debug but no daemon
288 .It Ic dismount_interval Xo
289 (numeric, default=120)
295 Specify, in seconds, the time between attempts to dismount file systems that
296 have exceeded their cached times.
297 .It Ic fully_qualified_hosts Xo
303 will perform RPC authentication using fully-qualified host names. This is
304 necessary for some systems, and especially when performing cross-domain
305 mounting. For this function to work, the
309 is used, requiring that
312 .It Ic hesiod_base Xo
313 (string, default=automount)
315 Specify the base name for hesiod maps.
317 (string, default to karch of the system)
323 Allows you to override the kernel-architecture of your system. Useful for
326 machines, where you can build one
328 binary and run it on multiple machines, yet you want each one to get the
332 (for example, sun4c, sun4m, sun4u, etc.)
338 to figure out the kernel architecture of the machine.
340 (string, default not set)
342 Specify the base name for LDAP.
343 .It Ic ldap_cache_maxmem Xo
344 (numeric, default=131072)
346 Specify the maximum memory amd should use to cache LDAP entries.
347 .It Ic ldap_cache_seconds Xo
350 Specify the number of seconds to keep entries in the cache.
351 .It Ic ldap_hostports Xo
352 (string, default not set)
354 Specify LDAP-specific values such as country and organization.
355 .It Ic local_domain Xo
356 (string, default no sub-domain)
362 Specify the local domain name. If this option is not given the domain name is
363 determined from the hostname by removing the first component of the
364 fully-qualified host name.
366 (string, default=/dev/stderr)
372 Specify a file name to log
374 events to. If the string
378 will send its events to the standard error file descriptor. IF the string
382 will record its events with the system logger
384 The default syslog facility used is
386 If you wish to change it, append its name to the log file name, delimited by a
387 single colon. For example, if
393 will log messages via
398 (if it exists on the system).
399 .It Ic log_options Xo
400 (string, default no logging options)
406 Specify any logging options for
408 Options are comma delimited, and can be preceded by the string
410 to negate their meaning. The
412 logging option is only available if am-utils was configured with
414 You can get the list of supported debugging options by running
418 .Bl -tag -width "warning" -compact
424 non-fatal system errors
432 additional statistical information
434 non-fatal user errors
440 .It Ic nfs_retransmit_counter Xo
441 (numeric, default=110)
446 .Fl t Ar interval.counter
449 Specifies the retransmit counter's value in tenths of seconds.
450 .It Ic nfs_retry_interval Xo
456 .Fl t Ar interval.counter
459 Specifies the interval in tenths of seconds, between NFS/RPC/UDP retries.
461 (string, default to local NIS domain name)
467 Specify an alternative
469 domain from which to fetch the
471 maps. The default is the system domain name. This option is ignored if
473 support is not available.
474 .It Ic normalize_hostnames Xo
475 (boolean, default=no)
483 then the name refereed to by
485 is normalized relative to the host database before being used. The effect is
486 to translate aliases into
490 (string, default to compiled in value)
496 Allows you to override the compiled-in name of the operating
497 system. Useful when the built-in name is not desired for backward
498 compatibility reasons. For example, if the build in name is
500 you can override it to
502 and use older maps which were written with the latter in mind.
504 (string, default to compiled in value)
510 Override the compiled-in version number of the operating
511 system. Useful when the built in version is not desired for backward
512 compatibility reasons. For example, if the build in version is
514 you can override it to
516 and use older maps that were written with the latter in mind.
518 (string, default=/dev/stdout)
520 Specify a file to store the process ID of the running daemon into. If not
523 will print its process id only the standard output. Useful for killing
525 after it had run. Note that the PID of a running
527 can also be retrieved via
529 This file is used only if the
533 (boolean, default=yes)
541 lock the running executable pages of
543 into memory. To improve
545 performance, systems that support the
549 process into memory. This way there is less chance it that the operating
550 system will schedule, page out, and swap the
552 process as needed. This improves
554 performance, at the cost of reserving the memory used by the
557 (making it unavailable for other processes).
558 .It Ic portmap_program Xo
559 (numeric, default=300019)
561 Specify an alternate Port-mapper RPC program number, other than the official
562 number. This is useful when running multiple
564 processes. For example, you can run another
568 mode, without affecting the primary
570 process in any way. For safety reasons, the alternate program numbers that
571 can be specified must be in the range 300019-300029, inclusive.
575 which can be used to specify an alternate program number of an
577 to contact. In this way,
579 can fully control any number of
581 processes running on the same host.
583 (boolean, default=no)
592 will print its process ID upon starting.
593 .It Ic print_version Xo
594 (boolean, default=no)
600 but the version prints and
605 will print its version information string, which includes some configuration
606 and compilation values.
607 .It Ic restart_mounts Xo
608 (boolean, default=no)
617 will scan the mount table to determine which file systems are currently
618 mounted. Whenever one of these would have been auto-mounted,
621 .It Ic selectors_on_default Xo
622 (boolean, default=no)
628 entry of maps will be looked for and process any selectors before setting
629 defaults for all other keys in that map. Useful when you want to set
630 different options for a complete map based on some parameters. For example,
631 you may want to better the
633 performance over slow slip-based networks as
638 wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
639 wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
641 .It Ic show_statfs_entries Xo
642 (boolean, default=no)
646 then all maps which are browsable will also show the number of entries
651 (This is accomplished by returning non-zero values to the
654 .It Ic unmount_on_exit Xo
655 (boolean, default=no)
661 will attempt to unmount all file systems which it knows about. Normally
666 mounted filesystems intact. Note that
668 does not know about file systems mounted before it starts up, unless the
674 .Ss "Parameters applicable to regular map sections"
677 (string, must be specified)
679 Name of the map where the keys are located.
681 (string, default no tag)
683 Each map entry in the configuration file can be tagged. If no tag is
684 specified, that map section will always be processed by
686 If it is specified, then
688 will process the map if the
692 and the value given to that command-line option matches that in the map
698 configuration I use daily.
700 # GLOBAL OPTIONS SECTION
702 normalize_hostnames = no
706 log_file = /var/log/amd
710 selectors_on_default = yes
711 # config.guess picks up "sunos5" and I don't want to edit my maps yet
713 # if you print_version after setting up "os", it will show it.
716 search_path = /etc/amdmaps:/usr/lib/amd:/usr/local/AMD/lib
719 # DEFINE AN AMD MOUNT POINT
733 map_name = amd.import
737 map_name = amd.tftpboot
743 .An Erez Zadok Aq ezk@cs.columbia.edu ,
744 Department of Computer Science, Columbia University, New York, USA.
746 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
747 Department of Computing, Imperial College, London, UK.
749 Other authors and contributers to am-utils are listed in the
751 file distributed with am-utils.
755 utility first appeared in
projects / dragonfly.git / blob