summaryrefslogtreecommitdiff
path: root/usr/src/man
diff options
context:
space:
mode:
authorYuri Pankov <yuri.pankov@nexenta.com>2017-07-29 16:02:29 +0300
committerRichard Lowe <richlowe@richlowe.net>2017-08-11 19:00:16 -0400
commitc66b8046543352459a11a51501b628d1c98a8c44 (patch)
tree1121a5f9a15592e29af27c5f55a10ec607cf88d6 /usr/src/man
parent12014b724f98604d61f9756b7e199416475d7396 (diff)
downloadillumos-joyent-c66b8046543352459a11a51501b628d1c98a8c44.tar.gz
8547 update mandoc to 1.14.3
Reviewed by: Robert Mustacchi <rm@joyent.com> Approved by: Richard Lowe <richlowe@richlowe.net>
Diffstat (limited to 'usr/src/man')
-rw-r--r--usr/src/man/Makefile.man4
-rw-r--r--usr/src/man/man1/apropos.17
-rw-r--r--usr/src/man/man1/mandoc.1664
-rw-r--r--usr/src/man/man1m/automount.1m53
-rw-r--r--usr/src/man/man1m/ipadm.1m88
-rw-r--r--usr/src/man/man1m/lofiadm.1m8
-rw-r--r--usr/src/man/man1m/mount_nfs.1m10
-rw-r--r--usr/src/man/man1m/share_nfs.1m14
-rw-r--r--usr/src/man/man1m/stmfadm.1m42
-rw-r--r--usr/src/man/man1m/zdb.1m10
-rw-r--r--usr/src/man/man1m/zfs.1m22
-rw-r--r--usr/src/man/man1m/zpool.1m4
-rw-r--r--usr/src/man/man3c/thrd_detach.3c2
-rw-r--r--usr/src/man/man3lib/libpkcs11.3lib4
-rw-r--r--usr/src/man/man3proc/Lgrab_error.3proc2
-rw-r--r--usr/src/man/man3proc/Pgetareg.3proc2
-rw-r--r--usr/src/man/man3proc/Pgrab_file.3proc1
-rw-r--r--usr/src/man/man3proc/Plwp_getspymaster.3proc6
-rw-r--r--usr/src/man/man3proc/Psysentry.3proc2
-rw-r--r--usr/src/man/man5/beastie.4th.56
-rw-r--r--usr/src/man/man5/eqn.56
-rw-r--r--usr/src/man/man5/loader.52
-rw-r--r--usr/src/man/man5/mandoc_char.537
-rw-r--r--usr/src/man/man5/mandoc_roff.5978
-rw-r--r--usr/src/man/man5/mdoc.552
-rw-r--r--usr/src/man/man5/regex.512
-rw-r--r--usr/src/man/man5/tbl.5443
-rw-r--r--usr/src/man/man7d/usba.7d96
-rw-r--r--usr/src/man/man9e/mc_propinfo.9e3
-rw-r--r--usr/src/man/man9f/mac_alloc.9f2
-rw-r--r--usr/src/man/man9f/mac_init_ops.9f6
-rw-r--r--usr/src/man/man9s/mac_callbacks.9s1
32 files changed, 1441 insertions, 1148 deletions
diff --git a/usr/src/man/Makefile.man b/usr/src/man/Makefile.man
index 3f465b98c1..a251d143e4 100644
--- a/usr/src/man/Makefile.man
+++ b/usr/src/man/Makefile.man
@@ -11,7 +11,7 @@
#
# Copyright 2011, Richard Lowe
-# Copyright 2014 Nexenta Systems, Inc. All rights reserved.
+# Copyright 2017 Nexenta Systems, Inc.
#
MANDOC= $(ONBLD_TOOLS)/bin/${MACH}/mandoc
@@ -46,7 +46,7 @@ $(ROOTMAN)/man$(MANSECT)/% : % $(ROOTMAN)/man$(MANSECT)
$(MANCHECKS):
@$(EGREP) -q "^.TH" $(@:%.check=%) || \
( $(ECHO) "checking $(@:%.check=%)"; \
- $(MANDOC) -Tlint $(@:%.check=%) )
+ $(MANDOC) -Tlint -Wwarning $(@:%.check=%) )
$(MANLINKS):
$(RM) $@; $(SYMLINK) $(LINKSRC) $@
diff --git a/usr/src/man/man1/apropos.1 b/usr/src/man/man1/apropos.1
index 56b160626e..8edb11ba22 100644
--- a/usr/src/man/man1/apropos.1
+++ b/usr/src/man/man1/apropos.1
@@ -95,13 +95,14 @@ Try
.Dl example% apropos password
.Lp
If the line starts
-.So Ar filename Ns Po Ar section Pc .\|.\|. Sc
+.So Ar filename Ns Po Ar section Pc ... Sc
you can run
.Lp
.Dl % Nm man Fl s Ar section Ar filename
.Lp
-to display the man page for \fIfilename\fR.
-.Ss Example 2 To find the man page for the subroutine \fBprintf()
+to display the man page for
+.Ar filename .
+.Ss Example 2 To find the man page for the subroutine printf()
Try
.Lp
.Dl example% Nm apropos Li format
diff --git a/usr/src/man/man1/mandoc.1 b/usr/src/man/man1/mandoc.1
index 1cddf8ac75..ac2a1da5f4 100644
--- a/usr/src/man/man1/mandoc.1
+++ b/usr/src/man/man1/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.174 2017/02/10 15:45:28 schwarze Exp $
+.\" $Id: mandoc.1,v 1.217 2017/07/20 15:26:41 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,19 +15,19 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: February 10 2017 $
+.Dd $Mdocdate: July 20 2017 $
.Dt MANDOC 1
.Os
.Sh NAME
.Nm mandoc
-.Nd format and display UNIX manuals
+.Nd format manual pages
.Sh SYNOPSIS
.Nm mandoc
-.Op Fl acfhkl
+.Op Fl ac
.Op Fl I Cm os Ns = Ns Ar name
.Op Fl K Ar encoding
-.Op Fl m Ns Ar format
-.Op Fl O Ar option
+.Op Fl mdoc | man
+.Op Fl O Ar options
.Op Fl T Ar output
.Op Fl W Ar level
.Op Ar
@@ -44,9 +44,7 @@ reads
.Xr mdoc 5
or
.Xr man 5
-text from stdin, implying
-.Fl m Ns Cm andoc ,
-and produces
+text from stdin and produces
.Fl T Cm locale
output.
.Pp
@@ -67,27 +65,15 @@ to paginate them.
This is the default.
It can be specified to override
.Fl a .
-.It Fl f
-A synonym for
-.Xr whatis 1 .
-This overrides any earlier
-.Fl k
-and
-.Fl l
-options.
-.It Fl h
-Display only the SYNOPSIS lines.
-Implies
-.Fl c .
.It Fl I Cm os Ns = Ns Ar name
Override the default operating system
.Ar name
for the
.Xr mdoc 5
-.Sq \&Os
+.Ic \&Os
and for the
.Xr man 5
-.Sq \&TH
+.Ic \&TH
macro.
.It Fl K Ar encoding
Specify the input encoding.
@@ -98,33 +84,53 @@ arguments are
.Cm iso-8859-1 ,
and
.Cm utf-8 .
-If not specified, autodetection uses the first match:
-.Bl -tag -width iso-8859-1
-.It Cm utf-8
-if the first three bytes of the input file
-are the UTF-8 byte order mark (BOM, 0xefbbbf)
-.It Ar encoding
-if the first or second line of the input file matches the
+If not specified, autodetection uses the first match in the following
+list:
+.Bl -enum
+.It
+If the first three bytes of the input file are the UTF-8 byte order
+mark (BOM, 0xefbbbf), input is interpreted as
+.Cm utf-8 .
+.It
+If the first or second line of the input file matches the
.Sy emacs
mode line format
.Pp
.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
-.It Cm utf-8
-if the first non-ASCII byte in the file introduces a valid UTF-8 sequence
-.It Cm iso-8859-1
-otherwise
+.Pp
+then input is interpreted according to
+.Ar encoding .
+.It
+If the first non-ASCII byte in the file introduces a valid UTF-8
+sequence, input is interpreted as
+.Cm utf-8 .
+.It
+Otherwise, input is interpreted as
+.Cm iso-8859-1 .
.El
-.It Fl l
-A synonym for
-.Fl a .
-.It Fl m Ns Ar format
-Input format.
-See
-.Sx Input Formats
-for available formats.
-Defaults to
-.Fl m Ns Cm andoc .
-.It Fl O Ar option
+.It Fl mdoc | man
+With
+.Fl mdoc ,
+all input files are interpreted as
+.Xr mdoc 5 .
+With
+.Fl man ,
+all input files are interpreted as
+.Xr man 5 .
+By default, the input language is automatically detected for each file:
+if the the first macro is
+.Ic \&Dd
+or
+.Ic \&Dt ,
+the
+.Xr mdoc 5
+parser is used; otherwise, the
+.Xr man 5
+parser is used.
+With other arguments,
+.Fl m
+is silently ignored.
+.It Fl O Ar options
Comma-separated output options.
.It Fl T Ar output
Output format.
@@ -140,13 +146,33 @@ to be reported on the standard error output and to affect the exit status.
The
.Ar level
can be
+.Cm base ,
+.Cm style ,
.Cm warning ,
.Cm error ,
or
-.Cm unsupp ;
+.Cm unsupp .
+The
+.Cm base
+level automatically derives the operating system from the contents of the
+.Ic \&Os
+macro, from the
+.Fl Ios
+command line option, or from the
+.Xr uname 2
+return value.
+The levels
+.Cm openbsd
+and
+.Cm netbsd
+are variants of
+.Cm base
+that bypass autodetection and request validation of base system
+conventions for a particular operating system.
+The level
.Cm all
is an alias for
-.Cm warning .
+.Cm base .
By default,
.Nm
is silent.
@@ -176,56 +202,13 @@ If multiple files are specified,
.Nm
will halt with the first failed parse.
.El
-.Ss Input Formats
-The
-.Nm
-utility accepts
-.Xr mdoc 5
-and
-.Xr man 5
-input with
-.Fl m Ns Cm doc
-and
-.Fl m Ns Cm an ,
-respectively.
-The
-.Xr mdoc 5
-format is
-.Em strongly
-recommended;
-.Xr man 5
-should only be used for legacy manuals.
-.Pp
-A third option,
-.Fl m Ns Cm andoc ,
-which is also the default, determines encoding on-the-fly: if the first
-non-comment macro is
-.Sq \&Dd
-or
-.Sq \&Dt ,
-the
-.Xr mdoc 5
-parser is used; otherwise, the
-.Xr man 5
-parser is used.
-.Pp
-If multiple
-files are specified with
-.Fl m Ns Cm andoc ,
-each has its file-type determined this way.
-If multiple files are
-specified and
-.Fl m Ns Cm doc
-or
-.Fl m Ns Cm an
-is specified, then this format is used exclusively.
.Ss Output Formats
The
.Nm
utility accepts the following
.Fl T
arguments, which correspond to output modes:
-.Bl -tag -width "-T locale"
+.Bl -tag -width "-T markdown"
.It Fl T Cm ascii
Produce 7-bit ASCII output.
See
@@ -237,7 +220,9 @@ See
.It Fl T Ns Cm lint
Parse only: produce no output.
Implies
-.Fl W Cm warning .
+.Fl W Cm all
+and redirects parser messages, which usually appear
+on standard error output, to standard output.
.It Fl T Cm locale
Encode output using the current locale.
This is the default.
@@ -249,6 +234,12 @@ Produce
format output.
See
.Sx Man Output .
+.It Fl T Cm markdown
+Produce output in
+.Sy markdown
+format.
+See
+.Sx Markdown Output .
.It Fl T Cm pdf
Produce PDF output.
See
@@ -263,9 +254,6 @@ Produce an indented parse tree.
Encode output in the UTF\-8 multi-byte format.
See
.Sx UTF\-8 Output .
-.It Fl T Cm xhtml
-This is a synonym for
-.Fl T Cm html .
.El
.Pp
If multiple input files are specified, these will be processed by the
@@ -309,8 +297,7 @@ Increasing this is not recommended; it may result in degraded formatting,
for example overfull lines or ugly line breaks.
.It Cm width Ns = Ns Ar width
The output width is set to
-.Ar width ,
-which will normalise to \(>=58.
+.Ar width .
.El
.Ss HTML Output
Output produced by
@@ -350,7 +337,7 @@ The string
for example,
.Ar ../src/%I.html ,
is used as a template for linked header files (usually via the
-.Sq \&In
+.Ic \&In
macro).
Instances of
.Sq \&%I
@@ -363,7 +350,7 @@ The string
for example,
.Ar ../html%S/%N.%S.html ,
is used as a template for linked manuals (usually via the
-.Sq \&Xr
+.Ic \&Xr
macro).
Instances of
.Sq \&%N
@@ -401,13 +388,47 @@ If the input format is
.Xr man 5 ,
the input is copied to the output, expanding any
.Xr mandoc_roff 5
-.Sq so
+.Ic so
requests.
The parser is also run, and as usual, the
.Fl W
level controls which
.Sx DIAGNOSTICS
are displayed before copying the input to the output.
+.Ss Markdown Output
+Translate
+.Xr mdoc 5
+input to the
+.Sy markdown
+format conforming to
+.Lk http://daringfireball.net/projects/markdown/syntax.text\
+ "John Gruber's 2004 specification" .
+The output also almost conforms to the
+.Lk http://commonmark.org/ CommonMark
+specification.
+.Pp
+The character set used for the markdown output is ASCII.
+Non-ASCII characters are encoded as HTML entities.
+Since that is not possible in literal font contexts, because these
+are rendered as code spans and code blocks in the markdown output,
+non-ASCII characters are transliterated to ASCII approximations in
+these contexts.
+.Pp
+Markdown is a very weak markup language, so all semantic markup is
+lost, and even part of the presentational markup may be lost.
+Do not use this as an intermediate step in converting to HTML;
+instead, use
+.Fl T Cm html
+directly.
+.Pp
+The
+.Xr man 5 ,
+.Xr tbl 5 ,
+and
+.Xr eqn 5
+input languages are not supported by
+.Fl T Cm markdown
+output mode.
.Ss PDF Output
PDF-1.1 output may be generated by
.Fl T Cm pdf .
@@ -534,27 +555,36 @@ option:
.Pp
.Bl -tag -width Ds -compact
.It 0
-No warnings or errors occurred, or those that did were ignored because
-they were lower than the requested
+No base system convention violations, style suggestions, warnings,
+or errors occurred, or those that did were ignored because they
+were lower than the requested
.Ar level .
+.It 1
+At least one base system convention violation or style suggestion
+occurred, but no warning or error, and
+.Fl W Cm base
+or
+.Fl W Cm style
+was specified.
.It 2
At least one warning occurred, but no error, and
.Fl W Cm warning
-was specified.
+or a lower
+.Ar level
+was requested.
.It 3
At least one parsing error occurred,
but no unsupported feature was encountered, and
.Fl W Cm error
-or
-.Fl W Cm warning
-was specified.
+or a lower
+.Ar level
+was requested.
.It 4
At least one unsupported feature was encountered, and
-.Fl W Cm unsupp ,
-.Fl W Cm error
-or
-.Fl W Cm warning
-was specified.
+.Fl W Cm unsupp
+or a lower
+.Ar level
+was requested.
.It 5
Invalid command line arguments were specified.
No input files have been read.
@@ -569,12 +599,11 @@ to exit at once, possibly in the middle of parsing or formatting a file.
Note that selecting
.Fl T Cm lint
output mode implies
-.Fl W Cm warning .
+.Fl W Cm all .
.Sh EXAMPLES
To page manuals to the terminal:
.Pp
-.Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less
-.Dl $ mandoc mandoc.1 mdoc.3 mdoc.5 | less
+.Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
.Pp
To produce HTML manuals with
.Pa mandoc.css
@@ -603,12 +632,19 @@ parser:
Messages displayed by
.Nm
follow this format:
-.Pp
-.D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
+.Bd -ragged -offset indent
+.Nm :
+.Ar file : Ns Ar line : Ns Ar column : level : message : macro args
+.Pq Ar os
+.Ed
.Pp
Line and column numbers start at 1.
Both are omitted for messages referring to an input file as a whole.
Macro names and arguments are omitted where meaningless.
+The
+.Ar os
+operating system specifier is omitted for messages that are relevant
+for all operating systems.
Fatal messages about invalid command line arguments
or operating system errors, for example when memory is exhausted,
may also omit the
@@ -628,35 +664,41 @@ so using GNU troff instead of
.Nm
to process the file may be preferable.
.It Cm error
-An input file contains invalid syntax that cannot be safely interpreted.
-By discarding part of the input or inserting missing tokens,
-the parser is able to continue, and the error does not prevent
-generation of formatted output, but typically, preparing that
-output involves information loss, broken document structure
-or unintended formatting, no matter whether
-.Nm
-or GNU troff is used.
-In many cases, the output of
-.Nm
-and GNU troff is identical, but in some,
-.Nm
-is more resilient than GNU troff with respect to malformed input.
-.Pp
-Non-existent or unreadable input files are also reported on the
-.Cm error
-level.
-In that case, the parser cannot even be started and no output
-is produced from those input files.
+Indicates a risk of information loss or severe misformatting,
+in most cases caused by serious syntax errors.
.It Cm warning
-An input file uses obsolete, discouraged or non-portable syntax.
-All the same, the meaning of the input is unambiguous and a correct
-rendering can be produced.
-Documents causing warnings may render poorly when using other
-formatting tools instead of
-.Nm .
+Indicates a risk that the information shown or its formatting
+may mismatch the author's intent in minor ways.
+Additionally, syntax errors are classified at least as warnings,
+even if they do not usually cause misformatting.
+.It Cm style
+An input file uses dubious or discouraged style.
+This is not a complaint about the syntax, and probably neither
+formatting nor portability are in danger.
+While great care is taken to avoid false positives on the higher
+message levels, the
+.Cm style
+level tries to reduce the probability that issues go unnoticed,
+so it may occasionally issue bogus suggestions.
+Please use your good judgement to decide whether any particular
+.Cm style
+suggestion really justifies a change to the input file.
+.It Cm base
+A convertion used in the base system of a specific operating system
+is not adhered to.
+These are not markup mistakes, and neither the quality of formatting
+nor portability are in danger.
+Messages of the
+.Cm base
+level are printed with the more intuitive
+.Cm style
+.Ar level
+tag.
.El
.Pp
Messages of the
+.Cm base ,
+.Cm style ,
.Cm warning ,
.Cm error ,
and
@@ -667,6 +709,199 @@ are hidden unless their level, or a lower level, is requested using a
option or
.Fl T Cm lint
output mode.
+.Pp
+As indicated below, all
+.Cm base
+and some
+.Cm style
+checks are only performed if a specific operating system name occurs
+in the arguments of the
+.Fl W
+command line option, of the
+.Ic \&Os
+macro, of the
+.Fl Ios
+command line option, or, if neither are present, in the return value
+of the
+.Xr uname 3
+function.
+.Ss Conventions for base system manuals
+.Bl -ohang
+.It Sy "Mdocdate found"
+.Pq mdoc , Nx
+The
+.Ic \&Dd
+macro uses CVS
+.Ic Mdocdate
+keyword substitution, which is not supported by the
+.Nx
+base system.
+Consider using the conventional
+.Dq "Month dd, yyyy"
+format instead.
+.It Sy "Mdocdate missing"
+.Pq mdoc , Ox
+The
+.Ic \&Dd
+macro does not use CVS
+.Ic Mdocdate
+keyword substitution, but using it is conventionally expected in the
+.Ox
+base system.
+.It Sy "unknown architecture"
+.Pq mdoc , Ox , Nx
+The third argument of the
+.Ic \&Dt
+macro does not match any of the architectures this operating system
+is running on.
+.It Sy "operating system explicitly specified"
+.Pq mdoc , Ox , Nx
+The
+.Ic \&Os
+macro has an argument.
+In the base system, it is conventionally left blank.
+.It Sy "RCS id missing"
+.Pq Ox , Nx
+The manual page lacks the comment line with the RCS identifier
+generated by CVS
+.Ic OpenBSD
+or
+.Ic NetBSD
+keyword substitution as conventionally used in these operating systems.
+.It Sy "referenced manual not found"
+.Pq mdoc
+An
+.Ic \&Xr
+macro references a manual page that is not found in the base system.
+The path to look for base system manuals is configurable at compile
+time and defaults to
+.Pa /usr/share/man : /usr/X11R6/man .
+.El
+.Ss Style suggestions
+.Bl -ohang
+.It Sy "legacy man(7) date format"
+.Pq mdoc
+The
+.Ic \&Dd
+macro uses the legacy
+.Xr man 5
+date format
+.Dq yyyy-dd-mm .
+Consider using the conventional
+.Xr mdoc 5
+date format
+.Dq "Month dd, yyyy"
+instead.
+.It Sy "lower case character in document title"
+.Pq mdoc , man
+The title is still used as given in the
+.Ic \&Dt
+or
+.Ic \&TH
+macro.
+.It Sy "duplicate RCS id"
+A single manual page contains two copies of the RCS identifier for
+the same operating system.
+Consider deleting the later instance and moving the first one up
+to the top of the page.
+.It Sy "typo in section name"
+.Pq mdoc
+Fuzzy string matching revealed that the argument of an
+.Ic \&Sh
+macro is similar, but not identical to a standard section name.
+.It Sy "unterminated quoted argument"
+.Pq roff
+Macro arguments can be enclosed in double quote characters
+such that space characters and macro names contained in the quoted
+argument need not be escaped.
+The closing quote of the last argument of a macro can be omitted.
+However, omitting it is not recommended because it makes the code
+harder to read.
+.It Sy "useless macro"
+.Pq mdoc
+A
+.Ic \&Bt ,
+.Ic \&Tn ,
+or
+.Ic \&Ud
+macro was found.
+Simply delete it: it serves no useful purpose.
+.It Sy "consider using OS macro"
+.Pq mdoc
+A string was found in plain text or in a
+.Ic \&Bx
+macro that could be represented using
+.Ic \&Ox ,
+.Ic \&Nx ,
+.Ic \&Fx ,
+or
+.Ic \&Dx .
+.It Sy "errnos out of order"
+.Pq mdoc, Nx
+The
+.Ic \&Er
+items in a
+.Ic \&Bl
+list are not in alphabetical order.
+.It Sy "duplicate errno"
+.Pq mdoc, Nx
+A
+.Ic \&Bl
+list contains two consecutive
+.Ic \&It
+entries describing the same
+.Ic \&Er
+number.
+.It Sy "trailing delimiter"
+.Pq mdoc
+The last argument of an
+.Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St ,
+or
+.Ic \&Sx
+macro ends with a trailing delimiter.
+This is usually bad style and often indicates typos.
+Most likely, the delimiter can be removed.
+.It Sy "no blank before trailing delimiter"
+.Pq mdoc
+The last argument of a macro that supports trailing delimiter
+arguments is longer than one byte and ends with a trailing delimiter.
+Consider inserting a blank such that the delimiter becomes a separate
+argument, thus moving it out of the scope of the macro.
+.It Sy "fill mode already enabled, skipping"
+.Pq man
+A
+.Ic \&fi
+request occurs even though the document is still in fill mode,
+or already switched back to fill mode.
+It has no effect.
+.It Sy "fill mode already disabled, skipping"
+.Pq man
+An
+.Ic \&nf
+request occurs even though the document already switched to no-fill mode
+and did not switch back to fill mode yet.
+It has no effect.
+.It Sy "function name without markup"
+.Pq mdoc
+A word followed by an empty pair of parentheses occurs on a text line.
+Consider using an
+.Ic \&Fn
+or
+.Ic \&Xr
+macro.
+.It Sy "whitespace at end of input line"
+.Pq mdoc , man , roff
+Whitespace at the end of input lines is almost never semantically
+significant \(em but in the odd case where it might be, it is
+extremely confusing when reviewing and maintaining documents.
+.It Sy "bad comment style"
+.Pq roff
+Comment lines start with a dot, a backslash, and a double-quote character.
+The
+.Nm
+utility treats the line as a comment line even without the backslash,
+but leaving out the backslash might not be portable.
+.El
.Ss Warnings related to the document prologue
.Bl -ohang
.It Sy "missing manual title, using UNTITLED"
@@ -681,13 +916,6 @@ macro before the first non-prologue macro.
There is no
.Ic \&TH
macro, or it has no arguments.
-.It Sy "lower case character in document title"
-.Pq mdoc , man
-The title is still used as given in the
-.Ic \&Dt
-or
-.Ic \&TH
-macro.
.It Sy "missing manual section, using \(dq\(dq"
.Pq mdoc , man
A
@@ -723,13 +951,17 @@ The date given in a
or
.Ic \&TH
macro does not follow the conventional format.
+.It Sy "date in the future, using it anyway"
+.Pq mdoc , man
+The date given in a
+.Ic \&Dd
+or
+.Ic \&TH
+macro is more than a day ahead of the current system
+.Xr time 3 .
.It Sy "missing Os macro, using \(dq\(dq"
.Pq mdoc
The default or current system is not shown in this case.
-.It Sy "duplicate prologue macro"
-.Pq mdoc
-One of the prologue macros occurs more than once.
-The last instance overrides all previous ones.
.It Sy "late prologue macro"
.Pq mdoc
A
@@ -737,17 +969,6 @@ A
or
.Ic \&Os
macro occurs after some non-prologue macro, but still takes effect.
-.It Sy "skipping late title macro"
-.Pq mdoc
-The
-.Ic \&Dt
-macro appears after the first non-prologue macro.
-Traditional formatters cannot handle this because
-they write the page header before parsing the document body.
-Even though this technical restriction does not apply to
-.Nm ,
-traditional semantics is preserved.
-The late macro is discarded including its arguments.
.It Sy "prologue macros out of order"
.Pq mdoc
The prologue macros are not given in the conventional order
@@ -819,6 +1040,14 @@ The
.Ic \&Nd
macro lacks the required argument.
The title line of the manual will end after the dash.
+.It Sy "description line outside NAME section"
+.Pq mdoc
+An
+.Ic \&Nd
+macro appears outside the NAME section.
+The arguments are printed anyway and the following text is used for
+.Xr apropos 1 ,
+but none of that behaviour is portable.
.It Sy "sections out of conventional order"
.Pq mdoc
A standard section occurs after another section it usually precedes.
@@ -831,6 +1060,24 @@ The same standard section title occurs more than once.
.Pq mdoc
A standard section header occurs in a section of the manual
where it normally isn't useful.
+.It Sy "cross reference to self"
+.Pq mdoc
+An
+.Ic \&Xr
+macro refers to a name and section matching the section of the present
+manual page and a name mentioned in an
+.Ic \&Nm
+macro in the NAME or SYNOPSIS section, or in an
+.Ic \&Fn
+or
+.Ic \&Fo
+macro in the SYNOPSIS.
+Consider using
+.Ic \&Nm
+or
+.Ic \&Fn
+instead of
+.Ic \&Xr .
.It Sy "unusual Xr order"
.Pq mdoc
In the SEE ALSO section, an
@@ -917,7 +1164,9 @@ The paragraph macro is moved after the end of the list.
.Pq mdoc
An input line begins with an
.Ic \&Ns
-macro.
+macro, or the next argument after an
+.Ic \&Ns
+macro is an isolated closing delimiter.
The macro is ignored.
.It Sy "blocks badly nested"
.Pq mdoc
@@ -958,20 +1207,12 @@ list block contains text or macros before the first
.Ic \&It
macro.
The offending children are moved before the beginning of the list.
-.It Sy "fill mode already enabled, skipping"
-.Pq man
-A
-.Ic \&fi
-request occurs even though the document is still in fill mode,
-or already switched back to fill mode.
-It has no effect.
-.It Sy "fill mode already disabled, skipping"
-.Pq man
-An
-.Ic \&nf
-request occurs even though the document already switched to no-fill mode
-and did not switch back to fill mode yet.
-It has no effect.
+.It Sy "first macro on line"
+Inside a
+.Ic \&Bl Fl column
+list, a
+.Ic \&Ta
+macro occurs as the first macro on a line, which is not portable.
.It Sy "line scope broken"
.Pq man
While parsing the next-line scope of the previous macro,
@@ -1025,6 +1266,7 @@ A
.Ic \&Bl ,
.Ic \&D1 ,
.Ic \&Dl ,
+.Ic \&MT ,
.Ic \&RS ,
or
.Ic \&UR
@@ -1037,7 +1279,7 @@ or
.Ic \&Bl
.Fl offset
or
-.Fl width.
+.Fl width .
.It Sy "missing display type, using -ragged"
.Pq mdoc
The
@@ -1102,6 +1344,17 @@ list, an
.Ic \&It
block is empty.
An empty list item is shown.
+.It Sy "missing argument, using next line"
+.Pq mdoc
+An
+.Ic \&It
+macro in a
+.Ic \&Bd Fl column
+list has no arguments.
+While
+.Nm
+uses the text or macros of the following line, if any, for the cell,
+other formatters may misformat the list.
.It Sy "missing font type, using \efR"
.Pq mdoc
A
@@ -1160,6 +1413,8 @@ An empty pair of square brackets is shown.
.It Sy "missing resource identifier, using \(dq\(dq"
.Pq man
The
+.Ic \&MT
+or
.Ic \&UR
macro is invoked without any argument.
An empty pair of angle brackets is shown.
@@ -1171,14 +1426,6 @@ An empty box is inserted.
.El
.Ss "Warnings related to bad macro arguments"
.Bl -ohang
-.It Sy "unterminated quoted argument"
-.Pq roff
-Macro arguments can be enclosed in double quote characters
-such that space characters and macro names contained in the quoted
-argument need not be escaped.
-The closing quote of the last argument of a macro can be omitted.
-However, omitting it is not recommended because it makes the code
-harder to read.
.It Sy "duplicate argument"
.Pq mdoc
A
@@ -1259,6 +1506,12 @@ or
.Ic \&Fn
macro contains an opening or closing parenthesis; that's probably wrong,
parentheses are added automatically.
+.It Sy "unknown library name"
+.Pq mdoc, not on Ox
+An
+.Ic \&Lb
+macro has an unknown name argument and will be rendered as
+.Qq library Dq Ar name .
.It Sy "invalid content in Rs block"
.Pq mdoc
An
@@ -1314,22 +1567,10 @@ As an implementation dependent choice, tab characters on text lines
are passed through to the formatters in any case.
Given that the text before the tab character will be filled,
it is hard to predict which tab stop position the tab will advance to.
-.It Sy "whitespace at end of input line"
-.Pq mdoc , man , roff
-Whitespace at the end of input lines is almost never semantically
-significant \(em but in the odd case where it might be, it is
-extremely confusing when reviewing and maintaining documents.
.It Sy "new sentence, new line"
.Pq mdoc
A new sentence starts in the middle of a text line.
Start it on a new input line to help formatters produce correct spacing.
-.It Sy "bad comment style"
-.Pq roff
-Comment lines start with a dot, a backslash, and a double-quote character.
-The
-.Nm
-utility treats the line as a comment line even without the backslash,
-but leaving out the backslash might not be portable.
.It Sy "invalid escape sequence"
.Pq roff
An escape sequence has an invalid opening argument delimiter, lacks the
@@ -1436,6 +1677,21 @@ and any remaining cells stay empty.
.El
.Ss "Errors related to roff, mdoc, and man code"
.Bl -ohang
+.It Sy "duplicate prologue macro"
+.Pq mdoc
+One of the prologue macros occurs more than once.
+The last instance overrides all previous ones.
+.It Sy "skipping late title macro"
+.Pq mdoc
+The
+.Ic \&Dt
+macro appears after the first non-prologue macro.
+Traditional formatters cannot handle this because
+they write the page header before parsing the document body.
+Even though this technical restriction does not apply to
+.Nm ,
+traditional semantics is preserved.
+The late macro is discarded including its arguments.
.It Sy "input stack limit exceeded, infinite loop?"
.Pq roff
Explicit recursion limits are implemented for the following features,
@@ -1506,7 +1762,7 @@ An
.Xr mdoc 5
block closing macro, a
.Xr man 5
-.Ic \&RE
+.Ic \&ME, \&RE
or
.Ic \&UE
macro, an
@@ -1540,7 +1796,7 @@ At the end of the document, an explicit
block, a
.Xr man 5
next-line scope or
-.Ic \&RS
+.Ic \&MT , \&RS
or
.Ic \&UR
block, an equation, table, or
@@ -1606,6 +1862,11 @@ whatever mode was active before the block.
A
.Ic \&Bl
macro fails to specify the list type.
+.It Sy "argument is not numeric, using 1"
+.Pq roff
+The argument of a
+.Ic \&ce
+request is not a number.
.It Sy "missing manual name, using \(dq\(dq"
.Pq mdoc
The first call to
@@ -1707,6 +1968,7 @@ A macro or request is invoked with too many arguments:
.Bl -dash -offset 2n -width 2n -compact
.It
.Ic \&Fo ,
+.Ic \&MT ,
.Ic \&PD ,
.Ic \&RS ,
.Ic \&UR ,
diff --git a/usr/src/man/man1m/automount.1m b/usr/src/man/man1m/automount.1m
index 717d4fafe1..111e1a512c 100644
--- a/usr/src/man/man1m/automount.1m
+++ b/usr/src/man/man1m/automount.1m
@@ -17,7 +17,7 @@
.\"
.\" Copyright 1989 AT&T
.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
-.\" Copyright 2016 Nexenta Systems, Inc.
+.\" Copyright 2017 Nexenta Systems, Inc.
.\"
.Dd February 25, 2017
.Dt AUTOMOUNT 1M
@@ -205,7 +205,7 @@ and
.Ar location
takes the form:
.Pp
-.Dl Ar host Ns : Ns Ar pathname
+.Dl Ar host Ns \&: Ns Ar pathname
.Pp
.Ar host
is the name of the host from which to mount the file system, and
@@ -259,7 +259,7 @@ then a single
.Ar location
may be used with a comma-separated list of hostnames:
.Bd -literal -offset indent
-.Ar hostname Ns , Ns Ar hostname Ns ...: Ns Ar pathname
+.Ar hostname Ns \&, Ns Ar hostname Ns ...: Ns Ar pathname
.Ed
.Pp
Requests for a server may be weighted, with the weighting factor appended to
@@ -338,7 +338,7 @@ this would allow automatic mounts in
.Pa /config
of any remote file system whose location could be specified as:
.Bd -literal -offset indent
-.Ar hostname Ns : Ns Pa /export/config/ Ns Ar hostname
+.Ar hostname Ns \&: Ns Pa /export/config/ Ns Ar hostname
.Ed
.Pp
Note that the wildcard key does not work in conjunction with the
@@ -356,42 +356,19 @@ 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
-.Ta Nm arch
-.Ta architecture name
-.Pq Qq Sy sun4
-.It Ev CPU
-.Ta Nm uname Fl p
-.Ta processor type
-.Pq Qq Sy sparc
-.It Ev HOST
-.Ta Nm uname Fl n
-.Ta host name
-.Pq Qq Sy myhost
-.It Ev KARCH
-.Ta Nm arch Fl k No or Nm uname Fl m
-.Ta kernel architecture name or machine hardware name
+.It Ev ARCH Ta Nm arch Ta architecture name Pq Qq Sy sun4
+.It Ev CPU Ta Nm uname Fl p Ta processor type Pq Qq Sy sparc
+.It Ev HOST Ta Nm uname Fl n Ta host name Pq Qq Sy myhost
+.It Ev KARCH Ta Nm arch Fl k No or Nm uname Fl m Ta kernel architecture name or
+machine hardware name
.Pq Qq Sy sun4u
-.It Ev OSNAME
-.Ta Nm uname Fl s
-.Ta OS name
-.Pq Qq Sy SunOS
-.It Ev OSREL
-.Ta Nm name Fl r
-.Ta OS release name
-.Pq Qq Sy 5.3
-.It Ev OSVERS
-.Ta Nm uname Fl v
-.Ta OS version
-.Pq Qq Sy beta1.0
-.It Ev NATISA
-.Ta Nm isainfo Fl n
-.Ta native instruction set architecture for the system
+.It Ev OSNAME Ta Nm uname Fl s Ta OS name Pq Qq Sy SunOS
+.It Ev OSREL Ta Nm name Fl r Ta OS release name Pq Qq Sy 5.3
+.It Ev OSVERS Ta Nm uname Fl v Ta OS version Pq Qq Sy beta1.0
+.It Ev NATISA Ta Nm isainfo Fl n Ta native instruction set architecture for the
+system
.Pq Qq Sy sparcv9
-.It Ev PLATFORM
-.Ta Nm uname Fl i
-.Ta platform name
-.Pq Qq Sy SUNW,Sun-Fire-V240
+.It Ev PLATFORM Ta Nm uname Fl i Ta platform name Pq Qq Sy SUNW,Sun-Fire-V240
.El
.Pp
If a reference needs to be protected from affixed characters, you can surround
diff --git a/usr/src/man/man1m/ipadm.1m b/usr/src/man/man1m/ipadm.1m
index dc3ea104c9..1a8ea8a54d 100644
--- a/usr/src/man/man1m/ipadm.1m
+++ b/usr/src/man/man1m/ipadm.1m
@@ -176,7 +176,7 @@ this can be one of the following values:
.Cm tcp ,
.Cm sctp
or
-.Cm udp.
+.Cm udp .
.Sh SUBCOMMANDS
The following subcommands are supported:
.Bl -tag -width ""
@@ -191,7 +191,7 @@ The interface will be enabled as part of the creation process.
The IPv4 interface will have the address 0.0.0.0.
The IPv6 interface will have the address ::.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -202,7 +202,7 @@ Temporary, not persistent across reboots.
.Xc
Disable an IP interface.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -213,7 +213,7 @@ Temporary, not persistent across reboots.
.Xc
Enable an IP interface.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -230,7 +230,7 @@ Permanently delete an IP interface.
.Xc
Show the current IP interface configuration.
.Bl -tag -width ""
-.It Fl o Ns , Ns Fl -output
+.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
@@ -292,7 +292,7 @@ IPv4
IPv6
.El
.El
-.It Fl p Ns , Ns Fl -parsable
+.It Fl p Ns \&, Ns Fl -parsable
Print the output in a parsable format.
.El
.It Xo
@@ -305,9 +305,9 @@ Print the output in a parsable format.
.Xc
Set a property's value(s) on the IP interface.
.Bl -tag -width ""
-.It Fl m Ns , Ns Fl -module
+.It Fl m Ns \&, Ns Fl -module
Specify which protocol the setting applies to.
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify the property name and value(s).
The property name can be one of the following:
.Bl -tag -compact -width "exchange_routes"
@@ -334,7 +334,7 @@ A value
.Cm none
may also be used.
.El
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -347,14 +347,14 @@ Temporary, not persistent across reboots.
.Xc
Reset an IP interface's property value to the default.
.Bl -tag -width ""
-.It Fl m Ns , Ns Fl -module
+.It Fl m Ns \&, Ns Fl -module
Specify which protocol the setting applies to.
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify the property name.
See the
.Nm ipadm Ic set-ifprop
subcommand for the list of property names.
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -367,11 +367,11 @@ Temporary, not persistent across reboots.
.Xc
Display the property values for one or all of the IP interfaces.
.Bl -tag -width ""
-.It Fl c Ns , Ns Fl -parsable
+.It Fl c Ns \&, Ns Fl -parsable
Print the output in a parsable format.
-.It Fl m Ns , Ns Fl -module
+.It Fl m Ns \&, Ns Fl -module
Specify which protocol to display.
-.It Fl o Ns , Ns Fl -output
+.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
@@ -397,7 +397,7 @@ The default value of the property.
.It Cm POSSIBLE
The possible values for the property.
.El
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify which properties to display.
See the
.Nm ipadm Ic set-ifprop
@@ -446,7 +446,7 @@ address configured on an interface is required to configure
IPv6 address on the same interface.
This takes the following options:
.Bl -tag -width ""
-.It Fl a Ns , Ns Fl -address
+.It Fl a Ns \&, Ns Fl -address
Specify the address.
The
.Cm local
@@ -458,26 +458,26 @@ Otherwise, the equal sign
.Pq Qq =
should be omitted and the address should be provided by itself without second
address.
-.It Fl d Ns , Ns Fl -down
+.It Fl d Ns \&, Ns Fl -down
The address is down.
.El
.It Fl T Cm dhcp
Obtain the address via DHCP.
This takes the following options:
.Bl -tag -width ""
-.It Fl w Ns , Ns Fl -wait
+.It Fl w Ns \&, Ns Fl -wait
Specify the time, in seconds, that the command should wait to obtain an address.
.El
.It Fl T Cm addrconf
Create an auto-configured address.
This takes the following options:
.Bl -tag -width ""
-.It Fl i Ns , Ns Fl -interface-id
+.It Fl i Ns \&, Ns Fl -interface-id
Specify the interface ID to be used.
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify which method of auto-configuration should be used.
.El
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -489,7 +489,7 @@ Temporary, not persistent across reboots.
Down the address.
This will stop packets from being sent or received.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -501,7 +501,7 @@ Temporary, not persistent across reboots.
Up the address.
This will enable packets to be sent and received.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -512,7 +512,7 @@ Temporary, not persistent across reboots.
.Xc
Disable the address.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -523,7 +523,7 @@ Temporary, not persistent across reboots.
.Xc
Enable the address.
.Bl -tag -width ""
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -539,7 +539,7 @@ It also restarts duplicate address detection for
.Cm static
addresses.
.Bl -tag -width ""
-.It Fl i Ns , Ns Fl -inform
+.It Fl i Ns \&, Ns Fl -inform
Obtain network configuration from DHCP without taking a lease on the address.
.El
.It Xo
@@ -550,7 +550,7 @@ Obtain network configuration from DHCP without taking a lease on the address.
.Xc
Delete the given address.
.Bl -tag -width ""
-.It Fl r Ns , Ns Fl -release
+.It Fl r Ns \&, Ns Fl -release
Indicate that the DHCP-assigned address should be released.
.El
.It Xo
@@ -561,7 +561,7 @@ Indicate that the DHCP-assigned address should be released.
.Xc
Show the current address properties.
.Bl -tag -width ""
-.It Fl o Ns , Ns Fl -output
+.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
@@ -624,7 +624,7 @@ deprecated
.It Cm ADDR
The address.
.El
-.It Fl p Ns , Ns Fl -parsable
+.It Fl p Ns \&, Ns Fl -parsable
Print the output in a parsable format.
.El
.It Xo
@@ -636,7 +636,7 @@ Print the output in a parsable format.
.Xc
Set a property's value(s) on the addrobj.
.Bl -tag -width ""
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify the property name and value(s).
The property name can be one of the following:
.Bl -tag -compact -width "deprecated"
@@ -656,7 +656,7 @@ Packets can be transmitted
.It Cm zone
The zone the addrobj is in.
.El
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -668,12 +668,12 @@ Temporary, not persistent across reboots.
.Xc
Reset an addrobj's property value to the default.
.Bl -tag -width ""
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify the property name.
See the
.Nm ipadm Ic set-addrprop
subcommand for the list of property names.
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -685,9 +685,9 @@ Temporary, not persistent across reboots.
.Xc
Display the property values for one or all of the addrobjs.
.Bl -tag -width ""
-.It Fl c Ns , Ns Fl -parsable
+.It Fl c Ns \&, Ns Fl -parsable
Print the output in a parsable format.
-.It Fl o Ns , Ns Fl -output
+.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
@@ -711,7 +711,7 @@ The default value of the property.
.It Cm POSSIBLE
The possible values for the property.
.El
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify which properties to display.
See the
.Nm ipadm Ic set-addrprop
@@ -726,7 +726,7 @@ subcommand for the list of property names.
.Xc
Set a property's value(s) on the protocol.
.Bl -tag -width ""
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify the property name and value(s).
The optional
.Sy + Ns | Ns Sy -
@@ -782,7 +782,7 @@ Smallest non-privileged port
.It Cm ttl
The IPv4 time-to-live.
.El
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -794,12 +794,12 @@ Temporary, not persistent across reboots.
.Xc
Reset a protocol's property value to the default.
.Bl -tag -width ""
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify the property name.
See the
.Nm ipadm Ic set-prop
subcommand for the list of property names.
-.It Fl t Ns , Ns Fl -temporary
+.It Fl t Ns \&, Ns Fl -temporary
Temporary, not persistent across reboots.
.El
.It Xo
@@ -811,9 +811,9 @@ Temporary, not persistent across reboots.
.Xc
Display the property values for one or all of the protocols.
.Bl -tag -width ""
-.It Fl c Ns , Ns Fl -parsable
+.It Fl c Ns \&, Ns Fl -parsable
Print the output in a parsable format.
-.It Fl o Ns , Ns Fl -output
+.It Fl o Ns \&, Ns Fl -output
Select which fields will be shown.
The field value can be one of the following names:
.Bl -tag -compact -width "PERSISTENT"
@@ -837,7 +837,7 @@ The default value of the property.
.It Cm POSSIBLE
The possible values for the property.
.El
-.It Fl p Ns , Ns Fl -prop
+.It Fl p Ns \&, Ns Fl -prop
Specify which properties to display.
See the
.Nm ipadm Ic set-prop
diff --git a/usr/src/man/man1m/lofiadm.1m b/usr/src/man/man1m/lofiadm.1m
index 750e2c732a..079caf2502 100644
--- a/usr/src/man/man1m/lofiadm.1m
+++ b/usr/src/man/man1m/lofiadm.1m
@@ -264,14 +264,14 @@ encryption key.
.It Ar token_key
PKCS#11 token object in the format:
.Pp
-.Ar token_name Ns : Ns Ar manufacturer_id Ns : Ns Ar serial_number Ns : Ns Ar key_label
+.Ar token_name Ns \&: Ns Ar manufacturer_id Ns \&: Ns
+.Ar serial_number Ns \&: Ns Ar key_label
.Pp
All but the key label are optional and can be empty.
For example, to specify a token object with only its key label
.Sy MylofiKey ,
-use:
-.Pp
-.Fl T Ar ::: Ns Ar MylofiKey
+use
+.Fl T Sy :::MylofiKey .
.It Ar wrapped_key_file
Path to file containing a symmetric encryption key wrapped by the RSA private
key specified by
diff --git a/usr/src/man/man1m/mount_nfs.1m b/usr/src/man/man1m/mount_nfs.1m
index 4992fa1b7b..caf5d86175 100644
--- a/usr/src/man/man1m/mount_nfs.1m
+++ b/usr/src/man/man1m/mount_nfs.1m
@@ -17,7 +17,7 @@
.\"
.\" Copyright 1989 AT&T
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved
-.\" Copyright 2016 Nexenta Systems, Inc.
+.\" Copyright 2017 Nexenta Systems, Inc.
.\"
.Dd March 12, 2016
.Dt MOUNT_NFS 1M
@@ -102,7 +102,7 @@ See
and
.Xr inet6 7P .
.Bl -tag -width Ds
-.It Ar host Ns : Ns Ar pathname
+.It Ar host Ns \&: Ns Ar pathname
Where
.Ar host
is the name of the NFS server host, and
@@ -122,12 +122,12 @@ See the discussion of URLs and the public option under
.Sx NFS FILE SYSTEMS
for a more detailed discussion.
.It Xo
-.Ar host Ns : Ns Ar pathname
+.Ar host Ns \&: Ns Ar pathname
.No nfs:// Ns Ar host Ns Oo : Ns Ar port Oc Ns / Ns Ar pathname
.Xc
-.Ar host Ns : Ns Ar pathname
+.Ar host Ns \&: Ns Ar pathname
is a comma-separated list of
-.Ar host Ns : Ns Ar pathname .
+.Ar host Ns \&: Ns Ar pathname .
See the discussion of replicated file systems and failover under
.Sx NFS FILE SYSTEMS
for a more detailed discussion.
diff --git a/usr/src/man/man1m/share_nfs.1m b/usr/src/man/man1m/share_nfs.1m
index 8a2770cb79..c79b6b9438 100644
--- a/usr/src/man/man1m/share_nfs.1m
+++ b/usr/src/man/man1m/share_nfs.1m
@@ -109,9 +109,9 @@ some other local user.
For clients where the gid in the incoming request is
.Ar clnt
and the client matches the
-.Ar access_list Ns
-, change the group ID to
-.Ar srv Ns .
+.Ar access_list ,
+change the group ID to
+.Ar srv .
If
.Ar clnt
is asterisk (*), all groups are mapped by this rule.
@@ -329,9 +329,9 @@ some other local user.
For clients where the uid in the incoming request is
.Ar clnt
and the client matches the
-.Ar access_list Ns
-, change the user ID to
-.Ar srv Ns .
+.Ar access_list ,
+change the user ID to
+.Ar srv .
If
.Ar clnt
is asterisk (*), all users are mapped by this rule.
@@ -553,7 +553,7 @@ The following example remaps the user with uid
at client
.Sy 10.0.0.1
to user
-.Sy joe Ns :
+.Sy joe :
.Bd -literal -offset indent
share -o uidmap=100:joe:@10.0.0.1 /export
.Ed
diff --git a/usr/src/man/man1m/stmfadm.1m b/usr/src/man/man1m/stmfadm.1m
index d99c31c3b3..1444e35832 100644
--- a/usr/src/man/man1m/stmfadm.1m
+++ b/usr/src/man/man1m/stmfadm.1m
@@ -16,7 +16,7 @@
.\"
.\"
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
-.\" Copyright 2016 Nexenta Systems, Inc.
+.\" Copyright 2017 Nexenta Systems, Inc.
.\"
.Dd March 1, 2016
.Dt STMFADM 1M
@@ -247,7 +247,7 @@ Add a host group member to a host group.
.Pp
An initiator cannot be a member of more than one host group.
.Bl -tag -width Ds
-.It Fl g Ns , Ns Fl -group-name Ar host-group
+.It Fl g Ns \&, Ns Fl -group-name Ar host-group
Specifies group name.
.Ar host-group
must be an existing group created using the
@@ -264,7 +264,7 @@ Add a target group member to a target group.
.Pp
A target cannot be a member of more than one target group.
.Bl -tag -width Ds
-.It Fl g Ns , Ns Fl -group-name Ar target-group
+.It Fl g Ns \&, Ns Fl -group-name Ar target-group
Specifies group name.
.Ar target-group
must be an existing group created using the
@@ -300,20 +300,20 @@ and
.Cm remove-view
subcommands.
.Bl -tag -width Ds
-.It Fl h Ns , Ns Fl -host-group Ar host-group
+.It Fl h Ns \&, Ns Fl -host-group Ar host-group
.Ar host-group
is the name of an host group previously created using
.Cm create-hg
subcommand.
If this option is not specified, the logical unit will be available to all
initiators that log in to the STMF framework.
-.It Fl n Ns , Ns Fl -lun Ar lu-number
+.It Fl n Ns \&, Ns Fl -lun Ar lu-number
.Ar lu-number
is an integer in the range 0-16383 to be assigned to the logical unit for this
view entry.
If this option is not specified, a logical unit number will be assigned by the
STMF framework.
-.It Fl t Ns , Ns Fl -target-group Ar target-group
+.It Fl t Ns \&, Ns Fl -target-group Ar target-group
.Ar target-group
is the name of a target group previously created using
.Cm create-tg
@@ -365,12 +365,12 @@ subcommand to specify an alternate file to contain the metadata.
It is advisable to use a file that can provide sufficient storage of the logical
unit metadata, preferably 64k.
.Bl -tag -width Ds
-.It Fl p Ns , Ns Fl -lu-prop Ar property Ns = Ns Ar value
+.It Fl p Ns \&, Ns Fl -lu-prop Ar property Ns = Ns Ar value
Set specified logical unit property.
Check
.Sx Logical Unit Properties
for the list of available properties.
-.It Fl s Ns , Ns Fl -size Ar size
+.It Fl s Ns \&, Ns Fl -size Ar size
.Ar size
is an integer followed by one of the following letters, to indicate a unit of
size:
@@ -407,7 +407,7 @@ subcommand.
This effectively unloads the logical unit from the STMF framework.
Any existing data on the logical unit remains intact.
.Bl -tag -width Ds
-.It Fl k Ns , Ns Fl -keep-views
+.It Fl k Ns \&, Ns Fl -keep-views
Keep view entries for this logical unit.
.El
.It Xo
@@ -449,7 +449,7 @@ If
.Ar host-group
is not specified, all host groups in the system will be listed.
.Bl -tag -width Ds
-.It Fl v Ns , Ns Fl -verbose
+.It Fl v Ns \&, Ns Fl -verbose
Display all host group members.
.El
.It Xo
@@ -464,7 +464,7 @@ If
.Ar lu-name
is not specified, all logical units in the system will be listed.
.Bl -tag -width Ds
-.It Fl v Ns , Ns Fl -verbose
+.It Fl v Ns \&, Ns Fl -verbose
Display verbose information about the logical unit.
.El
.It Xo
@@ -482,7 +482,7 @@ List information for the target port in the system referenced by
.Ar target .
If target name is not specified, all target ports in the system will be listed.
.Bl -tag -width Ds
-.It Fl v Ns , Ns Fl -verbose
+.It Fl v Ns \&, Ns Fl -verbose
Display verbose information about the target along with SCSI session information
for logged-in initiators.
.El
@@ -498,7 +498,7 @@ If
.Ar target-group
is not specified, all target groups in the system will be listed.
.Bl -tag -width Ds
-.It Fl v Ns , Ns Fl -verbose
+.It Fl v Ns \&, Ns Fl -verbose
Display all group members.
.El
.It Xo
@@ -514,7 +514,7 @@ If
is not specified, all view entries for the specified logical unit will be
listed.
.Bl -tag -width Ds
-.It Fl l Ns , Ns Fl -lu-name Ar lu-name
+.It Fl l Ns \&, Ns Fl -lu-name Ar lu-name
Specify logical unit.
.El
.It Xo
@@ -535,18 +535,18 @@ is not specified,
is interpreted as
.Ar lu-name.
.Bl -tag -width Ds
-.It Fl f Ns , Ns Fl -file
+.It Fl f Ns \&, Ns Fl -file
If specified,
.Ar lu-arg
is interpreted as file name.
This provides the ability to modify a logical unit that is not currently
imported into the STMF.
-.It Fl p Ns , Ns Fl -lu-prop Ar property
+.It Fl p Ns \&, Ns Fl -lu-prop Ar property
Modify specified logical unit property.
See
.Sx Logical Unit Properties
for the list of available properties.
-.It Fl s Ns , Ns Fl -size Ar size
+.It Fl s Ns \&, Ns Fl -size Ar size
.Ar size
is an integer followed by one of the following letters, to indicate a unit of
size:
@@ -588,7 +588,7 @@ Remove specified
.Ar initiator
from host group
.Bl -tag -width Ds
-.It Fl g Ns , Ns Fl -group-name Ar host-group
+.It Fl g Ns \&, Ns Fl -group-name Ar host-group
Specifies group name.
.Ar host-group
must be an existing group created using the
@@ -605,7 +605,7 @@ Remove specified
.Ar target
from target group.
.Bl -tag -width Ds
-.It Fl g Ns , Ns Fl -group-name Ar taget-group
+.It Fl g Ns \&, Ns Fl -group-name Ar taget-group
Specifies group name.
.Ar target-group
must be an existing group created using the
@@ -621,9 +621,9 @@ subcommand.
.Xc
Remove one or more view entries from a logical unit.
.Bl -tag -width Ds
-.It Fl a Ns , Ns Fl -all
+.It Fl a Ns \&, Ns Fl -all
Remove all view entries for this logical unit.
-.It Fl l Ns , Ns Fl -lu-name
+.It Fl l Ns \&, Ns Fl -lu-name
Specify logical unit.
.El
.El
diff --git a/usr/src/man/man1m/zdb.1m b/usr/src/man/man1m/zdb.1m
index f341df4e20..c740628f4f 100644
--- a/usr/src/man/man1m/zdb.1m
+++ b/usr/src/man/man1m/zdb.1m
@@ -41,7 +41,7 @@
.Nm
.Fl E
.Op Fl A
-.Ar word0 Ns : Ns Ar word1 Ns :...: Ns Ar word15
+.Ar word0 Ns \&: Ns Ar word1 Ns :...: Ns Ar word15
.Nm
.Fl l
.Op Fl Aqu
@@ -61,7 +61,7 @@
.Op Fl A
.Op Fl e Oo Fl V Oc Op Fl p Ar path ...
.Op Fl U Ar cache
-.Ar poolname vdev Ns : Ns Ar offset Ns : Ns Ar size Ns Op : Ns Ar flags
+.Ar poolname vdev Ns \&: Ns Ar offset Ns \&: Ns Ar size Ns Op : Ns Ar flags
.Nm
.Fl S
.Op Fl AP
@@ -157,7 +157,7 @@ Display the statistics independently for each deduplication table.
Dump the contents of the deduplication tables describing duplicate blocks.
.It Fl DDDDD
Also dump the contents of the deduplication tables describing unique blocks.
-.It Fl E Ar word0 Ns : Ns Ar word1 Ns :...: Ns Ar word15
+.It Fl E Ar word0 Ns \&: Ns Ar word1 Ns :...: Ns Ar word15
Decode and display block from an embedded block pointer specified by the
.Ar word
arguments.
@@ -218,7 +218,9 @@ must be relative to the root of
This option can be combined with
.Fl v
for increasing verbosity.
-.It Fl R Ar poolname vdev Ns : Ns Ar offset Ns : Ns Ar size Ns Op : Ns Ar flags
+.It Xo
+.Fl R Ar poolname vdev Ns \&: Ns Ar offset Ns \&: Ns Ar size Ns Op : Ns Ar flags
+.Xc
Read and display a block from the specified device.
By default the block is displayed as a hex dump, but see the description of the
.Sy r
diff --git a/usr/src/man/man1m/zfs.1m b/usr/src/man/man1m/zfs.1m
index 926d61cbf0..995b36cb38 100644
--- a/usr/src/man/man1m/zfs.1m
+++ b/usr/src/man/man1m/zfs.1m
@@ -26,7 +26,7 @@
.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
.\" Copyright (c) 2014 Integros [integros.com]
-.\" Copyright 2016 Nexenta Systems, Inc.
+.\" Copyright 2017 Nexenta Systems, Inc.
.\"
.Dd September 16, 2016
.Dt ZFS 1M
@@ -1715,7 +1715,7 @@ dataset.
The
.Sy nosuid
option is an alias for
-.Sy nodevices Ns , Ns Sy nosetuid .
+.Sy nodevices Ns \&, Ns Sy nosetuid .
These properties are reported as
.Qq temporary
by the
@@ -1744,7 +1744,7 @@ and underscore
.Pq Qq Sy _ .
The expected convention is that the property name is divided into two portions
such as
-.Em module Ns : Ns Em property ,
+.Em module Ns \&: Ns Em property ,
but this namespace is not enforced by ZFS.
User property names can be at most 256 characters, and cannot begin with a dash
.Pq Qq Sy - .
@@ -2171,7 +2171,7 @@ property is
.Sy off
.Pc .
The following fields are displayed,
-.Sy name Ns , Ns Sy used Ns , Ns Sy available Ns , Ns Sy referenced Ns , Ns
+.Sy name Ns \&, Ns Sy used Ns \&, Ns Sy available Ns \&, Ns Sy referenced Ns \&, Ns
.Sy mountpoint .
.Bl -tag -width "-H"
.It Fl H
@@ -2209,9 +2209,9 @@ The value
.Sy space
to display space usage properties on file systems and volumes.
This is a shortcut for specifying
-.Fl o Sy name Ns , Ns Sy avail Ns , Ns Sy used Ns , Ns Sy usedsnap Ns , Ns
-.Sy usedds Ns , Ns Sy usedrefreserv Ns , Ns Sy usedchild Fl t
-.Sy filesystem Ns , Ns Sy volume
+.Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns
+.Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t
+.Sy filesystem Ns \&, Ns Sy volume
syntax.
.El
.It Fl p
@@ -2333,7 +2333,7 @@ A depth of
will display only the dataset and its direct children.
.It Fl o Ar field
A comma-separated list of columns to display.
-.Sy name Ns , Ns Sy property Ns , Ns Sy value Ns , Ns Sy source
+.Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
is the default value.
.It Fl p
Display numbers in parsable
@@ -2515,7 +2515,7 @@ Print only the specified types from the following set:
.Sy posixgroup ,
.Sy smbgroup .
The default is
-.Fl t Sy posixuser Ns , Ns Sy smbuser .
+.Fl t Sy posixuser Ns \&, Ns Sy smbuser .
The default can be changed to include group types.
.El
.It Xo
@@ -2533,7 +2533,7 @@ filesystem or snapshot.
This subcommand is identical to
.Nm zfs Cm userspace ,
except that the default types to display are
-.Fl t Sy posixgroup Ns , Ns Sy smbgroup .
+.Fl t Sy posixgroup Ns \&, Ns Sy smbgroup .
.It Xo
.Nm
.Cm mount
@@ -2673,7 +2673,7 @@ snapshot to the second snapshot.
For example,
.Fl I Em @a Em fs@d
is similar to
-.Fl i Em @a Em fs@b Ns ; Fl i Em @b Em fs@c Ns ; Fl i Em @c Em fs@d .
+.Fl i Em @a Em fs@b Ns \&; Fl i Em @b Em fs@c Ns \&; Fl i Em @c Em fs@d .
The incremental source may be specified as with the
.Fl i
option.
diff --git a/usr/src/man/man1m/zpool.1m b/usr/src/man/man1m/zpool.1m
index 61e456ad04..3efb9930af 100644
--- a/usr/src/man/man1m/zpool.1m
+++ b/usr/src/man/man1m/zpool.1m
@@ -21,7 +21,7 @@
.\"
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright (c) 2013 by Delphix. All rights reserved.
-.\" Copyright 2016 Nexenta Systems, Inc.
+.\" Copyright 2017 Nexenta Systems, Inc.
.\"
.Dd Oct 2, 2016
.Dt ZPOOL 1M
@@ -985,7 +985,7 @@ Do not display headers, and separate fields by a single tab instead of arbitrary
space.
.It Fl o Ar field
A comma-separated list of columns to display.
-.Sy name Ns , Ns Sy property Ns , Ns Sy value Ns , Ns Sy source
+.Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
is the default value.
.It Fl p
Display numbers in parsable (exact) values.
diff --git a/usr/src/man/man3c/thrd_detach.3c b/usr/src/man/man3c/thrd_detach.3c
index 4f19042c2c..502032b1be 100644
--- a/usr/src/man/man3c/thrd_detach.3c
+++ b/usr/src/man/man3c/thrd_detach.3c
@@ -40,7 +40,7 @@ The act of calling
on a thread does not cause it to terminate.
.Sh RETURN VALUES
Upon successful completion, the
-.Xr thrd_detach 3C
+.Fn thrd_detach
function returns
.Sy thrd_success .
Otherwise, it returns
diff --git a/usr/src/man/man3lib/libpkcs11.3lib b/usr/src/man/man3lib/libpkcs11.3lib
index b065411f3c..3de428effd 100644
--- a/usr/src/man/man3lib/libpkcs11.3lib
+++ b/usr/src/man/man3lib/libpkcs11.3lib
@@ -43,7 +43,7 @@ By default, the following is the system-wide configuration for meta slot.
Meta slot is enabled.
Meta slot provides token-based object support with the Software RSA PKCS#11
softtoken
-.Pf ( Xr pkcs11_softtoken 5 ) .
+.Pq Xr pkcs11_softtoken 5 .
Meta slot is
allowed to move sensitive token objects to other slots if that is necessary to
perform an operation.
@@ -139,7 +139,7 @@ Applications can include either of these headers in place of
which contains both function and type definitions.
.Sh INTERFACES
The shared object
-.Lb libpkcs11.so.1
+.Pa libpkcs11.so.1
provides the public interfaces defined below.
See
.Xr Intro 3
diff --git a/usr/src/man/man3proc/Lgrab_error.3proc b/usr/src/man/man3proc/Lgrab_error.3proc
index 6606ac74c6..6e7f9af803 100644
--- a/usr/src/man/man3proc/Lgrab_error.3proc
+++ b/usr/src/man/man3proc/Lgrab_error.3proc
@@ -33,7 +33,7 @@ The
.Fn Lgrab_error
function only knows how to translate error codes that were stored in
the third argument
-.Pf ( Fa perr Ns )
+.Pq Fa perr
of a call to
.Xr Lgrab 3PROC .
.Sh RETURN VALUES
diff --git a/usr/src/man/man3proc/Pgetareg.3proc b/usr/src/man/man3proc/Pgetareg.3proc
index 254530b6d6..52e6a80733 100644
--- a/usr/src/man/man3proc/Pgetareg.3proc
+++ b/usr/src/man/man3proc/Pgetareg.3proc
@@ -61,7 +61,7 @@ representative thread (LWP).
For more information on how the representative is chosen, see
.Xr proc 4 .
To change the registers of a specific thread, use the
-.Xr Lgetareg 3PROC
+.Fn Lgetareg
and
.Xr Lsetareg 3PROC
functions.
diff --git a/usr/src/man/man3proc/Pgrab_file.3proc b/usr/src/man/man3proc/Pgrab_file.3proc
index 8c883d9677..fa3e3b31a9 100644
--- a/usr/src/man/man3proc/Pgrab_file.3proc
+++ b/usr/src/man/man3proc/Pgrab_file.3proc
@@ -102,5 +102,4 @@ indicates the system failure.
.Xr Pfree 3PROC ,
.Xr Pgrab_core 3PROC ,
.Xr Pgrab_error 3PROC ,
-.Xr Pgrab_file 3PROC ,
.Xr Prelease 3PROC
diff --git a/usr/src/man/man3proc/Plwp_getspymaster.3proc b/usr/src/man/man3proc/Plwp_getspymaster.3proc
index 7810b402b0..8b7adbf418 100644
--- a/usr/src/man/man3proc/Plwp_getspymaster.3proc
+++ b/usr/src/man/man3proc/Plwp_getspymaster.3proc
@@ -44,10 +44,12 @@ For more information on the agent LWP and the spy master, see
.Pp
If the thread identified
.Fa lwpid
-has an agent LWP, the corresponding ps information (see
+has an agent LWP, the corresponding ps information
+.Po see
.Xr proc 4
for the definition of the
-.Sy psinfo_t Ns )
+.Sy psinfo_t
+.Pc
will be filled into
.Fa ps .
.Pp
diff --git a/usr/src/man/man3proc/Psysentry.3proc b/usr/src/man/man3proc/Psysentry.3proc
index 6190890410..d25446b32d 100644
--- a/usr/src/man/man3proc/Psysentry.3proc
+++ b/usr/src/man/man3proc/Psysentry.3proc
@@ -122,7 +122,5 @@ in
.Xr libproc 3LIB .
.Sh SEE ALSO
.Xr libproc 3LIB ,
-.Xr Psysentry 3PROC ,
-.Xr Psysexit 3PROC ,
.Xr proc 4 ,
.Xr attributes 5
diff --git a/usr/src/man/man5/beastie.4th.5 b/usr/src/man/man5/beastie.4th.5
index c9ac2e6dd3..52e78afa1a 100644
--- a/usr/src/man/man5/beastie.4th.5
+++ b/usr/src/man/man5/beastie.4th.5
@@ -32,9 +32,9 @@
The file that goes by the name of
.Nm
is a set of commands designed to draw the ASCII art FreeBSD mascot
-.Nd known simply as
-.Ic beastie
-.Nd to the right of the boot loader menu.
+\(en known simply as
+.Em beastie
+\(en to the right of the boot loader menu.
In illumos based systems, the distribution specific logo is used.
The commands of
.Nm
diff --git a/usr/src/man/man5/eqn.5 b/usr/src/man/man5/eqn.5
index 5fcf9ec3ea..ea8f4ed220 100644
--- a/usr/src/man/man5/eqn.5
+++ b/usr/src/man/man5/eqn.5
@@ -1,4 +1,4 @@
-.\" $Id: eqn.7,v 1.35 2015/03/30 16:06:14 schwarze Exp $
+.\" $Id: eqn.7,v 1.36 2017/07/20 11:07:27 schwarze Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: March 30 2015 $
+.Dd $Mdocdate: July 20 2017 $
.Dt EQN 5
.Os
.Sh NAME
@@ -125,7 +125,7 @@ int (integral), sum (summation), grad (gradient), del (vector
differential), times (multiply), cdot (center-dot), nothing (zero-width
space), approx (approximately equals), prime (prime), half (one-half),
partial (partial differential), inf (infinity), >> (much greater), <<
-(much less), \-> (left arrow), <\- (right arrow), +\- (plus-minus), !=
+(much less), <\- (left arrow), \-> (right arrow), +\- (plus-minus), !=
(not equal), == (equivalence), <= (less-than-equal), and >=
(more-than-equal).
The character escape sequences documented in
diff --git a/usr/src/man/man5/loader.5 b/usr/src/man/man5/loader.5
index 655e4ad955..b65ab25ed9 100644
--- a/usr/src/man/man5/loader.5
+++ b/usr/src/man/man5/loader.5
@@ -621,7 +621,7 @@ Evaluates the remainder of the input buffer under a
exception guard.
.It Ic .#
Works like
-.Ic "."
+.Ic \&.
but without outputting a trailing space.
.It Ic fclose Pq Ar fd --
Closes a file.
diff --git a/usr/src/man/man5/mandoc_char.5 b/usr/src/man/man5/mandoc_char.5
index 16b1f4b94f..3ccf3bf7df 100644
--- a/usr/src/man/man5/mandoc_char.5
+++ b/usr/src/man/man5/mandoc_char.5
@@ -1,8 +1,8 @@
-.\" $Id: mandoc_char.7,v 1.64 2017/02/05 21:41:21 schwarze Exp $
+.\" $Id: mandoc_char.7,v 1.67 2017/06/14 20:57:07 schwarze Exp $
.\"
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2011, 2013, 2015 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2011, 2013, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -16,7 +16,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: February 5 2017 $
+.Dd $Mdocdate: June 14 2017 $
.Dt MANDOC_CHAR 5
.Os
.Sh NAME
@@ -169,6 +169,8 @@ even on request and macro lines.
.Ss Accents
In output modes supporting such special output characters, for example
.Fl T Cm pdf ,
+and sometimes less consistently in
+.Fl T Cm utf8 ,
some
.Xr mandoc_roff 5
formatters convert the following ASCII input characters to the
@@ -177,6 +179,7 @@ following Unicode special output characters:
.It \(ga Ta U+2018 Ta left single quotation mark
.It \(aq Ta U+2019 Ta right single quotation mark
.It \(ti Ta U+02DC Ta small tilde
+.It \(ha Ta U+02C6 Ta modifier letter circumflex
.El
.Pp
In prose, this automatic substitution is often desirable;
@@ -187,6 +190,7 @@ escaping to render as follows:
.It \e(ga Ta U+0060 Ta grave accent
.It \e(aq Ta U+0027 Ta apostrophe
.It \e(ti Ta U+007E Ta tilde
+.It \e(ha Ta U+005E Ta circumflex accent
.El
.Ss Periods
The period
@@ -256,6 +260,7 @@ Lines:
.It \e(ba Ta \(ba Ta bar
.It \e(br Ta \(br Ta box rule
.It \e(ul Ta \(ul Ta underscore
+.It \e(ru Ta \(ru Ta underscore (width 0.5m)
.It \e(rn Ta \(rn Ta overline
.It \e(bb Ta \(bb Ta broken bar
.It \e(sl Ta \(sl Ta forward slash
@@ -279,6 +284,10 @@ Text markers:
.It \e(sh Ta \(sh Ta hash (pound)
.It \e(CR Ta \(CR Ta carriage return
.It \e(OK Ta \(OK Ta check mark
+.It \e(CL Ta \(CL Ta club suit
+.It \e(SP Ta \(SP Ta spade suit
+.It \e(HE Ta \(HE Ta heart suit
+.It \e(DI Ta \(DI Ta diamond suit
.El
.Pp
Legal symbols:
@@ -372,6 +381,7 @@ Arrows:
.It \e(uA Ta \(uA Ta up double-arrow
.It \e(dA Ta \(dA Ta down double-arrow
.It \e(vA Ta \(vA Ta up-down double-arrow
+.It \e(an Ta \(an Ta horizontal arrow extension
.El
.Pp
Logical:
@@ -450,11 +460,20 @@ Mathematical:
.It \e(Ah Ta \(Ah Ta aleph
.It \e(Im Ta \(Im Ta imaginary
.It \e(Re Ta \(Re Ta real
+.It \e(wp Ta \(wp Ta Weierstrass p
.It \e(pd Ta \(pd Ta partial differential
.It \e(-h Ta \(-h Ta Planck constant over 2\(*p
-.It \e[12] Ta \[12] Ta one-half
-.It \e[14] Ta \[14] Ta one-fourth
-.It \e[34] Ta \[34] Ta three-fourths
+.It \e[hbar] Ta \[hbar] Ta Planck constant over 2\(*p
+.It \e(12 Ta \(12 Ta one-half
+.It \e(14 Ta \(14 Ta one-fourth
+.It \e(34 Ta \(34 Ta three-fourths
+.It \e(18 Ta \(18 Ta one-eighth
+.It \e(38 Ta \(38 Ta three-eighths
+.It \e(58 Ta \(58 Ta five-eighths
+.It \e(78 Ta \(78 Ta seven-eighths
+.It \e(S1 Ta \(S1 Ta superscript 1
+.It \e(S2 Ta \(S2 Ta superscript 2
+.It \e(S3 Ta \(S3 Ta superscript 3
.El
.Pp
Ligatures:
@@ -588,6 +607,8 @@ Units:
.It \e(fm Ta \(fm Ta minute
.It \e(sd Ta \(sd Ta second
.It \e(mc Ta \(mc Ta micro
+.It \e(Of Ta \(Of Ta Spanish female ordinal
+.It \e(Om Ta \(Om Ta Spanish masculine ordinal
.El
.Pp
Greek letters:
@@ -748,9 +769,7 @@ the
differently between mandoc and groff.
.It
In
-.Fl T Ns Cm html
-and
-.Fl T Ns Cm xhtml ,
+.Fl T Ns Cm html ,
the \e(\(ti=, \e(nb, and \e(nc special characters render differently
between mandoc and groff.
.It
diff --git a/usr/src/man/man5/mandoc_roff.5 b/usr/src/man/man5/mandoc_roff.5
index 471c82e5ce..cbc507542f 100644
--- a/usr/src/man/man5/mandoc_roff.5
+++ b/usr/src/man/man5/mandoc_roff.5
@@ -1,7 +1,7 @@
-.\" $Id: roff.7,v 1.75 2015/09/24 18:41:22 schwarze Exp $
+.\" $Id: roff.7,v 1.94 2017/07/05 12:25:17 schwarze Exp $
.\"
.\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2010, 2011, 2013-2015 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010,2011,2013-2015,2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -15,8 +15,8 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: September 24 2015 $
-.Dt MANDOC_ROFF 5
+.Dd $Mdocdate: July 5 2017 $
+.Dt ROFF 5
.Os
.Sh NAME
.Nm roff
@@ -80,7 +80,7 @@ Lines not beginning with control characters are called
They provide free-form text to be printed; the formatting of the text
depends on the respective processing context.
.Sh LANGUAGE SYNTAX
-.Nm roff
+.Nm
documents may contain only graphable 7-bit ASCII characters, the space
character, and, in certain circumstances, the tab character.
The backslash character
@@ -180,7 +180,7 @@ single-character
two-character
.Sq \e*(XX ,
and N-character
-.Sq \e*[N] .
+.Sq \e* Ns Bq N .
.Pp
Examples:
.Bl -tag -width Ds -offset indent -compact
@@ -397,219 +397,218 @@ The
parser recognises the following requests.
For requests marked as "ignored" or "unsupported", any arguments are
ignored, and the number of arguments is not checked.
-.Ss \&ab
+.Bl -tag -width Ds
+.It Ic \&ab Op Ar message
Abort processing.
Currently unsupported.
-.Ss \&ad
-Set line adjustment mode.
-It takes one argument to select normal, left, right,
-or center adjustment for subsequent text.
+.It Ic \&ad Op Cm b | c | l | n | r
+Set line adjustment mode for subsequent text.
Currently ignored.
-.Ss \&af
+.It Ic \&af Ar registername format
Assign an output format to a number register.
Currently ignored.
-.Ss \&aln
+.It Ic \&aln Ar newname oldname
Create an alias for a number register.
Currently unsupported.
-.Ss \&als
+.It Ic \&als Ar newname oldname
Create an alias for a request, string, macro, or diversion.
-Currently unsupported.
-.Ss \&am
+.It Ic \&am Ar macroname Op Ar endmacro
Append to a macro definition.
The syntax of this request is the same as that of
-.Sx \&de .
-.Ss \&am1
+.Ic \&de .
+.It Ic \&am1 Ar macroname Op Ar endmacro
Append to a macro definition, switching roff compatibility mode off
during macro execution (groff extension).
The syntax of this request is the same as that of
-.Sx \&de1 .
+.Ic \&de1 .
Since
.Xr mandoc 1
does not implement
.Nm
compatibility mode at all, it handles this request as an alias for
-.Sx \&am .
-.Ss \&ami
+.Ic \&am .
+.It Ic \&ami Ar macrostring Op Ar endstring
Append to a macro definition, specifying the macro name indirectly
(groff extension).
The syntax of this request is the same as that of
-.Sx \&dei .
-.Ss \&ami1
+.Ic \&dei .
+.It Ic \&ami1 Ar macrostring Op Ar endstring
Append to a macro definition, specifying the macro name indirectly
and switching roff compatibility mode off during macro execution
(groff extension).
The syntax of this request is the same as that of
-.Sx \&dei1 .
+.Ic \&dei1 .
Since
.Xr mandoc 1
does not implement
.Nm
compatibility mode at all, it handles this request as an alias for
-.Sx \&ami .
-.Ss \&as
+.Ic \&ami .
+.It Ic \&as Ar stringname Op Ar string
Append to a user-defined string.
The syntax of this request is the same as that of
.Sx \&ds .
If a user-defined string with the specified name does not yet exist,
it is set to the empty string before appending.
-.Ss \&as1
+.It Ic \&as1 Ar stringname Op Ar string
Append to a user-defined string, switching roff compatibility mode off
during macro execution (groff extension).
The syntax of this request is the same as that of
-.Sx \&ds1 .
+.Ic \&ds1 .
Since
.Xr mandoc 1
does not implement
.Nm
compatibility mode at all, it handles this request as an alias for
-.Sx \&as .
-.Ss \&asciify
+.Ic \&as .
+.It Ic \&asciify Ar divname
Fully unformat a diversion.
Currently unsupported.
-.Ss \&backtrace
+.It Ic \&backtrace
Print a backtrace of the input stack.
This is a groff extension and currently ignored.
-.Ss \&bd
+.It Ic \&bd Ar font Oo Ar curfont Oc Op Ar offset
Artificially embolden by repeated printing with small shifts.
Currently ignored.
-.Ss \&bleedat
+.It Ic \&bleedat Ar left top width height
Set the BleedBox page parameter for PDF generation.
This is a Heirloom extension and currently ignored.
-.Ss \&blm
+.It Ic \&blm Ar macroname
Set a blank line trap.
Currently unsupported.
-.Ss \&box
+.It Ic \&box Ar divname
Begin a diversion without including a partially filled line.
Currently unsupported.
-.Ss \&boxa
+.It Ic \&boxa Ar divname
Add to a diversion without including a partially filled line.
Currently unsupported.
-.Ss \&bp
-Begin new page.
+.It Ic \&bp Oo Cm + Ns | Ns Cm - Oc Ns Ar pagenumber
+Begin a new page.
Currently ignored.
-.Ss \&BP
+.It Ic \&BP Ar source height width position offset flags label
Define a frame and place a picture in it.
This is a Heirloom extension and currently unsupported.
-.Ss \&br
+.It Ic \&br
Break the output line.
-See
-.Xr man 5
-and
-.Xr mdoc 5 .
-.Ss \&break
+.It Ic \&break
Break out of a
-.Sx \&while
+.Ic \&while
loop.
Currently unsupported.
-.Ss \&breakchar
+.It Ic \&breakchar Ar char ...
Optional line break characters.
This is a Heirloom extension and currently ignored.
-.Ss \&brnl
-Break output line after next N input lines.
+.It Ic \&brnl Ar N
+Break output line after the next
+.Ar N
+input lines.
This is a Heirloom extension and currently ignored.
-.Ss \&brp
+.It Ic \&brp
Break and spread output line.
Currently, this is implemented as an alias for
-.Sx \&br .
-.Ss \&brpnl
-Break and spread output line after next N input lines.
+.Ic \&br .
+.It Ic \&brpnl Ar N
+Break and spread output line after the next
+.Ar N
+input lines.
This is a Heirloom extension and currently ignored.
-.Ss \&c2
+.It Ic \&c2 Op Ar char
Change the no-break control character.
Currently unsupported.
-.Ss \&cc
+.It Ic \&cc Op Ar char
Change the control character.
-Its syntax is as follows:
-.Bd -literal -offset indent
-.Pf . Cm \&cc Op Ar c
-.Ed
-.Pp
If
-.Ar c
+.Ar char
is not specified, the control character is reset to
.Sq \&. .
Trailing characters are ignored.
-.Ss \&ce
-Center some lines.
-It takes one integer argument, specifying how many lines to center.
-Currently ignored.
-.Ss \&cf
+.It Ic \&ce Op Ar N
+Center the next
+.Ar N
+input lines without filling.
+.Ar N
+defaults to 1.
+An argument of 0 or less ends centering.
+Currently, high level macros abort centering.
+.It Ic \&cf Ar filename
Output the contents of a file.
Ignored because insecure.
-.Ss \&cflags
+.It Ic \&cflags Ar flags char ...
Set character flags.
This is a groff extension and currently ignored.
-.Ss \&ch
+.It Ic \&ch Ar macroname Op Ar dist
Change a trap location.
Currently ignored.
-.Ss \&char
+.It Ic \&char Ar glyphname Op Ar string
Define a new glyph.
Currently unsupported.
-.Ss \&chop
+.It Ic \&chop Ar stringname
Remove the last character from a macro, string, or diversion.
Currently unsupported.
-.Ss \&class
+.It Ic \&class Ar classname char ...
Define a character class.
This is a groff extension and currently ignored.
-.Ss \&close
+.It Ic \&close Ar streamname
Close an open file.
Ignored because insecure.
-.Ss \&CL
+.It Ic \&CL Ar color text
Print text in color.
This is a Heirloom extension and currently unsupported.
-.Ss \&color
+.It Ic \&color Op Cm 1 | 0
Activate or deactivate colors.
This is a groff extension and currently ignored.
-.Ss \&composite
+.It Ic \&composite Ar from to
Define a name component for composite glyph names.
This is a groff extension and currently unsupported.
-.Ss \&continue
+.It Ic \&continue
Immediately start the next iteration of a
-.Sx \&while
+.Ic \&while
loop.
Currently unsupported.
-.Ss \&cp
+.It Ic \&cp Op Cm 1 | 0
Switch
.Nm
compatibility mode on or off.
Currently ignored.
-.Ss \&cropat
+.It Ic \&cropat Ar left top width height
Set the CropBox page parameter for PDF generation.
This is a Heirloom extension and currently ignored.
-.Ss \&cs
+.It Ic \&cs Ar font Op Ar width Op Ar emsize
Constant character spacing mode.
Currently ignored.
-.Ss \&cu
-Underline including whitespace.
+.It Ic \&cu Op Ar N
+Underline next
+.Ar N
+input lines including whitespace.
Currently ignored.
-.Ss \&da
+.It Ic \&da Ar divname
Append to a diversion.
Currently unsupported.
-.Ss \&dch
+.It Ic \&dch Ar macroname Op Ar dist
Change a trap location in the current diversion.
This is a Heirloom extension and currently unsupported.
-.Ss \&de
+.It Ic \&de Ar macroname Op Ar endmacro
Define a
.Nm
macro.
Its syntax can be either
.Bd -literal -offset indent
-.Pf . Cm \&de Ar name
-.Ar macro definition
+.Pf . Ic \&de Ar macroname
+.Ar definition
\&..
.Ed
.Pp
or
.Bd -literal -offset indent
-.Pf . Cm \&de Ar name Ar end
-.Ar macro definition
-.Pf . Ar end
+.Pf . Ic \&de Ar macroname Ar endmacro
+.Ar definition
+.Pf . Ar endmacro
.Ed
.Pp
Both forms define or redefine the macro
-.Ar name
+.Ar macroname
to represent the
-.Ar macro definition ,
+.Ar definition ,
which may consist of one or more input lines, including the newline
characters terminating each line, optionally containing calls to
.Nm
@@ -622,13 +621,13 @@ or
macros, whichever applies to the document in question.
.Pp
Specifying a custom
-.Ar end
+.Ar endmacro
macro works in the same way as for
-.Sx \&ig ;
+.Ic \&ig ;
namely, the call to
-.Sq Pf . Ar end
+.Sq Pf . Ar endmacro
first ends the
-.Ar macro definition ,
+.Ar definition ,
and after that, it is also evaluated as a
.Nm
request or
@@ -637,7 +636,7 @@ macro, but not as a high-level macro.
.Pp
The macro can be invoked later using the syntax
.Pp
-.D1 Pf . Ar name Op Ar argument Op Ar argument ...
+.D1 Pf . Ar macroname Op Ar argument Op Ar argument ...
.Pp
Regarding argument parsing, see
.Sx MACRO SYNTAX
@@ -645,7 +644,7 @@ above.
.Pp
The line invoking the macro will be replaced
in the input stream by the
-.Ar macro definition ,
+.Ar definition ,
replacing all occurrences of
.No \e\e$ Ns Ar N ,
where
@@ -670,15 +669,15 @@ joined together with single blank characters.
.Pp
Since macros and user-defined strings share a common string table,
defining a macro
-.Ar name
+.Ar macroname
clobbers the user-defined string
-.Ar name ,
+.Ar macroname ,
and the
-.Ar macro definition
+.Ar definition
can also be printed using the
.Sq \e*
string interpolation syntax described below
-.Sx ds ,
+.Ic ds ,
but this is rarely useful because every macro definition contains at least
one explicit newline character.
.Pp
@@ -689,7 +688,7 @@ to a large, but finite number, and
.Xr mandoc 1
also limits the length of the expanded input line.
Do not rely on the exact values of these limits.
-.Ss \&de1
+.It Ic \&de1 Ar macroname Op Ar endmacro
Define a
.Nm
macro that will be executed with
@@ -701,24 +700,20 @@ Since
does not implement
.Nm
compatibility mode at all, it handles this request as an alias for
-.Sx \&de .
-.Ss \&defcolor
+.Ic \&de .
+.It Ic \&defcolor Ar newname scheme component ...
Define a color name.
This is a groff extension and currently ignored.
-.Ss \&dei
+.It Ic \&dei Ar macrostring Op Ar endstring
Define a
.Nm
macro, specifying the macro name indirectly (groff extension).
The syntax of this request is the same as that of
-.Sx \&de .
-The request
-.Pp
-.D1 Pf . Cm \&dei Ar name Op Ar end
-.Pp
-has the same effect as:
+.Ic \&de .
+The effect is the same as:
.Pp
-.D1 Pf . Cm \&de No \e* Ns Bo Ar name Bc Op \e* Ns Bq Ar end
-.Ss \&dei1
+.D1 Pf . Cm \&de No \e* Ns Bo Ar macrostring Bc Op \e* Ns Bq Ar endstring
+.It Ic \&dei1 Ar macrostring Op Ar endstring
Define a
.Nm
macro that will be executed with
@@ -730,29 +725,23 @@ Since
does not implement
.Nm
compatibility mode at all, it handles this request as an alias for
-.Sx \&dei .
-.Ss \&device
-This request only makes sense with the groff-specific intermediate
-output format and is unsupported.
-.Ss \&devicem
-This request only makes sense with the groff-specific intermediate
-output format and is unsupported.
-.Ss \&di
+.Ic \&dei .
+.It Ic \&device Ar string ...
+.It Ic \&devicem Ar stringname
+These two requests only make sense with the groff-specific intermediate
+output format and are unsupported.
+.It Ic \&di Ar divname
Begin a diversion.
Currently unsupported.
-.Ss \&do
+.It Ic \&do Ar command Op Ar argument ...
Execute
.Nm
request or macro line with compatibility mode disabled.
Currently unsupported.
-.Ss \&ds
+.It Ic \&ds Ar stringname Op Oo \(dq Oc Ns Ar string
Define a user-defined string.
-Its syntax is as follows:
-.Pp
-.D1 Pf . Cm \&ds Ar name Oo \(dq Oc Ns Ar string
-.Pp
The
-.Ar name
+.Ar stringname
and
.Ar string
arguments are space-separated.
@@ -767,11 +756,11 @@ including whitespace and double-quote characters, even trailing ones.
The
.Ar string
can be interpolated into subsequent text by using
-.No \e* Ns Bq Ar name
+.No \e* Ns Bq Ar stringname
for a
-.Ar name
+.Ar stringname
of arbitrary length, or \e*(NN or \e*N if the length of
-.Ar name
+.Ar stringname
is two or one characters, respectively.
Interpolation can be prevented by escaping the leading backslash;
that is, an asterisk preceded by an even number of backslashes
@@ -779,11 +768,11 @@ does not trigger string interpolation.
.Pp
Since user-defined strings and macros share a common string table,
defining a string
-.Ar name
+.Ar stringname
clobbers the macro
-.Ar name ,
+.Ar stringname ,
and the
-.Ar name
+.Ar stringname
used for defining a string can also be invoked as a macro,
in which case the following input line will be appended to the
.Ar string ,
@@ -798,12 +787,12 @@ H SYNOPSIS
.Ed
.Pp
invokes the
-.Cm SH
+.Ic SH
macro when used in a
.Xr man 5
document.
Such abuse is of course strongly discouraged.
-.Ss \&ds1
+.It Ic \&ds1 Ar stringname Op Oo \(dq Oc Ns Ar string
Define a user-defined string that will be expanded with
.Nm
compatibility mode switched off during string expansion.
@@ -813,125 +802,122 @@ Since
does not implement
.Nm
compatibility mode at all, it handles this request as an alias for
-.Sx \&ds .
-.Ss \&dwh
+.Ic \&ds .
+.It Ic \&dwh Ar dist macroname
Set a location trap in the current diversion.
This is a Heirloom extension and currently unsupported.
-.Ss \&dt
+.It Ic \&dt Op Ar dist macroname
Set a trap within a diversion.
Currently unsupported.
-.Ss \&ec
-Change the escape character.
-Currently unsupported.
-.Ss \&ecs
+.It Ic \&ec Op Ar char
+Enable the escape mechanism and change the escape character.
+The
+.Ar char
+argument defaults to the backslash
+.Pq Sq \e .
+.It Ic \&ecr
Restore the escape character.
Currently unsupported.
-.Ss \&ecr
+.It Ic \&ecs
Save the escape character.
Currently unsupported.
-.Ss \&el
+.It Ic \&el Ar body
The
-.Qq else
+.Dq else
half of an if/else conditional.
Pops a result off the stack of conditional evaluations pushed by
-.Sx \&ie
+.Ic \&ie
and uses it as its conditional.
If no stack entries are present (e.g., due to no prior
-.Sx \&ie
+.Ic \&ie
calls)
then false is assumed.
The syntax of this request is similar to
-.Sx \&if
+.Ic \&if
except that the conditional is missing.
-.Ss \&em
+.It Ic \&em Ar macroname
Set a trap at the end of input.
Currently unsupported.
-.Ss \&EN
+.It Ic \&EN
End an equation block.
See
-.Sx \&EQ .
-.Ss \&eo
+.Ic \&EQ .
+.It Ic \&eo
Disable the escape mechanism completely.
-Currently unsupported.
-.Ss \&EP
+.It Ic \&EP
End a picture started by
-.Sx \&BP .
+.Ic \&BP .
This is a Heirloom extension and currently unsupported.
-.Ss \&EQ
+.It Ic \&EQ
Begin an equation block.
See
.Xr eqn 5
for a description of the equation language.
-.Ss \&errprint
+.It Ic \&errprint Ar message
Print a string like an error message.
This is a Heirloom extension and currently ignored.
-.Ss \&ev
+.It Ic \&ev Op Ar envname
Switch to another environment.
Currently unsupported.
-.Ss \&evc
+.It Ic \&evc Op Ar envname
Copy an environment into the current environment.
Currently unsupported.
-.Ss \&ex
+.It Ic \&ex
Abort processing and exit.
Currently unsupported.
-.Ss \&fallback
+.It Ic \&fallback Ar curfont font ...
Select the fallback sequence for a font.
This is a Heirloom extension and currently ignored.
-.Ss \&fam
+.It Ic \&fam Op Ar familyname
Change the font family.
-Takes one argument specifying the font family to be selected.
-It is a groff extension and currently ignored.
-.Ss \&fc
+This is a groff extension and currently ignored.
+.It Ic \&fc Op Ar delimchar Op Ar padchar
Define a delimiting and a padding character for fields.
Currently unsupported.
-.Ss \&fchar
+.It Ic \&fchar Ar glyphname Op Ar string
Define a fallback glyph.
Currently unsupported.
-.Ss \&fcolor
+.It Ic \&fcolor Ar colorname
Set the fill color for \eD objects.
This is a groff extension and currently ignored.
-.Ss \&fdeferlig
+.It Ic \&fdeferlig Ar font string ...
Defer ligature building.
This is a Heirloom extension and currently ignored.
-.Ss \&feature
+.It Ic \&feature Cm + Ns | Ns Cm - Ns Ar name
Enable or disable an OpenType feature.
This is a Heirloom extension and currently ignored.
-.Ss \&fi
+.It Ic \&fi
Switch to fill mode.
See
.Xr man 5 .
Ignored in
.Xr mdoc 5 .
-.Ss \&fkern
+.It Ic \&fkern Ar font minkern
Control the use of kerning tables for a font.
This is a Heirloom extension and currently ignored.
-.Ss \&fl
+.It Ic \&fl
Flush output.
Currently ignored.
-.Ss \&flig
+.It Ic \&flig Ar font string char ...
Define ligatures.
This is a Heirloom extension and currently ignored.
-.Ss \&fp
+.It Ic \&fp Ar position font Op Ar filename
Assign font position.
Currently ignored.
-.Ss \&fps
+.It Ic \&fps Ar mapname ...
Mount a font with a special character map.
This is a Heirloom extension and currently ignored.
-.Ss \&fschar
+.It Ic \&fschar Ar font glyphname Op Ar string
Define a font-specific fallback glyph.
This is a groff extension and currently unsupported.
-.Ss \&fspacewidth
+.It Ic \&fspacewidth Ar font Op Ar afmunits
Set a font-specific width for the space character.
This is a Heirloom extension and currently ignored.
-.Ss \&fspecial
+.It Ic \&fspecial Ar curfont Op Ar font ...
Conditionally define a special font.
This is a groff extension and currently ignored.
-.Ss \&ft
+.It Ic \&ft Op Ar font
Change the font.
-Its syntax is as follows:
-.Pp
-.D1 Pf . Cm \&ft Op Ar font
-.Pp
The following
.Ar font
arguments are supported:
@@ -950,91 +936,88 @@ switches to normal font
switches back to the previous font
.El
.Pp
-This request takes effect only locally, may be overridden by macros
-and escape sequences, and is only supported in
-.Xr man 5
-for now.
-.Ss \&ftr
+This request takes effect only locally and may be overridden
+by macros and escape sequences.
+.It Ic \&ftr Ar newname Op Ar oldname
Translate font name.
This is a groff extension and currently ignored.
-.Ss \&fzoom
+.It Ic \&fzoom Ar font Op Ar permille
Zoom font size.
Currently ignored.
-.Ss \&gcolor
+.It Ic \&gcolor Op Ar colorname
Set glyph color.
This is a groff extension and currently ignored.
-.Ss \&hc
+.It Ic \&hc Op Ar char
Set the hyphenation character.
Currently ignored.
-.Ss \&hcode
+.It Ic \&hcode Ar char code ...
Set hyphenation codes of characters.
Currently ignored.
-.Ss \&hidechar
+.It Ic \&hidechar Ar font char ...
Hide characters in a font.
This is a Heirloom extension and currently ignored.
-.Ss \&hla
+.It Ic \&hla Ar language
Set hyphenation language.
This is a groff extension and currently ignored.
-.Ss \&hlm
+.It Ic \&hlm Op Ar number
Set maximum number of consecutive hyphenated lines.
Currently ignored.
-.Ss \&hpf
+.It Ic \&hpf Ar filename
Load hyphenation pattern file.
This is a groff extension and currently ignored.
-.Ss \&hpfa
+.It Ic \&hpfa Ar filename
Load hyphenation pattern file, appending to the current patterns.
This is a groff extension and currently ignored.
-.Ss \&hpfcode
+.It Ic \&hpfcode Ar code code ...
Define mapping values for character codes in hyphenation patterns.
This is a groff extension and currently ignored.
-.Ss \&hw
+.It Ic \&hw Ar word ...
Specify hyphenation points in words.
Currently ignored.
-.Ss \&hy
+.It Ic \&hy Op Ar mode
Set automatic hyphenation mode.
Currently ignored.
-.Ss \&hylang
+.It Ic \&hylang Ar language
Set hyphenation language.
This is a Heirloom extension and currently ignored.
-.Ss \&hylen
+.It Ic \&hylen Ar nchar
Minimum word length for hyphenation.
This is a Heirloom extension and currently ignored.
-.Ss \&hym
+.It Ic \&hym Op Ar length
Set hyphenation margin.
This is a groff extension and currently ignored.
-.Ss \&hypp
+.It Ic \&hypp Ar penalty ...
Define hyphenation penalties.
This is a Heirloom extension and currently ignored.
-.Ss \&hys
+.It Ic \&hys Op Ar length
Set hyphenation space.
This is a groff extension and currently ignored.
-.Ss \&ie
+.It Ic \&ie Ar condition body
The
-.Qq if
+.Dq if
half of an if/else conditional.
The result of the conditional is pushed into a stack used by subsequent
invocations of
-.Sx \&el ,
+.Ic \&el ,
which may be separated by any intervening input (or not exist at all).
Its syntax is equivalent to
-.Sx \&if .
-.Ss \&if
-Begins a conditional.
-This request has the following syntax:
-.Bd -literal -offset indent
-\&.if COND BODY
+.Ic \&if .
+.It Ic \&if Ar condition body
+Begin a conditional.
+This request can also be written as follows:
+.Bd -unfilled -offset indent
+.Pf . Ic \&if Ar condition No \e{ Ns Ar body
+.Ar body ... Ns \e}
.Ed
-.Bd -literal -offset indent
-\&.if COND \e{BODY
-BODY...\e}
-.Ed
-.Bd -literal -offset indent
-\&.if COND \e{\e
-BODY...
-\&.\e}
+.Bd -unfilled -offset indent
+.Pf . Ic \&if Ar condition No \e{\e
+.Ar body ...
+.Pf . No \e}
.Ed
.Pp
-COND is a conditional statement.
+The
+.Ar condition
+is a boolean expression.
Currently,
.Xr mandoc 1
supports the following subset of roff conditionals:
@@ -1042,21 +1025,25 @@ supports the following subset of roff conditionals:
.It
If
.Sq \&!
-is prefixed to COND, the condition is logically inverted.
+is prefixed to
+.Ar condition ,
+it is logically inverted.
.It
-If the first character of COND is
+If the first character of
+.Ar condition
+is
.Sq n
.Pq nroff mode
or
.Sq o
.Pq odd page ,
-COND evaluates to true.
+it evaluates to true.
.It
-If the first character of COND is
+If the first character of
+.Ar condition
+is
.Sq c
.Pq character available ,
-.Sq d
-.Pq string defined ,
.Sq e
.Pq even page ,
.Sq t
@@ -1064,26 +1051,44 @@ If the first character of COND is
or
.Sq v
.Pq vroff mode ,
-COND evaluates to false.
+it evaluates to false.
+.It
+If the first character of
+.Ar condition
+is
+.Sq d ,
+it evaluates to true if the rest of
+.Ar condition
+is the name of an existing user defined macro or string;
+otherwise, it evaluates to false.
.It
-If the first character of COND is
+If the first character of
+.Ar condition
+is
.Sq r ,
-it evaluates to true if the rest of COND is the name of an existing
-number register; otherwise, it evaluates to false.
+it evaluates to true if the rest of
+.Ar condition
+is the name of an existing number register;
+otherwise, it evaluates to false.
.It
-If COND starts with a parenthesis or with an optionally signed
+If the
+.Ar condition
+starts with a parenthesis or with an optionally signed
integer number, it is evaluated according to the rules of
.Sx Numerical expressions
explained below.
It evaluates to true if the result is positive,
or to false if the result is zero or negative.
.It
-Otherwise, the first character of COND is regarded as a delimiter
-and COND evaluates to true if the string extending from its first
-to its second occurrence is equal to the string extending from its
-second to its third occurrence.
+Otherwise, the first character of
+.Ar condition
+is regarded as a delimiter and it evaluates to true if the string
+extending from its first to its second occurrence is equal to the
+string extending from its second to its third occurrence.
.It
-If COND cannot be parsed, it evaluates to false.
+If
+.Ar condition
+cannot be parsed, it evaluates to false.
.El
.Pp
If a conditional is false, its children are not processed, but are
@@ -1104,28 +1109,33 @@ conditional.
Sub-conditionals, in this case, obviously inherit the truth value of
the parent.
.Pp
-If the BODY section is begun by an escaped brace
+If the
+.Ar body
+section is begun by an escaped brace
.Sq \e{ ,
scope continues until the end of the input line containing the
matching closing-brace escape sequence
.Sq \e} .
-If the BODY is not enclosed in braces, scope continues until
-the end of the line.
-If the COND is followed by a BODY on the same line, whether after a
-brace or not, then requests and macros
+If the
+.Ar body
+is not enclosed in braces, scope continues until the end of the line.
+If the
+.Ar condition
+is followed by a
+.Ar body
+on the same line, whether after a brace or not, then requests and macros
.Em must
begin with a control character.
It is generally more intuitive, in this case, to write
-.Bd -literal -offset indent
-\&.if COND \e{\e
-\&.foo
-bar
-\&.\e}
+.Bd -unfilled -offset indent
+.Pf . Ic \&if Ar condition No \e{\e
+.Pf . Ar request
+.Pf . No \e}
.Ed
.Pp
than having the request or macro follow as
.Pp
-.D1 \&.if COND \e{ .foo
+.D1 Pf . Ic \&if Ar condition Pf \e{. Ar request
.Pp
The scope of a conditional is always parsed, but only executed if the
conditional evaluates to true.
@@ -1144,7 +1154,7 @@ will result in
being considered an argument of the
.Sq \&Fl
macro.
-.Ss \&ig
+.It Ic \&ig Op Ar endmacro
Ignore input.
Its syntax can be either
.Bd -literal -offset indent
@@ -1155,31 +1165,31 @@ Its syntax can be either
.Pp
or
.Bd -literal -offset indent
-.Pf . Cm \&ig Ar end
+.Pf . Cm \&ig Ar endmacro
.Ar ignored text
-.Pf . Ar end
+.Pf . Ar endmacro
.Ed
.Pp
In the first case, input is ignored until a
.Sq \&..
request is encountered on its own line.
In the second case, input is ignored until the specified
-.Sq Pf . Ar end
-macro is encountered.
+.Sq Pf . Ar endmacro
+is encountered.
Do not use the escape character
.Sq \e
anywhere in the definition of
-.Ar end ;
+.Ar endmacro ;
it would cause very strange behaviour.
.Pp
When the
-.Ar end
-macro is a roff request or a roff macro, like in
+.Ar endmacro
+is a roff request or a roff macro, like in
.Pp
.D1 \&.ig if
.Pp
the subsequent invocation of
-.Sx \&if
+.Ic \&if
will first terminate the
.Ar ignored text ,
then be invoked as usual.
@@ -1188,21 +1198,17 @@ Otherwise, it only terminates the
and arguments following it or the
.Sq \&..
request are discarded.
-.Ss \&in
+.It Ic \&in Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
Change indentation.
See
.Xr man 5 .
Ignored in
.Xr mdoc 5 .
-.Ss \&index
+.It Ic \&index Ar register stringname substring
Find a substring in a string.
This is a Heirloom extension and currently unsupported.
-.Ss \&it
+.It Ic \&it Ar expression macro
Set an input line trap.
-Its syntax is as follows:
-.Pp
-.D1 Pf . Cm it Ar expression macro
-.Pp
The named
.Ar macro
will be invoked after processing the number of input text lines
@@ -1213,63 +1219,59 @@ While evaluating the
the unit suffixes described below
.Sx Scaling Widths
are ignored.
-.Ss \&itc
+.It Ic \&it Ar expression macro
Set an input line trap, not counting lines ending with \ec.
Currently unsupported.
-.Ss \&IX
+.It Ic \&IX Ar class keystring
To support the generation of a table of contents,
.Xr pod2man 1
emits this user-defined macro, usually without defining it.
To avoid reporting large numbers of spurious errors,
.Xr mandoc 1
ignores it.
-.Ss \&kern
+.It Ic \&kern Op Cm 1 | 0
Switch kerning on or off.
Currently ignored.
-.Ss \&kernafter
+.It Ic \&kernafter Ar font char ... afmunits ...
Increase kerning after some characters.
This is a Heirloom extension and currently ignored.
-.Ss \&kernbefore
+.It Ic \&kernbefore Ar font char ... afmunits ...
Increase kerning before some characters.
This is a Heirloom extension and currently ignored.
-.Ss \&kernpair
+.It Ic \&kernpair Ar font char ... font char ... afmunits
Add a kerning pair to the kerning table.
This is a Heirloom extension and currently ignored.
-.Ss \&lc
+.It Ic \&lc Op Ar glyph
Define a leader repetition character.
Currently unsupported.
-.Ss \&lc_ctype
+.It Ic \&lc_ctype Ar localename
Set the
.Dv LC_CTYPE
locale.
This is a Heirloom extension and currently unsupported.
-.Ss \&lds
+.It Ic \&lds Ar macroname string
Define a local string.
This is a Heirloom extension and currently unsupported.
-.Ss \&length
-Count the number of input characters in a user-defined string.
+.It Ic \&length Ar register string
+Count the number of input characters in a string.
Currently unsupported.
-.Ss \&letadj
+.It Ic \&letadj Ar lspmin lshmin letss lspmax lshmax
Dynamic letter spacing and reshaping.
This is a Heirloom extension and currently ignored.
-.Ss \&lf
+.It Ic \&lf Ar lineno Op Ar filename
Change the line number for error messages.
Ignored because insecure.
-.Ss \&lg
+.It Ic \&lg Op Cm 1 | 0
Switch the ligature mechanism on or off.
Currently ignored.
-.Ss \&lhang
+.It Ic \&lhang Ar font char ... afmunits
Hang characters at left margin.
This is a Heirloom extension and currently ignored.
-.Ss \&linetabs
+.It Ic \&linetabs Op Cm 1 | 0
Enable or disable line-tabs mode.
This is a groff extension and currently unsupported.
-.Ss \&ll
+.It Ic \&ll Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
Change the output line length.
-Its syntax is as follows:
-.Pp
-.D1 Pf . Cm \&ll Op Oo +|- Oc Ns Ar width
-.Pp
If the
.Ar width
argument is omitted, the line length is reset to its previous value.
@@ -1281,77 +1283,75 @@ among others because it overrides the
.Xr mandoc 1
.Fl O Cm width
command line option.
-.Ss \&lnr
+.It Ic \&lnr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar value Op Ar increment
Set local number register.
This is a Heirloom extension and currently unsupported.
-.Ss \&lnrf
+.It Ic \&lnrf Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar value Op Ar increment
Set local floating-point register.
This is a Heirloom extension and currently unsupported.
-.Ss \&lpfx
+.It Ic \&lpfx Ar string
Set a line prefix.
This is a Heirloom extension and currently unsupported.
-.Ss \&ls
+.It Ic \&ls Op Ar factor
Set line spacing.
It takes one integer argument specifying the vertical distance of
subsequent output text lines measured in v units.
Currently ignored.
-.Ss \&lsm
+.It Ic \&lsm Ar macroname
Set a leading spaces trap.
This is a groff extension and currently unsupported.
-.Ss \&lt
+.It Ic \&lt Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
Set title line length.
Currently ignored.
-.Ss \&mc
+.It Ic \&mc Ar glyph Op Ar dist
Print margin character in the right margin.
-Currently ignored.
-.Ss \&mediasize
+The
+.Ar dist
+is currently ignored; instead, 1n is used.
+.It Ic \&mediasize Ar media
Set the device media size.
This is a Heirloom extension and currently ignored.
-.Ss \&minss
+.It Ic \&minss Ar width
Set minimum word space.
This is a Heirloom extension and currently ignored.
-.Ss \&mk
+.It Ic \&mk Op Ar register
Mark vertical position.
Currently ignored.
-.Ss \&mso
-Load a macro file.
+.It Ic \&mso Ar filename
+Load a macro file using the search path.
Ignored because insecure.
-.Ss \&na
+.It Ic \&na
Disable adjusting without changing the adjustment mode.
Currently ignored.
-.Ss \&ne
+.It Ic \&ne Op Ar height
Declare the need for the specified minimum vertical space
before the next trap or the bottom of the page.
Currently ignored.
-.Ss \&nf
+.It Ic \&nf
Switch to no-fill mode.
See
.Xr man 5 .
Ignored by
.Xr mdoc 5 .
-.Ss \&nh
+.It Ic \&nh
Turn off automatic hyphenation mode.
Currently ignored.
-.Ss \&nhychar
+.It Ic \&nhychar Ar char ...
Define hyphenation-inhibiting characters.
This is a Heirloom extension and currently ignored.
-.Ss \&nm
+.It Ic \&nm Op Ar start Op Ar inc Op Ar space Op Ar indent
Print line numbers.
Currently unsupported.
-.Ss \&nn
+.It Ic \&nn Op Ar number
Temporarily turn off line numbering.
Currently unsupported.
-.Ss \&nop
+.It Ic \&nop Ar body
Execute the rest of the input line as a request or macro line.
Currently unsupported.
-.Ss \&nr
+.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression
Define or change a register.
A register is an arbitrary string value that defines some sort of state,
which influences parsing and/or formatting.
-Its syntax is as follows:
-.Pp
-.D1 Pf \. Cm \&nr Ar name Oo +|- Oc Ns Ar expression
-.Pp
For the syntax of
.Ar expression ,
see
@@ -1360,8 +1360,8 @@ below.
If it is prefixed by a sign, the register will be
incremented or decremented instead of assigned to.
.Pp
-The following register
-.Ar name
+The following
+.Ar register
is handled specially:
.Bl -tag -width Ds
.It Cm nS
@@ -1378,155 +1378,165 @@ section itself.
Note that starting a new
.Xr mdoc 5
section with the
-.Cm \&Sh
+.Ic \&Sh
macro will reset this register.
.El
-.Ss \&nrf
+.It Xo
+.Ic \&nrf Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression
+.Op Ar increment
+.Xc
Define or change a floating-point register.
This is a Heirloom extension and currently unsupported.
-.Ss \&nroff
+.It Ic \&nroff
Force nroff mode.
This is a groff extension and currently ignored.
-.Ss \&ns
+.It Ic \&ns
Turn on no-space mode.
Currently ignored.
-.Ss \&nx
+.It Ic \&nx Op Ar filename
Abort processing of the current input file and process another one.
Ignored because insecure.
-.Ss \&open
+.It Ic \&open Ar stream file
Open a file for writing.
Ignored because insecure.
-.Ss \&opena
+.It Ic \&opena Ar stream file
Open a file for appending.
Ignored because insecure.
-.Ss \&os
+.It Ic \&os
Output saved vertical space.
Currently ignored.
-.Ss \&output
+.It Ic \&output Ar string
Output directly to intermediate output.
Not supported.
-.Ss \&padj
+.It Ic \&padj Op Cm 1 | 0
Globally control paragraph-at-once adjustment.
This is a Heirloom extension and currently ignored.
-.Ss \&papersize
+.It Ic \&papersize Ar media
Set the paper size.
This is a Heirloom extension and currently ignored.
-.Ss \&pc
+.It Ic \&pc Op Ar char
Change the page number character.
Currently ignored.
-.Ss \&pev
+.It Ic \&pev
Print environments.
This is a groff extension and currently ignored.
-.Ss \&pi
+.It Ic \&pi Ar command
Pipe output to a shell command.
Ignored because insecure.
-.Ss \&PI
+.It Ic \&PI
Low-level request used by
-.Sx \&BP .
+.Ic \&BP .
This is a Heirloom extension and currently unsupported.
-.Ss \&pl
+.It Ic \&pl Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
Change page length.
-Takes one height argument.
-Currently ignored.
-.Ss \&pm
-Print names and sizes of macros, strings, and diversions.
Currently ignored.
-.Ss \&pn
-Change page number of the next page.
+.It Ic \&pm
+Print names and sizes of macros, strings, and diversions
+to standard error output.
Currently ignored.
-.Ss \&pnr
-Print all number registers.
+.It Ic \&pn Oo Cm + Ns | Ns Cm - Oc Ns Ar number
+Change the page number of the next page.
Currently ignored.
-.Ss \&po
-Set horizontal page offset.
+.It Ic \&pnr
+Print all number registers on standard error output.
Currently ignored.
-.Ss \&ps
+.It Ic \&po Op Oo Cm + Ns | Ns Cm - Oc Ns Ar offset
+Set a horizontal page offset.
+If no argument is specified, the page offset is reverted to its
+previous value.
+If a sign is specified, the new page offset is calculated relative
+to the current one; otherwise, it is absolute.
+The argument follows the syntax of
+.Sx Scaling Widths
+and the default scaling unit is
+.Cm m .
+.It Ic \&ps Op Oo Cm + Ns | Ns Cm - Oc Ns size
Change point size.
-Takes one numerical argument.
Currently ignored.
-.Ss \&psbb
+.It Ic \&psbb Ar filename
Retrieve the bounding box of a PostScript file.
Currently unsupported.
-.Ss \&pshape
+.It Ic \&pshape Ar indent length ...
Set a special shape for the current paragraph.
This is a Heirloom extension and currently unsupported.
-.Ss \&pso
+.It Ic \&pso Ar command
Include output of a shell command.
Ignored because insecure.
-.Ss \&ptr
-Print the names and positions of all traps.
+.It Ic \&ptr
+Print the names and positions of all traps on standard error output.
This is a groff extension and currently ignored.
-.Ss \&pvs
+.It Ic \&pvs Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
Change post-vertical spacing.
This is a groff extension and currently ignored.
-.Ss \&rchar
+.It Ic \&rchar Ar glyph ...
Remove glyph definitions.
Currently unsupported.
-.Ss \&rd
+.It Ic \&rd Op Ar prompt Op Ar agument ...
Read from standard input.
Currently ignored.
-.Ss \&recursionlimit
+.It Ic \&recursionlimit Ar maxrec maxtail
Set the maximum stack depth for recursive macros.
This is a Heirloom extension and currently ignored.
-.Ss \&return
+.It Ic \&return Op Ar twice
Exit a macro and return to the caller.
Currently unsupported.
-.Ss \&rfschar
+.It Ic \&rfschar Ar font glyph ...
Remove font-specific fallback glyph definitions.
Currently unsupported.
-.Ss \&rhang
+.It Ic \&rhang Ar font char ... afmunits
Hang characters at right margin.
This is a Heirloom extension and currently ignored.
-.Ss \&rj
-Justify unfilled text to the right margin.
-Currently ignored.
-.Ss \&rm
+.It Ic \&rj Op Ar N
+Justify the next
+.Ar N
+input lines to the right margin without filling.
+.Ar N
+defaults to 1.
+An argument of 0 or less ends right adjustment.
+.It Ic \&rm Ar macroname
Remove a request, macro or string.
-Its syntax is as follows:
-.Pp
-.D1 Pf \. Cm \&rm Ar name
-.Ss \&rn
+.It Ic \&rn Ar oldname newname
Rename a request, macro, diversion, or string.
-Currently unsupported.
-.Ss \&rnn
+In
+.Xr mandoc 1 ,
+user-defined macros,
+.Xr mdoc 5
+and
+.Xr man 5
+macros, and user-defined strings can be renamed, but renaming of
+predefined strings and of
+.Nm
+requests is not supported, and diversions are not implemented at all.
+.It Ic \&rnn Ar oldname newname
Rename a number register.
Currently unsupported.
-.Ss \&rr
+.It Ic \&rr Ar register
Remove a register.
-Its syntax is as follows:
-.Pp
-.D1 Pf \. Cm \&rr Ar name
-.Ss \&rs
+.It Ic \&rs
End no-space mode.
Currently ignored.
-.Ss \&rt
+.It Ic \&rt Op Ar dist
Return to marked vertical position.
Currently ignored.
-.Ss \&schar
+.It Ic \&schar Ar glyph Op Ar string
Define global fallback glyph.
This is a groff extension and currently unsupported.
-.Ss \&sentchar
+.It Ic \&sentchar Ar char ...
Define sentence-ending characters.
This is a Heirloom extension and currently ignored.
-.Ss \&shc
+.It Ic \&shc Op Ar glyph
Change the soft hyphen character.
Currently ignored.
-.Ss \&shift
+.It Ic \&shift Op Ar number
Shift macro arguments.
Currently unsupported.
-.Ss \&sizes
+.It Ic \&sizes Ar size ...
Define permissible point sizes.
This is a groff extension and currently ignored.
-.Ss \&so
+.It Ic \&so Ar filename
Include a source file.
-Its syntax is as follows:
-.Pp
-.D1 Pf \. Cm \&so Ar file
-.Pp
-The
-.Ar file
-will be read and its contents processed as input in place of the
-.Sq \&.so
+The file is read and its contents processed as input in place of the
+.Ic \&so
request line.
To avoid inadvertent inclusion of unrelated files,
.Xr mandoc 1
@@ -1545,168 +1555,184 @@ Typical usage looks like:
.Dl \&.so man3/Xcursor.3
.Pp
As the whole concept is rather fragile, the use of
-.Sx \&so
+.Ic \&so
is discouraged.
Use
.Xr ln 1
instead.
-.Ss \&spacewidth
+.It Ic \&sp Op Ar height
+Break the output line and emit vertical space.
+The argument follows the syntax of
+.Sx Scaling Widths
+and defaults to one blank line
+.Pq Li 1v .
+.It Ic \&spacewidth Op Cm 1 | 0
Set the space width from the font metrics file.
This is a Heirloom extension and currently ignored.
-.Ss \&special
+.It Ic \&special Op Ar font ...
Define a special font.
This is a groff extension and currently ignored.
-.Ss \&spreadwarn
+.It Ic \&spreadwarn Op Ar width
Warn about wide spacing between words.
Currently ignored.
-.Ss \&ss
+.It Ic \&ss Ar wordspace Op Ar sentencespace
Set space character size.
Currently ignored.
-.Ss \&sty
+.It Ic \&sty Ar position style
Associate style with a font position.
This is a groff extension and currently ignored.
-.Ss \&substring
+.It Ic \&substring Ar stringname startpos Op Ar endpos
Replace a user-defined string with a substring.
Currently unsupported.
-.Ss \&sv
+.It Ic \&sv Op Ar height
Save vertical space.
Currently ignored.
-.Ss \&sy
+.It Ic \&sy Ar command
Execute shell command.
Ignored because insecure.
-.Ss \&T&
+.It Ic \&T&
Re-start a table layout, retaining the options of the prior table
invocation.
See
.Sx \&TS .
-.Ss \&ta
+.It Ic \&ta Op Ar width ... Op Cm T Ar width ...
Set tab stops.
-Takes an arbitrary number of arguments.
-Currently unsupported.
-.Ss \&tc
+Each
+.Ar width
+argument follows the syntax of
+.Sx Scaling Widths .
+If prefixed by a plus sign, it is relative to the previous tab stop.
+The arguments after the
+.Cm T
+marker are used repeatedly as often as needed; for each reuse,
+they are taken relative to the last previously established tab stop.
+When
+.Ic \&ta
+is called without arguments, all tab stops are cleared.
+.It Ic \&tc Op Ar glyph
Change tab repetition character.
Currently unsupported.
-.Ss \&TE
+.It Ic \&TE
End a table context.
See
.Sx \&TS .
-.Ss \&ti
-Temporary indent.
-Currently unsupported.
-.Ss \&tkf
+.It Ic \&ti Oo Cm + Ns | Ns Cm - Oc Ns Ar width
+Break the output line and indent the next output line by
+.Ar width .
+If a sign is specified, the temporary indentation is calculated
+relative to the current indentation; otherwise, it is absolute.
+The argument follows the syntax of
+.Sx Scaling Widths
+and the default scaling unit is
+.Cm m .
+.It Ic \&tkf Ar font minps width1 maxps width2
Enable track kerning for a font.
Currently ignored.
-.Ss \&tl
+.It Ic \&tl No \& Ap Ar left Ap Ar center Ap Ar right Ap
Print a title line.
Currently unsupported.
-.Ss \&tm
+.It Ic \&tm Ar string
Print to standard error output.
Currently ignored.
-.Ss \&tm1
+.It Ic \&tm1 Ar string
Print to standard error output, allowing leading blanks.
This is a groff extension and currently ignored.
-.Ss \&tmc
+.It Ic \&tmc Ar string
Print to standard error output without a trailing newline.
This is a groff extension and currently ignored.
-.Ss \&tr
+.It Ic \&tr Ar glyph glyph ...
Output character translation.
-Its syntax is as follows:
-.Pp
-.D1 Pf \. Cm \&tr Ar [ab]+
-.Pp
-Pairs of
-.Ar ab
-characters are replaced
-.Ar ( a
-for
-.Ar b ) .
-Replacement (or origin) characters may also be character escapes; thus,
+The first glyph in each pair is replaced by the second one.
+Character escapes can be used; for example,
.Pp
.Dl tr \e(xx\e(yy
.Pp
replaces all invocations of \e(xx with \e(yy.
-.Ss \&track
+.It Ic \&track Ar font minps width1 maxps width2
Static letter space tracking.
This is a Heirloom extension and currently ignored.
-.Ss \&transchar
+.It Ic \&transchar Ar char ...
Define transparent characters for sentence-ending.
This is a Heirloom extension and currently ignored.
-.Ss \&trf
+.It Ic \&trf Ar filename
Output the contents of a file, disallowing invalid characters.
This is a groff extension and ignored because insecure.
-.Ss \&trimat
+.It Ic \&trimat Ar left top width height
Set the TrimBox page parameter for PDF generation.
This is a Heirloom extension and currently ignored.
-.Ss \&trin
+.It Ic \&trin Ar glyph glyph ...
Output character translation, ignored by
-.Cm \&asciify .
+.Ic \&asciify .
Currently unsupported.
-.Ss \&trnt
+.It Ic \&trnt Ar glyph glyph ...
Output character translation, ignored by \e!.
Currently unsupported.
-.Ss \&troff
+.It Ic \&troff
Force troff mode.
This is a groff extension and currently ignored.
-.Ss \&TS
+.It Ic \&TS
Begin a table, which formats input in aligned rows and columns.
See
.Xr tbl 5
for a description of the tbl language.
-.Ss \&uf
+.It Ic \&uf Ar font
Globally set the underline font.
Currently ignored.
-.Ss \&ul
-Underline.
+.It Ic \&ul Op Ar N
+Underline next
+.Ar N
+input lines.
Currently ignored.
-.Ss \&unformat
+.It Ic \&unformat Ar divname
Unformat spaces and tabs in a diversion.
Currently unsupported.
-.Ss \&unwatch
+.It Ic \&unwatch Ar macroname
Disable notification for string or macro.
This is a Heirloom extension and currently ignored.
-.Ss \&unwatchn
+.It Ic \&unwatchn Ar register
Disable notification for register.
This is a Heirloom extension and currently ignored.
-.Ss \&vpt
+.It Ic \&vpt Op Cm 1 | 0
Enable or disable vertical position traps.
This is a groff extension and currently ignored.
-.Ss \&vs
+.It Ic \&vs Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
Change vertical spacing.
Currently ignored.
-.Ss \&warn
+.It Ic \&warn Ar flags
Set warning level.
Currently ignored.
-.Ss \&warnscale
+.It Ic \&warnscale Ar si
Set the scaling indicator used in warnings.
This is a groff extension and currently ignored.
-.Ss \&watch
+.It Ic \&watch Ar macroname
Notify on change of string or macro.
This is a Heirloom extension and currently ignored.
-.Ss \&watchlength
+.It Ic \&watchlength Ar maxlength
On change, report the contents of macros and strings
up to the specified length.
This is a Heirloom extension and currently ignored.
-.Ss \&watchn
+.It Ic \&watchn Ar register
Notify on change of register.
This is a Heirloom extension and currently ignored.
-.Ss \&wh
+.It Ic \&wh Ar dist Op Ar macroname
Set a page location trap.
Currently unsupported.
-.Ss \&while
+.It Ic \&while Ar condition body
Repeated execution while a condition is true.
Currently unsupported.
-.Ss \&write
+.It Ic \&write Oo \(dq Oc Ns Ar string
Write to an open file.
Ignored because insecure.
-.Ss \&writec
+.It Ic \&writec Oo \(dq Oc Ns Ar string
Write to an open file without appending a newline.
Ignored because insecure.
-.Ss \&writem
+.It Ic \&writem Ar macroname
Write macro or string to an open file.
Ignored because insecure.
-.Ss \&xflag
+.It Ic \&xflag Ar level
Set the extension level.
This is a Heirloom extension and currently ignored.
+.El
.Ss Numerical expressions
The
.Sx \&nr ,
@@ -1772,7 +1798,7 @@ logical and (corresponds to C
.Ic && )
.It Ic \&:
logical or (corresponds to C
-.Ic \&|| )
+.Ic || )
.It Ic <?
minimum (not available in C)
.It Ic >?
@@ -1780,7 +1806,7 @@ maximum (not available in C)
.El
.Pp
There is no concept of precedence; evaluation proceeds from left to right,
-except when subexpressions are enclosed in parantheses.
+except when subexpressions are enclosed in parentheses.
Inside parentheses, whitespace is ignored.
.Sh ESCAPE SEQUENCE REFERENCE
The
@@ -1828,7 +1854,7 @@ instead.
.Sx Special Characters
with two-letter names, see
.Xr mandoc_char 5 .
-.Ss \e*[ Ns Ar name ]
+.Ss \e* Ns Bq Ar name
Interpolate the string with the
.Ar name ;
see
@@ -1848,7 +1874,7 @@ Special character
.Ss \e/
Right italic correction (groff extension); ignored by
.Xr mandoc 1 .
-.Ss \e[ Ns Ar name ]
+.Ss \e Ns Bq Ar name
.Sx Special Characters
with names of arbitrary length, see
.Xr mandoc_char 5 .
@@ -1904,14 +1930,14 @@ Move down by half a line; ignored by
.Xr mandoc 1 .
.Ss \ee
Backslash special character.
-.Ss \eF[ Ns Ar name ]
+.Ss \eF Ns Bq Ar name
Switch font family (groff extension); ignored by
.Xr mandoc 1 .
For short names, there are variants
.No \eF Ns Ar c
and
.No \eF( Ns Ar cc .
-.Ss \ef[ Ns Ar name ]
+.Ss \ef Ns Bq Ar name
Switch to the font
.Ar name ,
see
@@ -1920,7 +1946,7 @@ For short names, there are variants
.No \ef Ns Ar c
and
.No \ef( Ns Ar cc .
-.Ss \eg[ Ns Ar name ]
+.Ss \eg Ns Bq Ar name
Interpolate the format of a number register; ignored by
.Xr mandoc 1 .
For short names, there are variants
@@ -1930,10 +1956,14 @@ and
.Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq
Set the height of the current font; ignored by
.Xr mandoc 1 .
-.Ss \eh\(aq Ns Ar number Ns \(aq
-Horizontal motion; ignored by
-.Xr mandoc 1 .
-.Ss \ek[ Ns Ar name ]
+.Ss \eh\(aq Ns Oo Cm \&| Oc Ns Ar width Ns \(aq
+Horizontal motion.
+If the vertical bar is given, the motion is relative to the current
+indentation.
+Otherwise, it is relative to the current position.
+The default scaling unit is
+.Cm m .
+.Ss \ek Ns Bq Ar name
Mark horizontal input place in register; ignored by
.Xr mandoc 1 .
For short names, there are variants
@@ -1943,17 +1973,19 @@ and
.Ss \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq
Vertical line drawing function; ignored by
.Xr mandoc 1 .
-.Ss \el\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq
-Horizontal line drawing function; ignored by
-.Xr mandoc 1 .
-.Ss \eM[ Ns Ar name ]
+.Ss \el\(aq Ns Ar width Ns Oo Ar c Oc Ns \(aq
+Draw a horizontal line of
+.Ar width
+using the glyph
+.Ar c .
+.Ss \eM Ns Bq Ar name
Set fill (background) color (groff extension); ignored by
.Xr mandoc 1 .
For short names, there are variants
.No \eM Ns Ar c
and
.No \eM( Ns Ar cc .
-.Ss \em[ Ns Ar name ]
+.Ss \em Ns Bq Ar name
Set glyph drawing color (groff extension); ignored by
.Xr mandoc 1 .
For short names, there are variants
@@ -1964,7 +1996,7 @@ and
Character
.Ar number
on the current font.
-.Ss \en[ Ns Ar name ]
+.Ss \en Ns Bq Ar name
Interpolate the number register
.Ar name .
For short names, there are variants
@@ -1977,6 +2009,8 @@ Overstrike, writing all the characters contained in the
to the same output position.
In terminal and HTML output modes,
only the last one of the characters is visible.
+.Ss \ep
+Break the output line at the end of the current word.
.Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq
Set number register; ignored by
.Xr mandoc 1 .
@@ -1989,9 +2023,9 @@ Change point size; ignored by
Alternative forms
.No \es Ns Oo +|- Oc Ns Ar n ,
.No \es Ns Oo +|- Oc Ns \(aq Ns Ar number Ns \(aq ,
-.No \es Ns [ Oo +|- Oc Ns Ar number ] ,
+.No \es Ns Bq Oo +|- Oc Ns Ar number ,
and
-.No \es Ns Oo +|- Oc Ns [ Ar number Ns ]
+.No \es Ns Oo +|- Oc Ns Bq Ar number
are also parsed and ignored.
.Ss \et
Horizontal tab; ignored by
@@ -1999,7 +2033,7 @@ Horizontal tab; ignored by
.Ss \eu
Move up by half a line; ignored by
.Xr mandoc 1 .
-.Ss \eV[ Ns Ar name ]
+.Ss \eV Ns Bq Ar name
Interpolate an environment variable; ignored by
.Xr mandoc 1 .
For short names, there are variants
@@ -2026,7 +2060,7 @@ as device control function; ignored in nroff mode and by
.Ss \ex\(aq Ns Ar number Ns \(aq
Extra line space function; ignored by
.Xr mandoc 1 .
-.Ss \eY[ Ns Ar name ]
+.Ss \eY Ns Bq Ar name
Output a string as a device control function; ignored in nroff mode and by
.Xr mandoc 1 .
For short names, there are variants
diff --git a/usr/src/man/man5/mdoc.5 b/usr/src/man/man5/mdoc.5
index d0123d86c5..97146f0c9b 100644
--- a/usr/src/man/man5/mdoc.5
+++ b/usr/src/man/man5/mdoc.5
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.262 2017/02/16 14:38:12 schwarze Exp $
+.\" $Id: mdoc.7,v 1.269 2017/07/20 16:24:53 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010, 2011, 2013-2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -19,7 +19,7 @@
.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
.\"
-.Dd $Mdocdate: February 16 2017 $
+.Dd $Mdocdate: July 20 2017 $
.Dt MDOC 5
.Os
.Sh NAME
@@ -601,10 +601,8 @@ in the alphabetical
.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)
.It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off
.It Sx \&Bk , \&Ek Ta keep block: Fl words
-.It Sx \&br Ta force output line break in text mode (no arguments)
-.It Sx \&sp Ta force vertical space: Op Ar height
.El
-.Ss Semantic markup for command line utilities:
+.Ss Semantic markup for command line utilities
.Bl -column "Brq, Bro, Brc" description
.It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility
.It Sx \&Fl Ta command line options (flags) (>=0 arguments)
@@ -615,7 +613,7 @@ in the alphabetical
.It Sx \&Ev Ta environmental variable (>0 arguments)
.It Sx \&Pa Ta file system path (>=0 arguments)
.El
-.Ss Semantic markup for function libraries:
+.Ss Semantic markup for function libraries
.Bl -column "Brq, Bro, Brc" description
.It Sx \&Lb Ta function library (one argument)
.It Sx \&In Ta include file (one argument)
@@ -636,7 +634,7 @@ in the alphabetical
.It Sx \&Er Ta error constant (>0 arguments)
.It Sx \&Ev Ta environmental variable (>0 arguments)
.El
-.Ss Various semantic markup:
+.Ss Various semantic markup
.Bl -column "Brq, Bro, Brc" description
.It Sx \&An Ta author name (>0 arguments)
.It Sx \&Lk Ta hyperlink: Ar uri Op Ar name
@@ -862,7 +860,7 @@ A version of
.At .
.It Cm III
.At III .
-.It Cm V[.[1-4]]?
+.It Cm V | V.[1-4]
A version of
.At V .
.El
@@ -1943,10 +1941,10 @@ The tab cell delimiter may only be used within the
.Sx \&It
line itself; on following lines, only the
.Sx \&Ta
-macro can be used to delimit cells, and
+macro can be used to delimit cells, and portability requires that
.Sx \&Ta
-is only recognised as a macro when called by other macros,
-not as the first macro on a line.
+is called by other macros: some parsers do not recognize it when
+it appears as the first macro on a line.
.Pp
Note that quoted strings may span tab-delimited cells on an
.Sx \&It
@@ -2668,11 +2666,6 @@ The second and last Technical Corrigendum.
.br
This standard is also called
X/Open Portability Guide version 7.
-.Pp
-.It \-p1003.1-2013
-.St -p1003.1-2013
-.br
-This is the first Technical Corrigendum.
.El
.It Other standards
.Pp
@@ -2827,29 +2820,6 @@ Examples:
.Dl \&.Xr mandoc 1
.Dl \&.Xr mandoc 1 \&;
.Dl \&.Xr mandoc 1 \&Ns s behaviour
-.Ss \&br
-Emits a line-break.
-This macro should not be used; it is implemented for compatibility with
-historical manuals.
-.Pp
-Consider using
-.Sx \&Pp
-in the event of natural paragraph breaks.
-.Ss \&sp
-Emits vertical space.
-This macro should not be used; it is implemented for compatibility with
-historical manuals.
-Its syntax is as follows:
-.Pp
-.D1 Pf \. Sx \&sp Op Ar height
-.Pp
-The
-.Ar height
-argument is a scaling width as described in
-.Xr mandoc_roff 5 .
-If unspecified,
-.Sx \&sp
-asserts a single vertical space.
.Sh MACRO SYNTAX
The syntax of a macro depends on its classification.
In this section,
@@ -3134,8 +3104,6 @@ then the macro accepts an arbitrary number of arguments.
.It Sx \&Va Ta Yes Ta Yes Ta n
.It Sx \&Vt Ta Yes Ta Yes Ta >0
.It Sx \&Xr Ta Yes Ta Yes Ta 2
-.It Sx \&br Ta \&No Ta \&No Ta 0
-.It Sx \&sp Ta \&No Ta \&No Ta 1
.El
.Ss Delimiters
When a macro argument consists of one single input character
@@ -3321,7 +3289,7 @@ but produces large indentations.
.Xr tbl 5
.Pp
The web page
-.Lk http://mdocml.bsd.lv/mdoc/ "extended documentation for the mdoc language"
+.Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"
provides a few tutorial-style pages for beginners, an extensive style
guide for advanced authors, and an alphabetic index helping to choose
the best macros for various kinds of content.
diff --git a/usr/src/man/man5/regex.5 b/usr/src/man/man5/regex.5
index 8e267ac4c0..b699737f68 100644
--- a/usr/src/man/man5/regex.5
+++ b/usr/src/man/man5/regex.5
@@ -575,7 +575,7 @@ of the format
.Qq \e{ Ns Em m Ns \e} ,
.Qq \e{ Ns Em m Ns ,\e}
or
-.Qq \e{ Ns Em m Ns , Ns Em n Ns \e} ,
+.Qq \e{ Ns Em m Ns \&, Ns Em n Ns \e} ,
together with that interval expression it matches what repeated consecutive
occurrences of the BRE would match.
The values of
@@ -602,7 +602,7 @@ occurrences of the preceding BRE,
matches at least
.Em m
occurrences and
-.Qq \e{ Ns Em m Ns , Ns Em n Ns \e}
+.Qq \e{ Ns Em m Ns \&, Ns Em n Ns \e}
matches any number of occurrences between
.Em m
and
@@ -633,7 +633,7 @@ The order of precedence is as shown in the following table:
.It escaped characters Ta \e< Ns Em special character Ns >
.It bracket expression Ta [ ]
.It subexpressions/back-references Ta \e( \e) \e Ns Em n
-.It single-character-BRE duplication Ta * \e{ Ns Em m Ns , Ns Em n Ns \e}
+.It single-character-BRE duplication Ta * \e{ Ns Em m Ns \&, Ns Em n Ns \e}
.It concatenation Ta
.It anchoring Ta ^ $
.El
@@ -887,7 +887,7 @@ of the format
.Qq { Ns Em m Ns } ,
.Qq { Ns Em m Ns ,}
or
-.Qq { Ns Em m Ns , Ns Em n Ns } ,
+.Qq { Ns Em m Ns \&, Ns Em n Ns } ,
together with that interval expression it matches what repeated consecutive
occurrences of the ERE would match.
The values of
@@ -914,7 +914,7 @@ occurrences of the preceding ERE,
matches at least
.Em m
occurrences and
-.Qq { Ns m Ns , Ns Em n Ns }
+.Qq { Ns m Ns \&, Ns Em n Ns }
matches any number of occurrences between
.Em m
and
@@ -959,7 +959,7 @@ The order of precedence will be as shown in the following table:
.It escaped characters Ta \e< Ns Em special character Ns >
.It bracket expression Ta \&[ \&]
.It grouping Ta \&( \&)
-.It single-character-ERE duplication Ta * + \&? { Ns Em m Ns , Ns Em n Ns}
+.It single-character-ERE duplication Ta * + \&? { Ns Em m Ns \&, Ns Em n Ns}
.It concatenation Ta
.It anchoring Ta ^ $
.It alternation Ta |
diff --git a/usr/src/man/man5/tbl.5 b/usr/src/man/man5/tbl.5
index d0238e4154..2503dbf3d8 100644
--- a/usr/src/man/man5/tbl.5
+++ b/usr/src/man/man5/tbl.5
@@ -1,7 +1,7 @@
-.\" $Id: tbl.7,v 1.26 2015/01/29 00:33:57 schwarze Exp $
+.\" $Id: tbl.7,v 1.28 2017/06/28 00:59:57 schwarze Exp $
.\"
.\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: January 29 2015 $
+.Dd $Mdocdate: June 28 2017 $
.Dt TBL 5
.Os
.Sh NAME
@@ -24,128 +24,43 @@
.Sh DESCRIPTION
The
.Nm tbl
-language is a table-formatting language.
+language formats tables.
It is used within
.Xr mdoc 5
and
.Xr man 5
-.Ux
-manual pages.
+pages.
This manual describes the subset of the
.Nm
language accepted by the
.Xr mandoc 1
utility.
.Pp
-Tables within
-.Xr mdoc 5
-or
-.Xr man 5
-are enclosed by the
-.Sq TS
-and
-.Sq TE
-macro tags, whose precise syntax is documented in
-.Xr mandoc_roff 5 .
-Tables consist of a series of options on a single line, followed by the
-table layout, followed by data.
-.Pp
-For example, the following creates a boxed table with digits centered in
-the cells.
-.Bd -literal -offset indent
-\&.TS
-tab(:) box;
-c5 c5 c5.
-1:2:3
-4:5:6
-\&.TE
-.Ed
-.Pp
-When formatted, the following output is produced:
-.Bd -filled -offset indent -compact
-.TS
-tab(:) box;
-c5 c5 c5.
-1:2:3
-4:5:6
-.TE
-.Ed
-.Sh TABLE STRUCTURE
-Tables are enclosed by the
-.Sq TS
-and
-.Sq TE
+Each table is started with a
.Xr mandoc_roff 5
-macros.
-A table consists of an optional single line of table
-.Sx Options
-terminated by a semicolon, followed by one or more lines of
+.Ic \&TS
+macro, consist of at most one line of
+.Sx Options ,
+one or more
.Sx Layout
-specifications terminated by a period, then
-.Sx Data .
+lines, one or more
+.Sx Data
+lines, and ends with a
+.Ic \&TE
+macro.
All input must be 7-bit ASCII.
-Example:
-.Bd -literal -offset indent
-\&.TS
-box tab(:);
-c | c
-| c | c.
-1:2
-3:4
-\&.TE
-.Ed
-.Pp
-Table data is
-.Em pre-processed ,
-that is, data rows are parsed then inserted into the underlying stream
-of input data.
-This allows data rows to be interspersed by arbitrary
-.Xr mandoc_roff 5 ,
-.Xr mdoc 5 ,
-and
-.Xr man 5
-macros such as
-.Bd -literal -offset indent
-\&.TS
-tab(:);
-c c c.
-1:2:3
-\&.Ao
-3:2:1
-\&.Ac
-\&.TE
-.Ed
-.Pp
-in the case of
-.Xr mdoc 5
-or
-.Bd -literal -offset indent
-\&.TS
-tab(:);
-c c c.
-\&.ds ab 2
-1:\e*(ab:3
-\&.I
-3:2:1
-\&.TE
-.Ed
-.Pp
-in the case of
-.Xr man 5 .
.Ss Options
-The first line of a table may contain options separated by spaces, tabs,
-or commas and terminated by a semicolon.
-If the first line does not have a terminating semicolon, it is assumed
-that no options are specified and instead a
+If the first input line of a table ends with a semicolon, it contains
+case-insensitive options separated by spaces, tabs, or commas.
+Otherwise, it is interpreted as the first
.Sx Layout
-is processed.
-Some options require arguments enclosed by parentheses.
-The following case-insensitive options are available:
+line.
+.Pp
+The following options are available.
+Some of them require arguments enclosed in parentheses:
.Bl -tag -width Ds
.It Cm allbox
Draw a single-line box around each table cell.
-Currently treated as a synonym for
-.Cm box .
.It Cm box
Draw a single-line box around the table.
For GNU compatibility, this may also be invoked with
@@ -185,73 +100,77 @@ Suppress warnings about tables exceeding the current line length.
This is a GNU extension and currently ignored.
.It Cm tab
Use the single-character argument as a delimiter between data cells.
-By default, the tab character is used.
+By default, the horizontal tabulator character is used.
.El
.Ss Layout
-The table layout follows
+The table layout follows an
.Sx Options
-or a
-.Sq \&T&
-macro invocation.
-Layout specifies how data rows are displayed on output.
-Each layout line corresponds to a line of data; the last layout line
-applies to all remaining data lines.
-Layout lines may also be separated by a comma.
-Each layout cell consists of one of the following case-insensitive keys:
+line or a
+.Xr mandoc_roff 5
+.Ic \&TS
+or
+.Ic \&T&
+macro.
+Each layout line specifies how one line of
+.Sx Data
+is formatted.
+The last layout line ends with a full stop.
+It also applies to all remaining data lines.
+Multiple layout lines can be joined by commas on a single physical
+input line.
+.Pp
+Each layout line consists of one or more layout cell specifications,
+optionally separated by whitespace.
+The following case-insensitive key characters start a new cell
+specification:
.Bl -tag -width 2n
.It Cm c
-Center a literal string within its column.
+Center the string in this cell.
.It Cm r
-Right-justify a literal string within its column.
+Right-justify the string in this cell.
.It Cm l
-Left-justify a literal string within its column.
+Left-justify the string in this cell.
.It Cm n
Justify a number around its last decimal point.
-If the decimal point is not found on the number, it's assumed to trail
-the number.
+If no decimal point is found in the number,
+it is assumed to trail the number.
.It Cm s
Horizontally span columns from the last
-.No non- Ns Cm s
-data cell.
-It is an error if spanning columns follow a
-.Cm \-
+.Pf non- Cm s
+layout cell.
+It is an error if a column span follows a
+.Cm _
or
-.Cm \(ba
-cell, or come first.
-This option is not supported by
-.Xr mandoc 1 .
+.Cm =
+cell, or comes first on a layout line.
+The combined cell as a whole consumes only one cell
+of the corresponding data line.
.It Cm a
-Left-justify a literal string and pad with one space.
+Left-justify a string and pad with one space.
.It Cm ^
Vertically span rows from the last
-.No non- Ns Cm ^
-data cell.
-It is an error to invoke a vertical span on the first layout row.
-Unlike a horizontal spanner, you must specify an empty cell (if it not
-empty, the data is discarded) in the corresponding data cell.
-.It Cm \-
-Replace the data cell (its contents will be lost) with a single
-horizontal line.
-This may also be invoked with
-.Cm _ .
+.Pf non- Cm ^
+layout cell.
+It is an error to invoke a vertical span on the first layout line.
+Unlike a horizontal span, a vertical span consumes a data cell
+and discards the content.
+.It Cm _
+Draw a single horizontal line in this cell.
+This consumes a data cell and discards the content.
+It may also be invoked with
+.Cm \- .
.It Cm =
-Replace the data cell (its contents will be lost) with a double
-horizontal line.
-.It Cm \(ba
-Emit a vertical bar instead of data.
-.It Cm \(ba\(ba
-Emit a double-vertical bar instead of data.
+Draw a double horizontal line in this cell.
+This consumes a data cell and discards the content.
.El
.Pp
-Keys may be followed by a set of modifiers.
-A modifier is either a modifier key or a natural number for specifying
-the minimum width of a column.
-The following case-insensitive modifier keys are available:
+Each cell key may be followed by zero or more of the following
+case-insensitive modifiers:
.Bl -tag -width 2n
.It Cm b
-Use a bold font for the contents of this column.
+Use a bold font for the contents of this cell.
.It Cm d
-Move cell content down to the last cell of a vertical span.
+Move content down to the last row of this vertical span.
Currently ignored.
.It Cm e
Make this column wider to match the maximum width
@@ -259,12 +178,12 @@ of any other column also having the
.Cm e
modifier.
.It Cm f
-The next character selects the font to use for this column.
+The next character selects the font to use for this cell.
See the
.Xr mandoc_roff 5
manual for supported one-character font names.
.It Cm i
-Use an italic font for the contents of this column.
+Use an italic font for the contents of this cell.
.It Cm m
Specify a cell start macro.
This is a GNU extension and currently unsupported.
@@ -277,15 +196,14 @@ Set the vertical line spacing to the following unsigned argument,
or change it by the following signed argument.
Currently ignored.
.It Cm t
-Do not vertically center cell content in the vertical span,
-leave it at the top.
+Do not vertically center content in this vertical span,
+leave it in the top row.
Currently ignored.
.It Cm u
-Move cell content up by half a table line.
+Move cell content up by half a table row.
Currently ignored.
.It Cm w
-Specify minimum column width.
-Currently ignored.
+Specify a minimum column width.
.It Cm x
After determining the width of all other columns, distribute the
rest of the line length among all columns having the
@@ -293,40 +211,185 @@ rest of the line length among all columns having the
modifier.
.It Cm z
Do not use this cell for determining the width of this column.
+.It Cm \&|
+Draw a single vertical line to the right of this cell.
+.It Cm ||
+Draw a double vertical line to the right of this cell.
.El
.Pp
-For example, the following layout specifies a center-justified column of
-minimum width 10, followed by vertical bar, followed by a left-justified
-column of minimum width 10, another vertical bar, then a column using
-bold font justified about the decimal point in numbers:
-.Pp
-.Dl c10 | l10 | nfB
+If a modifier consists of decimal digits,
+it specifies a minimum spacing in units of
+.Cm n
+between this column and the next column to the right.
+The default is 3.
+If there is a vertical line, it is drawn inside the spacing.
.Ss Data
-The data section follows the last layout row.
-By default, cells in a data section are delimited by a tab.
-This behaviour may be changed with the
+The data section follows the last
+.Sx Layout
+line.
+Each data line consists of one or more data cells, delimited by
.Cm tab
-option.
-If
-.Cm _
+characters.
+.Pp
+If a data cells contains only the single character
+.Ql _
or
-.Cm =
-is specified, a single or double line, respectively, is drawn across the
-data field.
-If
-.Cm \e-
+.Ql = ,
+a single or double horizontal line is drawn across the cell,
+joining its neighbours.
+If a data cells contains only the two character sequence
+.Ql \e_
+or
+.Ql \e= ,
+a single or double horizontal line is drawn inside the cell,
+not joining its neighbours.
+If a data line contains nothing but the single character
+.Ql _
or
-.Cm \e=
-is specified, a line is drawn within the data field (i.e. terminating
-within the cell and not draw to the border).
-If the last cell of a line is
-.Cm T{ ,
-all subsequent lines are included as part of the cell until
-.Cm T}
-is specified as its own data cell.
-It may then be followed by a tab
-.Pq or as designated by Cm tab
-or an end-of-line to terminate the row.
+.Ql = ,
+a horizontal line across the whole table is inserted
+without consuming a layout row.
+.Pp
+In place of any data cell, a text block can be used.
+It starts with
+.Ic \&T{
+at the end of a physical input line.
+Input line breaks inside the text block
+neither end the text block nor its data cell.
+It only ends if
+.Ic \&T}
+occurs at the beginning of a physical input line and is followed
+by an end-of-cell indicator.
+If the
+.Ic \&T}
+is followed by the end of the physical input line, the text block,
+the data cell, and the data line ends at this point.
+If the
+.Ic \&T}
+is followed by the
+.Cm tab
+character, only the text block and the data cell end,
+but the data line continues with the data cell following the
+.Cm tab
+character.
+If
+.Ic \&T}
+is followed by any other character, it does not end the text block,
+which instead continues to the following physical input line.
+.Sh EXAMPLES
+String justification and font selection:
+.Bd -literal -offset indent
+\&.TS
+rb c lb
+r ci l.
+r center l
+ri ce le
+right c left
+\&.TE
+.Ed
+.Bd -filled -offset indent
+.TS
+rb c lb
+r ci l.
+r center l
+ri ce le
+right c left
+.TE
+.Ed
+.Pp
+Some ports in
+.Ox 6.1
+to show number alignment and line drawing:
+.Bd -literal -offset indent
+\&.TS
+box tab(:);
+r| l
+r n.
+software:version
+_
+AFL:2.39b
+Mutt:1.8.0
+Ruby:1.8.7.374
+TeX Live:2015
+\&.TE
+.Ed
+.Bd -filled -offset indent
+.TS
+box tab(:);
+r| l
+r n.
+software:version
+_
+AFL:2.39b
+Mutt:1.8.0
+Ruby:1.8.7.374
+TeX Live:2015
+.TE
+.Ed
+.sp 2v
+Spans and skipping width calculations:
+.Bd -literal -offset indent
+\&.TS
+box tab(:);
+lz s | rt
+lt| cb| ^
+^ | rz s.
+left:r
+l:center:
+:right
+\&.TE
+.Ed
+.Bd -filled -offset indent
+.TS
+box tab(:);
+lz s | rt
+lt| cb| ^
+^ | rz s.
+left:r
+l:center:
+:right
+.TE
+.Ed
+.sp 2v
+Text blocks, specifying spacings and specifying and equalizing
+column widths, putting lines into individual cells, and overriding
+.Cm allbox :
+.Bd -literal -offset indent
+\&.TS
+allbox tab(:);
+le le||7 lw10.
+The fourth line:_:line 1
+of this column:=:line 2
+determines:\_:line 3
+the column width.:T{
+This text is too wide to fit into a column of width 17.
+T}:line 4
+T{
+No break here.
+T}::line 5
+\&.TE
+.Ed
+.Bd -filled -offset indent
+.TS
+allbox tab(:);
+le le||7 lw10.
+The fourth line:_:line 1
+of this column:=:line 2
+determines:\_:line 3
+the column width.:T{
+This text is too wide to fit into a column of width 17.
+T}:line 4
+T{
+No break here.
+T}::line 5
+.TE
+.Ed
+.sp 2v
+These examples were constructed to demonstrate many
+.Nm
+features in a compact way.
+In real manual pages, keep tables as simple as possible:
+Like that, they usually look better, are less fragile, and more portable.
.Sh COMPATIBILITY
The
.Xr mandoc 1
@@ -364,4 +427,6 @@ utility.
This
.Nm
reference was written by
-.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
+and
+.An Ingo Schwarze Aq Mt schwarze@openbsd.org .
diff --git a/usr/src/man/man7d/usba.7d b/usr/src/man/man7d/usba.7d
index dfd59bb244..57ffa4c8d6 100644
--- a/usr/src/man/man7d/usba.7d
+++ b/usr/src/man/man7d/usba.7d
@@ -47,74 +47,42 @@ or
.Pa kernel/drv/amd64
are 64 bit drivers.
.Bl -column -offset indent ".Pa kernel/drv/[sparcv9|amd64/]usbser_edge" "Edgeport USB to serial port"
-.It Em Client Driver
-.Ta Em Function/Device
-.It
-.Ta
-.It Pa kernel/drv/[sparcv9|amd64/]hid
-.Ta HID class
-.It Pa kernel/drv/[sparcv9|amd64/]hubd
-.Ta hub class
-.It Pa kernel/drv/[sparcv9|amd64/]scsa2usb
-.Ta mass storage class
-.It Pa kernel/drv/[sparcv9|amd64/]usbprn
-.Ta printer class
-.It Pa kernel/drv/[sparcv9|amd64/]usb_as
-.Ta audio streaming class
-.It Pa kernel/drv/[sparcv9|amd64/]usb_ac
-.Ta audio control class
-.It Pa kernel/drv/[sparcv9|amd64/]usbvc
-.Ta video class
-.It Pa kernel/drv/[sparcv9|amd64/]usb_mid
-.Ta multi-interface device
-.It Pa kernel/drv/[sparcv9|amd64/]usb_ia
-.Ta interface-association driver
-.It Pa kernel/drv/[sparcv9|amd64/]usbser_edge
-.Ta Edgeport USB to serial port
-.It Pa kernel/drv/[sparcv9|amd64/]usbsksp
-.Ta Keyspan USB to serial port
-.It Pa kernel/drv/[sparcv9|amd64/]usbsprl
-.Ta pl2303 USB to serial port
-.It Pa kernel/drv/[sparcv9|amd64/]usbsacm
-.Ta CDC ACM class to serial port
-.It Pa kernel/drv/[sparcv9|amd64/]ugen
-.Ta generic USB driver
-.It Pa kernel/drv/[sparcv9|amd64/]ohci
-.Ta open host controller driver
-.It Pa kernel/drv/[sparcv9|amd64/]uhci
-.Ta universal host controller driver
-.It Pa kernel/drv/[sparcv9|amd64/]ehci
-.Ta enhanced host controller driver
-.It Pa kernel/drv/[sparcv9|amd64/]xhci
-.Ta extensible host controller driver
+.It Em Client Driver Ta Em Function/Device
+.It Ta
+.It Pa kernel/drv/[sparcv9|amd64/]hid Ta HID class
+.It Pa kernel/drv/[sparcv9|amd64/]hubd Ta hub class
+.It Pa kernel/drv/[sparcv9|amd64/]scsa2usb Ta mass storage class
+.It Pa kernel/drv/[sparcv9|amd64/]usbprn Ta printer class
+.It Pa kernel/drv/[sparcv9|amd64/]usb_as Ta audio streaming class
+.It Pa kernel/drv/[sparcv9|amd64/]usb_ac Ta audio control class
+.It Pa kernel/drv/[sparcv9|amd64/]usbvc Ta video class
+.It Pa kernel/drv/[sparcv9|amd64/]usb_mid Ta multi-interface device
+.It Pa kernel/drv/[sparcv9|amd64/]usb_ia Ta interface-association driver
+.It Pa kernel/drv/[sparcv9|amd64/]usbser_edge Ta Edgeport USB to serial port
+.It Pa kernel/drv/[sparcv9|amd64/]usbsksp Ta Keyspan USB to serial port
+.It Pa kernel/drv/[sparcv9|amd64/]usbsprl Ta pl2303 USB to serial port
+.It Pa kernel/drv/[sparcv9|amd64/]usbsacm Ta CDC ACM class to serial port
+.It Pa kernel/drv/[sparcv9|amd64/]ugen Ta generic USB driver
+.It Pa kernel/drv/[sparcv9|amd64/]ohci Ta open host controller driver
+.It Pa kernel/drv/[sparcv9|amd64/]uhci Ta universal host controller driver
+.It Pa kernel/drv/[sparcv9|amd64/]ehci Ta enhanced host controller driver
+.It Pa kernel/drv/[sparcv9|amd64/]xhci Ta extensible host controller driver
.El
.Bl -column -offset indent ".Pa /kernel/strmod/[sparcv9|amd64/]usb_ah" "Function/Device"
-.It
-.Ta
-.It Em Client Streams Modules
-.Ta Em Function/Device
-.It
-.Ta
-.It Pa /kernel/strmod/[sparcv9|amd64/]usbkbm
-.Ta Keyboad
-.It Pa /kernel/strmod/[sparcv9|amd64/]usbms
-.Ta Mouse
-.It Pa /kernel/strmod/[sparcv9|amd64/]usb_ah
-.Ta Audio HID
+.It Ta
+.It Em Client Streams Modules Ta Em Function/Device
+.It Ta
+.It Pa /kernel/strmod/[sparcv9|amd64/]usbkbm Ta Keyboad
+.It Pa /kernel/strmod/[sparcv9|amd64/]usbms Ta Mouse
+.It Pa /kernel/strmod/[sparcv9|amd64/]usb_ah Ta Audio HID
.El
.Bl -column -offset indent ".Em Host Controller Interface Drivers" "Extensible HCI"
-.It Em Host Controller Interface Drivers
-.Ta Em Device
-.It
-.Ta
-.It Pa /kernel/drv/[amd64/]xhci
-.Ta Extensible HCI
-.It Pa /kernel/drv/[sparcv9|amd64/]ehci
-.Ta Enhanced HCI
-.It Pa /kernel/drv/[sparcv9|amd64/]ohci
-.Ta Open HCI
-.It Pa /kernel/drv/[sparcv|amd64/]uhci
-.Ta Universal HCI
+.It Em Host Controller Interface Drivers Ta Em Device
+.It Ta
+.It Pa /kernel/drv/[amd64/]xhci Ta Extensible HCI
+.It Pa /kernel/drv/[sparcv9|amd64/]ehci Ta Enhanced HCI
+.It Pa /kernel/drv/[sparcv9|amd64/]ohci Ta Open HCI
+.It Pa /kernel/drv/[sparcv|amd64/]uhci Ta Universal HCI
.El
.Sh DIAGNOSTICS
The messages described below may appear on the system console as well as being
diff --git a/usr/src/man/man9e/mc_propinfo.9e b/usr/src/man/man9e/mc_propinfo.9e
index 371e7d12a3..d86aea6ec9 100644
--- a/usr/src/man/man9e/mc_propinfo.9e
+++ b/usr/src/man/man9e/mc_propinfo.9e
@@ -58,7 +58,7 @@ If the device driver does not implement either of the
or
.Xr mc_setprop 9E
entry points then it does not need to implement the
-.Xr mc_propinfo 9E
+.Fn mc_propinfo
entry point.
However, it is highly recommended that these interfaces be implemented in order
to give users and administrators of the system access to the properties of the
@@ -260,5 +260,4 @@ example_m_propinfo(void *arg, const char *pr_name, mac_prop_id_t pr_num,
.Sh SEE ALSO
.Xr mac 9E ,
.Xr mc_getprop 9E ,
-.Xr mc_propinfo 9E ,
.Xr mac_prop_info 9F
diff --git a/usr/src/man/man9f/mac_alloc.9f b/usr/src/man/man9f/mac_alloc.9f
index e777672a77..5890e15363 100644
--- a/usr/src/man/man9f/mac_alloc.9f
+++ b/usr/src/man/man9f/mac_alloc.9f
@@ -66,7 +66,7 @@ section of
When the driver is done with the
.Xr mac_register 9S
structure, it must call the
-.Xr mac_free 9F
+.Fn mac_free
function to release any associated memory.
.Sh CONTEXT
The
diff --git a/usr/src/man/man9f/mac_init_ops.9f b/usr/src/man/man9f/mac_init_ops.9f
index c3608f89ec..62086d94e6 100644
--- a/usr/src/man/man9f/mac_init_ops.9f
+++ b/usr/src/man/man9f/mac_init_ops.9f
@@ -85,7 +85,7 @@ In addition, if the call to
in the driver's
.Xr _init 9E
entry point fails, then the driver should also call
-.Xr mac_fini_ops 9F .
+.Fn mac_fini_ops .
See the example below for how this should be structured.
.Sh CONTEXT
The
@@ -110,9 +110,9 @@ functions will always succeed.
They do not have any kind of return value.
.Sh EXAMPLES
The following example shows how a driver would call
-.Xr mac_init_ops 9F
+.Fn mac_init_ops
and
-.Xr mac_fini_ops 9F
+.Fn mac_fini_ops
correctly in the
.Xr _init 9E
and
diff --git a/usr/src/man/man9s/mac_callbacks.9s b/usr/src/man/man9s/mac_callbacks.9s
index 9ab382d65e..7908ff3028 100644
--- a/usr/src/man/man9s/mac_callbacks.9s
+++ b/usr/src/man/man9s/mac_callbacks.9s
@@ -285,7 +285,6 @@ value must be present in the
member.
For more information on the requirements of the function, see
.Xr mc_propinfo 9E .
-.Pp
.Ss Required Members
Many members in the structure are optional; however, the following
members must be set or a call to