BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / amd / amd / amd.8

diff --git a/usr/src/usr.sbin/amd/amd/amd.8 b/usr/src/usr.sbin/amd/amd/amd.8
index 5f198ad..153ef5b 100644 (file)
--- a/usr/src/usr.sbin/amd/amd/amd.8
+++ b/usr/src/usr.sbin/amd/amd/amd.8
@@ -1,224 +1,259 @@
-.\" $Id: amd.8,v 5.2 90/06/23 22:21:12 jsp Rel $
+.\"

 .\" Copyright (c) 1989 Jan-Simon Pendry
 .\" Copyright (c) 1989 Imperial College of Science, Technology & Medicine
 .\" 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.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Jan-Simon Pendry at Imperial College, London.
 .\"
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Jan-Simon Pendry at Imperial College, London.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.\"    @(#)amd.8       5.1 (Berkeley) 6/29/90
+.\"     @(#)amd.8      5.4 (Berkeley) 5/12/91

 .\"
 .\"

-.TH AMD 8 "June 29, 1990"
-.SH NAME
-amd \- automatically mount file systems
-.SH SYNOPSIS
-.B amd
-[
-.B \-nprv
-] [
-.BI \-a " mount_point"
-] [
-.BI \-c " duration"
-] [
-.BI \-d " domain"
-] [
-.BI \-k " kernel-arch"
-] [
-.BI \-l " logfile"
-] [
-.BI \-t " interval.interval"
-] [
-.BI \-w " interval"
-] [
-.BI \-x " log-option"
-] [
-.BI \-y " YP-domain"
-] [
-.BI \-C " cluster-name"
-] [
-.BI \-D " option"
-]
-[
-.I directory
-.I mapname
-.RI [ " \-map-options " ]
-] .\|.\|.
-.SH DESCRIPTION
-.B Amd
+.\" $Id: amd.8,v 5.2.1.2 91/05/07 22:20:43 jsp Alpha $
+.\"
+.Dd March 17, 1991
+.Dt AMD 8
+.Os
+.Sh NAME
+.Nm amd
+.Nd automatically mount file systems
+.Sh SYNOPSIS
+.Nm amd
+.Op Fl nprv
+.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 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
+.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
 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
-has been designed as a value-added replacement
-for the SunOS 4
-.IR automount (8)
-program.
-Considerable design effort has been expended in making
-.B amd
-robust in the face of
-.SM NFS
-servers going down.
-.B Amd
+appear to be quiescent.
+.Pp
+.Nm Amd

 operates by attaching itself as an
 operates by attaching itself as an

-.SM NFS
+.Tn NFS

 server to each of the specified
 server to each of the specified

-.IB directories .
+.Ar directories .

 Lookups within the specified directories
 are handled by
 Lookups within the specified directories
 are handled by

-.BR amd ,
-which uses the map contained in
-.I mapname
+.Nm amd ,
+which uses the map defined by
+.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.
 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.

-.SH OPTIONS
-.TP
-.B \-n
-Normalize hostnames.
-The name refered to by ${rhost} are normalized relative to the
-host database before being used.  The effect is to translate
-aliases into ``official'' names.
-.TP
-.B \-p
-Print PID.
-Outputs the process-id of
-.B amd
-to standard output where it can be saved into a file.
-.TP
-.B \-r
-Restart existing mounts.
-.B 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
-it.
-.TP
-.B \-v
-Version.  Displays version and configuration information on standard error.
-If you send a bug report, this should be used to determine
-which version of
-.B amd
-you are using.
-.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
 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
 Specify a

-.IR duration ,
+.Ar duration ,

 in seconds, that a looked up name remains
 cached when not in use.  The default is 5 minutes.
 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.
 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.
 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
 Specify a logfile in which to record mount and unmount events.
 If

-.I logfile
+.Ar logfile

 is the string
 is the string

