diff options
author | ru <ru@FreeBSD.org> | 2007-12-07 20:16:21 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2007-12-07 20:16:21 +0000 |
commit | b349ea29b4539d5529f06e25bebfd3ecbb1e1147 (patch) | |
tree | 5d81d541caa33de4458fa461fa1c153228d506fc /contrib/amd/amq/amq.8 | |
parent | 6f8c447516764915f5170e9605317028c19ebda7 (diff) | |
download | FreeBSD-src-b349ea29b4539d5529f06e25bebfd3ecbb1e1147.zip FreeBSD-src-b349ea29b4539d5529f06e25bebfd3ecbb1e1147.tar.gz |
Revise the man->mdoc conversion of the amd manpages.
Diffstat (limited to 'contrib/amd/amq/amq.8')
-rw-r--r-- | contrib/amd/amq/amq.8 | 212 |
1 files changed, 117 insertions, 95 deletions
diff --git a/contrib/amd/amq/amq.8 b/contrib/amd/amq/amq.8 index 8af070d..5cfbf5c 100644 --- a/contrib/amd/amq/amq.8 +++ b/contrib/amd/amq/amq.8 @@ -49,86 +49,104 @@ .Nd automounter query tool .Sh SYNOPSIS .Nm amq -.Op Fl fmpsuvTU +.Op Fl fmpsvwHTU .Op Fl h Ar hostname .Op Fl l Ar log_file .Op Fl x Ar log_options .Op Fl D Ar debug_options -.Op Fl M Ar mountmap_entry .Op Fl P Ar program_number -.Op Ar directory -.Ar ... +.Op Oo Fl u Oc Ar directory ... .Sh DESCRIPTION -.Nm Amq +The +.Nm +utility provides a simple way of determining the current state of the .Xr amd 8 program. Communication is by .Tn RPC . Three modes of operation are supported by the current protocol. -By default a list of mount points and auto-mounted file systems -is output. -An alternative host can be specified using the +By default +a list of mount points and auto-mounted file systems is output. +An +alternative host can be specified using the .Fl h option. .Pp -If directory names are given, as output by default, -then per file system information is displayed. +If +.Ar directory +names are given, as output by default, then per file system +information is displayed. .Sh OPTIONS -.Bl -tag -width Ds +.Bl -tag -width indent .It Fl f -Request automounter to flush the internal caches. +Ask the automounter to flush the internal caches and reload all the maps. .It Fl h Ar hostname -Query alternate host -.Ar hostname . +Specify an alternate host to query. By default the local host is used. -In an +In +an .Tn HP-UX -cluster, the root server is queried by default, since -that is the system on which the automounter is normally run. +cluster, the root server is queried by default, since that is the system on +which the automounter is normally run. .It Fl l Ar log_file -Tell amd to use +Tell +.Xr amd 8 +to use .Ar log_file as the log file name. -For security reasons, this must be the same log file which -.Nm amd +For security reasons, this must be the same log file +which +.Xr amd 8 used when started. This option is therefore only useful to refresh -.Nm amd Ns \'s -open file handle on the log file, so that it can be rotated and compressed via -daily cron jobs. +.Nm amd Ns 's +open file handle on the log file, so that it can be rotated +and compressed via daily cron jobs. .It Fl m -Request the automounter to provide a list of mounted file systems, -including the number of references to each file system and any error -which occurred while mounting. +Ask the automounter to provide a list of mounted file systems, including the +number of references to each file system and any error which occurred while +mounting. .It Fl p Return the process ID of the remote or locally running -.Nm amd . -Useful when you need to send a signal to the local -.Nm amd -process, and would rather not have to search through the process table. -This -option is used in the +.Xr amd 8 . +Useful when you +need to send a signal to the local +.Xr amd 8 +process, and would rather not have to +search through the process table. +This option is used in the .Pa ctl-amd script. .It Fl s -Request the automounter to provide system-wide mount statistics. +Ask the automounter to provide system-wide mount statistics. .It Fl u -Request the automounter to unmount the named file systems -instead of providing information about them. -Unmounts are requested, -not forced. -They merely cause the mounted file system to timeout, -which will be picked up by -.Nm amd Ns \'s +Ask the automounter to unmount the file systems named in +.Ar directory +instead of providing +information about them. +Unmounts are requested, not forced. +They merely +cause the mounted file system to timeout, which will be picked up by +.Nm amd Ns 's main scheduler thus causing the normal timeout action to be taken. .It Fl v -Request the automounter to provide version information. -This is a subset -of the information provided by -.Nm amd Ns \'s Fl v +Ask the automounter for its version information. +This is a subset of the +information output by +.Xr amd 8 Ns 's +.Fl v option. +.It Fl w +Translate a full pathname as returned by +.Xr getcwd 3 +into a short +.Xr amd 8 +pathname that goes through its mount points. +This option requires that +.Xr amd 8 +is running. .It Fl x Ar log_options Ask the automounter to use the logging options specified in .Ar log_options @@ -137,107 +155,109 @@ from now on. Ask the automounter to use the debugging options specified in .Ar debug_options from now on. -.It Fl M -Pass a mount map entry to -.Nm amd -and wait for it to be evaluated, possibly causing a mount. -This option is highly insecure. -By default, -.Nm amd -and -.Nm amq -do not support it. -It is necessary to configure -.Nm am-utils -with -.Ar --enable-amq-mount -to enable this option. +.It Fl H +Display short usage message. .It Fl P Ar program_number Contact an alternate running -.Nm amd -that had registered itself on a different RPC +.Xr amd 8 +that had registered itself on a different +.Tn RPC .Ar program_number and apply all other operations to that instance of the automounter. -This is useful when running multiple copies of -.Nm amd , -and need to manage each one separately. +This is +useful when you run multiple copies of +.Xr amd 8 , +and need to manage each +one separately. If not specified, -.Nm amq +.Nm will use the default program number for -.Nm amd , +.Xr amd 8 , 300019. For security reasons, the only alternate program numbers -.Nm amd +.Xr amd 8 can use range from 300019 to 300029, inclusive. .It Fl T Contact -.Nm amd +.Xr amd 8 using the TCP transport only. Normally -.Nm amq -will try TCP, and if that fails, will try UDP. +.Nm +will try TCP, and if that failed, will try UDP. .It Fl U Contact -.Nm amd +.Xr amd 8 using UDP (connectionless) transport only. Normally -.Nm amq -will try TCP, and if that fails, will try UDP. +.Nm +will try TCP, and if that failed, will try UDP. .El .Sh FILES -.Bl -tag -width amq.x -compact +.Bl -tag -width ".Pa amq.x" -compact .It Pa amq.x .Tn RPC protocol description. .El .Sh CAVEATS -.Nm Amq +The +.Nm +utility uses a Sun registered .Tn RPC program number (300019 decimal) which may not be in the -.Pa /etc/rpc +.Xr rpc 5 database. .Pp If the TCP wrappers library is available, and the -.It use_tcpwrappers +.Va use_tcpwrappers global -.It amd.conf +.Xr amd.conf 5 option is set to -.Qq yes , +.Dq Li yes , then -.Nm Amd +.Xr amd 8 will verify that the host running -.Nm Aamq +.Nm is authorized to connect. The -.Nm Amd -service name must used in the +.Dq Li amd +service name must be used in the .Pa /etc/hosts.allow and .Pa /etc/hosts.deny files. For example, to allow only localhost to connect to -.Nm Amd , +.Xr amd 8 , add this line to .Pa /etc/hosts.allow : -.Bd -literal -.nf - amd: localhost -.fi -.Ed +.Pp +.Dl "amd: localhost" .Pp and this line to .Pa /etc/hosts.deny : -.Bd -literal -.nf - amd: ALL -.fi -.Ed +.Pp +.Dl "amd: ALL" .Sh SEE ALSO .Xr amd.conf 5 , .Xr hosts_access 5 , .Xr amd 8 +.Pp +.Dq am-utils +.Xr info 1 +entry. +.Rs +.%A Erez Zadok +.%B "Linux NFS and Automounter Administration" +.%O ISBN 0-7821-2739-8 +.%I Sybex +.%D 2001 +.Re +.Pp +.Pa http://www.am-utils.org/ +.Rs +.%T Amd \- The 4.4 BSD Automounter +.Re .Sh HISTORY .Nm Amq first appeared in @@ -247,8 +267,10 @@ first appeared in Department of Computing, Imperial College, London, UK. .Pp .An Erez Zadok Aq ezk@cs.sunysb.edu , +Computer Science Department, Stony Brook +University, Stony Brook, New York, USA. .Pp -.An Other authors and contributors to +Other authors and contributors to .Nm am-utils are listed in the .Pa AUTHORS |