aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/amd.conf.5
blob: 2fa4334b314a8d7ff8d73c504fe7786a084a1b23 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
.\"
.\" Copyright (c) 1997-2014 Erez Zadok
.\" Copyright (c) 1990 Jan-Simon Pendry
.\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Jan-Simon Pendry at Imperial College, London.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"
.\" File: am-utils/scripts/amd.conf.5
.\"
.TH AMD.CONF 5 "7 August 1997"
.SH NAME
amd.conf \- Amd configuration file
.SH SYNOPSIS
.B amd.conf
.SH DESCRIPTION
The
.B amd.conf
file is the configuration file for Amd, as part of the am-utils suite.
.P
.B amd.conf
contains runtime configuration information for the
.B Amd
automounter program.
.\" **************************************************************************
.SH FILE FORMAT
.P
The file consists of sections and parameters.  A section begins with the
name of the section in square brackets and continues until the next section
begins or the end the file is reached.  Sections contain parameters of the
form 'name = value'.
.P
The file is line-based - that is, each newline-terminated line represents
either a comment, a section name or a parameter.  No line-continuation
syntax is available.
.P
Section, parameter names and their values are case sensitive.
.P
Only the first equals sign in a parameter is significant.  Whitespace before
or after the first equals sign is discarded.  Leading, trailing and
internal whitespace in section and parameter names is irrelevant.  Leading
and trailing whitespace in a parameter value is discarded.  Internal
whitespace within a parameter value is not allowed, unless the whole
parameter value is quoted with double quotes as in 'name = "some value"'.
.P
Any line beginning with a pound sign (#) is ignored, as are lines containing
only whitespace.
.P
The values following the equals sign in parameters are all either a string
(no quotes needed if string does not include spaces) or a boolean, which may
be given as yes/no.  Case is significant in all values.  Some items such as
cache timeouts are numeric.
.\" **************************************************************************
.SH SECTIONS
.SS The [global] section
Parameters in this section either apply to Amd as a whole, or to all other
regular map sections which follow.  There should be only one global section
defined in one configuration file.
.P
It is highly recommended that this section be specified first in the
configuration file.  If it is not, then regular map sections which precede
it will not use global values defined later.

.SS Regular [/map] sections
Parameters in regular (non-global) sections apply to a single map entry.
For example, if the map section
.B [/homes]
is defined, then all parameters following it will be applied to the
.I /homes
Amd-managed mount point.
.\" **************************************************************************
.SH PARAMETERS
.SS Parameters common to all sections
These parameters can be specified either in the global or a map specific
section.  Entries specified in a map-specific section override the default
value or one defined in the global section.   If such a common parameter is
specified only in the global section, it is applicable to all regular map
sections that follow.
.\" **************************************************************************
.TP
.BR browsable_dirs " (string, default=no)"
If "yes," then Amd's top-level mount points will be browsable to
.BR readdir (3)
calls.  This means you could run for example
.BR ls (1)
and see what keys are available to mount in that directory.  Not all entries
are made visible to readdir(3): the "/default" entry, wildcard
entries, and those with a "/" in them are not included.  If you specify
"full" to this option, all but "/default" will be visible.
Note that if you run a command which will attempt to
.BR stat (2)
the entries, such as often done by "ls -l" or "ls -F," Amd will attempt to
mount
.I every
entry in that map.  This is often called a ``mount storm.''

.TP
.BR map_defaults " (string, default to empty)"
This option sets a string to be used as the map's /defaults entry,
overriding any /defaults specified in the map.  This allows local users to
override map defaults without modifying maps globally.

.TP
.BR map_options " (string, default no options)"
This option is the same as specifying map options on the command line to
Amd, such as "cache:=all".

.TP
.BR map_type " (string, default search all map types)"
If specified, Amd will initialize the map only for the type given.  This is
useful to avoid the default map search type used by Amd which takes longer
and can have undesired side-effects such as initializing NIS even if not
used.  Possible values are

.nf
\fBexec\fR      executable maps
\fBfile\fR      plain files
\fBhesiod\fR    Hesiod name service from MIT
\fBldap\fR      Lightweight Directory Access Protocol
\fBndbm\fR      (New) dbm style hash files
\fBnis\fR       Network Information Services (version 2)
\fBnisplus\fR   Network Information Services Plus (version 3)
\fBpasswd\fR    local password files
\fBunion\fR     union maps
.fi

.TP
.BR mount_type " (string, default=nfs)"
All Amd mount types default to NFS.  That is, Amd is an NFS server on the
map mount points, for the local host it is running on.  If "autofs" is
specified, Amd will be an autofs server for those mount points.

.TP
.BR autofs_use_lofs " (string, default=yes)"
When set to "yes" and using Autofs, Amd will use lofs-type (loopback) mounts
for type:=link mounts.  This has the advantage of mounting in place, and
users get to the see the same pathname that they chdir'ed into.  If this
option is set to "no," then Amd will use symlinks instead: that code is more
tested, but negates autofs's big advantage of in-place mounts.

.TP
.BR search_path " (string, default no search path)"
This provides a (colon-delimited) search path for file maps.  Using a search
path, sites can allow for local map customizations and overrides, and can
distributed maps in several locations as needed.

.TP
.BR selectors_in_defaults " (boolean, default=no)"
If "yes," then the /defaults entry of maps will search for and process any
selectors before setting defaults for all other keys in that map.  Useful
when you want to set different options for a complete map based on some
parameters.  For example, you may want to better the NFS performance over
slow slip-based networks as follows:

.nf
/defaults \\
    wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
    wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
.fi

Deprecated form: selectors_on_default

.TP
.BR sun_map_syntax " (boolean, default=no)"
If "yes," then Amd will parse the map according to the Sun Automount syntax.

.\" **************************************************************************
.SS Parameters applicable to the global section only

.TP
.BR arch " (string, default to compiled in value)"
Same as the
.B \-A
option to Amd.  Allows you to override the value of the
.I arch
Amd variable.

.TP
.BR auto_attrcache " (numeric, default=0)"
Specify in seconds (or units of 0.1 seconds, depending on the OS), what is
the (kernel-side) NFS attribute cache timeout for @i{Amd}'s own automount
points.  A value of 0 is supposed to turn off attribute caching, meaning
that @i{Amd} will be consulted via a kernel-RPC each time someone stat()'s
the mount point (which could be abused as a denial-of-service attack).
Warning: some OSs are incapable of turning off the NFS attribute cache
reliably.  On such systems, Amd may not work reliably under heavy load.  See
the README.attrcache document in the Am-utils distribution for more details.

.TP
.BR auto_dir " (string, default=/a)"
Same as the
.B \-a
option to Amd.  This sets the private directory where Amd will create
sub-directories for its real mount points.

.TP
.BR cache_duration " (numeric, default=300)"
Same as the
.B \-c
option to Amd.  Sets the duration in seconds that looked-up or mounted map
entries remain in the cache.

.TP
.BR cluster " (string, default no cluster)"
Same as the
.B \-C
option to Amd.  Specifies the alternate HP-UX cluster to use.

.TP
.BR debug_mtab_file " (string, default=/tmp/mnttab)"
Path to mtab file that is used by Amd to store a list of mounted
file systems during debug-mtab mode.  This option only applies
to systems that store mtab information on disk.
.TP

.TP
.BR debug_options " (string, default no debug options)"
Same as the
.B \-D
option to Amd.  Specify any debugging options for Amd.  Works only if
am-utils was configured for debugging using the --enable-debug option.  The
"mem" option, as well as all other options, can be turned on via
--enable-debug=mem.  Otherwise debugging options are ignored.  Options are
comma delimited, and can be preceded by the string "no" to negate their
meaning.  You can get the list of supported debugging options by running Amd
\-H.  Possible values are:

.nf
\fBall\fR       all options (excludes hrtime and mtab)
\fBdefaults\fR  "sensible" default options (all--excluding hrtime, mtab, and xdrtrace)
\fBtest\fR      full debug options plus mtab,nodaemon,nofork,noamq
\fBamq\fR       register for amq
\fBdaemon\fR    enter daemon mode
\fBfork\fR      fork server
\fBfull\fR      program trace
\fBhrtime\fR    print high resolution time stamps (only if syslog(3) is not used)
\fBinfo\fR      info service specific debugging (hesiod, nis, etc.)
\fBmem\fR       trace memory allocations
\fBmtab\fR      use local "/tmp/mtab" file
\fBreaddir\fR   show browsable_dirs progress
\fBstr\fR       debug string munging
\fBtrace\fR     trace protocol and NFS mount arguments
\fBxdrtrace\fR  trace XDR routines
.fi

.TP
.BR dismount_interval " (numeric, default=120)"
Same as the
.B \-w
option to Amd.  Specify in seconds, the time between attempts to dismount
file systems that have exceeded their cached times.

.TP
.BR domain_strip " (boolean, default=yes)"
If "yes," then the domain
name part referred to by ${rhost} is stripped off.  This is
useful to keep logs and smaller.  If "no," then the domain name
part is left changed.  This is useful when using multiple domains with
the same maps (as you may have hosts whose domain-stripped name is
identical).

.TP
.BR exec_map_timeout " (numeric, default=10)"
The timeout in seconds that
.I Amd
will wait for an executable map program before an answer is returned from
that program (or script).  This value should be set to as small as possible
while still allowing normal replies to be returned before the timer expires,
because during the time that the executable map program is queried,
.I Amd
is essentially waiting and is thus not responding to any other queries.

.TP
.BR forced_unmounts " (boolean, default=no)"
If set to "yes," and the client OS supports forced or lazy unmounts, then
.I Amd
will attempt to use them if it gets any of three serious error conditions
when trying to unmount an existing mount point or mount on top of one: EIO,
ESTALE, or EBUSY.

This could be useful to recover from serious conditions such as hardware
failure of mounted disks, or NFS servers which are down permanently, were
migrated, or changed their IP address.  Only "type:=toplvl" mounts hung with
EBUSY are forcibly unmounted using this option, which is useful to recover
from a hung
.IR Amd ).

