summaryrefslogtreecommitdiffstats
path: root/contrib/amd/scripts/amd.conf.5
diff options
context:
space:
mode:
authormbr <mbr@FreeBSD.org>2003-09-02 15:42:57 +0000
committermbr <mbr@FreeBSD.org>2003-09-02 15:42:57 +0000
commitfa2df21e0559a4a9af7f4504ac75a0ff043eaeb9 (patch)
tree361063e0f962fb2fd69f626b26e596899c16d3cd /contrib/amd/scripts/amd.conf.5
parentccc3812476e334ade5336aa157187088e2026fd3 (diff)
downloadFreeBSD-src-fa2df21e0559a4a9af7f4504ac75a0ff043eaeb9.zip
FreeBSD-src-fa2df21e0559a4a9af7f4504ac75a0ff043eaeb9.tar.gz
Resolve conflicts.
Diffstat (limited to 'contrib/amd/scripts/amd.conf.5')
-rw-r--r--contrib/amd/scripts/amd.conf.5260
1 files changed, 138 insertions, 122 deletions
diff --git a/contrib/amd/scripts/amd.conf.5 b/contrib/amd/scripts/amd.conf.5
index 8e29faa..93edefc 100644
--- a/contrib/amd/scripts/amd.conf.5
+++ b/contrib/amd/scripts/amd.conf.5
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 1997-1999 Erez Zadok
+.\" Copyright (c) 1997-2003 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.
@@ -38,7 +38,7 @@
.\"
.\" %W% (Berkeley) %G%
.\"
-.\" $Id: amd.conf.5,v 1.3 1999/03/30 17:23:08 ezk Exp $
+.\" $Id: amd.conf.5,v 1.7.2.8 2003/03/16 01:47:00 ezk Exp $
.\" $FreeBSD$
.\"
.Dd April 7, 1997
@@ -121,86 +121,56 @@ then amd's top-level mount points will be browsable to
calls. This means you could run for example
.Xr ls 1
and see what keys are available to mount in that directory. Not all entries
-are made visible to
-.Xr readdir 3 :
-the
-.Qq Pa /default
-entry, wildcardentries, and those with a
-.Qq Pa /
-in them are not included. If you specify
-.Qq full
-to this option, all but
-.Qq Pa /default
-will be visible. Note that if you run a command which will attempt to
-.Xr stat 2
-the entries, such as often done by
-.Qq ls -l
-or
-.Qq ls -F ,
-.Nm amd
-will attempt to mount
-.Em every
-entry in that map. This is often called a
-.Em mount storm .
-.It Ic map_options Xo
-(string, default no options)
-.Xc
-This option is the same as specifying map options on the command line to
-.Nm amd ,
-such as
-.Ql cache\&:\&=all .
-.It Ic map_type Xo
-(string, default search all map types)
-.Xc
-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:
-.Pp
-.Bl -tag -width "nisplus" -compact
-.It Ic file
-plain files
-.It Ic hesiod
-Hesiod name service from MIT
-.It Ic ldap
-Lightweight Directory Access Protocol
-.It Ic ndbm
-(New) dbm style hash files
-.It Ic nis
-Network Information Services (version 2)
-.It Ic nisplus
-Network Information Services Plus (version 3)
-.It Ic passwd
-local password files
-.It Ic union
-union maps
-.El
-.It Ic mount_type Xo
-(string, default=nfs)
-.Xc
-All amd mount types default to
-.Tn NFS .
-That is,
-.Nm amd
-is an
-.Tn NFS
-server on the map mount points, for the local host it is running on. If
-.Qq autofs
-is specified, amd will be an autofs server for those mount points.
-.It Ic search_path Xo
-(string, default no search path)
-.Xc
-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.
-.El
-.Ss "Parameters applicable to the global section only"
-.Bl -tag -width 4n
-.It Ic arch Xo
-(string, default to compiled in value)
-.Xc
+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_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
+\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 must be 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 log an error and convert it to NFS.
+
+.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.
+
+.\" **************************************************************************
+.SS Parameters applicable to the global section only
+
+.TP
+.BR arch " (string, default to compiled in value)"
Allows you to override the value of the
.Va arch
.Nm amd
@@ -450,49 +420,95 @@ Specifies the retransmit counter's value in tenths of seconds.
(numeric, default=8)
.Xc
Same as the
-.Ic interval
-part of the
-.Fl t Ar interval.counter
-option to
-.Nm amd .
-Specifies the interval in tenths of seconds, between NFS/RPC/UDP retries.
-.It Ic nis_domain Xo
-(string, default to local NIS domain name)
-.Xc
+.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 amd \-H. Possible values are:
+
+.nf
+\fBall\fR all messages
+\fBdebug\fR debug messages
+\fBerror\fR non-fatal system errors
+\fBfatal\fR fatal errors
+\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 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 nfs_retransmit_counter " (numeric, default=11)"
Same as the
-.Fl y
-option to
-.Nm amd .
-Specify an alternative
-.Tn NIS
-domain from which to fetch the
-.Tn NIS
-maps. The default is the system domain name. This option is ignored if
-.Tn NIS
-support is not available.
-.It Ic normalize_hostnames Xo
-(boolean, default=no)
-.Xc
+.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_retry_interval " (numeric, default=8)"
Same as the
-.Fl n
-option to
-.Nm amd .
-If
-.Dq yes ,
-then the name refereed to by
-.Va ${rhost}
-is normalized relative to the host database before being used. The effect is
-to translate aliases into
-.Qq official
-names.
-.It Ic os Xo
-(string, default to compiled in value)
-.Xc
+.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 only).
+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_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 nis_domain " (string, default to local NIS domain name)"
Same as the
-.Fl O
-option to
-.Nm amd .
-Allows you to override the compiled-in name of the operating
+.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 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
.Dq sunos5 ,
OpenPOWER on IntegriCloud