Revise the man->mdoc conversion of the amd manpages.

This commit is contained in:
Ruslan Ermilov 2007-12-07 20:16:21 +00:00
parent 064be22e10
commit 2d15ec09ec
9 changed files with 983 additions and 849 deletions

View File

@ -1,5 +1,5 @@
.\"
.\" Copyright (c) 1997-2004 Erez Zadok
.\" Copyright (c) 1997-2006 Erez Zadok
.\" Copyright (c) 1989 Jan-Simon Pendry
.\" Copyright (c) 1989 Imperial College of Science, Technology & Medicine
.\" Copyright (c) 1989 The Regents of the University of California.
@ -48,30 +48,24 @@
.Nm amd
.Nd automatically mount file systems
.Sh SYNOPSIS
.Nm amd
.Nm
.Fl H
.Nm amd
.Nm
.Op Fl F Ar conf_file
.Nm amd
.Nm
.Op Fl nprvHS
.Op Fl a Ar mount_point
.Op Fl c Ar duration
.Op Fl d Ar domain
.Bk -words
.Op Fl k Ar kernel-arch
.Ek
.Op Fl l Ar logfile
.Op Fl o Ar op_sys_ver
.Op Fl t Ar timeout.retransmit
.Bk -words
.Op Fl w Ar interval
.Ek
.Op Fl x Ar log-option
.Op Fl y Ar YP-domain
.Op Fl A Ar arch
.Bk -words
.Op Fl C Ar cluster-name
.Ek
.Op Fl D Ar option
.Op Fl F Ar conf_file
.Op Fl O Ar op_sys_name
@ -82,41 +76,46 @@
.Oc
.Ar ...
.Sh DESCRIPTION
.Nm Amd
is a daemon that automatically mounts file systems whenever a file or directory
The
.Nm
utility
is a daemon that automatically mounts file systems
whenever a file or directory
within that file system is accessed.
File systems are automatically unmounted
when they appear to be quiescent.
File systems are automatically unmounted when they
appear to be quiescent.
.Pp
.Nm Amd
The
.Nm
utility
operates by attaching itself as an
.Tn NFS
server to each of the specified
.Ar directories .
Lookups within the specified directories
are handled by
.Nm amd ,
.Nm ,
which uses the map defined by
.Ar mapname
to determine how to resolve the lookup.
Generally, this will be a host name,
some file system information and some mount options for the given file system.
Generally, this will be a host name, some file system information
and some mount options for the given file system.
.Pp
In the first form depicted above,
.Nm amd
.Nm
will print a short help string.
In the second form, if no options are
specified, or if the
.Fl F
is used,
.Nm amd
.Nm
will read configuration parameters from the file
.Ar conf_file
which defaults to
.Pa /etc/amd.conf .
The last form is described below.
.Sh OPTIONS
.Bl -tag -width Ds
.Bl -tag -width indent
.It Fl a Ar temporary-directory
Specify an alternative location for the real mount points.
The default is
@ -140,55 +139,63 @@ Specify a logfile in which to record mount and unmount events.
If
.Ar logfile
is the string
.Em syslog ,
the log messages will be sent to the system log daemon by
.Dq Li syslog ,
then the log messages will be sent to the system log daemon by
.Xr syslog 3 .
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.
The default syslog facility used is
.Dv LOG_DAEMON .
If you
wish to change it, append its name to the log file name, delimited by a
single colon.
For example, if
.Ar logfile
is the string
.Dq Li syslog:local7
then
.Nm amd
.Nm
will log messages via
.Xr syslog 3
using the LOG_LOCAL7 facility (if it exists on the system).
using the
.Dv LOG_LOCAL7
facility (if it exists on the system).
.It Fl n
Normalize hostnames.
The name referred to by ${rhost} is normalized relative to the
host database before being used.
The effect is to translate
aliases into ``official'' names.
aliases into
.Dq official
names.
.It Fl o Ar op_sys_ver
Override the compiled-in version number of the operating system.
Useful when the built in version is not desired for backward
compatibility reasons.
Useful
when the built in version is not desired for backward compatibility reasons.
For example, if the build in version is
.Dq 2.5.1 ,
.Dq Li 2.5.1 ,
you can override it to
.Dq 5.5.1 ,
.Dq Li 5.5.1 ,
and use older maps that were written with the latter in mind.
.It Fl p
Print
.Em PID .
Outputs the process-id of
.Nm amd
Print PID.
Outputs the process ID of
.Nm
to standard output where it can be saved into a file.
.It Fl r
Restart existing mounts.
.Nm Amd
The
.Nm
utility
will scan the mount file table to determine which file systems
are currently mounted.
Whenever one of these would have
been auto-mounted,
.Nm amd
.Nm
.Em inherits
it.
.It Fl t Ar timeout.retransmit
Specify the NFS timeout
.Ar interval ,
Specify the NFS
.Ar timeout
interval,
in tenths of a second, between
.Tn NFS/RPC
retries (for UDP only).
@ -201,7 +208,10 @@ to communicate with amd.
Useful defaults are supplied if either or both
values are missing.
.Pp
Amd relies on the kernel RPC retransmit mechanism to trigger mount retries.
The
.Xr amd 8
utility
relies on the kernel RPC retransmit mechanism to trigger mount retries.
The values of these parameters change the overall retry interval.
Too long
an interval gives poor interactive response; too short an interval causes
@ -212,13 +222,14 @@ Displays version and configuration information on standard error.
.It Fl w Ar interval
Specify an
.Ar interval ,
in seconds, between attempts to dismount file systems that have exceeded their
cached times.
in seconds, between attempts to dismount
file systems that have exceeded their cached times.
The default is 2 minutes.
.It Fl x Ar options
Specify run-time logging options.
The options are a comma separated list
chosen from: fatal, error, user, warn, info, map, stats, all.
The options are a comma separated
list chosen from:
.Li fatal , error , user , warn , info , map , stats , all .
.It Fl y Ar domain
Specify an alternative
.Tn NIS
@ -231,8 +242,7 @@ This option is ignored if
support is not available.
.It Fl A Ar arch
Specifies the OS architecture.
This is used solely to set the
.Em ${arch}
This is used solely to set the ${arch}
selector.
.It Fl C Ar cluster-name
Specify an alternative HP-UX cluster name to use.
@ -240,11 +250,11 @@ Specify an alternative HP-UX cluster name to use.
Select from a variety of debug options.
Prefixing an
option with the string
.Em no
.Dq Li no
reverses the effect of that option.
Options are cumulative.
The most useful option is
.Ar all .
.Dq Li all .
.Pp
Since
.Fl D
@ -255,7 +265,7 @@ option
and a fuller description is available in the program source.
.It Fl F Ar conf_file
Specify an
.Nm amd
.Nm
configuration file to use.
See
.Xr amd.conf 5
@ -263,59 +273,63 @@ for description of this file's format.
This configuration file is used to
specify any options in lieu of typing many of them on the command line.
The
.Nm amd.conf
file includes directives for every command line option amd has,
and many more that are only available via the configuration file
facility.
The configuration file specified by this option is
processed after all other options have been processed, regardless
of the actual location of this option on the command line.
.Xr amd.conf 5
file includes directives for every command line option amd has, and many
more that are only available via the configuration file facility.
The
configuration file specified by this option is processed after all other
options had been processed, regardless of the actual location of this option
on the command line.
.It Fl H
Print help and usage string.
.It Fl O Ar op_sys_name
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 ,
Useful when the
built in name is not desired for backward compatibility reasons.
For
example, if the build in name is
.Dq Li sunos5 ,
you can override it to
.Dq sos5
.Dq Li sos5
and use older maps which were written with the latter in mind.
.It Fl S
Do not lock the running executable pages of
.Nm amd
.Nm
into memory.
To improve
.Nm amd's
.Nm Ns 's
performance, systems that support the
.Xr plock 3
call, could lock the
.Nm amd
.Nm
process into memory.
This way there is less chance the operating system will
schedule, page out, and swap the
.Nm amd
process as needed.
This way there is less chance
the operating system will schedule, page out, and swap the
.Nm
process as
needed.
This tends to improve
.Nm amd's
performance, at the cost of reserving the memory used by the
.Nm amd
process
(making it unavailable for other processes).
.Nm Ns 's
performance, at the cost of reserving the
memory used by the
.Nm
process (making it unavailable for other processes).
If this behavior is not desired, use the
.Fl S
option.
.It Fl T Ar tag
Specify a tag to use with
.Xr amd.conf 5 .
All Map entries tagged with tag will be processed.
All map entries tagged with
.Ar tag
will be processed.
Map entries that are not tagged are always processed.
Map entries that are tagged with a tag other than
.Ar tag
will not be processed.
.El
.Sh FILES
.Bl -tag -width /axx
.Bl -tag -width ".Pa /etc/amd.conf"
.It Pa /.amd_mnt
directory under which file systems are dynamically mounted
.It Pa /etc/amd.conf
@ -329,20 +343,17 @@ Symbolic links on an
file system can be incredibly inefficient.
In most implementations of
.Tn NFS ,
their interpolations are not cached by
the kernel and each time a symbolic link is
encountered during a
their interpolations are not cached
by the kernel and each time a symbolic link is encountered during a
.Em lookuppn
translation it costs an
.Tn RPC
call to the
.Tn NFS
server.
A large improvement in real-time
It would appear that a large improvement in real-time
performance could be gained by adding a cache somewhere.
Replacing
.Xr symlink 2
with a suitable incarnation of the auto-mounter
Replacing symlinks with a suitable incarnation of the auto-mounter
results in a large real-time speedup, but also causes a large
number of process context switches.
.Pp
@ -357,25 +368,34 @@ the features.
.Xr amq 8 ,
.Xr mount 8 ,
.Xr umount 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%T Amd \- The 4.4 BSD Automounter
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Pp
.%T Linux NFS and Automounter Administration
by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001).
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh HISTORY
The
.Nm amd
.Nm
utility first appeared in
.Bx 4.4 .
.Sh AUTHORS
.An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
Department of Computing, Imperial College, London, UK.
.Pp
.An Erez Zadok Aq ezk@am-utils.org ,
Department of Computer Science, Stony Brook University New York, USA.
.An Erez Zadok Aq ezk@cs.sunysb.edu ,
Computer Science Department, Stony Brook
University, Stony Brook, New York, USA.
.Pp
Other authors and contributors to am-utils are listed in the
.Pa AUTHORS

