xref: /openbsd-src/usr.sbin/amd/amq/amq.8 (revision cd4e86f620b9f79a8002d3f07aba0d6dd466ce69)
1.\"	$OpenBSD: amq.8,v 1.16 2019/06/02 06:53:11 bentley 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: June 2 2019 $
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 RPC.
55Three modes of operation are supported by the current protocol.
56By default a list of mount points and auto-mounted filesystems
57is output.
58An alternative host can be specified using the
59.Fl h
60option.
61.Pp
62If directory names are given, as output by default,
63then per-filesystem information is displayed.
64.Pp
65The options are as follows:
66.Bl -tag -width Ds
67.It Fl f
68Request automounter to flush the internal caches.
69.It Fl h Ar hostname
70Query alternate host
71.Ar hostname .
72By default the local host is used.
73In an HP-UX cluster, the root server is queried by default, since
74that is the system on which the automounter is normally run.
75.It Fl m
76Request the automounter to provide a list of mounted filesystems,
77including the number of references to each filesystem and any error
78which occurred while mounting.
79.It Fl s
80Request the automounter to provide system-wide mount statistics.
81.It Fl u
82Request the automounter to unmount the named filesystems
83instead of providing information about them.
84Unmounts are requested, not forced.
85They merely cause the mounted filesystem to timeout,
86which will be picked up by
87.Xr amd 8 Ns 's
88main scheduler thus causing the normal timeout action to be taken.
89.It Fl v
90Request the automounter to provide version information.
91This is a subset of the information provided by
92.Xr amd 8 Ns 's Fl v
93option.
94.\".It Fl M
95.\"Request automounter to add the given map entry to the root map and then
96.\"trigger a mount request for it.
97.El
98.Sh FILES
99.Bl -tag -width amq.xxxxx -compact
100.It Pa amq.x
101RPC protocol description
102.El
103.Sh SEE ALSO
104.Xr amd 8
105.Sh AUTHORS
106.An Jan-Simon Pendry Aq Mt jsp@doc.ic.ac.uk ,
107Department of Computing, Imperial College, London, UK.
108.\" .Sh HISTORY
109.\" .Nm amq
110.\" .At
111.Sh CAVEATS
112.Nm amq
113uses a Sun registered RPC program number (300019 decimal) which may not
114be in the
115.Pa /etc/rpc
116database.
117