Apply a series of scripts to automatically fix some markup bugs.

Approved by:	re (blanket)

1 files changed, 167 insertions, 102 deletions

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 .