View File

@ -49,86 +49,104 @@
.Nd automounter query tool
.Sh SYNOPSIS
.Nm amq
.Op Fl fmpsuvTU
.Op Fl fmpsvwHTU
.Op Fl h Ar hostname
.Op Fl l Ar log_file
.Op Fl x Ar log_options
.Op Fl D Ar debug_options
.Op Fl M Ar mountmap_entry
.Op Fl P Ar program_number
.Op Ar directory
.Ar ...
.Op Oo Fl u Oc Ar directory ...
.Sh DESCRIPTION
.Nm Amq
The
.Nm
utility
provides a simple way of determining the current state of the
.Xr amd 8
program.
Communication is by
.Tn RPC .
Three modes of operation are supported by the current protocol.
By default a list of mount points and auto-mounted file systems
is output.
An alternative host can be specified using the
By default
a list of mount points and auto-mounted file systems is output.
An
alternative host can be specified using the
.Fl h
option.
.Pp
If directory names are given, as output by default,
then per file system information is displayed.
If
.Ar directory
names are given, as output by default, then per file system
information is displayed.
.Sh OPTIONS
.Bl -tag -width Ds
.Bl -tag -width indent
.It Fl f
Request automounter to flush the internal caches.
Ask the automounter to flush the internal caches and reload all the maps.
.It Fl h Ar hostname
Query alternate host
.Ar hostname .
Specify an alternate host to query.
By default the local host is used.
In an
In
an
.Tn HP-UX
cluster, the root server is queried by default, since
that is the system on which the automounter is normally run.
cluster, the root server is queried by default, since that is the system on
which the automounter is normally run.
.It Fl l Ar log_file
Tell amd to use
Tell
.Xr amd 8
to use
.Ar log_file
as the log file name.
For security reasons, this must be the same log file which
.Nm amd
For security reasons, this must be the same log file
which
.Xr amd 8
used when started.
This option is therefore only useful to
refresh
.Nm amd Ns \'s
open file handle on the log file, so that it can be rotated and compressed via
daily cron jobs.
.Nm amd Ns 's
open file handle on the log file, so that it can be rotated
and compressed via daily cron jobs.
.It Fl m
Request the automounter to provide a list of mounted file systems,
including the number of references to each file system and any error
which occurred while mounting.
Ask the automounter to provide a list of mounted file systems, including the
number of references to each file system and any error which occurred while
mounting.
.It Fl p
Return the process ID of the remote or locally running
.Nm amd .
Useful when you need to send a signal to the local
.Nm amd
process, and would rather not have to search through the process table.
This
option is used in the
.Xr amd 8 .
Useful when you
need to send a signal to the local
.Xr amd 8
process, and would rather not have to
search through the process table.
This option is used in the
.Pa ctl-amd
script.
.It Fl s
Request the automounter to provide system-wide mount statistics.
Ask the automounter to provide system-wide mount statistics.
.It Fl u
Request the automounter to unmount the named file systems
instead of providing information about them.
Unmounts are requested,
not forced.
They merely cause the mounted file system to timeout,
which will be picked up by
.Nm amd Ns \'s
Ask the automounter to unmount the file systems named in
.Ar directory
instead of providing
information about them.
Unmounts are requested, not forced.
They merely
cause the mounted file system to timeout, which will be picked up by
.Nm amd Ns 's
main scheduler thus causing the normal timeout action to be taken.
.It Fl v
Request the automounter to provide version information.
This is a subset
of the information provided by
.Nm amd Ns \'s Fl v
Ask the automounter for its version information.
This is a subset of the
information output by
.Xr amd 8 Ns 's
.Fl v
option.
.It Fl w
Translate a full pathname as returned by
.Xr getcwd 3
into a short
.Xr amd 8
pathname that goes through its mount points.
This option requires that
.Xr amd 8
is running.
.It Fl x Ar log_options
Ask the automounter to use the logging options specified in
.Ar log_options
@ -137,107 +155,109 @@ from now on.
Ask the automounter to use the debugging options specified in
.Ar debug_options
from now on.
.It Fl M
Pass a mount map entry to
.Nm amd
and wait for it to be evaluated, possibly causing a mount.
This option is highly insecure.
By default,
.Nm amd
and
.Nm amq
do not support it.
It is necessary to configure
.Nm am-utils
with
.Ar --enable-amq-mount
to enable this option.
.It Fl H
Display short usage message.
.It Fl P Ar program_number
Contact an alternate running
.Nm amd
that had registered itself on a different RPC
.Xr amd 8
that had registered itself on a different
.Tn RPC
.Ar program_number
and apply all other operations to that instance of the automounter.
This is useful when running multiple copies of
.Nm amd ,
and need to manage each one separately.
This is
useful when you run multiple copies of
.Xr amd 8 ,
and need to manage each
one separately.
If not specified,
.Nm amq
.Nm
will use the default program number for
.Nm amd ,
.Xr amd 8 ,
300019.
For security reasons, the only alternate program numbers
.Nm amd
.Xr amd 8
can use range from 300019 to 300029, inclusive.
.It Fl T
Contact
.Nm amd
.Xr amd 8
using the TCP transport only.
Normally
.Nm amq
will try TCP, and if that fails, will try UDP.
.Nm
will try TCP, and if that failed, will try UDP.
.It Fl U
Contact
.Nm amd
.Xr amd 8
using UDP (connectionless) transport only.
Normally
.Nm amq
will try TCP, and if that fails, will try UDP.
.Nm
will try TCP, and if that failed, will try UDP.
.El
.Sh FILES
.Bl -tag -width amq.x -compact
.Bl -tag -width ".Pa amq.x" -compact
.It Pa amq.x
.Tn RPC
protocol description.
.El
.Sh CAVEATS
.Nm Amq
The
.Nm
utility
uses a Sun registered
.Tn RPC
program number (300019 decimal) which may not
be in the
.Pa /etc/rpc
.Xr rpc 5
database.
.Pp
If the TCP wrappers library is available, and the
.It use_tcpwrappers
.Va use_tcpwrappers
global
.It amd.conf
.Xr amd.conf 5
option is set to
.Qq yes ,
.Dq Li yes ,
then
.Nm Amd
.Xr amd 8
will verify that the host running
.Nm Aamq
.Nm
is authorized to connect.
The
.Nm Amd
service name must used in the
.Dq Li amd
service name must be used in the
.Pa /etc/hosts.allow
and
.Pa /etc/hosts.deny
files.
For example, to allow only localhost to connect to
.Nm Amd ,
.Xr amd 8 ,
add this line to
.Pa /etc/hosts.allow :
.Bd -literal
.nf
amd: localhost
.fi
.Ed
.Pp
.Dl "amd: localhost"
.Pp
and this line to
.Pa /etc/hosts.deny :
.Bd -literal
.nf
amd: ALL
.fi
.Ed
.Pp
.Dl "amd: ALL"
.Sh SEE ALSO
.Xr amd.conf 5 ,
.Xr hosts_access 5 ,
.Xr amd 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh HISTORY
.Nm Amq
first appeared in
@ -247,8 +267,10 @@ first appeared in
Department of Computing, Imperial College, London, UK.
.Pp
.An Erez Zadok Aq ezk@cs.sunysb.edu ,
Computer Science Department, Stony Brook
University, Stony Brook, New York, USA.
.Pp
.An Other authors and contributors to
Other authors and contributors to
.Nm am-utils
are listed in the
.Pa AUTHORS

