diff options
author | ru <ru@FreeBSD.org> | 2005-06-16 20:21:03 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2005-06-16 20:21:03 +0000 |
commit | caab8c754921f9dca4efa027b66a431abd8ad67f (patch) | |
tree | 17d486593cc1fc9af94b6e5c86ec01b8219f7e2f | |
parent | 6b05ae87c75ec1bbc879d9dd76bd644192f2ec48 (diff) | |
download | FreeBSD-src-caab8c754921f9dca4efa027b66a431abd8ad67f.zip FreeBSD-src-caab8c754921f9dca4efa027b66a431abd8ad67f.tar.gz |
Apply a series of scripts to automatically fix some markup bugs.
Approved by: re (blanket)
-rw-r--r-- | contrib/amd/amd/amd.8 | 117 | ||||
-rw-r--r-- | contrib/amd/amq/amq.8 | 72 | ||||
-rw-r--r-- | contrib/amd/amq/pawd.1 | 11 | ||||
-rw-r--r-- | contrib/amd/fixmount/fixmount.8 | 75 | ||||
-rw-r--r-- | contrib/amd/fsinfo/fsinfo.8 | 43 | ||||
-rw-r--r-- | contrib/amd/hlfsd/hlfsd.8 | 145 | ||||
-rw-r--r-- | contrib/amd/mk-amd-map/mk-amd-map.8 | 3 | ||||
-rw-r--r-- | contrib/amd/scripts/amd.conf.5 | 269 | ||||
-rw-r--r-- | contrib/amd/wire-test/wire-test.8 | 2 |
9 files changed, 445 insertions, 292 deletions
diff --git a/contrib/amd/amd/amd.8 b/contrib/amd/amd/amd.8 index d09fb5a..f9555e1 100644 --- a/contrib/amd/amd/amd.8 +++ b/contrib/amd/amd/amd.8 @@ -50,7 +50,7 @@ .Sh SYNOPSIS .Nm amd .Fl H -.Nm amd +.Nm amd .Op Fl F Ar conf_file .Nm amd .Op Fl nprvHS @@ -83,7 +83,8 @@ .Sh DESCRIPTION .Nm Amd is a daemon that automatically mounts file systems whenever a file or directory -within that file system is accessed. File systems are automatically unmounted +within that file system is accessed. +File systems are automatically unmounted when they appear to be quiescent. .Pp .Nm Amd @@ -96,17 +97,19 @@ are handled by .Nm amd , which uses the map defined by .Ar mapname -to determine how to resolve the lookup. Generally, this will be a host name, +to determine how to resolve the lookup. +Generally, this will be a host name, some file system information and some mount options for the given file system. .Pp In the first form depicted above, .Nm amd -will print a short help string. In the second form, if no options are +will print a short help string. +In the second form, if no options are specified, or if the .Fl F -is used, -.Nm amd -will read configuration parameters from the file +is used, +.Nm amd +will read configuration parameters from the file .Ar conf_file which defaults to .Pa /etc/amd.conf . @@ -121,12 +124,15 @@ The default is Specify a .Ar duration , in seconds, that a looked up name remains -cached when not in use. The default is 5 minutes. +cached when not in use. +The default is 5 minutes. .It Fl d Ar domain -Specify the local domain name. If this option is not +Specify the local domain name. +If this option is not given the domain name is determined from the hostname. .It Fl k Ar kernel-arch -Specifies the kernel architecture. This is used solely +Specifies the kernel architecture. +This is used solely to set the ${karch} selector. .It Fl l Ar logfile Specify a logfile in which to record mount and unmount events. @@ -136,31 +142,32 @@ is the string .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. +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 +For example, if .Ar logfile is the string .Dq Li syslog:local7 then .Nm amd -will log messages via +will log messages via .Xr syslog 3 using the LOG_LOCAL7 facility (if it exists on the system). .It Fl n Normalize hostnames. The name referred to by ${rhost} is normalized relative to the -host database before being used. The effect is to translate +host database before being used. +The effect is to translate aliases into ``official'' names. .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 +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 , +For example, if the build in version is +.Dq 2.5.1 , you can override it to -.Dq 5.5.1 , +.Dq 5.5.1 , and use older maps that were written with the latter in mind. .It Fl p Print @@ -172,7 +179,8 @@ to standard output where it can be saved into a file. Restart existing mounts. .Nm Amd will scan the mount file table to determine which file systems -are currently mounted. Whenever one of these would have +are currently mounted. +Whenever one of these would have been auto-mounted, .Nm amd .Em inherits @@ -182,25 +190,33 @@ Specify the NFS timeout .Ar interval , in tenths of a second, between .Tn NFS/RPC -retries (for UDP only). The default -is 0.8 seconds. The second value alters the retransmit counter, which -defaults to 11 retransmissions. Both of these values are used by the kernel -to communicate with amd. Useful defaults are supplied if either or both +retries (for UDP only). +The default +is 0.8 seconds. +The second value alters the retransmit counter, which +defaults to 11 retransmissions. +Both of these values are used by the kernel +to communicate with amd. +Useful defaults are supplied if either or both values are missing. .Pp Amd relies on the kernel RPC retransmit mechanism to trigger mount retries. -The values of these parameters change the overall retry interval. Too long +The values of these parameters change the overall retry interval. +Too long an interval gives poor interactive response; too short an interval causes excessive retries. .It Fl v -Version. Displays version and configuration information on standard error. +Version. +Displays version and configuration information on standard error. .It Fl w Ar interval Specify an .Ar interval , in seconds, between attempts to dismount file systems that have exceeded their -cached times. The default is 2 minutes. +cached times. +The default is 2 minutes. .It Fl x Ar options -Specify run-time logging options. The options are a comma separated list +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 @@ -215,10 +231,12 @@ support is not available. .It Fl C Ar cluster-name Specify an alternative HP-UX cluster name to use. .It Fl D Ar option -Select from a variety of debug options. Prefixing an +Select from a variety of debug options. +Prefixing an option with the string .Em no -reverses the effect of that option. Options are cumulative. +reverses the effect of that option. +Options are cumulative. The most useful option is .Ar all . .Pp @@ -232,40 +250,47 @@ and a fuller description is available in the program source. .It Fl F Ar conf_file Specify an .Nm amd -configuration file to use. See +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 +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 .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 +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. .It Fl O Ar op_sys_name -Override the compiled-in name of the operating system. +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 , +.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 +into memory. +To improve .Nm amd's -performance, systems that support the +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 +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 +process as needed. +This tends to improve .Nm amd's performance, at the cost of reserving the memory used by the .Nm amd @@ -277,7 +302,7 @@ option. .It Fl T Ar tag Specify a tag to use with .Xr amd.conf 5 . -All Map entries tagged with tag will be processed. +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 .Ar tag @@ -331,6 +356,11 @@ the features. .Re .Pp .Pa http://www.cs.columbia.edu/~ezk/am-utils/ +.Sh HISTORY +The +.Nm amd +utility first appeared in +.Bx 4.4 . .Sh AUTHORS .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , Department of Computing, Imperial College, London, UK. @@ -340,10 +370,5 @@ Department of Computer Science, Columbia University, New York, USA. .Pp Other authors and contributors to am-utils are listed in the -.Pa AUTHORS +.Pa AUTHORS file distributed with am-utils. -.Sh HISTORY -The -.Nm amd -utility first appeared in -.Bx 4.4 . diff --git a/contrib/amd/amq/amq.8 b/contrib/amd/amq/amq.8 index 6145508..6f94b12 100644 --- a/contrib/amd/amq/amq.8 +++ b/contrib/amd/amq/amq.8 @@ -81,17 +81,19 @@ 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 +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 .Ar log_file -as the log file name. +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 +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 @@ -102,10 +104,11 @@ 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 . +.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 +process, and would rather not have to search through the process table. +This option is used in the .Pa ctl-amd script. @@ -113,51 +116,54 @@ script. Request 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, +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 +Request the automounter to provide version information. +This is a subset of the information provided by .Nm amd Ns \'s Fl v option. .It Fl x Ar log_options -Ask the automounter to use the logging options specified in +Ask the automounter to use the logging options specified in .Ar log_options from now on. .It Fl D Ar log_options -Ask the automounter to use the debugging options specified in +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 +Pass a mount map entry to .Nm amd and wait for it to be evaluated, possibly causing a mount. -This option is highly insecure. +This option is highly insecure. By default, .Nm amd -and +and .Nm amq do not support it. It is necessary to configure .Nm am-utils -with +with .Ar --enable-amq-mount to enable this option. .It Fl P Ar program_number -Contact an alternate running -.Nm amd +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 -.Nm amd , -and need to manage each one separately. -If not specified, +.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. +If not specified, .Nm amq -will use the default program number for +will use the default program number for .Nm amd , 300019. For security reasons, the only alternate program numbers @@ -166,14 +172,14 @@ can use range from 300019 to 300029, inclusive. .It Fl T Contact .Nm amd -using the TCP transport only. -Normally +using the TCP transport only. +Normally .Nm amq will try TCP, and if that fails, will try UDP. .It Fl U -Contact +Contact .Nm amd -using UDP (connectionless) transport only. +using UDP (connectionless) transport only. Normally .Nm amq will try TCP, and if that fails, will try UDP. @@ -195,6 +201,10 @@ database. .Sh SEE ALSO .Xr amd.conf 5 , .Xr amd 8 +.Sh HISTORY +.Nm Amq +first appeared in +.Bx 4.4 . .Sh AUTHORS .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , Department of Computing, Imperial College, London, UK. @@ -202,13 +212,9 @@ Department of Computing, Imperial College, London, UK. .An Erez Zadok Aq ezk@cs.columbia.edu , Department of Computer Science, Columbia University, New York, USA. .Pp -.An Other authors and contributors to +.An Other authors and contributors to .Nm am-utils are listed in the -.Nm AUTHORS +.Nm AUTHORS file distributed with .Nm am-utils . -.Sh HISTORY -.Nm Amq -first appeared in -.Bx 4.4 . diff --git a/contrib/amd/amq/pawd.1 b/contrib/amd/amq/pawd.1 index 393836a..954bbab 100644 --- a/contrib/amd/amq/pawd.1 +++ b/contrib/amd/amq/pawd.1 @@ -54,17 +54,20 @@ .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 +possible path. +In particular, the path printed back does not include any of .Nm Amd Ns \'s -local mount points. Using them is unsafe, because +local mount points. +Using them is unsafe, because .Nm Amd may unmount managed file systems from the mount points, and thus including them in paths may not always find the files within. .Pp Without any arguments, .Nm -will print the automounter adjusted current working directory. With any +will print the automounter adjusted current working directory. +With any number of arguments, it will print the adjusted .Ar path of each one of the @@ -72,7 +75,7 @@ arguments. .Sh SEE ALSO .Xr pwd 1 , .Xr amd 8 , -.Xr amq 8 +.Xr amq 8 .Sh HISTORY The .Nm diff --git a/contrib/amd/fixmount/fixmount.8 b/contrib/amd/fixmount/fixmount.8 index cc2677a..1e32f11 100644 --- a/contrib/amd/fixmount/fixmount.8 +++ b/contrib/amd/fixmount/fixmount.8 @@ -55,12 +55,13 @@ \&... .Sh DESCRIPTION .Nm -is a variant of +is a variant of .Xr showmount 8 that can delete bogus mount entries in remote .Xr mountd 8 -daemons. The actions specified by the options are performed for each -.Ar host +daemons. +The actions specified by the options are performed for each +.Ar host in turn. .Sh OPTIONS .Bl -tag -width Ds @@ -76,18 +77,22 @@ from a crash or are the result of improper mount protocol. The actuality of mounts is verified using the entries in .Pa /etc/mtab . .It Fl v -Verify remote mounts. Similar to +Verify remote mounts. +Similar to .Fl r except that only a notification message is printed for each bogus entry -found. The remote mount table is not changed. +found. +The remote mount table is not changed. .It Fl A Issues a command to the remote mountd declaring that .Em all -of its file systems have been unmounted. This should be used with caution, as +of its file systems 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 file systems are still mounted locally. .It Fl v -Be quiet. Suppresses error messages due to timeouts and +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 . @@ -118,6 +123,24 @@ server. .Xr rmtab 5 , .Xr mountd 8 , .Xr showmount 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 3.0 . +.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 BUGS No attempt is made to verify the information in .Pa /etc/mtab @@ -126,14 +149,14 @@ itself. Since swap file mounts are not recorded in .Pa /etc/mtab , a heuristic specific to SunOS is used to determine whether such a mount -is actual (replacing the string -.Ql swap -with +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 +from the one in .Pa /etc/mtab . To catch those cases, a file system is also deemed mounted if its .Em local @@ -146,10 +169,11 @@ Since the local mount point is .Pa /usr/share as well this will be handled correctly. .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, +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 @@ -158,23 +182,6 @@ restarted. .Pp The RPC timeouts for .Nm mountd -calls can only be changed by recompiling. The defaults are 2 seconds +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 3565fd5..815ec7d 100644 --- a/contrib/amd/fsinfo/fsinfo.8 +++ b/contrib/amd/fsinfo/fsinfo.8 @@ -74,12 +74,14 @@ The following options are available: .Bl -tag -width Fl .It Fl a Ar autodir Specifies the directory name in which to place the automounter's -mount points. This defaults to +mount points. +This defaults to .Pa /a . .It Fl b Ar bootparams_prefix -Specifies the prefix for the +Specifies the prefix for the .Pa bootparams -file. If it is not given, then the file will not be generated. +file. +If it is not given, then the file will not be generated. The file will be constructed for the destination machine and will be placed into a file named .Pa bootparams @@ -91,7 +93,8 @@ diskless client that can boot from the destination machine. .It Fl d Ar dumpsets_prefix Specifies the prefix for the .Pa dumpsets -file. If it is not specified, then the file will not be generated. +file. +If it is not specified, then the file will not be generated. The file will be for the destination machine and will be placed into a file named .Pa dumpsets @@ -104,7 +107,8 @@ local backup system. .It Fl e Ar exports_prefix Defines the prefix for the .Pa exports -files. If it is not given, then the file will not be generated. +files. +If it is not given, then the file will not be generated. For each machine defined in the configuration files as having disks, and .Pa exports @@ -113,17 +117,20 @@ machine, prefixed with the .Ar exports_prefix string. If a machine is defined as diskless, then no -file will be created for it. The files contain entries +file will be created for it. +The files contain entries for directories on the machine that may be exported to clients. .It Fl f Ar fstabs_prefix This defines the prefix for the .Pa fstab -files. The files will only be created if this prefix is defined. +files. +The files will only be created if this prefix is defined. For each machine defined in the configuration files, a .Pa fstab file is created with the file name determined by prefixing this .Ar fstabs_prefix -string with the name of the machine. These files contain entries +string with the name of the machine. +These files contain entries for file systems and partitions to mount at boot time. .It Fl h Ar hostname Defines the hostname of the destination machine to process for. @@ -131,19 +138,24 @@ If this is not specified, it defaults to the local machine name, as returned by .Xr gethostname 3 . .It Fl m Ar automounts_prefix -Defines the prefix for the automounter files. The maps will -only be produced if this option is specified. The mount maps +Defines the prefix for the automounter files. +The maps will +only be produced if this option is specified. +The mount maps suitable for the network defined by the configuration files will be placed into files with names calculated by prefixing the .Ar automounts_prefix string to the name of each map. .It Fl q -Selects quite mode. Only error messages that are generated will +Selects quite mode. +Only error messages that are generated will be displayed. .It Fl v -Selects verbose mode. When this is activated, more messages +Selects verbose mode. +When this is activated, more messages will be displayed, and all information discovered when performing the semantic -analysis phase will be displayed. Each verbose message +analysis phase will be displayed. +Each verbose message is output to the standard output on a line starting with a `#' character. .It Fl D Xo @@ -157,7 +169,8 @@ Equivalent to the directive. .It Fl I Ar dir This option is passed into the preprocessor for the configuration -files. It specifies directories in which to find include files. +files. +It specifies directories in which to find include files. .It Fl U Ar name Removes and initial definition of the symbol .Ar name . @@ -165,7 +178,7 @@ Inverse of the .Fl D option. .It Ar config -One or more configuration files to be passed as input to +One or more configuration files to be passed as input to .Nm fsinfo . .El .Pp diff --git a/contrib/amd/hlfsd/hlfsd.8 b/contrib/amd/hlfsd/hlfsd.8 index a21f0e6..9ef049f 100644 --- a/contrib/amd/hlfsd/hlfsd.8 +++ b/contrib/amd/hlfsd/hlfsd.8 @@ -50,7 +50,7 @@ .Nm hlfsd .Nd home-link file system daemon .Sh SYNOPSIS -.Nm +.Nm .Op Fl fhnpvC .Op Fl a Ar alt_dir .Bk -words @@ -69,10 +69,11 @@ .Ek .Op linkname Op subdir .Sh DESCRIPTION -.Nm +.Nm is a daemon which implements a file system 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 +which accessed that link. +It was primarily designed to redirect incoming mail to users' home directories, so that it can read from anywhere. .Pp @@ -85,21 +86,26 @@ which defaults to .Pa /hlfs/home . Lookups within that directory are handled by .Nm hlfsd , -which uses the password map to determine how to resolve the lookup. The -directory will be created if it does not already exist. The symbolic link will +which uses the password map to determine how to resolve the lookup. +The +directory will be created if it does not already exist. +The symbolic link will be to the accessing user's home directory, with .Ar subdir -appended to it. If not specified, +appended to it. +If not specified, .Ar subdir -defaults to +defaults to .Pa .hlfsdir . This directory will also be created if it does not already exist. .Pp A .Er SIGHUP -will flush the internal caches, and reload the password map. It will also +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 +or rotated. +A .Er SIGUSR1 will cause it to dump its internal table of user IDs and home directories to the file @@ -107,13 +113,16 @@ the file .Sh OPTIONS .Bl -tag -width Ds .It Fl a Ar alt_dir -Alternate directory. The name of the directory to which +Alternate directory. +The name of the directory to which the symbolic link returned by .Nm -will point, if it cannot access the home directory of the user. This +will point, if it cannot access the home directory of the user. +This defaults to .Pa /var/hlfs . -This directory will be created if it does not exist. It is expected +This directory will be created if it does not exist. +It is expected that either users will read these files, or the system administrators will run a script to resend this .Dq lost mail @@ -122,19 +131,22 @@ to its owner. Caching interval. .Nm will cache the validity of home directories for this interval, in -seconds. Entries which have been verified within the last +seconds. +Entries which have been verified within the last .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, .Nm will re-verify the validity of the user's home directory, and -reset the cache time-counter. The default value for +reset the cache time-counter. +The default value for .Ar cache-interval -is 300 seconds +is 300 seconds (5 minutes). -.It Fl f -Force fast startup. This option tells +.It Fl f +Force fast startup. +This option tells .Nm to skip startup-time consistency checks such as existence of mount directory, alternate spool directory, symlink to be hidden under the @@ -149,15 +161,18 @@ Programs such as (which access the mailboxes of other users) must be setgid .Va HLFS_GID -to work properly. The default group is +to work properly. +The default group is .Dq hlfs . -If no group is provided, and there is no group -.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. +Help. +Print a brief help message, and exit. .It Fl i Ar reload-interval -Map-reloading interval. Each +Map-reloading interval. +Each .Ar reload-interval seconds, .Nm @@ -165,47 +180,53 @@ will reload the password map. .Nm needs the password map for the UIDs and home directory pathnames. .Nm -schedules a -.Va SIGALRM -to reload the password maps. A -.Va SIGHUP +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 +will force it to reload the maps immediately. +The default value for .Ar reload-interval -is 900 seconds +is 900 seconds (15 minutes). .It Fl l Ar logfile Specify a log file to which .Nm -will record events. If +will record events. +If .Pa logfile is the string .Pa syslog then the log messages will be sent to the system log daemon by .Xr syslog 3 , -using the +using the .Va LOG_DAEMON -facility. This is also the default. +facility. +This is also the default. .It Fl n No verify. .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 +sufficient disk-space for spooling. +This can speed up .Nm at the cost of possibly returning symbolic links to home directories which are not currently accessible or are full. By default, .Nm validates the symbolic-link in the background. -The +The .Fl n option overrides the meaning of the .Fl c option, since no caching is necessary. .It Fl o Ar mount-options -Mount options. Mount options which +Mount options. +Mount options which .Nm will use to mount itself on top of .Pa dirname . @@ -214,36 +235,44 @@ By default, is set to .Qq ro . If the system supports symbolic-link caching, default -options are set to +options are set to .Qq ro,nocache . .It Fl p -Prints +Prints .Va PID . Outputs the process-id of .Nm to standard output where it can be saved into a file. .It Fl v -Version. Displays version information to standard error. +Version. +Displays version information to standard error. .It Fl x Ar log-options -Specify run-time logging options. The options are a comma separated +Specify run-time logging options. +The options are a comma separated list chosen from: fatal, error, user, warn, info, map, stats, all. .It Fl C Force .Nm -to run on systems that cannot turn off the NFS attribute-cache. Use of +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 mis-delivery of mail. The option is ignored on systems that can turn +or mis-delivery of mail. +The option is ignored on systems that can turn off the attribute-cache. .It Fl D Ar log-options -Select from a variety of debugging options. Prefixing an +Select from a variety of debugging options. +Prefixing an option with the string .Qq no -reverses the effect of that option. Options are cumulative. +reverses the effect of that option. +Options are cumulative. The most useful option is .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 +documented here. +A fuller description is available in the program +source. +A .Va SIGUSR1 sent to .Nm @@ -256,15 +285,19 @@ Normally, .Nm will use .Xr getpwent 3 -to read the password database. This option allows you to override the +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 +directory other than their home directory. +Only the username, uid, and home-directory fields of the file .Ar password-file -are read and checked. All other fields are ignored. The file +are read and checked. +All other fields are ignored. +The file .Ar password-file -must be compliant with -.Ux +must be compliant with +.Ux System 7 colon-delimited format .Xr passwd 5 . .El @@ -296,15 +329,20 @@ user's home directory is accessible. .Xr mtab 5 , .Xr passwd 5 , .Xr amd 8 , -.Xr cron 8 , +.Xr cron 8 , .Xr mount 8 , .Xr sendmail 8 , .Xr umount 8 .Rs -.%T HLFSD: Delivering Email to Your $HOME +.%T HLFSD: Delivering Email to Your $HOME .%B Proc. LISA-VII, The 7th Usenix System Administration Conference .%D November 1993 .Re +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 3.0 . .Sh AUTHORS .An Erez Zadok Aq ezk@cs.columbia.edu , Department of Computer Science, Columbia University, @@ -312,8 +350,3 @@ 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 fe7af50..fef0e74 100644 --- a/contrib/amd/mk-amd-map/mk-amd-map.8 +++ b/contrib/amd/mk-amd-map/mk-amd-map.8 @@ -57,7 +57,8 @@ hashed database. The .Fl p option prints the map on standard output instead of generating -a database. This is usually used to merge continuation lines +a database. +This is usually used to merge continuation lines into one physical line. .Sh SEE ALSO .Xr amd.conf 5 , diff --git a/contrib/amd/scripts/amd.conf.5 b/contrib/amd/scripts/amd.conf.5 index 7a5060d..8b84754 100644 --- a/contrib/amd/scripts/amd.conf.5 +++ b/contrib/amd/scripts/amd.conf.5 @@ -59,24 +59,31 @@ contains runtime configuration information for the .Xr amd 8 automounter program. .Sh FILE FORMAT -The file consists of sections and parameters. A section begins with the +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 of the file is reached. Sections contain parameters of -the form +begins or the end of the file is reached. +Sections contain parameters of +the 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 +either a comment, a section name or a parameter. +No line-continuation syntax is available. .Pp Section, parameter names and their values are case sensitive. .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 +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 +parameter value is quoted with double quotes as in .Sq name = Qq some\ value . .Pp Any line beginning with a pound sign (#) is ignored, as are lines containing @@ -84,17 +91,21 @@ only whitespace. .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 +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 +Parameters in this section either apply to .Nm amd -as a whole, or to all other regular map sections which follow. There +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 +configuration file. +If it is not, then regular map sections which precede it will not use global values defined later. .Ss "Regular [/map] sections" Parameters in regular (non-global) sections apply to a single map entry. @@ -106,58 +117,66 @@ amd-managed mount point. .Sh PARAMETERS .Ss "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 +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. .Bl -tag -width 4n .It Ic browsable_dirs Xo (string, default=no) .Xc -If -.Qq yes , +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 +calls. +This means you could run for example .Xr ls 1 -and see what keys are available to mount in that directory. Not all entries -are made visible to +and see what keys are available to mount in that directory. +Not all entries +are made visible to .Xr readdir 3 : -the +the .Qq Pa /default -entry, wildcard entries, and those with a -.Qq Pa / -in them are not included. If you specify +entry, wildcard entries, and those with a +.Qq Pa / +in them are not included. +If you specify .Qq full -to this option, all but +to this option, all but .Qq Pa /default -will be visible. Note that if you run a command which will attempt to +will be visible. +Note that if you run a command which will attempt to .Xr stat 2 -the entries, such as often done by +the entries, such as often done by .Qq ls -l or .Qq ls -F , .Nm amd -will attempt to mount +will attempt to mount .Em every -entry in that map. This is often called a +entry in that map. +This is often called a .Dq mount storm . .It Ic map_options Xo (string, default no options) .Xc -This option is the same as specifying map options on the command line to +This option is the same as specifying map options on the command line to .Nm amd , such as .Ql cache\&:\&=all . .It Ic map_type Xo (string, default search all map types) .Xc -If specified, amd will initialize the map only for the type given. +If specified, amd will initialize the map only for the type given. This is useful to avoid the default map search type used by .Nm amd which takes longer and can have undesired side-effects such as initializing .Tn NIS -even if not used. Possible values are: +even if not used. +Possible values are: .Pp .Bl -tag -width "nisplus" -compact .It Ic file @@ -174,7 +193,7 @@ Network Information Services (version 2) Network Information Services Plus (version 3) .It Ic passwd local password files -.It Ic union +.It Ic union union maps .El .It Ic mount_type Xo @@ -186,16 +205,18 @@ 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 +server on the map mount points, for the local host it is running on. +If +.Qq autofs is specified, amd will log an error and convert it to .Tn NFS . .It Ic search_path Xo (string, default no search path) .Xc -This provides a +This provides a (colon-delimited) -search path for file maps. Using a search path, sites can allow for +search path for file maps. +Using a search path, sites can allow for local map customizations and overrides, and can query distributed maps in several locations as needed. .El @@ -210,7 +231,7 @@ Allows you to override the value of the variable. .It Ic auto_dir Xo (string, default= Ns Pa /a ) .Xc -Same as the +Same as the .Fl a option to .Nm amd . @@ -237,7 +258,7 @@ cluster to use. .It Ic debug_options Xo (string, default no debug options) .Xc -Same as the +Same as the .Fl D option to .Nm amd . @@ -250,19 +271,21 @@ The .Qq mem option alone can be turned on via .Fl -enable-debug Ns = Ns Ic mem . -Otherwise debugging options are ignored. Options are comma delimited, and can +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 +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 "daemon" -compact -.It Ic all +.It Ic all all options .It Ic amq -register for +register for .Xr amq 8 .It Ic daemon enter daemon mode @@ -273,7 +296,7 @@ program trace .It Ic info info service specific debugging (hesiod, nis, etc.) -.It Ic mem +.It Ic mem trace memory allocations .It Ic mtab use local @@ -294,18 +317,20 @@ Same as the option to .Nm amd . Specify, in seconds, the time between attempts to dismount file systems that -have exceeded their cached times. +have exceeded their cached times. .It Ic fully_qualified_hosts Xo (string, default=no) .Xc If .Qq yes , .Nm amd -will perform RPC authentication using fully-qualified host names. This is +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 +mounting. +For this function to work, the .Nm amd -variable +variable .Va ${hostd} is used, requiring that .Va ${domain} @@ -321,13 +346,14 @@ Same as the .Fl k option to .Nm amd . -Allows you to override the kernel-architecture of your system. Useful for +Allows you to override the kernel-architecture of your system. +Useful for example on Sun (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 +correct .Va karch variable set (for example, sun4c, sun4m, sun4u, etc.) @@ -360,7 +386,8 @@ Same as the .Fl d option to .Nm amd . -Specify the local domain name. If this option is not given the domain name is +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 Ic log_file Xo (string, default= Ns Pa /dev/stderr ) @@ -371,11 +398,13 @@ option to .Nm amd . Specify a file name to log .Nm amd -events to. If the string +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 +will send its events to the standard error file descriptor. +IF the string .Pa syslog is given, .Nm amd @@ -384,7 +413,8 @@ will record its events with the system logger 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 +single colon. +For example, if .Pa logfile is the string .Qq syslog:local7 @@ -407,7 +437,8 @@ 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 +to negate their meaning. +The .Dq debug logging option is only available if am-utils was configured with .Fl -enable-debug . @@ -416,7 +447,7 @@ You can get the list of supported debugging and logging options by running Possible values are: .Pp .Bl -tag -width "warning" -compact -.It Ic all +.It Ic all all messages .It Ic debug debug messages @@ -440,10 +471,13 @@ warnings .It Ic nfs_proto Xo (string, default to trying version tcp then udp) .Xc -By default, amd tries TCP and then UDP. This option forces the overall +By default, amd tries TCP and then UDP. +This option forces the overall .Tn NFS -protocol used to TCP or UDP. It overrides what is in the amd maps, and is -useful when amd is compiled with NFSv3 support that may not be stable. With +protocol used to TCP or UDP. +It overrides what is in the amd maps, and is +useful when amd is compiled with NFSv3 support that may not be stable. +With this option you can turn off the complete usage of NFSv3 dynamically (without having to recompile amd) until such time as NFSv3 support is desired again. @@ -462,7 +496,7 @@ Specifies the retransmit counter's value in tenths of seconds. .Xc Same as the .Ic interval -part of the +part of the .Fl t Ar interval.counter option to .Nm amd . @@ -478,29 +512,36 @@ The values of the .Ic nfs_retransmit_counter and the .Ic nfs_retry_interval -parameters change the overall retry interval. Too long an interval gives +parameters change the overall retry interval. +Too long an interval gives poor interactive response; too short an interval causes excessive retries. .It Ic nfs_allow_insecure_port Xo (string, default=no). .Xc Normally amd will refuse requests coming from unprivileged ports (i.e. ports >= 1024 on Unix systems), so that only privileged users and the kernel -can send NFS requests to it. However, some kernels (certain versions of +can send NFS requests to it. +However, some kernels (certain versions of Darwin, MacOS X, and Linux) have bugs that cause them to use unprivileged ports in certain situations, which causes amd to stop dead in its -tracks. This parameter allows amd to operate normally even on such systems, -at the expense of a slight decrease in the security of its operations. If +tracks. +This parameter allows amd to operate normally even on such systems, +at the expense of a slight decrease in the security of its operations. +If you see messages like "ignoring request from foo:1234, port not reserved" in your amd log, try enabling this parameter and give it another go. .It Ic nfs_vers Xo (numeric, default to trying version 3 then 2) .Xc -By default, amd tries version 3 and then version 2. This option forces the +By default, amd tries version 3 and then version 2. +This option forces the overall .Tn NFS -protocol used to version 3 or 2. It overrides what is in the +protocol used to version 3 or 2. +It overrides what is in the amd maps, and is useful when amd is compiled with NFSv3 support that may not -be stable. With this option you can turn off the complete usage of NFSv3 +be stable. +With this option you can turn off the complete usage of NFSv3 dynamically (without having to recompile amd) until such time as NFSv3 support is desired again. .It Ic nis_domain Xo @@ -516,7 +557,9 @@ 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 +maps. +The default is the system domain name. +This option is ignored if .Tn NIS support is not available. .It Ic normalize_hostnames Xo @@ -530,7 +573,8 @@ If .Dq yes , then the name refered to by .Va ${rhost} -is normalized relative to the host database before being used. The effect is +is normalized relative to the host database before being used. +The effect is to translate aliases into .Qq official names. @@ -542,8 +586,10 @@ Same as the 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 +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 , @@ -556,20 +602,25 @@ Same as the 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 +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 Ic pid_file Xo (string, default= Ns Pa /dev/stdout ) .Xc -Specify a file to store the process ID of the running daemon into. If not +Specify a file to store the process ID of the running daemon into. +If not specified, .Nm amd -will print its process id only the standard output. Useful for killing +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 +after it had run. +Note that the PID of a running .Nm amd can also be retrieved via .Nm amq Fl p . @@ -587,16 +638,19 @@ If .Dq yes , lock the running executable pages of .Nm amd -into memory. To improve +into memory. +To improve .Nm amd Ns '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 +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 +process as needed. +This improves .Nm amd Ns 's performance, at the cost of reserving the memory used by the .Nm amd @@ -606,22 +660,26 @@ process (numeric, default=300019) .Xc Specify an alternate Port-mapper RPC program number, other than the official -number. This is useful when running multiple +number. +This is useful when running multiple .Nm amd -processes. For example, you can run another +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 +process in any way. +For safety reasons, the alternate program numbers that can be specified must be in the range 300019-300029, inclusive. .Nm amq has an option .Fl P which can be used to specify an alternate program number of an .Nm amd -to contact. In this way, +to contact. +In this way, .Nm amq can fully control any number of .Nm amd @@ -646,7 +704,8 @@ option to .Nm amd , but the version prints and .Nm amd -continues to run. If +continues to run. +If .Dq yes , .Nm amd will print its version information string, which includes some configuration @@ -662,7 +721,8 @@ 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, +mounted. +Whenever one of these would have been auto-mounted, .Nm amd inherits it. .It Ic selectors_on_default Xo @@ -673,8 +733,10 @@ If 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, +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 @@ -703,14 +765,16 @@ system call.) .Xc If .Dq yes , -then +then .Nm amd -will attempt to unmount all file systems which it knows about. Normally +will attempt to unmount all file systems which it knows about. +Normally .Nm amd -leaves all +leaves all (esp.\&) .Tn NFS -mounted file systems intact. Note that +mounted file systems intact. +Note that .Nm amd does not know about file systems mounted before it starts up, unless the .Ar restart_mounts @@ -727,7 +791,8 @@ Name of the map where the keys are located. .It Ic tag Xo (string, default no tag) .Xc -Each map entry in the configuration file can be tagged. If no tag is +Each map entry in the configuration file can be tagged. +If no tag is specified, that map section will always be processed by .Nm amd . If it is specified, then @@ -737,10 +802,10 @@ will process the map if the option was given to .Nm amd , and the value given to that command-line option matches that in the map -section. +section. .El .Sh EXAMPLES -Here is a real +Here is a real .Nm amd configuration I use daily. .Bd -literal @@ -785,7 +850,12 @@ map_name = amd.tftpboot .Ed .Sh SEE ALSO .Xr amd 8 , -.Xr amq 8 +.Xr amq 8 +.Sh HISTORY +The +.Nm amd +utility first appeared in +.Bx 4.4 . .Sh AUTHORS .An Erez Zadok Aq ezk@cs.columbia.edu , Department of Computer Science, Columbia University, New York, USA. @@ -793,11 +863,6 @@ Department of Computer Science, Columbia University, New York, USA. .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk , Department of Computing, Imperial College, London, UK. .Pp -Other authors and contributers to am-utils are listed in the +Other authors and contributers to am-utils are listed in the .Pa AUTHORS file distributed with am-utils. -.Sh HISTORY -The -.Nm amd -utility first appeared in -.Bx 4.4 . diff --git a/contrib/amd/wire-test/wire-test.8 b/contrib/amd/wire-test/wire-test.8 index d3247f7..2c6a37c 100644 --- a/contrib/amd/wire-test/wire-test.8 +++ b/contrib/amd/wire-test/wire-test.8 @@ -74,7 +74,7 @@ If not specified, defaults to .Dq localhost . .Sh SEE ALSO -.Xr amd 8 +.Xr amd 8 .Sh HISTORY The .Nm |