diff options
Diffstat (limited to 'contrib/amd/doc/am-utils.texi')
| -rw-r--r-- | contrib/amd/doc/am-utils.texi | 185 |
1 files changed, 131 insertions, 54 deletions
diff --git a/contrib/amd/doc/am-utils.texi b/contrib/amd/doc/am-utils.texi index a4950ab..12bda8f 100644 --- a/contrib/amd/doc/am-utils.texi +++ b/contrib/amd/doc/am-utils.texi @@ -38,7 +38,7 @@ @c @c %W% (Berkeley) %G% @c -@c $Id: am-utils.texi,v 1.10 1999/09/08 23:36:49 ezk Exp $ +@c $Id: am-utils.texi,v 1.12 1999/09/30 21:01:39 ezk Exp $ @c @setfilename am-utils.info @@ -889,6 +889,10 @@ features. @c {Config} {Compile} {Amd} {NFS V.3} {Shlib} {Hlfsd} @tab yes @tab yes @tab yes @tab n/a @tab yes @tab ? +@item @b{i586-pc-linux-gnu-rh6.1} +@c {Config} {Compile} {Amd} {NFS V.3} {Shlib} {Hlfsd} +@tab yes @tab yes @tab yes @tab n/a @tab yes @tab ? + @item @b{i586-pc-linux-gnulibc1} @c {Config} {Compile} {Amd} {NFS V.3} {Shlib} {Hlfsd} @tab yes @tab yes @tab yes @tab n/a @tab yes @tab ? @@ -1638,6 +1642,8 @@ These are the selectors currently implemented. * karch Selector Variable:: * os Selector Variable:: * osver Selector Variable:: +* full_os Selector Variable:: +* vendor Selector Variable:: * key Selector Variable:: * map Selector Variable:: @@ -1785,7 +1791,7 @@ be displayed by running the command @samp{amd -v}. @xref{Supported Platforms}.@refill @c ---------------------------------------------------------------- -@node osver Selector Variable, key Selector Variable, os Selector Variable, Selectors +@node osver Selector Variable, full_os Selector Variable, os Selector Variable, Selectors @comment node-name, next, previous, up @subsubsection osver Selector Variable @cindex osver Selector Variable @@ -1799,6 +1805,34 @@ be displayed by running the command @samp{amd -v}. @xref{Supported Platforms}.@refill @c ---------------------------------------------------------------- +@node full_os Selector Variable, vendor Selector Variable, osver Selector Variable, Selectors +@comment node-name, next, previous, up +@subsubsection full_os Selector Variable +@cindex full_os Selector Variable +@cindex full_os, mount selector +@cindex Mount selector; full_os +@cindex Selector; full_os + +The full name of the operating system, including its version. This +value is automatically determined at compile time. The full operating +system name and version can be displayed by running the command +@samp{amd -v}. @xref{Supported Platforms}.@refill + +@c ---------------------------------------------------------------- +@node vendor Selector Variable, key Selector Variable, full_os Selector Variable, Selectors +@comment node-name, next, previous, up +@subsubsection vendor Selector Variable +@cindex vendor Selector Variable +@cindex vendor, mount selector +@cindex Mount selector; vendor +@cindex Selector; vendor + +The name of the vendor of the operating system. This value is +automatically determined at compile time. The name of the vendor can be +displayed by running the command @samp{amd -v}. @xref{Supported +Platforms}.@refill + +@c ---------------------------------------------------------------- @ifhtml <HR> @end ifhtml @@ -1809,7 +1843,7 @@ expanded prior to a map lookup, these selectors are all defined as empty strings. @c ---------------------------------------------------------------- -@node key Selector Variable, map Selector Variable, osver Selector Variable, Selectors +@node key Selector Variable, map Selector Variable, vendor Selector Variable, Selectors @comment node-name, next, previous, up @subsubsection key Selector Variable @cindex key Selector Variable @@ -1948,7 +1982,7 @@ directory. A common map to use for both might look like the following: @example home/* netgrp(ppp-hosts);type:=link;fs:=/local/$@{key@} \ - !netgrp(ppp-hosts);type:=nfs;rhost=serv1;rfs:=/remote/$@{key@} + !netgrp(ppp-hosts);type:=nfs;rhost:=serv1;rfs:=/remote/$@{key@} @end example @c ---------------------------------------------------------------- @@ -2719,7 +2753,7 @@ single host in a mount map. @cindex Operating System version @cindex Setting the Operating System version -Override the compiled-in version number of the operating system, with +Overrides the compiled-in version number of the operating system, with @var{op-sys-ver}. Useful when the built-in version is not desired for backward compatibility reasons. For example, if the built-in version is @samp{2.5.1}, you can override it to @samp{5.5.1}, and use older maps @@ -2762,14 +2796,16 @@ Tells @i{Amd} to restart existing mounts (@pxref{Inheritance Filesystem}). @section @code{-t} @var{timeout.retransmit} @cindex Setting Amd's RPC parameters -Specifies the RPC @dfn{timeout} and @dfn{retransmit} intervals used by -the kernel to communicate to @i{Amd}. These are used to set the -@samp{timeo} and @samp{retrans} mount options. +Specifies the RPC @dfn{timeout} interval and the @dfn{retransmit} +counter used by the kernel to communicate to @i{Amd}. These are used to +set the @samp{timeo} and @samp{retrans} mount options, respectively. +The default timeout is 0.8 seconds, and the default number of +retransmissions is 11. @i{Amd} relies on the kernel RPC retransmit mechanism to trigger mount -retries. The value of this parameter changes the retry interval. Too -long an interval gives poor interactive response, too short an interval -causes excessive retries. +retries. The values of these parameters change the overall retry +interval. Too long an interval gives poor interactive response; too +short an interval causes excessive retries. @c ---------------------------------------------------------------- @node -v Option, -w Option, -t Option, Amd Command Line Options @@ -2804,9 +2840,10 @@ The information includes the version number, number of times @i{Amd} was compiled on the local system, release date and name of the release. Following come the cpu type, byte ordering, and the architecture and kernel architecture as @code{$@{arch@}} and @code{$@{karch@}}, -respectively. The next line lists the full name of the system, the -variables @code{$@{os@}} and @code{$@{osver@}}, and the vendor's -name. @xref{Supported Platforms}. +respectively. The next line lists the operating system full name, short +name, version, and vendor. These four values correspond to the +variables @code{$@{full_os@}}, @code{$@{os@}}, @code{$@{osver@}}, and +@code{$@{vendor@}}, respectively. @xref{Supported Platforms}. Then come a list of map types supported, filesystems internally supported by @i{Amd} (AMFS), and generic filesystems available (FS). @@ -2982,7 +3019,7 @@ debug string munging @item test full debug but no daemon @item trace -protocol trace +trace RPC protocol and NFS mount arguments @end table You may also refer to the program source for a more detailed explanation @@ -3022,7 +3059,7 @@ Print a brief help and usage string. @cindex Operating System name @cindex Setting the Operating System name -Override the compiled-in name of the operating system, with +Overrides the compiled-in name of the operating system, with @var{op-sys-name}. Useful when the built-in name is not desired for backward compatibility reasons. For example, if the build in name is @samp{sunos5}, you can override it to the old name @samp{sos5}, and use @@ -3563,11 +3600,11 @@ XXX: THIS FILESYSTEM IS NOT IMPLEMENTED YET! @cindex program, filesystem type @cindex Filesystem type; program -The @dfn{program} (@samp{type:=program}) filesystem type allows a program to be run whenever a -mount or unmount is required. This allows easy addition of support for -other filesystem types, such as MIT's Remote Virtual Disk (RVD) -which has a programmatic interface via the commands -@samp{rvdmount} and @samp{rvdunmount}. +The @dfn{program} (@samp{type:=program}) filesystem type allows a +program to be run whenever a mount or unmount is required. This allows +easy addition of support for other filesystem types, such as MIT's +Remote Virtual Disk (RVD) which has a programmatic interface via the +commands @samp{rvdmount} and @samp{rvdunmount}. @noindent The following options must be specified: @@ -3752,12 +3789,13 @@ another machine. The following options may be specified: @table @code -@cindex cache, mount option -@cindex Mount option; cache +@cindex cache, mount map option +@cindex Mount map option; cache @item cache specifies whether the data in this mount-map should be cached. The default value is @samp{none}, in which case no caching is done in order to conserve memory. + However, better performance and reliability can be obtained by caching some or all of a mount-map. @@ -3846,11 +3884,11 @@ dylan/dk5 type:=ufs;dev:=/dev/dsk/5s0 @cindex direct, filesystem type @cindex Filesystem type; direct -The @dfn{direct} (@samp{type:=direct}) filesystem is almost identical to the automount -filesystem. Instead of appearing to be a directory of mount points, it -appears as a symbolic link to a mounted filesystem. The mount is done -at the time the link is accessed. @xref{Automount Filesystem}, for a -list of required options. +The @dfn{direct} (@samp{type:=direct}) filesystem is almost identical to +the automount filesystem. Instead of appearing to be a directory of +mount points, it appears as a symbolic link to a mounted filesystem. +The mount is done at the time the link is accessed. @xref{Automount +Filesystem}, for a list of required options. Direct automount points are created by specifying the @samp{direct} filesystem type on the command line: @@ -4192,6 +4230,7 @@ The following parameters are applicable to the @samp{[global]} section only. * cluster Parameter:: * debug_options Parameter:: * dismount_interval Parameter:: +* full_os Parameter:: * fully_qualified_hosts Parameter:: * hesiod_base Parameter:: * karch Parameter:: @@ -4217,6 +4256,7 @@ The following parameters are applicable to the @samp{[global]} section only. * selectors_on_default Parameter:: * show_statfs_entries Parameter:: * unmount_on_exit Parameter:: +* vendor Parameter:: @end menu @c ---------------------------------------------------------------- @@ -4263,14 +4303,15 @@ in the cache. @subsection @t{debug_options} Parameter @cindex debug_options Parameter -(type=string, default no debug options). Same as the @code{-D} -option to @i{Amd}. Specify any debugging options for @i{Amd}. Works -only if am-utils was configured for debugging using the -@code{--enable-debug} option. The @samp{mem} option alone can be turned -on via @code{--enable-debug=mem}. Otherwise debugging options are -ignored. Options are comma delimited, and can be preceded by the string -@samp{no} to negate their meaning. You can get the list of supported -debugging options by running @code{amd -v}. Possible values are: +(type=string, default no debug options). Same as the @code{-D} option +to @i{Amd}. Specify any debugging options for @i{Amd}. Works only if +am-utils was configured for debugging using the @code{--enable-debug} +option. The @samp{mem} option, as well as all other options, can be +turned on via @code{--enable-debug=mem}. Otherwise debugging options +are ignored. Options are comma delimited, and can be preceded by the +string @samp{no} to negate their meaning. You can get the list of +supported debugging and logging options by running @code{amd -H}. +Possible values are: @table @samp @item all @@ -4292,11 +4333,11 @@ debug string munging @item test full debug but no daemon @item trace -protocol trace +trace RPC protocol and NFS mount arguments @end table @c ---------------------------------------------------------------- -@node dismount_interval Parameter, fully_qualified_hosts Parameter, debug_options Parameter, Global Parameters +@node dismount_interval Parameter, full_os Parameter, debug_options Parameter, Global Parameters @comment node-name, next, previous, up @subsection @t{dismount_interval} Parameter @cindex dismount_interval Parameter @@ -4306,7 +4347,20 @@ protocol trace systems that have exceeded their cached times. @c ---------------------------------------------------------------- -@node fully_qualified_hosts Parameter, hesiod_base Parameter, dismount_interval Parameter, Global Parameters +@node full_os Parameter, fully_qualified_hosts Parameter, dismount_interval Parameter, Global Parameters +@comment node-name, next, previous, up +@subsection @t{full_os} Parameter +@cindex full_os Parameter + +(type=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 @samp{linux}, but you can override it +to @samp{linux-2.2.5}. + +@c ---------------------------------------------------------------- +@node fully_qualified_hosts Parameter, hesiod_base Parameter, full_os Parameter, Global Parameters @comment node-name, next, previous, up @subsection @t{fully_qualified_hosts} Parameter @cindex fully_qualified_hosts Parameter @@ -4422,7 +4476,7 @@ option to @i{Amd}. Specify any logging options for @i{Amd}. Options are comma delimited, and can be preceded by the string @samp{no} to negate their meaning. The @samp{debug} logging option is only available if am-utils was configured with @code{--enable-debug}. You can get the -list of supported debugging options by running @code{amd -v}. Possible +list of supported debugging options by running @code{amd -H}. Possible values are: @table @samp @@ -4454,9 +4508,10 @@ warnings @subsection @t{nfs_retransmit_counter} Parameter @cindex nfs_retransmit_counter Parameter -(type=numeric, default=110). Same as the @i{counter} part of the -@code{-t} @i{interval.counter} option to @i{Amd}. Specifies the -retransmit counter's value in @emph{tenths} of seconds. +(type=numeric, default=11). Same as the @i{retransmit} part of the +@code{-t} @i{timeout.retransmit} option to @i{Amd}. Specifies the +number of NFS retransmissions that the kernel will use to communicate +with @i{Amd}. @xref{-t Option}. @c ---------------------------------------------------------------- @node nfs_retry_interval Parameter, nis_domain Parameter, nfs_retransmit_counter Parameter, Global Parameters @@ -4464,9 +4519,17 @@ retransmit counter's value in @emph{tenths} of seconds. @subsection @t{nfs_retry_interval} Parameter @cindex nfs_retry_interval Parameter -(type=numeric, default=8). Same as the @i{interval} part of the -@code{-t} @i{interval.counter} option to @i{Amd}. Specifies the -interval in @emph{tenths} of seconds, between NFS/RPC/UDP retries. +(type=numeric, default=8). Same as the @i{timeout} part of the +@code{-t} @i{timeout.retransmit} option to @i{Amd}. Specifies the NFS +timeout interval, in @emph{tenths} of seconds, between NFS/RPC retries +(for UDP only). This is the value that the kernel will use to +communicate with @i{Amd}. @xref{-t Option}. + +Amd relies on the kernel RPC retransmit mechanism to trigger mount +retries. The values of the @i{nfs_retransmit_counter} and the +@i{nfs_retry_interval} parameters change the overall retry interval. +Too long an interval gives poor interactive response; too short an +interval causes excessive retries. @c ---------------------------------------------------------------- @node nis_domain Parameter, normalize_hostnames Parameter, nfs_retry_interval Parameter, Global Parameters @@ -4503,6 +4566,7 @@ backward compatibility reasons. For example, if the built-in name is @samp{sunos5}, you can override it to @samp{sos5}, and use older maps which were written with the latter in mind. + @c ---------------------------------------------------------------- @node osver Parameter, pid_file Parameter, os Parameter, Global Parameters @comment node-name, next, previous, up @@ -4613,7 +4677,7 @@ follows: @end example @c ---------------------------------------------------------------- -@node show_statfs_entries Parameter, unmount_on_exit Parameter , selectors_on_default Parameter, Global Parameters +@node show_statfs_entries Parameter, unmount_on_exit Parameter, selectors_on_default Parameter, Global Parameters @comment node-name, next, previous, up @subsection @t{show_statfs_entries} Parameter @cindex show_statfs_entries Parameter @@ -4624,7 +4688,7 @@ browsable will also show the number of entries (keys) they have when the @b{statfs}(2) system call). @c ---------------------------------------------------------------- -@node unmount_on_exit Parameter, , show_statfs_entries Parameter, Global Parameters +@node unmount_on_exit Parameter, vendor Parameter, show_statfs_entries Parameter, Global Parameters @comment node-name, next, previous, up @subsection @t{unmount_on_exit} Parameter @cindex unmount_on_exit Parameter @@ -4635,6 +4699,18 @@ all (esp. NFS) mounted file systems intact. Note that @i{Amd} does not know about file systems mounted before it starts up, unless the @samp{restart_mounts} option is used (@pxref{restart_mounts Parameter}). +@c ---------------------------------------------------------------- +@node vendor Parameter, , unmount_on_exit Parameter, Global Parameters +@comment node-name, next, previous, up +@subsection @t{vendor} Parameter +@cindex vendor Parameter + +(type=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 @samp{unknown}, but you can set it to +@samp{redhat}. + @c ================================================================ @node Regular Map Parameters, amd.conf Examples, Global Parameters, Amd Configuration File @comment node-name, next, previous, up @@ -6339,11 +6415,12 @@ the accessing user's home directory, with @i{subdir} appended to it. If not specified, @i{subdir} defaults to @file{.hlfsdir}. This directory will also be created if it does not already exist. -A @samp{SIGTERM} sent to @i{Hlfsd} will cause it to shutdown. A @samp{SIGHUP} will -flush the internal caches, and reload the password map. It will also -close and reopen the log file, to enable the original log file to be -removed or rotated. A @samp{SIGUSR1} will cause it to dump its internal table -of user IDs and home directories to the file @file{/tmp/hlfsddump}. +A @samp{SIGTERM} sent to @i{Hlfsd} will cause it to shutdown. A +@samp{SIGHUP} will flush the internal caches, and reload the password +map. It will also close and reopen the log file, to enable the original +log file to be removed or rotated. A @samp{SIGUSR1} will cause it to +dump its internal table of user IDs and home directories to the file +@file{/tmp/hlfsddump}. @menu * Introduction to Hlfsd:: @@ -8063,4 +8140,4 @@ All other registered trademarks are owned by their respective owners. @c LocalWords: serv maxgroups nfsl cachedir copt cfsadmin efs addopts fg ROMs @c LocalWords: nointr extatt setchapternewpage columnfractions alphaev gnulibc @c LocalWords: freebsdelf gnuoldld ifhtml defperm nodefperm norrip RRIP rrip -@c LocalWords: noversion attr XXXXXX netgrpd +@c LocalWords: noversion attr XXXXXX netgrpd rh mkstemp |
