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 .\"
  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 filesystems
  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-filesystem 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.  In an
  85 .Tn HP-UX
  86 cluster, the root server is queried by default, since
  87 that is the system on which the automounter is normally run.
  88 .It Fl l Ar log_file
  89 Tell amd to use
  90 .Ar log_file
  91 as the log file name.
  92 For security reasons, this must be the same log file which
  93 .Nm amd
  94 used when started.  This option is therefore only useful to
  95 refresh
  96 .Nm amd Ns \'s
  97 open file handle on the log file, so that it can be rotated and compressed via
  98 daily cron jobs.
  99 .It Fl m
 100 Request the automounter to provide a list of mounted filesystems,
 101 including the number of references to each filesystem and any error
 102 which occurred while mounting.
 103 .It Fl p
 104 Return the process ID of the remote or locally running
 105 .Nm amd .
 106 Useful when you need to send a signal to the local
 107 .Nm amd
 108 process, and would rather not have to search through the process table.  This
 109 option is used in the
 110 .Pa ctl-amd
 111 script.
 112 .It Fl s
 113 Request the automounter to provide system-wide mount statistics.
 114 .It Fl u
 115 Request the automounter to unmount the named filesystems
 116 instead of providing information about them.  Unmounts are requested,
 117 not forced.  They merely cause the mounted filesystem to timeout,
 118 which will be picked up by
 119 .Nm amd Ns \'s
 120 main scheduler thus causing the normal timeout action to be taken.
 121 .It Fl v
 122 Request the automounter to provide version information.  This is a subset
 123 of the information provided by
 124 .Nm amd Ns \'s Fl v
 125 option.
 126 .It Fl x Ar log_options
 127 Ask the automounter to use the logging options specified in
 128 .Ar log_options
 129 from now on.
 130 .It Fl D Ar log_options
 131 Ask the automounter to use the debugging options specified in
 132 .Ar debug_options
 133 from now on.
 134 .It Fl M
 135 Pass a mount map entry to
 136 .Nm amd
 137 and wait for it to be evaluated, possibly causing a mount.
 138 This option is highly insecure.
 139 By default,
 140 .Nm amd
 141 and
 142 .Nm amq
 143 do not support it.
 144 It is necessary to configure
 145 .Nm am-utils
 146 with
 147 .Ar --enable-amq-mount
 148 to enable this option.
 149 .It Fl P Ar program_number
 150 Contact an alternate running
 151 .Nm amd
 152 that had registered itself on a different RPC
 153 .Ar program_number
 154 and apply all other operations to that instance of the automounter.
 155 This is useful when running multiple copies of
 156 .Nm amd ,
 157 and need to manage each one separately.
 158 If not specified,
 159 .Nm amq
 160 will use the default program number for
 161 .Nm amd ,
 162 300019.
 163 For security reasons, the only alternate program numbers
 164 .Nm amd
 165 can use range from 300019 to 300029, inclusive.
 166 .It Fl T
 167 Contact
 168 .Nm amd
 169 using the TCP transport only.
 170 Normally
 171 .Nm amq
 172 will try TCP, and if that fails, will try UDP.
 173 .It Fl U
 174 Contact
 175 .Nm amd
 176 using UDP (connectionless) transport only.
 177 Normally
 178 .Nm amq
 179 will try TCP, and if that fails, will try UDP.
 180 .El
 181 .Sh FILES
 182 .Bl -tag -width amq.x -compact
 183 .It Pa amq.x
 184 .Tn RPC
 185 protocol description.
 186 .El
 187 .Sh CAVEATS
 188 .Nm Amq
 189 uses a Sun registered
 190 .Tn RPC
 191 program number (300019 decimal) which may not
 192 be in the
 193 .Pa /etc/rpc
 194 database.
 195 .Sh SEE ALSO
 196 .Xr amd.conf 5 ,
 197 .Xr amd 8
 198 .Sh AUTHORS
 199 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
 200 Department of Computing, Imperial College, London, UK.
 201 .Pp
 202 .An Erez Zadok Aq ezk@cs.columbia.edu ,
 203 Department of Computer Science, Columbia University, New York, USA.
 204 .Pp
 205 .An Other authors and contributors to
 206 .Nm am-utils
 207 are listed in the
 208 .Nm AUTHORS
 209 file distributed with
 210 .Nm am-utils .
 211 .Sh HISTORY
 212 .Nm Amq
 213 first appeared in
 214 .Bx 4.4 .