EditPageHistoryDiffInfoLikePages

Annotated edit history of groff_mm(7) version 1, including all changes. View license author blame.

Rev	Author	#	Line
1	perry	1	GROFF_MM
		2	!!!GROFF_MM
		3	NAME
		4	SYNOPSIS
		5	DESCRIPTION
		6	INTERNALS
		7	AUTHOR
		8	FILES
		9	SEE ALSO
		10	----
		11	!!NAME
		12
		13
		14	groff_mm - groff mm macros
		15	!!SYNOPSIS
		16
		17
		18	__groff -mm__ [[ ''options''... ] [[ ''files''...
		19	]
		20	!!DESCRIPTION
		21
		22
		23	The groff mm macros are intended to be compatible with the
		24	DWB mm macros with the following limitations:
		25
		26
		27	no Bell Labs localisms implemented.
		28
		29
		30	the macros OK and PM is not implemented.
		31
		32
		33	groff mm does not support cut marks
		34
		35
		36	__mm__ is intended to be international. Therefore it is
		37	possible to write short national macrofiles which change all
		38	english text to the preferred language. Use __mmse__ as
		39	an example.
		40
		41
		42	A file called __locale__ or ''lang''___locale__ is
		43	read after the initiation of the global variables. It is
		44	therefore possible to localize the macros with companyname
		45	and so on.
		46
		47
		48	In this manual square brackets is used to show optional
		49	arguments.
		50
		51
		52	__Number registers and strings__
		53	Many macros can be controlled by number registers and
		54	strings. A number register is assigned with the __nr__
		55	command:__
		56	.nr__ ''XXX [[+-]n [[i]''__
		57	XXX__ is the name of the register, __n__ is the value
		58	to be assigned, and __i__ is increment value for
		59	auto-increment. __n__ can have a plus or minus sign as
		60	prefix if an increment or decrement of the current value is
		61	wanted. (Auto-increment or decrement occurs if the number
		62	register is used with a plus or minus sign, __n+[[XXX]__
		63	or __n-[[XXX]__.)
		64
		65
		66	Strings is defined with __ds__.__
		67	.ds__ ''YYY string''
		68	The string is assigned everything to the end of the line,
		69	even blanks. Initial blanks in ''string'' should be
		70	prefixed with a double-quote. (Strings are used in the text
		71	as __*[[YYY]__.)
		72
		73
		74	__Special formatting of number registers__
		75	A number register is printed with normal digits if no format
		76	has been given. Set the format with __af__:__
		77	.af__ ''R c
		78	R'' is the name of the register, ''c'' is the
		79	format.
		80
		81
		82	__Form__
		83
		84
		85	__Sequence__ 1
		86
		87
		88	0, 1, 2, 3, ... 001
		89
		90
		91	000, 001, 002, 003, ... i
		92
		93
		94	0, i, ii, iii, iv, ... I
		95
		96
		97	0, I, II, III, IV, ... a
		98
		99
		100	0, a, b, c, ..., z, aa, ab, ... A
		101
		102
		103	0, A, B, C, ..., Z, AA, AB, ...
		104
		105
		106	__Macros:__
		107
		108
		109	__)E level text__
		110
		111
		112	Adds __text__ (heading-text) to the table of contents
		113	with __level__ either 0 or between 1-7. See also
		114	__.H__. This macro is used for customized table of
		115	contents.
		116
		117
		118	__1C [[1]__
		119
		120
		121	Begin one column processing. An __1__ as argument
		122	disables the page-break. Use wide footnotes, small footnotes
		123	may be overprinted.
		124
		125
		126	__2C__
		127
		128
		129	Begin two column processing. Splits the page in two columns.
		130	It is a special case of __MC__. See also
		131	__1C__.
		132
		133
		134	__AE__
		135
		136
		137	Abstract end, see __AS__.
		138
		139
		140	__AF [[name of firm]__
		141
		142
		143	Authors firm, should be called before __AU__, see also
		144	__COVER__.
		145
		146
		147	__AL [[type [[text-indent [[1]]]__
		148
		149
		150	Start autoincrement list. Items are numbered beginning on
		151	one. The ''type'' argument controls the type of
		152	numbers.
		153
		154
		155	Arg
		156
		157
		158	Description 1
		159
		160
		161	Arabic (the default) A
		162
		163
		164	Upper-case letters (A-Z) a
		165
		166
		167	Lower-case letters (a-z) I
		168
		169
		170	Upper-case roman i
		171
		172
		173	Lower-case roman ''Text-indent'' sets the indent and
		174	overrides __Li__. A third argument will prohibit printing
		175	of a blank line before each item.
		176
		177
		178	__APP name text__
		179
		180
		181	Begin an appendix with name ''name''. Automatic naming
		182	occurs if ''name'' is
		183	''A__ if auto is used. An new page is ejected, and a
		184	header is also produced if the number variable __Aph__ is
		185	non-zero. This is the default. The appendix always appear in
		186	the 'List of contents' with correct pagenumber. The name
		187	''APPENDIX'' can be changed by setting the string
		188	__App__ to the desired text. The string __Apptxt__
		189	contains the current appendix text.
		190
		191
		192	__APPSK name pages text__
		193
		194
		195	Same as __.APP__, but the pagenr is incremented with
		196	''pages''. This is used when diagrams or other
		197	non-formatted documents are included as
		198	appendixes.
		199
		200
		201	__AS [[arg [[indent]]__
		202
		203
		204	Abstract start. Indent is specified in 'ens', but scaling is
		205	allowed. Argument ''arg'' controls where the abstract is
		206	printed.
		207
		208
		209	Arg
		210
		211
		212	Placement 0
		213
		214
		215	Abstract will be printed on page 1 and on the cover sheet if
		216	used in the released-paper style (__MT 4__), otherwise it
		217	will be printed on page 1 without a cover sheet.
		218	1
		219
		220
		221	Abstract will only be printed on the cover sheet (__MT
		222	4__ only). 2
		223
		224
		225	Abstract will be printed only on the cover sheet (other than
		226	__MT 4__ only). The cover sheet is printed without need
		227	for __CS__. Abstract is not printed at all in external
		228	letters (__MT 5__). The ''indent'' controls the
		229	indentation of both margins, otherwise will normal text
		230	indent be used.
		231
		232
		233	__AST [[title]__
		234
		235
		236	Abstract title. Default is __ABSTRACT__. Sets the text
		237	above the abstract text.
		238
		239
		240	__AT title1 [[title2 ...]__
		241
		242
		243	Authors title. __AT__ must appear just after each
		244	__AU__. The title will show up after the name in the
		245	signature block.
		246
		247
		248	__AU [[name [[initials [[loc [[dept [[ext [[room [[arg [[arg
		249	[[arg]]]]]]]]]__
		250
		251
		252	Author information, specifies the author of the memo or
		253	paper, and will be printed on the cover sheet and on other
		254	similar places. __AU__ must not appear before __TL__.
		255	The author information can contain initials, location,
		256	department, telephone extension, room number or name and up
		257	to three extra arguments.
		258
		259
		260	__AV [[name [[1]]__
		261
		262
		263	Approval signature, generates an approval line with place
		264	for signature and date. The string __APPROVED:__ can be
		265	changed with variable __Letapp__, and the string
		266	__Date__ in __Letdate__.
		267
		268
		269	__AVL [[name]__
		270
		271
		272	Letter signature, generates a line with place for
		273	signature.
		274
		275
		276	__B [[bold-text [[prev-font-text [[bold...]]]__
		277
		278
		279	Begin boldface. No limit on the number of arguments. All
		280	arguments will be concatenated to one word, the first, third
		281	and so on will be printed in boldface.
		282
		283
		284	__B1__
		285
		286
		287	Begin box (as the ms macro). Draws a box around the text.
		288	The text will be indented one character, and the right
		289	margin will be one character shorter.
		290
		291
		292	__B2__
		293
		294
		295	End box. Finish the box started by __B1__.
		296
		297
		298	__BE__
		299
		300
		301	End bottom block, see __BS__.
		302
		303
		304	__BI [[bold-text [[italic-text [[bold-text
		305	[[...]]]]__
		306
		307
		308	Bold-italic. No limit on the number of arguments, see
		309	__B__.
		310
		311
		312	__BL [[text-indent [[1]]__
		313
		314
		315	Start bullet list, initialize a list with a bullet and a
		316	space in the beginning of each list item (see __LI__).
		317	''Text-indent'' overrides the default indentation of the
		318	list items set by number register __Pi__. A third
		319	argument will prohibit printing of a blank line before each
		320	item.
		321
		322
		323	__BR [[bold-text [[roman-text [[bold-text
		324	[[...]]]]__
		325
		326
		327	Bold-roman. No limit on the number of
		328	arguments.
		329
		330
		331	__BS__
		332
		333
		334	Bottom block start. Begins the definition of a text block
		335	which is printed at the bottom of each page. Block ends with
		336	__BE__.
		337
		338
		339	__BVL text-indent [[mark-indent [[1]]__
		340
		341
		342	Start of broken variable-item list. Broken variable-item
		343	list has no fixed mark, it assumes that every __LI__ has
		344	a mark instead. The text will always begin at the next line
		345	after the mark. ''Text-indent'' sets the indent to the
		346	text, and ''mark-indent'' the distance from the current
		347	indent to the mark. A third argument will prohibit printing
		348	of a blank line before each item.
		349
		350
		351	__COVER [[arg]__
		352
		353
		354	__COVER__ begins a coversheet definition. It is important
		355	that __.COVER__ appears before any normal text.
		356	__.COVER__ uses ''arg'' to build the filename
		357	/usr/share/groff/1.17.2/tmac/mm/''arg''.cov. Therefore it
		358	is possible to create unlimited types of coversheets.
		359	''ms.cov'' is supposed to look like the __ms__
		360	coversheet. __.COVER__ requires a __.COVEND__ at the
		361	end of the coverdefinition. Always use this order of the
		362	covermacros:
		363
		364
		365	.COVER
		366	.TL
		367	.AF
		368	.AU
		369	.AT
		370	.AS
		371	.AE
		372	.COVEND
		373	However, only __.TL__ and __.AU__ are required.
		374
		375
		376	__COVEND__
		377
		378
		379	This finish the cover description and prints the cover-page.
		380	It is defined in the cover file.
		381
		382
		383	__DE__
		384
		385
		386	Display end. Ends a block of text, display, that begins with
		387	__DS__ or __DF__.
		388
		389
		390	__DF [[format [[fill [[rindent]]]__
		391
		392
		393	Begin floating display (no nesting allowed). A floating
		394	display is saved in a queue and is printed in the order
		395	entered. ''Format'', ''fill'' and ''rindent'' is
		396	the same as in __DS__. Floating displays are controlled
		397	by the two number registers __De__ and
		398	__Df__.
		399
		400
		401	__De register__
		402
		403
		404	0
		405
		406
		407	Nothing special, this is the default. 1
		408
		409
		410	A page eject will occur after each printed display, giving
		411	only one display per page and no text following
		412	it.
		413
		414
		415	__Df register__
		416
		417
		418	0
		419
		420
		421	Displays are printed at the end of each section (when
		422	section-page numbering is active) or at the end of the
		423	document. 1
		424
		425
		426	A new display will be printed on the current page if there
		427	is enough space, otherwise it will be printed at the end of
		428	the document. 2
		429
		430
		431	One display will be printed at the top of each page or
		432	column (in multi-column mode). 3
		433
		434
		435	Print one display if there is enough space for it, otherwise
		436	it will be printed at the top of the next page or column.
		437	4
		438
		439
		440	Print as many displays that will fit in a new page or
		441	column. A page break will occur between each display if
		442	__De__ is not zero. 5
		443
		444
		445	Fill the current page with displays and the rest beginning
		446	at a new page or column. (This is the default.) A page break
		447	will occur between each display if __De__ is not
		448	zero.
		449
		450
		451	__DL [[text-indent [[1 [[1]]]__
		452
		453
		454	Dash list start. Begins a list where each item is printed
		455	after a dash. ''Text-indent'' changes the default
		456	indentation of the list items set by number register
		457	__Pi__. A second argument prevents the empty line between
		458	each list item to be printed. See __LI__. A third
		459	argument will prohibit printing of a blank line before each
		460	item.
		461
		462
		463	__DS [[format [[fill [[rindent]]]__
		464
		465
		466	Static display start. Begins collection of text until
		467	__DE__. The text is printed together on the same page,
		468	unless it is longer than the height of the page. __DS__
		469	can be nested to a unlimited depth (reasonably
		470	:-).
		471
		472
		473	__format__
		474
		475
		476
		477
		478	No indentation. none
		479
		480
		481	No indentation. L
		482
		483
		484	No indentation. I
		485
		486
		487	Indent text with the value of number register __Si__.
		488	C
		489
		490
		491	Center each line CB
		492
		493
		494	Center the whole display as a block. R
		495
		496
		497	Right adjust the lines. RB
		498
		499
		500	Right adjust the whole display as a block
		501
		502
		503	L, I, C and CB can also be specified as 0, 1, 2 or 3 for
		504	compatibility reasons. (Don't use it. :-)
		505
		506
		507	__fill__
		508
		509
		510
		511
		512	Line-filling turned off. none
		513
		514
		515	Line-filling turned off. N
		516
		517
		518	Line-filling turned off. F
		519
		520
		521	Line-filling turned on.
		522
		523
		524	N and F can also be specified as 0 or 1. An empty line will
		525	normally be printed before and after the display. Setting
		526	number register __Ds__ to 0 will prevent this.
		527	''Rindent'' shortens the line length by that
		528	amount.
		529
		530
		531	__EC [[title [[override [[flag [[refname]]]]__
		532
		533
		534	Equation title. Sets a title for an equation. The
		535	''override'' argument change the numbering.
		536
		537
		538	__flag__
		539
		540
		541	none
		542
		543
		544	''override'' is a prefix to the number. 0
		545
		546
		547	''override'' is a prefix to the number. 1
		548
		549
		550	''override'' is a suffix to the number. 2
		551
		552
		553	''override'' replaces the number. __EC__ uses the
		554	number register __Ec__ as counter. It is possible to use
		555	__.af__ to change the format of the number. If number
		556	register __Of__ is 1, then the format of title will use a
		557	dash instead of a dot after the number.
		558	The string __Le__ controls the title of the List of
		559	Equations, default is ''LIST OF EQUATIONS''. The List of
		560	Equations will only be printed if number register __Le__
		561	is 1, default 0. The string __Liec__ contains the word
		562	''Equation'', wich is printed before the number. If
		563	''refname'' is used, then the equation number is saved
		564	with __.SETR__, and can be retrieved with __.GETST__
		565	''refname''.
		566	Special handling of the title will occur if __EC__ is
		567	used inside __DS__/__DE__, it will not be affected by
		568	the format of __DS__.
		569
		570
		571	__EF [[arg]__
		572
		573
		574	Even-page footer, printed just above the normal page footer
		575	on even pages, see __PF__.
		576
		577
		578	__EH [[arg]__
		579
		580
		581	Even-page header, printed just below the normal page header
		582	on even pages, see __PH__.
		583
		584
		585	__EN__
		586
		587
		588	Equation end, see __EQ__.
		589
		590
		591	__EOP__
		592
		593
		594	End of page user-defined macro. This macro will be called
		595	instead of the normal printing of the footer. The macro will
		596	be executed in a separate environment, without any trap
		597	active. See __TP__.
		598
		599
		600	__Strings available to EOP__
		601
		602
		603	EOPf
		604
		605
		606	Argument from __PF__. EOPef
		607
		608
		609	Argument from __EF__. EOPof
		610
		611
		612	Argument from __OF__.
		613
		614
		615	__EPIC width height [[name]__
		616
		617
		618	__EPIC__ draws a box with the given ''width'' and
		619	''height'', it will also print the text ''name'' or a
		620	default string if ''name'' is not specified.. This is
		621	used to include external pictures, just give the size of the
		622	picture. See __PIC__
		623
		624
		625	__EQ [[label]__
		626
		627
		628	Equation start. __EQ__/__EN__ are the delimiters for
		629	equations written for __eqn__. __EQ__/__EN__ must
		630	be inside a __DS__/__DE__-pair, except when __EQ__
		631	is only used to set options in __eqn__. The ''label''
		632	will appear at the right margin of the equation, unless
		633	number register __Eq__ is 1. Then the label will appear
		634	at the left margin.
		635
		636
		637	__EX [[title [[override [[flag [[refname]]]]__
		638
		639
		640	Exhibit title, arguments are the same as for __EC__.
		641	__EX__ uses the number register __Ex__ as counter. The
		642	string __Lx__ controls the title of the List of Exhibits,
		643	default is ''LIST OF EXHIBITS''. The List of Exhibits
		644	will only be printed if number register __Lx__ is 1,
		645	default 1. The string __Liex__ contains the word
		646	''Exhibit'', which is printed before the number. If
		647	''refname'' is used, then the exhibit number is saved
		648	with __.SETR__, and can be retrieved with __.GETST__
		649	''refname''.
		650	Special handling of the title will occur if __EX__ is
		651	used inside __DS__/__DE__, it will not be affected by
		652	the format of __DS__.
		653
		654
		655	__FC [[closing]__
		656
		657
		658	Prints ''Yours very truly,'' as a formal closing of a
		659	letter or memorandum. The argument replaces the defualt
		660	string. The default is stored in string variable
		661	__Letfc__.
		662
		663
		664	__FD [[arg [[1]]__
		665
		666
		667	Footnote default format. Controls the hyphenation (hyphen),
		668	right margin justification (adjust), indentation of footnote
		669	text (indent). It can also change the label justification
		670	(ljust).
		671
		672
		673	__arg hyphen adjust indent ljust
		674	__0 no yes yes left
		675	1 yes yes yes left
		676	2 no no yes left
		677	3 yes no yes left
		678	4 no yes no left
		679	5 yes yes no left
		680	6 no no no left
		681	7 yes no no left
		682	8 no yes yes right
		683	9 yes yes yes right
		684	10 no no yes right
		685	11 yes no yes right
		686	Argument greater than or equal to 11 is considered as arg 0. Default for mm is 10.
		687
		688
		689	__FE__
		690
		691
		692	Footnote end.
		693
		694
		695	__FG [[title [[override [[flag [[refname]]]]__
		696
		697
		698	Figure title, arguments are the same as for __EC__.
		699	__FG__ uses the number register __Fg__ as counter. The
		700	string __Lf__ controls the title of the List of Figures,
		701	default is ''LIST OF FIGURES''. The List of Figures will
		702	only be printed if number register __Lf__ is 1, default
		703	1. The string __Lifg__ contains the word ''Figure'',
		704	wich is printed before the number. If ''refname'' is
		705	used, then the figure number is saved with __.SETR__, and
		706	can be retrieved with __.GETST__ ''refname''.
		707	Special handling of the title will occur if __FG__ is
		708	used inside __DS__/__DE__, it will not be affected by
		709	the format of __DS__.
		710
		711
		712	__FS [[label]__
		713
		714
		715	Footnote start. The footnote is ended by __FE__.
		716	Footnotes is normally automatically numbered, the number is
		717	available in string __F__. Just add __*F__ in the
		718	text. By adding ''label'', it is possible to have other
		719	number or names on the footnotes. Footnotes in displays is
		720	now possible. An empty line separates footnotes, the height
		721	of the line is controlled by number register __Fs__,
		722	default value is 1.
		723
		724
		725	__GETHN refname [[varname]__
		726
		727
		728	Includes the headernumber where the corresponding
		729	__SETR__ ''refname'' was placed. Will be X.X.X. in
		730	pass 1. See __INITR__. If ''varname'' is used,
		731	__GETHN__ sets the stringvariable ''varname'' to the
		732	headernumber.
		733
		734
		735	__GETPN refname [[varname]__
		736
		737
		738	Includes the pagenumber where the corresponding __SETR__
		739	''refname'' was placed. Will be 9999 in pass 1. See
		740	__INITR__. If ''varname'' is used, __GETPN__ sets
		741	the stringvariable ''varname'' to the
		742	pagenumber.
		743
		744
		745	__GETR refname__
		746
		747
		748	Combines __GETHN__ and __GETPN__ with the text
		749	'chapter' and ', page'. The string ''Qrf'' contains the
		750	text for reference:
		751
		752
		753	.ds Qrf See chapter \*[[Qrfh], page \*[[Qrfp].
		754
		755
		756	''Qrf'' may be changed to support other languages.
		757	Strings ''Qrfh'' and ''Qrfp'' are set by __GETR__
		758	and contains the page and headernumber.
		759
		760
		761	__GETST refname [[varname]__
		762
		763
		764	Includes the string saved with the second argument to
		765	__.SETR__. Will be dummystring in pass 1. If varname is
		766	used, __GETST__ sets the stringvariable ''varname'' to
		767	the saved string. See __INITR__.
		768
		769
		770	__H level [[heading-text [[heading-suffix]]__
		771
		772
		773	Numbered section heading. Section headers can have a level
		774	between 1 and 7, level 1 is the top level. The text is given
		775	in ''heading-text'', and must be surrounded by double
		776	quotes if it contains spaces. __Heading-suffix__ is added
		777	to the header in the text but not in the table of contents.
		778	This is normally used for footnote marks and similar things.
		779	Don't use __*F__ in ''heading-suffix'', it won't work.
		780	A manual label must be used, see __FS__.
		781
		782
		783	An eventual paragraph, __P__, directly after __H__
		784	will be ignored, __H__ is taking care of spacing and
		785	indentation.
		786
		787
		788	__Page ejection before heading__
		789	Number register __Ej__ controls page ejection before the
		790	heading. Normally, a level one heading gets two blank lines
		791	before it, higher levels gets only one. A new page is
		792	ejected before each first-level heading if number register
		793	__Ej__ is 1. All levels below or equal the value of
		794	__Ej__ gets a new page. Default value for __Ej__ is
		795	0.
		796
		797
		798	__Heading break level__
		799	A line break occurs after the heading if the heading level
		800	is less or equal to number register __Hb__. Default value
		801	2.
		802
		803
		804	__Heading space level__
		805	A blank line is inserted after the heading if the heading
		806	level is less or equal to number register __Hs__. Default
		807	value 2.
		808
		809
		810	Text will follow the heading on the same line if the level
		811	is greater than both __Hb__ and __Hs__.
		812
		813
		814	__Post-heading indent__
		815	Indentation of the text after the heading is controlled by
		816	number register __Hi__, default value 0.
		817
		818
		819	__Hi__
		820
		821
		822	0
		823
		824
		825	The text will be left-justified. 1
		826
		827
		828	Indentation of the text will follow the value of number
		829	register __Pt__, see __P__. 2
		830
		831
		832	The text will be lined up with the first word of the
		833	heading.
		834
		835
		836	__Centered section headings__
		837	All headings whose level is equal or below number register
		838	__Hc__ and also less than or equal to __Hb__ or
		839	__Hs__ is centerered.
		840
		841
		842	__Font control of the heading__
		843	The font of each heading level is controlled by string
		844	__HF__. It contains a fontnumber or fontname for each
		845	level. Default is __2 2 2 2 2 2 2__ (all headings in
		846	italic). Could also be written as __I I I I I I I__. All
		847	omitted values are presumed to be a 1.
		848
		849
		850	__Point size control__.
		851	String __HP__ controls the pointsize of each heading, in
		852	the same way as __HF__ controls the font. A value of 0
		853	selects the default point size. Default value is __0 0 0 0
		854	0 0 0__. Beware that only the point size changes, not the
		855	vertical size. That can be controlled by the user specified
		856	macro __HX__ and/or __HZ__.
		857
		858
		859	__Heading counters__
		860	Seven number registers, named __H1__ thru __H7__
		861	contains the counter for each heading level. The values are
		862	printed using arabic numerals, this can be changed with the
		863	macro __HM__ (see below). All marks are concatenated
		864	before printing. To avoid this, set number register
		865	__Ht__ to 1. That will only print the current heading
		866	counter at each heading.
		867
		868
		869	__Automatic table of contents__
		870	All headings whose level is equal or below number register
		871	__Cl__ is saved to be printed in the table of contents.
		872	Default value is 2.
		873
		874
		875	__Special control of the heading, user-defined
		876	macros__.
		877	These macros can be defined by the user to get a finer
		878	control of vertical spacing, fonts or other features.
		879	Argument ''level'' is the level-argument to __H__, but
		880	0 for unnumbered headings (see __HU__). Argument
		881	''rlevel'' is the real level, it is set to number
		882	register __Hu__ for unnumbered headings. Argument
		883	''heading-text'' is the text argument to __H__ and
		884	__HU__.
		885
		886
		887	__HX__ ''level rlevel heading-text''__
		888	HX__ is called just before the printing of the heading.
		889	The following register is available for __HX__. __HX__
		890	may alter __}0__, __}2__ and __;3__.
		891
		892
		893	__string }0__
		894
		895
		896	Contains the heading mark plus two spaces if ''rlevel''
		897	is non-zero, otherwise empty.
		898
		899
		900	__register ;0__
		901
		902
		903	Contains the position of the text after the heading. 0 means
		904	that the text should follow the heading on the same line, 1
		905	means that a line break should occur before the text and 2
		906	means that a blank line should separate the heading and the
		907	text.
		908
		909
		910	__string }2__
		911
		912
		913	Contains two spaces if register __;0__ is 0. It is used
		914	to separate the heading from the text. The string is empty
		915	if __;0__ is non-zero.
		916
		917
		918	__register ;3__
		919
		920
		921	Contains the needed space in units after the heading.
		922	Default is 2v.
		923
		924
		925	Can be used to change things like numbering (__}0__),
		926	vertical spacing (__}2__) and the needed space after the
		927	heading.
		928
		929
		930	__HY__ ''dlevel rlevel heading-text''__
		931	HY__ is called after size and font calculations and might
		932	be used to change indentation.
		933
		934
		935	__HZ__ ''dlevel rlevel heading-text''__
		936	HZ__ is called after the printing of the heading, just
		937	before __H__ or __HU__ exits. Could be used to change
		938	the page header according to the section
		939	heading.
		940
		941
		942	__HC [[hyphenation-character]__
		943
		944
		945	Set hyphenation character. Default value is %. Resets to the
		946	default if called without argument. Hyphenation can be
		947	turned off by setting number register __Hy__ to 0 in the
		948	beginning of the file.
		949
		950
		951	__HM [[arg1 [[arg2 [[... [[arg7]]]]__
		952
		953
		954	Heading mark style. Controls the type of marking for
		955	printing of the heading counters. Default is 1 for all
		956	levels.
		957
		958
		959	__Argument__
		960
		961
		962	1
		963
		964
		965	Arabic numerals. 0001
		966
		967
		968	Arabic numerals with leading zeroes, one or more.
		969	A
		970
		971
		972	Upper-case alphabetic a
		973
		974
		975	Lower-case alphabetic I
		976
		977
		978	Upper-case roman numerals i
		979
		980
		981	lower-case roman numerals ''empty''
		982
		983
		984	Arabic numerals.
		985
		986
		987	__HU heading-text__
		988
		989
		990	Unnumbered section header. __HU__ behavies like __H__
		991	at the level in number register __Hu__. See
		992	__H__.
		993
		994
		995	__HX dlevel rlevel heading-text__
		996
		997
		998	Userdefined heading exit. Called just before printing the
		999	header. See __H__.
		1000
		1001
		1002	__HY dlevel rlevel heading-text__
		1003
		1004
		1005	Userdefined heading exit. Called just before printing the
		1006	header. See __H__.
		1007
		1008
		1009	__HZ dlevel rlevel heading-text__
		1010
		1011
		1012	Userdefined heading exit. Called just after printing the
		1013	header. See __H__.
		1014
		1015
		1016	__I [[italic-text [[prev-font-text [[italic-text
		1017	[[...]]]]__
		1018
		1019
		1020	Italic. Changes the font to italic if called without
		1021	arguments. With one argument it will set the word in italic.
		1022	With two argument it will concatenate them and set the first
		1023	word in italic and the second in the previous font. There is
		1024	no limit on the number of argument, all will be
		1025	concatenated.
		1026
		1027
		1028	__IA [[addressee-name [[title]]__
		1029
		1030
		1031	Begins specification of the addressee and addressee's
		1032	address in letter style. Several names can be specified with
		1033	empty __IA__/__IE__-pairs, but only one address. See
		1034	__LT__.
		1035
		1036
		1037	__IB [[italic-text [[bold-text [[italic-text
		1038	[[...]]]]__
		1039
		1040
		1041	Italic-bold. Even arguments is printed in italic, odd in
		1042	boldface. See __I__.
		1043
		1044
		1045	__IE__
		1046
		1047
		1048	Ends the address-specification after __IA__.
		1049
		1050
		1051	__INITI type filename [[macro]__
		1052
		1053
		1054	Initialize the new index system, sets the filename to
		1055	collect index lines in with __IND__. Argument ''type''
		1056	selects the type of index, page number, header marks or
		1057	both. The default is ''N''.
		1058
		1059
		1060	It is also possible to create a macro that is responsible
		1061	for formatting each row. Add the name of the macro as
		1062	argument 3. The macro will be called with the index as
		1063	argument(s).
		1064
		1065
		1066	__type__
		1067
		1068
		1069	N
		1070
		1071
		1072	Page numbers H
		1073
		1074
		1075	Header marks B
		1076
		1077
		1078	Both page numbers and header marks, tab
		1079	separated
		1080
		1081
		1082	__INITR filename__
		1083
		1084
		1085	Initialize the refencemacros. References will be written to
		1086	''filename.tmp'' and ''filename.qrf''. Requires two
		1087	passes with groff. The first looks for references and the
		1088	second includes them. __INITR__ can be used several
		1089	times, but it is only the first occurrence of __INITR__
		1090	that is active. Option __-U__ might be needed if
		1091	__unsafe__-errors occur. See also __SETR__,
		1092	__GETPN__ and __GETHN__.
		1093
		1094
		1095	__IND arg1 [[arg2 [[...]]__
		1096
		1097
		1098	__IND__ writes a line in the index file selected by
		1099	__INITI__ with all arguments and the page number or
		1100	header mark separated by tabs.
		1101
		1102
		1103	__Examples__
		1104	arg1tpage number
		1105	arg1targ2tpage number
		1106	arg1theader mark
		1107	arg1tpage numbertheader mark
		1108
		1109
		1110	__INDP__
		1111
		1112
		1113	__INDP__ prints the index by running the command
		1114	specified by string variable __Indcmd__, normally ''sort
		1115	-tt''. __INDP__ reads the output from the command to
		1116	form the index, normally in two columns (can be changed by
		1117	defining __TYIND__). The index is printed with string
		1118	variable __Index__ as header, default is __INDEX__.
		1119	One-column processing is returned after the list.
		1120	__INDP__ will call the user-defined macros __TXIND__,
		1121	__TYIND__ and __TZIND__ if defined. __TXIND__ is
		1122	called before printing __INDEX__, __TYIND__ is called
		1123	instead of printing __INDEX__. __TZIND__ is called
		1124	after the printing and should take care of restoring to
		1125	normal operation again.
		1126
		1127
		1128	__ISODATE [[0]__
		1129
		1130
		1131	__ISODATE__ changes the predefined date string in
		1132	__DT__ to ISO-format, ie YYYY-MM-DD. This can also be
		1133	done by adding __-rIso=1__ on the command line. Reverts
		1134	to old date format if argument is __0__.
		1135
		1136
		1137	__IR [[italic-text [[roman-text [[italic-text
		1138	[[...]]]]__
		1139
		1140
		1141	Italic-roman. Even arguments is printed in italic, odd in
		1142	roman. See __I__.
		1143
		1144
		1145	__LB text-indent mark-indent pad type [[mark [[LI-space
		1146	[[LB-space]]]__
		1147
		1148
		1149	List begin macro. This is the common macro used for all
		1150	lists. ''Text-indent'' is the number of spaces to indent
		1151	the text from the current indent.
		1152
		1153
		1154	''Pad'' and ''mark-indent'' controls where to put the
		1155	mark. The mark is placed within the mark area, and
		1156	''mark-indent'' sets the number of spaces before this
		1157	area. It is normally 0. The mark area ends where the text
		1158	begins. The start of the text is still controlled by
		1159	''text-indent''.
		1160
		1161
		1162	The mark is left justified whitin the mark area if
		1163	''pad'' is 0. If ''pad'' is greater than 0, then
		1164	''mark-indent'' is ignored, and the mark is placed
		1165	''pad'' spaces before the text. This will right justify
		1166	the mark.
		1167
		1168
		1169	If ''type'' is 0 the list will have either a hanging
		1170	indent or, if argument ''mark'' is given, the string
		1171	''mark'' as mark.
		1172
		1173
		1174	If ''type'' is greater than 0 automatic numbering will
		1175	occur, arabic if ''mark'' is empty. ''Mark'' can then
		1176	be any of __1__, __A__, __a__, __I__ or
		1177	__i__.
		1178
		1179
		1180	''Type'' selects one of six possible ways to display the
		1181	mark.__
		1182	type__
		1183
		1184
		1185	1
		1186
		1187
		1188	x. 2
		1189
		1190
		1191	x) 3
		1192
		1193
		1194	(x) 4
		1195
		1196
		1197	[[x] 5
		1198
		1199
		1200
		1201
		1202	{x}
		1203
		1204
		1205	Every item in the list will get ''LI-space'' number of
		1206	blank lines before them. Default is 1.
		1207
		1208
		1209	__LB__ itself will print ''LB-space'' blank lines.
		1210	Default is 0.
		1211
		1212
		1213	__LC [[list-level]__
		1214
		1215
		1216	List-status clear. Terminates all current active lists down
		1217	to ''list-level'', or 0 if no argmuent is given. This is
		1218	used by __H__ to clear any active list.
		1219
		1220
		1221	__LE [[1]__
		1222
		1223
		1224	List end. Terminate the current list. __LE__ outputs a
		1225	blank line if an argument is given.
		1226
		1227
		1228	__LI [[mark [[1]]__
		1229
		1230
		1231	List item precedes every item in a list. Without argument
		1232	__LI__ will print the mark determined by the current list
		1233	type. By giving __LI__ one argument, it will use that as
		1234	the mark instead. Two arguments to __LI__ will make
		1235	''mark'' a prefix to the current mark. There will be no
		1236	separating space between the prefix and the mark if the
		1237	second argument is __2__ instead of __1__. This
		1238	behaviour can also be achieved by setting number register
		1239	__Limsp__ to zero. A zero length ''mark'' will make a
		1240	hanging indent instead.
		1241
		1242
		1243	A blank line is normally printed before the list item. This
		1244	behaviour can be controlled by number register __Ls__.
		1245	Pre-spacing will occur for each list-level less than or
		1246	equal to __Ls__. Default value is 99. (Nesting of lists
		1247	is unlimited. :-)
		1248
		1249
		1250	The indentation can be changed thru number register
		1251	__Li__. Default is 6.
		1252
		1253
		1254	All lists begins with a list initialization macro,
		1255	__LB__. There are, however, seven predefined listtypes to
		1256	make lists easier to use. They all call __LB__ with
		1257	different default values.
		1258
		1259
		1260	__AL__
		1261
		1262
		1263	Automatically Incremented List __ML__
		1264
		1265
		1266	Marked List __VL__
		1267
		1268
		1269	Variable-Item List __BL__
		1270
		1271
		1272	Bullet List __DL__
		1273
		1274
		1275	Dash List __RL__
		1276
		1277
		1278	Reference List __BVL__
		1279
		1280
		1281	Broken Varable List. These lists are described at other
		1282	places in this manual. See also __LB__.
		1283
		1284
		1285	__LT [[arg]__
		1286
		1287
		1288	Formats a letter in one of four different styles depending
		1289	on the argument. See also __INTERNALS__.
		1290
		1291
		1292	__Arg__
		1293
		1294
		1295	__Style__ BL
		1296
		1297
		1298	Blocked. Date line, return address, writer's address and
		1299	closing begins at the center of the line. All other lines
		1300	begin at the left margin. SB
		1301
		1302
		1303	Semi-blocked. Same as blocked, except that the first line in
		1304	every paragraph is indented five spaces. FB
		1305
		1306
		1307	Full-blocked. All lines begin at the left margin.
		1308	SP
		1309
		1310
		1311	Simplified. Almost the same as the full-blocked style.
		1312	Subject and the writer's identification are printed in
		1313	all-capital.
		1314
		1315
		1316	__LO type [[arg]__
		1317
		1318
		1319	Specify options in letter (see __.LT__). This is a list
		1320	of the standard options:
		1321
		1322
		1323	CN
		1324
		1325
		1326	Confidential notation. Prints __CONFIDENTIAL__ on the
		1327	second line below the date line. Any argument replaces
		1328	__CONFIDENTIAL__. See also string variable __LetCN__.
		1329	RN
		1330
		1331
		1332	Reference notation. Prints __In reference to:__ and the
		1333	argument two lines below the date line. See also string
		1334	variable __LetRN__. AT
		1335
		1336
		1337	Attention. Prints __ATTENTION:__ and the argument below
		1338	the inside address. See also string variable __LetAT__.
		1339	SA
		1340
		1341
		1342	Salutation. Prints __To Whom It May Concern:__ or the
		1343	argument if it was present. The salutation is printed two
		1344	lines below the inside address. See also string variable
		1345	__LetSA__. SJ
		1346
		1347
		1348	Subject line. Prints the argument as subject prefixed with
		1349	__SUBJECT:__ two lines below the inside address, except
		1350	in letter type __SP__. Then the subject is printed in
		1351	all-captial without any prefix. See also string variable
		1352	__LetSJ__.
		1353
		1354
		1355	__MC column-size [[column-separation]__
		1356
		1357
		1358	Begin multiple columns. Return to normal with __1C__.
		1359	__MC__ will create as many columns as the current line
		1360	length permits. ''Column-size'' is the width of each
		1361	column, and ''column-separation'' is the space between
		1362	two columns. Default separation is the column-size/15. See
		1363	also __1C__.
		1364
		1365
		1366	__ML mark [[text-indent [[1]]__
		1367
		1368
		1369	Marked list start. The ''mark'' argument will be printed
		1370	before each list item. ''Text-indent'' sets the indent
		1371	and overrides __Li__. A third argument will prohibit
		1372	printing of a blank line before each item.
		1373
		1374
		1375	__MT [[arg [[addressee]]__
		1376
		1377
		1378	Memorandum type. The ''arg'' is part of a filename in
		1379	''/usr/share/groff/1.17.2/tmac/mm/*.MT''. Memorandum type
		1380	0 thru 5 are supported, including ''''.
		1381	''Addressee'' just sets a variable, used in the AT
		1382	''
		1383	arg__
		1384
		1385
		1386	0
		1387
		1388
		1389	Normal memorandum, no type printed 1
		1390
		1391
		1392	Memorandum with ''MEMORANDUM FOR FILE'' printed
		1393	2
		1394
		1395
		1396	Memorandum with ''PROGRAMMER'S NOTES'' printed
		1397	3
		1398
		1399
		1400	Memorandum with ''ENGINEER'S NOTES'' printed
		1401	4
		1402
		1403
		1404	Released paper style 5
		1405
		1406
		1407	External letter style See also __COVER__/__COVEND__, a
		1408	more flexible type of front page.
		1409
		1410
		1411	__MOVE y-pos [[x-pos [[line-length]]__
		1412
		1413
		1414	Move to a position, pageoffset set to ''x-pos''. If
		1415	''line-length'' is not given, the difference between
		1416	current and new pageoffset is used. Use __PGFORM__
		1417	without arguments to return to normal.
		1418
		1419
		1420	__MULB cw1 space1 [[cw2 space2 [[cw3 ...]]__
		1421
		1422
		1423	Begin a special multi-column mode. Every columns width must
		1424	be specified. Also the space between the columns must be
		1425	specified. The last column does not need any
		1426	space-definition. __MULB__ starts a diversion and
		1427	__MULE__ ends the diversion and prints the columns. The
		1428	unit for width and space is 'n', but __MULB__ accepts all
		1429	normal unitspecifications like 'c' and 'i'. __MULB__
		1430	operates in a separate environment.
		1431
		1432
		1433	__MULN__
		1434
		1435
		1436	Begin the next column. This is the only way to switch
		1437	column.
		1438
		1439
		1440	__MULE__
		1441
		1442
		1443	End the multi-column mode and print the
		1444	columns.
		1445
		1446
		1447	__nP [[type]__
		1448
		1449
		1450	Print numbered paragraph with header level two. See
		1451	__.P__.
		1452
		1453
		1454	__NCOL__
		1455
		1456
		1457	Force printing to the next column, don't use this together
		1458	with the __MUL*__ macros, see __2C__.
		1459
		1460
		1461	__NS [[arg [[1]]__
		1462
		1463
		1464	Prints different types of notations. The argument selects
		1465	between the predefined type of notations. If the second
		1466	argument is available, then the argument becomes the entire
		1467	notation. If the argument doesn't exist in the predefined,
		1468	it will be printed as __Copy (__''arg''__) to__. It
		1469	is possible to add more standard notations, see the string
		1470	variable __Letns__ and __Letnsdef__.
		1471
		1472
		1473	__Arg
		1474	Notation
		1475	__''none
		1476	'' Copy To
		1477	''
		1478
		1479
		1480	__ND new-date__
		1481
		1482
		1483	New date. Override the current date. Date is not printed if
		1484	''new-date'' is an empty string.
		1485
		1486
		1487	__OF [[arg]__
		1488
		1489
		1490	Odd-page footer, a line printed just above the normal
		1491	footer. See __EF__ and __PF__.
		1492
		1493
		1494	__OH [[arg]__
		1495
		1496
		1497	Odd-page header, a line printed just below the normal
		1498	header. See __EH__ and __PH__.
		1499
		1500
		1501	__OP__
		1502
		1503
		1504	Make sure that the following text is printed at the top of
		1505	an odd-numbered page. Will not output an empty page if
		1506	currently at the top of an odd page.
		1507
		1508
		1509	__P [[type]__
		1510
		1511
		1512	Begin new paragraph. __P__ without argument will produce
		1513	left justified text, even the first line of the paragraph.
		1514	This is the same as setting ''type'' to 0. If the
		1515	argument is 1, then the first line of text following
		1516	__P__ will be indented by the number of spaces in number
		1517	register __Pi__, normally 5.
		1518
		1519
		1520	Instead of giving 1 as argument to __P__ it is possible
		1521	to set the paragraph type in number register __Pt__.
		1522	Using 0 and 1 will be the same as adding that value to
		1523	__P__. A value of 2 will indent all paragraphs, except
		1524	after headings, lists and displays.
		1525
		1526
		1527	The space between two paragraphs is controlled by number
		1528	register __Ps__, and is 1 by default (one blank
		1529	line).
		1530
		1531
		1532	__PGFORM [[linelength [[pagelength [[pageoffset
		1533	[[1]]]]__
		1534
		1535
		1536	Sets linelength, pagelength and/or pageoffset. This macro
		1537	can be used for special formatting, like letterheads and
		1538	other. It is normally the first command in a file, though
		1539	it's not necessary. __PGFORM__ can be used without
		1540	arguments to reset everything after a __MOVE__. A
		1541	line-break is done unless the fourth argument is given. This
		1542	can be used to avoid the pagenumber on the first page while
		1543	setting new width and length. (It seems as if this macro
		1544	sometimes doesn't work too well. Use the command line
		1545	arguments to change linelength, pagelength and pageoffset
		1546	instead. Sorry.)
		1547
		1548
		1549	__PGNH__
		1550
		1551
		1552	No header is printed on the next page. Used to get rid of
		1553	the header in letters or other special texts. This macro
		1554	must be used before any text to inhibit the pageheader on
		1555	the first page.
		1556
		1557
		1558	__PIC [[-L] [[-C] [[-R] [[-I n] filename [[width
		1559	[[height]]__
		1560
		1561
		1562	__PIC__ includes a Postscript file in the document. The
		1563	macro depends on __mmroff__ and __INITR__. __-L__,
		1564	__-C__, __-R__ and __-I n__ adjusts the picture or
		1565	indents it. The optionally ''width'' and ''height''
		1566	can also be given to resize the picture.
		1567
		1568
		1569	__PE__
		1570
		1571
		1572	Picture end. Ends a picture for __pic__, see the manual
		1573	for __pic__.
		1574
		1575
		1576	__PF [[arg]__
		1577
		1578
		1579	Page footer. __PF__ sets the line to be printed at the
		1580	bottom of each page. Normally empty. See __PH__ for the
		1581	argument specification.
		1582
		1583
		1584	__PH [[arg]__
		1585
		1586
		1587	Page header, a line printed at the top of each page. The
		1588	argument should be specified as
		1589	%__ is changed to
		1590	the current page number. The default page-header is
		1591	__
		1592
		1593
		1594	__PS__
		1595
		1596
		1597	Picture start (from pic). Begins a picture for __pic__,
		1598	see the manual.
		1599
		1600
		1601	__PX__
		1602
		1603
		1604	Page-header user-defined exit. __PX__ is called just
		1605	after the printing of the page header in ''no-space''
		1606	mode.
		1607
		1608
		1609	__R__
		1610
		1611
		1612	Roman. Return to roman font, see also __I__.
		1613
		1614
		1615	__RB [[roman-text [[bold-text [[roman-text
		1616	[[...]]]]__
		1617
		1618
		1619	Roman-bold. Even arguments is printed in roman, odd in
		1620	boldface. See __I__.
		1621
		1622
		1623	__RD [[prompt [[diversion [[string]]]__
		1624
		1625
		1626	Read from standard input to diversion and/or string. The
		1627	text will be saved in a diversion named ''diversion''.
		1628	Recall the text by writing the name of the diversion after a
		1629	dot on an empty line. A string will also be defined if
		1630	''string'' is given. ''Diversion'' and/or
		1631	''prompt'' can be empty (''
		1632
		1633
		1634	__RF__
		1635
		1636
		1637	Reference end. Ends a reference definition and returns to
		1638	normal processing. See __RS__.
		1639
		1640
		1641	__RI [[roman-text [[italic-text [[roman-text
		1642	[[...]]]]__
		1643
		1644
		1645	Even arguments are printed in roman, odd in italic. See
		1646	__I__.
		1647
		1648
		1649	__RL [[text-indent [[1]]__
		1650
		1651
		1652	Reference list start. Begins a list where each item is
		1653	preceded with a automatically incremented number between
		1654	square brackets. ''Text-indent'' changes the default
		1655	indentation.
		1656
		1657
		1658	__RP [[arg1 [[arg2]]__
		1659
		1660
		1661	Produce reference page. __RP__ can be used if a reference
		1662	page is wanted somewhere in the document. It is not needed
		1663	if __TC__ is used to produce a table of content. The
		1664	reference page will then be printed
		1665	automatically.
		1666
		1667
		1668	The reference counter will not be reset if ''arg1'' is
		1669	1.
		1670
		1671
		1672	''Arg2'' tells __RP__ whether to eject a page or
		1673	not.__
		1674	Arg2__
		1675
		1676
		1677	0
		1678
		1679
		1680	The reference page will be printed on a separate page. This
		1681	is the default. 1
		1682
		1683
		1684	Do not eject page after the list. 2
		1685
		1686
		1687	Do not eject page before the list. 3
		1688
		1689
		1690	Do not eject page before and after the list. The reference
		1691	items will be separated by a blank line. Setting number
		1692	register __Ls__ to 0 will suppress the line.
		1693
		1694
		1695	The string __Rp__ contains the reference page title and
		1696	is normally set to ''REFERENCES''.
		1697
		1698
		1699	__RS [[string-name]__
		1700
		1701
		1702	__RS__ begins an automatically numbered reference
		1703	definition. Put the string __*(Rf__ where the reference
		1704	mark should be and write the reference between
		1705	__RS__/__RF__ at next new line after the reference
		1706	mark. The reference number is stored in number register
		1707	__:R__. If ''string-name'' is given, a string with
		1708	that name will be defined and contain the current reference
		1709	mark. The string can be referenced as
		1710	__*[[__''string-name''__]__ ''later in the
		1711	text.''
		1712
		1713
		1714	__S [[size [[spacing]]__
		1715
		1716
		1717	Set point size and vertical spacing. If any argument is
		1718	equal 'P', then the previous value is used. A 'C' means
		1719	current value, and 'D' default value. If '+' or '-' is used
		1720	before the value, then increment or decrement of the current
		1721	value will be done.
		1722
		1723
		1724	__SA [[arg]__
		1725
		1726
		1727	Set right-margin justification. Justification is normally
		1728	turned on. No argumenent or __0__ turns off
		1729	justification, a __1__ turns on
		1730	justification.
		1731
		1732
		1733	__SETR refname [[string]__
		1734
		1735
		1736	Remember the current header and page-number as
		1737	''refname''. Saves ''string'' if ''string'' is
		1738	defined. ''string'' is retrieved with __.GETST__. See
		1739	__INITR__.
		1740
		1741
		1742	__SG [[arg [[1]]__
		1743
		1744
		1745	Signature line. Prints the authors name(s) after the formal
		1746	closing. The argument will be appended to the reference
		1747	data, printed at either the first or last author. The
		1748	reference data is the location, department and initials
		1749	specified with __.AU__. It will be printed at the first
		1750	author if the second argument is given, otherwise at the
		1751	last. No reference data will be printed if the author(s) is
		1752	specifed thru __.WA__/__.WE__. See
		1753	__INTERNALS__.
		1754
		1755
		1756	__SK [[pages]__
		1757
		1758
		1759	Skip pages. If ''pages'' is __0__ or omitted, a skip
		1760	to the next page will occur unless it is already at the top
		1761	of a page. Otherwise it will skip ''pages''
		1762	pages.
		1763
		1764
		1765	__SM string1 [[string2 [[string3]]__
		1766
		1767
		1768	Make a string smaller. If ''string2'' is given,
		1769	''string1'' will be smaller and ''string2'' normal,
		1770	concatenated with ''string1''. With three argument, all
		1771	is concatenated, but only ''string2'' is made
		1772	smaller.
		1773
		1774
		1775	__SP [[lines]__
		1776
		1777
		1778	Space vertically. ''lines'' can have any scalingfactor,
		1779	like ''3i'' or ''8v''. Several __SP__ in a line
		1780	will only produce the maximum number of lines, not the sum.
		1781	__SP__ will also be ignored until the first textline in a
		1782	page. Add a ____ before __SP__ to avoid
		1783	this.
		1784
		1785
		1786	__TAB__
		1787
		1788
		1789	reset tabs to every 5n. Normally used to reset any previous
		1790	tabpositions.
		1791
		1792
		1793	__TB [[title [[override [[flag [[refname]]]]__
		1794
		1795
		1796	Table title, arguments are the same as for __EC__.
		1797	__TB__ uses the number register __Tb__ as counter. The
		1798	string __Lt__ controls the title of the List of Tables,
		1799	default is ''LIST OF TABLES''. The List of Tables will
		1800	only be printed if number register __Lt__ is 1, default
		1801	1. The string __Litb__ contains the word ''TABLE'',
		1802	wich is printed before the number.
		1803	Special handling of the title will occur if __TB__ is
		1804	used inside __DS__/__DE__, it will not be affected by
		1805	the format of __DS__.
		1806
		1807
		1808	__TC [[slevel [[spacing [[tlevel [[tab [[h1 [[h2 [[h3 [[h4
		1809	[[h5]]]]]]]]]__
		1810
		1811
		1812	Table of contents. This macro is normally used at the last
		1813	line of the document. It generates a table of contents with
		1814	headings up to the level controlled by number register
		1815	__Cl__. Note that __Cl__ controls the saving of
		1816	headings, it has nothing to do with __TC__. Headings with
		1817	level less than or equal to ''slevel'' will get
		1818	''spacing'' number of lines before them. Headings with
		1819	level less than or equal to ''tlevel'' will have their
		1820	page numbers right justified with dots or spaces separating
		1821	the text and the page number. Spaces is used if ''tab''
		1822	is greater than zero, otherwise dots. Other headings will
		1823	have the page number directly at the end of the heading text
		1824	(''ragged right'').
		1825
		1826
		1827	The rest of the arguments will be printed, centered, before
		1828	the table of contents.
		1829
		1830
		1831	The user-defined macros __TX__ and __TY__ are used if
		1832	__TC__ is called with at most four arguments. __TX__
		1833	is called before the printing of ''CONTENTS'', and
		1834	__TY__ is called instead of printing
		1835	''CONTENTS''.
		1836
		1837
		1838	Equivalent macros can be defined for list of figures,
		1839	tables, equations and excibits by defining __TXxx__ or
		1840	__TYxx__, where __xx__ is __Fg__, __TB__,
		1841	__EC__ or __EX__.
		1842
		1843
		1844	String __Ci__ can be set to control the indentations for
		1845	each heading-level. It must be scaled, like __.ds Ci .25i
		1846	.5i .75i 1i 1i__. The indentation is normally controlled
		1847	by the maxlength of headings in each level.
		1848
		1849
		1850	All texts can be redefined, new stringvariables ''Lifg'',
		1851	''Litb'', ''Liex'', ''Liec'' and ''Licon''
		1852	contain
		1853	''
		1854
		1855
		1856	__TE__
		1857
		1858
		1859	Table end. See __TS__.
		1860
		1861
		1862	__TH [[N]__
		1863
		1864
		1865	Table header. See __TS__. __TH__ ends the header of
		1866	the table. This header will be printed again if a page-break
		1867	occurs. Argument ''N'' isn't implemented
		1868	yet.
		1869
		1870
		1871	__TL [[charging-case number(s) [[filing-case
		1872	number(s)]]__
		1873
		1874
		1875	Begin title of memorandum. All text up to the next __AU__
		1876	is included in the title. ''Charging-case number'' and
		1877	''filing-case'' are saved for use in the front page
		1878	processing.
		1879
		1880
		1881	__TM [[num1 [[num2 [[...]]]__
		1882
		1883
		1884	Technical memorandumnumbers used in __.MT__. Unlimited
		1885	number of arguments may be given.
		1886
		1887
		1888	__TP__
		1889
		1890
		1891	Top of page user-defined macro. This macro is called instead
		1892	of the normal page header. It is possible to get complete
		1893	control over the header. Note that header and footer is
		1894	printed in a separate environment. Linelength is preserved
		1895	though.
		1896
		1897
		1898	__TS [[H]__
		1899
		1900
		1901	Table start. This is the start of a table specification to
		1902	__tbl__. See separate manual for __tbl__. __TS__
		1903	ends with __TE__. Argument ''H'' tells __mm__ that
		1904	the table has a header. See __TH__.
		1905
		1906
		1907	__TX__
		1908
		1909
		1910	Userdefined table of contents exit. This macro is called
		1911	just before __TC__ prints the word ''CONTENTS''. See
		1912	__TC__.
		1913
		1914
		1915	__TY__
		1916
		1917
		1918	Userdefined table of contents exit (no
		1919	CONTENTS''. See __TC__.
		1920
		1921
		1922	__VERBON [[flag [[pointsize [[font]]]__
		1923
		1924
		1925	Begin verbatim output using courier font. Usually for
		1926	printing programs. All character has equal width. The
		1927	pointsize can be changed with the second argument. By
		1928	specifying the font-argument it is possible to use another
		1929	font instead of courier. ''flag'' controls several
		1930	special features. It contains the sum of all wanted
		1931	features.
		1932
		1933
		1934	Value
		1935
		1936
		1937	Description 1
		1938
		1939
		1940	Disable the escape-character (). This is normally turned on
		1941	during verbose output. 2
		1942
		1943
		1944	Add an empty line before the verbose text. 4
		1945
		1946
		1947	Add an empty line after the verbose text. 8
		1948
		1949
		1950	Print the verbose text with numbered lines. This adds four
		1951	digitsized spaces in the beginning of each line. Finer
		1952	control is available with the string-variable __Verbnm__.
		1953	It contains all arguments to the __troff__-command
		1954	__.nm__, normally '1'. 16
		1955
		1956
		1957	Indent the verbose text with five 'n':s. This is controlled
		1958	by the number-variable __Verbin__ (in
		1959	units).
		1960
		1961
		1962	__VERBOFF__
		1963
		1964
		1965	End verbatim output.
		1966
		1967
		1968	__VL text-indent [[mark-indent [[1]]__
		1969
		1970
		1971	Variable-item list has no fixed mark, it assumes that every
		1972	__LI__ have a mark instead. ''Text-indent'' sets the
		1973	indent to the text, and ''mark-indent'' the distance from
		1974	the current indent to the mark. A third argument will
		1975	prohibit printing of a blank line before each
		1976	item.
		1977
		1978
		1979	__VM [[top [[bottom]]__
		1980
		1981
		1982	Vertical margin.
		1983
		1984
		1985	__WA [[writer-name [[title]]__
		1986
		1987
		1988	Begins specification of the writer and writer's address.
		1989	Several names can be specified with empty
		1990	__WA__/__WE__-pairs, but only one
		1991	address.
		1992
		1993
		1994	__WE__
		1995
		1996
		1997	Ends the address-specification after
		1998	__.WA__.
		1999
		2000
		2001	__WC [[format]__
		2002
		2003
		2004	Footnote and display width control.
		2005
		2006
		2007	N
		2008
		2009
		2010	Set default mode, __-WF__, __-FF__, __-WD__ and
		2011	__FB__. WF
		2012
		2013
		2014	Wide footnotes, wide also in two-column mode.
		2015	-WF
		2016
		2017
		2018	Normal footnote width, follow column mode. FF
		2019
		2020
		2021	All footnotes gets the same width as the first footnote
		2022	encountered. -FF
		2023
		2024
		2025	Normal footnotes, width follows __WF__ and __-WF__.
		2026	WD
		2027
		2028
		2029	Wide displays, wide also in two-column mode.
		2030	-WD
		2031
		2032
		2033	Normal display width, follow column mode. FB
		2034
		2035
		2036	Floating displays generates a line break when printed on the
		2037	current page. -FB
		2038
		2039
		2040	Floating displays does not generate line break.
		2041
		2042
		2043	__Strings used in mm:__
		2044
		2045
		2046	__App__
		2047
		2048
		2049	A string containing the word
		2050
		2051
		2052	__Apptxt__
		2053
		2054
		2055	The current appendix text.
		2056
		2057
		2058	__EM__ Em dash string
		2059
		2060
		2061	__H1txt__
		2062
		2063
		2064	Will be updated by __.H__ and __.HU__ to the current
		2065	heading text. Also updated in table of contents
		2066	__
		2067
		2068
		2069	__HF__
		2070
		2071
		2072	Fontlist for headings, normally
		2073
		2074
		2075	__HP__
		2076
		2077
		2078	Pointsize list for headings. Normally
		2079
		2080
		2081	__Index__
		2082
		2083
		2084	Contains ''INDEX''.
		2085
		2086
		2087	__Indcmd__
		2088
		2089
		2090	Contains the index command, ''sort -tt''.
		2091
		2092
		2093	__Lifg__ String containing ''Figure''.
		2094
		2095
		2096	__Litb__
		2097
		2098
		2099	String containing ''TABLE''.
		2100
		2101
		2102	__Liex__
		2103
		2104
		2105	String containing ''Exhibit''.
		2106
		2107
		2108	__Liec__
		2109
		2110
		2111	String containing ''Equation''.
		2112
		2113
		2114	__Licon__
		2115
		2116
		2117	String containing ''CONTENTS''.
		2118
		2119
		2120	__Lf__
		2121
		2122
		2123	Contains
		2124
		2125
		2126	__Lt__
		2127
		2128
		2129	Contains
		2130
		2131
		2132	__Lx__
		2133
		2134
		2135	Contains
		2136
		2137
		2138	__Le__
		2139
		2140
		2141	Contains
		2142
		2143
		2144	__Letfc__
		2145
		2146
		2147	Contains
		2148	.FC__.
		2149
		2150
		2151	__Letapp__
		2152
		2153
		2154	Contains
		2155	.AV__.
		2156
		2157
		2158	__Letdate__
		2159
		2160
		2161	Contains .AV__.
		2162
		2163
		2164	__LetCN__
		2165
		2166
		2167	Contains .LO
		2168	CN__.
		2169
		2170
		2171	__LetSA__
		2172
		2173
		2174	Contains .LO
		2175	SA__.
		2176
		2177
		2178	__LetAT__
		2179
		2180
		2181	Contains .LO
		2182	AT__.
		2183
		2184
		2185	__LetSJ__
		2186
		2187
		2188	Contains .LO
		2189	SJ__.
		2190
		2191
		2192	__LetRN__
		2193
		2194
		2195	Contains .LO
		2196	RN__.
		2197
		2198
		2199	__Letns__
		2200
		2201
		2202	is an array containing the different strings used in
		2203	__.NS__. It is really a number of stringvariables
		2204	prefixed with __Letns!__. If the argument doesn't exist,
		2205	it will be included between __()__ with __Letns!copy__
		2206	as prefix and __Letns!to__ as suffix. Observe the space
		2207	after __copy__ and before __to__.
		2208
		2209
		2210	__Name Value
		2211	__Letns!0 Copy to
		2212	Letns!1 Copy (with att.) to
		2213	Letns!2 Copy (without att.) to
		2214	Letns!3 Att.
		2215	Letns!4 Atts.
		2216	Letns!5 Enc.
		2217	Letns!6 Encs.
		2218	Letns!7 Under separate cover
		2219	Letns!8 Letter to
		2220	Letns!9 Memorandum to
		2221	Letns!10 Copy (with atts.) to
		2222	Letns!11 Copy (without atts.) to
		2223	Letns!12 Abstract Only to
		2224	Letns!13 Complete Memorandum to
		2225	Letns!14 CC
		2226	Letns!copy Copy
		2227	__
		2228
		2229
		2230	__Letnsdef__
		2231
		2232
		2233	Defines the standard-notation used when no argument is given
		2234	to __.NS__. Default is __0__.
		2235
		2236
		2237	__MO1 - MO12__
		2238
		2239
		2240	Strings containing ''January'' thru
		2241	''December''.
		2242
		2243
		2244	__Qrf__
		2245
		2246
		2247	String containing
		2248
		2249
		2250	__Rp__
		2251
		2252
		2253	Contains
		2254
		2255
		2256	__Tcst__
		2257
		2258
		2259	Contains current status of table of contents and list of
		2260	XXXX. Empty outside __.TC__. Useful in user-defined
		2261	macros like __.TP__.
		2262
		2263
		2264	__Value Meaning
		2265	__co Table of contents
		2266	fg List of figures
		2267	tb List of tables
		2268	ec List of equations
		2269	ex List of exhibits
		2270	ap Appendix
		2271
		2272
		2273	__Tm__
		2274
		2275
		2276	Contains trade mark.
		2277
		2278
		2279	__Verbnm__
		2280
		2281
		2282	Argument to __.nm__ in __.VERBON__, default:
		2283	__1__.
		2284
		2285
		2286	__Number variables used in mm:__
		2287
		2288
		2289	__Aph__
		2290
		2291
		2292	Print an appendix-page for every new appendix if this
		2293	numbervariable is non-zero. No output will occur if
		2294	__Aph__ is zero, but there will always be an
		2295	appendix-entry in the 'List of contents'.
		2296
		2297
		2298	__Cl__
		2299
		2300
		2301	Contents level [[0:7], contents saved if heading level
		2302
		2303
		2304	__Cp__
		2305
		2306
		2307	Eject page between LIST OF XXXX if Cp == 0, default
		2308	0.
		2309
		2310
		2311	__D__
		2312
		2313
		2314	Debugflag, values
		2315
		2316
		2317	__De__
		2318
		2319
		2320	Eject after floating display is output [[0:1], default
		2321	0.
		2322
		2323
		2324	__Dsp__
		2325
		2326
		2327	Controls the space output before and after static displays
		2328	if defined. Otherwise is the value of Lsp used.
		2329
		2330
		2331	__Df__
		2332
		2333
		2334	Floating keep output [[0:5], default 5.
		2335
		2336
		2337	__Ds__
		2338
		2339
		2340	__Lsp__ space before and after display if == 1 [[0:1],
		2341	default 1.
		2342
		2343
		2344	__Ej__
		2345
		2346
		2347	Eject page, default 0.
		2348
		2349
		2350	__Eq__
		2351
		2352
		2353	Equation lable adjust 0=left, 1=right. Default
		2354	0.
		2355
		2356
		2357	__Fs__
		2358
		2359
		2360	Footnote spacing, default 1.
		2361
		2362
		2363	__H1-H7__
		2364
		2365
		2366	Heading counters
		2367
		2368
		2369	__H1dot__
		2370
		2371
		2372	Append a dot after the level one heading number if
		2373
		2374
		2375	__H1h__
		2376
		2377
		2378	Copy of number register __H1__, but it is
		2379	incremented
		2380
		2381
		2382	just before the page break. Useful in user defined header
		2383	macros. __Hb__ Heading break level [[0:7], default
		2384	2.
		2385
		2386
		2387	__Hc__
		2388
		2389
		2390	Heading centering level, [[0:7]. Default 0.
		2391
		2392
		2393	__Hi__
		2394
		2395
		2396	Heading temporary indent [[0:2], default 1.
		2397	0 -
		2398	1 -
		2399	2 -
		2400
		2401
		2402	__Hps__
		2403
		2404
		2405	Numbervariable with the heading pre-space level. If the
		2406	heading-level is less than or equal to __Hps__, then two
		2407	lines will precede the section heading instead of one.
		2408	Default is first level only. The real amount of lines is
		2409	controlled by the variables __Hps1__ and
		2410	__Hps2__.
		2411
		2412
		2413	__Hps1__
		2414
		2415
		2416	This is the number of lines preceding __.H__ when the
		2417	heading-level is greater than __Hps__. Value is in units,
		2418	normally 0.5.
		2419
		2420
		2421	__Hps2__
		2422
		2423
		2424	This is the number of lines preceding __.H__ when the
		2425	heading-level is less than or equal to __Hps__. Value is
		2426	in units, normally 1.
		2427
		2428
		2429	__Hs__
		2430
		2431
		2432	Heading space level [[0:7], default 2.
		2433
		2434
		2435	__Hss__
		2436
		2437
		2438	This is the number of lines that follows __.H__ when the
		2439	heading-level is less than or equal to __Hs__. Value is
		2440	in units, normally 1.
		2441
		2442
		2443	__Ht__
		2444
		2445
		2446	Heading numbering type, default 0. 0 -
		2447	1 -
		2448
		2449
		2450	__Hu__
		2451
		2452
		2453	Unnumbered heading level, default 2.
		2454
		2455
		2456	__Hy__
		2457
		2458
		2459	Hyphenation in body, default 1.
		2460	0 -
		2461	1 -
		2462
		2463
		2464	__Iso__
		2465
		2466
		2467	Set this variable to 1 on the command line to get
		2468	ISO-formatted date string. (__-rIso=1__) Useless inside a
		2469	document.
		2470
		2471
		2472	__Letwam__
		2473
		2474
		2475	Max lines in return-address, used in __.WA__/__.WE__.
		2476	Default 14.
		2477
		2478
		2479	__Lf, Lt, Lx, Le__
		2480
		2481
		2482	Enables (1) or disables (0) the printing of List of figures,
		2483	List of tables, List of exhibits and List of equations.
		2484	Default: Lf=1, Lt=1, Lx=1, Le=0.
		2485
		2486
		2487	__Li__
		2488
		2489
		2490	List indent, used by .AL, default 6.
		2491
		2492
		2493	__Limsp__
		2494
		2495
		2496	Flag for space between prefix and mark in automatic lists
		2497	(.AL).
		2498	0 == no space
		2499	1 == space
		2500
		2501
		2502	__Ls__
		2503
		2504
		2505	List space, if current listlevel
		2506
		2507
		2508	__Lsp__
		2509
		2510
		2511	The size of an empty line. Normally 0.5v, but it is 1v if
		2512	__n__ is set (__.nroff__).
		2513
		2514
		2515	__N__
		2516
		2517
		2518	Numbering style [[0:5], default 0.
		2519	0 == (default) normal header for all pages.
		2520	1 == header replaces footer on first page, header is
		2521	empty.
		2522	2 == page header is removed on the first page.
		2523	3 ==
		2524	4 == page header is removed on the first page.
		2525	5 ==
		2526
		2527
		2528	__Np__
		2529
		2530
		2531	Numbered paragraphs, default 0.
		2532	0 == not numbered
		2533	1 == numbered in first level headings.
		2534
		2535
		2536	__Of__
		2537
		2538
		2539	Format of figure,table,exhibit,equation titles, default
		2540	0.
		2541	0 =
		2542	1 =
		2543
		2544
		2545	__P__
		2546
		2547
		2548	Current page-number, normally the same as % unless
		2549
		2550
		2551	__Pi__
		2552
		2553
		2554	paragraph indent, default 5.
		2555
		2556
		2557	__Pgps__
		2558
		2559
		2560	Controls whether header and footer pointsize should follow
		2561	the current setting or just change when the header and
		2562	footer is defined.
		2563
		2564
		2565	Value
		2566
		2567
		2568	Description 0
		2569
		2570
		2571	Pointsize will only change to the current setting when
		2572	__.PH__, __.PF__, __.OH__, __.EH__, __.OF__
		2573	or __.OE__ is executed. 1
		2574
		2575
		2576	Pointsize will change after every __.S__. This is the
		2577	default.
		2578
		2579
		2580	__Ps__
		2581
		2582
		2583	paragraph spacing, default 1.
		2584
		2585
		2586	__Pt__
		2587
		2588
		2589	Paragraph type, default 0.
		2590	0 == left-justified
		2591	1 == indented .P
		2592	2 == indented .P except after .H, .DE or .LE.
		2593
		2594
		2595	__Sectf__
		2596
		2597
		2598	Flag controlling
		2599
		2600
		2601	__Sectp__
		2602
		2603
		2604	Flag controlling
		2605
		2606
		2607	__Si__
		2608
		2609
		2610	Display indent, default 5.
		2611
		2612
		2613	__Verbin__
		2614
		2615
		2616	Indent for __.VERBON__, default 5n.
		2617
		2618
		2619	__.mgm__
		2620
		2621
		2622	Always 1.
		2623	!!INTERNALS
		2624
		2625
		2626	The letter macros is using different submacros depending on
		2627	the letter type. The name of the submacro has the letter
		2628	type as suffix. It is therefore possible to define other
		2629	letter types, either in the national macro-file, or as local
		2630	additions. __.LT__ will set the number variables
		2631	__Pt__ and __Pi__ to 0 and 5. The following strings
		2632	and macros must be defined for a new letter
		2633	type:
		2634
		2635
		2636	__let@init___''type''
		2637
		2638
		2639	This macro is called directly by __.LT__. It is supposed
		2640	to initialize variables and other stuff.
		2641
		2642
		2643	__let@head___''type''
		2644
		2645
		2646	This macro prints the letter head, and is called instead of
		2647	the normal page header. It is supposed to remove the alias
		2648	__let@header__, otherwise it will be called for all
		2649	pages.
		2650
		2651
		2652	__let@sg___''type name title n flag [[arg1 [[arg2
		2653	[[...]]]''
		2654
		2655
		2656	__.SG__ is calling this macro only for letters,
		2657	memorandums has its own processing. ''name'' and
		2658	''title'' is specified thru __.WA__/__.WB__.
		2659	''n'' is the counter, 1-max, and ''flag'' is true for
		2660	the last name. Any other argument to __.SG__ is
		2661	appended.
		2662
		2663
		2664	__let@fc___''type closing''
		2665
		2666
		2667	This macro is called by __.FC__, and has the formal
		2668	closing as argument.
		2669
		2670
		2671	__.LO__ is implemented as a general option-macro.
		2672	__.LO__ demands that a string named __Let__''type''
		2673	is defined, where ''type'' is the letter type. __.LO__
		2674	will then assign the argument to the string variable
		2675	__let*lo-__''type''.
		2676	!!AUTHOR
		2677
		2678
		2679	J
		2680	!!FILES
		2681
		2682
		2683	__/usr/share/groff/1.17.2/tmac/tmac.m__
		2684
		2685
		2686	__/usr/share/groff/1.17.2/tmac/mm/*.cov__
		2687
		2688
		2689	__/usr/share/groff/1.17.2/tmac/mm/*.MT__
		2690
		2691
		2692	__/usr/share/groff/1.17.2/tmac/mm/locale__
		2693	!!SEE ALSO
		2694
		2695
		2696	groff(1), troff(1), tbl(1),
		2697	pic(1), eqn(1)__
		2698	mm__(7) mmse(7)
		2699	----