8300 fix man page issues found by mandoc 1.14.1

Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Toomas Soome <tsoome@me.com>
Approved by: Gordon Ross <gwr@nexenta.com>

1 files changed, 147 insertions, 105 deletions

diff --git a/usr/src/man/man1m/automount.1m b/usr/src/man/man1m/automount.1m
index 3ce74a5b1d..717d4fafe1 100644
--- a/usr/src/man/man1m/automount.1m
+++ b/usr/src/man/man1m/automount.1m
@@ -34,18 +34,21 @@ The
 .Nm
 utility installs
 .Nm autofs
-mount points and associates an automount map with each mount point. It starts
-the
+mount points and associates an automount map with each mount point.
+It starts the
 .Xr automountd 1M
 daemon if it finds any non-trivial entries in either local or distributed
-automount maps and if the daemon is not already running. The
+automount maps and if the daemon is not already running.
+The
 .Nm autofs
 file system monitors attempts to access directories within it and notifies the
 .Xr automountd 1M
-daemon. The daemon uses the map to locate a file system, which it then mounts at
-the point of reference within the
+daemon.
+The daemon uses the map to locate a file system, which it then mounts at the
+point of reference within the
 .Nm autofs
-file system. A map can be assigned to an
+file system.
+A map can be assigned to an
 .Nm autofs
 mount using an entry in the
 .Pa /etc/auto_master
@@ -61,7 +64,8 @@ The file
 .Pa /etc/auto_master
 determines the locations of all
 .Nm autofs
-mount points. By default, this file contains three entries:
+mount points.
+By default, this file contains three entries:
 .Bd -literal -offset indent
 # Master map for automounter
 #
@@ -72,17 +76,21 @@ mount points. By default, this file contains three entries:
 .Pp
 The
 .Sy +auto_master
-entry is a reference to an external NIS master map. If one exists, then
-its entries are read as if they occurred in place of the
+entry is a reference to an external NIS master map.
+If one exists, then its entries are read as if they occurred in place of the
 .Sy +auto_master
-entry. The remaining entries in the master file specify a directory on which an
+entry.
+The remaining entries in the master file specify a directory on which an
 .Nm autofs
 mount will be made followed by the automounter map to be associated with it.
 Optional mount options may be supplied as an optional third field in the each
-entry. These options are used for any entries in the map that do not specify
-mount options explicitly. The
+entry.
+These options are used for any entries in the map that do not specify mount
+options explicitly.
+The
 .Nm
-command is usually run without arguments. It compares the entries
+command is usually run without arguments.
+It compares the entries
 .Pa /etc/auto_master
 with the current list of
 .Nm autofs
@@ -96,33 +104,37 @@ up to date with the
 .Pa /etc/auto_master .
 At boot time it installs all
 .Nm autofs
-mounts from the master map. Subsequently, it may be run to install
+mounts from the master map.
+Subsequently, it may be run to install
 .Nm autofs
 mounts for new entries in the master map or the direct map, or to perform
 unmounts for entries that have been removed from these maps.
 .Ss Automount with Solaris Trusted Extensions
 If a system is configured with Solaris Trusted Extensions, additional
-processing is performed to facilitate multilevel home directory access. A list
-of zones whose labels are dominated by the current zone is generated and
+processing is performed to facilitate multilevel home directory access.
+A list of zones whose labels are dominated by the current zone is generated and
 default
 .Sy auto_home
-automount maps are generated if they do not currently exist. These automount
-maps are named
+automount maps are generated if they do not currently exist.
+These automount maps are named
 .Sy auto_home_ Ns Ar zonename ,
 where
 .Ar zonename
-is the name of each zone's lower-level zone. An
+is the name of each zone's lower-level zone.
+An
 .Nm autofs
 mount of each such
 .Sy auto_home
 map is then performed, regardless of whether it is explicitly or implicitly
-listed in the master map. Instead of
+listed in the master map.
+Instead of
 .Nm autofs
 mounting the standard
 .Sy auto_home
 map, the zone uses an
 .Pa auto_home
-file appended with its own zone name. Each zone's
+file appended with its own zone name.
+Each zone's
 .Sy auto_home
 map is uniquely named so that it can be maintained and shared by all zones using
 a common name server.
@@ -130,7 +142,8 @@ a common name server.
 By default, the home directories of lower-level zones are mounted read-only
 under
 .Pa /zone/ Ns Ar zonename Ns Pa /export/home
-when each zone is booted. The default
+when each zone is booted.
+The default
 .Sy auto_home_ Ns Ar zonename
 automount map specifies that path as the source directory for an
 .Nm lofs
@@ -147,22 +160,23 @@ as generated from a higher level zone would contain:
 When a home directory is referenced and the name does not match any other keys
 in the
 .Sy auto_home_public