.TP
.BR full_os " (string, default to compiled in value)"
The full name of the operating system, along with its version.  Allows you
to override the compiled-in full name and version of the operating system.
Useful when the compiled-in name is not desired.  For example, the full
operating system name on linux comes up as ``linux'', but you can override
it to ``linux-2.2.5.''

.TP
.BR fully_qualified_hosts " (string, default=no)"
If "yes,"
.I Amd
will perform RPC authentication using fully-qualified host names.  This is
necessary for some systems, and especially when performing cross-domain
mounting.  For this function to work, the
.I Amd
variable ${hostd} is used, requiring that ${domain} not be null.

.TP
.BR hesiod_base " (string, default=automount)"
Specify the base name for hesiod maps.

.TP
.BR karch " (string, default to karch of the system)"
Same as the
.B \-k
option to Amd.  Allows you to override the kernel-architecture of your
system.  Useful for example on Sun (Sparc) machines, where you can build one
Amd binary, and run it on multiple machines, yet you want each one to get
the correct
.I karch
variable set (for example, sun4c, sun4m, sun4u, etc.)  Note that if not
specified, Amd will use uname(3) to figure out the kernel architecture of
the machine.

.TP
.BR ldap_base " (string, default not set)"
Specify the base name for LDAP.  This often includes LDAP-specific
values such as country and organization.

