summaryrefslogtreecommitdiff
path: root/mm/groff_mm.man
diff options
context:
space:
mode:
Diffstat (limited to 'mm/groff_mm.man')
-rw-r--r--mm/groff_mm.man94
1 files changed, 74 insertions, 20 deletions
diff --git a/mm/groff_mm.man b/mm/groff_mm.man
index 008390557..922665e5a 100644
--- a/mm/groff_mm.man
+++ b/mm/groff_mm.man
@@ -21,7 +21,7 @@ no letter macros implemented (yet).
no Bell Labs localisms implemented.
.TP
.B \(bu
-the macros OK, PM and TM is not implemented.
+the macros OK and PM is not implemented.
.TP
.B \(bu
groff mm does not support cut marks
@@ -32,6 +32,20 @@ english text to the preferred language. Use \fBm@TMAC_M@se\fP as an example.
.LP
Groff mm has several extensions:
.TP
+.B "APP name text"
+Begin an appendix with name \fIname\fP. Automatic naming occurs if
+\fIname\fP is "". The appendixes starts with \fBA\fP if auto is used.
+An new page is ejected, and a header is also produced if the number
+variable \fBAph\fP is non-zero. This is the default.
+The appendix always appear in the 'List of contents' with correct
+pagenumber. The name \fIAPPENDIX\fP can be changed by setting
+the string \fBApp\fP to the desired text.
+.TP
+.B "APPSK name pages text"
+Same as \fB.APP\fP, but the pagenr is incremented with \fIpages\fP.
+This is used when diagrams or other non-formatted documents are
+included as appendixes.
+.TP
.B B1
Begin box (as the ms macro)
Draws a box around the text.
@@ -45,13 +59,25 @@ broken variable-item list.
As VL but text begins always at the next line
.TP
.B "COVER [arg]"
-Works just like MT, but reads from @TMAC_MDIR@/*.cov instead.
-\fIarg\fP is used together with \fI.cov\fP to find a macrofile
-with the selected headermacros, like \fIms.cov\fP.
+\fBCOVER\fP begins a coversheet definition. It is important
+that \fB.COVER\fP appears before any normal text.
+\fB.COVER\fP uses \fIarg\fP to build the filename
+@TMAC_MDIR@/\fIarg\fP.cov. Therefore it is possible to create unlimited
+types of coversheets.
\fIms.cov\fP is supposed to look like the \fBms\fP coversheet.
-It is also possible to control size and fonts of title and abstract,
-since \fBCOVER\fP is before .TL, .AS and the rest.
-Only a few coverfiles exists at the moment.
+\fB.COVER\fP requires a \fB.COVEND\fP at the end of the coverdefinition.
+Always use this order of the covermacros:
+.nf
+\&.COVER
+\&.TL
+\&.AF
+\&.AU
+\&.AT
+\&.AS
+\&.AE
+\&.COVEND
+.fi
+However, only \fB.TL\fP and \fB.AU\fP are required.
.TP
.B COVEND
This finish the cover description and prints the cover-page.
@@ -98,11 +124,9 @@ Begin multiple columns. Return to normal with 1C.
.TP
.B "MT [arg [addressee]]"
Memorandom type.
-Well, not new, but different.
The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP.
-So, it is possible to write even the AT&T covers now.
+Memorandum type 0 thru 5 are supported, including \fI"string"\fP.
\fIAddresse\fP just sets a variable, used in the AT&T macros.
-An example of a macro file can be found in \fI0.MT\fP.
.TP
.B "MOVE y-pos [x-pos [line-length]]"
Move to a position, pageoffset set to \fIx-pos\fP.
@@ -143,6 +167,30 @@ End verbatim output.
.LP
New variables in m@TMAC_M@:
.TP
+.B App
+A string containing the word "APPENDIX".
+.TP
+.B Aph
+Print an appendix-page for every new appendix
+if this numbervariable is non-zero.
+No output will occur if \fBAph\fP is zero, but there will always
+be an appendix-entry in the 'List of contents'.
+.TP
+.B Hps
+Numbervariable with the heading pre-space level. If the heading-level
+is less than or equal to \fBHps\fP, then two lines will precede the
+section heading instead of one. Default is first level only.
+The real amount of lines is controlled by the variables \fBHps1\fP and
+\fBHps2\fP.
+.TP
+.B Hps1
+This is the number of lines preceding \fB.H\fP when the heading-level
+is greater than \fBHps\fP. Value is in units, normally 0.5v.
+.TP
+.B Hps2
+This is the number of lines preceding \fB.H\fP when the heading-level
+is less than or equal to \fBHps\fP. Value is in units, normally 1v.
+.TP
.B Lifg
String containing \fIFigure\fP.
.TP
@@ -158,6 +206,10 @@ String containing \fIEquation\fP.
.B Licon
String containing \fICONTENTS\fP.
.TP
+.B Lsp
+.TP
+The size of an empty line. Normally 0.5v, but it is 1v
+if \fBn\fP is set (\fB.nroff\fP).
.B "MO1 - MO12"
Strings containing \fIJanuary\fI to \fIDecember\fP.
.TP
@@ -166,6 +218,10 @@ String containing "See chapter \e\e*[Qrfh], page \e\en[Qrfp].".
.TP
.B .mgm
Always 1.
+.LP
+A file called \fBlocale\fP or \fIlang\fP\fB_locale\fP is read
+after the initiation of the global variables. It is therefore
+possible to localize the macros with companyname and so on.
.sp 3
.LP
The following standard macros are implemented:
@@ -186,7 +242,7 @@ Authors firm
Start autoincrement list
.TP
.B "AS [arg [indent]]"
-Abstract start
+Abstract start. Indent is specified in 'ens', but scaling is allowed.
.TP
.B "AT title1 [title2 ...]"
Authors title
@@ -233,7 +289,6 @@ right adjusted text and block may be used (R or RB as \fIformat\fP).
Equation title.
If \fIrefname\fP is used, then the equationnumber is saved with
\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
-See BUGS for limits.
.TP
.B "EF [arg]"
Even-page footer.
@@ -251,7 +306,6 @@ Equation start.
Exhibit title.
If \fIrefname\fP is used, then the exhibitnumber is saved with
\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
-See BUGS for limits.
.TP
.B "FD [arg [1]]"
Footnote default format.
@@ -263,7 +317,6 @@ Footnote end.
Figure title.
If \fIrefname\fP is used, then the figurenumber is saved with
\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
-See BUGS for limits.
.TP
.B FS
Footnote start.
@@ -397,7 +450,6 @@ Space vertically. \fIlines\fP can have any scalingfactor, like \fI3i\fP or
Table title.
If \fIrefname\fP is used, then the tablenumber is saved with
\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
-See BUGS for limits.
.TP
.B "TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]"
Table of contents.
@@ -415,6 +467,10 @@ Table header.
.B TL
Begin title of memorandom.
.TP
+.B TM [num1 [num2 [...]]]
+Technical memorandumnumbers used in \fB.MT\fP. Unlimited number
+of arguments may be given.
+.TP
.B TP
Top of page user-defined macro.
.TP
@@ -579,11 +635,7 @@ Paragraph type.
.B Si=5
Display indent.
.LP
-.SH BUGS
-It is only possible to have one title in each \fB.DS\fP/\fB.DE\fP
-for figures, equations, exhibits and tables. This title is always printed
-under the contents in the display. It is, however, possible to use
-these macros outside displays also.
+.\".SH BUGS
.SH AUTHOR
Jörgen Hägg, Lund Institute of Technology, Sweden <jh@efd.lth.se>
.SH FILES
@@ -593,6 +645,8 @@ Jörgen Hägg, Lund Institute of Technology, Sweden <jh@efd.lth.se>
.B @TMAC_MDIR@*.cov
.TP
.B @TMAC_MDIR@*.MT
+.TP
+.B @TMAC_MDIR@locale
.SH "SEE ALSO"
.BR groff (@MAN1EXT@),
.BR gtroff (@MAN1EXT@),