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
337 \fIsh#\fP groff \-Tps \-dpaper=a4l \-P\-pa4 \-P\-l \-ms foo.ms > foo.ps
343 This file provides proper definitions for the macros
348 .BR @g@pic (@MAN1EXT@)
351 They center each picture.
353 Use it only if your macro package doesn't provide proper definitions
354 for those two macros (actually, most of them already do).
359 A single macro is provided in this file,
361 to include a PostScript graphic in a document.
363 The following output devices support inclusion of PS images:
368 for all other devices the image is replaced with a hollow rectangle
371 This macro file is already loaded at start-up by
373 so it isn't necessary to call it explicitly.
379 \&\fB.PSPIC\fP [\fB\-L\fP\||\|\fB-R\fP\||\|\fB\-I\fP\ \fIn\fP] \
380 \fI\|file\fP [\fIwidth\fP [\fIheight\fP]]
385 is the name of the PostScript file;
389 give the desired width and height of the image.
395 argument is specified, the image's natural width (as given in
396 the file's bounding box) or the current line length is used
397 as the width, whatever is smaller.
403 arguments may have scaling indicators attached;
404 the default scaling indicator is\~\c
407 This macro scales the graphic uniformly
408 in the x and y\~directions so that it is no more than
415 By default, the graphic is horizontally centered.
421 options cause the graphic to be left-aligned and right-aligned,
426 option causes the graphic to be indented by\~\c
428 (default scaling indicator is\~\c
434 within a diversion it is recommended to extend it with
435 the following code, assuring that the diversion's width completely
436 covers the image's width.
443 \&\eh'(\e\en[ps-offset]u + \e\en[ps-deswid]u)'
453 Use this for tracing macro calls.
455 It is only useful for debugging.
458 .BR groff_trace (@MAN7EXT@) .
463 Overrides the definition of standard troff characters and some groff
464 characters for tty devices.
466 The optical appearance is intentionally inferior compared to that of
467 normal tty formatting to allow processing with critical equipment.
472 Additions of elements known from the html format, as used in the
473 internet (World Wide Web) pages; this includes URL links and mail
475 .BR groff_www (@MAN7EXT@).
478 .\" --------------------------------------------------------------------
480 .\" --------------------------------------------------------------------
482 Classical roff systems were designed before the conventions of the
485 call evolved, and used a naming scheme for macro packages that looks
486 odd to modern eyes. Macro packages were always included with the option
488 when this option was directly followed by its argument without an
489 intervening space, this looked like a long option preceded by a single
490 minus \[em] a sensation in the computer stone age.
491 To make this invocation form work, classical troff
492 macro packages used names that started with the letter `m',
493 which was omitted in the naming of the macro file.
497 For example, the macro package for the man pages was called
501 So it could be activated by the argument
511 For similar reasons, macro packages that did not start with an `m'
513 added in the documentation and in speech; for example, the package
518 in the documentation, although a more suitable name would be
520 For, when omitting the space between the option and its argument, the
521 command line option for activating this package reads
526 To cope with all situations, actual versions of
527 .BR groff (@MAN1EXT@)
528 are smart about both naming schemes by providing two macro files
529 for the inflicted macro packages; one with a leading `m'
530 the other one without it.
536 macro package may be specified as on of the following four methods:
540 \fIsh#\fP groff\ \-m\ man
541 \fIsh#\fP groff\ \-man
542 \fIsh#\fP groff\ \-mman
543 \fIsh#\fP groff\ \-m\ an
548 Recent packages that do not start with `m'
549 do not use an additional `m'
550 in the documentation.
554 macro package may be specified only as one of the two methods:
558 \fIsh#\fP groff\ \-m\ www
559 \fIsh#\fP groff\ \-mwww
564 Obviously, variants like
566 would not make much sense.
570 A second strange feature of classical troff was to name macro files
571 in the form \fBtmac.\fIname\fR.
572 In modern operating systems, the type of a file is specified as a
573 postfix, the file name extension.
575 Again, groff copes with this situation by searching both
585 The easiest way to find out which macro packages are available on a
586 system is to check the man\~page
587 .BR groff (@MAN1EXT@),
588 or the contents of the
596 most macro packages are described in\~man pages called
597 .BR groff_\f[I]name\f[] (@MAN7EXT@),
599 for the classical packages.
602 .\" --------------------------------------------------------------------
604 .\" --------------------------------------------------------------------
606 There are several ways to use a macro package in a document.
608 The classical way is to specify the troff/groff option
611 at run-time; this makes the contents of the macro package
617 is searched within the tmac path; if not found,
619 is searched for instead.
623 Alternatively, it is also possible to include a macro file by adding
627 into the document; the argument must be the full file name of an
628 existing file, possibly with the directory where it is kept.
630 In groff, this was improved by the similar request
633 which added searching in the tmac path, just like option
639 Note that in order to resolve the
643 requests, the roff preprocessor
644 .BR soelim (@MAN1EXT@)
645 must be called if the files to be included need preprocessing.
647 This can be done either directly by a pipeline on the command line or
648 by using the troff/groff option
652 calls soelim automatically.
656 For example, suppose a macro file is stored as
657 .I @MACRODIR@/macros.tmac
658 and is used in some document called
663 At run-time, the formatter call for this is
667 \fIsh#\fP groff\ \-m\ \fImacrofile\ document.roff\fP
672 To include the macro file directly in the document either
676 \&.mso macrofile.tmac
684 \&.so @MACRODIR@/macros.tmac
689 In both cases, the formatter is called with
692 \fIsh#\fP groff\ \-s\ \fIdocu.roff\fP
697 If you want to write your own groff macro file, call it
699 and put it in some directory of the tmac path, see section
701 Then documents can include it with the
703 request or the option
708 .\" --------------------------------------------------------------------
710 .\" --------------------------------------------------------------------
712 .\" This section does not fit into the framework of this document.
714 There is a convention that is supported by many modern roff
719 described in the following.
722 If the first line in a document is a comment, the first word (after the
723 comment characters and a blank) constitutes the
726 That means that the letters of this word are interpreted as
727 abbreviations for those preprocessor commands that should be run
728 when formatting the document.
730 Mostly, only the letters corresponding to the options for the
731 preprocessors are recognized,
751 .BR roff (@MAN7EXT@)).
755 Besides being a good reminder for the user, some formatters (like the
757 program) are even able to automatically start the preprocessors
758 specified in the preprocessor word, but do not bet on this.
764 program handles some preprocessors automatically, such that in
765 man\~pages only the following characters should be used:
770 .\" --------------------------------------------------------------------
772 .\" --------------------------------------------------------------------
776 document is a text file that is enriched by predefined formatting
777 constructs, such as requests, escape sequences, strings, numeric
778 registers, and macros from a macro package.
780 These elements are described in
781 .BR roff (@MAN7EXT@).
785 To give a document a personal style, it is most useful to extend the
786 existing elements by defining some macros for repeating tasks; the best
787 place for this is near the beginning of the document or in a separate
792 Macros without arguments are just like strings.
794 But the full power of macros reveals when arguments are passed with a
797 Within the macro definition, the arguments are available as the escape
802 .BR $[ \*[Ellipsis] ] ,
806 the name under which the macro was called is in
808 and the number of arguments is in register
811 .BR groff (@MAN7EXT@).
814 .\" --------------------------------------------------------------------
816 .\" --------------------------------------------------------------------
818 The phase when groff reads a macro is called
822 This is comparable to the C\~preprocessing phase during the development
823 of a program written in the C\~language.
827 In this phase, groff interprets all backslashes; that means that all
828 escape sequences in the macro body are interpreted and replaced by
831 For constant expression, this is wanted, but strings and registers
832 that might change between calls of the macro must be protected from
835 This is most easily done by doubling the backslash that introduces the
838 This doubling is most important for the positional parameters.
840 For example, to print information on the arguments that were passed to
841 the macro to the terminal, define a macro named `.print_args',
846 .ds @1 \ef[I]\e\e$0\ef[]\"
849 \&.ds midpart was called with
851 \&.\ \ tm\ \*[@1]\ \e\e*[midpart]\ \e\en[.$]\ \*[@2]
860 When calling this macro by
864 \&.print_args arg1 arg2
868 the following text is printed to the terminal:
872 \&\f[CI]print_args\f[] was called with the following 2 arguments:
878 Let's analyze each backslash in the macro definition.
880 As the positional parameters and the number of arguments change
881 with each call of the macro their leading backslash must be doubled,
886 The same applies to the macro name because it could be called with an
894 is a constant string, it does not change, so no doubling for
898 escape sequences are predefined groff elements for setting the font
901 Of course, this behavior does not change, so no doubling with
907 .\" --------------------------------------------------------------------
909 .\" --------------------------------------------------------------------
911 Writing groff macros is easy when the escaping mechanism is temporarily
914 In groff, this is done by enclosing the macro definition(s) into a
921 Then the body in the macro definition is just like a normal part of
922 the document \[em] text enhanced by calls of requests, macros,
923 strings, registers, etc.
925 For example, the code above can be written in a simpler way by
929 .ds @1 \ef[I]\e$0\ef[]\"
933 \&.ds midpart was called with
935 \&.\ \ tm\ \*[@1]\ \e*[midpart]\ \en[.$]\ \*[@2]
945 Unfortunately, draft mode cannot be used universally.
947 Although it is good enough for defining normal macros, draft mode
948 fails with advanced applications, such as indirectly defined
949 strings, registers, etc.
951 An optimal way is to define and test all macros in draft mode and then
952 do the backslash doubling as a final step; do not forget to remove the
957 .\" --------------------------------------------------------------------
958 .SS "Tips for Macro Definitions"
959 .\" --------------------------------------------------------------------
962 Start every line with a dot, for example, by using the groff request
964 for text lines, or write your own macro that handles also text lines
971 \&.\ \ if (\e\en[.$] == 0)\ \e
973 \&.\ \ nop\ \e)\e\e$*[rs]\)
979 Write a comment macro that works both for copy-in and draft mode; for
980 as escaping is off in draft mode, trouble might occur when normal
983 For example, the following macro just ignores its arguments, so it
984 acts like a comment line:
991 \&.c\ This\ is\ like\ a\ comment\ line.
996 In long macro definitions, make ample use of comment lines or empty
997 lines for a better structuring.
1000 To increase readability, use groff's indentation facility for requests
1001 and macro calls (arbitrary whitespace after the leading dot).
1004 .\" --------------------------------------------------------------------
1006 .\" --------------------------------------------------------------------
1008 Diversions can be used to implement quite advanced programming
1011 They are comparable to pointers to large data structures in the
1012 C\~programming language, but their usage is quite different.
1016 In their simplest form, diversions are multi-line strings, but
1017 they get their power when diversions are used dynamically within macros.
1019 The information stored in a diversion can be retrieved by calling the
1020 diversion just like a macro.
1024 Most of the problems arising with diversions can be avoided if you remain
1025 aware of the fact that diversions always store complete lines.
1027 If diversions are used when the line buffer has not been flushed,
1028 strange results are produced; not knowing this, many people get
1029 desperate about diversions.
1031 To ensure that a diversion works, line breaks should be added at the
1034 To be on the secure side, enclose everything that has to do with
1035 diversions into a pair of line breaks; for example, by explicitly using
1039 This rule should be applied to diversion definition, both inside and
1040 outside, and to all calls of diversions.
1042 This is a bit of overkill, but it works nicely.
1046 [If you really need diversions which should ignore the current partial
1047 line, use environments to save the current partial line and/\:or use the
1053 The most powerful feature using diversions is to start a diversion
1054 within a macro definition and end it within another macro.
1056 Then everything between each call of this macro pair is stored within
1057 the diversion and can be manipulated from within the macros.
1060 .\" --------------------------------------------------------------------
1062 .\" --------------------------------------------------------------------
1064 All macro names must be named
1066 to fully use the tmac mechanism.
1069 as with classical packages is possible as well, but deprecated.
1073 The macro files are kept in the
1074 .IR "tmac directories" ;
1075 a colon separated list of these constitutes the
1080 The search sequence for macro files is (in that order):
1083 the directories specified with troff/groff's
1088 the directories given in the
1090 environment variable
1093 the current directory (only if in unsafe mode, which is enabled by the
1095 command line switch)
1101 a platform-specific directory, being
1103 in this installation
1106 a site-specific (platform-independent) directory, being
1108 in this installation
1111 the main tmac directory, being
1113 in this installation
1116 .\" --------------------------------------------------------------------
1118 .\" --------------------------------------------------------------------
1122 A colon separated list of additional tmac directories in which to search
1125 See the previous section for a detailed description.
1128 .\" --------------------------------------------------------------------
1130 .\" --------------------------------------------------------------------
1132 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007
1133 Free Software Foundation, Inc.
1136 This document is distributed under the terms of the FDL (GNU Free
1137 Documentation License) version 1.1 or later.
1139 You should have received a copy of the FDL on your system, it is also
1140 available on-line at the
1141 .UR http://\:www.gnu.org/\:copyleft/\:fdl.html
1146 This document is part of
1148 the GNU roff distribution.
1160 .\" --------------------------------------------------------------------
1162 .\" --------------------------------------------------------------------
1164 A complete reference for all parts of the groff system is found in the
1171 .BR groff (@MAN1EXT@)
1172 an overview of the groff system.
1176 .BR groff_man (@MAN7EXT@),
1178 .BR groff_mdoc (@MAN7EXT@),
1180 .BR groff_me (@MAN7EXT@),
1182 .BR groff_mm (@MAN7EXT@),
1184 .BR groff_mom (@MAN7EXT@),
1186 .BR groff_ms (@MAN7EXT@),
1188 .BR groff_trace (@MAN7EXT@),
1190 .BR groff_www (@MAN7EXT@).
1191 the groff tmac macro packages.
1195 .BR groff (@MAN7EXT@)
1200 The Filesystem Hierarchy Standard is available at the
1201 .UR http://\:www.pathname.com/\:fhs/
1205 .\" Local Variables: