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