7050 Prefer 'subcommand' over 'sub-command' in the manual pages

Reviewed by: Robert Mustacchi <rm@joyent.com>
Approved by: Dan McDonald <danmcd@omniti.com>

11 files changed, 20 insertions, 64 deletions

diff --git a/usr/src/man/man1/elfsign.1 b/usr/src/man/man1/elfsign.1
index 4ff1ba68f9..993909053d 100644
--- a/usr/src/man/man1/elfsign.1
+++ b/usr/src/man/man1/elfsign.1
@@ -43,7 +43,6 @@ elfsign \- sign binaries
 .fi
 
 .SH DESCRIPTION
-.sp
 .ne 2
 .na
 \fB\fBlist\fR\fR
@@ -94,7 +93,6 @@ an appropriate certificate in \fB/etc/crypto/certs\fR if \fB-c\fR is not given.
 .RE
 
 .SH OPTIONS
-.sp
 .LP
 The following options are supported:
 .sp
@@ -291,7 +289,6 @@ is not stable parseable output.
 .RE
 
 .SH OPERANDS
-.sp
 .LP
 The following operand is supported:
 .sp
@@ -381,7 +378,6 @@ CN=VENDOR, OU=Software Development, O=Vendor Inc.
 .sp
 
 .SH EXIT STATUS
-.sp
 .LP
 The following exit values are returned:
 .sp
@@ -390,7 +386,7 @@ The following exit values are returned:
 .TS
 c c c
 l l l .
-VALUE	MEANING	SUB-COMMAND
+VALUE	MEANING	SUBCOMMAND
 \fB0\fR	Operation successful	sign/verify/request
 \fB1\fR	Invalid arguments	
 \fB2\fR	Failed to verify ELF object 	verify
@@ -406,7 +402,6 @@ T}	verify
 .TE
 
 .SH FILES
-.sp
 .ne 2
 .na
 \fB\fB/etc/crypto/certs\fR\fR
@@ -417,7 +412,6 @@ used
 .RE
 
 .SH ATTRIBUTES
-.sp
 .LP
 See \fBattributes\fR(5) for descriptions of the following attributes:
 .sp
@@ -438,7 +432,6 @@ The \fBelfsign\fR command and subcommands are Committed. While applications
 should not depend on the output format of \fBelfsign\fR, the output format of
 the \fBlist\fR subcommand is Committed.
 .SH SEE ALSO
-.sp
 .LP
 \fBdate\fR(1), \fBpktool\fR(1), \fBcryptoadm\fR(1M), \fBlibpkcs11\fR(3LIB),
 \fBattributes\fR(5)
diff --git a/usr/src/man/man1m/flowadm.1m b/usr/src/man/man1m/flowadm.1m
index fdc8151b41..605833c0ef 100644
--- a/usr/src/man/man1m/flowadm.1m
+++ b/usr/src/man/man1m/flowadm.1m
@@ -70,8 +70,7 @@ traffic for more observable and deterministic behavior.
 .LP
 \fBflowadm\fR is implemented as a set of subcommands with corresponding
 options. Options are described in the context of each subcommand.
-.SH SUB-COMMANDS
-.sp
+.SH SUBCOMMANDS
 .LP
 The following subcommands are supported:
 .sp
diff --git a/usr/src/man/man1m/itadm.1m b/usr/src/man/man1m/itadm.1m
index bd815625b7..f57fe25f24 100644
--- a/usr/src/man/man1m/itadm.1m
+++ b/usr/src/man/man1m/itadm.1m
@@ -163,7 +163,7 @@ example specifications.
 .in -2
 .sp
 
-.SH SUB-COMMANDS
+.SH SUBCOMMANDS
 .LP
 The following are the \fBitadm\fR subcommands with their options.
 .SS "\fBitadm create-target\fR"
diff --git a/usr/src/man/man1m/ndmpadm.1m b/usr/src/man/man1m/ndmpadm.1m
index 680c9fdd23..04c3947f4d 100644
--- a/usr/src/man/man1m/ndmpadm.1m
+++ b/usr/src/man/man1m/ndmpadm.1m
@@ -107,7 +107,7 @@ The following option is supported:
 Display a list of all subcommands and options.
 .RE
 