.TP
.BR ldap_cache_maxmem " (numeric, default=131072)"
Specify the maximum memory Amd should use to cache LDAP entries.

.TP
.BR ldap_cache_seconds " (numeric, default=0)"
Specify the number of seconds to keep entries in the cache.

.TP
.BR ldap_hostports " (string, default not set)"
Specify the LDAP host and port values.

.TP
.BR ldap_proto_version " (numeric, default=2)"
Specify the version of the LDAP protocol to use.

.TP
.BR local_domain " (string, default no sub-domain)"
Same as the
.B \-d
option to Amd.  Specify the local domain name.  If this option is not given
the domain name is determined from the hostname, by removing the first
component of the fully-qualified host name.

.TP
.BR localhost_address " (string, default to localhost or 127.0.0.1)"
Specify the name or IP address for Amd to use when connecting the sockets
for the local NFS server and the RPC server.  This defaults to 127.0.0.1 or
whatever the host reports as its local address.  This parameter is useful on
hosts with multiple addresses where you want to force Amd to connect to a
specific address.

.TP
.BR log_file " (string, default=/dev/stderr)"
Same as the
.B \-l
option to Amd.  Specify a file name to log Amd events to.
If the string
.B /dev/stderr
is specified, Amd will send its events to the standard error file descriptor.
If the string
.B syslog
is given, Amd will record its events with the system logger
.BR syslogd (8).
The default syslog facility used is LOG_DAEMON.  If you
wish to change it, append its name to the log file name, delimited by a
single colon.  For example, if
.I logfile
is the string
.B syslog:local7
then Amd will log messages via
.IR syslog (3)
using the LOG_LOCAL7 facility (if it exists on the system).

