.\" Modified Tue Jul 27 20:12:02 2004 by Colin Watson <cjwatson@debian.org>
.\" 2007-05-30, mtk: various rewrites and moved much text to new man-pages.7.
.\"
-.TH MAN 7 2017-03-13 "Linux" "Linux Programmer's Manual"
+.TH MAN 7 2019-03-06 "Linux" "Linux Programmer's Manual"
.SH NAME
man \- macros to format man pages
.SH SYNOPSIS
.B groff \-Tascii \-man
.I file
\&...
-.LP
+.PP
.B groff \-Tps \-man
.I file
\&...
-.LP
+.PP
.B man
.RI [ section ]
.I title
.BR man-pages (7).
.SS Title line
The first command in a man page (after comment lines,
-that is, lines that start with \fB.\\"\fP) should be
+that is, lines that start with \fB.\e"\fP) should be
+.PP
.RS
-.sp
.B \&.TH
.I "title section date source manual"
-.sp
.RE
+.PP
For details of the arguments that should be supplied to the
.B TH
command, see
.\" on the same line as
.\" .BR \&.SH ,
.\" then place the heading in double quotes.
-
+.PP
The only mandatory heading is NAME, which should be the first section and
be followed on the next line by a one-line description of the program:
+.PP
.RS
-.sp
\&.SH NAME
.br
-item \\- description
-.sp
+item \e- description
.RE
+.PP
It is extremely important that this format is followed, and that there is a
backslash before the single dash which follows the item name.
This syntax is used by the
.TP
.B \&.SM
Small (useful for acronyms)
-.LP
+.PP
Traditionally, each command can have up to six arguments, but the GNU
implementation removes this limitation (you might still want to limit
yourself to 6 arguments for portability's sake).
use \ee.
Other sequences you may use, where x or xx are any characters and N
is any digit, include:
-.BR \e' ,
-.BR \e` ,
+.BR \e\(aq ,
+.BR \e\(ga ,
.BR \e- ,
.BR \e. ,
.BR \e" ,
.PP
Tools processing these files should open the file and examine the first
nonwhitespace character.
-A period (.) or single quote (') at the beginning
+A period (.) or single quote (\(aq) at the beginning
of a line indicates a troff-based file (such as man or mdoc).
A left angle bracket (<) indicates an SGML/XML-based
file (such as HTML or Docbook).
Anything else suggests simple ASCII
text (e.g., a "catman" result).
.PP
-Many man pages begin with \fB\'\e"\fP followed by a
+Many man pages begin with \fB\(aq\e"\fP followed by a
space and a list of characters,
indicating how the page is to be preprocessed.
For portability's sake to non-troff translators we recommend
insert cross-references.
By sticking to the safe subset described above, it should be easier to
automate transitioning to a different reference page format in the future.
-.LP
+.PP
The Sun macro
.B TX
is not implemented.
.BR groff_man (7),
.BR groff_www (7),
.BR man-pages (7),
-.BR mdoc (7),
-.BR mdoc.samples (7)
+.BR mdoc (7)