summaryrefslogtreecommitdiff
path: root/tmac/groff_man.man
diff options
context:
space:
mode:
authorwl <wl>2007-02-20 19:08:44 +0000
committerwl <wl>2007-02-20 19:08:44 +0000
commita25358ac81372daa00f9eb17adcd84e2b6af5057 (patch)
treee0e65f6f817b8a396975ce67507134b8e7b48826 /tmac/groff_man.man
parenta4c68a60dda64c29ade91e1d68f04473ea4d729f (diff)
downloadgroff-a25358ac81372daa00f9eb17adcd84e2b6af5057.tar.gz
* tmac/groff_man.man: Revised to improve visual appearance.
Reduce use of future tense. * tmac/groff_trace.man: Revosed to improve visual appearance.
Diffstat (limited to 'tmac/groff_man.man')
-rw-r--r--tmac/groff_man.man596
1 files changed, 350 insertions, 246 deletions
diff --git a/tmac/groff_man.man b/tmac/groff_man.man
index 3fc679e0..ae586f56 100644
--- a/tmac/groff_man.man
+++ b/tmac/groff_man.man
@@ -1,5 +1,5 @@
.ig
-Copyright (C) 1999-2000, 2001, 2002, 2003, 2004, 2005
+Copyright (C) 1999-2000, 2001, 2002, 2003, 2004, 2005, 2007
Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of this
@@ -33,23 +33,18 @@ groff_man \- groff `man' macros to support generation of man pages
.
.SH SYNOPSIS
.
-.B groff
-.B \-man
-[
-.IR options .\|.\|.\&
-]
-[
-.IR files .\|.\|.\&
-]
-.br
-.B groff
-.B \-m\ man
-[
-.IR options .\|.\|.\&
-]
-[
-.IR files .\|.\|.\&
-]
+.SY "groff\ \-man"
+.RI [ options
+.IR .\|.\|.\& ]
+.RI [ files
+.IR .\|.\|.\& ]
+.
+.SY "groff\ \-m\ man"
+.RI [ options
+.IR .\|.\|.\& ]
+.RI [ files
+.IR .\|.\|.\& ]
+.YS
.
.
.\" -----------------------------------------------------------------
@@ -59,7 +54,7 @@ groff_man \- groff `man' macros to support generation of man pages
The
.B man
macros used to generate
-.I \%man\~pages
+.I man\~pages
with
.I groff
were written by James Clark.
@@ -79,7 +74,7 @@ various registers).
.
.TP
.B \-rcR=1
-This option (the default if in nroff mode) will create a single, very
+This option (the default if in nroff mode) creates a single, very
long page instead of multiple pages.
.
Say
@@ -89,7 +84,7 @@ to disable it.
.TP
.B \-rC1
If more than one manual page is given on the command line, number the
-pages continuously, rather than starting each at\ 1.
+pages continuously, rather than starting each at\~1.
.
.TP
.B \-rD1
@@ -108,12 +103,12 @@ The default is -0.5i.
.BI \-rHY= flags
Set hyphenation flags.
.
-Possible values are 1\ to hyphenate without restrictions, 2\ to not
-hyphenate the last word on a page, 4\ to not hyphenate the last two
-characters of a word, and 8\ to not hyphenate the first two characters
+Possible values are 1\~to hyphenate without restrictions, 2\~to not
+hyphenate the last word on a page, 4\~to not hyphenate the last two
+characters of a word, and 8\~to not hyphenate the first two characters
of a word.
.
-These values are additive; the default is\ 14.
+These values are additive; the default is\~14.
.
.TP
.BI \-rIN= width
@@ -152,18 +147,18 @@ program;
direct initialization of the `LL' register should
.I always
be preferred to the use of such a request.
-In particular, note that a `.ll\ 65n' request will
+In particular, note that a `.ll\ 65n' request does
.I not
preserve the normal
.I nroff
default line length,
(the
.B man
-default initialization to 78n will prevail),
+default initialization to 78n prevails),
whereas,
the `-rLL=65n' option, or an equivalent `.nr\ LL\ 65n'
request preceding the use of the `TH' macro,
-.I will
+.I does
set a line length of 65n.
.
.TP
@@ -175,9 +170,9 @@ length.
.
.TP
.BI \-rP nnn
-Enumeration of pages will start with
+Enumeration of pages start with
.I nnn
-rather than with\ 1.
+rather than with\~1.
.
.TP
.BI \-rS xx
@@ -185,7 +180,7 @@ Base document font size is
.I xx
points
.RI ( xx
-can be 10, 11, or\ 12) rather than 10\ points.
+can be 10, 11, or\~12) rather than 10\~points.
.
.TP
.BI \-rSN= width
@@ -195,7 +190,7 @@ The default is 3n.
.
.TP
.BI \-rX nnn
-After page\ \c
+After page\~\c
.IR nnn ,
number pages as
.IR nnn a,
@@ -203,7 +198,7 @@ number pages as
.IR nnn c,
etc.
.
-For example, the option `\-rX2' will produce the following page
+For example, the option `\-rX2' produces the following page
numbers: 1, 2, 2a, 2b, 2c, etc.
.
.
@@ -216,19 +211,19 @@ This section describes the available macros for manual pages.
For further customization, put additional macros and requests into the
file
.B man.local
-which will be loaded immediately after the
+which is loaded immediately after the
.B man
package.
.
.TP
-.BI .TH " title section \fB[\fPextra1\fB]\fP \fB[\fPextra2\fB]\fP \fB[\fPextra3\fB]"
+.BI .TH " title section \fR[\fPextra1\fR]\fP \fR[\fPextra2\fR]\fP \fR[\fPextra3\fR]"
Set the title of the
.I man\~page
to
.I title
and the section to
.IR section ,
-which must take on a value between 1 and\ 8.
+which must take on a value between 1 and\~8.
.
The value
.I section
@@ -244,9 +239,9 @@ are positioned at the left and right in the header line (with
in parentheses immediately appended to
.IR title .
.I extra1
-will be positioned in the middle of the footer line.
+is positioned in the middle of the footer line.
.I extra2
-will be positioned at the left in the footer line (or at the left on
+is positioned at the left in the footer line (or at the left on
even pages and at the right on odd pages if double-sided printing is
active).
.I extra3
@@ -256,7 +251,7 @@ is centered in the header line.
For HTML output, headers and footers are completely suppressed.
.
.IP
-Additionally, this macro starts a new page; the new line number is\ 1
+Additionally, this macro starts a new page; the new line number is\~1
again (except if the `-rC1' option is given on the command line) --
this feature is intended only for formatting multiple
.IR \%man\~pages ;
@@ -267,7 +262,7 @@ should contain exactly one
macro at the beginning of the file.
.
.TP
-.BI ".SH [" "text for a heading" ]
+.BI .SH " \fR[\fPtext for a heading\fR]\fP"
Set up an unnumbered section heading sticking out to the left.
.
Prints out all the text following
@@ -284,7 +279,7 @@ Additionally, the left margin and the indentation for the following
text is reset to the default values.
.
.TP
-.BI ".SS [" "text for a heading" ]
+.BI .SS " \fR[\fPtext for a heading\fR]\fP"
Set up a secondary, unnumbered section heading.
.
Prints out all the text following
@@ -301,7 +296,7 @@ Additionally, the left margin and the indentation for the following
text is reset to the default values.
.
.TP
-.BI ".TP [" nnn ]
+.BI .TP " \fR[\fPnnn\fR]\fP"
Set up an indented paragraph with label.
.
The indentation is set to
@@ -329,8 +324,8 @@ If the label is wider than the indentation the descriptive part of the
paragraph begins on the line following the label, entirely indented.
.
Note that neither font shape nor font size of the label is set to a
-default value; on the other hand, the rest of the text will have
-default font settings.
+default value; on the other hand, the rest of the text has default
+font settings.
.
.IP
The
@@ -339,20 +334,27 @@ macro is the macro used for the explanations you are just reading.
.
.TP
.B .TQ
-The
+The
.B TQ
-macro sets up header continuation for a .TP macro. With it, you can
-stack up any number of labels (such as in a glossary, or list of
-commands) before beginning the indented paragraph. For an example,
-look just past the next paragraph.
+macro sets up header continuation for a .TP macro.
+.
+With it, you can stack up any number of labels (such as in a
+glossary, or list of commands) before beginning the indented
+paragraph.
+.
+For an example, look just past the next paragraph.
+.
.IP
This macro is not defined on legacy Unix systems running classic
-troff. To be certain your page will be portable to those systems,
+troff.
+.
+To be certain your page will be portable to those systems,
copy its definition from the
-.B an-ext.tmac
-file of a
-.BR groff
+.B \%an-ext.tmac
+file of a
+.BR groff
installation.
+.
.TP
.B .LP
.TQ
@@ -372,7 +374,7 @@ Roman).
Finally, the current left margin and the indentation are restored.
.
.TP
-.BI ".IP [" designator "] [" nnn ]
+.BI .IP " \fR[\fPdesignator\fR]\fP \fR[\fPnnn\fR]\fP"
Set up an indented paragraph, using
.I designator
as a tag to mark its beginning.
@@ -408,11 +410,13 @@ margin temporarily to the current indentation value.
is one of the three macros used in the
.B man
package to format lists.
+.
.IP \(bu 4
.B HP
is another.
.
This macro produces a paragraph with a left hanging indentation.
+.
.IP \(bu 4
.B TP
is another.
@@ -422,7 +426,7 @@ paragraph.
.RE
.
.TP
-.BI ".HP [" nnn ]
+.BI .HP " \fR[\fPnnn\fR]\fP"
Set up a paragraph with hanging left indentation.
.
The indentation is set to
@@ -438,7 +442,7 @@ or
Font size and face are reset to its default values.
.
The following paragraph illustrates the effect of this macro with
-hanging indentation set to\ 4 (enclosed by
+hanging indentation set to\~4 (enclosed by
.B .RS
and
.B .RE
@@ -452,17 +456,21 @@ macro.
.
As you can see, it produces a paragraph where all lines but the first
are indented.
+.
.RE
.IP
-Use of this presentation-level macro is deprecated. While it is
-universally portable to legacy Unix systems, a hanging indent cannot
-be expressed naturally under HTML and many HTML-based manual viewers
-simply interpret it as a starter for a normal paragraph. Thus, any
-information or distinction you tried to express with the indentation
-may be lost.
+Use of this presentation-level macro is deprecated.
+.
+While it is universally portable to legacy Unix systems, a hanging
+indentation cannot be expressed naturally under HTML, and many
+HTML-based manual viewers simply interpret it as a starter for a
+normal paragraph.
+.
+Thus, any information or distinction you tried to express with the
+indentation may be lost.
.
.TP
-.BI ".RS [" nnn ]
+.BI .RS " \fR[\fPnnn\fR]\fP"
This macro moves the left margin to the right by the value
.I nnn
if specified (default unit is `n'); otherwise it is set to the
@@ -481,7 +489,7 @@ Calls to the
macro can be nested.
.
.TP
-.BI ".RE [" nnn ]
+.BI .RE " \fR[\fPnnn\fR]\fP"
This macro moves the left margin back to level
.IR nnn ,
restoring the previous left margin.
@@ -490,28 +498,36 @@ If no argument is given, it moves one level back.
.
The first level (i.e., no call to
.B RS
-yet) has number\ 1, and each call to
+yet) has number\~1, and each call to
.B RS
-increases the level by\ 1.
+increases the level by\~1.
.
.TP
-.B EX
+.B .EX
.TQ
-.B EE
-Example/End Example. After
-.BR EX ,
-filling is disabled and the font is set to constant-width. This is
-useful for formatting code, command, and configuration-file examples.
+.B .EE
+Example/End Example.
+.
+After
+.BR EX ,
+filling is disabled and the font is set to constant-width.
+.
+This is useful for formatting code, command, and
+configuration-file examples.
+.
The
-.B EE
+.B EE
macro restores the previous font.
-.sp
+.
+.IP
These macros are defined on many (but not all) legacy Unix systems
-running classic troff. To be certain your page will be portable to
-those systems, copy their definitions from the
-.B an-ext.tmac
-file of a
-.BR groff
+running classic troff.
+.
+To be certain your page will be portable to those systems, copy
+their definitions from the
+.B \%an-ext.tmac
+file of a
+.BR groff
installation.
.
.PP
@@ -533,8 +549,8 @@ The macros
.BR RS ,
.BR RE ,
.BR EX ,
-and
-.BR EE
+and
+.B EE
also cause a break but no insertion of vertical space.
.
.
@@ -542,15 +558,15 @@ also cause a break but no insertion of vertical space.
.
.SH "MACROS TO SET FONTS"
.
-The standard font is Roman; the default text size is 10\ point.
+The standard font is Roman; the default text size is 10\~point.
.
.TP
-.BI ".SM [" text ]
+.BI .SM " \fR[\fPtext\fR]\fP"
Causes the text on the same line or the text on the next input line to
appear in a font that is one point size smaller than the default font.
.
.TP
-.BI ".SB [" text ]
+.BI .SB " \fR[\fPtext\fR]\fP"
Causes the text on the same line or the text on the next input line to
appear in boldface font, one point size smaller than the default font.
.
@@ -562,9 +578,11 @@ italic.
The text must be on the same line as the macro call.
.
Thus
+.
.RS
.IP
\&.BI this "word and" that
+.
.PP
would cause `this' and `that' to appear in bold face, while `word and'
appears in italics.
@@ -605,7 +623,7 @@ face.
The text must be on the same line as the macro call.
.
.TP
-.BI ".B [" text ]
+.BI .B " \fR[\fPtext\fR]\fP"
Causes
.I text
to appear in bold face.
@@ -614,7 +632,7 @@ If no text is present on the line where the macro is called the text
of the next input line appears in bold face.
.
.TP
-.BI ".I [" text ]
+.BI .I " \fR[\fPtext\fR]\fP"
Causes
.I text
to appear in italic.
@@ -626,155 +644,210 @@ of the next input line appears in italic.
.\" -----------------------------------------------------------------
.
.SH "MACROS TO DESCRIBE HYPERLINKS AND EMAIL ADDRESSES"
-
+.
The following macros are not defined on legacy Unix systems
-running classic troff. To be certain your page will be portable to
-those systems, copy their definitions from the
-.B an-ext.tmac
-file of a
-.BR groff
+running classic troff.
+.
+To be certain your page will be portable to those systems, copy
+their definitions from the
+.B \%an-ext.tmac
+file of a
+.BR groff
installation.
-
-Using these macros helps ensure that you will get hyperlinks when your
-manual page is rendered in a browser or other program that is Web-enabled.
-
+.
+.PP
+Using these macros helps ensure that you get hyperlinks when your
+manual page is rendered in a browser or other program that is
+Web-enabled.
+.
.TP
-.B UR
+.BI .UR " URL"
.TQ
-.B UE
-Wrap a World Wide Web hyperlink. The argument to the
+.BI .UE " \fR[\fPpunctuation\fR]\fP"
+Wrap a World Wide Web hyperlink.
+.
+The argument to
.B UR
-is the URL; thereafter, lines until
+is the URL; thereafter, lines until
.B UE
-are collected and used as the link text. Any argument to the
+are collected and used as the link text.
+.
+Any argument to the
.B UE
macro is pasted to the end of the text.
-On a device that is not
-a browser,
-
+.
+On a device that is not a browser,
+.
+.RS
+.IP
.EX
this is a link to
-\&.UR http:\&//randomsite,org/fubar
+\&.UR http://\e:randomsite.org/\e:fubar
some random site
\&.UE ,
given as an example
.EE
-
-will usually display like this: "this is a link to some random
-site <http:\&//randomsite,org/fubar>, given as an example".
-
+.RE
+.
+.IP
+usually displays like this: \[lq]this is a link to some random
+site <http://\:randomsite.org/\:fubar>, given as an example\[rq].
+.
+.IP
+The use of
+.B \e:
+to insert hyphenless breakpoints is a groff extension and can
+be omitted.
+.
.TP
-.B MT
+.BI .MT " address"
.TQ
-.B ME
-Wrap an email address. The argument of MT is the address; text
-following, until
+.BI .ME " \fR[\fPpunctuation\fR]\fP"
+Wrap an email address.
+.
+The argument of
+.B MT
+is the address; text following, until
.BR ME ,
-is a name to be associated with the address. Any argument to the
+is a name to be associated with the address.
+.
+Any argument to the
.B ME
-macro is pasted to the end of the link text. On a device that is not
-a browser,
-
+macro is pasted to the end of the link text.
+.
+On a device that is not a browser,
+.
+.RS
+.IP
.EX
contact
-\&.UR fred.foonly@fubar,net
+\&.UR fred.foonly@\e:fubar.net
Fred Foonly
\&.UE
for more information
.EE
-
-will usually display like this: "contact Fred Foonly
-<fred.foonly@fubar.net> for more information".
-
+.RE
+.
+.IP
+usually displays like this: \[lq]contact Fred Foonly
+<fred.foonly@\:fubar.net> for more information\[rq].
+.
+.IP
+The use of
+.B \e:
+to insert hyphenless breakpoints is a groff extension and can
+be omitted.
+.
+.
.\" -----------------------------------------------------------------
.
.SH "MACROS TO DESCRIBE COMMAND SYNOPSES"
.
The following macros are not defined on legacy Unix systems
-running classic troff. To be certain your page will be portable to
-those systems, copy their definitions from the
-.B an-ext.tmac
-file of a
-.BR groff
+running classic troff.
+.
+To be certain your page will be portable to those systems, copy their
+definitions from the
+.B \%an-ext.tmac
+file of a
+.BR groff
installation.
-
-These macros are a convenience for authors. They will also assist
-automated translation tools and help browsers in recognizing
-command synopses and treating them differently from running text.
-.
-.TP
-.B SY
-Begin synopsis. Takes a single argument, the name of a command. Text
-following, until closed by
+.
+.PP
+These macros are a convenience for authors.
+They also assist automated translation tools and help browsers in
+recognizing command synopses and treating them differently from
+running text.
+.
+.TP
+.BI .SY " command"
+Begin synopsis.
+.
+Takes a single argument, the name of a command.
+.
+Text following, until closed by
.BR YS ,
-will be set with a hanging indent with the width of the command name
-plus a space. This produces the traditional look of a Unix command
-synopsis.
+is set with a hanging indentation with the width of
+.I command
+plus a space.
+.
+This produces the traditional look of a Unix command synopsis.
+.
.TP
-.B OP
-Describe an optional command argument. The arguments of this macro
-will be set surrounded by option braces in the default Roman font.
+.BI .OP " key value"
+Describe an optional command argument.
+.
+The arguments of this macro are set surrounded by option braces
+in the default Roman font; the first argument is printed with
+a bold face, while the second argument is typeset as italic.
+.
.TP
-.B YS
-This macro restores normal indentation at the end of a command synopsis.
-.LP
+.B .YS
+This macro restores normal indentation at the end of a command
+synopsis.
+.
+.PP
Here is a real example:
-
+.
+.IP
.EX
\&.SY groff
-\&.OP -abcegiklpstzCEGNRSUVXZ
-\&.OP -d cs
-\&.OP -f fam
-\&.OP -F dir
-\&.OP -I dir
-\&.br
-\&.OP -K arg
-\&.OP -L arg
-\&.OP -m name
-\&.OP -M dir
-\&.OP -n num
-\&.OP -o list
-\&.OP -P arg
-\&.br
-\&.OP -r cn
-\&.OP -T dev
-\&.OP -w name
-\&.OP -W name
+\&.OP \e-abcegiklpstzCEGNRSUVXZ
+\&.OP \e-d cs
+\&.OP \e-f fam
+\&.OP \e-F dir
+\&.OP \e-I dir
+\&.OP \e-K arg
+\&.OP \e-L arg
+\&.OP \e-m name
+\&.OP \e-M dir
+\&.OP \e-n num
+\&.OP \e-o list
+\&.OP \e-P arg
+\&.OP \e-r cn
+\&.OP \e-T dev
+\&.OP \e-w name
+\&.OP \e-W name
\&.RI [ file
-\&.IR ... ]
+\&.IR .\e|.\e|. ]
\&.YS
.EE
-
+.
+.PP
produces the following output:
-
+.
+.RS
+.PP
.SY groff
-.OP -abcegiklpstzCEGNRSUVXZ
-.OP -d cs
-.OP -f fam
-.OP -F dir
-.OP -I dir
-.br
-.OP -K arg
-.OP -L arg
-.OP -m name
-.OP -M dir
-.OP -n num
-.OP -o list
-.OP -P arg
-.br
-.OP -r cn
-.OP -T dev
-.OP -w name
-.OP -W name
+.OP \-abcegiklpstzCEGNRSUVXZ
+.OP \-d cs
+.OP \-f fam
+.OP \-F dir
+.OP \-I dir
+.OP \-K arg
+.OP \-L arg
+.OP \-m name
+.OP \-M dir
+.OP \-n num
+.OP \-o list
+.OP \-P arg
+.OP \-r cn
+.OP \-T dev
+.OP \-w name
+.OP \-W name
.RI [ file
-.IR ... ]
+.IR .\|.\|. ]
.YS
-
-Note the use of
+.RE
+.
+.PP
+If necessary, you might use
.B br
-requests to control line breaking. You can insert plain text as
-well; this will look like the traditional (unornamnted) syntax
-for a required command argument or filename.
+requests to control line breaking.
+.
+You can insert plain text as well; this looks like the traditional
+(unornamented) syntax for a required command argument or filename.
+.
.
.\" -----------------------------------------------------------------
.
@@ -787,29 +860,35 @@ which ignores indentation.
.
.TP
.B .DT
-Set tabs every 0.5 inches.
+Set tabs every 0.5\~inches.
.
Since this macro is always called during a
.B TH
request, it makes sense to call it only if the tab positions have been
changed.
-.sp
-Use of this presentation-level macro is deprecated. It translates
-poorly to HTML, under which exact whitespace control and tabbing are not
-readily available. Thus, information or distinctions that you use
-.B DT
-to express are likely to be lost. If you feel tempted to use it,
-you should probably be composing a table using
-.BR tbl (1)
+.
+.IP
+Use of this presentation-level macro is deprecated.
+.
+It translates poorly to HTML, under which exact whitespace control
+and tabbing are not readily available.
+.
+Thus, information or distinctions that you use
+.B DT
+to express are likely to be lost.
+.
+If you feel tempted to use it, you should probably be composing a
+table using
+.BR @g@tbl (@MAN1DIR@)
markup instead.
.
.TP
-.BI ".PD [" nnn ]
+.BI .PD " \fR[\fPnnn\fR]\fP"
Adjust the empty space before a new paragraph or section.
.
The optional argument gives the amount of space (default unit is `v');
-without parameter, the value is reset to its default value (1\ line in
-nroff mode, 0.4v\ otherwise).
+without parameter, the value is reset to its default value (1\~line in
+nroff mode, 0.4v\~otherwise).
.
This affects the macros
.BR SH ,
@@ -823,15 +902,19 @@ and
.BR IP ,
and
.BR HP .
-.sp
-Use of this presentation-level macro is deprecated. It translates
-poorly to HTML, under which exact control of inter-paragraph spacing
-is not readily available. Thus, information or distinctions that you use
-.B PD
+.
+.IP
+Use of this presentation-level macro is deprecated.
+.
+It translates poorly to HTML, under which exact control of
+inter-paragraph spacing is not readily available.
+.
+Thus, information or distinctions that you use
+.B PD
to express are likely to be lost.
.
.TP
-.BI ".AT [" system " [" release ]]
+.BI .AT " \fR[\fPsystem \fR[\fPrelease\fR]]\fP"
Alter the footer for use with \f[CR]AT&T\f[]
.IR \%man\~pages .
This command exists only for compatibility; don't use it.
@@ -841,9 +924,9 @@ See the
info manual for more.
.
.TP
-.BI ".UC [" version ]
+.BI .UC " \fR[\fPversion\fR]\fP"
Alter the footer for use with \f[CR]BSD\f[]
-.IR \%man\~pages .
+.IR man\~pages .
This command exists only for compatibility; don't use it.
.
See the
@@ -851,19 +934,20 @@ See the
info manual for more.
.
.TP
-.B ".PT"
+.B .PT
Print the header string.
.
Redefine this macro to get control of the header.
.
.TP
-.B ".BT"
+.B .BT
Print the footer string.
.
Redefine this macro to get control of the footer.
.
.PP
The following strings are defined:
+.
.TP
.B \e*S
Switch back to the default font size.
@@ -898,10 +982,12 @@ or
is needed, it has become usage to make the first line of the
.I \%man\~page
look like this:
+.
.PP
.RS
.BI '\e"\ word
.RE
+.
.PP
Note the single space character after the double quote.
.I word
@@ -929,46 +1015,57 @@ requests, one can, in principle, supplement the functionality of the
.B man
macros with individual
.I groff
-requests where necessary. See the
+requests where necessary.
+.
+See the
.I groff
info pages for a complete reference of all requests.
-.LP
-Note, however, that using raw troff requests is likely to make your page
-render poorly on the (increasingly common) class of viewers that
-render it to HTML. Troff requests make implicit assumptions about
-things like character and page sizes that may break in an HTML
-environment; also, many of these viewers don't interpret the full
-troff vocabulary, a problem which can lead to portions of your
-text being silently dropped.
-.LP
+.
+.PP
+Note, however, that using raw troff requests is likely to make your
+page render poorly on the (increasingly common) class of viewers that
+render it to HTML.
+.
+Troff requests make implicit assumptions about things like character
+and page sizes that may break in an HTML environment; also, many of
+these viewers don't interpret the full troff vocabulary, a problem
+which can lead to portions of your text being silently dropped.
+.
+.PP
For portability to modern viewers, it is best to write your page
-entirely in the requests described on this page. Further, it is best
-to completely avoid those we have described as 'presentation-level'
+entirely in the requests described on this page.
+.
+Further, it is best to completely avoid those we have described as
+`presentation-level'
.RB ( HP ,
.BR PD ,
and
.BR DT ).
-.LP
+.
+.PP
The macros we have described as extensions
-.RB ( EX/EE ,
-.BR SY/OP/YS ,
-.BR UR/UE ,
+.RB ( .EX / .EE ,
+.BR .SY / .OP / .YS ,
+.BR .UR / .UE ,
and
-.BR MT/ME )
+.BR .MT / .ME )
should be used with caution, as they may not yet be built in to
-some viewer that is important to your audience. If in doubt, copy
-the implementation onto your page.
-.
-
+some viewer that is important to your audience.
+.
+If in doubt, copy the implementation onto your page.
+.
+.
.\" -----------------------------------------------------------------
.
.SH FILES
+.
.TP
.B man.tmac
.TQ
.B an.tmac
These are wrapper files to call
.BR andoc.tmac .
+.
.TP
.B andoc.tmac
This file checks whether the
@@ -976,27 +1073,32 @@ This file checks whether the
macros or the
.B mdoc
package should be used.
+.
.TP
.B an-old.tmac
Most
.B man
macros are contained in this file.
+.
.TP
.B an-ext.tmac
-The extension macro definitions forx
-.BR \&.SY ,
-.BR \&.OP ,
-.BR .YS ,
-.BR .TQ ,
+The extension macro definitions for
+.BR .SY ,
+.BR .OP ,
+.BR .YS ,
+.BR .TQ ,
.BR .EX/.EE ,
.BR .UR/.UE ,
and
-.BR .MT/.ME
-are contained in this file. It is written in classic troff,
-and released for free re-use, and not copylefted; manual page authors
-concerned about portability to legacy Unix systems are encouraged to
-copy these definitions into their pages, and maintainers of troff
+.BR .MT/.ME
+are contained in this file.
+.
+It is written in classic troff, and released for free re-use,
+and not copylefted; manual page authors concerned about
+portability to legacy Unix systems are encouraged to copy these
+definitions into their pages, and maintainers of troff
or its workalikes are encouraged to re-use them.
+.
.TP
.B man.local
Local changes and customizations should be put into this file.
@@ -1019,17 +1121,19 @@ Local changes and customizations should be put into this file.
.SH AUTHORS
.
This manual page was originally written for the Debian GNU/Linux
-system by
+system by
.MT sgk@debian.org
Susan G. Kleinmann
.ME .
+.
It was corrected and updated by
.MT wl@gnu.org
Werner Lemberg
.ME .
+.
The extension macros were documented (and partly designed) by
.MT esr@thyrsus.com
-Eric S. Raymond
+Eric S. Raymond
.ME ;
he also wrote the portability advice.
.