.TP
.BR log_options " (string, default=defaults)"
Same as the
.B \-x
option to Amd.  Specify any logging options for Amd.  Options are comma
delimited, and can be preceded by the string "no" to negate their meaning.
The "debug" logging option is only available if am-utils was configured with
--enable-debug.  You can get the list of supported debugging and logging
options by running
.B amd
.BR \-H .
Possible values are:

.nf
\fBall\fR       all messages
\fBdefaults\fR  default messages (fatal,error,user,warning,info)
\fBdebug\fR     debug messages
\fBerror\fR     non-fatal system errors (cannot be turned off)
\fBfatal\fR     fatal errors (cannot be turned off)
\fBinfo\fR      information
\fBmap\fR       map errors
\fBstats\fR     additional statistical information
\fBuser\fR      non-fatal user errors
\fBwarn\fR      warnings
\fBwarning\fR   warnings
.fi

.TP
.BR map_reload_interval " (numeric, default=3600)"
The number of seconds that Amd will wait before it checks to see if any maps
have changed at their source (NIS servers, LDAP servers, files, etc.).  Amd
will reload only those maps that have changed.

.TP
.BR nfs_allow_any_interface " (string, default=no)"
Normally Amd accepts local NFS packets only from 127.0.0.1.  If this
parameter is set to "yes" then Amd will accept local NFS packets from any
local interface; this is useful on hosts that may have multiple interfaces
where the system is forced to send all outgoing packets (even those bound to
the same host) via an address other than 127.0.0.1.

.TP
.BR nfs_allow_insecure_port " (string, default=no)"
Normally Amd will refuse requests coming from unprivileged ports (i.e.
ports >= 1024 on Unix systems), so that only privileged users and the kernel
can send NFS requests to it.  However, some kernels (certain versions of
Darwin, MacOS X, and Linux) have bugs that cause them to use unprivileged
ports in certain situations, which causes Amd to stop dead in its tracks.
This parameter allows Amd to operate normally even on such systems, at the
expense of a slight decrease in the security of its operations.  If you see
messages like "ignoring request from foo:1234, port not reserved" in your
Amd log, try enabling this parameter and give it another go.

.TP
.BR nfs_proto " (string, default to trying version tcp then udp)"
By default, Amd tries TCP and then UDP.  This option forces the overall NFS
protocol used to TCP or UDP.  It overrides what is in the Amd maps, and is
useful when Amd is compiled with NFSv3 support that may not be stable.  With
this option you can turn off the complete usage of NFSv3 dynamically
(without having to recompile Amd) until such time as NFSv3 support is
desired again.

.TP
.BR nfs_retransmit_counter " (numeric, default=11)"
Same as the
.I retransmit
part of the
.BI \-t " timeout.retransmit"
option to Amd.
Specifies the number of NFS retransmissions that the kernel will use to
communicate with Amd.

.TP
.BR nfs_retransmit_counter_udp " (numeric, default=11)"
Same as the
.B nfs_retransmit_counter
option, but for all UDP mounts only.

.TP
.BR nfs_retransmit_counter_tcp " (numeric, default=11)"
Same as the
.B nfs_retransmit_counter
option, but for all TCP mounts only.

.TP
.BR nfs_retransmit_counter_toplvl " (numeric, default=11)"
Same as the
.B nfs_retransmit_counter
option, but only for Amd's top-level UDP mounts.

.TP
.BR nfs_retry_interval " (numeric, default=8)"
Same as the
.I timeout
part of the
.BI \-t " timeout.retransmit"
option to Amd.  Specifies the NFS timeout interval, in
.I tenths
of seconds, between NFS/RPC retries (for UDP and TCP).
This is the value that the kernel will use to
communicate with Amd.