-map, it will match this loopback mount specification. If this loopback match
-occurs and the name corresponds to a valid user whose home directory does not
-exist in the public zone, the directory is automatically created on behalf of
-the user.
+map, it will match this loopback mount specification.
+If this loopback match occurs and the name corresponds to a valid user whose
+home directory does not exist in the public zone, the directory is automatically
+created on behalf of the user.
 .Sh OPTIONS
 The following options are supported:
 .Bl -tag -width Ds
 .It Fl v
-Verbose mode. Notifies of
+Verbose mode.
+Notifies of
 .Nm autofs
 mounts, unmounts, or other non-essential information.
 .It Fl t Ar duration
 Specifies a
 .Ar duration ,
-in seconds, that a file system is to remain mounted when not in use. The default
-is
+in seconds, that a file system is to remain mounted when not in use.
+The default is
 .Sy 10
 minutes.
 .El
@@ -184,8 +198,8 @@ is a comma-separated list of
 .Nm mount
 options, and
 .Ar location
-specifies a file system from which the directory may be mounted. In the case of
-a simple NFS mount, the options that can be used are specified in
+specifies a file system from which the directory may be mounted.
+In the case of a simple NFS mount, the options that can be used are specified in
 .Xr mount_nfs 1M ,
 and
 .Ar location
@@ -211,17 +225,19 @@ If the read-only flag is set in the map entry,
 .Nm automountd
 mounts a list of locations that the kernel may use, sorted by several criteria.
 Only locations available at mount time will be mounted, and thus be available to
-the kernel. When a server does not respond, the kernel will switch to an
-alternate server. The sort ordering of
+the kernel.
+When a server does not respond, the kernel will switch to an alternate server.
+The sort ordering of
 .Nm
-is used to determine how the next server is chosen. If the read-only flag is not
-set,
+is used to determine how the next server is chosen.
+If the read-only flag is not set,
 .Nm
 will mount the best single location, chosen by the same sort ordering, and new
 servers will only be chosen when an unmount has been possible, and a remount is
-done. Servers on the same local subnet are given the strongest preference, and
-servers on the local net are given the second strongest preference. Among
-servers equally far away, response times will determine the order if no
+done.
+Servers on the same local subnet are given the strongest preference, and servers
+on the local net are given the second strongest preference.
+Among servers equally far away, response times will determine the order if no
 weighting factors
 .Pq see below
 are used.
@@ -230,9 +246,10 @@ If the list includes server locations using both the NFS Version 2 Protocol and
 the NFS Version 3 Protocol,
 .Nm
 will choose only a subset of the server locations on the list, so that all
-entries will be the same protocol. It will choose servers with the NFS Version 3
-Protocol so long as an NFS Version 2 Protocol server on a local subnet will not
-be ignored. See the FIXME for additional details.
+entries will be the same protocol.
+It will choose servers with the NFS Version 3 Protocol so long as an NFS Version
+2 Protocol server on a local subnet will not be ignored.
+See the FIXME for additional details.
 .Pp
 If each
 .Ar location
@@ -246,11 +263,11 @@ may be used with a comma-separated list of hostnames:
 .Ed
 .Pp
 Requests for a server may be weighted, with the weighting factor appended to
-the server name as an integer in parentheses. Servers without a weighting are
-assumed to have a value of zero
+the server name as an integer in parentheses.
+Servers without a weighting are assumed to have a value of zero
 .Pq most likely to be selected .
-Progressively higher values decrease the chance of being selected. In the
-example,
+Progressively higher values decrease the chance of being selected.
+In the example,
 .Bd -literal -offset indent
 man -ro	alpha,bravo,charlie(1),delta(4):/usr/man
 .Ed
@@ -263,19 +280,21 @@ have the highest priority; host
 .Sy delta
 has the lowest.
 .Pp
-Server proximity takes priority in the selection process. In the example above,
-if the server
+Server proximity takes priority in the selection process.
+In the example above, if the server
 .Sy delta
 is on the same network segment as the client, but the others are on different
 network segments, then
 .Sy delta
-will be selected; the weighting value is ignored. The weighting has effect only
-when selecting between servers with the same network proximity. The automounter
-always selects the localhost over other servers on the same network segment,
-regardless of weighting.
+will be selected; the weighting value is ignored.
+The weighting has effect only when selecting between servers with the same
+network proximity.
+The automounter always selects the localhost over other servers on the same
+network segment, regardless of weighting.
 .Pp
 In cases where each server has a different export point, the weighting can
-still be applied. For example:
+still be applied.
+For example:
 .Bd -literal -offset indent
 man	-ro	alpha:/usr/man bravo,charlie(1):/usr/share/man \e
 		delta(3):/export/man
