contrib/amd/amq/amq.8

   1 .\"
   2 .\" Copyright (c) 1997-2004 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.3.2.8 2004/01/06 03:15:16 ezk Exp $
  42 .\" $FreeBSD$
  43 .\"
  44 .Dd March 16, 1991
  45 .Dt AMQ 8
  46 .Os
  47 .Sh NAME
  48 .Nm amq
  49 .Nd automounter query tool
  50 .Sh SYNOPSIS
  51 .Nm amq
  52 .Op Fl fmpsuvTU
  53 .Op Fl h Ar hostname
  54 .Op Fl l Ar log_file
  55 .Op Fl x Ar log_options
  56 .Op Fl D Ar debug_options
  57 .Op Fl M Ar mountmap_entry
  58 .Op Fl P Ar program_number
  59 .Op Ar directory
  60 .Ar ...
  61 .Sh DESCRIPTION
  62 .Nm Amq
  63 provides a simple way of determining the current state of the
  64 .Xr amd 8
  65 program.
  66 Communication is by
  67 .Tn RPC .
  68 Three modes of operation are supported by the current protocol.
  69 By default a list of mount points and auto-mounted file systems
  70 is output.
  71 An alternative host can be specified using the
  72 .Fl h
  73 option.
  74 .Pp
  75 If directory names are given, as output by default,
  76 then per file system information is displayed.
  77 .Sh OPTIONS
  78 .Bl -tag -width Ds
  79 .It Fl f
  80 Request automounter to flush the internal caches.
  81 .It Fl h Ar hostname
  82 Query alternate host
  83 .Ar hostname .
  84 By default the local host is used.
  85 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.
  96 This option is therefore only useful to
  97 refresh
  98 .Nm amd Ns \'s
  99 open file handle on the log file, so that it can be rotated and compressed via
 100 daily cron jobs.
 101 .It Fl m
 102 Request the automounter to provide a list of mounted file systems,
 103 including the number of references to each file system and any error
 104 which occurred while mounting.
 105 .It Fl p
 106 Return the process ID of the remote or locally running
 107 .Nm amd .
 108 Useful when you need to send a signal to the local
 109 .Nm amd
 110 process, and would rather not have to search through the process table.
 111 This
 112 option is used in the
 113 .Pa ctl-amd
 114 script.
 115 .It Fl s
 116 Request the automounter to provide system-wide mount statistics.
 117 .It Fl u
 118 Request the automounter to unmount the named file systems
 119 instead of providing information about them.
 120 Unmounts are requested,
 121 not forced.
 122 They merely cause the mounted file system to timeout,
 123 which will be picked up by
 124 .Nm amd Ns \'s
 125 main scheduler thus causing the normal timeout action to be taken.
 126 .It Fl v
 127 Request the automounter to provide version information.
 128 This is a subset
 129 of the information provided by
 130 .Nm amd Ns \'s Fl v
 131 option.
 132 .It Fl x Ar log_options
 133 Ask the automounter to use the logging options specified in
 134 .Ar log_options
 135 from now on.
 136 .It Fl D Ar log_options
 137 Ask the automounter to use the debugging options specified in
 138 .Ar debug_options
 139 from now on.
 140 .It Fl M
 141 Pass a mount map entry to
 142 .Nm amd
 143 and wait for it to be evaluated, possibly causing a mount.
 144 This option is highly insecure.
 145 By default,
 146 .Nm amd
 147 and
 148 .Nm amq
 149 do not support it.
 150 It is necessary to configure
 151 .Nm am-utils
 152 with
 153 .Ar --enable-amq-mount
 154 to enable this option.
 155 .It Fl P Ar program_number
 156 Contact an alternate running
 157 .Nm amd
 158 that had registered itself on a different RPC
 159 .Ar program_number
 160 and apply all other operations to that instance of the automounter.
 161 This is useful when running multiple copies of
 162 .Nm amd ,
 163 and need to manage each one separately.
 164 If not specified,
 165 .Nm amq
 166 will use the default program number for
 167 .Nm amd ,
 168 300019.
 169 For security reasons, the only alternate program numbers
 170 .Nm amd
 171 can use range from 300019 to 300029, inclusive.
 172 .It Fl T
 173 Contact
 174 .Nm amd
 175 using the TCP transport only.
 176 Normally
 177 .Nm amq
 178 will try TCP, and if that fails, will try UDP.
 179 .It Fl U
 180 Contact
 181 .Nm amd
 182 using UDP (connectionless) transport only.
 183 Normally
 184 .Nm amq
 185 will try TCP, and if that fails, will try UDP.
 186 .El
 187 .Sh FILES
 188 .Bl -tag -width amq.x -compact
 189 .It Pa amq.x
 190 .Tn RPC
 191 protocol description.
 192 .El
 193 .Sh CAVEATS
 194 .Nm Amq
 195 uses a Sun registered
 196 .Tn RPC
 197 program number (300019 decimal) which may not
 198 be in the
 199 .Pa /etc/rpc
 200 database.
 201 .Sh SEE ALSO
 202 .Xr amd.conf 5 ,
 203 .Xr amd 8
 204 .Sh HISTORY
 205 .Nm Amq
 206 first appeared in
 207 .Bx 4.4 .
 208 .Sh AUTHORS
 209 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
 210 Department of Computing, Imperial College, London, UK.
 211 .Pp
 212 .An Erez Zadok Aq ezk@cs.columbia.edu ,
 213 Department of Computer Science, Columbia University, New York, USA.
 214 .Pp
 215 .An Other authors and contributors to
 216 .Nm am-utils
 217 are listed in the
 218 .Nm AUTHORS
 219 file distributed with
 220 .Nm am-utils .