Amd relies on the kernel RPC retransmit mechanism to trigger mount retries.
The values of the
.B nfs_retransmit_counter
and the
.B nfs_retry_interval
parameters change the overall retry interval.  Too long an interval gives
poor interactive response; too short an interval causes excessive retries.

.TP
.BR nfs_retry_interval_udp " (numeric, default=8)"
Same as the
.B nfs_retry_interval
option, but for all UDP mounts only.

.TP
.BR nfs_retry_interval_tcp " (numeric, default=8)"
Same as the
.B nfs_retry_interval
option, but for all TCP mounts only.

.TP
.BR nfs_retry_interval_toplvl " (numeric, default=8)"
Same as the
.B nfs_retry_interval
option, but only for Amd's top-level UDP mounts.

.TP
.BR nfs_vers " (numeric, default to trying version 3 then 2)"
By default, Amd tries version 3 and then version 2.  This option forces the
overall NFS protocol used to version 3 or 2.  It overrides what is in the
Amd maps, and is useful when Amd is compiled with NFSv3 support that may not
be stable.  With this option you can turn off the complete usage of NFSv3
dynamically (without having to recompile Amd) until such time as NFSv3
support is desired again.

.TP
.BR nis_domain " (string, default to local NIS domain name)"
Same as the
.B \-y
option to Amd.  Specify an alternative NIS domain from which to fetch the
NIS maps.  The default is the system domain name.  This option is ignored if
NIS support is not available.

.TP
.BR normalize_hostnames " (boolean, default=no)"
Same as the
.B \-n
option to Amd.  If "yes," then the name refereed to by ${rhost} is
normalized relative to the host database before being used.  The effect is
to translate aliases into ``official'' names.

.TP
.BR normalize_slashes " (boolean, default=yes)"

If "yes," then Amd will condense all multiple ``/'' (slash) characters into
one and remove all trailing slashes.  If "no," then Amd will not touch
strings that may contain repeated or trailing slashes.  The latter is
sometimes useful with SMB mounts, which often require multiple slash
characters in pathnames.

.TP
.BR os " (string, default to compiled in value)"
Same as the
.B \-O
option to Amd.  Allows you to override the compiled-in name of the operating
system.  Useful when the built-in name is not desired for backward
compatibility reasons.  For example, if the build in name is ``sunos5'', you
can override it to ``sos5'', and use older maps which were written with the
latter in mind.

.TP
.BR osver " (string, default to compiled in value)"
Same as the
.B \-o
option to Amd.  Overrides the compiled-in version number of the operating
system.  Useful when the built in version is not desired for backward
compatibility reasons.  For example, if the build in version is ``2.5.1'',
you can override it to ``5.5.1'', and use older maps that were written with
the latter in mind.

.TP
.BR pid_file " (string, default=/dev/stdout)"
Specify a file to store the process ID of the running daemon into.  If not
specified, Amd will print its process id onto the standard output.  Useful
for killing Amd after it had run.  Note that the PID of a running Amd can
also be retrieved via
.B amq
.BR \-p .
This file is used only if the print_pid option is on.

.TP
.BR plock " (boolean, default=yes)"
Same as the
.B \-S
option to Amd.
If "yes," lock the running executable pages of Amd into memory.  To improve
Amd's performance, systems that support the
.BR plock (3)
or
.BR mlockall (2)
call can lock the Amd process into memory.  This way there is less chance it
the operating system will schedule, page out, and swap the Amd process as
needed.  This improves Amd's performance, at the cost of reserving the
memory used by the Amd process (making it unavailable for other processes).

.TP
.BR portmap_program " (numeric, default=300019)"
Specify an alternate Port-mapper RPC program number, other than the official
number.  This is useful when running multiple Amd processes.  For example,
you can run another Amd in "test" mode, without affecting the primary Amd
process in any way.  For safety reasons, the alternate program numbers that
can be specified must be in the range 300019-300029, inclusive.
Amq
has an option
.B -P
which can be used to specify an alternate program number of an Amd to
contact.  In this way, amq can fully control any number of Amd processes
running on the same host.

.TP
.BR preferred_amq_port " (numeric, default=0)"
Specify an alternate Port-mapper RPC port number for Amd's
Amq
service.  This is used for both UDP and TCP.  Setting this value to 0 (or
not defining it) will cause
Amd
to select an arbitrary port number.  Setting the
Amq
RPC service port to a specific number is useful in firewalled or NAT'ed
environments, where you need to know which port
Amd
will listen on.