View File

@ -51,16 +51,18 @@
.Nm
.Op Ar path ...
.Sh DESCRIPTION
The
.Nm
utility
is used to print the current working directory, adjusted to reflect proper
paths that can be reused to go through the automounter for the shortest
possible path.
In particular, the path printed back does not include any
of
.Nm Amd Ns \'s
.Xr amd 8 Ns 's
local mount points.
Using them is unsafe, because
.Nm Amd
.Xr amd 8
may unmount managed file systems from the mount points, and thus including
them in paths may not always find the files within.
.Pp
@ -76,15 +78,32 @@ arguments.
.Xr pwd 1 ,
.Xr amd 8 ,
.Xr amq 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 3.0 .
.SH AUTHORS
Erez Zadok <ezk@cs.sunysb.edu>, Computer Science Department, Stony Brook
.Sh AUTHORS
.An Erez Zadok Aq ezk@cs.sunysb.edu ,
Computer Science Department, Stony Brook
University, Stony Brook, New York, USA.
.P
.Pp
Other authors and contributors to am-utils are listed in the
.B AUTHORS
.Pa AUTHORS
file distributed with am-utils.

View File

@ -51,10 +51,11 @@
.Nm
.Op Fl adervq
.Op Fl h Ar name
.Ar host
\&...
.Ar host ...
.Sh DESCRIPTION
The
.Nm
utility
is a variant of
.Xr showmount 8
that can delete bogus mount entries in remote
@ -64,8 +65,8 @@ The actions specified by the options are performed for each
.Ar host
in turn.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a Fl d Fl e
.Bl -tag -width indent
.It Fl a , d , e
These options work as in
.Xr showmount 8
except that only entries pertaining to the local host are printed.
@ -87,15 +88,15 @@ The remote mount table is not changed.
Issues a command to the remote mountd declaring that
.Em all
of its file systems have been unmounted.
This should be used with caution, as
it removes all remote mount entries pertaining to the local system, whether or
not any file systems are still mounted locally.
This should be used with caution, as it removes all
remote mount entries pertaining to the local system, whether or not any
file systems are still mounted locally.
.It Fl q
Be quiet.
Suppresses error messages due to timeouts and
.Dq Program not Registered ,
.Dq Li "Program not registered" ,
i.e., due to remote hosts not supporting RPC or not running
.Nm mountd .
.Xr mountd 8 .
.It Fl h Ar name
Pretend the local hostname is
.Ar name .
@ -110,7 +111,7 @@ This option also saves time as comparisons of remotely recorded and local
hostnames by address are avoided.
.El
.Sh FILES
.Bl -tag -width /axx
.Bl -tag -width ".Pa /etc/rmtab"
.It Pa /etc/mtab
List of current mounts.
.It Pa /etc/rmtab
@ -123,6 +124,22 @@ server.
.Xr rmtab 5 ,
.Xr mountd 8 ,
.Xr showmount 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh HISTORY
The
.Nm
@ -141,6 +158,15 @@ are listed in the
.Nm AUTHORS
file distributed with
.Nm am-utils .
.Sh AUTHORS
.An Andreas Stolcke Aq stolcke@icsi.berkeley.edu
.Pp
.An Erez Zadok Aq ezk@cs.sunysb.edu ,
Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
.Pp
Other authors and contributors to am-utils are listed in the
.Pa AUTHORS
file distributed with am-utils.
.Sh BUGS
No attempt is made to verify the information in
.Pa /etc/mtab
@ -150,9 +176,9 @@ Since swap file mounts are not recorded in
.Pa /etc/mtab ,
a heuristic specific to SunOS is used to determine whether such a mount
is actual (replacing the string
.Ql swap
.Dq Li swap
with
.Ql root
.Dq Li root
and verifying the resulting path).
.Pp
Symbolic links on the server will cause the path in the remote entry to differ
@ -170,27 +196,19 @@ Since the local mount point is
as well this will be handled correctly.
.Pp
There is no way to clear a stale entry in a remote
.Nm mountd
after the local hostname (or whatever reverse name resolution
returns for it) has been changed.
.Xr mountd 8
after the
local hostname (or whatever reverse name resolution returns for it)
has been changed.
To take care of these cases,
the remote
.Pa /etc/rmtab
file has to be edited and
.Nm mountd
.Xr mountd 8
restarted.
.Pp
The RPC timeouts for
.Nm mountd
.Xr mountd 8
calls can only be changed by recompiling.
The defaults are 2 seconds
for client handle creation and 5 seconds for RPC calls.
.Sh AUTHORS
.An Andreas Stolcke Aq stolcke@icsi.berkeley.edu
.Pp
.An Erez Zadok Aq ezk@cs.sunysb.edu ,
Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
.Pp
Other authors and contributors to am-utils are listed in the
.Pa AUTHORS
file distributed with am-utils.
The defaults are 2 seconds for client handle creation and 5 seconds for
RPC calls.