-.SH SUB-COMMANDS
+.SH SUBCOMMANDS
 .LP
 The \fBndmpadm\fR command supports the subcommands described below.
 .SS "\fBdisable\fR Subcommand"
diff --git a/usr/src/man/man1m/route.1m b/usr/src/man/man1m/route.1m
index 9e03c507af..60cbf3f1ae 100644
--- a/usr/src/man/man1m/route.1m
+++ b/usr/src/man/man1m/route.1m
@@ -40,7 +40,6 @@ route \- manually manipulate the routing tables
 .fi
 
 .SH DESCRIPTION
-.sp
 .LP
 \fBroute\fR manually manipulates the network routing tables. These tables are
 normally maintained by the system routing daemon, such as \fBin.routed\fR(1M)
@@ -57,15 +56,14 @@ of the programmatic interface discussed in \fBroute\fR(7P).
 can modify routing tables, the \fBRTM_GET\fR operation is allowed for
 non-privileged users.
 .SH OPTIONS
-.sp
 .ne 2
 .na
 \fB\fB-f\fR\fR
 .ad
 .RS 15n
 Flush the routing tables of all gateway entries. If you use the \fB-f\fR option
-in conjunction with any of the \fBroute\fR sub-commands, \fBroute\fR flushes
-the gateways before performing the sub-command. Specify the table to flush by
+in conjunction with any of the \fBroute\fR subcommands, \fBroute\fR flushes
+the gateways before performing the subcommand. Specify the table to flush by
 placing the \fBinet\fR or \fBinet6\fR modifier immediately after the \fB-f\fR
 option. If unspecified, flushing IPv4 (\fBinet\fR) routes is the default.
 .RE
@@ -131,7 +129,6 @@ Print additional details in verbose mode.
 .RE
 
 .SS "Subcommands"
-.sp
 .LP
 The following subcommands are supported:
 .sp
@@ -201,7 +198,7 @@ conjunction with the \fB-p\fR option.
 
 .sp
 .LP
-The \fBadd\fR and \fBdelete\fR sub-commands have the following syntax:
+The \fBadd\fR and \fBdelete\fR subcommands have the following syntax:
 .sp
 .in +2
 .nf
@@ -218,7 +215,7 @@ through which packets should be routed. Modifiers described in \fBOPERANDS\fR
 can be placed anywhere on the command line.
 .sp
 .LP
-The \fBget\fR and \fBchange\fR sub-commands have the following syntax:
+The \fBget\fR and \fBchange\fR subcommands have the following syntax:
 .sp
 .in +2
 .nf
@@ -235,7 +232,7 @@ through which packets should be routed. Modifiers described in \fBOPERANDS\fR
 can be placed anywhere on the command line.
 .sp
 .LP
-The \fBmonitor\fR sub-command has the following syntax:
+The \fBmonitor\fR subcommand has the following syntax:
 .sp
 .in +2
 .nf
@@ -245,12 +242,10 @@ route monitor [ -inet | -inet6 ]
 .sp
 
 .SH OPERANDS
-.sp
 .LP
-\fBroute\fR executes its sub-commands on routes to destinations by way of
+\fBroute\fR executes its subcommands on routes to destinations by way of
 gateways.
 .SS "Destinations and Gateways"
-.sp
 .LP
 By default, destination and gateway addresses are interpreted as IPv4
 addresses. All symbolic names are tried first as a host name, using
@@ -259,7 +254,7 @@ addresses. All symbolic names are tried first as a host name, using
 .sp
 .LP
 Including an optional modifier on the command line before the address changes
-how the \fBroute\fR sub-command interprets it.
+how the \fBroute\fR subcommand interprets it.
 .sp
 .LP
 The following modifiers are supported:
@@ -448,7 +443,6 @@ multipathing) group, then requests to add a route will automatically be
 translated to the corresponding IPMP IP interface, and requests to delete or
 change a route on an underlying interface will fail.
 .SS "Routing Flags"
