diff options
author | obrien <obrien@FreeBSD.org> | 1998-09-12 04:04:59 +0000 |
---|---|---|
committer | obrien <obrien@FreeBSD.org> | 1998-09-12 04:04:59 +0000 |
commit | 3c3a03dc00f20f9346832e12f10338ab967b4143 (patch) | |
tree | d660dbe35c9f8c88d5047d09692ac74058220e86 /contrib/amd | |
parent | 4faed0fd1dc0eff361ce9f718db938dd6d408198 (diff) | |
download | FreeBSD-src-3c3a03dc00f20f9346832e12f10338ab967b4143.zip FreeBSD-src-3c3a03dc00f20f9346832e12f10338ab967b4143.tar.gz |
Merge our older Amd manpages with the new am-utils manpages.
The am-utils manpages were un-mandocafied, un4.4BSD'ed with CSRG
copyrights regressed to 1989.
This work was done by Brian Handy who I am very greatful to.
(only a few minor tweaks by me)
Submitted by: Brian Handy <handy@lambic.physics.montana.edu>
Diffstat (limited to 'contrib/amd')
-rw-r--r-- | contrib/amd/amd/amd.8 | 481 | ||||
-rw-r--r-- | contrib/amd/amq/amq.8 | 319 | ||||
-rw-r--r-- | contrib/amd/amq/pawd.1 | 49 | ||||
-rw-r--r-- | contrib/amd/fixmount/fixmount.8 | 191 | ||||
-rw-r--r-- | contrib/amd/fsinfo/fsinfo.8 | 92 | ||||
-rw-r--r-- | contrib/amd/hlfsd/hlfsd.8 | 364 | ||||
-rw-r--r-- | contrib/amd/mk-amd-map/mk-amd-map.8 | 39 | ||||
-rw-r--r-- | contrib/amd/scripts/amd.conf.5 | 922 | ||||
-rw-r--r-- | contrib/amd/wire-test/wire-test.8 | 63 |
9 files changed, 1339 insertions, 1181 deletions
diff --git a/contrib/amd/amd/amd.8 b/contrib/amd/amd/amd.8 index cad42b3..5e5e5eb 100644 --- a/contrib/amd/amd/amd.8 +++ b/contrib/amd/amd/amd.8 @@ -38,315 +38,298 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: amd.8,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $ +.\" $Id: amd.8,v 1.2 1998/09/05 05:52:24 obrien Exp $ .\" -.TH AMD 8 "3 November 1989" -.SH NAME -amd \- automatically mount file systems -.SH SYNOPSIS -.B amd -.B \-H -.br -.B amd -[ -.BI \-F " conf_file" -] -.br -.B amd -[ -.B \-nprvHS -] [ -.BI \-a " mount_point" -] [ -.BI \-c " duration" -] [ -.BI \-d " domain" -] [ -.BI \-k " kernel-arch" -] [ -.BI \-l " logfile" -] [ -.BI \-o " op_sys_ver" -] [ -.BI \-t " interval.interval" -] [ -.BI \-w " interval" -] [ -.BI \-x " log-option" -] [ -.BI \-y " YP-domain" -] [ -.BI \-C " cluster-name" -] [ -.BI \-D " option" -] [ -.BI \-F " conf_file" -] [ -.BI \-O " op_sys_name" -] [ -.BI \-T " tag" -] -[ -.I directory -.I mapname -.RI [ " \-map-options " ] -] .\|.\|. -.SH DESCRIPTION -.B Amd -is a daemon that automatically mounts filesystems -whenever a file or directory -within that filesystem is accessed. -Filesystems are automatically unmounted when they -appear to have become quiescent. -.LP -.B Amd +.Dd April 19, 1994 +.Dt AMD 8 +.Os +.Sh NAME +.Nm amd +.Nd automatically mount file systems +.Sh SYNOPSIS +.Nm amd +.Op Fl F Ar conf_file +.Nm amd +.Op Fl nprvHS +.Op Fl a Ar mount_point +.Op Fl c Ar duration +.Op Fl d Ar domain +.Bk -words +.Op Fl k Ar kernel-arch +.Ek +.Op Fl l Ar logfile +.Op Fl o Ar op_sys_ver +.Op Fl t Ar interval.interval +.Bk -words +.Op Fl w Ar interval +.Ek +.Op Fl x Ar log-option +.Op Fl y Ar YP-domain +.Bk -words +.Op Fl C Ar cluster-name +.Ek +.Op Fl D Ar option +.Op Fl F Ar conf_file +.Op Fl O Ar op_sys_name +.Op Fl T Ar tag +.Oo +.Ar directory mapname +.Op Fl map-options +.Oc +.Ar ... +.Sh DESCRIPTION +.Nm Amd +is a daemon that automatically mounts filesystems whenever a file or directory +within that filesystem is accessed. Filesystems are automatically unmounted +when they appear to be quiescent. +.Pp +.Nm Amd operates by attaching itself as an -.SM NFS +.Tn NFS server to each of the specified -.IB directories . +.Ar directories . Lookups within the specified directories are handled by -.BR amd , +.Nm amd , which uses the map defined by -.I mapname -to determine how to resolve the lookup. -Generally, this will be a host name, some filesystem information -and some mount options for the given filesystem. -.LP +.Ar mapname +to determine how to resolve the lookup. Generally, this will be a host name, +some filesystem information and some mount options for the given filesystem. +.Pp In the first form depicted above, -.B amd +.Nm amd will print a short help string. In the second form, if no options are -specified, or the -.B -F -is used, -.B amd -will read configuration parameters from the file -.I conf_file +specified, or if the +.Fl F +is used, +.Nm amd +will read configuration parameters from the file +.Ar conf_file which defaults to -.BR /etc/amd.conf . +.Pa /etc/amd.conf . The last form is described below. -.SH OPTIONS - -.\"*******************************************************" - -.TP -.BI \-a " temporary-directory" +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl a Ar temporary-directory Specify an alternative location for the real mount points. The default is -.BR /a . - -.TP -.BI \-c " duration" +.Pa /a . +.It Fl c Ar duration Specify a -.IR duration , +.Ar duration , in seconds, that a looked up name remains cached when not in use. The default is 5 minutes. - -.TP -.BI \-d " domain" +.It Fl d Ar domain Specify the local domain name. If this option is not given the domain name is determined from the hostname. - -.TP -.BI \-k " kernel-arch" +.It Fl k Ar kernel-arch Specifies the kernel architecture. This is used solely to set the ${karch} selector. - -.TP -.BI \-l " logfile" +.It Fl l Ar logfile Specify a logfile in which to record mount and unmount events. If -.I logfile +.Ar logfile is the string -.B syslog -then the log messages will be sent to the system log daemon by -.IR syslog (3). -The default syslog facility used is LOG_DAEMON. If you -wish to change it, append its name to the log file name, delimited by a -single colon. For example, if -.I logfile +.Em syslog , +the log messages will be sent to the system log daemon by +.Xr syslog 3 . +The default syslog facility used is LOG_DAEMON. +If you wish to change it, append its name to the log file name, +delimited by a single colon. +For example, if +.Ar logfile is the string -.B syslog:local7 +.Nm syslog:local7 then -.B Amd -will log messages via -.IR syslog (3) +.Nm amd +will log messages via +.Xr syslog 3 using the LOG_LOCAL7 facility (if it exists on the system). - -.TP -.B \-n +.It Fl n Normalize hostnames. -The name refereed to by ${rhost} is normalized relative to the +The name referred to by ${rhost} is normalized relative to the host database before being used. The effect is to translate aliases into ``official'' names. - -.TP -.BI \-o " op_sys_ver" -Override the compiled-in version number of the operating system. Useful -when the built in version is not desired for backward compatibility reasons. -For example, if the build in version is ``2.5.1'', you can override it to -``5.5.1'', and use older maps that were written with the latter in mind. - -.TP -.B \-p -Print PID. +.It Fl o Ar op_sys_ver +Override the compiled-in version number of the operating system. +Useful when the built in version is not desired for backward +compatibility reasons. +For example, if the build in version is +.Dq 2.5.1 , +you can override it to +.Dq 5.5.1 , +and use older maps that were written with the latter in mind. +.It Fl p +Print +.Em PID . Outputs the process-id of -.B amd +.Nm amd to standard output where it can be saved into a file. - -.TP -.B \-r +.It Fl r Restart existing mounts. -.B Amd +.Nm Amd will scan the mount file table to determine which filesystems are currently mounted. Whenever one of these would have been auto-mounted, -.B amd -.I inherits +.Nm amd +.Em inherits it. - -.TP -.BI \-t " interval.interval" +.It Fl t Ar interval.interval Specify the -.IR interval , -in tenths of a second, between NFS/RPC/UDP retries. -The default is 0.8 seconds. -The second values alters the restransmit counter. -Useful defaults are supplied if either or both -values are missing. - -.TP -.B \-v +.Ar interval , +in tenths of a second, between +.Tn NFS/RPC/UDP +retries. The default is 0.8 seconds. The second values alters the retransmit +counter. Useful defaults are supplied if either or both values are missing. +.It Fl v Version. Displays version and configuration information on standard error. - -.TP -.BI \-w " interval" +.It Fl w Ar interval Specify an -.IR interval , -in seconds, between attempts to dismount -filesystems that have exceeded their cached times. -The default is 2 minutes. - -.TP -.BI \-x " options" -Specify run-time logging options. The options are a comma separated -list chosen from: fatal, error, user, warn, info, map, stats, all. - -.TP -.BI \-y " domain" -Specify an alternative NIS domain from which to fetch the NIS maps. -The default is the system domain name. This option is ignored if NIS +.Ar interval , +in seconds, between attempts to dismount filesystems that have exceeded their +cached times. The default is 2 minutes. +.It Fl x Ar options +Specify run-time logging options. The options are a comma separated list +chosen from: fatal, error, user, warn, info, map, stats, all. +.It Fl y Ar domain +Specify an alternative +.Tn NIS +domain from which to fetch the +.Tn NIS +maps. +The default is the system domain name. +This option is ignored if +.Tn NIS support is not available. - -.TP -.BI \-C " cluster-name" +.It Fl C Ar cluster-name Specify an alternative HP-UX cluster name to use. - -.TP -.BI \-D " option" +.It Fl D Ar option Select from a variety of debug options. Prefixing an -option with the strings -.B no +option with the string +.Em no reverses the effect of that option. Options are cumulative. The most useful option is -.BR all . +.Ar all . +.Pp Since -.I \-D +.Fl D is only used for debugging other options are not documented here: -the current supported set of options is listed by the \-v option +the current supported set of options is listed by the +.Fl v +option and a fuller description is available in the program source. - -.TP -.BI \-F " conf_file" -Specify an amd configuration file to use. See -.BR amd.conf (5) +.It Fl F Ar conf_file +Specify an +.Nm amd +configuration file to use. See +.Xr amd.conf 5 for description of this file's format. This configuration file is used to specify any options in lieu of typing many of them on the command line. The -.I amd.conf -file includes directives for every command line option amd has, and many -more that are only available via the configuration file facility. The -configuration file specified by this option is processed after all other -options had been processed, regardless of the actual location of this option -on the command line. - -.TP -.B \-H +.Nm amd.conf +file includes directives for every command line option amd has, +and many more that are only available via the configuration file +facility. The configuration file specified by this option is +processed after all other options have been processed, regardless +of the actual location of this option on the command line. +.It Fl H Print help and usage string. - -.TP -.BI \-O " op_sys_name" -Override the compiled-in name of the operating system. Useful when the -built in name is not desired for backward compatibility reasons. For -example, if the build in name is ``sunos5'', you can override it to -``sos5'', and use older maps which were written with the latter in mind. - -.TP -.B \-S -Do not lock the running executable pages of amd into memory. To improve -amd's performance, systems that support the -.BR plock (3) -call, could lock the amd process into memory. This way there is less chance -the operating system will schedule, page out, and swap the amd process as -needed. This tends improves amd's performance, at the cost of reserving the -memory used by the amd process (making it unavailable for other processes). +.It Fl O Ar op_sys_name +Override the compiled-in name of the operating system. +Useful when the built in name is not desired for backward +compatibility reasons. +For example, if the build in name is +.Dq sunos5 , +you can override it to +.Dq sos5 +and use older maps which were written with the latter in mind. +.It Fl S +Do not lock the running executable pages of +.Nm amd +into memory. To improve +.Nm amd's +performance, systems that support the +.Xr plock 3 +call, could lock the +.Nm amd +process into memory. This way there is less chance the operating system will +schedule, page out, and swap the +.Nm amd +process as needed. This tends to improve +.Nm amd's +performance, at the cost of reserving the memory used by the +.Nm amd +process +.Pq making it unavailable for other processes . If this behavior is not desired, use the -.B \-S +.Fl S option. - -.TP -.BI \-T " tag" +.It Fl T Ar tag Specify a tag to use with -.BR amd.conf (5). -All map entries tagged with -.I tag -will be processed. Map entries that are not tagged are always processed. +.Xr amd.conf 5. +All Map entries tagged with tag will be processed. +Map entries that are not tagged are always processed. Map entries that are tagged with a tag other than -.I tag +.Ar tag will not be processed. - -.SH FILES -.PD 0 -.TP 5 -.B /a +.Sh FILES +.Bl -tag -width /axx +.It Pa /a directory under which filesystems are dynamically mounted -.TP 5 -.B /etc/amd.conf +.It Pa /etc/amd.conf default configuration file -.PD -.SH CAVEATS +.El +.Sh CAVEATS Some care may be required when creating a mount map. -.LP -Symbolic links on an NFS filesystem can be incredibly inefficient. -In most implementations of NFS, their interpolations are not cached -by the kernel and each time a symlink is encountered during a -.I lookuppn -translation it costs an RPC call to the NFS server. -It would appear that a large improvement in real-time +.Pp +Symbolic links on an +.Tn NFS +filesystem can be incredibly inefficient. +In most implementations of +.Tn NFS , +their interpolations are not cached by +the kernel and each time a symbolic link is +encountered during a +.Em lookuppn +translation it costs an +.Tn RPC +call to the +.Tn NFS +server. +A large improvement in real-time performance could be gained by adding a cache somewhere. -Replacing symlinks with a suitable incarnation of the auto-mounter +Replacing +.Xr symlink 2 +with a suitable incarnation of the auto-mounter results in a large real-time speedup, but also causes a large number of process context switches. -.LP +.Pp A weird imagination is most useful to gain full advantage of all the features. -.SH "SEE ALSO" -.BR domainname (1), -.BR hostname (1), -.BR syslog (3). -.BR amd.conf (5), -.BR mtab (5), -.BR amq (8), -.BR automount (8), -.BR mount (8), -.BR umount (8), -.LP -.I "Amd \- The 4.4 BSD Automounter" -.SH AUTHORS -Jan-Simon Pendry <jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK. -.P -Erez Zadok <ezk@cs.columbia.edu>, Department of Computer Science, Columbia -University, New York, USA. -.P -Other authors and contributors to am-utils are listed in the -.B AUTHORS +.Sh SEE ALSO +.Xr domainname 1 , +.Xr hostname 1 , +.Xr syslog 3 , +.Xr amd.conf 5 , +.Xr mtab 5 , +.Xr amq 8 , +.Xr automount 8 , +.Xr mount 8 , +.Xr umount 8 +.Rs +.%T Amd \- The 4.4 BSD Automounter +.Re +.Sh AUTHORS +.An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , +Department of Computing, Imperial College, London, UK. +.Pp +.An Erez Zadok Aq ezk@cs.columbia.edu , +Department of Computer Science, Columbia University, +New York, USA. +.Pp +.An Other authors and contributors to am-utils are listed in the +.Nm AUTHORS file distributed with am-utils. +.Sh HISTORY +The +.Nm amd +utility first appeared in 4.4BSD. diff --git a/contrib/amd/amq/amq.8 b/contrib/amd/amq/amq.8 index 52f3b4e..4181cea 100644 --- a/contrib/amd/amq/amq.8 +++ b/contrib/amd/amq/amq.8 @@ -38,177 +38,178 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: amq.8,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $ +.\" $Id: amq.8,v 1.2 1998/09/05 06:38:19 obrien Exp $ .\" -.TH AMQ 8 "25 April 1989" -.SH NAME -amq \- automounter query tool -.SH SYNOPSIS -.B amq -[ -.BI \-fmpsuvTU -] [ -.BI \-h " hostname" -] [ -.BI \-l " log_file" -] [ -.BI \-x " log_options" -] [ -.BI \-D " debug_options" -] [ -.BI \-M " mountmap entry" -] [ -.BI \-P " program_number" -] [ -.I directory -] .\|.\|. -.SH DESCRIPTION -.B Amq -provides a simple way of determining the current state of -.B amd +.Dd March 16, 1991 +.Dt AMQ 8 +.Os +.Sh NAME +.Nm amq +.Nd automounter query tool +.Sh SYNOPSIS +.Nm amq +.Op Fl fmpsuvTU +.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 ... +.Sh DESCRIPTION +.Nm Amq +provides a simple way of determining the current state of the +.Xr amd 8 program. Communication is by -.SM RPC. -Three modes of operation are supported by the current protocol. By default -a list of mount points and auto-mounted filesystems is output. An -alternative host can be specified using the -.I \-h +.Tn RPC . +Three modes of operation are supported by the current protocol. +By default a list of mount points and auto-mounted filesystems +is output. +An alternative host can be specified using the +.Fl h option. -.LP -If -.I directory -names are given, as output by default, then per-filesystem -information is displayed. -.SH OPTIONS - -.TP -.B \-f -Ask the automounter to flush the internal caches. - -.TP -.BI \-h " hostname" -Specify an alternate host to query. By default the local host is used. In -an -.SM HP-UX -cluster, the root server is queried by default, since that is the system on -which the automounter is normally run. - -.TP -.BI \-l " log_file" +.Pp +If directory names are given, as output by default, +then per-filesystem information is displayed. +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl f +Request automounter to flush the internal caches. +.It Fl h Ar hostname +Query alternate host +.Ar hostname . +By default the local host is used. 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. +.It Fl l Ar log_file Tell amd to use -.I log_file -as the log file name. For security reasons, this must be the same log file -which amd used when started. This option is therefore only useful to -refresh amd's open file handle on the log file, so that it can be rotated -and compressed via daily cron jobs. - -.TP -.B \-m -Ask the automounter to provide a list of mounted filesystems, including the -number of references to each filesystem and any error which occurred while -mounting. - -.TP -.B \-p -Return the process ID of the remote or locally running amd. Useful when you -need to send a signal to the local amd process, and would rather not have to -search through the process table. This option is used in the -.I ctl-amd +.Ar log_file +as the log file name. +For security reasons, this must be the same log file which +.Nm amd +used when started. This option is therefore only useful to +refresh +.Nm amd'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 filesystems, +including the number of references to each filesystem 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 +.Pa ctl-amd script. - -.TP -.B \-s -Ask the automounter to provide system-wide mount statistics. - -.TP -.B \-u -Ask the automounter to unmount the filesystems named in -.I directory -instead of providing -information about them. Unmounts are requested, not forced. They merely -cause the mounted filesystem to timeout, which will be picked up by -.BR amd 's +.It Fl s +Request the automounter to provide system-wide mount statistics. +.It Fl u +Request the automounter to unmount the named filesystems +instead of providing information about them. Unmounts are requested, +not forced. They merely cause the mounted filesystem to timeout, +which will be picked up by +.Nm amd Ns \'s main scheduler thus causing the normal timeout action to be taken. - -.TP -.B \-v -Ask the automounter for its version information. This is a subset of the -information output by -.BR amd 's -.I -v +.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 option. - -.TP -.BI \-x " log_options" -Ask the automounter to use the logging options specified in -.I log_options +.It Fl x Ar log_options +Ask the automounter to use the logging options specified in +.Ar log_options from now on. - -.TP -.BI \-D " log_options" -Ask the automounter to use the debugging options specified in -.I debug_options +.It Fl D Ar log_options +Ask the automounter to use the debugging options specified in +.Ar debug_options from now on. - -.TP -.BI \-M " map_ent" -Pass a mount map entry to -.B amd -and wait for it to be evaluated, possible causing a mount. This option is -highly insecure. By default, amd and amq do not support it. You have to -configure am-utils with -.I \-\-enable\-amq\-mount +.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. - -.TP -.BI \-P " program_number" -Contact an alternate running amd that had registered itself on a different -RPC -.I program_number -and apply all other operations to that instance of the automounter. This is -useful when you run multiple copies of amd, and need to manage each -one separately. If not specified, amq will use the default program number -for amd, 300019. For security reasons, the only alternate program numbers -amd can use range from 300019 to 300029, inclusive. - -.TP -.B \-T +.It Fl P Ar program_number +Contact an alternate running +.Nm amd +that had registered itself on a different RPC +.Ar program_number +and apply all other operations to that instance of the automounter. +This is useful when running multiple copies of +.Nmamd , +and need to manage each one separately. +If not specified, +.Nm amq +will use the default program number for +.Nm amd , +300019. +For security reasons, the only alternate program numbers +.Nm amd +can use range from 300019 to 300029, inclusive. +.It Fl T Contact -.B amd -using the TCP transport only. Normally -.B amq -will try TCP, and if that failed, will try UDP. - -.TP -.B \-U -Contact -.B amd -using UDP (connectionless) transport only. Normally -.B amq -will try TCP, and if that failed, will try UDP. - -.SH FILES -.PD 0 -.TP 20 -.B amq.x -.SM RPC +.Nm amd +using the TCP transport only. +Normally +.Nm amq +will try TCP, and if that fails, will try UDP. +.It Fl U +Contact +.Nm amd +using UDP (connectionless) transport only. +Normally +.Nm amq +will try TCP, and if that fails, will try UDP. +.El +.Sh FILES +.Bl -tag -width amq.xxxxx -compact +.Bl -tag -width Ds +.It Pa amq.x +.Tn RPC protocol description. -.SH CAVEATS -.B Amq +.El +.Sh CAVEATS +.Nm Amq uses a Sun registered -.SM RPC +.Tn RPC program number (300019 decimal) which may not -be in the /etc/rpc database. -.SH "SEE ALSO" -.BR amd.conf (5). -.BR amd (8), -.BR ctl-amd (8), -.SH AUTHORS -Jan-Simon Pendry <jsp@doc.ic.ac.uk>, Department of Computing, Imperial College, London, UK. -.P -Erez Zadok <ezk@cs.columbia.edu>, Department of Computer Science, Columbia -University, New York, USA. -.P -Other authors and contributors to am-utils are listed in the -.B AUTHORS -file distributed with am-utils. +be in the +.Pa /etc/rpc +database. +.Sh SEE ALSO +.Xr amd.conf 8 , +.Xr amd 8 , +.Xr ctl-amd 8 +.Sh AUTHORS +.An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , +Department of Computing, Imperial College, London, UK. +.Pp +.An Erez Zadok Aq ezk@cs.columbia.edu , +Department of Computer Science, Columbia University, New York, USA. +.Pp +.An Other authors and contributors to +.Nm am-utils +are listed in the +.Nm AUTHORS +file distributed with +.Nm am-utils . +.Sh HISTORY +.Nm Amq +first appeared in 4.4BSD. +.At diff --git a/contrib/amd/amq/pawd.1 b/contrib/amd/amq/pawd.1 index c9cde87..22a5122 100644 --- a/contrib/amd/amq/pawd.1 +++ b/contrib/amd/amq/pawd.1 @@ -38,35 +38,42 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: pawd.1,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $ +.\" $Id: pawd.1,v 1.2 1998/09/05 06:56:36 obrien Exp $ .\" -.TH PAWD 1 "6 Jan 1998" -.SH NAME -pawd \- print automounter working directory -.SH SYNOPSIS -.B pawd -[ -.I path ... -] -.SH DESCRIPTION -.LP -.B pawd +.Dd January 6, 1998 +.Dt PAWD 1 +.Os +.Sh NAME +.Nm pawd +.Nd print automounter working directory +.Sh SYNOPSIS +.Nm +.Op Ar path ... +.Sh DESCRIPTION +.Nm is used to print the current working directory, adjusted to reflect proper paths that can be reused to go through the automounter for the shortest possible path. In particular, the path printed back does not include any of -.BR Amd 's +.Nm Amd Ns \'s local mount points. Using them is unsafe, because -.B Amd +.Nm Amd may unmount managed file systems from the mount points, and thus including them in paths may not always find the files within. -.P +.Pp Without any arguments, -.B pawd +.Nm will print the automounter adjusted current working directory. With any -number of arguments, it will print the adjusted path of each one of the +number of arguments, it will print the adjusted +.Ar path +of each one of the arguments. -.SH "SEE ALSO" -.BR pwd (1), -.BR amd (8), -.BR amq (8). +.Sh SEE ALSO +.Xr pwd 1 , +.Xr amd 8 , +.Xr amq 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Fx 3.0 . diff --git a/contrib/amd/fixmount/fixmount.8 b/contrib/amd/fixmount/fixmount.8 index c99a458..88c9aef 100644 --- a/contrib/amd/fixmount/fixmount.8 +++ b/contrib/amd/fixmount/fixmount.8 @@ -38,122 +38,141 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: fixmount.8,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $ +.\" $Id: fixmount.8,v 1.2 1998/09/05 06:56:36 obrien Exp $ .\" -.TH FIXMOUNT 8L "26 Feb 1993" -.SH NAME -fixmount \- fix remote mount entries -.SH SYNOPSIS -.B fixmount -[ -.B \-adervq -] -[ -.B \-h -.I name -] -.I host +.Dd February 26, 1993 +.Dt FIXMOUNT 8 +.Os +.Sh NAME +.Nm fixmount +.Nd fix remote mount entries +.Sh SYNOPSIS +.Nm +.Op Fl adervq +.Op Fl h Ar name +.Ar host \&... -.SH DESCRIPTION -.IX "fixmount command" "" "\fLfixmount\fP \(em fix remote mount entries" -.LP -.B fixmount -is a variant of -.BR showmount (8) +.Sh DESCRIPTION +.Nm +is a variant of +.Xr showmount 8 that can delete bogus mount entries in remote -.BR mountd (8C) -daemons. -The actions specified by the options are performed for each -.I host +.Xr mountd 8 +daemons. The actions specified by the options are performed for each +.Ar host in turn. -.SH OPTIONS -.TP -.B \-a \-d \-e +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl a Fl d Fl e These options work as in -.BR showmount (8) +.Xr showmount 8 except that only entries pertaining to the local host are printed. -.TP -.B \-r +.It Fl r Removes those remote mount entries on -.I host +.Ar host that do not correspond to current mounts, i.e., which are left-over from a crash or are the result of improper mount protocol. The actuality of mounts is verified using the entries in -.BR /etc/mtab . -.TP -.B \-v +.Pa /etc/mtab . +.It Fl v Verify remote mounts. Similar to -.B \-r +.Fl r except that only a notification message is printed for each bogus entry found. The remote mount table is not changed. -.TP -.B \-A -Issues a command to the remote mountd declaring that ALL of its filesystems -have been unmounted. This should be used with caution, as it removes all -remote mount entries pertaining to the local system, whether or not any -filesystems are still mounted locally. -.TP -.B \-q -Be quiet. -Suppresses error messages due to timeouts and "Program not registered", -i.e., due to remote hosts not supporting RPC or not running mountd. -.TP -.BI \-h \ name +.It Fl A +Issues a command to the remote mountd declaring that +.Em all +of its filesystems have been unmounted. This should be used with caution, as +it removes all remote mount entries pertaining to the local system, whether or +not any filesystems are still mounted locally. +.It Fl v +Be quiet. Suppresses error messages due to timeouts and +.Dq Program not Registered , +i.e., due to remote hosts not supporting RPC or not running +.Nm mountd . +.It Fl h Ar name Pretend the local hostname is -.IR name . +.Ar name . This is useful after the local hostname has been changed and rmtab entries using the old name remain on a remote machine. Unfortunately, most mountd's won't be able to successfully handle removal of such entries, so this option is useful in combination with -.B \-v +.Fl v only. -.br +.Pp This option also saves time as comparisons of remotely recorded and local hostnames by address are avoided. -.SH FILES -.PD 0 -.TP 20 -.B /etc/mtab +.Sh FILES +.Bl -tag -width /axx +.It Pa /etc/mtab List of current mounts. -.TP -.B /etc/rmtab -Backup file for remote mount entries on NFS server. -.PD -.SH "SEE ALSO" -.BR mtab (5), -.BR rmtab (5), -.BR mountd (8), -.BR showmount (8). -.SH BUGS +.It Pa /etc/rmtab +Backup file for remote mount entries on +.Tn NFS +server. +.El +.Sh SEE ALSO +.Xr mtab 5 , +.Xr rmtab 5 , +.Xr mountd 8 , +.Xr showmount 8 . +.Sh BUGS No attempt is made to verify the information in -.B /etc/mtab +.Pa /etc/mtab itself. -.PP +.Pp Since swap file mounts are not recorded in -.BR /etc/mtab , +.Pa /etc/mtab , a heuristic specific to SunOS is used to determine whether such a mount -is actual (replacing the string "swap" with "root" and verifying the resulting -path). -.PP +is actual (replacing the string +.Ql swap +with +.Ql root +and verifying the resulting path). +.Pp Symbolic links on the server will cause the path in the remote entry to differ -from the one in -.BR /etc/mtab . +from the one in +.Pa /etc/mtab . To catch those cases, a filesystem is also deemed mounted if its -.I local +.Em local mount point is identical to the remote entry. I.e., on a SunOS diskless client, -.B server:/export/share/sunos.4.1.1 +.Ic server:/export/share/sunos.4.1.1 is actually -.BR /usr/share . +.Pa /usr/share . Since the local mount point is -.B /usr/share +.Pa /usr/share as well this will be handled correctly. -.PP -There is no way to clear a stale entry in a remote mountd after the -local hostname (or whatever reverse name resolution returns for it) -has been changed. To take care of these cases, -the remote /etc/rmtab file has to be edited and mountd restarted. -.PP -The RPC timeouts for mountd calls can only be changed by recompiling. -The defaults are 2 seconds for client handle creation and 5 seconds for -RPC calls. +.Pp +There is no way to clear a stale entry in a remote +.Nm mountd +after the local hostname (or whatever reverse name resolution +returns for it) has been changed. To take care of these cases, +the remote +.Pa /etc/rmtab +file has to be edited and +.Mn mountd +restarted. +.Pp +The RPC timeouts for +.Nm mountd +calls can only be changed by recompiling. The defaults are 2 seconds +for client handle creation and 5 seconds for RPC calls. +.Sh AUTHORS +.An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , +Department of Computing, Imperial College, London, UK. +.Pp +.An Erez Zadok Aq ezk@cs.columbia.edu , +Department of Computer Science, Columbia University, New York, USA. +.Pp +.An Other authors and contributors to +.Nm am-utils +are listed in the +.Nm AUTHORS +file distributed with +.Nm am-utils . +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 3.0 . diff --git a/contrib/amd/fsinfo/fsinfo.8 b/contrib/amd/fsinfo/fsinfo.8 index 5a4eec5..cbaad0d 100644 --- a/contrib/amd/fsinfo/fsinfo.8 +++ b/contrib/amd/fsinfo/fsinfo.8 @@ -33,69 +33,49 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)fsinfo.8 8.1 (Berkeley) 6/28/93 -.\" $Id: fsinfo.8,v 1.2 1994/06/13 20:50:18 mycroft Exp $ +.\" $Id: fsinfo.8,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $ .\" -.TH FSINFO 8 "June 28, 1993" -.SH NAME -fsinfo \- co-ordinate site-wide filesystem information -.SH SYNOPSIS -.B fsinfo -[ -.B \-v -] [ -.B \-a -.I autodir -] [ -.B \-b -.I bootparams -] [ -.B \-d -.I dumpsets -] [ -.B \-e -.I exports -] [ -.B \-f -.I fstabs -] [ -.B \-h -.I hostname -] [ -.B \-m -.I automounts -] [ -.B \-I -.I dir -] [ -.B \-D -.I string[=string]] -] [ -.B \-U -.I string[=string]] -] -.I config -.I ... -.SH DESCRIPTION +.Dd June 28, 1993 +.Dt FSINFO 8 +.Os +.Sh NAME +.Nm fsinfo +.Nd co-ordinate site-wide filesystem information +.Sh SYNOPSIS +.Nm \&fsinfo +.Op Fl v +.Op Fl a Ar autodir +.Op Fl b Ar bootparams +.Op Fl d Ar dumpsets +.Op Fl e Ar exports +.Op Fl f Ar fstabs +.Op Fl h Ar hostname +.Op Fl m Ar automounts +.Op Fl I Ar dir +.Op Fl D Ar string[=string]] +.Op Fl U Ar string[=string]] +.Ar config +\&... +.Sh DESCRIPTION The -.B fsinfo +.Nm utility takes a set of system configuration information, and generates a co-ordinated set of -.I amd -, -.I mount +.Xr amd , +.Xr mount , and -.I mountd +.Xr mountd configuration files. -.PP +.Pp The -.B fsinfo +.Nm command is fully described in the document -.I "Amd - The 4.4BSD Automounter" -.SH "SEE ALSO" -.BR amd (8), -.BR mount (8), -.BR mountd (8). -.SH HISTORY +.%T "Amd - The 4.4BSD Automounter" +.Sh "SEE ALSO" +.Xr amd 8 , +.Xr mount 8 , +.Xr mountd 8 . +.Sh HISTORY The -.B fsinfo +.Nm command first appeared in 4.4BSD. diff --git a/contrib/amd/hlfsd/hlfsd.8 b/contrib/amd/hlfsd/hlfsd.8 index cdd44fc..0c023ca 100644 --- a/contrib/amd/hlfsd/hlfsd.8 +++ b/contrib/amd/hlfsd/hlfsd.8 @@ -36,274 +36,282 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: hlfsd.8,v 1.1.1.1 1998/08/23 22:07:20 obrien Exp $ +.\" $Id: hlfsd.8,v 1.2 1998/09/05 06:56:36 obrien Exp $ .\" .\" HLFSD was written at Columbia University Computer Science Department, by .\" Erez Zadok <ezk@cs.columbia.edu> and Alexander Dupuy <dupuy@smarts.com> .\" It is distributed under the same terms and conditions as AMD. .\" -.TH HLFSD 8 "14 September 1993" -.SH NAME -hlfsd \- home-link file system daemon -.SH SYNOPSIS -.B hlfsd -[ -.B \-fhnpvC -] [ -.BI \-a " alt_dir" -] [ -.BI \-c " cache-interval" -] [ -.BI \-g " group" -] [ -.BI \-i " reload-interval" -] [ -.BI \-l " logfile" -] [ -.BI \-o " mount-options" -] [ -.BI \-x " log-options" -] [ -.BI \-D " debug-options" -] [ -.BI \-P " password-file" -] -[ -.I linkname -.RI [ " subdir " ] -] -.SH DESCRIPTION -.B Hlfsd +.Dd September 14, 1993 +.Dt HLFSD 8 +.Os +.Sh NAME +.Nm hlfsd +.Nd home-link file system daemon +.Sh SYNOPSIS +.Nm +.Op Fl fhnpvC +.Op Fl a Ar alt_dir +.Bk -words +.Op Fl c Ar cache-interval +.Ek +.Op Fl g Ar group +.Bk -words +.Op Fl i Ar reload-interval +.Ek +.Op Fl l Ar logfile +.Bk -words +.Op Fl o Ar mount-options +.Op Fl x Ar log-options +.Op Fl D Ar debug-options +.Op Fl P Ar password-file +.Ek +.Op linkname Op subdir +.Sh DESCRIPTION +.Nm is a daemon which implements a filesystem containing a symbolic link to subdirectory within a user's home directory, depending on the user which accessed that link. It was primarily designed to redirect incoming mail to users' home directories, so that it can read from anywhere. -.LP -.B Hlfsd +.Pp +.Nm operates by mounting itself as an -.SM NFS +.Tn NFS server for the directory containing -.IR linkname , +.Ar linkname , which defaults to -.BR /hlfs/home . +.Pa /hlfs/home . Lookups within that directory are handled by -.BR hlfsd , -which uses the password map to determine how to resolve the lookup. -The directory will be created if it doesn't already exist. The symbolic link will be to the accessing user's home directory, with -.I subdir +.Nm , +which uses the password map to determine how to resolve the lookup. The +directory will be created if it doesn't already exist. The symbolic link will +be to the accessing user's home directory, with +.Ar subdir appended to it. If not specified, -.I subdir +.Ar subdir defaults to -.BR .hlfsdir . +.Pa .hlfsdir . This directory will also be created if it does not already exist. -.LP -A SIGTERM sent to -.B hlfsd -will cause it to shutdown. A SIGHUP will flush the internal -caches, and reload the password map. It will also close and -reopen the log file, to enable the original log file to be -removed or rotated. A SIGUSR1 will cause it to dump its internal -table of user IDs and home directories to the file -.BR /usr/tmp/hlfsd.dump.XXXXXX . -.SH OPTIONS -.TP -.BI \-a " alt_dir" +.Pp +A +.Er SIGHUP +will flush the internal caches, and reload the password map. It will also +close and reopen the log file, to enable the original log file to be removed +or rotated. A +.Er SIGUSR1 +will cause it to dump its internal table of user IDs and home directories to +the file +.Pa /usr/tmp/hlfsd.dump.XXXXXX . +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl a Ar alt_dir Alternate directory. The name of the directory to which the symbolic link returned by -.B hlfsd +.Nm will point, if it cannot access the home directory of the user. This defaults to -.BR /var/hlfs . +.Pa /var/hlfs . This directory will be created if it doesn't exist. It is expected that either users will read these files, or the system administrators -will run a script to resend this "lost mail" to its owner. -.TP -.BI \-c " cache-interval" +will run a script to resend this +.Dq lost mail +to its owner. +.It Fl c Ar cache-interval Caching interval. -.B Hlfsd +.Nm will cache the validity of home directories for this interval, in seconds. Entries which have been verified within the last -.I cache-interval +.Ar cache-interval seconds will not be verified again, since the operation could be expensive, and the entries are most likely still valid. After the interval has expired, -.B hlfsd +.Nm will re-verify the validity of the user's home directory, and reset the cache time-counter. The default value for -.I cache-interval -is 300 seconds (5 minutes). -.TP -.B \-f +.Ar cache-interval +is 300 seconds +.Pq 5 minutes . +.It Fl f Force fast startup. This option tells -.B hlfsd +.Nm to skip startup-time consistency checks such as existence of mount directory, alternate spool directory, symlink to be hidden under the mount directory, their permissions and validity. -.TP -.BI \-g " group" -Set the special group HLFS_GID to -.IR group . +.It Fl g Ar group +Set the special group +.Va HLFS_GID +to +.Ar group . Programs such as -.B from -or -.BR comsat , -which access the mailboxes of other users) must be setgid HLFS_GID to -work properly. The default group is "hlfs". If no group is provided, -and there is no group "hlfs", this feature is disabled. -.TP -.B \-h +.Ic comsat , +.Pq which access the mailboxes of other users + must be setgid +.Va HLFS_GID +to work properly. The default group is +.Dq hlfs . +If no group is provided, and there is no group +.Dq hlfs , +this feature is disabled. +.It Fl h Help. Print a brief help message, and exit. -.TP -.BI \-i " reload-interval" +.It i Ar reload-interval Map-reloading interval. Each -.I reload-interval +.Ar reload-interval seconds, -.B hlfsd +.Nm will reload the password map. -.B Hlfsd +.Nm needs the password map for the UIDs and home directory pathnames. -.B Hlfsd -schedules a SIGALRM to reload the password maps. A SIGHUP sent to -.B hlfsd -will force it to reload the maps immediately. The default -value for -.I reload-interval -is 900 seconds (15 minutes.) -.TP -.BI \-l " logfile" +.Nm +schedules a +.Va SIGALRM +to reload the password maps. A +.Va SIGHUP +sent to +.Nm +will force it to reload the maps immediately. The default value for +.Ar reload-interval +is 900 seconds +.Pq 15 minutes . +.It Fl l Ar logfile Specify a log file to which -.B hlfsd +.Nm will record events. If -.I logfile +.Pa logfile is the string -.B syslog +.Pa syslog then the log messages will be sent to the system log daemon by -.IR syslog (3), -using the LOG_DAEMON facility. -This is also the default. -.TP -.B \-n +.Xr syslog 3 , +using the +.Va LOG_DAEMON +facility. This is also the default. +.It Fl n No verify. -.B Hlfsd +.Nm will not verify the validity of the symbolic link it will be returning, or that the user's home directory contains sufficient disk-space for spooling. This can speed up -.B hlfsd +.Nm at the cost of possibly returning symbolic links to home directories which are not currently accessible or are full. By default, -.B hlfsd +.Nm validates the symbolic-link in the background. -The -.B \-n +The +.Fl n option overrides the meaning of the -.B \-c +.Fl c option, since no caching is necessary. -.TP -.BI \-o " mount-options" +.It Fl o Ar mount-options Mount options. Mount options which -.B hlfsd +.Nm will use to mount itself on top of -.I dirname. +.Pa dirname . By default, -.IR mount-options -is set to "ro". If the system supports symbolic-link caching, default -options are set to "ro,nocache". -.TP -.B \-p -Print PID. +.Ar mount-options +is set to +.Qq ro . +If the system supports symbolic-link caching, default +options are set to +.Qq ro,nocache . +.It Fl p +Prints +.Va PID . Outputs the process-id of -.B hlfsd +.Nm to standard output where it can be saved into a file. -.TP -.B \-v +.It Fl v Version. Displays version information to standard error. -.TP -.BI \-x " log-options" +.It Fl x Ar log-options Specify run-time logging options. The options are a comma separated list chosen from: fatal, error, user, warn, info, map, stats, all. -.TP -.BI \-C +.It Fl C Force -.B hlfsd +.Nm to run on systems that cannot turn off the NFS attribute-cache. Use of this option on those systems is discouraged, as it may result in loss or misdelivery of mail. The option is ignored on systems that can turn off the attribute-cache. -.TP -.BI \-D " log-options" +.It Fl D Ar log-options Select from a variety of debugging options. Prefixing an option with the string -.B no +.Qq no reverses the effect of that option. Options are cumulative. The most useful option is -.BR all . +.Em all . Since this option is only used for debugging other options are not documented here. A fuller description is available in the program -source. A SIGUSR1 sent to -.B hlfsd +source. A +.Va SIGUSR1 +sent to +.Nm will cause it to dump its internal password map to the file -.BR /usr/tmp/hlfsd.dump.XXXXXX . -.TP -.BI \-P " password-file" +.Pa /usr/tmp/hlfsd.dump.XXXXXX . +.It Fl P Ar password-file Read the user-name, user-id, and home directory information from the file -.I password-file. +.Ar password-file . Normally, -.B hlfsd +.Nm will use -.IR getpwent (3) +.Xr getpwent 3 to read the password database. This option allows you to override the default database, and is useful if you want to map users' mail files to a directory other than their home directory. Only the username, uid, and home-directory fields of the file -.I password-file +.Ar password-file are read and checked. All other fields are ignored. The file .I password-file -must otherwise be compliant with Unix System 7 colon-delimited format -.IR passwd (4). -.SH FILES -.PD 0 -.TP 5 -.B /hlfs +must be compliant with +.Ux +System 7 colon-delimited format +.Xr passwd 4 . +.Sh FILES +.Bl -tag -width /axx +.It Pa /hlfs directory under which -.B hlfsd +.Nm mounts itself and manages the symbolic link -.BR home . -.TP 5 -.B .hlfsdir +.Pa home . +.It Pa .hlfsdir default sub-directory in the user's home directory, to which the -.B home +.Pa home symbolic link returned by -.B hlfsd +.Nm points. -.TP 5 -.B /var/hlfs +.It /var/hlfs directory to which -.B home +.Pa home symbolic link returned by -.B hlfsd +.Nm points if it is unable to verify the that user's home directory is accessible. -.SH "SEE ALSO" -.BR mail(1), -.BR getgrent (3), -.BR getpwent (3), -.BR mtab (5), -.BR passwd (5), -.BR amd (8), -.BR automount (8), -.BR cron(8), -.BR mount (8), -.BR sendmail (8), -.BR umount (8). -.LP -.IR "HLFSD: Delivering Email to Your $HOME" , -in -.IR "Proc. LISA-VII, The 7th Usenix System Administration Conference" , -November 1993. -.SH AUTHORS -Erez Zadok <ezk@cs.columbia.edu>, Computer Science Department, -Columbia University, New York City, New York, USA, and -Alexander Dupuy <dupuy@smarts.com>, System Management ARTS, -White Plains, New York, USA. +.Sh SEE ALSO +.Xr mail 1 , +.Xr getgrent 3 , +.Xr getpwent 3 , +.Xr mtab 5 , +.Xr passwd 5 , +.Xr amd 8 , +.Xr automount 8 , +.Xr cron 8 , +.Xr mount 8 , +.Xr sendmail 8 , +.Xr umount 8 +.Rs +.%T HLFSD: Delivering Email to Your $HOME +.%B Proc. LISA-VII, The 7th Usenix System Administration Conference +.%D November 1993 +.Re +.Sh AUTHORS +.An Erez Zadok Aq ezk@cs.columbia.edu , +Department of Computer Science, Columbia University, +New York, USA. +.Pp +.An Alexander Dupuy Aq dupuy@smarts.com , +System Management ARTS, White Plains, New York, USA. +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 3.0 . diff --git a/contrib/amd/mk-amd-map/mk-amd-map.8 b/contrib/amd/mk-amd-map/mk-amd-map.8 index a6690b8..e22e818 100644 --- a/contrib/amd/mk-amd-map/mk-amd-map.8 +++ b/contrib/amd/mk-amd-map/mk-amd-map.8 @@ -33,30 +33,31 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)mk-amd-map.8 8.1 (Berkeley) 6/28/93 -.\" $Id: mk-amd-map.8,v 1.3 1997/05/29 01:48:43 cgd Exp $ +.\" $Id: mk-amd-map.8,v 1.1.1.1 1998/08/23 22:07:21 obrien Exp $ .\" -.TH MK-AMD-MAP 8 "June 28, 1993" -.SH NAME -.B mk-amd-map -\- create database maps for Amd -.SH SYNOPSIS -.B mk-amd-map -[ -.B \-p -] -.I mapname -.SH DESCRIPTION -.B mk-amd-map +.Dd June 28, 1993 +.Dt MK-AMD-MAP 8 +.Os BSD 4.4 +.Sh NAME +.Nm mk-amd-map +.Nd create database maps for Amd +.Sh SYNOPSIS +.Nm +.Op Fl p +.Ar mapname +.Sh DESCRIPTION +.Nm creates the database maps used by the keyed map lookups in -amd(8). +.Xr amd 8 . It reads input from the named file and outputs them to a correspondingly named hashed database. -.TP -.B \-p -This +.Pp +The +.Fl p option prints the map on standard output instead of generating a database. This is usually used to merge continuation lines into one physical line. -.SH SEE ALSO -.BR amd (8). +.Sh SEE ALSO +.Xr amd.conf 5 , +.Xr amd 8 diff --git a/contrib/amd/scripts/amd.conf.5 b/contrib/amd/scripts/amd.conf.5 index a64323c..b652e9d 100644 --- a/contrib/amd/scripts/amd.conf.5 +++ b/contrib/amd/scripts/amd.conf.5 @@ -38,454 +38,596 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: amd.conf.5,v 1.2 1998/09/02 21:07:47 brian Exp $ +.\" $Id: amd.conf.5,v 1.3 1998/09/05 06:56:36 obrien Exp $ .\" -.TH AMD.CONF 8 "7 August 1997" -.SH NAME -amd.conf \- amd configuration file -.SH SYNOPSIS -.B amd.conf -.SH DESCRIPTION +.Dd April 7, 1997 +.Dt AMD.CONF 5 +.Os +.Sh NAME +.Nm amd.conf +.Nd amd configuration file +.Sh SYNOPSIS +.Nm amd.conf +.Sh DESCRIPTION The -.B amd.conf +.Nm file is the configuration file for amd, as part of the am-utils suite. -.P -.B amd.conf +.Pp +.Nm contains runtime configuration information for the -.B amd +.Nm amd automounter program. -.\" ************************************************************************** -.SH FILE FORMAT -.P +.Sh FILE FORMAT The file consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins or the end the file is reached. Sections contain parameters of the -form 'name = value'. -.P +form +.Sq name = value . +.Pp The file is line-based - that is, each newline-terminated line represents either a comment, a section name or a parameter. No line-continuation syntax is available. -.P +.Pp Section, parameter names and their values are case sensitive. -.P +.Pp Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is not allowed, unless the whole -parameter value is quoted with double quotes as in 'name = "some value"'. -.P +parameter value is quoted with double quotes as in +.So name = +.Qq some value +.Sc . +.Pp Any line beginning with a pound sign (#) is ignored, as are lines containing only whitespace. -.P +.Pp The values following the equals sign in parameters are all either a string (no quotes needed if string does not include spaces) or a boolean, which may be given as yes/no. Case is significant in all values. Some items such as cache timeouts are numeric. -.\" ************************************************************************** -.SH SECTIONS -.SS The [global] section -Parameters in this section either apply to amd as a whole, or to all other -regular map sections which follow. There should be only one global section -defined in one configuration file. -.P +.Sh SECTIONS +.Bl -tag -width 4n +.It Nm The [global] section +Parameters in this section either apply to +.Nm amd +as a whole, or to all other regular map sections which follow. There +should be only one global section defined in one configuration file. +.Pp It is highly recommended that this section be specified first in the configuration file. If it is not, then regular map sections which precede it will not use global values defined later. - -.SS Regular [/map] sections +.It Nm Regular [/map] sections Parameters in regular (non-global) sections apply to a single map entry. For example, if the map section -.B [/homes] +.Bq Pa /homes is defined, then all parameters following it will be applied to the -.I /homes +.Pa /homes amd-managed mount point. -.\" ************************************************************************** -.SH PARAMETERS -.SS Parameters common to all sections +.El +.Sh PARAMETERS +.Bl -tag -width F1 +.It Sy Parameters common to all sections These parameters can be specified either in the global or a map specific section. Entries specified in a map-specific section override the default value or one defined in the global section. If such a common parameter is specified only in the global section, it is applicable to all regular map sections that follow. -.\" ************************************************************************** -.TP -.BR browsable_dirs " (string, default=no)" -If "yes", then amd's top-level mount points will be browsable to -.BR readdir (3) +.Bl -tag -width F1 +.It Nm browsable_dirs (string, default=no) +If +.Qq yes , +then amd's top-level mount points will be browsable to +.Xr readdir 3 calls. This means you could run for example -.BR ls (3) +.Xr ls 3 and see what keys are available to mount in that directory. Not all entries -are made visible to readdir(3): the "/default" entry, wildcard -entries, and those with a "/" in them are not included. If you specify -"full" to this option, all but "/default" will be visible. -Note that if you run a command which will attempt to -.BR stat (2) -the entries, such as often done by "ls -l" or "ls -F", amd will attempt to -mount -.I every -entry in that map. This is often called a ``mount storm''. - -.TP -.BR map_options " (string, default no options)" -This option is the same as specifying map options on the command line to -amd, such as "cache:=all". - -.TP -.BR map_type " (string, default search all map types)" -If specified, amd will initialize the map only for the type given. This is -useful to avoid the default map search type used by amd which takes longer -and can have undesired side-effects such as initializing NIS even if not -used. Possible values are - -.nf -\fBfile\fR plain files -\fBhesiod\fR Hesiod name service from MIT -\fBldap\fR Lightweight Directory Access Protocol -\fBndbm\fR (New) dbm style hash files -\fBnis\fR Network Information Services (version 2) -\fBnisplus\fR Network Information Services Plus (version 3) -\fBpasswd\fR local password files -\fBunion\fR union maps -.fi - -.TP -.BR mount_type " (string, default=nfs)" -All amd mount types default to NFS. That is, amd is an NFS server on the -map mount points, for the local host it is running on. If "autofs" is -specified, amd will be an autofs server for those mount points. - -.TP -.BR search_path " (string, default no search path)" -This provides a (colon-delimited) search path for file maps. Using a search -path, sites can allow for local map customizations and overrides, and can -distributed maps in several locations as needed. - -.\" ************************************************************************** -.SS Parameters applicable to the global section only - -.TP -.BR arch " (string, default to compiled in value)" +are made visible to +.Xr readdir 3 : +the +.Qq Pa /default +entry, wildcardentries, and those with a +.Qq Pa / +in them are not included. If you specify +.Qq full +to this option, all but +.Qq Pa /default +will be visible. Note that if you run a command which will attempt to +.Xr stat 2 +the entries, such as often done by +.Qq ls -l +or +.Qq ls -F , +.Nm amd +will attempt to mount +.Em every +entry in that map. This is often called a +.Em mount storm . +.It Nm map_options (string, default no options) +This option is the same as specifying map options on the command line to +.Nm amd , +such as +.Ql cache\&:\&=all . +.It Nm map_type (string, default search all map types) +If specified, amd will initialize the map only for the type given. +This is useful to avoid the default map search type used by amd which +takes longer and can have undesired side-effects such as initializing +NIS even if not used. Possible values are: +.Pp +.Bl -tag -width 10n -compact +.It Nm file +plain files +.It Nm hesiod +Hesiod name service from MIT +.It Nm ldap +Lightweight Directory Access Protocol +.It Nm ndbm +(New) dbm style hash files +.It Nm nis +Network Information Services (version 2) +.It Nm nisplus +Network Information Services Plus (version 3) +.It Nm passwd +local password files +.It Nm union +union maps +.El +.It Nm mount_type (string, default=nfs) +All amd mount types default to +.Tn NFS . +That is, +.Nm amd +is an +.Tn NFS +server on the map mount points, for the local host it is running on. If +.Qq autofs +is specified, amd will be an autofs server for those mount points. +.It Nm search_path (string, default no search path) +This provides a +.Pq colon-delimited +search path for file maps. Using a search path, sites can allow for +local map customizations and overrides, and can distributed maps in +several locations as needed. +.El +.It Nm Parameters applicable to the global section only +.Bl -tag -width F1 +.It Nm arch (string, default to compiled in value) Allows you to override the value of the -.I arch -amd variable. - -.TP -.BR auto_dir " (string, default=/a)" -Same as the -.B \-a -option to amd. This sets the private directory where amd will create -sub-directories for its real mount points. - -.TP -.BR cache_duration " (numeric, default=300)" +.Va arch +.Nm amd +variable. +.It Nm auto_dir (string, default=/a) +Same as the +.Fl a +option to +.Nm amd . +This sets the private directory where amd will create sub-directories for its +real mount points. +.It Nm cache_duration (numeric, default=300) Same as the -.B \-c -option to amd. Sets the duration in seconds that looked up map entries -remain in the cache. - -.TP -.BR cluster " (string, default no cluster)" -Same as the -.B \-C -option to amd. Specifies the alternate HP-UX cluster to use. - -.TP -.BR debug_options " (string, default no debug options)" +.Fl c +option to +.Nm amd . +Sets the duration in seconds that looked up map entries remain in the cache. +.It Nm cluster (string, default no cluster) Same as the -.B \-D -option to amd. Specify any debugging options for amd. Works only if -am-utils was configured for debugging using the --enable-debug option. The -"mem" option alone can be turned on via --enable-debug=mem. Otherwise -debugging options are ignored. Options are comma delimited, and can be -preceded by the string "no" to negate their meaning. You can get the list -of supported debugging options by running amd \-v. Possible values are: - -.nf -\fBall\fR all options -\fBamq\fR register for amq -\fBdaemon\fR enter daemon mode -\fBfork\fR fork server -\fBfull\fR program trace -\fBinfo\fR info service specific debugging (hesiod, nis, etc.) -\fBmem\fR trace memory allocations -\fBmtab\fR use local "./mtab" file -\fBstr\fR debug string munging -\fBtest\fR full debug but no daemon -\fBtrace\fR protocol trace -.fi - -.TP -.BR dismount_interval " (numeric, default=120)" +.Fl C +option to +.Nm amd . +Specifies the alternate +.Tm HP-UX +cluster to use. +.It Nm debug_options (string, default no debug options) +Same as the +.Fl D +option to +.Fl amd . +Specify any debugging options for +.Nm amd . +Works only if am-utils was configured for debugging using the +.Ic --enable-debug option . +The +.Qq mem +option alone can be turned on via +.Ic --enable-debug=mem . +Otherwise debugging options are ignored. Options are comma delimited, and can +be preceded by the string +.Qq no +to negate their meaning. You can get the list of supported debugging options +by running +.Nm amd Fl v . +Possible values are: +.Pp +.Bl -tag -width 10n -compact +.It Nm all +all options +.It Nm amq +register for +.Nm amq +.It Nm daemon +enter daemon mode +.It Nm fork +fork server +.It Nm full +program trace +.It Nm info +info service specific debugging +.Pq hesiod, nis, etc. +.It mem +trace memory allocations +.It Nm mtab +use local +.Pa ./mtab +file +.It Nm str +debug string munging +.It Nm test +full debug but no daemon +.It Nm trace +protocol trace +.El +.It Nm dismount_interval (numeric, default=120) Same as the -.B \-w -option to amd. Specify in seconds, the time between attempts to dismount -file systems that have exceeded their cached times. - -.TP -.BR fully_qualified_hosts " (string, default=no)" -If "yes", -.I Amd +.Fl w +option to +.Nm amd . +Specify, in seconds, the time between attempts to dismount file systems that +have exceeded their cached times. +.It Nm fully_qualified_hosts (string, default=no) +If +.Qq yes , +.Nm Amd will perform RPC authentication using fully-qualified host names. This is necessary for some systems, and especially when performing cross-domain mounting. For this function to work, the -.I Amd -variable ${hostd} is used, requiring that ${domain} not be null. - -.TP -.BR hesiod_base " (string, default=automount)" +.Nm amd +variable +.Va ${hostd} +is used, requiring that +.Va ${domain} +not be null. +.It Nm hesiod_base (string, default=automount) Specify the base name for hesiod maps. - -.TP -.BR karch " (string, default to karch of the system)" +.It Nm karch (string, default to karch of the system) Same as the -.B \-k -option to amd. Allows you to override the kernel-architecture of your -system. Useful for example on Sun (Sparc) machines, where you can build one -amd binary, and run it on multiple machines, yet you want each one to get -the correct -.I karch -variable set (for example, sun4c, sun4m, sun4u, etc.) Note that if not -specified, amd will use uname(2) to figure out the kernel architecture of -the machine. - -.TP -.BR ldap_base " (string, default not set)" +.Fl k +option to +.Nm amd . +Allows you to override the kernel-architecture of your system. Useful for +example on Sun +.Pq Sparc +machines, where you can build one +.Nm amd +binary and run it on multiple machines, yet you want each one to get the +correct +.Va karch +variable set +.Pq for example, sun4c, sun4m, sun4u, etc. +Note that if not +specified, +.Nm amd +will use +.Xr uname 2 +to figure out the kernel architecture of the machine. +.It Nm ldap_base (string, default not set) Specify the base name for LDAP. - -.TP -.BR ldap_cache_maxmem " (numeric, default=131072)" +.It Nm ldap_cache_maxmem (numeric, default=131072) Specify the maximum memory amd should use to cache LDAP entries. - -.TP -.BR ldap_cache_seconds " (numeric, default=0)" +.It Nm ldap_cache_seconds (numeric, default=0) Specify the number of seconds to keep entries in the cache. - -.TP -.BR ldap_hostports " (string, default not set)" +.It Nm ldap_hostports (string, default not set) Specify LDAP-specific values such as country and organization. - -.TP -.BR local_domain " (string, default no sub-domain)" +.It Nm local_domain (string, default no sub-domain) Same as the -.B \-d -option to amd. Specify the local domain name. If this option is not given -the domain name is determined from the hostname, by removing the first -component of the fully-qualified host name. - -.TP -.BR log_file " (string, default=/dev/stderr)" +.Fl d +option to +.Nm amd . +Specify the local domain name. If this option is not given the domain name is +determined from the hostname by removing the first component of the +fully-qualified host name. +.It Nm log_file (string, default=/dev/stderr) Same as the -.B \-l -option to amd. Specify a file name to log amd events to. -If the string -.B /dev/stderr -is specified, amd will send its events to the standard error file descriptor. -If the string -.B syslog -is given, amd will record its events with the system logger -.BR syslogd (8). -The default syslog facility used is LOG_DAEMON. If you -wish to change it, append its name to the log file name, delimited by a +.Fl l +option to +.Nm amd . +Specify a file name to log +.Nm amd +events to. If the string +.Pa /dev/stderr +is specified, +.Nm amd +will send its events to the standard error file descriptor. IF the string +.Pa syslog +is given, +.Nm amd +will record its events with the system logger +.Xr syslog 8 . +The default syslog facility used is +.Ev LOG_DAEMON . +If you wish to change it, append its name to the log file name, delimited by a single colon. For example, if -.I logfile +.Pa logfile is the string -.B syslog:local7 -then amd will log messages via -.IR syslog (3) -using the LOG_LOCAL7 facility (if it exists on the system). - -.TP -.BR log_options " (string, default no logging options)" +.Qq syslog:local7 +then +.Nm amd +will log messages via +.Xr syslog 3 +using the +.Ev LOG_LOCAL7 +facility +.Pq if it exists on the system . +.It Nm log_options (string, default no logging options) Same as the -.B \-x -option to amd. Specify any logging options for amd. Options are comma -delimited, and can be preceded by the string "no" to negate their meaning. -The "debug" logging option is only available if am-utils was configured with ---enable-debug. You can get the list of supported debugging options by -running amd \-v. Possible values are: - -.nf -\fBall\fR all messages -\fBdebug\fR debug messages -\fBerror\fR non-fatal system errors -\fBfatal\fR fatal errors -\fBinfo\fR information -\fBmap\fR map errors -\fBstats\fR additional statistical information -\fBuser\fR non-fatal user errors -\fBwarn\fR warnings -\fBwarning\fR warnings -.fi - -.TP -.BR nfs_retransmit_counter " (numeric, default=110)" +.Fl x +option to +.Nm amd . +Specify any logging options for +.Nm amd . +Options are comma delimited, and can be preceded by the string +.Dq no +to negate their meaning. The +.Dq debug +logging option is only available if +.Nm am-utils +was configured with +.Fl -enable-debug . +You can get the list of supported debugging options by running +.Nm amd Fl v . +Possible values are: +.Pp +.Bl -tag -width 10n -compact +.It Nm all +all messages +.It Nm debug +debug messages +.It Nm error +non-fatal system errors +.It Nm fatal +fatal errors +.It Nm info +information +.It Nm map +map errors +.It Nm stats +additional statistical information +.It Nm user +non-fatal user errors +.It Nm warn +warnings +.It Nm warning +warnings +.El +.It Nm nfs_retransmit_counter (numeric, default=110) Same as the -.I counter -part of the -.BI \-t " interval.counter" -option to amd. Specifies the retransmit counter's value in -.I tenths -of seconds. - -.TP -.BR nfs_retry_interval " (numeric, default=8)" +.Ic counter +part of the +.Fl t Ar interval.counter +option to +.Nm amd . +Specifies the retransmit counter's value in tenths of seconds. +.It Nm nfs_retry_interval (numeric, default=8) Same as the -.I interval +.Ic interval part of the -.BI \-t " interval.counter" -option to amd. Specifies the interval in -.I tenths -of seconds, between NFS/RPC/UDP retries. - -.TP -.BR nis_domain " (string, default to local NIS domain name)" +.Fl t Ar interval.counter +option to +.Nm amd . +Specifies the interval in tenths of seconds, between NFS/RPC/UDP retries. +.It Nm nis_domain +.Po string, default to local +.Tn NIS +.Pc domain name Same as the -.B \-y -option to amd. Specify an alternative NIS domain from which to fetch the -NIS maps. The default is the system domain name. This option is ignored if -NIS support is not available. - -.TP -.BR normalize_hostnames " (boolean, default=no)" +.Fl y +option to +.Nm amd . +Specify an alternative +.Tn NIS +domain from which to fetch the +.Tn NIS +maps. The default is the system domain name. This option is ignored if +.Tn NIS +support is not available. +.It Nm normalize_hostnames (boolean, default=no) Same as the -.B \-n -option to amd. If "yes", then the name refereed to by ${rhost} is -normalized relative to the host database before being used. The effect is -to translate aliases into ``official'' names. - -.TP -.BR os " (string, default to compiled in value)" +.Fl n +option to +.Nm amd . +If +.Dq yes , +then the name refereed to by +.Va ${rhost} +is normalized relative to the host database before being used. The effect is +to translate aliases into +.Qq official +names. +.It Nm os (string, default to compiled in value) Same as the -.B \-O -option to amd. Allows you to override the compiled-in name of the operating +.Fl O +option to +.Nm amd . +Allows you to override the compiled-in name of the operating system. Useful when the built-in name is not desired for backward -compatibility reasons. For example, if the build in name is ``sunos5'', you -can override it to ``sos5'', and use older maps which were written with the -latter in mind. - -.TP -.BR osver " (string, default to compiled in value)" +compatibility reasons. For example, if the build in name is +.Dq sunos5 , +you can override it to +.Dq sos5 , +and use older maps which were written with the latter in mind. +.It Nm osver (string, default to compiled in value) Same as the -.B \-o -option to amd. Override the compiled-in version number of the operating +.Fl o +option to +.Nm amd . +Override the compiled-in version number of the operating system. Useful when the built in version is not desired for backward -compatibility reasons. For example, if the build in version is ``2.5.1'', -you can override it to ``5.5.1'', and use older maps that were written with -the latter in mind. - -.TP -.BR pid_file " (string, default=/dev/stdout)" +compatibility reasons. For example, if the build in version is +.Dq 2.5.1 , +you can override it to +.Dq 5.5.1 , +and use older maps that were written with the latter in mind. +.It Nm pid_file (string, default=/dev/stdout) Specify a file to store the process ID of the running daemon into. If not -specified, amd will print its process id onto the standard output. Useful -for killing amd after it had run. Note that the PID of a running amd can -also be retrieved via -.B amq -.BR \-p . -This file is used only if the print_pid option is on. - -.TP -.BR plock " (boolean, default=yes)" +specified, +.Nm amd +will print its process id only the standard output. Useful for killing +.Nm amd +after it had run. Note that the PID of a running +.Nm amd +can also be retrieved via +.Nm amq Fl p . +This file is used only if the +.Ar print_pid +option is on. +.It Nm plock (boolean, default=yes) Same as the -.B \-S -option to amd. -If "yes", lock the running executable pages of amd into memory. To improve -amd's performance, systems that support the -.BR plock (3) -call can lock the amd process into memory. This way there is less chance it -the operating system will schedule, page out, and swap the amd process as -needed. This improves amd's performance, at the cost of reserving the -memory used by the amd process (making it unavailable for other processes). - -.TP -.BR portmap_program " (numeric, default=300019)" +.Fl S +option to +.Nm amd . +If +.Dq yes , +lock the running executable pages of +.Nm amd +into memory. To improve +.Nm amd's +performance, systems that support the +.Xr plock 3 +call can lock the +.Nm amd +process into memory. This way there is less chance it that the operating +system will schedule, page out, and swap the +.Nm amd +process as needed. This improves +.Nm amd's +performance, at the cost of reserving the memory used by the +.Nm amd +process +.Pq making it unavailable for other processes . +.It Nm portmap_program (numeric, default=300019) Specify an alternate Port-mapper RPC program number, other than the official -number. This is useful when running multiple amd processes. For example, -you can run another amd in "test" mode, without affecting the primary amd +number. This is useful when running multiple +.Nm amd +processes. For example, you can run another +.Nm amd +in +.Dq test +mode, without affecting the primary +.Nm amd process in any way. For safety reasons, the alternate program numbers that can be specified must be in the range 300019-300029, inclusive. -.B amq +.Nm amq has an option -.B -P -which can be used to specify an alternate program number of an amd to -contact. In this way, amq can fully control any number of amd processes -running on the same host. - -.TP -.BR print_pid " (boolean, default=no)" +.Fl P +which can be used to specify an alternate program number of an +.Nm amd +to contact. In this way, +.Nm amq +can fully control any number of +.Nm amd +processes running on the same host. +.It Nm print_pid (boolean, default=no) Same as the -.B \-p -option to amd. If "yes", amd will print its process ID upon starting. - -.TP -.BR print_version " (boolean, default=no)" +.Fl p +option to +.Nm amd . +If +.Dq yes , +.Nm amd +will print its process ID upon starting. +.It Nm print_version (boolean, default=no) Same as the -.B \-v -option to amd, but the version prints and amd continues to run. If "yes", -amd will print its version information string, which includes some -configuration and compilation values. - -.TP -.BR restart_mounts " (boolean, default=no)" +.Fl v +option to +.Nm amd , +but the version prints and +.Nm amd +continues to run. If +.Dq yes , +.Nm amd +will print its version information string, which includes some configuration +and compilation values. +.It Nm restart_mounts (boolean, default=no) Same as the -.B \-r -option to amd. If "yes" -.B amd +.Fl r +option to +.Nm amd . +If +.Dq yes , +.Nm amd will scan the mount table to determine which file systems are currently mounted. Whenever one of these would have been auto-mounted, -.B amd +.Nm amd inherits it. - -.TP -.BR selectors_on_default " (boolean, default=no)" -If "yes", then the /default entry of maps will be look for and process any -selectors before setting defaults for all other keys in that map. Useful -when you want to set different options for a complete map based on some -parameters. For example, you may want to better the NFS performance over -slow slip-based networks as follows: - -.nf +.It Nm selectors_on_default (boolean, default=no) +If +.Dq yes , +then the +.Pa /default +entry of maps will be looked for and process any selectors before setting +defaults for all other keys in that map. Useful when you want to set +different options for a complete map based on some parameters. For example, +you may want to better the +.Tn NFS +performance over slow slip-based networks as +follows: +.Pp +.Bd -literal /defaults \\ wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\ wire!=slip-net;opts:=intr,rsize=8192,wsize=8192 -.fi - -.TP -.BR show_statfs_entries " (boolean), default=no)" -If "yes", then all maps which are browsable will also show the number of -entries (keys) they have when "df" runs. (This is accomplished by returning -non-zero values to the statfs(2) system call). - -.TP -.BR unmount_on_exist " (boolean), default=no)" -If "yes", then amd will attempt to unmount all file systems which it knows -about. Normally amd leaves all (esp. NFS) mounted file systems intact. -Note that amd does not know about file systems mounted before it starts up, -unless the restart_mounts option or -.B \-r +.Ed +.It Nm show_statfs_entries (boolean), default=no) +If +.Dq yes , +then all maps which are browsable will also show the number of entries +.Pq keys +they have when +.Qq df +runs. +.Po This is accomplished by returning non-zero values to the +.Xr statfs 2 +.Pc system call . +.It Nm unmount_on_exist (boolean), default=no) +If +.Dq yes , +then +.Nm amd +will attempt to unmount all file systems which it knows about. Normally +.Nm amd +leaves all +.Pq esp. +.Tn NFS +mounted filesystems intact. Note that +.Nm amd +does not know about file systems mounted before it starts up, unless the +.AR restart_mounts +option or +.Fl r flag are used. - -.\" ************************************************************************** -.SS Parameters applicable to regular map sections - -.TP -.BR map_name " (string, must be specified)" +.El +.It Sy Parameters applicable to regular map sections +.Bl -tag -width F1 +.It Nm map_name (string, must be specified) Name of the map where the keys are located. - -.TP -.BR tag " (string, default no tag)" +.It Nm tag (string, default no tag) Each map entry in the configuration file can be tagged. If no tag is -specified, that map section will always be processed by amd. If it is -specified, then amd will process the map if the -.B -T -option was given to amd, and the value given to that command-line option -matches that in the map section. - -.\" ************************************************************************** -.SH EXAMPLES -Here is a real amd configuration file I use daily. -.P -.nf +specified, that map section will always be processed by +.Nm amd . +If it is specified, then +.Nm amd +will process the map if the +.Fl T +option was given to +.Nm amd , +and the value given to that command-line option matches that in the map +section. +.El +.Sh EXAMPLES +Here is a real +.Nm amd +configuration I use daily. +.Bd -literal # GLOBAL OPTIONS SECTION [ global ] normalize_hostnames = no @@ -508,31 +650,37 @@ browsable_dirs = yes # DEFINE AN AMD MOUNT POINT [ /u ] map_name = amd.u - -[ /proj ] + +[ /proj ] map_name = amd.proj - -[ /src ] + +[ /src ] map_name = amd.src - -[ /misc ] + +[ /misc ] map_name = amd.misc - -[ /import ] + +[ /import ] map_name = amd.import - -[ /tftpboot/.amd ] + +[ /tftpboot/.amd ] tag = tftpboot map_name = amd.tftpboot -.fi -.\" ************************************************************************** -.SH "SEE ALSO" -.BR amd (8), -.BR amq (8). -.SH AUTHORS -Erez Zadok <ezk@cs.columbia.edu>, Department of Computer Science, Columbia -University, New York, USA. -.P -Other authors and contributors to am-utils are listed in the -.B AUTHORS +.Ed +.Sh SEE ALSO +.Xr amd 8 , +.Xr amq 8 +.Sh AUTHORS +.An Erez Zadok Aq ezk@cs.columbia.edu , +Department of Computer Science, Columbia University, New York, USA. +.Pp +.An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , +Department of Computing, Imperial College, London, UK. +.Pp +.An Other Authors and contributers to am-utils are listed in the +.Nm AUTHORS file distributed with am-utils. +.Sh HISTORY +The +.Nm amd +utility first appeared in 4.4BSD. diff --git a/contrib/amd/wire-test/wire-test.8 b/contrib/amd/wire-test/wire-test.8 index 874ca92..b7db891 100644 --- a/contrib/amd/wire-test/wire-test.8 +++ b/contrib/amd/wire-test/wire-test.8 @@ -38,33 +38,44 @@ .\" .\" %W% (Berkeley) %G% .\" -.\" $Id: fixmount.8,v 5.2.2.1 1992/02/09 15:11:15 jsp beta $ +.\" $Id: wire-test.8,v 1.1.1.1 1998/08/23 22:07:21 obrien Exp $ .\" -.TH WIRE-TEST 8L "26 Feb 1993" -.SH NAME -wire-test \- test your network interfaces and local IP address -.SH SYNOPSIS -.B wire-test -[ -.I host -] -.SH DESCRIPTION -.LP -.B wire-test -is used to find out what amd thinks are the first two network -interfaces and network names/numbers used, as well as the IP address -used for amd to NFS-mount itself. - +.Dd February 26, 1993 +.Dt WIRE-TEST 8 +.Os +.Sh NAME +.Nm wire-test +.Nd test your network interfaces and local IP address +.Sh SYNOPSIS +.Nm +.Op Ar host +.Sh DESCRIPTION +.Nm +is used to find out what +.Nm Amd +thinks are the first two network interfaces and network names/numbers +used, as well as the IP address used for +.Nm Amd +to NFS-mount itself. +.Pp If -.I host +.Ar host is specified, then -.B wire-test -will test for the working combinations of NFS protocol and version from -the current client to the NFS server -.I host. +.Nm +will test for the working combinations of +.Tn NFS +protocol and version from the current client to the +.Tn NFS +server +.Ar host . If not specified, -.I host -defaults to "localhost". - -.SH "SEE ALSO" -.BR amd (8). +.Ar host +defaults to +.Dq localhost . +.Sh SEE ALSO +.Xr amd 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 3.0 . |