View File

@ -190,10 +190,26 @@ and in the
.Nm amd
section in
.Xr info 1 .
.Sh "SEE ALSO"
.Sh SEE ALSO
.Xr amd 8 ,
.Xr mount 8 ,
.Xr mountd 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh HISTORY
The
.Nm

View File

@ -53,23 +53,19 @@
.Nm
.Op Fl fhnpvC
.Op Fl a Ar alt_dir
.Bk -words
.Op Fl c Ar cache-interval
.Ek
.Op Fl g Ar group
.Bk -words
.Op Fl i Ar reload-interval
.Ek
.Op Fl l Ar logfile
.Bk -words
.Op Fl o Ar mount-options
.Op Fl x Ar log-options
.Op Fl D Ar debug-options
.Op Fl P Ar password-file
.Ek
.Op linkname Op subdir
.Op Ar linkname Op Ar subdir
.Sh DESCRIPTION
The
.Nm
utility
is a daemon which implements a file system containing a symbolic link to
subdirectory within a user's home directory, depending on the user
which accessed that link.
@ -77,7 +73,9 @@ It was primarily designed to redirect
incoming mail to users' home directories, so that it can read from
anywhere.
.Pp
The
.Nm
utility
operates by mounting itself as an
.Tn NFS
server for the directory containing
@ -85,12 +83,10 @@ server for the directory containing
which defaults to
.Pa /hlfs/home .
Lookups within that directory are handled by
.Nm hlfsd ,
.Nm ,
which uses the password map to determine how to resolve the lookup.
The
directory will be created if it does not already exist.
The symbolic link will
be to the accessing user's home directory, with
The directory will be created if it does not already exist.
The symbolic link will be to the accessing user's home directory, with
.Ar subdir
appended to it.
If not specified,
@ -100,18 +96,24 @@ defaults to
This directory will also be created if it does not already exist.
.Pp
A
.Er 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.
.Dv SIGTERM
sent to
.Nm
will cause it to shutdown.
A
.Er SIGUSR1
will cause it to dump its internal table of user IDs and home directories to
the file
.Dv 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
.Dv SIGUSR1
will cause it to dump its internal
table of user IDs and home directories to the file
.Pa /usr/tmp/hlfsd.dump.XXXXXX .
.Sh OPTIONS
.Bl -tag -width Ds
.Bl -tag -width indent
.It Fl a Ar alt_dir
Alternate directory.
The name of the directory to which
@ -129,7 +131,9 @@ will run a script to resend this
to its owner.
.It Fl c Ar cache-interval
Caching interval.
The
.Nm
utility
will cache the validity of home directories for this interval, in
seconds.
Entries which have been verified within the last
@ -142,8 +146,7 @@ will re-verify the validity of the user's home directory, and
reset the cache time-counter.
The default value for
.Ar cache-interval
is 300 seconds
(5 minutes).
is 300 seconds (5 minutes).
.It Fl f
Force fast startup.
This option tells
@ -153,19 +156,19 @@ directory, alternate spool directory, symlink to be hidden under the
mount directory, their permissions and validity.
.It Fl g Ar group
Set the special group
.Va HLFS_GID
.Dv HLFS_GID
to
.Ar group .
Programs such as
.Ic comsat ,
(which access the mailboxes of other users)
must be setgid
.Va HLFS_GID
.Xr comsat 8 ,
(which access the mailboxes of other users) must be setgid
.Dv HLFS_GID
to work properly.
The default group is
.Dq hlfs .
If no group is provided, and there is no group
.Dq hlfs ,
.Dq Li hlfs .
If no group is provided,
and there is no group
.Dq Li hlfs ,
this feature is disabled.
.It Fl h
Help.
@ -177,38 +180,43 @@ Each
seconds,
.Nm
will reload the password map.
The
.Nm
utility
needs the password map for the UIDs and home directory pathnames.
The
.Nm
schedules a
.Va SIGALRM
utility schedules a
.Dv SIGALRM
to reload the password maps.
A
.Va SIGHUP
.Dv SIGHUP
sent to
.Nm
will force it to reload the maps immediately.
The default value for
The default
value for
.Ar reload-interval
is 900 seconds
(15 minutes).
is 900 seconds (15 minutes).
.It Fl l Ar logfile
Specify a log file to which
.Nm
will record events.
If
.Pa logfile
.Ar logfile
is the string
.Pa syslog
.Dq Li syslog
then the log messages will be sent to the system log daemon by
.Xr syslog 3 ,
using the
.Va LOG_DAEMON
.Dv LOG_DAEMON
facility.
This is also the default.
.It Fl n
No verify.
The
.Nm
utility
will not verify the validity of the symbolic link it will be
returning, or that the user's home directory contains
sufficient disk-space for spooling.
@ -229,18 +237,17 @@ Mount options.
Mount options which
.Nm
will use to mount itself on top of
.Pa dirname .
.Ar dirname .
By default,
.Ar mount-options
is set to
.Qq ro .
.Dq Li ro .
If the system supports symbolic-link caching, default
options are set to
.Qq ro,nocache .
.Dq Li ro,nocache .
.It Fl p
Prints
.Va PID .
Outputs the process-id of
Print PID.
Outputs the process ID of
.Nm
to standard output where it can be saved into a file.
.It Fl v
@ -249,7 +256,8 @@ Displays version information to standard error.
.It Fl x Ar log-options
Specify run-time logging options.
The options are a comma separated
list chosen from: fatal, error, user, warn, info, map, stats, all.
list chosen from:
.Li fatal , error , user , warn , info , map , stats , all .
.It Fl C
Force
.Nm
@ -263,17 +271,17 @@ off the attribute-cache.
Select from a variety of debugging options.
Prefixing an
option with the string
.Qq no
.Dq Li no
reverses the effect of that option.
Options are cumulative.
The most useful option is
.Em all .
.Dq Li all .
Since this option is only used for debugging other options are not
documented here.
A fuller description is available in the program
source.
A
.Va SIGUSR1
.Dv SIGUSR1
sent to
.Nm
will cause it to dump its internal password map to the file
@ -296,13 +304,13 @@ are read and checked.
All other fields are ignored.
The file
.Ar password-file
must be compliant with
must otherwise be compliant with
.Ux
System 7 colon-delimited format
.Xr passwd 5 .
.El
.Sh FILES
.Bl -tag -width /axx
.Bl -tag -width ".Pa /var/hlfs"
.It Pa /hlfs
directory under which
.Nm
@ -338,6 +346,19 @@ user's home directory is accessible.
.%B Proc. LISA-VII, The 7th Usenix System Administration Conference
.%D November 1993
.Re
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Sh HISTORY
The
.Nm

