BSD 4_3_Net_2 release

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

diff --git a/usr/src/usr.sbin/amd/amq/amq.8 b/usr/src/usr.sbin/amd/amq/amq.8
index ea935ec..d1ede15 100644 (file)
--- a/usr/src/usr.sbin/amd/amq/amq.8
+++ b/usr/src/usr.sbin/amd/amq/amq.8
@@ -1,106 +1,133 @@
-.\" $Id: amq.8,v 5.2 90/06/23 22:21:16 jsp Rel $
+.\"

 .\" Copyright (c) 1990 Jan-Simon Pendry
 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
 .\" 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.
+.\" Copyright (c) 1990, 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.
+.\"
+.\"     @(#)amq.8      5.6 (Berkeley) 8/5/91

 .\"
 .\"

-.\"    @(#)amq.8       5.1 (Berkeley) 6/29/90
+.\" $Id: amq.8,v 5.2.1.2 91/05/07 22:20:44 jsp Alpha $

 .\"
 .\"

-.TH AMQ 8 "June 29, 1990"
-.SH NAME
-amq \- automounter query tool
-.SH SYNOPSIS
-.B amq
-[
-.BI \-h " hostname"
-] [
-.B \-f
-] [
-.B \-m
-] [
-.B \-s
-] [
-.B \-u
-]
-[
-.I directory
-] .\|.\|.
-.SH DESCRIPTION
-.B Amq
-provides a simple way of determining the current state of
-.B amd
+.Dd March 16, 1991
+.Dt AMQ 8
+.Os
+.Sh NAME
+.Nm amq
+.Nd automounter query tool
+.Sh SYNOPSIS
+.Nm amq
+.Op Fl f
+.Op Fl h Ar hostname
+.Op Fl M Ar mountmap_entry
+.Op Fl m
+.Op Fl s
+.Op Fl u
+.Op Fl v
+.Op Ar directory
+.Ar ...
+.Sh DESCRIPTION
+.Nm Amq
+provides a simple way of determining the current state of the
+.Xr amd 8

 program.
 Communication is by
 program.
 Communication is by

-.SM RPC.
+.Tn RPC .

 Three modes of operation are supported by the current protocol.
 By default a list of mount points and auto-mounted filesystems
 is output.
 An alternative host can be specified using the
 Three modes of operation are supported by the current protocol.
 By default a list of mount points and auto-mounted filesystems
 is output.
 An alternative host can be specified using the

-.I \-h
+.Fl h

 option.
 option.

-.LP
+.Pp

 If directory names are given, as output by default,
 then per-filesystem information is displayed.
 If directory names are given, as output by default,
 then per-filesystem information is displayed.

-.SH OPTIONS
-The
-.I \-h
-option specifies an alternate host to query.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl f
+Request automounter to flush the internal caches.
+.It Fl h Ar hostname
+Query alternate host
+.Ar hostname .

 By default the local host is used.  In an
 By default the local host is used.  In an

-.SM HP-UX
+.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.

-.LP
-The
-.I \-f
-option asks the automounter to flush the internal
-mount map cache.
-The
-.I \-m
-option asks the automounter to provide a list of mounted filesystems,
+.It Fl m
+Request the automounter to provide a list of mounted filesystems,

 including the number of references to each filesystem and any error
 which occured while mounting.
 including the number of references to each filesystem and any error
 which occured while mounting.

-The
-.I \-s
-option asks the automounter to provide system-wide mount statistics.
-.LP
-The
-.I \-u
-option asks the automounter to unmount the named filesystems
+.It Fl s
+Request the automounter to provide system-wide mount statistics.
+.It Fl u
+Request the automounter to unmount the named filesystems

 instead of providing information about them.  Unmounts are requested,
 not forced.  They merely cause the mounted filesystem to timeout,
 which will be picked up by
 instead of providing information about them.  Unmounts are requested,
 not forced.  They merely cause the mounted filesystem to timeout,
 which will be picked up by

-.BR amd 's
+.Xr amd Ns \'s

 main scheduler thus causing the normal timeout action to be taken.
 main scheduler thus causing the normal timeout action to be taken.

-.SH FILES
-.PD 0
-.TP 20
-.B amq.x
-.SM RPC
+.It Fl v
+Request the automounter to provide version information.  This is a subset
+of the information provided by
+.Xr amd Ns \'s
+.It Fl v
+option.
+.It Fl M
+Request automounter to add the given map entry to the root map and then
+trigger a mount request for it.
+.El
+.Sh FILES
+.Bl -tag -width amq.xxxxx -compact
+.Bl -tag -width Ds
+.It Pa amq.x
+.Tn RPC

 protocol description.
 protocol description.

-.SH CAVEATS
-.B Amq
+.El
+.Sh CAVEATS
+.Nm Amq

 uses a Sun registered
 uses a Sun registered

-.SM RPC
+.Tn RPC

 program number (300019 decimal) which may not
 program number (300019 decimal) which may not

-be in the /etc/rpc database.
-.SH "SEE ALSO"
-.BR amd (8)
-.SH AUTHOR
-Jan-Simon Pendry <jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
+be in the
+.Pa /etc/rpc
+database.
+.Sh SEE ALSO
+.Xr amd 8
+.Sh AUTHOR
+.An Jan-Simon Pendry
+<jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
+.Sh HISTORY
+The
+.Nm amq
+tool is
+.Ud .