.TP
.BR print_pid " (boolean, default=no)"
Same as the
.B \-p
option to Amd.  If "yes," Amd will print its process ID upon starting.

.TP
.BR print_version " (boolean, default=no)"
Same as the
.B \-v
option to Amd, but the version prints and Amd continues to run.  If "yes,"
Amd will print its version information string, which includes some
configuration and compilation values.

.TP
.BR restart_mounts " (boolean, default=no)"
Same as the
.B \-r
option to Amd.  If "yes"
Amd
will scan the mount table to determine which file systems are currently
mounted.  Whenever one of these would have been auto-mounted,
Amd
inherits it.

.TP
.BR show_statfs_entries " (boolean), default=no)"
If "yes," then all maps which are browsable will also show the number of
entries (keys) they have when "df" runs. (This is accomplished by returning
non-zero values to the statfs(2) system call).

.TP
.BR truncate_log " (boolean), default=no)"
If "yes," then the log file (if it is a regular file), will be truncated
upon startup.

.TP
.BR unmount_on_exit " (boolean), default=no)"
If "yes," then Amd will attempt to unmount all file systems which it knows
about.  Normally Amd leaves all (esp. NFS) mounted file systems intact.
Note that Amd does not know about file systems mounted before it starts up,
unless the restart_mounts option or
.B \-r
flag are used.

.TP
.BR use_tcpwrappers " (boolean), default=yes)"
If "yes," then Amd will use the tcpd/librwap tcpwrappers library
(if available) to control
access to Amd via the /etc/hosts.allow and /etc/hosts.deny files.

.TP
.BR vendor " (string, default to compiled in value)"
The name of the vendor of the operating system.  Overrides the compiled-in
vendor name.  Useful when the compiled-in name is not desired.  For example,
most Intel based systems set the vendor name to ``unknown'', but you can set
it to ``redhat.''

.\" **************************************************************************
.SS Parameters applicable to regular map sections

.TP
.BR map_name " (string, must be specified)"
Name of the map where the keys are located.

.TP
.BR tag " (string, default no tag)"
Each map entry in the configuration file can be tagged.  If no tag is
specified, that map section will always be processed by Amd.  If it is
specified, then Amd will process the map if the
.B -T
option was given to Amd, and the value given to that command-line option
matches that in the map section.

.\" **************************************************************************
.SH EXAMPLES
Here is a real Amd configuration file I use daily.
.P
.nf
# GLOBAL OPTIONS SECTION
[ global ]
normalize_hostnames =    no
print_pid =              no
restart_mounts =         yes
auto_dir =               /n
log_file =               /var/log/amd
log_options =            all
#debug_options =         all
plock =                  no
selectors_in_defaults =  yes
# config.guess picks up "sunos5" and I don't want to edit my maps yet
os =                     sos5
# if you print_version after setting up "os," it will show it.
print_version =          no
map_type =               file
search_path =            /etc/amdmaps:/usr/lib/amd:/usr/local/AMD/lib
browsable_dirs =         yes

# DEFINE AN AMD MOUNT POINT
[ /u ]
map_name =               amd.u

[ /proj ]
map_name =               amd.proj

[ /src ]
map_name =               amd.src

[ /misc ]
map_name =               amd.misc

[ /import ]
map_name =               amd.import

[ /tftpboot/.amd ]
tag =                    tftpboot
map_name =               amd.tftpboot
.fi
.\" **************************************************************************
.SH "SEE ALSO"
.BR amd (8),
.BR amq (8),
.BR ctl-amd (8),
.BR automount (8),
.BR hosts_access (5).
.LP
``am-utils''
.BR info (1)
entry.
.LP
.I "Linux NFS and Automounter Administration"
by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001).
.LP
.I http://www.am-utils.org
.LP
.I "Amd \- The 4.4 BSD Automounter"
.SH AUTHORS
Erez Zadok <ezk@cs.sunysb.edu>, Computer Science Department, Stony Brook
University, Stony Brook, New York, USA.
.P
Other authors and contributors to am-utils are listed in the
.B AUTHORS
file distributed with am-utils.