xref: /openbsd/usr.sbin/amd/amq/amq.8 (revision d485f761)
1.\"
2.\" Copyright (c) 1990 Jan-Simon Pendry
3.\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
4.\" Copyright (c) 1990, 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" This code is derived from software contributed to Berkeley by
8.\" Jan-Simon Pendry at Imperial College, London.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     from: @(#)amq.8	8.3 (Berkeley) 4/18/94
39.\"	$Id: amq.8,v 1.8 2001/08/03 16:03:02 mpech Exp $
40.\"
41.Dd March 16, 1991
42.Dt AMQ 8
43.Os
44.Sh NAME
45.Nm amq
46.Nd automounter query tool
47.Sh SYNOPSIS
48.Nm amq
49.Op Fl f
50.Op Fl h Ar hostname
51.\".Op Fl M Ar mountmap_entry
52.Op Fl m
53.Op Fl s
54.Op Fl u
55.Op Fl v
56.Op Ar directory
57.Ar ...
58.Sh DESCRIPTION
59.Nm amq
60provides a simple way of determining the current state of the
61.Xr amd 8
62program.
63Communication is by
64.Tn RPC .
65Three modes of operation are supported by the current protocol.
66By default a list of mount points and auto-mounted filesystems
67is output.
68An alternative host can be specified using the
69.Fl h
70option.
71.Pp
72If directory names are given, as output by default,
73then per-filesystem information is displayed.
74.Pp
75The options are as follows:
76.Bl -tag -width Ds
77.It Fl f
78Request automounter to flush the internal caches.
79.It Fl h Ar hostname
80Query alternate host
81.Ar hostname .
82By default the local host is used.
83In an
84.Tn HP-UX
85cluster, the root server is queried by default, since
86that is the system on which the automounter is normally run.
87.It Fl m
88Request the automounter to provide a list of mounted filesystems,
89including the number of references to each filesystem and any error
90which occurred while mounting.
91.It Fl s
92Request the automounter to provide system-wide mount statistics.
93.It Fl u
94Request the automounter to unmount the named filesystems
95instead of providing information about them.
96Unmounts are requested, not forced.
97They merely cause the mounted filesystem to timeout,
98which will be picked up by
99.Nm amd Ns \'s
100main scheduler thus causing the normal timeout action to be taken.
101.It Fl v
102Request the automounter to provide version information.
103This is a subset of the information provided by
104.Xr amd Ns \'s Fl v
105option.
106.\".It Fl M
107.\"Request automounter to add the given map entry to the root map and then
108.\"trigger a mount request for it.
109.El
110.Sh FILES
111.Bl -tag -width amq.xxxxx -compact
112.It Pa amq.x
113.Tn RPC
114protocol description
115.El
116.Sh SEE ALSO
117.Xr amd 8
118.Sh AUTHORS
119.An Jan-Simon Pendry
120<jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
121.\" .Sh HISTORY
122.\" .Nm amq
123.\" .At
124.Sh CAVEATS
125.Nm amq
126uses a Sun registered
127.Tn RPC
128program number (300019 decimal) which may not
129be in the
130.Pa /etc/rpc
131database.
132