4 File position: <groff-source>/man/groff_tmac.man
6 This file is part of groff, the GNU roff type-setting system.
8 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008
9 Free Software Foundation, Inc.
10 written by Bernd Warken <bwarken@mayn.de> and Werner Lemberg
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.1 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being this .ig-section and AUTHOR, with no
17 Front-Cover Texts, and with no Back-Cover Texts.
19 A copy of the Free Documentation License is included as a file called
20 FDL in the main directory of the groff source package.
22 .ds Ellipsis \&.\|.\|.\&\"
24 .TH GROFF_TMAC @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@"
26 groff_tmac \- macro files in the roff typesetting system
29 .\" --------------------------------------------------------------------
31 .\" --------------------------------------------------------------------
35 type-setting system provides a set of macro packages suitable for
36 special kinds of documents.
38 Each macro package stores its macros and definitions in a file called
41 The name is deduced from
47 The tmac files are normal roff source documents, except that they
48 usually contain only definitions and setup commands, but no text.
50 All tmac files are kept in a single or a small number of directories,
56 .\" --------------------------------------------------------------------
57 .SH "GROFF MACRO PACKAGES"
58 .\" --------------------------------------------------------------------
61 provides all classical macro packages, some more full packages, and
62 some secondary packages for special purposes.
64 Note that it is not possible to use multiple primary macro packages at the
65 same time; saying e.g.\&
69 \fIsh#\fP groff \-m man \-m ms foo
77 \fIsh#\fP groff \-m man foo \-m ms bar
84 .\" --------------------------------------------------------------------
86 .\" --------------------------------------------------------------------
90 This is the classical macro package for UNIX manual pages
91 (man\~pages); it is quite handy and easy to use; see
92 .BR groff_man (@MAN7EXT@).
99 An alternative macro package for man\~pages mainly used in BSD
100 systems; it provides many new features, but it is not the standard for
102 .BR groff_mdoc (@MAN7EXT@).
105 .\" --------------------------------------------------------------------
107 .\" --------------------------------------------------------------------
109 The packages in this section provide a complete set of macros for
110 writing documents of any kind, up to whole books.
112 They are similar in functionality; it is a matter of taste which one
121 .BR groff_me (@MAN7EXT@).
129 .BR groff_mm (@MAN7EXT@).
136 macro package, only available in groff.
138 As this is not based on other packages, it can be freely designed.
140 So it is expected to become quite a nice, modern macro package.
143 .BR groff_mom (@MAN7EXT@).
151 .BR groff_ms (@MAN7EXT@).
154 .\" --------------------------------------------------------------------
155 .SS "Language-specific Packages"
156 .\" --------------------------------------------------------------------
160 This file adds support for Czech localization, including the main macro
161 packages (me, mom, mm, and ms).
166 sets the input encoding to latin-2.
173 German localization support, including the main macro packages (me, mom, mm,
178 selects hyphenation patterns for traditional orthography, and
180 does the same for the new orthography (`Recht\%schreib\%reform').
182 It should be used as the last macro package on the command line.
187 This file adds support for French localization, including the main macro
188 packages (me, mom, mm, and ms).
195 \fIsh#\fP groff -ms -mfr foo.ms > foo.ps
202 sets the input encoding to latin-9 to get proper support of the `oe'
208 Swedish localization support, including the me, mom, and ms macro packages.
210 Note that Swedish for the mm macros is handled separately; see
211 .BR groff_mmse (@MAN7EXT@).
213 It should be used as the last macro package on the command line.
216 .\" --------------------------------------------------------------------
217 .SS "Input Encodings"
218 .\" --------------------------------------------------------------------
229 Various input encodings supported directly by groff.
231 Normally, this macro is loaded at the very beginning of a document or
232 specified as the first macro argument on the command line.
235 loads latin1 by default at start-up.
237 Note that these macro packages don't work on EBCDIC hosts.
242 Encoding support for EBCDIC.
244 On those platforms it is loaded automatically at start-up.
246 Due to different character ranges used in
248 it doesn't work on architectures which are based on ASCII.
252 Note that it can happen that some input encoding characters are not
253 available for a particular output device.
259 groff -Tlatin1 -mlatin9 ...
263 fails if you use the Euro character in the input.
265 Usually, this limitation is present only for devices which have a
266 limited set of output glyphs
269 for other devices it is usually sufficient to install proper
270 fonts which contain the necessary glyphs.
273 .\" --------------------------------------------------------------------
274 .SS "Special Packages"
275 .\" --------------------------------------------------------------------
277 The macro packages in this section are not intended for stand-alone
278 usage, but can be used to add special functionality to any other
279 macro package or to plain groff.
284 Provide some macros for addition, multiplication, and division of 60bit
285 integers (allowing safe multiplication of 30bit integers, for example).
290 Switch to the EC and TC font families.
293 .BR \%grodvi (@MAN1EXT@)
294 \[en] this man page also gives more details of how to use it.
299 This macro file is already loaded at start-up by
301 so it isn't necessary to call it explicitly.
303 It provides an interface to set the paper size on the command line with
304 the option \f[B]\%\-dpaper=\f[]\f[I]size\f[].
308 are the same as the predefined
310 values in the DESC file (only lowercase; see
311 .BR groff_font (@MAN5EXT@)
317 (ell) character denotes landscape orientation.
325 Most output drivers need additional command line switches
329 to override the default paper length and orientation as set in the driver
332 For example, use the following for PS output on A4 paper in landscape
338 \fIsh#\fP groff \-Tps \-dpaper=a4l \-P\-pa4 \-P\-l \-ms foo.ms > foo.ps
344 This file provides proper definitions for the macros
349 .BR @g@pic (@MAN1EXT@)
352 They center each picture.
354 Use it only if your macro package doesn't provide proper definitions
355 for those two macros (actually, most of them already do).
360 A single macro is provided in this file,
362 to include a PostScript graphic in a document.
364 The following output devices support inclusion of PS images:
370 for all other devices the image is replaced with a hollow rectangle
373 This macro file is already loaded at start-up by
375 so it isn't necessary to call it explicitly.
381 \&\fB.PSPIC\fP [\fB\-L\fP\||\|\fB\-R\fP\||\|\fB\-I\fP\ \fIn\fP] \
382 \fI\|file\fP [\fIwidth\fP [\fIheight\fP]]
387 is the name of the PostScript file;
391 give the desired width and height of the image.
397 argument is specified, the image's natural width (as given in
398 the file's bounding box) or the current line length is used
399 as the width, whatever is smaller.
405 arguments may have scaling indicators attached;
406 the default scaling indicator is\~\c
409 This macro scales the graphic uniformly
410 in the x and y\~directions so that it is no more than
417 By default, the graphic is horizontally centered.
423 options cause the graphic to be left-aligned and right-aligned,
428 option causes the graphic to be indented by\~\c
430 (default scaling indicator is\~\c
436 within a diversion it is recommended to extend it with
437 the following code, assuring that the diversion's width completely
438 covers the image's width.
445 \&\[rs]h'(\[rs]\[rs]n[ps-offset]u + \[rs]\[rs]n[ps-deswid]u)'
455 Use this for tracing macro calls.
457 It is only useful for debugging.
460 .BR groff_trace (@MAN7EXT@) .
465 Overrides the definition of standard troff characters and some groff
466 characters for TTY devices.
468 The optical appearance is intentionally inferior compared to that of
469 normal TTY formatting to allow processing with critical equipment.
474 Additions of elements known from the HTML format, as used in the
475 internet (World Wide Web) pages; this includes URL links and mail
477 .BR groff_www (@MAN7EXT@).
480 .\" --------------------------------------------------------------------
482 .\" --------------------------------------------------------------------
484 Classical roff systems were designed before the conventions of the
487 call evolved, and used a naming scheme for macro packages that looks
488 odd to modern eyes. Macro packages were always included with the option
490 when this option was directly followed by its argument without an
491 intervening space, this looked like a long option preceded by a single
492 minus \[em] a sensation in the computer stone age.
493 To make this invocation form work, classical troff
494 macro packages used names that started with the letter `m',
495 which was omitted in the naming of the macro file.
499 For example, the macro package for the man pages was called
503 So it could be activated by the argument
513 For similar reasons, macro packages that did not start with an `m'
515 added in the documentation and in speech; for example, the package
520 in the documentation, although a more suitable name would be
522 For, when omitting the space between the option and its argument, the
523 command line option for activating this package reads
528 To cope with all situations, actual versions of
529 .BR groff (@MAN1EXT@)
530 are smart about both naming schemes by providing two macro files
531 for the inflicted macro packages; one with a leading `m'
532 the other one without it.
538 macro package may be specified as on of the following four methods:
542 \fIsh#\fP groff\ \-m\ man
543 \fIsh#\fP groff\ \-man
544 \fIsh#\fP groff\ \-mman
545 \fIsh#\fP groff\ \-m\ an
550 Recent packages that do not start with `m'
551 do not use an additional `m'
552 in the documentation.
556 macro package may be specified only as one of the two methods:
560 \fIsh#\fP groff\ \-m\ www
561 \fIsh#\fP groff\ \-mwww
566 Obviously, variants like
568 would not make much sense.
572 A second strange feature of classical troff was to name macro files
573 in the form \f[B]tmac.\f[]\f[I]name\f[].
574 In modern operating systems, the type of a file is specified as a
575 postfix, the file name extension.
577 Again, groff copes with this situation by searching both
587 The easiest way to find out which macro packages are available on a
588 system is to check the man\~page
589 .BR groff (@MAN1EXT@),
590 or the contents of the
598 most macro packages are described in\~man pages called
599 .BR groff_\f[I]name\f[] (@MAN7EXT@),
601 for the classical packages.
604 .\" --------------------------------------------------------------------
606 .\" --------------------------------------------------------------------
608 There are several ways to use a macro package in a document.
610 The classical way is to specify the troff/groff option
613 at run-time; this makes the contents of the macro package
619 is searched within the tmac path; if not found,
621 is searched for instead.
625 Alternatively, it is also possible to include a macro file by adding
629 into the document; the argument must be the full file name of an
630 existing file, possibly with the directory where it is kept.
632 In groff, this was improved by the similar request
635 which added searching in the tmac path, just like option
641 Note that in order to resolve the
645 requests, the roff preprocessor
646 .BR soelim (@MAN1EXT@)
647 must be called if the files to be included need preprocessing.
649 This can be done either directly by a pipeline on the command line or
650 by using the troff/groff option
654 calls soelim automatically.
658 For example, suppose a macro file is stored as
661 .I @MACRODIR@/macros.tmac
664 and is used in some document called
669 At run-time, the formatter call for this is
673 \fIsh#\fP groff \-m macros docu.roff
678 To include the macro file directly in the document either
690 \&.so @MACRODIR@/macros.tmac
695 In both cases, the formatter should be called with option
701 \fIsh#\fP groff \-s docu.roff
706 If you want to write your own groff macro file, call it
708 and put it in some directory of the tmac path, see section
710 Then documents can include it with the
712 request or the option
717 .\" --------------------------------------------------------------------
719 .\" --------------------------------------------------------------------
721 .\" This section does not fit into the framework of this document.
723 There is a convention that is supported by many modern roff
728 described in the following.
731 If the first line in a document is a comment, the first word (after the
732 comment characters and a blank) constitutes the
735 That means that the letters of this word are interpreted as
736 abbreviations for those preprocessor commands that should be run
737 when formatting the document.
739 Mostly, only the letters corresponding to the options for the
740 preprocessors are recognized,
760 .BR roff (@MAN7EXT@)).
764 Besides being a good reminder for the user, some formatters (like the
766 program) are even able to automatically start the preprocessors
767 specified in the preprocessor word, but do not bet on this.
773 program handles some preprocessors automatically, such that in
774 man\~pages only the following characters should be used:
779 .\" --------------------------------------------------------------------
781 .\" --------------------------------------------------------------------
785 document is a text file that is enriched by predefined formatting
786 constructs, such as requests, escape sequences, strings, numeric
787 registers, and macros from a macro package.
789 These elements are described in
790 .BR roff (@MAN7EXT@).
794 To give a document a personal style, it is most useful to extend the
795 existing elements by defining some macros for repeating tasks; the best
796 place for this is near the beginning of the document or in a separate
801 Macros without arguments are just like strings.
803 But the full power of macros reveals when arguments are passed with a
806 Within the macro definition, the arguments are available as the escape
811 .BR \[rs]$[ \*[Ellipsis] ] ,
815 the name under which the macro was called is in
817 and the number of arguments is in register
820 .BR groff (@MAN7EXT@).
823 .\" --------------------------------------------------------------------
825 .\" --------------------------------------------------------------------
827 The phase when groff reads a macro is called
833 This is comparable to the C\~preprocessing phase during the development
834 of a program written in the C\~language.
838 In this phase, groff interprets all backslashes; that means that all
839 escape sequences in the macro body are interpreted and replaced by
842 For constant expressions, this is wanted, but strings and registers
843 that might change between calls of the macro must be protected from
846 This is most easily done by doubling the backslash that introduces the
849 This doubling is most important for the positional parameters.
851 For example, to print information on the arguments that were passed to
852 the macro to the terminal, define a macro named `.print_args',
857 .ds @1 \[rs]f[I]\[rs]\[rs]$0\[rs]f[]\"
860 \&.ds midpart was called with
862 \&.\ \ tm\ \*[@1]\ \[rs]*[midpart]\ \[rs]\[rs]n[.$]\ \*[@2]
863 \&.\ \ tm\ \[rs]\[rs]$*
871 When calling this macro by
875 \&.print_args arg1 arg2
879 the following text is printed to the terminal:
883 \&\f[CI]print_args\f[] was called with the following 2 arguments:
889 Let's analyze each backslash in the macro definition.
891 As the positional parameters and the number of arguments change
892 with each call of the macro their leading backslash must be doubled,
897 The same applies to the macro name because it could be called with an
905 is a constant string, it does not change, so no doubling for
906 .IR \[rs]*[midpart] .
909 escape sequences are predefined groff elements for setting the font
912 Of course, this behavior does not change, so no doubling with
918 .\" --------------------------------------------------------------------
920 .\" --------------------------------------------------------------------
922 Writing groff macros is easy when the escaping mechanism is temporarily
925 In groff, this is done by enclosing the macro definition(s) into a
932 Then the body in the macro definition is just like a normal part of
933 the document \[em] text enhanced by calls of requests, macros,
934 strings, registers, etc.
936 For example, the code above can be written in a simpler way by
940 .ds @1 \[rs]f[I]\[rs]$0\[rs]f[]\"
944 \&.ds midpart was called with
946 \&.\ \ tm\ \*[@1]\ \[rs]*[midpart]\ \[rs]n[.$]\ \*[@2]
956 Unfortunately, draft mode cannot be used universally.
958 Although it is good enough for defining normal macros, draft mode
959 fails with advanced applications, such as indirectly defined
960 strings, registers, etc.
962 An optimal way is to define and test all macros in draft mode and then
963 do the backslash doubling as a final step; do not forget to remove the
968 .\" --------------------------------------------------------------------
969 .SS "Tips for Macro Definitions"
970 .\" --------------------------------------------------------------------
973 Start every line with a dot, for example, by using the groff request
975 for text lines, or write your own macro that handles also text lines
982 \&.\ \ if (\[rs]\[rs]n[.$] == 0)\ \[rs]
984 \&.\ \ nop\ \[rs])\[rs]\[rs]$*\[rs])
990 Write a comment macro that works both for copy-in and draft mode; for
991 as escaping is off in draft mode, trouble might occur when normal
994 For example, the following macro just ignores its arguments, so it
995 acts like a comment line:
1002 \&.c\ This\ is\ like\ a\ comment\ line.
1007 In long macro definitions, make ample use of comment lines or
1008 almost-empty lines (this is, lines which have a leading dot
1009 and nothing else) for a better structuring.
1012 To increase readability, use groff's indentation facility for requests
1013 and macro calls (arbitrary whitespace after the leading dot).
1016 .\" --------------------------------------------------------------------
1018 .\" --------------------------------------------------------------------
1020 Diversions can be used to implement quite advanced programming
1023 They are comparable to pointers to large data structures in the
1024 C\~programming language, but their usage is quite different.
1028 In their simplest form, diversions are multi-line strings, but
1029 they get their power when diversions are used dynamically within macros.
1031 The (formatted) information stored in a diversion can be retrieved by
1032 calling the diversion just like a macro.
1036 Most of the problems arising with diversions can be avoided if you remain
1037 aware of the fact that diversions always store complete lines.
1039 If diversions are used when the line buffer has not been flushed,
1040 strange results are produced; not knowing this, many people get
1041 desperate about diversions.
1043 To ensure that a diversion works, line breaks should be added at the
1046 To be on the secure side, enclose everything that has to do with
1047 diversions into a pair of line breaks; for example, by explicitly using
1051 This rule should be applied to diversion definition, both inside and
1052 outside, and to all calls of diversions.
1054 This is a bit of overkill, but it works nicely.
1058 [If you really need diversions which should ignore the current partial
1059 line, use environments to save the current partial line and/\:or use the
1065 The most powerful feature using diversions is to start a diversion
1066 within a macro definition and end it within another macro.
1068 Then everything between each call of this macro pair is stored within
1069 the diversion and can be manipulated from within the macros.
1072 .\" --------------------------------------------------------------------
1074 .\" --------------------------------------------------------------------
1076 All macro names must be named
1078 to fully use the tmac mechanism.
1081 as with classical packages is possible as well, but deprecated.
1085 The macro files are kept in the
1086 .IR "tmac directories" ;
1087 a colon separated list of these constitutes the
1092 The search sequence for macro files is (in that order):
1095 the directories specified with troff/groff's
1100 the directories given in the
1102 environment variable
1105 the current directory (only if in unsafe mode, which is enabled by the
1107 command line switch)
1113 a platform-specific directory, being
1121 in this installation
1124 a site-specific (platform-independent) directory, being
1132 in this installation
1135 the main tmac directory, being
1143 in this installation
1146 .\" --------------------------------------------------------------------
1148 .\" --------------------------------------------------------------------
1152 A colon separated list of additional tmac directories in which to search
1155 See the previous section for a detailed description.
1158 .\" --------------------------------------------------------------------
1160 .\" --------------------------------------------------------------------
1162 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008
1163 Free Software Foundation, Inc.
1166 This document is distributed under the terms of the FDL (GNU Free
1167 Documentation License) version 1.1 or later.
1169 You should have received a copy of the FDL on your system, it is also
1170 available on-line at the
1171 .UR http://\:www.gnu.org/\:copyleft/\:fdl.html
1176 This document is part of
1178 the GNU roff distribution.
1190 .\" --------------------------------------------------------------------
1192 .\" --------------------------------------------------------------------
1194 A complete reference for all parts of the groff system is found in the
1201 .BR groff (@MAN1EXT@)
1202 an overview of the groff system.
1206 .BR groff_man (@MAN7EXT@),
1208 .BR groff_mdoc (@MAN7EXT@),
1210 .BR groff_me (@MAN7EXT@),
1212 .BR groff_mm (@MAN7EXT@),
1214 .BR groff_mom (@MAN7EXT@),
1216 .BR groff_ms (@MAN7EXT@),
1218 .BR groff_trace (@MAN7EXT@),
1220 .BR groff_www (@MAN7EXT@).
1221 the groff tmac macro packages.
1225 .BR groff (@MAN7EXT@)
1230 The Filesystem Hierarchy Standard is available at the
1231 .UR http://\:www.pathname.com/\:fhs/
1235 .\" Local Variables: