external/bsd/am-utils/dist/amq/amq.8

   1 .\"     $NetBSD: amq.8,v 1.1.1.2 2009/03/20 20:26:50 christos Exp $
   2 .\"
   3 .\"
   4 .\" Copyright (c) 1997-2009 Erez Zadok
   5 .\" Copyright (c) 1990 Jan-Simon Pendry
   6 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
   7 .\" Copyright (c) 1990 The Regents of the University of California.
   8 .\" All rights reserved.
   9 .\"
  10 .\" This code is derived from software contributed to Berkeley by
  11 .\" Jan-Simon Pendry at Imperial College, London.
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\" 3. All advertising materials mentioning features or use of this software
  22 .\"    must display the following acknowledgment:
  23 .\"      This product includes software developed by the University of
  24 .\"      California, Berkeley and its contributors.
  25 .\" 4. Neither the name of the University nor the names of its contributors
  26 .\"    may be used to endorse or promote products derived from this software
  27 .\"    without specific prior written permission.
  28 .\"
  29 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  30 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  33 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  34 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  35 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  36 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  38 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  39 .\" SUCH DAMAGE.
  40 .\"
  41 .\"
  42 .\" File: am-utils/amq/amq.8
  43 .\"
  44 .TH AMQ 8 "25 April 1989"
  45 .SH NAME
  46 amq \- automounter query tool
  47 .SH SYNOPSIS
  48 .B amq
  49 [
  50 .BI \-fmpqsvwHTU
  51 ] [
  52 .BI \-h " hostname"
  53 ] [
  54 .BI \-l " log_file"
  55 ] [
  56 .BI \-x " log_options"
  57 ] [
  58 .BI \-D " debug_options"
  59 ] [
  60 .BI \-P " program_number"
  61 ] [[
  62 .B \-u
  63 ]
  64 .I directory .\|.\|.
  65 ]
  66 .SH DESCRIPTION
  67 .B Amq
  68 provides a simple way of determining the current state of
  69 .B amd
  70 program.
  71 Communication is by
  72 .SM RPC.
  73 Three modes of operation are supported by the current protocol.  By default
  74 a list of mount points and auto-mounted filesystems is output.  An
  75 alternative host can be specified using the
  76 .I \-h
  77 option.
  78 .LP
  79 If
  80 .I directory
  81 names are given, as output by default, then per-filesystem
  82 information is displayed.
  83 .SH OPTIONS
  84
  85 .TP
  86 .B \-f
  87 Ask the automounter to flush the internal caches and reload all the maps.
  88
  89 .TP
  90 .BI \-h " hostname"
  91 Specify an alternate host to query.  By default the local host is used.  In
  92 an
  93 .SM HP-UX
  94 cluster, the root server is queried by default, since that is the system on
  95 which the automounter is normally run.
  96
  97 .TP
  98 .BI \-l " log_file"
  99 Tell amd to use
 100 .I log_file
 101 as the log file name.  For security reasons, this must be the same log file
 102 which amd used when started.  This option is therefore only useful to
 103 refresh amd's open file handle on the log file, so that it can be rotated
 104 and compressed via daily cron jobs.
 105
 106 .TP
 107 .B \-m
 108 Ask the automounter to provide a list of mounted filesystems, including the
 109 number of references to each filesystem and any error which occurred while
 110 mounting.
 111
 112 .TP
 113 .B \-p
 114 Return the process ID of the remote or locally running amd.  Useful when you
 115 need to send a signal to the local amd process, and would rather not have to
 116 search through the process table.  This option is used in the
 117 .I ctl-amd
 118 script.
 119
 120 .TP
 121 .B \-q
 122 Suppress error messages produced when attempting synchronous unmounts
 123 with the
 124 .B \-u
 125 option.
 126
 127 .TP
 128 .B \-s
 129 Ask the automounter to provide system-wide mount statistics.
 130
 131 .TP
 132 .B \-u
 133 Ask the automounter to unmount the filesystems named in
 134 .I directory
 135 instead of providing
 136 information about them.  Unmounts are requested, not forced.  They merely
 137 cause the mounted filesystem to timeout, which will be picked up by
 138 .BR amd 's
 139 main scheduler thus causing the normal timeout action to be taken.
 140 If the
 141 .B \-u
 142 option is repeated,
 143 .B amq
 144 will attempt to unmount the file system synchronously by waiting until
 145 the timeout action is taken and returning an error if the unmount
 146 fails.
 147 Any error messages produced may be suppressed with the
 148 .B \-q
 149 option.
 150
 151 .TP
 152 .B \-v
 153 Ask the automounter for its version information.  This is a subset of the
 154 information output by
 155 .BR amd 's
 156 .I -v
 157 option.
 158
 159 .TP
 160 .B \-w
 161 Translate a full pathname as returned by
 162 .IR getcwd (3)
 163 into a short
 164 .B Amd
 165 pathname that goes through its mount points.   This option requires that
 166 .B Amd
 167 is running.
 168
 169 .TP
 170 .BI \-x " log_options"
 171 Ask the automounter to use the logging options specified in
 172 .I log_options
 173 from now on.  Note that the "fatal" and "error" options cannot be turned
 174 off.
 175
 176 .TP
 177 .BI \-D " debug_options"
 178 Ask the automounter to use the debugging options specified in
 179 .I debug_options
 180 from now on.
 181
 182 .TP
 183 .B \-H
 184 Display short usage message.
 185
 186 .TP
 187 .BI \-P " program_number"
 188 Contact an alternate running amd that had registered itself on a different
 189 RPC
 190 .I program_number
 191 and apply all other operations to that instance of the automounter.  This is
 192 useful when you run multiple copies of amd, and need to manage each
 193 one separately.  If not specified, amq will use the default program number
 194 for amd, 300019.  For security reasons, the only alternate program numbers
 195 amd can use range from 300019 to 300029, inclusive.
 196
 197 .TP
 198 .B \-T
 199 Contact
 200 .B amd
 201 using the TCP transport only.  Normally
 202 .B amq
 203 will try TCP, and if that failed, will try UDP.
 204
 205 .TP
 206 .B \-U
 207 Contact
 208 .B amd
 209 using UDP (connectionless) transport only.  Normally
 210 .B amq
 211 will try TCP, and if that failed, will try UDP.
 212
 213 .SH FILES
 214 .TP 20
 215 .B amq.x
 216 .SM RPC
 217 protocol description.
 218
 219 .SH CAVEATS
 220 .B Amq
 221 uses a Sun registered
 222 .SM RPC
 223 program number (300019 decimal) which may not
 224 be in the /etc/rpc database.
 225 .PP
 226 If the TCP wrappers library is available, and the
 227 .B use_tcpwrappers
 228 global
 229 .B amd.conf
 230 option is set to ``yes'', then
 231 .B amd
 232 will verify that the host running
 233 .B amq
 234 is authorized to connect.  The
 235 .I amd
 236 service name must used in the
 237 .B /etc/hosts.allow
 238 and
 239 .B /etc/hosts.deny
 240 files.  For example, to allow only localhost to connect to
 241 .B amd,
 242 add this line to
 243 .B /etc/hosts.allow:
 244 .PP
 245 .RS
 246 amd: localhost
 247 .RE
 248 .PP
 249 and this line to
 250 .B /etc/hosts.deny:
 251 .PP
 252 .RS
 253 amd: ALL
 254 .RE
 255
 256 .SH "SEE ALSO"
 257 .BR amd (8),
 258 .\" .BR ctl-amd (8),
 259 .BR amd.conf (5),
 260 .BR hosts_access (5).
 261 .LP
 262 ``am-utils''
 263 .BR info (1)
 264 entry.
 265 .LP
 266 .I "Linux NFS and Automounter Administration"
 267 by Erez Zadok, ISBN 0-7821-2739-8, (Sybex, 2001).
 268 .LP
 269 .I http://www.am-utils.org
 270 .LP
 271 .I "Amd \- The 4.4 BSD Automounter"
 272
 273 .SH AUTHORS
 274 Jan-Simon Pendry <jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK.
 275 .P
 276 Erez Zadok <ezk@cs.sunysb.edu>, Computer Science Department, Stony Brook
 277 University, Stony Brook, New York, USA.
 278 .P
 279 Other authors and contributors to am-utils are listed in the
 280 .B AUTHORS
 281 file distributed with am-utils.