View File

@ -36,18 +36,21 @@
.\" $Id: mk-amd-map.8,v 1.9.2.1 2006/01/02 18:48:26 ezk Exp $
.\" $FreeBSD$
.\"
.Dd Janary 2, 2006
.Dd January 2, 2006
.Dt MK-AMD-MAP 8
.Os
.Sh NAME
.Nm mk-amd-map
.Nd create database maps for Amd
.Nd create database maps for
.Xr amd 8
.Sh SYNOPSIS
.Nm
.Op Fl p
.Ar mapname
.Sh DESCRIPTION
The
.Nm
utility
creates the database maps used by the keyed map lookups in
.Xr amd 8 .
It reads input from the named file
@ -63,6 +66,22 @@ into one physical line.
.Sh SEE ALSO
.Xr amd.conf 5 ,
.Xr amd 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh AUTHORS
.An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
Department of Computing, Imperial College, London, UK.

File diff suppressed because it is too large Load Diff

View File

@ -51,12 +51,15 @@
.Nm
.Op Ar host
.Sh DESCRIPTION
The
.Nm
utility
is used to find out what
.Nm Amd
thinks are the first two network interfaces and network names/numbers
used, as well as the IP address used for
.Nm Amd
.Xr amd 8
thinks are the first two network
interfaces and network names/numbers used, as well as the IP address
used for
.Xr amd 8
to NFS-mount itself.
.Pp
If
@ -72,9 +75,25 @@ server
If not specified,
.Ar host
defaults to
.Dq localhost .
.Dq Li localhost .
.Sh SEE ALSO
.Xr amd 8
.Pp
.Dq am-utils
.Xr info 1
entry.
.Rs
.%A Erez Zadok
.%B "Linux NFS and Automounter Administration"
.%O ISBN 0-7821-2739-8
.%I Sybex
.%D 2001
.Re
.Pp
.Pa http://www.am-utils.org/
.Rs
.%T Amd \- The 4.4 BSD Automounter
.Re
.Sh HISTORY
The
.Nm