@@ -292,7 +311,8 @@ The ampersand
 .Pq Qq Sy \*(Am
 character is expanded to the value of the
 .Ar key
-field for the entry in which it occurs. In this case:
+field for the entry in which it occurs.
+In this case:
 .Bd -literal -offset indent
 jane	sparcserver:/home/&
 .Ed
@@ -306,9 +326,9 @@ The asterisk
 .Pq Qq Sy *
 character, when supplied as the
 .Ar key
-field, is recognized as the catch-all entry. Such an entry will match any key
-not previously matched. For instance, if the following entry appeared in the
-indirect map for
+field, is recognized as the catch-all entry.
+Such an entry will match any key not previously matched.
+For instance, if the following entry appeared in the indirect map for
 .Pa /config :
 .Bd -literal -offset indent
 *	&:/export/config/&
@@ -327,12 +347,13 @@ option.
 .Ss Variable Substitution
 Client specific variables can be used within an
 .Nm
-map. For instance, if
+map.
+For instance, if
 .Sy $HOST
 appeared within a map,
 .Nm
-would expand it to its current value for the client's host name. Supported
-variables are:
+would expand it to its current value for the client's host name.
+Supported variables are:
 .Bl -column "PLATFORM" "arch -k or uname -m"
 .It Sy NAME Ta Sy OUTPUT OF Ta Sy DESCRIPTION (EXAMPLE)
 .It Ev ARCH
@@ -385,8 +406,8 @@ A multiple mount entry takes the form:
 .Pp
 The initial
 .Ar mountpoint
-is optional for the first mount and mandatory for all subsequent mounts. The
-optional
+is optional for the first mount and mandatory for all subsequent mounts.
+The optional
 .Ar mountpoint
 is taken as a pathname relative to the directory named by
 .Ar key .
@@ -422,15 +443,16 @@ or
 .Sy svr2 ,
 whichever host is nearest and responds first.
 .Ss Other File System Types
-The automounter assumes NFS mounts as a default file system type. Other file
-system types can be described using the
+The automounter assumes NFS mounts as a default file system type.
+Other file system types can be described using the
 .Sy fstype
-mount option. Other mount options specific to this file system type can be
-combined with the
+mount option.
+Other mount options specific to this file system type can be combined with the
 .Sy fstype
-option. The location field must contain information specific to the file system
-type. If the location field begins with a slash, a colon character must be
-prepended, for instance, to mount a CD file system:
+option.
+The location field must contain information specific to the file system type.
+If the location field begins with a slash, a colon character must be prepended,
+for instance, to mount a CD file system:
 .Bd -literal -offset indent
 cdrom	-fstype=hsfs,ro	:/dev/sr0
 .Ed
@@ -451,23 +473,26 @@ section for information on option inheritance.
 An indirect map allows you to specify mappings for the subdirectories you wish
 to mount under the
 .Ar directory
-indicated on the command line. In an indirect map, each
+indicated on the command line.
+In an indirect map, each
 .Ar key
 consists of a simple name that refers to one or more file systems that are to be
 mounted as needed.
 .Ss Direct Maps
 Entries in a direct map are associated directly with
 .Nm autofs
-mount points. Each
+mount points.
+Each
 .Ar key
 is the full pathname of an
 .Nm autofs
-mount point. The direct map as a whole is not associated with any single
-directory.
+mount point.
+The direct map as a whole is not associated with any single directory.
 .Pp
 Direct maps are distinguished from indirect maps by the
 .Sy \-
-key. For example:
+key.
+For example:
 .Bd -literal -offset indent
 # Master map for automounter
 #
@@ -509,10 +534,12 @@ The
 .Sy -hosts
 map is used with the
 .Pa /net
-directory and assumes that the map key is the hostname of an NFS server. The
+directory and assumes that the map key is the hostname of an NFS server.
+The
 .Nm automountd
 daemon dynamically constructs a map entry from the server's list of exported
-file systems. References to a directory under
+file systems.
+References to a directory under
 .Pa /net/hermes
 will refer to the corresponding directory relative to
 .Sy hermes
@@ -520,26 +547,29 @@ root.
 .Pp
 The
 .Sy -null
-map cancels a previous map for the directory indicated. This is most useful in
-the
+map cancels a previous map for the directory indicated.
+This is most useful in the
 .Pa /etc/auto_master
 for cancelling entries that would otherwise be inherited from the
 .Sy +auto_master
-include entry. To be effective, the
+include entry.
+To be effective, the
 .Sy -null
 entries must be inserted before the included map entry.
 .Ss Executable Maps
 Local maps that have the execute bit set in their file permissions will be
 executed by the automounter and provided with a key to be looked up as an
-argument. The executable map is expected to return the content of an
-automounter map entry on its stdout or no output if the entry cannot be
-determined. A direct map cannot be made executable.
+argument.
+The executable map is expected to return the content of an automounter map entry
+on its stdout or no output if the entry cannot be determined.
+A direct map cannot be made executable.
 .Ss Configuration and the auto_master Map
 When initiated without arguments,
 .Nm
 consults the master map for a list of
 .Nm autofs
-mount points and their maps. It mounts any
+mount points and their maps.
+It mounts any
 .Nm autofs
 mounts that are not already mounted, and unmounts
 .Nm autofs
@@ -547,18 +577,21 @@ mounts that have been removed from the master map or direct map.
 .Pp
 The master map is assumed to be called
 .Sy auto_master
-and its location is determined by the name service switch policy. Normally the
-master map is located initially as a local file
+and its location is determined by the name service switch policy.
+Normally the master map is located initially as a local file
 .Pa /etc/auto_master .
 .Ss Browsing
 The
 .Nm automountd
-daemon supports browsability of indirect maps. This allows all of the potential
-mount points to be visible, whether or not they are mounted. The
+daemon supports browsability of indirect maps.
+This allows all of the potential mount points to be visible, whether or not they
+are mounted.
+The
 .Sy -nobrowse
 option can be added to any indirect
 .Nm autofs
-map to disable browsing. For example:
+map to disable browsing.
+For example:
 .Bd -literal -offset indent
 /net	-hosts		-nosuid,nobrowse
 /home	auto_home
@@ -574,21 +607,23 @@ The
 .Sy -browse
 option enables browsability of
 .Nm autofs
-file systems. This is the default for all indirect maps.
+file systems.
+This is the default for all indirect maps.
 .Pp
 The
 .Sy -browse
 option does not work in conjunction with the wildcard key.
 .Ss Restricting Mount Maps
 Options specified for a map are used as the default options for all the entries
-in that map. They are ignored when map entries specify their own mount options.
+in that map.
+They are ignored when map entries specify their own mount options.
 .Pp
 In some cases, however, it is desirable to force
 .Sy nosuid , nodevices , nosetuid ,
 or
 .Sy noexec
-for a complete mount map and its submounts. This can be done by specifying the
-additional mount option,
+for a complete mount map and its submounts.
+This can be done by specifying the additional mount option,
 .Sy -restrict .
 .Bd -literal -offset indent
 /home	auto_home	-restrict,nosuid,hard
@@ -600,13 +635,15 @@ option forces the inheritance of all the restrictive options
 .Sy nosuid , nodevices , nosetuid ,
 and
 .Sy noexec
-as well as the restrict option itself. In this particular example, the
+as well as the restrict option itself.
+In this particular example, the
 .Sy nosuid
 and
 .Sy restrict
 option are inherited but the
 .Sy hard
-option is not. The
+option is not.
+The
 .Sy restrict
 option also prevents the execution of
 .Qq executable maps
@@ -619,7 +656,8 @@ Master automount map.
 .It Pa /etc/auto_home
 Map to support automounted home directories.
 .It Pa /etc/nsswitch.conf
-Name service switch configuration file. See
+Name service switch configuration file.
+See
 .Xr nsswitch.conf 4 .
 .El
 .Sh EXIT STATUS
@@ -651,15 +689,16 @@ Since each direct map entry results in a new
 .Nm autofs
 mount such maps should be kept short.
 .Pp
-Entries in both direct and indirect maps can be modified at any time. The new
-information is used when
+Entries in both direct and indirect maps can be modified at any time.
+The new information is used when
 .Nm automountd
 next uses the map entry to do a mount.
 .Pp
 New entries added to a master map or direct map will not be useful until the
 automount command is run to install them as new
 .Nm autofs
-mount points. New entries added to an indirect map may be used immediately.
+mount points.
+New entries added to an indirect map may be used immediately.
 .Pp
 As of the Solaris 2.6 release, a listing
 .Po see
@@ -668,19 +707,22 @@ As of the Solaris 2.6 release, a listing
 of the
 .Nm autofs
 directory associated with an indirect map shows all potential mountable
-entries. The attributes associated with the potential mountable entries are
-temporary. The real file system attributes will only be shown once the file
-system has been mounted.
+entries.
+The attributes associated with the potential mountable entries are temporary.
+The real file system attributes will only be shown once the file system has been
+mounted.
 .Pp
 Default mount options can be assigned to an entire map when specified as an
-optional third field in the master map. These options apply only to map entries
-that have no mount options. Note that map entities with options override the
-default options, as at this time, the options do not concatenate. The
-concatenation feature is planned for a future release.
+optional third field in the master map.
+These options apply only to map entries that have no mount options.
+Note that map entities with options override the default options, as at this
+time, the options do not concatenate.
+The concatenation feature is planned for a future release.
 .Pp
 When operating on a map that invokes an NFS mount, the default number of
 retries for the automounter is 0, that is, a single mount attempt, with no
-retries. Note that this is significantly different from the default
+retries.
+Note that this is significantly different from the default
 .Pq 10000
 for the
 .Xr mount_nfs 1M