View | Details | Raw Unified | Return to bug 57926
Collapse All | Expand All

(-)amd.conf.5 (-122 / +230 lines)
Lines 121-176 Link Here
121
calls.  This means you could run for example
121
calls.  This means you could run for example
122
.Xr ls 1
122
.Xr ls 1
123
and see what keys are available to mount in that directory.  Not all entries
123
and see what keys are available to mount in that directory.  Not all entries
124
are made visible to readdir(3): the "/default" entry, wildcard
124
are made visible to
125
entries, and those with a "/" in them are not included.  If you specify
125
.Xr readdir 3 :
126
"full" to this option, all but "/default" will be visible.
126
the
127
.Qq Pa /default
128
entry, wildcard entries, and those with a
129
.Qq Pa /
130
in them are not included.
131
If you specify
132
.Qq full
133
to this option, all but
134
.Qq Pa /default
135
will be visible.
127
Note that if you run a command which will attempt to
136
Note that if you run a command which will attempt to
128
.BR stat (2)
137
.Xr stat 2
129
the entries, such as often done by "ls -l" or "ls -F", amd will attempt to
138
the entries, such as often done by
130
mount
139
.Qq ls -l
131
.I every
140
or
132
entry in that map.  This is often called a ``mount storm''.
141
.Qq ls -F ,
133
142
.Nm amd
134
.TP
143
will attempt to mount
135
.BR map_options " (string, default no options)"
144
.Em every
145
entry in that map.
146
This is often called a
147
.Em mount storm .
148
.It Ic map_options Xo
149
(string, default no options)
150
.Xc
136
This option is the same as specifying map options on the command line to
151
This option is the same as specifying map options on the command line to
137
amd, such as "cache:=all".
152
.Nm amd ,
138
153
such as
139
.TP
154
.Ql cache\&:\&=all .
140
.BR map_type " (string, default search all map types)"
155
.It Ic map_type Xo
141
If specified, amd will initialize the map only for the type given.  This is
156
(string, default search all map types)
157
.Xc
158
If specified, amd will initialize the map only for the type given.
159
This is
142
useful to avoid the default map search type used by amd which takes longer
160
useful to avoid the default map search type used by amd which takes longer
143
and can have undesired side-effects such as initializing NIS even if not
161
and can have undesired side-effects such as initializing NIS even if not
144
used.  Possible values are
162
used.
145
163
Possible values are
146
.nf
164
.Pp
147
\fBfile\fR      plain files
165
.Bl -tag -width "nisplus" -compact
148
\fBhesiod\fR    Hesiod name service from MIT
166
.It Ic file
149
\fBldap\fR      Lightweight Directory Access Protocol
167
plain files
150
\fBndbm\fR      (New) dbm style hash files
168
.It Ic hesiod
151
\fBnis\fR       Network Information Services (version 2)
169
Hesiod name service from MIT
152
\fBnisplus\fR   Network Information Services Plus (version 3)
170
.It Ic ldap
153
\fBpasswd\fR    local password files
171
Lightweight Directory Access Protocol
154
\fBunion\fR     union maps
172
.It Ic ndbm
155
.fi
173
(New) dbm style hash files
156
174
.It Ic nis
157
.TP
175
Network Information Services (version 2)
158
.BR mount_type " (string, default=nfs)"
176
.It Ic nisplus
159
All amd mount types must be NFS.  That is, amd is an NFS server on the
177
Network Information Services Plus (version 3)
160
map mount points, for the local host it is running on.  If "autofs" is
178
.It Ic passwd
161
specified, amd will log an error and convert it to NFS.
179
local password files
162
180
.It Ic union 
163
.TP
181
union maps
164
.BR search_path " (string, default no search path)"
182
.El
165
This provides a (colon-delimited) search path for file maps.  Using a search
183
.It Ic mount_type Xo
184
(string, default=nfs)
185
.Xc
186
All
187
.Nm amd
188
mount types must be
189
.Tn NFS .
190
That is,
191
.Nm amd
192
is an
193
.Tn NFS
194
server on the
195
map mount points, for the local host it is running on.
196
If
197
.Qq autofs
198
is specified,
199
.Nm amd
200
will log an error and convert it to
201
.Tn NFS .
202
.It Ic search_path Xo
203
(string, default no search path)
204
.Xc
205
This provides a
206
(colon-delimited)
207
search path for file maps.
208
Using a search
166
path, sites can allow for local map customizations and overrides, and can
209
path, sites can allow for local map customizations and overrides, and can
167
distributed maps in several locations as needed.
210
distributed maps in several locations as needed.
168
211
.El
169
.\" **************************************************************************
212
.Ss "Parameters applicable to the global section only"
170
.SS Parameters applicable to the global section only
213
.Bl -tag -width 4n
171
214
.It Ic arch Xo
172
.TP
215
(string, default to compiled in value)
173
.BR arch " (string, default to compiled in value)"
216
.Xc
174
Allows you to override the value of the
217
Allows you to override the value of the
175
.Va arch
218
.Va arch
176
.Nm amd
219
.Nm amd
Lines 410-416 Link Here
410
(numeric, default=110)
453
(numeric, default=110)
411
.Xc
454
.Xc
412
Same as the
455
Same as the
413
.Ic counter
456
.Ar counter
414
part of the
457
part of the
415
.Fl t Ar interval.counter
458
.Fl t Ar interval.counter
416
option to
459
option to
Lines 420-516 Link Here
420
(numeric, default=8)
463
(numeric, default=8)
421
.Xc
464
.Xc
422
Same as the
465
Same as the
423
.B \-x
466
.Fl x
424
option to amd.  Specify any logging options for amd.  Options are comma
467
option to
425
delimited, and can be preceded by the string "no" to negate their meaning.
468
.Nm amd .
426
The "debug" logging option is only available if am-utils was configured with
469
Specify any logging options for
427
--enable-debug.  You can get the list of supported debugging and logging
470
.Nm amd .
428
options by running amd \-H.  Possible values are:
471
Options are comma
429
472
delimited, and can be preceded by the string
430
.nf
473
.Qq no
431
\fBall\fR       all messages
474
to negate their meaning.
432
\fBdebug\fR     debug messages
475
The
433
\fBerror\fR     non-fatal system errors
476
.Qq debug
434
\fBfatal\fR     fatal errors
477
logging option is only available if am-utils was configured with
435
\fBinfo\fR      information
478
--enable-debug.
436
\fBmap\fR       map errors
479
You can get the list of supported debugging and logging
437
\fBstats\fR     additional statistical information
480
options by running
438
\fBuser\fR      non-fatal user errors
481
.Nm amd Fl H .
439
\fBwarn\fR      warnings
482
Possible values are:
440
\fBwarning\fR   warnings
483
.Pp
441
.fi
484
.Bl -tag -width "warning" -compact
442
485
.It Ic all
443
.TP
486
all messages
444
.BR nfs_vers " (numeric, default to trying version 3 then 2)"
487
.It Ic debug
445
By default, amd tries version 3 and then version 2.  This option forces the
488
debug messages
446
overall NFS protocol used to version 3 or 2.  It overrides what is in the
489
.It Ic error
490
non-fatal system errors
491
.It Ic fatal
492
fatal errors
493
.It Ic info
494
information
495
.It Ic map
496
map errors
497
.It Ic stats
498
additional statistical information
499
.It Ic user
500
non-fatal user errors
501
.It Ic warn
502
warnings
503
.It Ic warning
504
warnings
505
.El
506
.It Ic nfs_vers Xo
507
(numeric, default to trying version 3 then 2)
508
.Xc
509
By default,
510
.Nm amd
511
tries version 3 and then version 2.
512
This option forces the
513
overall
514
.Tn NFS
515
protocol used to version 3 or 2.
516
It overrides what is in the
447
amd maps, and is useful when amd is compiled with NFSv3 support that may not
517
amd maps, and is useful when amd is compiled with NFSv3 support that may not
448
be stable.  With this option you can turn off the complete usage of NFSv3
518
be stable.
519
With this option you can turn off the complete usage of NFSv3
449
dynamically (without having to recompile amd) until such time as NFSv3
520
dynamically (without having to recompile amd) until such time as NFSv3
450
support is desired again.
521
support is desired again.
451
522
.It Ic nfs_retransmit_counter Xo
452
.TP
523
(numeric, default=11)
453
.BR nfs_retransmit_counter " (numeric, default=11)"
524
.Xc
454
Same as the
525
Same as the
455
.I retransmit
526
.Ar retransmit
456
part of the
527
part of the
457
.BI \-t " timeout.retransmit"
528
.Fl t Ar timeout.retransmit
458
option to amd.
529
option to
459
Specifies the number of NFS retransmissions that the kernel will use to
530
.Nm amd .
460
communicate with amd.
531
Specifies the number of
461
532
.Tn NFS
462
.TP
533
retransmissions that the kernel will use to
463
.BR nfs_retry_interval " (numeric, default=8)"
534
communicate with
535
.Nm amd .
536
.It Ic nfs_retry_interval Xo
537
(numeric, default=8)
538
.Xc
464
Same as the
539
Same as the
465
.I timeout
540
.Ar timeout
466
part of the
541
part of the
467
.BI \-t " timeout.retransmit"
542
.Fl t Ar timeout.retransmit
468
option to amd.  Specifies the NFS timeout interval, in
543
option to
469
.I tenths
544
.Nm amd .
470
of seconds, between NFS/RPC retries (for UDP only).
545
Specifies the
546
.Tn NFS
547
timeout interval, in
548
.Em tenths
549
of seconds, between NFS/RPC
550
retries (for UDP only).
471
This is the value that the kernel will use to
551
This is the value that the kernel will use to
472
communicate with amd.
552
communicate with
473
553
.Nm amd .
474
Amd relies on the kernel RPC retransmit mechanism to trigger mount retries.
554
.Pp
555
.Nm Amd
556
relies on the kernel RPC retransmit mechanism to trigger mount retries.
475
The values of the
557
The values of the
476
.B nfs_retransmit_counter
558
.Ar nfs_retransmit_counter
477
and the
559
and the
478
.B nfs_retry_interval
560
.Ar nfs_retry_interval
479
parameters change the overall retry interval.  Too long an interval gives
561
parameters change the overall retry interval.
562
Too long an interval gives
480
poor interactive response; too short an interval causes excessive retries.
563
poor interactive response; too short an interval causes excessive retries.
481
564
.It Ic nfs_proto Xo
482
.TP
565
(string, default to trying version tcp then udp)
483
.BR nfs_proto " (string, default to trying version tcp then udp)"
566
.Xc
484
By default, amd tries TCP and then UDP.  This option forces the overall NFS
567
By default,
485
protocol used to TCP or UDP.  It overrides what is in the amd maps, and is
568
.Nm amd
486
useful when amd is compiled with NFSv3 support that may not be stable.  With
569
tries TCP and then UDP.
570
This option forces the overall
571
.Tn NFS
572
protocol used to TCP or UDP.
573
It overrides what is in the amd maps, and is
574
useful when amd is compiled with NFSv3 support that may not be stable.
575
With
487
this option you can turn off the complete usage of NFSv3 dynamically
576
this option you can turn off the complete usage of NFSv3 dynamically
488
(without having to recompile amd) until such time as NFSv3 support is
577
(without having to recompile amd) until such time as NFSv3 support is
489
desired again.
578
desired again.
490
579
.It Ic nis_domain Xo
491
.TP
580
(string, default to local NIS domain name)
492
.BR nis_domain " (string, default to local NIS domain name)"
581
.Xc
493
Same as the
582
Same as the
494
.B \-y
583
.Fl y
495
option to amd.  Specify an alternative NIS domain from which to fetch the
584
option to
496
NIS maps.  The default is the system domain name.  This option is ignored if
585
.Nm amd .
497
NIS support is not available.
586
Specify an alternative
498
587
.Tn NIS
499
.TP
588
domain from which to fetch the
500
.BR normalize_hostnames " (boolean, default=no)"
589
.Tn NIS
501
Same as the
590
maps.
502
.B \-n
591
The default is the system domain name.
503
option to amd.  If "yes", then the name refereed to by ${rhost} is
592
This option is ignored if
504
normalized relative to the host database before being used.  The effect is
593
.Tn NIS
505
to translate aliases into ``official'' names.
594
support is not available.
506
595
.It Ic normalize_hostnames Xo
507
.TP
596
(boolean, default=no)
508
.BR os " (string, default to compiled in value)"
597
.Xc
509
Same as the
598
Same as the
510
.B \-O
599
.Fl n
511
option to amd.  Allows you to override the compiled-in name of the operating
600
option to
512
system.  Useful when the built-in name is not desired for backward
601
.Nm amd .
513
compatibility reasons.  For example, if the build in name is
602
If
603
.Qq yes ,
604
then the name refereed to by
605
.Va ${rhost}
606
is normalized relative to the host database before being used.
607
The effect is
608
to translate aliases into
609
.Qq official
610
names.
611
.It Ic os Xo
612
(string, default to compiled in value)
613
.Xc
614
Same as the
615
.Fl O
616
option to
617
.Nm amd .
618
Allows you to override the compiled-in name of the operating system.
619
Useful when the built-in name is not desired for backward
620
compatibility reasons.
621
For example, if the build in name is
514
.Dq sunos5 ,
622
.Dq sunos5 ,
515
you can override it to
623
you can override it to
516
.Dq sos5 ,
624
.Dq sos5 ,

Return to bug 57926