-.sp
 .LP
 Routes have associated flags that influence operation of the protocols when
 sending to destinations matched by the routes. These flags can be set (and in
@@ -603,7 +597,6 @@ sensitivity label.
 .RE
 
 .SS "Compatibility"
-.sp
 .LP
 The modifiers \fBhost\fR and \fBnet\fR are taken to be equivalent to
 \fB-\fR\fBhost\fR and \fB-net\fR\fB\fR. To specify a symbolic address that
@@ -630,7 +623,6 @@ _
 The \fB\fR\fB-ifa\fR \fBhostname\fR modifier is also accepted, but has no
 effect.
 .SH FILES
-.sp
 .ne 2
 .na
 \fB\fB/etc/defaultrouter\fR\fR
@@ -658,7 +650,6 @@ List of network names and addresses
 .RE
 
 .SH SEE ALSO
-.sp
 .LP
 \fBuname\fR(1), \fBin.ripngd\fR(1M), \fBin.routed\fR(1M), \fBnetstat\fR(1M),
 \fBrouted\fR(1M), \fBioctl\fR(2), \fBgetipnodebyname\fR(3SOCKET),
@@ -666,7 +657,6 @@ List of network names and addresses
 \fBhosts\fR(4), \fBnetworks\fR(4), \fBattributes\fR(5), \fBARP\fR(7P),
 \fBip\fR(7P), \fBroute\fR(7P), \fBrouting\fR(7P)
 .SH DIAGNOSTICS
-.sp
 .ne 2
 .na
 \fB\fBadd\fR [ \fBhost\fR\||\ \fBnetwork\|]\fR \fIdestination\fR:\fIgateway\fR
@@ -704,7 +694,7 @@ As \fBadd\fR, but when deleting or changing an entry.
 .ad
 .sp .6
 .RS 4n
-When the \fB-f\fR flag is specified, or the \fBflush\fR sub-command is used,
+When the \fB-f\fR flag is specified, or the \fBflush\fR subcommand is used,
 each routing table entry deleted is indicated with a message of this form.
 .RE
 
@@ -763,7 +753,6 @@ process does not have appropriate privileges.
 .RE
 
 .SH NOTES
-.sp
 .LP
 Specifying that destinations are local (with the \fB-interface\fRmodifier)
 assumes that the routers implement \fBproxy ARP\fR, meaning that they respond
diff --git a/usr/src/man/man1m/sasinfo.1m b/usr/src/man/man1m/sasinfo.1m
index 7bbec47a15..3098e2b84d 100644
--- a/usr/src/man/man1m/sasinfo.1m
+++ b/usr/src/man/man1m/sasinfo.1m
@@ -43,7 +43,6 @@ sasinfo \- Serial Attached SCSI HBA port command line interface
 .fi
 
 .SH DESCRIPTION
-.sp
 .LP
 The \fBsasinfo\fR utility is a command line interface that collects
 administrative information on Serial Attached SCSI-2 (SAS-2) host bus adapter
@@ -53,8 +52,7 @@ that might be connected to those HBA ports.
 .sp
 .LP
 \fBsasinfo\fR is implemented as a set of subcommands, described below.
-.SH SUB-COMMANDS
-.sp
+.SH SUBCOMMANDS
 .LP
 The following subcommands are supported by \fBsasinfo\fR.
 .sp
@@ -120,7 +118,6 @@ including the SAS Management Protocol (SMP) target port.
 .RE
 
 .SH OPTIONS
-.sp
 .LP
 The following options are supported.
 .sp
@@ -717,7 +714,6 @@ OS Device Name: /dev/rdsk/c4t50020F230000B4AFd0s2
 .sp
 
 .SH ATTRIBUTES
-.sp
 .LP
 See \fBattributes\fR(5) for descriptions of the following attributes:
 .sp
@@ -733,6 +729,5 @@ Interface Stability	Committed
 .TE
 
 .SH SEE ALSO
-.sp
 .LP
 \fBattributes\fR(5)
diff --git a/usr/src/man/man1m/sbdadm.1m b/usr/src/man/man1m/sbdadm.1m
index 6efdfa6abb..5445dff56f 100644
--- a/usr/src/man/man1m/sbdadm.1m
+++ b/usr/src/man/man1m/sbdadm.1m
@@ -33,12 +33,10 @@ sbdadm \- SCSI Block Disk command line interface
 .fi
 
 .SH DESCRIPTION
-.sp
 .LP
 The \fBsbdadm\fR command creates and manages SCSI-block-device-based logical
 units that are registered with the SCSI Target Mode Framework (STMF).
-.SH SUB-COMMANDS
-.sp
+.SH SUBCOMMANDS
 .LP
 The \fBsbdadm\fR command supports the subcommands listed below. Note that if
 you enter a question mark as an argument to the command (\fBsbdadm ?\fR),
@@ -169,7 +167,6 @@ The size specified can exceed the size of the file or device represented by
 .RE
 
 .SH OPERANDS
-.sp
 .LP
 \fBsbdadm\fR use the following operands:
 .sp
@@ -230,7 +227,6 @@ Found 2 LU(s)
 .sp
 
 .SH EXIT STATUS
-.sp
 .ne 2
 .na
 \fB\fB0\fR\fR
@@ -251,7 +247,6 @@ An error occurred.
 .RE
 
 .SH ATTRIBUTES
-.sp
 .LP
 See \fBattributes\fR(5) for descriptions of the following attributes:
 .sp
@@ -267,6 +262,5 @@ Interface Stability	Obsolete Committed
 .TE
 
 .SH SEE ALSO
-.sp
 .LP
 \fBstmfadm\fR(1M), \fBattributes\fR(5)
diff --git a/usr/src/man/man1m/smbadm.1m b/usr/src/man/man1m/smbadm.1m
index 257e24e537..9fada6fca3 100644
--- a/usr/src/man/man1m/smbadm.1m
+++ b/usr/src/man/man1m/smbadm.1m
@@ -201,7 +201,7 @@ Specifies the name of the \fBCIFS\fR local group.
 Specifies the name of a Solaris local user.
 .RE
 
-.SH SUB-COMMANDS
+.SH SUBCOMMANDS
 .LP
 The \fBsmbadm\fR command includes these subcommands:
 .sp
@@ -408,7 +408,7 @@ Selected domain controller
 .sp .6
 .RS 4n
 Lookup the SID for the given \fIaccount-name\fR, or lookup the
-\fIaccount-name\fR for the given SID.  This sub-command is
+\fIaccount-name\fR for the given SID.  This subcommand is
 primarily for diagnostic use, to confirm whether the server
 can lookup domain accounts and/or SIDs.
 .RE
diff --git a/usr/src/man/man1m/smtnrhdb.1m b/usr/src/man/man1m/smtnrhdb.1m
index 2f8c5dd3f0..74734855e3 100644
--- a/usr/src/man/man1m/smtnrhdb.1m
+++ b/usr/src/man/man1m/smtnrhdb.1m
@@ -13,7 +13,6 @@ smtnrhdb \- manage entries in the tnrhdb database
 .fi
 
 .SH DESCRIPTION
-.sp
 .LP
 The \fBsmtnrhdb\fR command adds, modifies, deletes, and lists entries in the
 \fBtnrhdb\fR database.
@@ -30,7 +29,6 @@ initialized for the command to succeed (see \fBsmc\fR(1M)). After rebooting the
 Solaris Management Console server, the first \fBsmc\fR connection can time out,
 so you might need to retry the command.
 .SS "Valid Host Addresses and Wildcards"
-.sp
 .LP
 The trusted network software uses a network "longest prefix of matching bits"
 mechanism when looking for a host. The software looks first for the IP address
@@ -56,8 +54,7 @@ addresses, see \fISystem Administration Guide: IP Services\fR.
 The \fBsmtnrhdb\fR command accepts a hostname, IP address, and wildcard address
 with as optional prefix as valid addresses. See \fIsubcommand_args\fR, below,
 for the format of valid addresses.
-.SH SUB-COMMANDS
-.sp
+.SH SUBCOMMANDS
 .LP
 \fBsmtnrhdb\fR \fIsubcommand\fRs are:
 .sp
@@ -109,7 +106,6 @@ administrator must have the \fBsolaris.network.host.write\fR and
 .RE
 
 .SH OPTIONS
-.sp
 .LP
 The \fBsmtnrhdb\fR authentication arguments, \fIauth_args\fR, are derived from
 the \fBsmc\fR arg set. These arguments are the same regardless of which
@@ -119,7 +115,6 @@ subcommand you use.
 The subcommand-specific options, \fIsubcommand_args\fR, must be preceded by the
 \fB--\fR option.
 .SS "\fIauth_args\fR"
-.sp
 .LP
 The valid \fIauth_args\fR are \fB-D\fR, \fB-H\fR, \fB-l\fR, \fB-p\fR, \fB-r\fR,
 and \fB-u\fR; they are all optional. If no \fIauth_args\fR are specified,
@@ -219,7 +214,6 @@ not enter the preceding options, you must still enter the \fB--\fR option.
 .RE
 
 .SS "\fIsubcommand_args\fR"
-.sp
 .LP
 \fBNote:\fR Descriptions and other arg options that contain white spaces must
 be enclosed in double quotes.
@@ -450,7 +444,6 @@ from machine1.ExampleCo.COM was successful.
 .sp
 
 .SH EXIT STATUS
-.sp
 .LP
 The following exit values are returned:
 .sp
@@ -484,7 +477,6 @@ An error occurred while executing the command. An error message displays.
 .RE
 
 .SH FILES
-.sp
 .LP
 The following files are used by the \fBsmtnrhdb\fR command:
 .sp
@@ -498,7 +490,6 @@ Trusted network remote-host database.
 .RE
 
 .SH ATTRIBUTES
-.sp
 .LP
 See \fBattributes\fR(5) for descriptions of the following attributes:
 .sp
@@ -514,14 +505,12 @@ Interface Stability	Committed
 .TE
 
 .SH SEE ALSO
-.sp
 .LP
 \fBsmc\fR(1M), \fBnetmasks\fR(4), \fBattributes\fR(5)
 .sp
 .LP
 \fISystem Administration Guide: Security Services\fR
 .SH NOTES
-.sp
 .LP
 The functionality described on this manual page is available only if the system
 is configured with Trusted Extensions.
diff --git a/usr/src/man/man1m/tpmadm.1m b/usr/src/man/man1m/tpmadm.1m
index 8f52ef0f9b..c60b356165 100644
--- a/usr/src/man/man1m/tpmadm.1m
+++ b/usr/src/man/man1m/tpmadm.1m
@@ -38,7 +38,6 @@ tpmadm \- administer Trusted Platform Module
 .fi
 
 .SH DESCRIPTION
-.sp
 .LP
 A Trusted Platform Module (TPM) is a hardware component that provides for
 protected key storage and reliable measurements of software used to boot the
@@ -69,8 +68,7 @@ regardless of the privilege level of the calling process. Second, the TPM owner
 is not able to override access controls for data protected by TPM keys. The
 owner can effectively destroy data by re-initializing the TPM, but he cannot
 access data that has been encrypted using TPM keys owned by other users.
-.SH SUB-COMMANDS
-.sp
+.SH SUBCOMMANDS
 .LP
 The following subcommands are used in the form:
 .sp
@@ -170,7 +168,6 @@ storage.
 .RE
 
 .SH EXIT STATUS
-.sp
 .LP
 After completing the requested operation, \fBtpmadm\fR exits with one of the
 following status values.
@@ -205,7 +202,6 @@ Usage error. The \fBtpmadm\fR command was invoked with invalid arguments.
 .RE
 
 .SH ATTRIBUTES
-.sp
 .LP
 See \fBattributes\fR(5) for descriptions of the following attributes:
 .sp
@@ -221,7 +217,6 @@ Interface Stability	Committed
 .TE
 
 .SH SEE ALSO
-.sp
 .LP
 \fBattributes\fR(5)
 .sp
diff --git a/usr/src/tools/onbld/Checks/SpellCheck.py b/usr/src/tools/onbld/Checks/SpellCheck.py
index da4ab55cdb..13ab16c7c2 100644
--- a/usr/src/tools/onbld/Checks/SpellCheck.py
+++ b/usr/src/tools/onbld/Checks/SpellCheck.py
@@ -242,6 +242,8 @@ misspellings = {
 }
 
 alternates = {
+	'sub-command': 'subcommand',
+	'sub-commands': 'subcommands',
 	'writeable': 'writable'
 }