1.\"
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.
7.\"
8.\" This code is derived from software contributed to Berkeley by
9.\" Jan-Simon Pendry at Imperial College, London.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
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.
26.\"
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
37.\" SUCH DAMAGE.
38.\"
39.\" %W% (Berkeley) %G%
40.\"
41.\" $Id: amd.conf.5,v 1.3 1999/03/30 17:23:08 ezk Exp $
| 1.\"
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.
7.\"
8.\" This code is derived from software contributed to Berkeley by
9.\" Jan-Simon Pendry at Imperial College, London.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
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.
26.\"
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
37.\" SUCH DAMAGE.
38.\"
39.\" %W% (Berkeley) %G%
40.\"
41.\" $Id: amd.conf.5,v 1.3 1999/03/30 17:23:08 ezk Exp $
|
43.\"
44.Dd April 7, 1997
45.Dt AMD.CONF 5
46.Os
47.Sh NAME
48.Nm amd.conf
49.Nd amd configuration file
50.Sh SYNOPSIS
51.Nm
52.Sh DESCRIPTION
53The
54.Nm
55file is the configuration file for amd, as part of the am-utils suite.
56.Pp
57.Nm
58contains runtime configuration information for the
59.Xr amd 8
60automounter program.
61.Sh FILE FORMAT
62The file consists of sections and parameters. A section begins with the
63name of the section in square brackets and continues until the next section
64begins or the end of the file is reached. Sections contain parameters of
65the form
66.Sq name = value .
67.Pp
68The file is line-based - that is, each newline-terminated line represents
69either a comment, a section name or a parameter. No line-continuation
70syntax is available.
71.Pp
72Section, parameter names and their values are case sensitive.
73.Pp
74Only the first equals sign in a parameter is significant. Whitespace before
75or after the first equals sign is discarded. Leading, trailing and
76internal whitespace in section and parameter names is irrelevant. Leading
77and trailing whitespace in a parameter value is discarded. Internal
78whitespace within a parameter value is not allowed, unless the whole
79parameter value is quoted with double quotes as in
80.Sq name = Qq some\ value .
81.Pp
82Any line beginning with a pound sign (#) is ignored, as are lines containing
83only whitespace.
84.Pp
85The 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
87be given as yes/no. Case is significant in all values. Some items such as
88cache timeouts are numeric.
89.Sh SECTIONS
90.Ss "The [global] section"
91Parameters in this section either apply to
92.Nm amd
93as a whole, or to all other regular map sections which follow. There
94should be only one global section defined in one configuration file.
95.Pp
96It is highly recommended that this section be specified first in the
97configuration file. If it is not, then regular map sections which precede
98it will not use global values defined later.
99.Ss "Regular [/map] sections"
100Parameters in regular (non-global) sections apply to a single map entry.
101For example, if the map section
102.Bq Pa /homes
103is defined, then all parameters following it will be applied to the
104.Pa /homes
105amd-managed mount point.
106.Sh PARAMETERS
107.Ss "Parameters common to all sections"
108These parameters can be specified either in the global or a map specific
109section. Entries specified in a map-specific section override the default
110value or one defined in the global section. If such a common parameter is
111specified only in the global section, it is applicable to all regular map
112sections that follow.
113.Bl -tag -width 4n
114.It Ic browsable_dirs Xo
115(string, default=no)
116.Xc
117If
118.Qq yes ,
119then amd's top-level mount points will be browsable to
120.Xr readdir 3
121calls. This means you could run for example
122.Xr ls 1
123and see what keys are available to mount in that directory. Not all entries
124are made visible to
125.Xr readdir 3 :
126the
127.Qq Pa /default
128entry, wildcardentries, and those with a
129.Qq Pa /
130in them are not included. If you specify
131.Qq full
132to this option, all but
133.Qq Pa /default
134will be visible. Note that if you run a command which will attempt to
135.Xr stat 2
136the entries, such as often done by
137.Qq ls -l
138or
139.Qq ls -F ,
140.Nm amd
141will attempt to mount
142.Em every
143entry in that map. This is often called a
144.Em mount storm .
145.It Ic map_options Xo
146(string, default no options)
147.Xc
148This option is the same as specifying map options on the command line to
149.Nm amd ,
150such as
151.Ql cache\&:\&=all .
152.It Ic map_type Xo
153(string, default search all map types)
154.Xc
155If specified, amd will initialize the map only for the type given.
156This is useful to avoid the default map search type used by amd which
157takes longer and can have undesired side-effects such as initializing
158NIS even if not used. Possible values are:
159.Pp
160.Bl -tag -width "nisplus" -compact
161.It Ic file
162plain files
163.It Ic hesiod
164Hesiod name service from MIT
165.It Ic ldap
166Lightweight Directory Access Protocol
167.It Ic ndbm
168(New) dbm style hash files
169.It Ic nis
170Network Information Services (version 2)
171.It Ic nisplus
172Network Information Services Plus (version 3)
173.It Ic passwd
174local password files
175.It Ic union
176union maps
177.El
178.It Ic mount_type Xo
179(string, default=nfs)
180.Xc
181All amd mount types default to
182.Tn NFS .
183That is,
184.Nm amd
185is an
186.Tn NFS
187server on the map mount points, for the local host it is running on. If
188.Qq autofs
189is specified, amd will be an autofs server for those mount points.
190.It Ic search_path Xo
191(string, default no search path)
192.Xc
193This provides a
194(colon-delimited)
195search path for file maps. Using a search path, sites can allow for
196local map customizations and overrides, and can distributed maps in
197several locations as needed.
198.El
199.Ss "Parameters applicable to the global section only"
200.Bl -tag -width 4n
201.It Ic arch Xo
202(string, default to compiled in value)
203.Xc
204Allows you to override the value of the
205.Va arch
206.Nm amd
207variable.
208.It Ic auto_dir Xo
209(string, default=/a)
210.Xc
211Same as the
212.Fl a
213option to
214.Nm amd .
215This sets the private directory where amd will create sub-directories for its
216real mount points.
217.It Ic cache_duration Xo
218(numeric, default=300)
219.Xc
220Same as the
221.Fl c
222option to
223.Nm amd .
224Sets the duration in seconds that looked up map entries remain in the cache.
225.It Ic cluster Xo
226(string, default no cluster)
227.Xc
228Same as the
229.Fl C
230option to
231.Nm amd .
232Specifies the alternate
233.Tn HP-UX
234cluster to use.
235.It Ic debug_options Xo
236(string, default no debug options)
237.Xc
238Same as the
239.Fl D
240option to
241.Nm amd .
242Specify any debugging options for
243.Nm amd .
244Works only if am-utils was configured for debugging using the
245.Fl -enable-debug
246option.
247The
248.Qq mem
249option alone can be turned on via
250.Fl -enable-debug Ns = Ns Ic mem .
251Otherwise debugging options are ignored. Options are comma delimited, and can
252be preceded by the string
253.Qq no
254to negate their meaning. You can get the list of supported debugging options
255by running
256.Nm amd Fl v .
257Possible values are:
258.Pp
259.Bl -tag -width "daemon" -compact
260.It Ic all
261all options
262.It Ic amq
263register for
264.Xr amq 8
265.It Ic daemon
266enter daemon mode
267.It Ic fork
268fork server
269.It Ic full
270program trace
271.It Ic info
272info service specific debugging
273(hesiod, nis, etc.)
274.It mem
275trace memory allocations
276.It Ic mtab
277use local
278.Pa ./mtab
279file
280.It Ic str
281debug string munging
282.It Ic test
283full debug but no daemon
284.It Ic trace
285protocol trace
286.El
287.It Ic dismount_interval Xo
288(numeric, default=120)
289.Xc
290Same as the
291.Fl w
292option to
293.Nm amd .
294Specify, in seconds, the time between attempts to dismount file systems that
295have exceeded their cached times.
296.It Ic fully_qualified_hosts Xo
297(string, default=no)
298.Xc
299If
300.Qq yes ,
301.Nm Amd
302will perform RPC authentication using fully-qualified host names. This is
303necessary for some systems, and especially when performing cross-domain
304mounting. For this function to work, the
305.Nm amd
306variable
307.Va ${hostd}
308is used, requiring that
309.Va ${domain}
310not be null.
311.It Ic hesiod_base Xo
312(string, default=automount)
313.Xc
314Specify the base name for hesiod maps.
315.It Ic karch Xo
316(string, default to karch of the system)
317.Xc
318Same as the
319.Fl k
320option to
321.Nm amd .
322Allows you to override the kernel-architecture of your system. Useful for
323example on Sun
324(Sparc)
325machines, where you can build one
326.Nm amd
327binary and run it on multiple machines, yet you want each one to get the
328correct
329.Va karch
330variable set
331(for example, sun4c, sun4m, sun4u, etc.)
332Note that if not
333specified,
334.Nm amd
335will use
336.Xr uname 3
337to figure out the kernel architecture of the machine.
338.It Ic ldap_base Xo
339(string, default not set)
340.Xc
341Specify the base name for LDAP.
342.It Ic ldap_cache_maxmem Xo
343(numeric, default=131072)
344.Xc
345Specify the maximum memory amd should use to cache LDAP entries.
346.It Ic ldap_cache_seconds Xo
347(numeric, default=0)
348.Xc
349Specify the number of seconds to keep entries in the cache.
350.It Ic ldap_hostports Xo
351(string, default not set)
352.Xc
353Specify LDAP-specific values such as country and organization.
354.It Ic local_domain Xo
355(string, default no sub-domain)
356.Xc
357Same as the
358.Fl d
359option to
360.Nm amd .
361Specify the local domain name. If this option is not given the domain name is
362determined from the hostname by removing the first component of the
363fully-qualified host name.
364.It Ic log_file Xo
365(string, default=/dev/stderr)
366.Xc
367Same as the
368.Fl l
369option to
370.Nm amd .
371Specify a file name to log
372.Nm amd
373events to. If the string
374.Pa /dev/stderr
375is specified,
376.Nm amd
377will send its events to the standard error file descriptor. IF the string
378.Pa syslog
379is given,
380.Nm amd
381will record its events with the system logger
382.Xr syslogd 8 .
383The default syslog facility used is
384.Ev LOG_DAEMON .
385If you wish to change it, append its name to the log file name, delimited by a
386single colon. For example, if
387.Pa logfile
388is the string
389.Qq syslog:local7
390then
391.Nm amd
392will log messages via
393.Xr syslog 3
394using the
395.Ev LOG_LOCAL7
396facility
397(if it exists on the system).
398.It Ic log_options Xo
399(string, default no logging options)
400.Xc
401Same as the
402.Fl x
403option to
404.Nm amd .
405Specify any logging options for
406.Nm amd .
407Options are comma delimited, and can be preceded by the string
408.Dq no
409to negate their meaning. The
410.Dq debug
411logging option is only available if am-utils was configured with
412.Fl -enable-debug .
413You can get the list of supported debugging options by running
414.Nm amd Fl v .
415Possible values are:
416.Pp
417.Bl -tag -width "warning" -compact
418.It Ic all
419all messages
420.It Ic debug
421debug messages
422.It Ic error
423non-fatal system errors
424.It Ic fatal
425fatal errors
426.It Ic info
427information
428.It Ic map
429map errors
430.It Ic stats
431additional statistical information
432.It Ic user
433non-fatal user errors
434.It Ic warn
435warnings
436.It Ic warning
437warnings
438.El
439.It Ic nfs_retransmit_counter Xo
440(numeric, default=110)
441.Xc
442Same as the
443.Ic counter
444part of the
445.Fl t Ar interval.counter
446option to
447.Nm amd .
448Specifies the retransmit counter's value in tenths of seconds.
449.It Ic nfs_retry_interval Xo
450(numeric, default=8)
451.Xc
452Same as the
453.Ic interval
454part of the
455.Fl t Ar interval.counter
456option to
457.Nm amd .
458Specifies the interval in tenths of seconds, between NFS/RPC/UDP retries.
459.It Ic nis_domain Xo
460(string, default to local NIS domain name)
461.Xc
462Same as the
463.Fl y
464option to
465.Nm amd .
466Specify an alternative
467.Tn NIS
468domain from which to fetch the
469.Tn NIS
470maps. The default is the system domain name. This option is ignored if
471.Tn NIS
472support is not available.
473.It Ic normalize_hostnames Xo
474(boolean, default=no)
475.Xc
476Same as the
477.Fl n
478option to
479.Nm amd .
480If
481.Dq yes ,
482then the name refereed to by
483.Va ${rhost}
484is normalized relative to the host database before being used. The effect is
485to translate aliases into
486.Qq official
487names.
488.It Ic os Xo
489(string, default to compiled in value)
490.Xc
491Same as the
492.Fl O
493option to
494.Nm amd .
495Allows you to override the compiled-in name of the operating
496system. Useful when the built-in name is not desired for backward
497compatibility reasons. For example, if the build in name is
498.Dq sunos5 ,
499you can override it to
500.Dq sos5 ,
501and use older maps which were written with the latter in mind.
502.It Ic osver Xo
503(string, default to compiled in value)
504.Xc
505Same as the
506.Fl o
507option to
508.Nm amd .
509Override the compiled-in version number of the operating
510system. Useful when the built in version is not desired for backward
511compatibility reasons. For example, if the build in version is
512.Dq 2.5.1 ,
513you can override it to
514.Dq 5.5.1 ,
515and use older maps that were written with the latter in mind.
516.It Ic pid_file Xo
517(string, default=/dev/stdout)
518.Xc
519Specify a file to store the process ID of the running daemon into. If not
520specified,
521.Nm amd
522will print its process id only the standard output. Useful for killing
523.Nm amd
524after it had run. Note that the PID of a running
525.Nm amd
526can also be retrieved via
527.Nm amq Fl p .
528This file is used only if the
529.Ar print_pid
530option is on.
531.It Ic plock Xo
532(boolean, default=yes)
533.Xc
534Same as the
535.Fl S
536option to
537.Nm amd .
538If
539.Dq yes ,
540lock the running executable pages of
541.Nm amd
542into memory. To improve
543.Nm amd Ns 's
544performance, systems that support the
545.Xr plock 3
546call can lock the
547.Nm amd
548process into memory. This way there is less chance it that the operating
549system will schedule, page out, and swap the
550.Nm amd
551process as needed. This improves
552.Nm amd Ns 's
553performance, at the cost of reserving the memory used by the
554.Nm amd
555process
556(making it unavailable for other processes).
557.It Ic portmap_program Xo
558(numeric, default=300019)
559.Xc
560Specify an alternate Port-mapper RPC program number, other than the official
561number. This is useful when running multiple
562.Nm amd
563processes. For example, you can run another
564.Nm amd
565in
566.Dq test
567mode, without affecting the primary
568.Nm amd
569process in any way. For safety reasons, the alternate program numbers that
570can be specified must be in the range 300019-300029, inclusive.
571.Nm amq
572has an option
573.Fl P
574which can be used to specify an alternate program number of an
575.Nm amd
576to contact. In this way,
577.Nm amq
578can fully control any number of
579.Nm amd
580processes running on the same host.
581.It Ic print_pid Xo
582(boolean, default=no)
583.Xc
584Same as the
585.Fl p
586option to
587.Nm amd .
588If
589.Dq yes ,
590.Nm amd
591will print its process ID upon starting.
592.It Ic print_version Xo
593(boolean, default=no)
594.Xc
595Same as the
596.Fl v
597option to
598.Nm amd ,
599but the version prints and
600.Nm amd
601continues to run. If
602.Dq yes ,
603.Nm amd
604will print its version information string, which includes some configuration
605and compilation values.
606.It Ic restart_mounts Xo
607(boolean, default=no)
608.Xc
609Same as the
610.Fl r
611option to
612.Nm amd .
613If
614.Dq yes ,
615.Nm amd
616will scan the mount table to determine which file systems are currently
617mounted. Whenever one of these would have been auto-mounted,
618.Nm amd
619inherits it.
620.It Ic selectors_on_default Xo
621(boolean, default=no)
622.Xc
623If
624.Dq yes ,
625then the
626.Pa /default
627entry of maps will be looked for and process any selectors before setting
628defaults for all other keys in that map. Useful when you want to set
629different options for a complete map based on some parameters. For example,
630you may want to better the
631.Tn NFS
632performance over slow slip-based networks as
633follows:
634.Pp
635.Bd -literal
636/defaults \\
637 wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
638 wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
639.Ed
640.It Ic show_statfs_entries Xo
641(boolean, default=no)
642.Xc
643If
644.Dq yes ,
645then all maps which are browsable will also show the number of entries
646(keys)
647they have when
648.Qq df
649runs.
650(This is accomplished by returning non-zero values to the
651.Xr statfs 2
652system call.)
653.It Ic unmount_on_exit Xo
654(boolean, default=no)
655.Xc
656If
657.Dq yes ,
658then
659.Nm amd
660will attempt to unmount all file systems which it knows about. Normally
661.Nm amd
662leaves all
663(esp.\&)
664.Tn NFS
| 43.\"
44.Dd April 7, 1997
45.Dt AMD.CONF 5
46.Os
47.Sh NAME
48.Nm amd.conf
49.Nd amd configuration file
50.Sh SYNOPSIS
51.Nm
52.Sh DESCRIPTION
53The
54.Nm
55file is the configuration file for amd, as part of the am-utils suite.
56.Pp
57.Nm
58contains runtime configuration information for the
59.Xr amd 8
60automounter program.
61.Sh FILE FORMAT
62The file consists of sections and parameters. A section begins with the
63name of the section in square brackets and continues until the next section
64begins or the end of the file is reached. Sections contain parameters of
65the form
66.Sq name = value .
67.Pp
68The file is line-based - that is, each newline-terminated line represents
69either a comment, a section name or a parameter. No line-continuation
70syntax is available.
71.Pp
72Section, parameter names and their values are case sensitive.
73.Pp
74Only the first equals sign in a parameter is significant. Whitespace before
75or after the first equals sign is discarded. Leading, trailing and
76internal whitespace in section and parameter names is irrelevant. Leading
77and trailing whitespace in a parameter value is discarded. Internal
78whitespace within a parameter value is not allowed, unless the whole
79parameter value is quoted with double quotes as in
80.Sq name = Qq some\ value .
81.Pp
82Any line beginning with a pound sign (#) is ignored, as are lines containing
83only whitespace.
84.Pp
85The 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
87be given as yes/no. Case is significant in all values. Some items such as
88cache timeouts are numeric.
89.Sh SECTIONS
90.Ss "The [global] section"
91Parameters in this section either apply to
92.Nm amd
93as a whole, or to all other regular map sections which follow. There
94should be only one global section defined in one configuration file.
95.Pp
96It is highly recommended that this section be specified first in the
97configuration file. If it is not, then regular map sections which precede
98it will not use global values defined later.
99.Ss "Regular [/map] sections"
100Parameters in regular (non-global) sections apply to a single map entry.
101For example, if the map section
102.Bq Pa /homes
103is defined, then all parameters following it will be applied to the
104.Pa /homes
105amd-managed mount point.
106.Sh PARAMETERS
107.Ss "Parameters common to all sections"
108These parameters can be specified either in the global or a map specific
109section. Entries specified in a map-specific section override the default
110value or one defined in the global section. If such a common parameter is
111specified only in the global section, it is applicable to all regular map
112sections that follow.
113.Bl -tag -width 4n
114.It Ic browsable_dirs Xo
115(string, default=no)
116.Xc
117If
118.Qq yes ,
119then amd's top-level mount points will be browsable to
120.Xr readdir 3
121calls. This means you could run for example
122.Xr ls 1
123and see what keys are available to mount in that directory. Not all entries
124are made visible to
125.Xr readdir 3 :
126the
127.Qq Pa /default
128entry, wildcardentries, and those with a
129.Qq Pa /
130in them are not included. If you specify
131.Qq full
132to this option, all but
133.Qq Pa /default
134will be visible. Note that if you run a command which will attempt to
135.Xr stat 2
136the entries, such as often done by
137.Qq ls -l
138or
139.Qq ls -F ,
140.Nm amd
141will attempt to mount
142.Em every
143entry in that map. This is often called a
144.Em mount storm .
145.It Ic map_options Xo
146(string, default no options)
147.Xc
148This option is the same as specifying map options on the command line to
149.Nm amd ,
150such as
151.Ql cache\&:\&=all .
152.It Ic map_type Xo
153(string, default search all map types)
154.Xc
155If specified, amd will initialize the map only for the type given.
156This is useful to avoid the default map search type used by amd which
157takes longer and can have undesired side-effects such as initializing
158NIS even if not used. Possible values are:
159.Pp
160.Bl -tag -width "nisplus" -compact
161.It Ic file
162plain files
163.It Ic hesiod
164Hesiod name service from MIT
165.It Ic ldap
166Lightweight Directory Access Protocol
167.It Ic ndbm
168(New) dbm style hash files
169.It Ic nis
170Network Information Services (version 2)
171.It Ic nisplus
172Network Information Services Plus (version 3)
173.It Ic passwd
174local password files
175.It Ic union
176union maps
177.El
178.It Ic mount_type Xo
179(string, default=nfs)
180.Xc
181All amd mount types default to
182.Tn NFS .
183That is,
184.Nm amd
185is an
186.Tn NFS
187server on the map mount points, for the local host it is running on. If
188.Qq autofs
189is specified, amd will be an autofs server for those mount points.
190.It Ic search_path Xo
191(string, default no search path)
192.Xc
193This provides a
194(colon-delimited)
195search path for file maps. Using a search path, sites can allow for
196local map customizations and overrides, and can distributed maps in
197several locations as needed.
198.El
199.Ss "Parameters applicable to the global section only"
200.Bl -tag -width 4n
201.It Ic arch Xo
202(string, default to compiled in value)
203.Xc
204Allows you to override the value of the
205.Va arch
206.Nm amd
207variable.
208.It Ic auto_dir Xo
209(string, default=/a)
210.Xc
211Same as the
212.Fl a
213option to
214.Nm amd .
215This sets the private directory where amd will create sub-directories for its
216real mount points.
217.It Ic cache_duration Xo
218(numeric, default=300)
219.Xc
220Same as the
221.Fl c
222option to
223.Nm amd .
224Sets the duration in seconds that looked up map entries remain in the cache.
225.It Ic cluster Xo
226(string, default no cluster)
227.Xc
228Same as the
229.Fl C
230option to
231.Nm amd .
232Specifies the alternate
233.Tn HP-UX
234cluster to use.
235.It Ic debug_options Xo
236(string, default no debug options)
237.Xc
238Same as the
239.Fl D
240option to
241.Nm amd .
242Specify any debugging options for
243.Nm amd .
244Works only if am-utils was configured for debugging using the
245.Fl -enable-debug
246option.
247The
248.Qq mem
249option alone can be turned on via
250.Fl -enable-debug Ns = Ns Ic mem .
251Otherwise debugging options are ignored. Options are comma delimited, and can
252be preceded by the string
253.Qq no
254to negate their meaning. You can get the list of supported debugging options
255by running
256.Nm amd Fl v .
257Possible values are:
258.Pp
259.Bl -tag -width "daemon" -compact
260.It Ic all
261all options
262.It Ic amq
263register for
264.Xr amq 8
265.It Ic daemon
266enter daemon mode
267.It Ic fork
268fork server
269.It Ic full
270program trace
271.It Ic info
272info service specific debugging
273(hesiod, nis, etc.)
274.It mem
275trace memory allocations
276.It Ic mtab
277use local
278.Pa ./mtab
279file
280.It Ic str
281debug string munging
282.It Ic test
283full debug but no daemon
284.It Ic trace
285protocol trace
286.El
287.It Ic dismount_interval Xo
288(numeric, default=120)
289.Xc
290Same as the
291.Fl w
292option to
293.Nm amd .
294Specify, in seconds, the time between attempts to dismount file systems that
295have exceeded their cached times.
296.It Ic fully_qualified_hosts Xo
297(string, default=no)
298.Xc
299If
300.Qq yes ,
301.Nm Amd
302will perform RPC authentication using fully-qualified host names. This is
303necessary for some systems, and especially when performing cross-domain
304mounting. For this function to work, the
305.Nm amd
306variable
307.Va ${hostd}
308is used, requiring that
309.Va ${domain}
310not be null.
311.It Ic hesiod_base Xo
312(string, default=automount)
313.Xc
314Specify the base name for hesiod maps.
315.It Ic karch Xo
316(string, default to karch of the system)
317.Xc
318Same as the
319.Fl k
320option to
321.Nm amd .
322Allows you to override the kernel-architecture of your system. Useful for
323example on Sun
324(Sparc)
325machines, where you can build one
326.Nm amd
327binary and run it on multiple machines, yet you want each one to get the
328correct
329.Va karch
330variable set
331(for example, sun4c, sun4m, sun4u, etc.)
332Note that if not
333specified,
334.Nm amd
335will use
336.Xr uname 3
337to figure out the kernel architecture of the machine.
338.It Ic ldap_base Xo
339(string, default not set)
340.Xc
341Specify the base name for LDAP.
342.It Ic ldap_cache_maxmem Xo
343(numeric, default=131072)
344.Xc
345Specify the maximum memory amd should use to cache LDAP entries.
346.It Ic ldap_cache_seconds Xo
347(numeric, default=0)
348.Xc
349Specify the number of seconds to keep entries in the cache.
350.It Ic ldap_hostports Xo
351(string, default not set)
352.Xc
353Specify LDAP-specific values such as country and organization.
354.It Ic local_domain Xo
355(string, default no sub-domain)
356.Xc
357Same as the
358.Fl d
359option to
360.Nm amd .
361Specify the local domain name. If this option is not given the domain name is
362determined from the hostname by removing the first component of the
363fully-qualified host name.
364.It Ic log_file Xo
365(string, default=/dev/stderr)
366.Xc
367Same as the
368.Fl l
369option to
370.Nm amd .
371Specify a file name to log
372.Nm amd
373events to. If the string
374.Pa /dev/stderr
375is specified,
376.Nm amd
377will send its events to the standard error file descriptor. IF the string
378.Pa syslog
379is given,
380.Nm amd
381will record its events with the system logger
382.Xr syslogd 8 .
383The default syslog facility used is
384.Ev LOG_DAEMON .
385If you wish to change it, append its name to the log file name, delimited by a
386single colon. For example, if
387.Pa logfile
388is the string
389.Qq syslog:local7
390then
391.Nm amd
392will log messages via
393.Xr syslog 3
394using the
395.Ev LOG_LOCAL7
396facility
397(if it exists on the system).
398.It Ic log_options Xo
399(string, default no logging options)
400.Xc
401Same as the
402.Fl x
403option to
404.Nm amd .
405Specify any logging options for
406.Nm amd .
407Options are comma delimited, and can be preceded by the string
408.Dq no
409to negate their meaning. The
410.Dq debug
411logging option is only available if am-utils was configured with
412.Fl -enable-debug .
413You can get the list of supported debugging options by running
414.Nm amd Fl v .
415Possible values are:
416.Pp
417.Bl -tag -width "warning" -compact
418.It Ic all
419all messages
420.It Ic debug
421debug messages
422.It Ic error
423non-fatal system errors
424.It Ic fatal
425fatal errors
426.It Ic info
427information
428.It Ic map
429map errors
430.It Ic stats
431additional statistical information
432.It Ic user
433non-fatal user errors
434.It Ic warn
435warnings
436.It Ic warning
437warnings
438.El
439.It Ic nfs_retransmit_counter Xo
440(numeric, default=110)
441.Xc
442Same as the
443.Ic counter
444part of the
445.Fl t Ar interval.counter
446option to
447.Nm amd .
448Specifies the retransmit counter's value in tenths of seconds.
449.It Ic nfs_retry_interval Xo
450(numeric, default=8)
451.Xc
452Same as the
453.Ic interval
454part of the
455.Fl t Ar interval.counter
456option to
457.Nm amd .
458Specifies the interval in tenths of seconds, between NFS/RPC/UDP retries.
459.It Ic nis_domain Xo
460(string, default to local NIS domain name)
461.Xc
462Same as the
463.Fl y
464option to
465.Nm amd .
466Specify an alternative
467.Tn NIS
468domain from which to fetch the
469.Tn NIS
470maps. The default is the system domain name. This option is ignored if
471.Tn NIS
472support is not available.
473.It Ic normalize_hostnames Xo
474(boolean, default=no)
475.Xc
476Same as the
477.Fl n
478option to
479.Nm amd .
480If
481.Dq yes ,
482then the name refereed to by
483.Va ${rhost}
484is normalized relative to the host database before being used. The effect is
485to translate aliases into
486.Qq official
487names.
488.It Ic os Xo
489(string, default to compiled in value)
490.Xc
491Same as the
492.Fl O
493option to
494.Nm amd .
495Allows you to override the compiled-in name of the operating
496system. Useful when the built-in name is not desired for backward
497compatibility reasons. For example, if the build in name is
498.Dq sunos5 ,
499you can override it to
500.Dq sos5 ,
501and use older maps which were written with the latter in mind.
502.It Ic osver Xo
503(string, default to compiled in value)
504.Xc
505Same as the
506.Fl o
507option to
508.Nm amd .
509Override the compiled-in version number of the operating
510system. Useful when the built in version is not desired for backward
511compatibility reasons. For example, if the build in version is
512.Dq 2.5.1 ,
513you can override it to
514.Dq 5.5.1 ,
515and use older maps that were written with the latter in mind.
516.It Ic pid_file Xo
517(string, default=/dev/stdout)
518.Xc
519Specify a file to store the process ID of the running daemon into. If not
520specified,
521.Nm amd
522will print its process id only the standard output. Useful for killing
523.Nm amd
524after it had run. Note that the PID of a running
525.Nm amd
526can also be retrieved via
527.Nm amq Fl p .
528This file is used only if the
529.Ar print_pid
530option is on.
531.It Ic plock Xo
532(boolean, default=yes)
533.Xc
534Same as the
535.Fl S
536option to
537.Nm amd .
538If
539.Dq yes ,
540lock the running executable pages of
541.Nm amd
542into memory. To improve
543.Nm amd Ns 's
544performance, systems that support the
545.Xr plock 3
546call can lock the
547.Nm amd
548process into memory. This way there is less chance it that the operating
549system will schedule, page out, and swap the
550.Nm amd
551process as needed. This improves
552.Nm amd Ns 's
553performance, at the cost of reserving the memory used by the
554.Nm amd
555process
556(making it unavailable for other processes).
557.It Ic portmap_program Xo
558(numeric, default=300019)
559.Xc
560Specify an alternate Port-mapper RPC program number, other than the official
561number. This is useful when running multiple
562.Nm amd
563processes. For example, you can run another
564.Nm amd
565in
566.Dq test
567mode, without affecting the primary
568.Nm amd
569process in any way. For safety reasons, the alternate program numbers that
570can be specified must be in the range 300019-300029, inclusive.
571.Nm amq
572has an option
573.Fl P
574which can be used to specify an alternate program number of an
575.Nm amd
576to contact. In this way,
577.Nm amq
578can fully control any number of
579.Nm amd
580processes running on the same host.
581.It Ic print_pid Xo
582(boolean, default=no)
583.Xc
584Same as the
585.Fl p
586option to
587.Nm amd .
588If
589.Dq yes ,
590.Nm amd
591will print its process ID upon starting.
592.It Ic print_version Xo
593(boolean, default=no)
594.Xc
595Same as the
596.Fl v
597option to
598.Nm amd ,
599but the version prints and
600.Nm amd
601continues to run. If
602.Dq yes ,
603.Nm amd
604will print its version information string, which includes some configuration
605and compilation values.
606.It Ic restart_mounts Xo
607(boolean, default=no)
608.Xc
609Same as the
610.Fl r
611option to
612.Nm amd .
613If
614.Dq yes ,
615.Nm amd
616will scan the mount table to determine which file systems are currently
617mounted. Whenever one of these would have been auto-mounted,
618.Nm amd
619inherits it.
620.It Ic selectors_on_default Xo
621(boolean, default=no)
622.Xc
623If
624.Dq yes ,
625then the
626.Pa /default
627entry of maps will be looked for and process any selectors before setting
628defaults for all other keys in that map. Useful when you want to set
629different options for a complete map based on some parameters. For example,
630you may want to better the
631.Tn NFS
632performance over slow slip-based networks as
633follows:
634.Pp
635.Bd -literal
636/defaults \\
637 wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
638 wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
639.Ed
640.It Ic show_statfs_entries Xo
641(boolean, default=no)
642.Xc
643If
644.Dq yes ,
645then all maps which are browsable will also show the number of entries
646(keys)
647they have when
648.Qq df
649runs.
650(This is accomplished by returning non-zero values to the
651.Xr statfs 2
652system call.)
653.It Ic unmount_on_exit Xo
654(boolean, default=no)
655.Xc
656If
657.Dq yes ,
658then
659.Nm amd
660will attempt to unmount all file systems which it knows about. Normally
661.Nm amd
662leaves all
663(esp.\&)
664.Tn NFS
|