man/groff_tmac.man

   1 .ig
   2 groff_tmac.5
   3
   4 File position: <groff-source>/man/groff_tmac.man
   5
   6 Last update: 8 Feb 2007
   7
   8 This file is part of groff, the GNU roff type-setting system.
   9
  10 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007
  11   Free Software Foundation, Inc.
  12 written by Bernd Warken <bwarken@mayn.de> and Werner Lemberg
  13 <wl@gnu.org>
  14
  15 Permission is granted to copy, distribute and/or modify this document
  16 under the terms of the GNU Free Documentation License, Version 1.1 or
  17 any later version published by the Free Software Foundation; with the
  18 Invariant Sections being this .ig-section and AUTHOR, with no
  19 Front-Cover Texts, and with no Back-Cover Texts.
  20
  21 A copy of the Free Documentation License is included as a file called
  22 FDL in the main directory of the groff source package.
  23 ..
  24 .ds Ellipsis \&.\|.\|.\&\"
  25 .
  26 .TH GROFF_TMAC @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@"
  27 .SH NAME
  28 groff_tmac \- macro files in the roff typesetting system
  29 .\" --------------------------------------------------------------------
  30 .SH DESCRIPTION
  31 .\" --------------------------------------------------------------------
  32 .
  33 The
  34 .BR roff (@MAN7EXT@)
  35 type-setting system provides a set of macro packages suitable for
  36 special kinds of documents.
  37 .
  38 Each macro package stores its macros and definitions in a file called
  39 the package's
  40 .BR "tmac file" .
  41 The name is deduced from
  42 .RB ` T\c
  43 .IB roff MAC\c
  44 .IR ros '.
  45 .
  46 .P
  47 The tmac files are normal roff source documents, except that they
  48 usually contain only definitions and setup commands, but no text.
  49 .
  50 All tmac files are kept in a single or a small number of directories,
  51 the
  52 .B tmac
  53 directories.
  54 .
  55 .
  56 .\" --------------------------------------------------------------------
  57 .SH "GROFF MACRO PACKAGES"
  58 .\" --------------------------------------------------------------------
  59 .
  60 .I groff
  61 provides all classical macro packages, some more full packages, and
  62 some secondary packages for special purposes.
  63 .
  64 Note that it is not possible to use multiple primary macro packages at the
  65 same time; saying e.g.\&
  66 .
  67 .IP
  68 .EX
  69 \fIsh#\fP groff \-m man \-m ms foo
  70 .EE
  71 .
  72 .P
  73 or
  74 .
  75 .IP
  76 .EX
  77 \fIsh#\fP groff \-m man foo \-m ms bar
  78 .EE
  79 .
  80 .P
  81 fails.
  82 .
  83 .
  84 .\" --------------------------------------------------------------------
  85 .SS "Man\~Pages"
  86 .\" --------------------------------------------------------------------
  87 .
  88 .TP
  89 .B man
  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@).
  93 .
  94 .
  95 .TP
  96 .B doc
  97 .TQ
  98 .B mdoc
  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
 101 man\~pages; see
 102 .BR groff_mdoc (@MAN7EXT@).
 103 .
 104 .
 105 .\" --------------------------------------------------------------------
 106 .SS "Full Packages"
 107 .\" --------------------------------------------------------------------
 108 .
 109 The packages in this section provide a complete set of macros for
 110 writing documents of any kind, up to whole books.
 111 .
 112 They are similar in functionality; it is a matter of taste which one
 113 to use.
 114 .
 115 .
 116 .TP
 117 .B me
 118 The classical
 119 .I me
 120 macro package; see
 121 .BR groff_me (@MAN7EXT@).
 122 .
 123 .
 124 .TP
 125 .B mm
 126 The semi-classical
 127 .I mm
 128 macro package; see
 129 .BR groff_mm (@MAN7EXT@).
 130 .
 131 .
 132 .TP
 133 .B mom
 134 The new
 135 .I mom
 136 macro package, only available in groff.
 137 .
 138 As this is not based on other packages, it can be freely designed.
 139 .
 140 So it is expected to become quite a nice, modern macro package.
 141 .
 142 See
 143 .BR groff_mom (@MAN7EXT@).
 144 .
 145 .
 146 .TP
 147 .B ms
 148 The classical
 149 .I ms
 150 macro package; see
 151 .BR groff_ms (@MAN7EXT@).
 152 .
 153 .
 154 .\" --------------------------------------------------------------------
 155 .SS "Language-specific Packages"
 156 .\" --------------------------------------------------------------------
 157 .
 158 .
 159 .TP
 160 .B de
 161 .TQ
 162 .B den
 163 German localization support, including the main macro packages (me, mom, mm,
 164 and ms).
 165 .
 166 .IP
 167 .B de.tmac
 168 selects hyphenation patterns for traditional orthography, and
 169 .B den.tmac
 170 does the same for the new orthography (`Rechtschreibreform').
 171 .
 172 It should be used as the last macro package on the command line.
 173 .
 174 .
 175 .TP
 176 .B fr
 177 This file adds support for French localization, including the main macro
 178 packages (me, mom, mm, and ms).
 179 .
 180 .
 181 Example:
 182 .RS
 183 .IP
 184 .EX
 185 \fIsh#\fP groff -ms -mfr foo.ms > foo.ps
 186 .EE
 187 .
 188 .IP
 189 Note that
 190 .B fr.tmac
 191 sets the input encoding to latin-9 to get proper support of the `oe'
 192 ligature.
 193 .
 194 .
 195 .TP
 196 .B sv
 197 Swedish localization support, including the me, mom, and ms macro packages.
 198 .
 199 Note that Swedish for the mm macros is handled separately; see
 200 .BR groff_mmse (@MAN7EXT@).
 201 .
 202 It should be used as the last macro package on the command line.
 203 .
 204 .
 205 .\" --------------------------------------------------------------------
 206 .SS "Input Encodings"
 207 .\" --------------------------------------------------------------------
 208 .
 209 .
 210 .TP
 211 .B latin1
 212 .TQ
 213 .B latin2
 214 .TQ
 215 .B latin5
 216 .TQ
 217 .B latin9
 218 Various input encodings supported directly by groff.
 219 .
 220 Normally, this macro is loaded at the very beginning of a document or
 221 specified as the first macro argument on the command line.
 222 .
 223 .B @g@roff
 224 loads latin1 by default at start-up.
 225 .
 226 Note that these macro packages don't work on EBCDIC hosts.
 227 .
 228 .
 229 .TP
 230 .B cp1047
 231 Encoding support for EBCDIC.
 232 .
 233 On those platforms it is loaded automatically at start-up.
 234 .
 235 Due to different character ranges used in
 236 .B @g@roff
 237 it doesn't work on architectures which are based on ASCII.
 238 .
 239 .
 240 .P
 241 Note that it can happen that some input encoding characters are not
 242 available for a particular output device.
 243 .
 244 For example, saying
 245 .
 246 .P
 247 .EX
 248 groff -Tlatin1 -mlatin9 ...
 249 .EE
 250 .
 251 .P
 252 fails if you use the Euro character in the input.
 253 .
 254 Usually, this limitation is present only for devices which have a
 255 limited set of output glyphs
 256 .RB ( \-Tascii ,
 257 .BR \-Tlatin1 );
 258 for other devices it is usually sufficient to install proper
 259 fonts which contain the necessary glyphs.
 260 .
 261 .
 262 .\" --------------------------------------------------------------------
 263 .SS "Special Packages"
 264 .\" --------------------------------------------------------------------
 265 .
 266 The macro packages in this section are not intended for stand-alone
 267 usage, but can be used to add special functionality to any other
 268 macro package or to plain groff.
 269 .
 270 .
 271 .TP
 272 .B 60bit
 273 Provide some macros for addition, multiplication, and division of 60bit
 274 integers (allowing safe multiplication of 30bit integers, for example).
 275 .
 276 .
 277 .TP
 278 .B ec
 279 Switch to the EC and TC font families.
 280 .
 281 To be used with
 282 .BR \%grodvi (@MAN1EXT@)
 283 \[en] this man page also gives more details of how to use it.
 284 .
 285 .
 286 .TP
 287 .B papersize
 288 This macro file is already loaded at start-up by
 289 .B @g@troff
 290 so it isn't necessary to call it explicitly.
 291 .
 292 It provides an interface to set the paper size on the command line with
 293 the option \f[B]\%\-dpaper=\f[]\f[I]size\f[].
 294 .
 295 Possible values for
 296 .I size
 297 are the same as the predefined
 298 .B papersize
 299 values in the DESC file (only lowercase; see
 300 .BR groff_font (@MAN5EXT@)
 301 for more) except
 302 .BR a7 - d7 .
 303 .
 304 An appended
 305 .B l
 306 (ell) character denotes landscape orientation.
 307 .
 308 Examples:
 309 .BR a4 ,
 310 .BR c3l ,
 311 .BR letterl .
 312 .
 313 .IP
 314 Most output drivers need additional command line switches
 315 .B \-p
 316 and
 317 .B \-l
 318 to override the default paper length and orientation as set in the driver
 319 specific DESC file.
 320 .
 321 For example, use the following for PS output on A4 paper in landscape
 322 orientation:
 323 .
 324 .IP
 325 .EX
 326 \fIsh#\fP groff \-Tps \-dpaper=a4l \-P\-pa4 \-P\-l \-ms foo.ms > foo.ps
 327 .EE
 328 .
 329 .
 330 .TP
 331 .B pic
 332 This file provides proper definitions for the macros
 333 .B PS
 334 and
 335 .BR PE ,
 336 needed for the
 337 .BR @g@pic (@MAN1EXT@)
 338 preprocessor.
 339 .
 340 They center each picture.
 341 .
 342 Use it only if your macro package doesn't provide proper definitions
 343 for those two macros (actually, most of them already do).
 344 .
 345 .
 346 .TP
 347 .B pspic
 348 A single macro is provided in this file,
 349 .BR PSPIC ,
 350 to include a PostScript graphic in a document.
 351 .
 352 The following output devices support inclusion of PS images:
 353 .BR \-Tps ,
 354 .BR \-Tdvi ,
 355 and
 356 .BR \-Thtml ;
 357 for all other devices the image is replaced with a hollow rectangle
 358 of the same size.
 359 .
 360 This macro file is already loaded at start-up by
 361 .B @g@troff
 362 so it isn't necessary to call it explicitly.
 363 .
 364 .IP
 365 Syntax:
 366 .RS
 367 .IP
 368 \&\fB.PSPIC\fP [\fB\-L\fP\||\|\fB-R\fP\||\|\fB\-I\fP\ \fIn\fP] \
 369 \fI\|file\fP [\fIwidth\fP [\fIheight\fP]]
 370 .RE
 371 .
 372 .IP
 373 .I file
 374 is the name of the PostScript file;
 375 .I width
 376 and
 377 .I height
 378 give the desired width and height of the image.
 379 .
 380 If neither a
 381 .I width
 382 nor a
 383 .I height
 384 argument is specified, the image's natural width (as given in
 385 the file's bounding box) or the current line length is used
 386 as the width, whatever is smaller.
 387 .
 388 The
 389 .I width
 390 and
 391 .I height
 392 arguments may have scaling indicators attached;
 393 the default scaling indicator is\~\c
 394 .BR i .
 395 .
 396 This macro scales the graphic uniformly
 397 in the x and y\~directions so that it is no more than
 398 .I width
 399 wide
 400 and
 401 .I height
 402 high.
 403 .
 404 By default, the graphic is horizontally centered.
 405 .
 406 The
 407 .BI \-L
 408 and
 409 .BI \-R
 410 options cause the graphic to be left-aligned and right-aligned,
 411 respectively.
 412 .
 413 The
 414 .B \-I
 415 option causes the graphic to be indented by\~\c
 416 .I n
 417 (default scaling indicator is\~\c
 418 .BR m ).
 419 .
 420 .IP
 421 For use of
 422 .B .PSPIC
 423 within a diversion it is recommended to extend it with
 424 the following code, assuring that the diversion's width completely
 425 covers the image's width.
 426 .
 427 .RS
 428 .IP
 429 .EX
 430 \&.am PSPIC
 431 \&.\ \ vpt 0
 432 \&\eh'(\e\en[ps-offset]u + \e\en[ps-deswid]u)'
 433 \&.\ \ sp -1
 434 \&.\ \ vpt 1
 435 \&..
 436 .EE
 437 .RE
 438 .
 439 .
 440 .TP
 441 .B trace
 442 Use this for tracing macro calls.
 443 .
 444 It is only useful for debugging.
 445 .
 446 See
 447 .BR groff_trace (@MAN7EXT@) .
 448 .
 449 .
 450 .TP
 451 .B tty-char
 452 Overrides the definition of standard troff characters and some groff
 453 characters for tty devices.
 454 .
 455 The optical appearance is intentionally inferior compared to that of
 456 normal tty formatting to allow processing with critical equipment.
 457 .
 458 .
 459 .TP
 460 .B www
 461 Additions of elements known from the html format, as used in the
 462 internet (World Wide Web) pages; this includes URL links and mail
 463 addresses; see
 464 .BR groff_www (@MAN7EXT@).
 465 .
 466 .
 467 .\" --------------------------------------------------------------------
 468 .SH NAMING
 469 .\" --------------------------------------------------------------------
 470 .
 471 Classical roff systems were designed before the conventions of the
 472 modern C
 473 .BR getopt (3)
 474 call evolved, and used a naming scheme for macro packages that looks
 475 odd to modern eyes. Macro packages were always included with the option
 476 .BR \-m ;
 477 when this option was directly followed by its argument without an
 478 intervening space, this looked like a long option preceded by a single
 479 minus \[em] a sensation in the computer stone age.
 480 To make this invocation form work, classical troff
 481 macro packages used names that started with the letter `m',
 482 which was omitted in the naming of the macro file.
 483 .
 484 .
 485 .P
 486 For example, the macro package for the man pages was called
 487 .IR man ,
 488 while its macro file
 489 .IR tmac.an .
 490 So it could be activated by the argument
 491 .I an
 492 to option
 493 .BR \-m ,
 494 or
 495 .BR \-man
 496 for short.
 497 .
 498 .
 499 .P
 500 For similar reasons, macro packages that did not start with an `m'
 501 had a leading `m'
 502 added in the documentation and in speech; for example, the package
 503 corresponding to
 504 .I tmac.doc
 505 was called
 506 .I mdoc
 507 in the documentation, although a more suitable name would be
 508 .IR doc .
 509 For, when omitting the space between the option and its argument, the
 510 command line option for activating this package reads
 511 .BR \-mdoc .
 512 .
 513 .
 514 .P
 515 To cope with all situations, actual versions of
 516 .BR groff (@MAN1EXT@)
 517 are smart about both naming schemes by providing two macro files
 518 for the inflicted macro packages; one with a leading `m'
 519 the other one without it.
 520 .
 521 So in
 522 .IR groff ,
 523 the
 524 .I man
 525 macro package may be specified as on of the following four methods:
 526 .
 527 .IP
 528 .EX
 529 \fIsh#\fP groff\ \-m\ man
 530 \fIsh#\fP groff\ \-man
 531 \fIsh#\fP groff\ \-mman
 532 \fIsh#\fP groff\ \-m\ an
 533 .EE
 534 .
 535 .
 536 .P
 537 Recent packages that do not start with `m'
 538 do not use an additional `m'
 539 in the documentation.
 540 .
 541 For example, the
 542 .I www
 543 macro package may be specified only as one of the two methods:
 544 .
 545 .IP
 546 .EX
 547 \fIsh#\fP groff\ \-m\ www
 548 \fIsh#\fP groff\ \-mwww
 549 .EE
 550 .
 551 .
 552 .P
 553 Obviously, variants like
 554 .I \-mmwww
 555 would not make much sense.
 556 .
 557 .
 558 .P
 559 A second strange feature of classical troff was to name macro files
 560 in the form \fBtmac.\fIname\fR.
 561 In modern operating systems, the type of a file is specified as a
 562 postfix, the file name extension.
 563 .
 564 Again, groff copes with this situation by searching both
 565 .IB anything .tmac
 566 and
 567 .BI tmac. anything
 568 if only
 569 .I anything
 570 is specified.
 571 .
 572 .
 573 .P
 574 The easiest way to find out which macro packages are available on a
 575 system is to check the man\~page
 576 .BR groff (@MAN1EXT@),
 577 or the contents of the
 578 .I tmac
 579 directories.
 580 .
 581 .
 582 .P
 583 In
 584 .IR groff ,
 585 most macro packages are described in\~man pages called
 586 .BR groff_\f[I]name\f[] (@MAN7EXT@),
 587 with a leading `m'
 588 for the classical packages.
 589 .
 590 .
 591 .\" --------------------------------------------------------------------
 592 .SH INCLUSION
 593 .\" --------------------------------------------------------------------
 594 .
 595 There are several ways to use a macro package in a document.
 596 .
 597 The classical way is to specify the troff/groff option
 598 .BR \-m
 599 .I name
 600 at run-time; this makes the contents of the macro package
 601 .I name
 602 available.
 603 .
 604 In groff, the file
 605 .IB name .tmac
 606 is searched within the tmac path; if not found,
 607 .BI tmac. name
 608 is searched for instead.
 609 .
 610 .
 611 .P
 612 Alternatively, it is also possible to include a macro file by adding
 613 the request
 614 .B .so
 615 .I filename
 616 into the document; the argument must be the full file name of an
 617 existing file, possibly with the directory where it is kept.
 618 .
 619 In groff, this was improved by the similar request
 620 .B .mso
 621 .IR package ,
 622 which added searching in the tmac path, just like option
 623 .BR \-m
 624 does.
 625 .
 626 .
 627 .P
 628 Note that in order to resolve the
 629 .B .so
 630 and
 631 .B .mso
 632 requests, the roff preprocessor
 633 .BR soelim (@MAN1EXT@)
 634 must be called if the files to be included need preprocessing.
 635 .
 636 This can be done either directly by a pipeline on the command line or
 637 by using the troff/groff option
 638 .BR \-s .
 639 .
 640 .I man
 641 calls soelim automatically.
 642 .
 643 .
 644 .P
 645 For example, suppose a macro file is stored as
 646 .I @MACRODIR@/macros.tmac
 647 and is used in some document called
 648 .IR docu.roff .
 649 .
 650 .
 651 .P
 652 At run-time, the formatter call for this is
 653 .
 654 .IP
 655 .EX
 656 \fIsh#\fP groff\ \-m\ \fImacrofile\ document.roff\fP
 657 .EE
 658 .
 659 .
 660 .P
 661 To include the macro file directly in the document either
 662 .
 663 .IP
 664 .EX
 665 \&.mso macrofile.tmac
 666 .EE
 667 .
 668 .P
 669 is used or
 670 .
 671 .IP
 672 .EX
 673 \&.so @MACRODIR@/macros.tmac
 674 .EE
 675 .
 676 .
 677 .P
 678 In both cases, the formatter is called with
 679 .IP
 680 .EX
 681 \fIsh#\fP groff\ \-s\ \fIdocu.roff\fP
 682 .EE
 683 .
 684 .
 685 .P
 686 If you want to write your own groff macro file, call it
 687 .IB whatever .tmac
 688 and put it in some directory of the tmac path, see section
 689 .BR FILES .
 690 Then documents can include it with the
 691 .B .mso
 692 request or the option
 693 .BR \-m .
 694 .
 695 .
 696 .ig
 697 .\" --------------------------------------------------------------------
 698 .SH CONVENTION
 699 .\" --------------------------------------------------------------------
 700 .
 701 .\" This section does not fit into the framework of this document.
 702 .
 703 There is a convention that is supported by many modern roff
 704 type-setters and
 705 .BR man (1)
 706 programs, the
 707 .I preprocessor word
 708 described in the following.
 709 .
 710 .P
 711 If the first line in a document is a comment, the first word (after the
 712 comment characters and a blank) constitutes the
 713 .B preprocessor
 714 .BR word .
 715 That means that the letters of this word are interpreted as
 716 abbreviations for those preprocessor commands that should be run
 717 when formatting the document.
 718 .
 719 Mostly, only the letters corresponding to the options for the
 720 preprocessors are recognized,
 721 `e'
 722 (for
 723 .BR eqn ),
 724 .\" `G',
 725 .\" `g',
 726 `p`
 727 (for
 728 .BR pic ),
 729 `R'
 730 (for
 731 .BR refer ),
 732 `s'
 733 (for
 734 .BR soelim ),
 735 and
 736 `t'
 737 (for
 738 .BR tbl ).
 739 (see
 740 .BR roff (@MAN7EXT@)).
 741 .
 742 .
 743 .P
 744 Besides being a good reminder for the user, some formatters (like the
 745 .BR man (1)
 746 program) are even able to automatically start the preprocessors
 747 specified in the preprocessor word, but do not bet on this.
 748 .
 749 .
 750 .P
 751 The
 752 .I man
 753 program handles some preprocessors automatically, such that in
 754 man\~pages only the following characters should be used:
 755 `e', `p', and `t'.
 756 .
 757 .
 758 ..
 759 .\" --------------------------------------------------------------------
 760 .SH "WRITING MACROS"
 761 .\" --------------------------------------------------------------------
 762 .
 763 A
 764 .BR roff (@MAN7EXT@)
 765 document is a text file that is enriched by predefined formatting
 766 constructs, such as requests, escape sequences, strings, numeric
 767 registers, and macros from a macro package.
 768 .
 769 These elements are described in
 770 .BR roff (@MAN7EXT@).
 771 .
 772 .
 773 .P
 774 To give a document a personal style, it is most useful to extend the
 775 existing elements by defining some macros for repeating tasks; the best
 776 place for this is near the beginning of the document or in a separate
 777 file.
 778 .
 779 .
 780 .P
 781 Macros without arguments are just like strings.
 782 .
 783 But the full power of macros reveals when arguments are passed with a
 784 macro call.
 785 .
 786 Within the macro definition, the arguments are available as the escape
 787 sequences
 788 .BR $1 ,
 789 \*[Ellipsis],
 790 .BR $9 ,
 791 .BR $[ \*[Ellipsis] ] ,
 792 .BR $* ,
 793 and
 794 .BR $@ ,
 795 the name under which the macro was called is in
 796 .BR $0 ,
 797 and the number of arguments is in register
 798 .BR \en[.$] ;
 799 see
 800 .BR groff (@MAN7EXT@).
 801 .
 802 .
 803 .\" --------------------------------------------------------------------
 804 .SS "Copy-in Mode"
 805 .\" --------------------------------------------------------------------
 806 .
 807 The phase when groff reads a macro is called
 808 .I "copy-in mode"
 809 in roff-talk.
 810 .
 811 This is comparable to the C\~preprocessing phase during the development
 812 of a program written in the C\~language.
 813 .
 814 .
 815 .P
 816 In this phase, groff interprets all backslashes; that means that all
 817 escape sequences in the macro body are interpreted and replaced by
 818 their value.
 819 .
 820 For constant expression, this is wanted, but strings and registers
 821 that might change between calls of the macro must be protected from
 822 being evaluated.
 823 .
 824 This is most easily done by doubling the backslash that introduces the
 825 escape sequence.
 826 .
 827 This doubling is most important for the positional parameters.
 828 .
 829 For example, to print information on the arguments that were passed to
 830 the macro to the terminal, define a macro named `.print_args',
 831 say.
 832 .
 833 .
 834 .IP
 835 .ds @1 \ef[I]\e\e$0\ef[]\"
 836 .ds @2 arguments:\"
 837 .EX
 838 \&.ds midpart was called with
 839 \&.de print_args
 840 \&.\ \ tm\ \*[@1]\ \e\e*[midpart]\ \e\en[.$]\ \*[@2]
 841 \&.\ \ tm\ \e\e$*
 842 \&..
 843 .EE
 844 .rm @1
 845 .rm @2
 846 .
 847 .
 848 .P
 849 When calling this macro by
 850 .
 851 .IP
 852 .EX
 853 \&.print_args arg1 arg2
 854 .EE
 855 .
 856 .P
 857 the following text is printed to the terminal:
 858 .
 859 .IP
 860 .EX
 861 \&\f[CI]print_args\f[] was called with the following 2 arguments:
 862 arg1 arg2
 863 .EE
 864 .
 865 .
 866 .P
 867 Let's analyze each backslash in the macro definition.
 868 .
 869 As the positional parameters and the number of arguments change
 870 with each call of the macro their leading backslash must be doubled,
 871 which results in
 872 .I \e\e$*
 873 and
 874 .IR \e\e[.$] .
 875 The same applies to the macro name because it could be called with an
 876 alias name, so
 877 .IR \e\e$0 .
 878 .
 879 .
 880 .P
 881 On the other hand,
 882 .I midpart
 883 is a constant string, it does not change, so no doubling for
 884 .IR \e*[midpart] .
 885 The
 886 .I \ef
 887 escape sequences are predefined groff elements for setting the font
 888 within the text.
 889 .
 890 Of course, this behavior does not change, so no doubling with
 891 .I \ef[I]
 892 and
 893 .IR \ef[] .
 894 .
 895 .
 896 .\" --------------------------------------------------------------------
 897 .SS "Draft Mode"
 898 .\" --------------------------------------------------------------------
 899 .
 900 Writing groff macros is easy when the escaping mechanism is temporarily
 901 disabled.
 902 .
 903 In groff, this is done by enclosing the macro definition(s) into a
 904 pair of
 905 .B .eo
 906 and
 907 .B .ec
 908 requests.
 909 .
 910 Then the body in the macro definition is just like a normal part of
 911 the document \[em] text enhanced by calls of requests, macros,
 912 strings, registers, etc.
 913 .
 914 For example, the code above can be written in a simpler way by
 915 .
 916 .
 917 .IP
 918 .ds @1 \ef[I]\e$0\ef[]\"
 919 .ds @2 arguments:\"
 920 .EX
 921 \&.eo
 922 \&.ds midpart was called with
 923 \&.de print_args
 924 \&.\ \ tm\ \*[@1]\ \e*[midpart]\ \en[.$]\ \*[@2]
 925 \&.\ \ tm\ \e$*
 926 \&..
 927 \&.ec
 928 .EE
 929 .rm @1
 930 .rm @2
 931 .
 932 .
 933 .P
 934 Unfortunately, draft mode cannot be used universally.
 935 .
 936 Although it is good enough for defining normal macros, draft mode
 937 fails with advanced applications, such as indirectly defined
 938 strings, registers, etc.
 939 .
 940 An optimal way is to define and test all macros in draft mode and then
 941 do the backslash doubling as a final step; do not forget to remove the
 942 .I .eo
 943 request.
 944 .
 945 .
 946 .\" --------------------------------------------------------------------
 947 .SS "Tips for Macro Definitions"
 948 .\" --------------------------------------------------------------------
 949 .
 950 .IP \(bu
 951 Start every line with a dot, for example, by using the groff request
 952 .B .nop
 953 for text lines, or write your own macro that handles also text lines
 954 with a leading dot.
 955 .
 956 .RS
 957 .IP
 958 .EX
 959 \&.de Text
 960 \&.\ \ if (\e\en[.$] == 0)\ \e
 961 \&.\ \ \ \ return
 962 \&.\ \ nop\ \e)\e\e$*[rs]\)
 963 \&..
 964 .EE
 965 .RE
 966 .
 967 .IP \(bu
 968 Write a comment macro that works both for copy-in and draft mode; for
 969 as escaping is off in draft mode, trouble might occur when normal
 970 comments are used.
 971 .
 972 For example, the following macro just ignores its arguments, so it
 973 acts like a comment line:
 974 .
 975 .RS
 976 .IP
 977 .EX
 978 \&.de\ c
 979 \&..
 980 \&.c\ This\ is\ like\ a\ comment\ line.
 981 .EE
 982 .RE
 983 .
 984 .IP \(bu
 985 In long macro definitions, make ample use of comment lines or empty
 986 lines for a better structuring.
 987 .
 988 .IP \(bu
 989 To increase readability, use groff's indentation facility for requests
 990 and macro calls (arbitrary whitespace after the leading dot).
 991 .
 992 .
 993 .\" --------------------------------------------------------------------
 994 .SS "Diversions"
 995 .\" --------------------------------------------------------------------
 996 .
 997 Diversions can be used to implement quite advanced programming
 998 constructs.
 999 .
1000 They are comparable to pointers to large data structures in the
1001 C\~programming language, but their usage is quite different.
1002 .
1003 .
1004 .P
1005 In their simplest form, diversions are multi-line strings, but
1006 they get their power when diversions are used dynamically within macros.
1007 .
1008 The information stored in a diversion can be retrieved by calling the
1009 diversion just like a macro.
1010 .
1011 .
1012 .P
1013 Most of the problems arising with diversions can be avoided if you remain
1014 aware of the fact that diversions always store complete lines.
1015 .
1016 If diversions are used when the line buffer has not been flushed,
1017 strange results are produced; not knowing this, many people get
1018 desperate about diversions.
1019 .
1020 To ensure that a diversion works, line breaks should be added at the
1021 right places.
1022 .
1023 To be on the secure side, enclose everything that has to do with
1024 diversions into a pair of line breaks; for example, by explicitly using
1025 .B .br
1026 requests.
1027 .
1028 This rule should be applied to diversion definition, both inside and
1029 outside, and to all calls of diversions.
1030 .
1031 This is a bit of overkill, but it works nicely.
1032 .
1033 .
1034 .P
1035 [If you really need diversions which should ignore the current partial
1036 line, use environments to save the current partial line and/\:or use the
1037 .B .box
1038 request.]
1039 .
1040 .
1041 .P
1042 The most powerful feature using diversions is to start a diversion
1043 within a macro definition and end it within another macro.
1044 .
1045 Then everything between each call of this macro pair is stored within
1046 the diversion and can be manipulated from within the macros.
1047 .
1048 .
1049 .\" --------------------------------------------------------------------
1050 .SH FILES
1051 .\" --------------------------------------------------------------------
1052 .
1053 All macro names must be named
1054 .IB name .tmac
1055 to fully use the tmac mechanism.
1056 .
1057 .BI tmac. name
1058 as with classical packages is possible as well, but deprecated.
1059 .
1060 .
1061 .P
1062 The macro files are kept in the
1063 .IR "tmac directories" ;
1064 a colon separated list of these constitutes the
1065 .IR "tmac path" .
1066 .
1067 .
1068 .P
1069 The search sequence for macro files is (in that order):
1070 .
1071 .IP \(bu
1072 the directories specified with troff/groff's
1073 .B \-M
1074 command line option
1075 .
1076 .IP \(bu
1077 the directories given in the
1078 .B $GROFF_TMAC_PATH
1079 environment variable
1080 .
1081 .IP \(bu
1082 the current directory (only if in unsafe mode, which is enabled by the
1083 .B \-U
1084 command line switch)
1085 .
1086 .IP \(bu
1087 the home directory
1088 .
1089 .IP \(bu
1090 a platform-specific directory, being
1091 .B @SYSTEMMACRODIR@
1092 in this installation
1093 .
1094 .IP \(bu
1095 a site-specific (platform-independent) directory, being
1096 .B @LOCALMACRODIR@
1097 in this installation
1098 .
1099 .IP \(bu
1100 the main tmac directory, being
1101 .B @MACRODIR@
1102 in this installation
1103 .
1104 .
1105 .\" --------------------------------------------------------------------
1106 .SH ENVIRONMENT
1107 .\" --------------------------------------------------------------------
1108 .
1109 .TP
1110 .B $GROFF_TMAC_PATH
1111 A colon separated list of additional tmac directories in which to search
1112 for macro files.
1113 .
1114 See the previous section for a detailed description.
1115 .
1116 .
1117 .\" --------------------------------------------------------------------
1118 .SH AUTHOR
1119 .\" --------------------------------------------------------------------
1120 .
1121 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006, 2007
1122 Free Software Foundation, Inc.
1123 .
1124 .P
1125 This document is distributed under the terms of the FDL (GNU Free
1126 Documentation License) version 1.1 or later.
1127 .
1128 You should have received a copy of the FDL on your system, it is also
1129 available on-line at the
1130 .UR http://www.gnu.org/copyleft/fdl.html
1131 GNU copyleft site
1132 .UE .
1133 .
1134 .P
1135 This document is part of
1136 .IR groff ,
1137 the GNU roff distribution.
1138 .
1139 It was written by
1140 .MT bwarken@mayn.de
1141 Bernd Warken
1142 .ME ;
1143 it is maintained by
1144 .MT wl@gnu.org
1145 Werner Lemberg
1146 .ME .
1147 .
1148 .
1149 .\" --------------------------------------------------------------------
1150 .SH "SEE ALSO"
1151 .\" --------------------------------------------------------------------
1152 .
1153 A complete reference for all parts of the groff system is found in the
1154 groff
1155 .BR info (1)
1156 file.
1157 .
1158 .
1159 .TP
1160 .BR groff (@MAN1EXT@)
1161 an overview of the groff system.
1162 .
1163 .
1164 .TP
1165 .BR groff_man (@MAN7EXT@),
1166 .TQ
1167 .BR groff_mdoc (@MAN7EXT@),
1168 .TQ
1169 .BR groff_me (@MAN7EXT@),
1170 .TQ
1171 .BR groff_mm (@MAN7EXT@),
1172 .TQ
1173 .BR groff_mom (@MAN7EXT@),
1174 .TQ
1175 .BR groff_ms (@MAN7EXT@),
1176 .TQ
1177 .BR groff_trace (@MAN7EXT@),
1178 .TQ
1179 .BR groff_www (@MAN7EXT@).
1180 the groff tmac macro packages.
1181 .
1182 .
1183 .TP
1184 .BR groff (@MAN7EXT@)
1185 the groff language.
1186 .
1187 .
1188 .P
1189 The Filesystem Hierarchy Standard is available at the
1190 .UR http://www.pathname.com/fhs/
1191 FHS web site
1192 .UE .
1193 .
1194 .\" Local Variables:
1195 .\" mode: nroff
1196 .\" End: