summaryrefslogtreecommitdiff
path: root/tmac/groff_man.man
diff options
context:
space:
mode:
authorwlemb <wlemb>2000-10-26 14:15:06 +0000
committerwlemb <wlemb>2000-10-26 14:15:06 +0000
commitd512a69b13065fea8dfe89fdebc4dfdafb5e6941 (patch)
treeccd62cd31b27a59da67a4b239917be9ef82ceb4a /tmac/groff_man.man
parent7cdd47b59da0d60d0ef9be3e750a486b1c741511 (diff)
downloadgroff-d512a69b13065fea8dfe89fdebc4dfdafb5e6941.tar.gz
Convert macros `tmac.XXX' to `XXX.tmac'. Special cases:
tmac.doc.old -> doc-old.tmac tmac.an.old -> an-old.tmac * tmac/tmac.*: Moved to ... * tmac/*.tmac: this. * tmac/man.local: Fix comment. * tmac/groff_man.man, tmac/groff_markup.man, tmac/groff_mdoc.man, tmac/groff_me.man, tmac/groff_ms.man, tmac/groff_tmac.man: Updated. Added some `FILES' sections. More use of @...@ directives. Other minor updates. * arch/djgpp/README, font/devutf8/NOTES: Updated. * doc/homepage.ms, doc/groff.texinfo: Updated. * man/groff.man, man/roff.man: Updated. * src/devices/grodvi/grodvi.man, src/devices/grolbp/grolbp.man, src/devices/grolj4/grolj4.man, src/devices/grops/grops.man, src/devices/grotty/grotty.man: Updated. * src/preproc/pic/pic.man: Updated. * src/roff/grog/grog.pl, src/roff/grog/grog.sh: Use -mdoc-old instead of -mdoc.old. * src/roff/grog/grog.man: Document -mdoc and -mdoc-old. * src/roff/nroff/nroff.man: Updated. * NEWS: Updated. * tmac/fixmacros.sed, tmac/strip.sed: Add explanatory comment. * tmac/mm.diff: Removed -- it has no use now since the mm package is part of groff. * tmac/*: Removed trailing spaces. * arch/djgpp/t-groff.bat: Fix GROFF_TMAC_PATH (hyphen.us is now in the tmac subdirectory also).
Diffstat (limited to 'tmac/groff_man.man')
-rw-r--r--tmac/groff_man.man70
1 files changed, 50 insertions, 20 deletions
diff --git a/tmac/groff_man.man b/tmac/groff_man.man
index 14bd3b0c..27d92a68 100644
--- a/tmac/groff_man.man
+++ b/tmac/groff_man.man
@@ -30,7 +30,16 @@ groff_man \- groff `man' macros to support generation of man pages
.SH SYNOPSIS
.
.B groff
-.B \-m@TMAC_AN_PREFIX@an
+.B \-man
+[
+.IR options .\|.\|.
+]
+[
+.IR files .\|.\|.
+]
+.br
+.B groff
+.B \-m\ man
[
.IR options .\|.\|.
]
@@ -40,11 +49,11 @@ groff_man \- groff `man' macros to support generation of man pages
.
.SH DESCRIPTION
.
-The
-.B tmac.@TMAC_AN_PREFIX@an
-macros used to generate man pages with
+The
+.B man
+macros used to generate man pages with
.I groff
-were written by James Clark.
+were written by James Clark.
This document provides a brief summary of the use of each macro in that
package.
.
@@ -91,11 +100,12 @@ For example, the option `\-rX2' will produce the following page numbers:
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
-.BR tmac.@TMAC_AN_PREFIX@an .
+which will be loaded immediately after the
+.B man
+package.
.TP
.BI .TH " title section " [ extra1 "] [" extra2 "] [" extra3 ]
-Sets the title of the man page to
+Sets the title of the man page to
.I title
and the section to
.IR section ,
@@ -154,7 +164,7 @@ value.
.TP
.BI ".TP [" nnn ]
Sets up an indented paragraph with label.
-The indentation is set to
+The indentation is set to
.I nnn
if that argument is supplied (the default unit is `n' if omitted), otherwise
it is set to the default indentation value.
@@ -188,8 +198,8 @@ The font size and shape are reset to the default value (10pt resp. Roman).
Finally, the current left margin is restored.
.TP
.BI ".IP [" designator "] [" nnn ]
-Sets up an indented paragraph, using
-.I designator
+Sets up an indented paragraph, using
+.I designator
as a tag to mark its beginning.
The indentation is set to
.I nnn
@@ -205,9 +215,9 @@ designator, using `.IP\ \\(bu\ 4':
.RS
.IP \(bu 4
.B IP
-is one of the three macros used in
-.B tmac.@TMAC_AN_PREFIX@an
-to format lists.
+is one of the three macros used in the
+.B man
+package to format lists.
.IP \(bu 4
.B HP
is another.
@@ -413,15 +423,35 @@ Modern implementations of the
program read this first line and automatically call the right
preprocessor(s).
.
+.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
+.B man
+macros or the
+.B mdoc
+package should be used.
+.TP
+.B an-old.tmac
+All
+.B man
+macros are contained in this file.
+.
.SH "SEE ALSO"
.
-Since the
-.B tmac.@TMAC_AN_PREFIX@an
-macros consist of groups of
-.I groff
+Since the
+.B man
+macros consist of groups of
+.I groff
requests, one can, in principle, supplement the functionality of the
-.B tmac.@TMAC_AN_PREFIX@an
-macros with individual
+.B man
+macros with individual
.I groff
requests where necessary.
A complete list of these requests is available on the WWW at