Merge branch 'vendor/GCC50'
[dragonfly.git] / contrib / amd / amq / amq.8
1 .\"
2 .\" Copyright (c) 1997-1999 Erez Zadok
3 .\" Copyright (c) 1990 Jan-Simon Pendry
4 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
5 .\" Copyright (c) 1990 The Regents of the University of California.
6 .\" 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. All advertising materials mentioning features or use of this software
20 .\"    must display the following acknowledgment:
21 .\"      This product includes software developed by the University of
22 .\"      California, Berkeley and its contributors.
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\"    may be used to endorse or promote products derived from this software
25 .\"    without specific prior written permission.
26 .\"
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .\" SUCH DAMAGE.
38 .\"
39 .\"     %W% (Berkeley) %G%
40 .\"
41 .\" $Id: amq.8,v 1.2 1999/01/10 21:53:58 ezk Exp $
42 .\" $FreeBSD: src/contrib/amd/amq/amq.8,v 1.5.2.3 2001/08/16 10:53:40 ru Exp $
43 .\" $DragonFly: src/contrib/amd/amq/amq.8,v 1.2 2003/06/17 04:23:57 dillon Exp $
44 .\"
45 .Dd March 16, 1991
46 .Dt AMQ 8
47 .Os
48 .Sh NAME
49 .Nm amq
50 .Nd automounter query tool
51 .Sh SYNOPSIS
52 .Nm amq
53 .Op Fl fmpsuvTU
54 .Op Fl h Ar hostname
55 .Op Fl l Ar log_file
56 .Op Fl x Ar log_options
57 .Op Fl D Ar debug_options
58 .Op Fl M Ar mountmap_entry
59 .Op Fl P Ar program_number
60 .Op Ar directory
61 .Ar ...
62 .Sh DESCRIPTION
63 .Nm Amq
64 provides a simple way of determining the current state of the
65 .Xr amd 8
66 program.
67 Communication is by
68 .Tn RPC .
69 Three modes of operation are supported by the current protocol.
70 By default a list of mount points and auto-mounted filesystems
71 is output.
72 An alternative host can be specified using the
73 .Fl h
74 option.
75 .Pp
76 If directory names are given, as output by default,
77 then per-filesystem information is displayed.
78 .Sh OPTIONS
79 .Bl -tag -width Ds
80 .It Fl f
81 Request automounter to flush the internal caches.
82 .It Fl h Ar hostname
83 Query alternate host
84 .Ar hostname .
85 By default the local host is used.  In an
86 .Tn HP-UX
87 cluster, the root server is queried by default, since
88 that is the system on which the automounter is normally run.
89 .It Fl l Ar log_file
90 Tell amd to use
91 .Ar log_file
92 as the log file name. 
93 For security reasons, this must be the same log file which
94 .Nm amd
95 used when started.  This option is therefore only useful to 
96 refresh
97 .Nm amd Ns \'s
98 open file handle on the log file, so that it can be rotated and compressed via
99 daily cron jobs.
100 .It Fl m
101 Request the automounter to provide a list of mounted filesystems,
102 including the number of references to each filesystem and any error
103 which occurred while mounting.
104 .It Fl p
105 Return the process ID of the remote or locally running
106 .Nm amd .  
107 Useful when you need to send a signal to the local
108 .Nm amd
109 process, and would rather not have to search through the process table.  This
110 option is used in the
111 .Pa ctl-amd
112 script.
113 .It Fl s
114 Request the automounter to provide system-wide mount statistics.
115 .It Fl u
116 Request the automounter to unmount the named filesystems
117 instead of providing information about them.  Unmounts are requested,
118 not forced.  They merely cause the mounted filesystem to timeout,
119 which will be picked up by
120 .Nm amd Ns \'s
121 main scheduler thus causing the normal timeout action to be taken.
122 .It Fl v
123 Request the automounter to provide version information.  This is a subset
124 of the information provided by
125 .Nm amd Ns \'s Fl v
126 option.
127 .It Fl x Ar log_options
128 Ask the automounter to use the logging options specified in 
129 .Ar log_options
130 from now on.
131 .It Fl D Ar log_options
132 Ask the automounter to use the debugging options specified in 
133 .Ar debug_options
134 from now on.
135 .It Fl M
136 Pass a mount map entry to 
137 .Nm amd
138 and wait for it to be evaluated, possibly causing a mount.
139 This option is highly insecure.  
140 By default,
141 .Nm amd
142 and 
143 .Nm amq
144 do not support it.
145 It is necessary to configure
146 .Nm am-utils
147 with 
148 .Ar --enable-amq-mount
149 to enable this option.
150 .It Fl P Ar program_number
151 Contact an alternate running 
152 .Nm amd 
153 that had registered itself on a different RPC
154 .Ar program_number 
155 and apply all other operations to that instance of the automounter.  
156 This is useful when running multiple copies of 
157 .Nm amd , 
158 and need to manage each one separately.  
159 If not specified, 
160 .Nm amq
161 will use the default program number for 
162 .Nm amd ,
163 300019.
164 For security reasons, the only alternate program numbers
165 .Nm amd
166 can use range from 300019 to 300029, inclusive.
167 .It Fl T
168 Contact
169 .Nm amd
170 using the TCP transport only.  
171 Normally 
172 .Nm amq
173 will try TCP, and if that fails, will try UDP.
174 .It Fl U
175 Contact 
176 .Nm amd
177 using UDP (connectionless) transport only. 
178 Normally
179 .Nm amq
180 will try TCP, and if that fails, will try UDP.
181 .El
182 .Sh FILES
183 .Bl -tag -width amq.x -compact
184 .It Pa amq.x
185 .Tn RPC
186 protocol description.
187 .El
188 .Sh CAVEATS
189 .Nm Amq
190 uses a Sun registered
191 .Tn RPC
192 program number (300019 decimal) which may not
193 be in the
194 .Pa /etc/rpc
195 database.
196 .Sh SEE ALSO
197 .Xr amd.conf 5 ,
198 .Xr amd 8
199 .Sh AUTHORS
200 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
201 Department of Computing, Imperial College, London, UK.
202 .Pp
203 .An Erez Zadok Aq ezk@cs.columbia.edu ,
204 Department of Computer Science, Columbia University, New York, USA.
205 .Pp
206 .An Other authors and contributors to 
207 .Nm am-utils
208 are listed in the
209 .Nm AUTHORS 
210 file distributed with
211 .Nm am-utils .
212 .Sh HISTORY
213 .Nm Amq
214 first appeared in
215 .Bx 4.4 .