-.B syslog
-then the log messages will be sent to the system log daemon by
-.IR syslog (3).
-This is only available on certain systems (e.g.
-.I not
-.SM HP-UX
-and early versions of Ultrix).
-.TP
-.BI \-t " interval.interval"
+.Em syslog ,
+the log messages will be sent to the system log daemon by
+.Xr syslog 3 .
+.It Fl n
+Normalize hostnames.
+The name refered to by ${rhost} is normalized relative to the
+host database before being used.  The effect is to translate
+aliases into ``official'' names.
+.It Fl p
+Print
+.Em PID .
+Outputs the process-id of
+.Nm amd
+to standard output where it can be saved into a file.
+.It Fl r
+Restart existing mounts.
+.Nm Amd
+will scan the mount file table to determine which filesystems
+are currently mounted.  Whenever one of these would have
+been auto-mounted,
+.Nm amd
+.Em inherits
+it.
+.It Fl t Ar interval.interval

 Specify the
 Specify the

-.IR interval ,
-in tenths of a second, between NFS/RPC/UDP retries.
+.Ar interval ,
+in tenths of a second, between
+.Tn 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.
 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
-.BI \-w " interval"
+.It Fl v
+Version.  Displays version and configuration information on standard error.
+.It Fl w Ar interval

 Specify an
 Specify an

-.IR interval ,
+.Ar interval ,

 in seconds, between attempts to dismount
 filesystems that have exceeded their cached times.
 The default is 2 minutes.
 in seconds, between attempts to dismount
 filesystems that have exceeded their cached times.
 The default is 2 minutes.

-.TP
-.BI \-y " domain"
-Specify an alternative YP domain from which to fetch the YP maps.
+.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.
 The default is the system domain name.

-.TP
-.BI \-x " options"
+This option is ignored if
+.Tn NIS
+support is not available.
+.It Fl x Ar options

 Specify run-time logging options.  The options are a comma separated
 Specify run-time logging options.  The options are a comma separated

-list chosen from: fatal, error, user, warn, info, all.
-.TP
-.BI \-D " option"
+list chosen from: fatal, error, user, warn, info, map, stats, all.
+.It Fl D Ar option

 Select from a variety of debug options.  Prefixing an
 option with the strings
 Select from a variety of debug options.  Prefixing an
 option with the strings

-.B no
+.Em no

 reverses the effect of that option.  Options are cumulative.
 The most useful option is
 reverses the effect of that option.  Options are cumulative.
 The most useful option is

-.BR all .
+.Ar all .
+.El
+.Pp

 Since
 Since

-.I \-D
+.Fl D

 is only used for debugging other options are not documented here:
 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.
 and a fuller description is available in the program source.

-.SH FILES
-.PD 0
-.TP 5
-.B /a
+.Sh FILES
+.Bl -tag -width /axx
+.It Pa /a

 directory under which filesystems are dynamically mounted
 directory under which filesystems are dynamically mounted

-.PD
-.SH CAVEATS
+.El
+.Sh CAVEATS

 Some care may be required when creating a mount map.
 Some care may be required when creating a mount map.

-.LP
-Symbolic links on an NFS filesystem are incredibly inefficient.
-Their interpolations are not cached by the kernel and each time a symlink is
+.Pp
+Symbolic links on an
+.Tn NFS
+filesystem can be incredibly inefficient.
+In most implementations of NFS, their interpolations are not cached by
+the kernel and each time a symbolic link is

 encountered during a
 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
+.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.
 performance could be gained by adding a cache somewhere.

-Replacing symlinks with a suitable incarnation of the auto-mounter
+Replacing
+.Xr symlinks 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.
 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.
 A weird imagination is most useful to gain full advantage of all
 the features.

-.SH "SEE ALSO"
-.BR amq (8),
-.BR domainname (1),
-.BR hostname (1),
-.BR automount (8),
-.BR mount (8),
-.BR umount (8),
-.BR mtab (5),
-.LP
-.I "Amd \- An Automounter"
-.SH AUTHOR
-Jan-Simon Pendry <jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
+.Sh SEE ALSO
+.Xr amq 8 ,
+.Xr domainname 1 ,
+.Xr hostname 1 ,
+.Xr automount 8 ,
+.Xr mount 8 ,
+.Xr umount 8 ,
+.Xr mtab 5 ,
+.Rs
+.%T Amd \- The 4.4 BSD Automounter
+.Re
+.Sh AUTHOR
+.An Jan-Simon Pendry
+<jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
+.Sh HISTORY
+.Nm Amd
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.At