Skip to content
This repository has been archived by the owner on Nov 7, 2019. It is now read-only.

Commit

Permalink
8300 fix man page issues found by mandoc 1.14.1
Browse files Browse the repository at this point in the history
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Toomas Soome <tsoome@me.com>
Approved by: Gordon Ross <gwr@nexenta.com>
  • Loading branch information
Yuri Pankov authored and gwr committed Jun 7, 2017
1 parent cb4d790 commit 72d3dbb
Show file tree
Hide file tree
Showing 284 changed files with 6,817 additions and 5,103 deletions.
12 changes: 7 additions & 5 deletions usr/src/man/man1/apropos.1
Expand Up @@ -39,8 +39,9 @@ and
fail.
.Lp
Each word is considered
separately and the case of letters is ignored. Words which are part of other
words are considered; for example, when looking for
separately and the case of letters is ignored.
Words which are part of other words are considered; for example, when looking
for
.Sq compile ,
.Nm apropos
finds all instances of
Expand All @@ -49,8 +50,8 @@ also.
.Lp
The
.Nm whatis
command performs the same search, but only matches whole words. In the above
example,
command performs the same search, but only matches whole words.
In the above example,
.Nm whatis
would not match the instances of
.Sq compiler
Expand All @@ -70,7 +71,8 @@ command.
.Bl -tag -width "-s section"
.It Fl M Ar path
Force a specific colon separated manual path instead of the
default search path. Overrides the MANPATH environment variable.
default search path.
Overrides the MANPATH environment variable.
.It Fl s Ar section
Restrict search to specified section.
.El
Expand Down
3 changes: 2 additions & 1 deletion usr/src/man/man1/hostname.1
Expand Up @@ -17,7 +17,8 @@ The
.Nm
command prints the name of the current host, as given before the
.Xr login 1
prompt. The super-user can set the hostname by giving
prompt.
The super-user can set the hostname by giving
.Ar name-of-host .
.Sh OPTIONS
.Bl -tag -width Ds
Expand Down
22 changes: 11 additions & 11 deletions usr/src/man/man1/kvmstat.1
Expand Up @@ -31,15 +31,15 @@ injected interrupts, emulations, and more, on a per virtual CPU basis.
.Nm
should be used when trying to get a rough sense of guest activity from the
hypervisor's perspective, and allows one to understand from a low-level
perspective, what kind of activity is going on inside of the virtual machine. In
addition,
perspective, what kind of activity is going on inside of the virtual machine.
In addition,
.Nm
is useful for diagnosing reports of pathological or faulty behavior inside of
guests. While there is no expected range of values for the fields displayed as
that varies with the use of virtual machines, if all of the virtual CPUs for a
given virtual machine are consistently zero, then that may indicate that a
problem has occurred, for example, a panic inside of the guest or a bug in the
hypervisor.
guests.
While there is no expected range of values for the fields displayed as that
varies with the use of virtual machines, if all of the virtual CPUs for a given
virtual machine are consistently zero, then that may indicate that a problem has
occurred, for example, a panic inside of the guest or a bug in the hypervisor.
.Lp
If no operands are specified, then
.Nm
Expand Down Expand Up @@ -96,15 +96,15 @@ The following operands are supported:
.Bl -hang -width Ds
.It Ar count
.Bd -filled -compact
Specifies the number of times that the statistics are repeated. If not
specified,
Specifies the number of times that the statistics are repeated.
If not specified,
.Nm
will continue until it is terminated.
.Ed
.It Ar interval
.Bd -filled -compact
Specifies the number of seconds between reports of statistics. If not specified,
reports are generated every second.
Specifies the number of seconds between reports of statistics.
If not specified, reports are generated every second.
.Ed
.El
.Sh STABILITY
Expand Down
98 changes: 61 additions & 37 deletions usr/src/man/man1/man.1
Expand Up @@ -39,8 +39,8 @@
.Sh DESCRIPTION
The
.Nm
command displays information from the reference manuals. It
displays complete manual pages that you select by
command displays information from the reference manuals.
It displays complete manual pages that you select by
.Ar name ,
or one-line summaries selected either by
.Ar keyword
Expand All @@ -55,7 +55,8 @@ Reference Manual pages are marked up with either
.Xr man 5 ,
or
.Xr mdoc 5
language tags. The
language tags.
The
.Nm
command recognizes the type of markup and
processes the file accordingly.
Expand All @@ -65,8 +66,10 @@ processes the file accordingly.
The online Reference Manual page directories are conventionally located in
.Pa /usr/share/man .
Each directory corresponds to a
section of the manual. Since these directories are optionally installed, they
might not reside on your host. You might have to mount
section of the manual.
Since these directories are optionally installed, they might not reside on your
host.
You might have to mount
.Pa /usr/share/man
from a host on which they do reside.
The
Expand All @@ -92,23 +95,27 @@ Shows all manual pages matching
.Ar name
within the
.Ev MANPATH
search path. Manual pages are displayed in the order found.
search path.
Manual pages are displayed in the order found.
.It Fl d
Debugs. Displays what a section-specifier evaluates to, method used for
searching, and paths searched by
Debugs.
Displays what a section-specifier evaluates to, method used for searching, and
paths searched by
.Nm .
.It Fl f Ar file ...
Attempts to locate manual pages related to any of the given
.Ar file
names. It strips the leading path name components from each
names.
It strips the leading path name components from each
.Ar file ,
and then prints one-line summaries containing the resulting basename or names.
This option also uses the
.Pa whatis
database.
.It Fl F
This option is present for backwards compatibility and is documented
here for reference only. It performs no function.
here for reference only.
It performs no function.
.It Fl k Ar keyword ...
Prints out one-line summaries from the
.Pa whatis
Expand All @@ -124,10 +131,12 @@ Lists all manual pages found matching
.Ar name
within the search path.
.It Fl M Ar path
Specifies an alternate search path for manual pages. The
Specifies an alternate search path for manual pages.
The
.Ar path
is a colon-separated list of directories that contain manual page directory
subtrees. For example, if
subtrees.
For example, if
.Ar path
is
.Pa /usr/share/man:/usr/local/man ,
Expand All @@ -143,11 +152,13 @@ or
.Fl w
options, the
.Fl M
option must appear first. Each directory in the
option must appear first.
Each directory in the
.Ar path
is assumed to contain subdirectories of the form
.Pa man* ,
one for each section. This option overrides the
one for each section.
This option overrides the
.Ev MANPATH
environment variable.
.It Fl r
Expand All @@ -156,7 +167,8 @@ display it.
.It Fl s Ar section
Specifies sections of the manual for
.Nm
to search. The directories searched for
to search.
The directories searched for
.Ar name
are limited to those specified by
.Ar section .
Expand All @@ -172,12 +184,14 @@ can be a word, for example,
.Li old ,
.Li public .
.Ar section
can also be a letter. To specify multiple sections,
separate each section with a comma. This option overrides the
can also be a letter.
To specify multiple sections, separate each section with a comma.
This option overrides the
.Ev MANPATH
environment variable and the
.Pa man.cf
file. See
file.
See
.Sx Search Path
below for an explanation of how
.Nm
Expand All @@ -187,7 +201,8 @@ Arranges for the specified manual pages to be sent to the default
printer as PostScript.
.It Fl T Ar macro-package
This option is present for backwards compatibility and is documented
here for reference only. It performs no function.
here for reference only.
It performs no function.
.It Fl w
Updates the
.Nm whatis
Expand All @@ -210,8 +225,8 @@ Entries in the reference manuals are organized into
.Em sections .
A section
name consists of a major section name, typically a single digit, optionally
followed by a subsection name, typically one or more letters. An unadorned
major section name, for example,
followed by a subsection name, typically one or more letters.
An unadorned major section name, for example,
.Qq 9 ,
does not act as an abbreviation for
the subsections of that name, such as
Expand All @@ -223,7 +238,8 @@ That is, each subsection must be searched separately by
.Nm
.Fl s .
Each section contains descriptions apropos to a particular reference category,
with subsections refining these distinctions. See the
with subsections refining these distinctions.
See the
.Em intro
manual pages for an explanation of the classification used in this release.
.
Expand All @@ -248,13 +264,14 @@ environment variable, primarily by substituting
.Li man
for the last component of the
.Ev PATH
element. Special provisions are added
to account for unique characteristics of directories such as
element.
Special provisions are added to account for unique characteristics of
directories such as
.Pa /sbin ,
.Pa /usr/ucb ,
.Pa /usr/xpg4/bin ,
and others. If the file argument contains
a
and others.
If the file argument contains a
.Qq /
character, the
.Em dirname
Expand Down Expand Up @@ -299,7 +316,8 @@ file has the following format:
Lines beginning with
.Sq Li #
and blank lines are considered comments, and are
ignored. Each directory specified in
ignored.
Each directory specified in
.Ev MANPATH
can contain a manual page
configuration file, specifying the default search order for that directory.
Expand All @@ -310,9 +328,9 @@ page entry fitting the pattern:
.Dl \&.so man*/ Ns Em sourcefile
.Lp
.Nm
processes the indicated file in place of the current one. The
reference must be expressed as a path name relative to the root of the manual
page directory subtree.
processes the indicated file in place of the current one.
The reference must be expressed as a path name relative to the root of the
manual page directory subtree.
.Lp
When the second or any subsequent line starts with
.Sy \&.so ,
Expand All @@ -337,27 +355,32 @@ and
.Bl -tag -width MANWIDTH
.It Ev MANPATH
A colon-separated list of directories; each directory can be followed by a
comma-separated list of sections. If set, its value overrides
comma-separated list of sections.
If set, its value overrides
.Pa /usr/share/man
as the default directory search path, and the
.Pa man.cf
file as the default section search path. The
file as the default section search path.
The
.Fl M
and
.Fl s
flags, in turn, override these values.
.It Ev MANWIDTH
Width of the output. If set to the special value
Width of the output.
If set to the special value
.Qq Sy TTY
.Po or
.Qq Sy tty
.Pc ,
and output is to terminal, auto-detect terminal width.
.It Ev PAGER
A program to use for interactively delivering
output to the screen. If not set,
output to the screen.
If not set,
.Sq Nm more Fl s
is used. See
is used.
See
.Xr more 1 .
.El
.Sh FILES
Expand Down Expand Up @@ -419,5 +442,6 @@ created with the
option.
.Sh BUGS
The manual is supposed to be reproducible either on a phototypesetter or on an
ASCII terminal. However, on a terminal some information (indicated by
font changes, for instance) is lost.
ASCII terminal.
However, on a terminal some information (indicated by font changes, for
instance) is lost.
7 changes: 4 additions & 3 deletions usr/src/man/man1m/acpidump.1m
Expand Up @@ -29,8 +29,8 @@
The
.Nm
utility is used to dump the system's Advanced Configuration and Power Interface
(ACPI) tables that are provided by system firmware. The dumped tables can be
used by other utilities, such as
(ACPI) tables that are provided by system firmware.
The dumped tables can be used by other utilities, such as
.Xr acpixtract 1M
or
.Sy iasl .
Expand All @@ -42,7 +42,8 @@ Get the table at the given physical address.
.It Fl b
Dump all tables to binary files.
.It Fl c Ar on|off
Enable dumping customized tables. The default is off.
Enable dumping customized tables.
The default is off.
.It Fl f Ar file
Read the table from the given binary file.
.It Fl h
Expand Down
13 changes: 8 additions & 5 deletions usr/src/man/man1m/acpixtract.1m
Expand Up @@ -25,19 +25,22 @@
The
.Nm
utility extracts the binary data from a dump of the system's Advanced
Configuration and Power Interface (ACPI) tables. The dump is usually obtained
via the
Configuration and Power Interface (ACPI) tables.
The dump is usually obtained via the
.Xr acpidump 1M
command. The resulting binary file(s) are represented in the ACPI
command.
The resulting binary file(s) are represented in the ACPI
.Sy ASL
assembly language. For each table extracted, a corresponding
assembly language.
For each table extracted, a corresponding
.Em table.dat
file will be created.
.Sh OPTIONS
The following options are supported:
.Bl -tag -width Ds
.It Fl a
Extract all of the tables found. By default only the
Extract all of the tables found.
By default only the
.Sy DSDT
and
.Sy SSDT
Expand Down

0 comments on commit 72d3dbb

Please sign in to comment.