summaryrefslogtreecommitdiffstats
path: root/contrib/amd/amd
diff options
context:
space:
mode:
authorobrien <obrien@FreeBSD.org>1998-09-12 04:04:59 +0000
committerobrien <obrien@FreeBSD.org>1998-09-12 04:04:59 +0000
commit3c3a03dc00f20f9346832e12f10338ab967b4143 (patch)
treed660dbe35c9f8c88d5047d09692ac74058220e86 /contrib/amd/amd
parent4faed0fd1dc0eff361ce9f718db938dd6d408198 (diff)
downloadFreeBSD-src-3c3a03dc00f20f9346832e12f10338ab967b4143.zip
FreeBSD-src-3c3a03dc00f20f9346832e12f10338ab967b4143.tar.gz
Merge our older Amd manpages with the new am-utils manpages.
The am-utils manpages were un-mandocafied, un4.4BSD'ed with CSRG copyrights regressed to 1989. This work was done by Brian Handy who I am very greatful to. (only a few minor tweaks by me) Submitted by: Brian Handy <handy@lambic.physics.montana.edu>
Diffstat (limited to 'contrib/amd/amd')
-rw-r--r--contrib/amd/amd/amd.8481
1 files changed, 232 insertions, 249 deletions
diff --git a/contrib/amd/amd/amd.8 b/contrib/amd/amd/amd.8
index cad42b3..5e5e5eb 100644
--- a/contrib/amd/amd/amd.8
+++ b/contrib/amd/amd/amd.8
@@ -38,315 +38,298 @@
.\"
.\" %W% (Berkeley) %G%
.\"
-.\" $Id: amd.8,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $
+.\" $Id: amd.8,v 1.2 1998/09/05 05:52:24 obrien Exp $
.\"
-.TH AMD 8 "3 November 1989"
-.SH NAME
-amd \- automatically mount file systems
-.SH SYNOPSIS
-.B amd
-.B \-H
-.br
-.B amd
-[
-.BI \-F " conf_file"
-]
-.br
-.B amd
-[
-.B \-nprvHS
-] [
-.BI \-a " mount_point"
-] [
-.BI \-c " duration"
-] [
-.BI \-d " domain"
-] [
-.BI \-k " kernel-arch"
-] [
-.BI \-l " logfile"
-] [
-.BI \-o " op_sys_ver"
-] [
-.BI \-t " interval.interval"
-] [
-.BI \-w " interval"
-] [
-.BI \-x " log-option"
-] [
-.BI \-y " YP-domain"
-] [
-.BI \-C " cluster-name"
-] [
-.BI \-D " option"
-] [
-.BI \-F " conf_file"
-] [
-.BI \-O " op_sys_name"
-] [
-.BI \-T " tag"
-]
-[
-.I directory
-.I mapname
-.RI [ " \-map-options " ]
-] .\|.\|.
-.SH DESCRIPTION
-.B Amd
-is a daemon that automatically mounts filesystems
-whenever a file or directory
-within that filesystem is accessed.
-Filesystems are automatically unmounted when they
-appear to have become quiescent.
-.LP
-.B Amd
+.Dd April 19, 1994
+.Dt AMD 8
+.Os
+.Sh NAME
+.Nm amd
+.Nd automatically mount file systems
+.Sh SYNOPSIS
+.Nm amd
+.Op Fl F Ar conf_file
+.Nm amd
+.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 interval.interval
+.Bk -words
+.Op Fl w Ar interval
+.Ek
+.Op Fl x Ar log-option
+.Op Fl y Ar YP-domain
+.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
+.Op Fl T Ar tag
+.Oo
+.Ar directory mapname
+.Op Fl map-options
+.Oc
+.Ar ...
+.Sh DESCRIPTION
+.Nm Amd
+is a daemon that automatically mounts filesystems whenever a file or directory
+within that filesystem is accessed. Filesystems are automatically unmounted
+when they appear to be quiescent.
+.Pp
+.Nm Amd
operates by attaching itself as an
-.SM NFS
+.Tn NFS
server to each of the specified
-.IB directories .
+.Ar directories .
Lookups within the specified directories
are handled by
-.BR amd ,
+.Nm amd ,
which uses the map defined by
-.I mapname
-to determine how to resolve the lookup.
-Generally, this will be a host name, some filesystem information
-and some mount options for the given filesystem.
-.LP
+.Ar mapname
+to determine how to resolve the lookup. Generally, this will be a host name,
+some filesystem information and some mount options for the given filesystem.
+.Pp
In the first form depicted above,
-.B amd
+.Nm amd
will print a short help string. In the second form, if no options are
-specified, or the
-.B -F
-is used,
-.B amd
-will read configuration parameters from the file
-.I conf_file
+specified, or if the
+.Fl F
+is used,
+.Nm amd
+will read configuration parameters from the file
+.Ar conf_file
which defaults to
-.BR /etc/amd.conf .
+.Pa /etc/amd.conf .
The last form is described below.
-.SH OPTIONS
-
-.\"*******************************************************"
-
-.TP
-.BI \-a " temporary-directory"
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl a Ar temporary-directory
Specify an alternative location for the real mount points.
The default is
-.BR /a .
-
-.TP
-.BI \-c " duration"
+.Pa /a .
+.It Fl c Ar duration
Specify a
-.IR duration ,
+.Ar duration ,
in seconds, that a looked up name remains
cached when not in use. The default is 5 minutes.
-
-.TP
-.BI \-d " domain"
+.It Fl d Ar domain
Specify the local domain name. If this option is not
given the domain name is determined from the hostname.
-
-.TP
-.BI \-k " kernel-arch"
+.It Fl k Ar kernel-arch
Specifies the kernel architecture. This is used solely
to set the ${karch} selector.
-
-.TP
-.BI \-l " logfile"
+.It Fl l Ar logfile
Specify a logfile in which to record mount and unmount events.
If
-.I logfile
+.Ar logfile
is the string
-.B syslog
-then the log messages will be sent to the system log daemon by
-.IR 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. For example, if
-.I logfile
+.Em syslog ,
+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.
+For example, if
+.Ar logfile
is the string
-.B syslog:local7
+.Nm syslog:local7
then
-.B Amd
-will log messages via
-.IR syslog (3)
+.Nm amd
+will log messages via
+.Xr syslog 3
using the LOG_LOCAL7 facility (if it exists on the system).
-
-.TP
-.B \-n
+.It Fl n
Normalize hostnames.
-The name refereed to by ${rhost} is normalized relative to the
+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.
-
-.TP
-.BI \-o " 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.
-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
-.B \-p
-Print PID.
+.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.
+For example, if the build in version is
+.Dq 2.5.1 ,
+you can override it to
+.Dq 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
-.B amd
+.Nm amd
to standard output where it can be saved into a file.
-
-.TP
-.B \-r
+.It Fl r
Restart existing mounts.
-.B Amd
+.Nm Amd
will scan the mount file table to determine which filesystems
are currently mounted. Whenever one of these would have
been auto-mounted,
-.B amd
-.I inherits
+.Nm amd
+.Em inherits
it.
-
-.TP
-.BI \-t " interval.interval"
+.It Fl t Ar interval.interval
Specify the
-.IR interval ,
-in tenths of a second, between NFS/RPC/UDP retries.
-The default is 0.8 seconds.
-The second values alters the restransmit counter.
-Useful defaults are supplied if either or both
-values are missing.
-
-.TP
-.B \-v
+.Ar interval ,
+in tenths of a second, between
+.Tn NFS/RPC/UDP
+retries. The default is 0.8 seconds. The second values alters the retransmit
+counter. Useful defaults are supplied if either or both values are missing.
+.It Fl v
Version. Displays version and configuration information on standard error.
-
-.TP
-.BI \-w " interval"
+.It Fl w Ar interval
Specify an
-.IR interval ,
-in seconds, between attempts to dismount
-filesystems that have exceeded their cached times.
-The default is 2 minutes.
-
-.TP
-.BI \-x " options"
-Specify run-time logging options. The options are a comma separated
-list chosen from: fatal, error, user, warn, info, map, stats, all.
-
-.TP
-.BI \-y " domain"
-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
+.Ar interval ,
+in seconds, between attempts to dismount filesystems 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.
+.It Fl y Ar domain
+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.
-
-.TP
-.BI \-C " cluster-name"
+.It Fl C Ar cluster-name
Specify an alternative HP-UX cluster name to use.
-
-.TP
-.BI \-D " option"
+.It Fl D Ar option
Select from a variety of debug options. Prefixing an
-option with the strings
-.B no
+option with the string
+.Em no
reverses the effect of that option. Options are cumulative.
The most useful option is
-.BR all .
+.Ar all .
+.Pp
Since
-.I \-D
+.Fl D
is only used for debugging other options are not documented here:
-the current supported set of options is listed by the \-v option
+the current supported set of options is listed by the
+.Fl v
+option
and a fuller description is available in the program source.
-
-.TP
-.BI \-F " conf_file"
-Specify an amd configuration file to use. See
-.BR amd.conf (5)
+.It Fl F Ar conf_file
+Specify an
+.Nm amd
+configuration file to use. See
+.Xr amd.conf 5
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
-.I 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 had been processed, regardless of the actual location of this option
-on the command line.
-
-.TP
-.B \-H
+.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.
+.It Fl H
Print help and usage string.
-
-.TP
-.BI \-O " 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 ``sunos5'', you can override it to
-``sos5'', and use older maps which were written with the latter in mind.
-
-.TP
-.B \-S
-Do not lock the running executable pages of amd into memory. To improve
-amd's performance, systems that support the
-.BR plock (3)
-call, could lock the amd process into memory. This way there is less chance
-the operating system will schedule, page out, and swap the amd process as
-needed. This tends improves amd's performance, at the cost of reserving the
-memory used by the amd process (making it unavailable for other processes).
+.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 ,
+you can override it to
+.Dq 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
+into memory. To improve
+.Nm amd's
+performance, systems that support the
+.Xr plock 3
+call, could lock the
+.Nm amd
+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 tends to improve
+.Nm amd's
+performance, at the cost of reserving the memory used by the
+.Nm amd
+process
+.Pq making it unavailable for other processes .
If this behavior is not desired, use the
-.B \-S
+.Fl S
option.
-
-.TP
-.BI \-T " tag"
+.It Fl T Ar tag
Specify a tag to use with
-.BR amd.conf (5).
-All map entries tagged with
-.I tag
-will be processed. Map entries that are not tagged are always processed.
+.Xr amd.conf 5.
+All Map entries tagged with tag will be processed.
+Map entries that are not tagged are always processed.
Map entries that are tagged with a tag other than
-.I tag
+.Ar tag
will not be processed.
-
-.SH FILES
-.PD 0
-.TP 5
-.B /a
+.Sh FILES
+.Bl -tag -width /axx
+.It Pa /a
directory under which filesystems are dynamically mounted
-.TP 5
-.B /etc/amd.conf
+.It Pa /etc/amd.conf
default configuration file
-.PD
-.SH CAVEATS
+.El
+.Sh CAVEATS
Some care may be required when creating a mount map.
-.LP
-Symbolic links on an NFS filesystem can be incredibly inefficient.
-In most implementations of NFS, their interpolations are not cached
-by the kernel and each time a symlink is encountered during a
-.I lookuppn
-translation it costs an RPC call to the NFS server.
-It would appear that a large improvement in real-time
+.Pp
+Symbolic links on an
+.Tn NFS
+filesystem 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
+.Em lookuppn
+translation it costs an
+.Tn RPC
+call to the
+.Tn NFS
+server.
+A large improvement in real-time
performance could be gained by adding a cache somewhere.
-Replacing symlinks with a suitable incarnation of the auto-mounter
+Replacing
+.Xr symlink 2
+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.
-.LP
+.Pp
A weird imagination is most useful to gain full advantage of all
the features.
-.SH "SEE ALSO"
-.BR domainname (1),
-.BR hostname (1),
-.BR syslog (3).
-.BR amd.conf (5),
-.BR mtab (5),
-.BR amq (8),
-.BR automount (8),
-.BR mount (8),
-.BR umount (8),
-.LP
-.I "Amd \- The 4.4 BSD Automounter"
-.SH AUTHORS
-Jan-Simon Pendry <jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
-.P
-Erez Zadok <ezk@cs.columbia.edu>, Department of Computer Science, Columbia
-University, New York, USA.
-.P
-Other authors and contributors to am-utils are listed in the
-.B AUTHORS
+.Sh SEE ALSO
+.Xr domainname 1 ,
+.Xr hostname 1 ,
+.Xr syslog 3 ,
+.Xr amd.conf 5 ,
+.Xr mtab 5 ,
+.Xr amq 8 ,
+.Xr automount 8 ,
+.Xr mount 8 ,
+.Xr umount 8
+.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.
+.Pp
+.An Erez Zadok Aq ezk@cs.columbia.edu ,
+Department of Computer Science, Columbia University,
+New York, USA.
+.Pp
+.An Other authors and contributors to am-utils are listed in the
+.Nm AUTHORS
file distributed with am-utils.
+.Sh HISTORY
+The
+.Nm amd
+utility first appeared in 4.4BSD.
OpenPOWER on IntegriCloud