contrib/mom/momdoc/typesetting.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3 This file is part of groff, the GNU roff type-setting system.
   4
   5 Copyright (C) 2004-2018 Free Software Foundation, Inc.
   6 Written by Peter Schaffter (peter@schaffter.ca).
   7
   8 Permission is granted to copy, distribute and/or modify this document
   9 under the terms of the GNU Free Documentation License, Version 1.3 or
  10 any later version published by the Free Software Foundation; with no
  11 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  12 Texts.
  13
  14 A copy of the Free Documentation License is included as a file called
  15 FDL in the main directory of the groff source package.
  16 -->
  17
  18 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  19 <html xmlns="http://www.w3.org/1999/xhtml">
  20
  21 <head>
  22   <meta http-equiv="content-type" content="text/html;charset=utf-8"/>
  23   <title>Mom -- Typesetting Macros</title>
  24   <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  25 </head>
  26
  27 <body style="background-color: #f5faff;">
  28
  29 <!-- ==================================================================== -->
  30
  31 <div id="top" class="page">
  32
  33 <!-- Navigation links -->
  34 <table style="width: 100%;">
  35 <tr>
  36   <td><a href="toc.html">Back to Table of Contents</a></td>
  37   <td style="text-align: right;"><a href="goodies.html#top">Next: Goodies</a></td>
  38 </tr>
  39 </table>
  40
  41 <h1 id="typesetting" class="docs">The typesetting macros</h1>
  42
  43 <div id="typesetting-macros-mini-toc" class="mini-toc">
  44 <div class="mini-toc-col-1">
  45 <ul class="no-enumerator">
  46   <li class="list-head"><a href="#typesetting-macros">Introduction</a></li>
  47   <li class="list-head"><a href="#page-setup-intro">Paper and page setup</a>
  48   <ul>
  49     <li class="item"><a href="#page-setup-note"><i>Important note on page dimensions &amp; papersize</i></a></li>
  50     <li class="item"><a href="#index-page-setup">Macro list</a></li>
  51   </ul></li>
  52   <li class="list-head"><a href="#basic-params-intro">Basic typesetting parameters</a>
  53   <ul>
  54     <li class="item"><a href="#index-basic">Macro list</a></li>
  55   </ul></li>
  56   <li class="list-head"><a href="#justification-intro">Justification and quadding/
  57     <br/>
  58     <span style="margin-left: 1em;">breaking and joining lines</span></a>
  59   <ul>
  60     <li class="item"><a href="#index-justification">Macro list</a></li>
  61   </ul></li>
  62   <li class="list-head"><a href="#refinements-intro">Typographic refinements</a>
  63   <ul>
  64     <li class="item"><a href="#index-refinements">Macro list</a></li>
  65   </ul></li>
  66   <li class="list-head"><a href="#modifications-intro">Type modifications (pseudo font styles)</a>
  67   <ul class="no-enumerator">
  68     <li class="item"><a href="#index-modifications">Macro list</a></li>
  69   </ul></li>
  70   <li class="list-head"><a href="#aldrld-intro">Vertical movements</a>
  71   <ul class="no-enumerator">
  72     <li class="item"><a href="#index-aldrld">Macro list</a>
  73     </li>
  74   </ul></li>
  75 </ul>
  76 </div>
  77 <div class="mini-toc-col-2">
  78   <ul class="no-enumerator">
  79   <li class="list-head"><a href="#tabs-intro">Tabs</a>
  80   <ul class="no-enumerator">
  81     <li class="item"><a href="#typesetting-tabs">Typesetting tabs</a>
  82     <ul style="margin-left: -.5em;">
  83       <li class="item" style="margin-left: -.5em; list-style-type: circle;"><a href="#typesetting-tabs-tut">Quickie tutorial on typesetting tabs</a></li>
  84     </ul></li>
  85     <li class="item"><a href="#string-tabs">String tabs</a>
  86     <ul style="margin-left: -.5em;">
  87       <li class="item" style="margin-left: -.5em; list-style-type: circle;"><a href="#string-tabs-tut">Quickie tutorial on string tabs</a></li>
  88     </ul></li>
  89     <li class="item"><a href="#index-tabs">Macro list</a></li>
  90   </ul></li>
  91   <li class="list-head"><a href="#multicolumns-intro">Multiple columns</a>
  92   <ul class="no-enumerator">
  93     <li class="item"><a href="#index-multicolumns">Macro list</a>
  94     </li>
  95   </ul></li>
  96   <li class="list-head"><a href="#indents-intro">Indents</a>
  97   <ul class="no-enumerator">
  98     <li class="item"><a href="#indents-handling">How mom handles indents</a></li>
  99     <li class="item"><a href="#index-indents">Macro list</a>
 100     </li>
 101   </ul></li>
 102   <li class="list-head"><a href="goodies.html#goodies">Goodies</a>
 103   <ul class="no-enumerator">
 104     <li class="item"><a href="goodies.html#goodies-macros">Macro list</a>
 105     </li>
 106   </ul></li>
 107   <li class="list-head"><a href="inlines.html#top">Inline escapes</a>
 108   <ul class="no-enumerator">
 109     <li class="item"><a href="inlines.html#index-inlines">List of inline escapes</a>
 110     </li>
 111   </ul></li>
 112   <li class="list-head"><a href="color.html">Coloured text</a>
 113   <ul class="no-enumerator">
 114     <li class="item"><a href="color.html#index-color">Macro list</a></li>
 115   </ul></li>
 116 </ul>
 117 </div>
 118 </div>
 119
 120 <div class="rule-medium"><hr/></div>
 121
 122 <h2 id="typesetting-intro" class="docs">Introduction</h2>
 123
 124 <p>
 125 Mom&#8217;s typesetting macros provide access to groff&#8217;s
 126 typesetting capabilities.  Aside from controlling basic type
 127 parameters (family, font, line length, point size, leading),
 128 mom&#8217;s macros fine-tune wordspacing, letterspacing, kerning,
 129 hyphenation, and so on.  In addition, mom has true typesetting tabs,
 130 string tabs, multiple indent styles, line padding, and a batch of
 131 other goodies.
 132 </p>
 133
 134 <p>
 135 In some cases, mom&#8217;s typesetting macros merely imitate groff
 136 primitives.  In others, they approach typesetting concerns in
 137 conceptually new ways (for groff, at least).  This should present
 138 no problem for newcomers to groff who are learning mom.  Old groff
 139 hands should be careful.  Just because it looks like a duck and
 140 walks like a duck does not, in this instance, mean that it is a
 141 duck.  When using mom, stay away from groff primitives if mom
 142 provides a macro that accomplishes the same thing.
 143 </p>
 144
 145 <p>
 146 Mom&#8217;s typesetting macros can be used as a standalone package,
 147 independent of the
 148 <a href="docprocessing.html#top">document processing macros</a>.
 149 With them, you can typeset on-the-fly.  Book covers, your best
 150 friend&#8217;s résumé, a poster for a lost dog&mdash;none of these
 151 requires structured document processing (page headers, paragraphs,
 152 headings, footnotes, etc).  What they do demand is precise control over
 153 every element on the page.  The typesetting macros give you that
 154 control.
 155 </p>
 156
 157 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
 158
 159 <!-- ==================================================================== -->
 160
 161 <h2 id="page-setup-intro" class="macro-group">Paper and page setup: paper size &amp; page margins</h2>
 162
 163 <p>
 164 The page setup macros establish the physical dimensions of your page
 165 and the margins you want it to have. Groff has defaults for these,
 166 but I recommend setting them at the top of your files anyway.
 167 </p>
 168
 169 <p>
 170 If you&#8217;re using mom&#8217;s
 171 <a href="docprocessing.html#docprocessing">document processing macros</a>,
 172 these macros must come after
 173 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>.
 174 </p>
 175
 176 <p>
 177 The
 178 <a href="#paper">PAPER</a>
 179 macro provides a shortcut for setting the page to the correct
 180 dimensions for a number of common paper sizes.  The
 181 <a href="#page">PAGE</a>
 182 macro provides a convenient way of setting the page dimensions and
 183 some or all of the page margins with a single macro.
 184 </p>
 185
 186 <div class="box-notes">
 187 <h3 id="page-setup-note" class="docs notes">Important note on page dimensions and papersize</h3>
 188
 189 <p style="margin-top: .5em;">
 190 When mom files are processed with
 191 <a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>,
 192 which is recommended (see
 193 <a href="http://www.schaffter.ca/mom/pdf/mom-pdf.pdf"><span class="book-title">Producing PDFs with groff and mom</span></a>),
 194 page dimensions are automatically passed to groff, and you don't
 195 have to worry about them.
 196 </p>
 197
 198 <p>
 199 Mom documents processed directly with <strong>groff</strong>, or with
 200 <strong>pdfroff</strong>, or with <strong>pdfmom&nbsp;&#8209;Tps</strong>, require
 201 that the papersize be given on the command line as well if the
 202 papersize is different from the default on your system.  You can
 203 verify&mdash;or change&mdash;the default papersize by inspecting the
 204 files
 205 <br/>
 206 <span class="pre-in-pp">
 207   &lt;path to groff&gt;/font/devps/DESC
 208 </span>
 209 and
 210 <br/>
 211 <span class="pre-in-pp">
 212   &lt;path to groff&gt;/font/devpdf/DESC
 213 </span>
 214 (See <strong>man papersize</strong> for list of valid papersize
 215 names, as well as for instructions on how to enter a non-standard
 216 size.)
 217 </p>
 218
 219 <p>
 220 If you occasionally need to print on sheets that do not
 221 conform to your default papersize, you must, in addition
 222 to setting the page dimensions in your mom file, pass the
 223 <kbd>-P-p&lt;papersize&gt;</kbd> option to <strong>groff</strong>,
 224 <strong>pdfroff</strong>, or <strong>pdfmom -Tps</strong>.
 225 </p>
 226
 227 <p>
 228 For example, suppose your routine papersize is &#8220;letter&#8221;,
 229 and you need to print something on a legal-sized sheet.  After
 230 telling mom about the legal-size sheet (with either
 231 <a href="#pagelength">PAGELENGTH</a>
 232 and
 233 <a href="#pagewidth">PAGEWIDTH</a>
 234 or
 235 <a href="#paper">PAPER</a>,
 236 or
 237 <a href="#page">PAGE</a>),
 238 you must include <kbd>-P-p&lt;papersize&gt;</kbd> on whichever
 239 command line you use, e.g.,
 240 <br/>
 241 <span class="pre-in-pp">
 242   pdfmom -Tps -mom -P-plegal
 243 </span>
 244 Remember, though, that
 245 <a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>,
 246 with no <kbd>-Tps</kbd> option, is smart enough to know the
 247 papersize from the dimensions provided in your mom file.
 248 </p>
 249
 250 <p class="tip-bottom">
 251 Consult <kbd>man groff</kbd>, <kbd>man grops</kbd> and <kbd>man
 252 groff_font</kbd> for additional information concerning papersizes,
 253 as well as information on printing in &#8220;landscape&#8221;
 254 orientation.
 255 </p>
 256 </div>
 257
 258 <div class="macro-list-container">
 259 <h3 id="index-page-setup" class="macro-list">Paper and page setup macros</h3>
 260
 261 <ul class="macro-list">
 262   <li><a href="#pagewidth">PAGEWIDTH</a> &ndash; page width</li>
 263   <li><a href="#pagelength">PAGELENGTH</a> &ndash; page length</li>
 264   <li><a href="#paper">PAPER</a> &ndash; common paper sizes</li>
 265   <li><a href="#l-margin">L_MARGIN</a> &ndash; left margin</li>
 266   <li><a href="#r-margin">R_MARGIN</a> &ndash; right margin</li>
 267   <li><a href="#t-margin">T_MARGIN</a> &ndash; top margin</li>
 268   <li><a href="#b-margin">B_MARGIN</a> &ndash; bottom margin</li>
 269   <li><a href="#page">PAGE</a> &ndash; page dimensions and margins all in one fell swoop</li>
 270   <li><a href="#newpage">NEWPAGE</a> &ndash; start a new page</li>
 271 </ul>
 272 </div>
 273
 274 <!-- -PAGEWIDTH- -->
 275
 276 <div class="macro-id-overline">
 277 <h3 id="pagewidth" class="macro-id">Page width</h3>
 278 </div>
 279
 280 <div class="box-macro-args">
 281 Macro: <b>PAGEWIDTH</b> <kbd class="macro-args">&lt;width of printer sheet&gt;</kbd>
 282 </div>
 283 <p class="requires">
 284 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
 285 </p>
 286
 287 <p>
 288 The argument to PAGEWIDTH is the width of your printer sheet.
 289 PAGEWIDTH requires a unit of measure.  Decimal fractions are
 290 allowed.  Hence, to tell mom that the width of your printer sheet is
 291 8-1/2 inches, you enter
 292 <br/>
 293 <span class="pre-in-pp">
 294   .PAGEWIDTH 8.5i
 295 </span>
 296 Please read the
 297 <a href="#page-setup-note">Important note on page dimensions and papersize</a>
 298 for information on ensuring groff respects your
 299 PAGEWIDTH.
 300 </p>
 301
 302 <div class="box-important">
 303 <p class="tip">
 304 <span class="important">Important:</span> <kbd>PAGEWIDTH</kbd>,
 305 when you need it, should be placed at the top of your files.
 306 </p>
 307 </div>
 308
 309 <!-- -PAGELENGTH- -->
 310
 311 <div class="macro-id-overline">
 312 <h3 id="pagelength" class="macro-id">Page length</h3>
 313 </div>
 314
 315 <div class="box-macro-args">
 316 Macro: <b>PAGELENGTH</b> <kbd class="macro-args">&lt;length of printer sheet&gt;</kbd>
 317 </div>
 318 <p class="requires">
 319 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
 320 </p>
 321
 322 <p>
 323 PAGELENGTH tells mom how long your printer sheet is.  It works just
 324 like PAGEWIDTH.  Therefore, to tell mom your printer sheet is 11
 325 inches long, you enter
 326 <br/>
 327 <span class="pre-in-pp">
 328   .PAGELENGTH 11i
 329 </span>
 330 Please read the
 331 <a href="#page-setup-note">Important note on page dimensions and papersize</a>
 332 for information on ensuring groff respects your PAGELENGTH.
 333 </p>
 334
 335 <div class="box-important">
 336 <p class="tip">
 337 <span class="important">Important:</span> <kbd>PAGELENGTH</kbd>,
 338 when you need it, should be placed at the top of your files.
 339 </p>
 340 </div>
 341
 342 <!-- -PAPER- -->
 343
 344 <div class="macro-id-overline">
 345 <h3 id="paper" class="macro-id">Paper</h3>
 346 </div>
 347
 348 <div class="box-macro-args">
 349 Macro: <b>PAPER</b> <kbd class="macro-args">&lt;paper type&gt; [ LANDSCAPE ]</kbd>
 350 </div>
 351
 352 <p>
 353 PAPER provides a convenient way to set the dimensions for some
 354 common printer sheet sizes. <kbd>&lt;paper&nbsp;type&gt;</kbd> can
 355 be one of:
 356 <br/>
 357 <span class="pre-in-pp">
 358   LETTER       EXECUTIVE
 359   LEGAL        10x14
 360   STATEMENT    A3
 361   TABLOID      A4
 362   LEDGER       A5
 363   FOLIO        B4
 364   QUARTO       B5
 365 </span>
 366 Say, for example, you have A4-sized sheets in your printer.  It&#8217;s
 367 shorter (and easier) to enter
 368 <br/>
 369 <span class="pre-in-pp">
 370   .PAPER A4
 371 </span>
 372 than to remember the correct dimensions and enter
 373 <br/>
 374 <span class="pre-in-pp">
 375   .PAGEWIDTH  595p
 376   .PAGELENGTH 842p
 377 </span>
 378 If you&#8217;d like landscape orientation for your paper type,
 379 pass PAPER the <kbd>LANDSCAPE</kbd> argument.
 380 <p>
 381 Please read the
 382 <a href="#page-setup-note">Important note on page dimensions and papersize</a>
 383 for information on ensuring groff respects your PAPER size.
 384 </p>
 385
 386 <div class="box-important">
 387 <p class="tip">
 388 <span class="important">Important:</span> <kbd>PAPER</kbd> when you
 389 need it, should be placed at the top of your files.
 390 </p>
 391 </div>
 392
 393 <!-- -L_MARGIN- -->
 394
 395 <div class="macro-id-overline">
 396 <h3 id="l-margin" class="macro-id">Left margin</h3>
 397 </div>
 398
 399 <div class="box-macro-args">
 400 Macro: <b>L_MARGIN</b> <kbd class="macro-args">&lt;left margin&gt;</kbd>
 401 </div>
 402 <p class="requires">
 403 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
 404 </p>
 405
 406 <p>
 407 L_MARGIN establishes the distance from the left edge of the printer
 408 sheet at which you want your type to start.  It may be used any
 409 time, and remains in effect until you enter a new value.
 410 </p>
 411
 412 <p>
 413 <a href="#il">Left indents</a>
 414 and
 415 <a href="#tabs">tabs</a>
 416 are calculated from the value you pass to L_MARGIN, hence it&#8217;s
 417 always a good idea to invoke it before starting any serious
 418 typesetting.  A unit of measure is required.  Decimal fractions are
 419 allowed.  Therefore, to set the left margin at 3 picas (1/2 inch),
 420 you&#8217;d enter either
 421 <br/>
 422 <span class="pre-in-pp">
 423   .L_MARGIN 3P
 424 </span>
 425 or
 426 <span class="pre-in-pp">
 427   .L_MARGIN .5i
 428 </span>
 429 If you use the macros
 430 <a href="#page">PAGE</a>,
 431 <a href="#pagewidth">PAGEWIDTH</a>
 432 or
 433 <a href="#paper">PAPER</a>
 434 without invoking L_MARGIN (either before or afterwards), mom
 435 automatically sets L_MARGIN to 1 inch.
 436 </p>
 437
 438 <div class="box-tip">
 439 <p class="tip">
 440 <span class="note">Note:</span> L_MARGIN behaves in a special way
 441 when you&#8217;re using the
 442 <a href="docprocessing.html#docprocessing">document processing macros</a>.
 443 See
 444 <a href="docprocessing.html#behaviour">Typesetting macros during document processing</a>
 445 for an explanation.
 446 </p>
 447 </div>
 448
 449 <!-- -R_MARGIN- -->
 450
 451 <div class="macro-id-overline">
 452 <h3 id="r-margin" class="macro-id">Right margin</h3>
 453 </div>
 454
 455 <div class="box-macro-args">
 456 Macro: <b>R_MARGIN</b> <kbd class="macro-args">&lt;right margin&gt;</kbd>
 457 </div>
 458 <p class="requires">
 459 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
 460 </p>
 461
 462 <div class="box-important">
 463 <p class="tip">
 464 <span class="important">IMPORTANT:</span> R_MARGIN, if used, must
 465 come after
 466 <a href="#paper">PAPER</a>,
 467 <a href="#pagewidth">PAGEWIDTH</a>,
 468 <a href="#l-margin">L_MARGIN</a>
 469 and/or
 470 <a href="#page">PAGE</a>
 471 (if a right margin isn&#8217;t given to PAGE).  The reason is that
 472 R_MARGIN calculates line length from the overall page dimensions and
 473 the left margin.  Obviously, it can&#8217;t make the calculation if
 474 it doesn&#8217;t know the page width and the left margin.
 475 </p>
 476 </div>
 477
 478 <p>
 479 R_MARGIN establishes the amount of space you want between the end
 480 of typeset lines and the right hand edge of the printer sheet.  In
 481 other words, it sets the line length.  R_MARGIN requires a unit of
 482 measure.  Decimal fractions are allowed.
 483 </p>
 484
 485 <p>
 486 The line length macro
 487 (<a href="#linelength">LL</a>)
 488 can be used in place of R_MARGIN.  In either case, the last one
 489 invoked sets the line length.  The choice of which to use is up
 490 to you.  In some instances, you may find it easier to think of a
 491 section of type as having a right margin.  In others, giving a line
 492 length may make more sense.
 493 </p>
 494
 495 <p>
 496 For example, if you&#8217;re setting a page of type you know should
 497 have 6-pica margins left and right, it makes sense to enter a left
 498 and right margin, like this:
 499 <br/>
 500 <span class="pre-in-pp">
 501   .L_MARGIN 6P
 502   .R_MARGIN 6P
 503 </span>
 504 That way, you don&#8217;t have to worry about calculating the line
 505 length.  On the other hand, if you know the line length for a patch
 506 of type should be 17 picas and 3 points, entering the line length
 507 with LL is much easier than calculating the right margin, e.g.,
 508 <br/>
 509 <span class="pre-in-pp">
 510   .LL 17P+3p
 511 </span>
 512 If you use the macros
 513 <a href="#page">PAGE</a>,
 514 <a href="#pagewidth">PAGEWIDTH</a>
 515 or
 516 <a href="#paper">PAPER</a>
 517 without invoking <kbd>.R_MARGIN</kbd> afterwards, mom automatically
 518 sets R_MARGIN to 1 inch.  If you set a line length after these
 519 macros (with
 520 <a href="#linelength">LL</a>),
 521 the line length calculated by R_MARGIN is, of course, overridden.
 522 </p>
 523
 524 <div class="box-tip">
 525 <p class="tip">
 526 <span class="note">Note:</span> R_MARGIN behaves in a special way when you&#8217;re
 527 using the
 528 <a href="docprocessing.html#docprocessing">document processing macros</a>.
 529 See
 530 <a href="docprocessing.html#behaviour">Typesetting macros during document processing</a>
 531 for an explanation.
 532 </p>
 533 </div>
 534
 535 <!-- -T_MARGIN- -->
 536
 537 <div class="macro-id-overline">
 538 <h3 id="t-margin" class="macro-id">Top margin</h3>
 539 </div>
 540
 541 <div class="box-macro-args">
 542 Macro: <b>T_MARGIN</b> <kbd class="macro-args">&lt;top margin&gt;</kbd>
 543 </div>
 544 <p class="requires">
 545 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
 546 </p>
 547
 548 <p>
 549 T_MARGIN establishes the distance from the top of the printer
 550 sheet at which you want your type to start.  It requires a unit of
 551 measure, and decimal fractions are allowed.  To set a top margin of
 552 2-1/2 centimetres, you&#8217;d enter
 553 <br/>
 554 <span class="pre-in-pp">
 555    .T_MARGIN 2.5c
 556 </span>
 557 T_MARGIN calculates the vertical position of the first line of type
 558 on a page by treating the top edge of the printer sheet as a
 559 <a href="definitions.html#baseline">baseline</a>.  Therefore,
 560 <br/>
 561 <span class="pre-in-pp">
 562   .T_MARGIN 1.5i
 563 </span>
 564 puts the baseline of the first line of type 1-1/2 inches beneath the
 565 top of the page.
 566 </p>
 567
 568 <div class="box-tip">
 569 <p class="tip">
 570 <span class="note">Note:</span> T_MARGIN means something slightly
 571 different when you&#8217;re using the
 572 <a href="docprocessing.html#docprocessing">document processing macros</a>.
 573 See
 574 <a href="docprocessing.html#tb-margins">Top and bottom margins in document processing</a>
 575 for an explanation.
 576 </p>
 577 </div>
 578
 579 <div class="box-important">
 580 <p class="tip">
 581 <span class="important">IMPORTANT:</span> T_MARGIN does two
 582 things: it establishes the top margin for pages that come after
 583 it <i>and</i> it moves to that position on the current page.
 584 Therefore, T_MARGIN should only be used at the top of a file (prior
 585 to entering text) or after
 586 <a href="#newpage">NEWPAGE</a>,
 587 like this:
 588 <br/>
 589 <span class="pre-in-pp" style="margin-bottom: -1em;">
 590   .NEWPAGE
 591   .T_MARGIN 6P
 592   &lt;text&gt;
 593 </span>
 594 </p>
 595 </div>
 596
 597 <!-- -B_MARGIN- -->
 598
 599 <div class="macro-id-overline">
 600 <h3 id="b-margin" class="macro-id">Bottom margin</h3>
 601 </div>
 602
 603 <div class="box-macro-args">
 604 Macro: <b>B_MARGIN</b> <kbd class="macro-args">&lt;bottom margin&gt;</kbd>
 605 </div>
 606 <p class="requires">
 607 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
 608 </p>
 609
 610 <p>
 611 B_MARGIN sets a nominal position at the bottom of the page beyond
 612 which you don&#8217;t want your type to go.  When the bottom margin
 613 is reached, mom starts a new page.  B_MARGIN requires a unit of
 614 measure.  Decimal fractions are allowed.  To set a nominal bottom
 615 margin of 3/4 inch, enter
 616 <br/>
 617 <span class="pre-in-pp">
 618   .B_MARGIN .75i
 619 </span>
 620 Obviously, if you haven&#8217;t spaced the type on your pages so
 621 that the last lines fall perfectly at the bottom margin, the margin
 622 will vary from page to page.  Usually, but not always, the last line
 623 of type that fits on a page before the bottom margin causes mom to
 624 start a new page.
 625 </p>
 626
 627 <p>
 628 Occasionally, owing to a peculiarity in groff, an extra line will
 629 fall below the nominal bottom margin.  If you&#8217;re using the
 630 <a href="docprocessing.html#docprocessing">document processing macros</a>,
 631 this is unlikely to happen; the document processing macros are very
 632 hard-nosed about aligning bottom margins.
 633 </p>
 634
 635 <div class="box-tip">
 636 <p class="tip">
 637 <span class="note">Note:</span> The meaning of B_MARGIN is slightly
 638 different when you&#8217;re using the document processing macros.
 639 See
 640 <a href="docprocessing.html#tb-margins">Top and bottom margins in document processing</a>
 641 for an explanation.
 642 </p>
 643 </div>
 644
 645 <!-- -PAGE- -->
 646
 647 <div class="macro-id-overline">
 648 <h3 id="page" class="macro-id">Page</h3>
 649 </div>
 650
 651 <div class="box-macro-args" style="overflow: auto;">
 652 Macro: <b>PAGE</b> <kbd class="macro-args">&lt;width&gt;&nbsp;[ &lt;length&gt; [ &lt;lm&gt; [ &lt;rm&gt; [ &lt;tm&gt; [ &lt;bm&gt; ] ] ] ] ]</kbd>
 653 </div>
 654 <p class="requires">
 655 &bull;&nbsp;All arguments require a <a href="definitions.html#unitofmeasure">unit of measure</a>
 656 </p>
 657
 658 <div class="box-important">
 659 <p class="tip">
 660 <span class="important">IMPORTANT:</span> If you&#8217;re using the
 661 <a href="docprocessing.html#docprocessing">document processing macros</a>,
 662 PAGE must come after
 663 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>.
 664 Otherwise, it should go at the top of a document, prior to any
 665 text.  And remember, when you&#8217;re using the document processing
 666 macros, top margin and bottom margin mean something slightly
 667 different than when you&#8217;re using just the typesetting macros
 668 (see
 669 <a href="docprocessing.html#tb-margins">Top and bottom margins in document processing</a>).
 670 </p>
 671 </div>
 672
 673 <p>
 674 PAGE lets you establish paper dimensions and page margins with a
 675 single macro.  The only required argument is page width.  The rest
 676 are optional, but they must appear in order and you can&#8217;t
 677 skip over any. <kbd>&lt;lm&gt;, &lt;rm&gt;, &lt;tm&gt;</kbd> and
 678 <kbd>&lt;bm&gt;</kbd> refer to the left, right, top and bottom
 679 margins respectively.
 680 </p>
 681
 682 <p>
 683 Assuming your page dimensions are 11 inches by 17 inches, and
 684 that&#8217;s all you want to set, enter
 685 <br/>
 686 <span class="pre-in-pp">
 687   .PAGE 11i 17i
 688 </span>
 689 If you want to set the left margin as well, say, at 1 inch, PAGE
 690 would look like this:
 691 <br/>
 692 <span class="pre-in-pp">
 693   .PAGE 11i 17i 1i
 694 </span>
 695 Now suppose you also want to set the top margin, say, at 1-1/2
 696 inches. &lt;tm&gt; comes after &lt;rm&gt; in the optional arguments,
 697 but you can&#8217;t skip over any arguments, therefore to set the
 698 top margin, you must also give a right margin.  The PAGE macro would
 699 look like this:
 700 <br/>
 701 <span class="pre-in-pp">
 702   .PAGE 11i 17i 1i 1i 1.5i
 703                    |   |
 704   required right---+   +---top margin
 705       margin
 706 </span>
 707 Clearly, PAGE is best used when you want a convenient way to tell
 708 mom just the dimensions of your printer sheet (width and length), or
 709 when you want to tell her everything about the page (dimensions and
 710 all the margins), for example
 711 <br/>
 712 <span class="pre-in-pp">
 713   .PAGE 8.5i 11i 45p 45p 45p 45p
 714 </span>
 715 This sets up an 8-1/2 by 11 inch page with margins of 45 points
 716 (5/8-inch) all around.
 717 </p>
 718
 719 <p>
 720 Additionally, if you invoke <kbd>.PAGE</kbd> with a top margin
 721 argument, any macros you invoke after <kbd>.PAGE</kbd> will almost
 722 certainly move the
 723 <a href="definitions.html#baseline">baseline</a>
 724 of the first line of text down by one linespace.  To compensate, do
 725 <br/>
 726 <span class="pre-in-pp">
 727   .RLD 1v
 728 </span>
 729 immediately before entering any text, or, if it&#8217;s feasible,
 730 make PAGE the last macro you invoke prior to entering text.
 731 </p>
 732
 733 <p>
 734 Please read the
 735 <a href="#page-setup-note">Important note on page dimensions and papersize</a>
 736 for information on ensuring groff respects your PAGE dimensions and
 737 margins.
 738 </p>
 739
 740 <!-- -NEWPAGE- -->
 741
 742 <div class="macro-id-overline">
 743 <h3 id="newpage" class="macro-id">Start a new page</h3>
 744 </div>
 745
 746 <div class="box-macro-args">
 747 Macro: <b>NEWPAGE</b>
 748 </div>
 749
 750 <p>
 751 Whenever you want to start a new page, use NEWPAGE, by itself with
 752 no argument. Mom will finish up processing the current page and move
 753 you to the top of a new one (subject to the top margin set with
 754 <a href="#t-margin">T_MARGIN</a>).
 755 </p>
 756
 757 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
 758
 759 <!-- ==================================================================== -->
 760
 761 <h2 id="basic-params-intro" class="macro-group">Basic typesetting parameters</h2>
 762
 763 <p>
 764 The basic typesetting parameter macros deal with fundamental
 765 requirements for setting type: family, font, point size, leading and
 766 line length.
 767 </p>
 768
 769 <p>
 770 If you&#8217;re using the typesetting macros only, the arguments
 771 passed to the basic parameter macros remain in effect until
 772 you change them.  The document processing macros handle things
 773 differently.  See
 774 <a href="docprocessing.html#behaviour">Typesetting macros during document processing</a>
 775 for an explanation.
 776 </p>
 777
 778 <div id="index-basic" class="macro-list-container">
 779 <h3 class="macro-list">Basic parameter macros</h3>
 780 <ul class="macro-list">
 781   <li><a href="#family">FAMILY</a> &ndash; type family</li>
 782   <li><a href="#font">FT</a> &ndash; font</li>
 783   <li><a href="#fallback-font">FALLBACK_FONT</a> &ndash; for invalid fonts</li>
 784   <li><a href="#ps">PT_SIZE</a> &ndash; point size of type</li>
 785   <li><a href="#leading">LS</a> &ndash; line spacing/leading</li>
 786   <li><a href="#autolead">AUTOLEAD</a> &ndash; automatic line spacing</li>
 787   <li><a href="#linelength">LL</a> &ndash; line length</li>
 788 </ul>
 789 </div>
 790
 791 <!-- -FAMILY- -->
 792
 793 <div class="macro-id-overline">
 794 <h3 id="family" class="macro-id">Type family</h3>
 795 </div>
 796
 797 <div class="box-macro-args">
 798 Macro: <b>FAMILY</b> <kbd class="macro-args">&lt;family&gt;</kbd>
 799 </div>
 800 <p class="alias">
 801 <i>Alias:</i> <b>FAM</b>
 802 </p>
 803
 804 <p>
 805 FAMILY takes one argument: the name of the
 806 <a href="definitions.html#family">family</a>
 807 you want.  Groff comes with a small set of basic families, each
 808 identified by a 1-, 2-or 3-letter mnemonic.  The standard families
 809 are:
 810 <br/>
 811 <span class="pre-in-pp">
 812   A   = Avant Garde
 813   BM  = Bookman
 814   H   = Helvetica
 815   HN  = Helvetica Narrow
 816   N   = New Century Schoolbook
 817   P   = Palatino
 818   T   = Times Roman
 819   ZCM = Zapf Chancery
 820 </span>
 821 The argument you pass to FAMILY is the identifier at left, above.
 822 For example, if you want Helvetica, enter
 823 <br/>
 824 <span class="pre-in-pp">
 825   .FAMILY H
 826 </span>
 827 </p>
 828
 829 <div class="box-tip" style="margin-top: -1em;">
 830 <p class="tip-top">
 831 <span class="note">Note:</span> The font macro
 832 (<a href="#font">FT</a>)
 833 lets you specify both the type family and the desired font with
 834 a single macro.  While this saves a few keystrokes, I recommend
 835 using FAMILY for family, and FT for font, except where doing
 836 so is genuinely inconvenient. <kbd>ZCM</kbd>, for example,
 837 only exists in one style: Italic (<kbd>I</kbd>).  Therefore,
 838 <kbd>.FT&nbsp;ZCMI</kbd> makes more sense than setting the family to
 839 <kbd>ZCM</kbd>, then setting the font to <kbd>I</kbd>.
 840 </p>
 841
 842 <p id="fam-add-note" class="tip-bottom">
 843 <span class="additional-note">Additional note:</span>
 844 If you are running a version of groff lower than 1.19.2, you must
 845 follow all FAMILY requests with a FT request, otherwise mom will set
 846 all type up to the next FT request in the
 847 <a href="#fallback-font">fallback font</a>.
 848 </p>
 849 </div>
 850
 851 <p style="margin-top: -.5em;">
 852 If you are running a version of groff greater than or
 853 equal to 1.19.2, when you invoke the FAMILY macro, mom
 854 &#8220;remembers&#8221; the font style (Roman, Italic, etc)
 855 currently in use (if the font style exists in the new family) and
 856 will continue to use the same font style in the new family.  For
 857 example:
 858 <br/>
 859 <span class="pre-in-pp">
 860   .FAMILY BM   \" Bookman family
 861   .FT     I    \" Medium Italic
 862   &lt;some text&gt;  \" Bookman Medium Italic
 863   .FAMILY H    \" Helvetica family
 864   &lt;more text&gt;  \" Helvetica Medium Italic
 865 </span>
 866 However, if the font style does not exist in the new family, mom
 867 will set all subsequent type in the
 868 <a href="#fallback-font">fallback font</a>
 869 (by default, Courier Medium Roman) until she encounters a
 870 <a href="#font">.FT</a>
 871 request that&#8217;s valid for the family.  For example, assuming
 872 you don&#8217;t have the font &#8220;Medium Condensed Roman&#8221;
 873 (mom extension &#8220;CD&#8221;) in the Helvetica family:
 874 <br/>
 875 <span class="pre-in-pp">
 876   .FAMILY UN    \" Univers family
 877   .FT     CD    \" Medium Condensed
 878   &lt;some text&gt;   \" Univers Medium Condensed
 879   .FAMILY H     \" Helvetica family
 880   &lt;more text&gt;   \" Courier Medium Roman!
 881 </span>
 882 In the above example, you must follow
 883 <kbd>.FAMILY&nbsp;H</kbd> with a FT request
 884 that&#8217;s valid for Helvetica.
 885 </p>
 886
 887 <p>
 888 Please see the Appendices,
 889 <a href="appendices.html#fonts">Adding fonts to groff</a>,
 890 for information on adding fonts and families to groff, as well as
 891 to see a list of the extensions mom provides to groff&#8217;s basic
 892 <b>R</b>, <b>I</b>, <b>B</b>, <b>BI</b> styles.
 893 </p>
 894
 895 <div class="box-tip">
 896 <p class="tip">
 897 <span class="tip">Suggestion:</span> When adding
 898 families to groff, I recommend following the established standard
 899 for the naming families and fonts.  For example, if you add the
 900 Garamond family, name the font files
 901 <br/>
 902 <span class="pre-in-pp">
 903   GARAMONDR
 904   GARAMONDI
 905   GARAMONDB
 906   GARAMONDBI
 907 </span>
 908 GARAMOND then becomes a valid family name you can pass to FAMILY.
 909 (You could, of course, shorten GARAMOND to just G, or GD.) <b>R</b>,
 910 <b>I</b>, <b>B</b>, and <b>BI</b> after GARAMOND are the roman,
 911 italic, bold and bold-italic fonts respectively.
 912 </p>
 913 </div>
 914
 915 <!-- -FT- -->
 916
 917 <div class="macro-id-overline">
 918 <h3 id="font" class="macro-id">FT</h3>
 919 </div>
 920
 921 <div class="box-macro-args">
 922 Macro: <b>FT</b> <kbd class="macro-args">R | I | B | BI | &lt;any other valid font style&gt;</kbd>
 923 </div>
 924 <p class="alias">
 925 <i>Alias:</i> <b>FONT</b>
 926 </p>
 927
 928 <p>
 929 By default, groff permits FT to take one of four possible arguments
 930 specifying the desired font:
 931 <br/>
 932 <span class="pre-in-pp">
 933   R  = (Medium) Roman
 934   I  = (Medium) Italic
 935   B  = Bold (Roman)
 936   BI = Bold Italic
 937 </span>
 938 For example, if your
 939 <a href="definitions.html#family">family</a>
 940 is Helvetica, entering
 941 <br/>
 942 <span class="pre-in-pp">
 943   .FT B
 944 </span>
 945 will give you the Helvetica bold
 946 <a href="definitions.html#font">font</a>.
 947 If your family were Palatino, you&#8217;d get the Palatino bold
 948 font.
 949 </p>
 950
 951 <p>
 952 Mom considerably extends the range of arguments you can pass to FT,
 953 making it more convenient to add and access fonts of differing
 954 <a href="definitions.html#weight">weights</a>
 955 and
 956 <a href="definitions.html#shape">shapes</a>
 957 within the same family.  Have a look
 958 <a href="appendices.html#style-extensions">here</a>
 959 for a list of the weight/style arguments mom allows.  Be aware,
 960 though, that you must have the fonts, correctly installed and named,
 961 in order to use the arguments.  (See
 962 <a href="appendices.html#fonts">Adding fonts to groff</a>
 963 for instructions and information.)  Please also read the
 964 <a href="#fam-add-note">ADDITIONAL NOTE</a>
 965 found in the description of the FAMILY macro.
 966 </p>
 967
 968 <p>
 969 How mom reacts to an invalid argument to FT depends on which version
 970 of groff you&#8217;re using.  If your groff version is greater than
 971 or equal to 1.19.2, mom will issue a warning and, depending on how
 972 you&#8217;ve set up the
 973 <a href="#fallback-font">fallback font</a>,
 974 either continue processing using the fallback font, or abort
 975 (allowing you to correct the problem).  If your groff version is
 976 less than 1.19.2, mom will silently continue processing, using
 977 either the fallback font or the font that was in effect prior to the
 978 invalid FT call.
 979 </p>
 980
 981 <p>
 982 FT will also accept, as an argument, a full family+font name.  For
 983 example,
 984 <br/>
 985 <span class="pre-in-pp">
 986   .FT HB
 987 </span>
 988 will set subsequent type in Helvetica Bold.  However, I strongly
 989 recommend keeping family and font separate except where doing so is
 990 genuinely inconvenient.
 991 </p>
 992
 993 <p>
 994 For inline control of fonts, see
 995 <a href="inlines.html#inline-fonts-mom">Inline Escapes, font control</a>.
 996 </p>
 997
 998
 999 <!-- -FALLBACK_FONT- -->
1000
1001 <div class="macro-id-overline">
1002 <h3 id="fallback-font" class="macro-id">Fallback font</h3>
1003 </div>
1004
1005 <div class="box-macro-args">
1006 Macro: <b>FALLBACK_FONT</b> <kbd class="macro-args">&lt;fallback font&gt; [ ABORT | WARN ]</kbd>
1007 </div>
1008
1009 <p>
1010 In the event that you pass an invalid argument to
1011 <a href="#font">.FAMILY</a>
1012 (ie a non-existent family), mom, by default, uses the fallback
1013 font, Courier Medium Roman (CR), in order to continue processing
1014 your file.
1015 </p>
1016
1017 <p>
1018 If you&#8217;d prefer another fallback font, pass FALLBACK_FONT the
1019 full family+font name of the font you&#8217;d like.  For example, if
1020 you&#8217;d rather the fallback font were Times Roman Medium Roman,
1021 <br/>
1022 <span class="pre-in-pp">
1023   .FALLBACK_FONT TR
1024 </span>
1025 would do the trick.
1026 </p>
1027
1028 <p>
1029 Mom issues a warning whenever a font style set with
1030 <a href="#font">FT</a>
1031 does not exist, either because you haven&#8217;t registered the
1032 style (see
1033 <a href="appendices.html#register-style">here</a>
1034 for instructions on registering styles), or because the font style
1035 does not exist in the current family set with
1036 <a href="#family">FAMILY</a>.
1037 By default, mom then aborts, which allows you to correct the
1038 problem.
1039 </p>
1040
1041 <p>
1042 If you&#8217;d prefer that mom not abort on non-existent fonts,
1043 but rather continue processing using a fallback font, you can pass
1044 FALLBACK_FONT the argument <kbd>WARN</kbd>, either by itself, or in
1045 conjunction with your chosen fallback font.
1046 </p>
1047
1048 <p>
1049 Some examples of invoking FALLBACK_FONT:
1050 </p>
1051
1052 <ul class="no-enumerator" style="margin-left: -1em;">
1053 <li style="margin-top: -.5em;">
1054 <kbd>.FALLBACK_FONT WARN</kbd>
1055 <br/>
1056 mom will issue a warning whenever you try to access a non-existent
1057 font but will continue processing your file with the default
1058 fallback font, Courier Medium Roman.
1059 <br/>
1060 </li>
1061 <li style="margin-top: .5em;">
1062 <kbd>.FALLBACK_FONT TR WARN</kbd>
1063 <br/>
1064 mom will issue a warning whenever you try to access a non-existent
1065 font but will continue processing your file with a fallback font of
1066 Times Roman Medium Roman; additionally, &#8220;TR&#8221; will be
1067 the fallback font whenever you try to access a family that does not
1068 exist.
1069 </li>
1070 <li style="margin-top: .5em;">
1071 <kbd>.FALLBACK_FONT TR ABORT</kbd>
1072 <br/>
1073 mom will abort whenever you try to access a non-existent font, and
1074 will use the fallback font &#8220;TR&#8221; whenever you try to
1075 access a family that does not exist.
1076 </li>
1077 </ul>
1078
1079 <p>
1080 If, for some reason, you want to revert to ABORT, just enter
1081 <kbd>.FALLBACK_FONT&nbsp;ABORT</kbd> and mom will once again abort
1082 on font errors.
1083 </p>
1084
1085 <!-- -PT_SIZE- -->
1086
1087 <div class="macro-id-overline">
1088 <h3 id="ps" class="macro-id">Point size of type</h3>
1089 </div>
1090
1091 <div class="box-macro-args">
1092 Macro: <b>PT_SIZE</b> <kbd class="macro-args">&lt;size of type in points&gt;</kbd>
1093 </div>
1094 <p class="requires">
1095 &bull;&nbsp;Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>
1096 </p>
1097
1098 <p>
1099 PT_SIZE (Point Size) takes one argument: the size of type in points.
1100 Unlike most other macros that establish the size or measure of
1101 something, PT_SIZE does not require that you supply a unit of
1102 measure since it&#8217;s a near universal convention that type size
1103 is measured in points.  Therefore, to change the type size to, say,
1104 11 points, enter
1105 <br/>
1106 <span class="pre-in-pp">
1107   .PT_SIZE 11
1108 </span>
1109 Point sizes may be fractional (e.g., 10.25 or 12.5).
1110 </p>
1111
1112 <p>
1113 If you invoke PT_SIZE without an argument, it reverts to its former
1114 value.  For example, if your point size is 10 and you change it to
1115 12 with <kbd>.PT_SIZE&nbsp;12</kbd>, entering <kbd>.PT_SIZE</kbd>
1116 (i.e. without an argument) resets the point size to 10.
1117 </p>
1118
1119 <p>
1120 You can prepend a plus or a minus sign to the argument to PT_SIZE,
1121 in which case the point size will be changed by + or - the original
1122 value.  For example, if the point size is 12, and you want 14, you
1123 can do
1124 <br/>
1125 <span class="pre-in-pp">
1126   .PT_SIZE +2
1127 </span>
1128 then later reset it to 12 with
1129 <span class="pre-in-pp">
1130   .PT_SIZE -2
1131 </span>
1132 or, more simply, just
1133 <span class="pre-in-pp">
1134   .PT_SIZE
1135 </span>
1136 The size of type can also be changed inline.  See
1137 <a href="inlines.html#inline-size-mom">Inline Escapes, changing point size</a>.
1138 </p>
1139
1140 <div class="box-tip">
1141 <p class="tip">
1142 <span class="note">Note:</span> It is unfortunate that the
1143 <kbd>pic</kbd> preprocessor has already taken the name,
1144 <kbd>PS</kbd>, and thus mom&#8217;s macro for setting point
1145 sizes can&#8217;t use it.  However, if you aren&#8217;t using
1146 <kbd>pic</kbd>, you might want to
1147 <a href="goodies.html#alias">alias</a>
1148 PT_SIZE as PS, since there&#8217;d be no conflict.  For example
1149 <br/>
1150 <span class="pre-in-pp">
1151   .ALIAS PS PT_SIZE
1152 </span>
1153 would allow you to set point sizes with <kbd>.PS</kbd>.
1154 </p>
1155 </div>
1156
1157 <!-- -LS- -->
1158
1159 <div class="macro-id-overline">
1160 <h3 id="leading" class="macro-id">Line spacing/leading</h3>
1161 </div>
1162
1163 <div class="box-macro-args">
1164 Macro: <b>LS</b> <kbd class="macro-args">&lt;distance between lines&gt;</kbd>
1165 </div>
1166 <p class="requires">
1167 &bull;&nbsp;Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>
1168 </p>
1169
1170 <p>
1171 LS (Line Space) takes one argument: the distance you want, typically
1172 in points, from baseline to baseline of type.  The argument may be
1173 fractional (e.g., 12.25 or 14.5).  Like PT_SIZE, LS does not require
1174 a unit of measure, since
1175 <a href="definitions.html#leading">leading</a>
1176 is most often given in points.  Therefore, to set the linespace to
1177 14 points, you would enter
1178 <br/>
1179 <span class="pre-in-pp">
1180   .LS 14
1181 </span>
1182 However, if you wish, you may specify a unit of measure by appending
1183 it directly to the argument passed to LS.  For example, if you want
1184 a linespace of 1/4 of an inch, enter
1185 <br/>
1186 <span class="pre-in-pp">
1187   .LS .25i
1188 </span>
1189 You can prepend a plus or a minus sign to the argument to LS, in
1190 which case the line spacing will be changed by + or - the original
1191 value.  For example, if the line spacing is 14 points, and you want
1192 17 points, you can do
1193 <br/>
1194 <span class="pre-in-pp">
1195   .LS +3
1196 </span>
1197 then later reset it to 14 points with
1198 <br/>
1199 <span class="pre-in-pp">
1200   .LS -3
1201 </span>
1202 </p>
1203
1204 <div class="box-tip">
1205 <p class="tip">
1206 <span class="experts">Experts:</span> LS should not be confused with
1207 the groff primitive <kbd>.ls</kbd>. LS acts like
1208 <kbd>.vs</kbd>. mom does not provide a macro analogous to
1209 <kbd>.ls</kbd>.
1210 </p>
1211 </div>
1212
1213 <!-- -AUTOLEAD- -->
1214
1215 <div class="macro-id-overline">
1216 <h3 id="autolead" class="macro-id">Automatic line spacing</h3>
1217 </div>
1218
1219 <div class="box-macro-args">
1220 Macro: <b>AUTOLEAD</b> <kbd class="macro-args">&lt;amount of automatic leading&gt; [FACTOR]</kbd>
1221 </div>
1222 <p class="requires">
1223 &bull;&nbsp;Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>
1224 <br/>
1225 (Please see
1226 <a href="docprocessing.html#autolead">here</a>
1227 for information on using
1228 <span style="font-style: normal">AUTOLEAD</span> during document
1229 processing.)
1230 </p>
1231
1232 <p>
1233 Without the <kbd>FACTOR</kbd> argument, AUTOLEAD calculates the
1234 linespace for you by adding its argument to the current point size
1235 of type. All subsequent
1236 <a href="#ps">PT_SIZE</a>
1237 requests automatically update the linespacing by the autolead amount.
1238 </p>
1239
1240 <p>
1241 Used in this way, AUTOLEAD does not require a unit of measure;
1242 points is assumed.  However, you may use an alternate unit of
1243 measure by appending it to the argument.  The argument may be a
1244 decimal fraction (e.g., .5 or 2.75).
1245 </p>
1246
1247 <p>
1248 As an example, if your current point size of type is 12, entering
1249 <br/>
1250 <span class="pre-in-pp">
1251   .AUTOLEAD 2
1252 </span>
1253 changes the linespace to 14 points, regardless any linespacing
1254 already in effect.  From here on, every change to the size of type
1255 (with PT_SIZE, not
1256 <a href="definitions.html#inlines">inline</a>)
1257 changes the linespace as well.  If you decrease the type size to 9
1258 points, the leading decreases to 11 points.  If you increase the
1259 type size to 16 points, the leading increases to 18 points.
1260 </p>
1261
1262 <p>
1263 Automatic updating of the linespacing continues until you enter a
1264 &#8220;manual&#8221; line space value with
1265 <a href="#leading">LS</a>.
1266 </p>
1267
1268 <div class="box-tip">
1269 <p class="tip">
1270 <span class="experts">Experts:</span> Please note that the groff
1271 <a href="definitions.html#primitives">primitives</a>,
1272 <kbd>.vs</kbd> and <kbd>.ps</kbd>, are unaffected by, and have no
1273 effect, on AUTOLEAD.
1274 </p>
1275 </div>
1276
1277 <p>
1278 If you give AUTOLEAD the optional FACTOR argument, AUTOLEAD
1279 calculates the line space as a factor of the
1280 <a href="definitions.html#numericargument">numeric argument</a>
1281 you gave AUTOLEAD.  For example, if your point size is 12,
1282 <br/>
1283 <span class="pre-in-pp">
1284   .AUTOLEAD 1.125 FACTOR
1285 </span>
1286 sets the leading at 13.5 points.  If you change the point size to
1287 14, the leading automatically changes to 15.75 (14 x 1.125).
1288 </p>
1289
1290 <div class="box-tip">
1291 <p class="tip">
1292 <span class="note">Note:</span> There&#8217;s no need to prepend a
1293 plus sign
1294 (<kbd>+</kbd>)
1295 to AUTOLEAD&#8217;s argument, although you may do so if you wish.
1296 </p>
1297 </div>
1298
1299 <!-- -LL- -->
1300
1301 <div class="macro-id-overline">
1302 <h3 id="linelength" class="macro-id">Line length</h3>
1303 </div>
1304
1305 <div class="box-macro-args">
1306 Macro: <b>LL</b> <kbd class="macro-args">&lt;line length&gt;</kbd>
1307 </div>
1308 <p class="requires">
1309 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
1310 </p>
1311
1312 <p>
1313 LL (Line Length) takes one argument: the distance from the left
1314 margin of the page to the maximum allowable point on the right at
1315 which groff should place type.  The line length, in other words, as
1316 the macro suggests.
1317 </p>
1318
1319 <p>
1320 LL requires a unit of measure.  Therefore, to set the line length to
1321 39 picas, you would enter
1322 <br/>
1323 <span class="pre-in-pp">
1324   .LL 39P
1325 </span>
1326 As with other macros that require a unit of measure, the argument to
1327 LL may be fractional.  For example,
1328 <br/>
1329 <span class="pre-in-pp">
1330   .LL 4.5i
1331 </span>
1332 sets the line length to 4-1/2 inches.
1333 </p>
1334
1335 <p>
1336 Additionally, you may express a new line length relative to the
1337 current line length by prepending a plus or minus sign to the
1338 argument.  Thus, if you wanted to increase the line length by 3
1339 <a href="definitions.html#picaspoints">points</a>, you could
1340 do
1341 <br/>
1342 <span class="pre-in-pp">
1343   .LL +3p
1344 </span>
1345 This is especially handy when you want to &#8220;hang&#8221;
1346 punctuation outside the right margin since you can pass
1347 groff&#8217;s
1348 <a href="inlines.html#inline-stringwidth-groff"><kbd>\w</kbd></a>
1349 escape as the argument to LL, like this:
1350 <br/>
1351 <span class="pre-in-pp">
1352   .LL +\w'.'u
1353 </span>
1354 The above example increases the current line length by the width of
1355 a period.  Notice that you must append the
1356 <a href="definitions.html#unitofmeasure">unit of measure</a>,
1357 <b>u</b>, to the escape since LL requires a unit of measure.
1358 </p>
1359
1360 <div class="box-tip">
1361 <p class="tip">
1362 <span class="note">Note:</span> The right margin macro
1363 <a href="#r-margin">(R_MARGIN)</a>
1364 can also be used to set line length.
1365 </p>
1366 </div>
1367
1368 <div class="rule-short"><hr/></div>
1369
1370 <!-- ==================================================================== -->
1371
1372 <h2 id="justification-intro" class="macro-group">Justification and quadding/breaking and joining lines</h2>
1373
1374 <p>
1375 The justification and quadding macros deal with how type aligns
1376 along the left and right margins.  In a nutshell, type either aligns
1377 at the left margin, at the right margin, at both margins, or at
1378 neither margin (centred).
1379 </p>
1380
1381 <p>
1382 These macros also determine whether or not
1383 <a href="definitions.html#inputline">input lines</a>
1384 are joined and
1385 <a href="definitions.html#filled">filled</a>
1386 during output.
1387 </p>
1388
1389 <p>
1390 Additionally, macros that deal with how to break
1391 <a href="definitions.html#outputline">output lines</a>
1392 are covered in this section, as is the
1393 <a href="definitions.html#inlines">inline escape</a>
1394 for joining input lines.
1395 </p>
1396
1397 <p>
1398 You may encounter some words here that are unfamiliar.  Refer to
1399 <a href="definitions.html#typesetting">Typesetting terms</a>
1400 and
1401 <a href="definitions.html#groff">Groff terms</a>
1402 for an explanation.
1403 </p>
1404
1405 <div id="index-justification" class="macro-list-container">
1406 <h3 class="macro-list">Justification and quadding/breaking and joining lines macros</h3>
1407 <ul class="macro-list">
1408   <li>Fill modes
1409   <ul style="list-style-type: none; margin-left: -1em;">
1410     <li><a href="#justify">JUSTIFY</a> &ndash; set lines justified</li>
1411     <li><a href="#quad">QUAD</a> &ndash; set filled lines flush left, right or centred</li>
1412   </ul></li>
1413   <li>Nofill modes
1414   <ul style="list-style-type: none; margin-left: -1em;">
1415     <li><a href="#lrc">LEFT</a> &ndash; set non-filled lines flush left</li>
1416     <li><a href="#lrc">RIGHT</a> &ndash; set non-filled lines flush right</li>
1417     <li><a href="#lrc">CENTER</a> &ndash; set non-filled lines centred</li>
1418   </ul></li>
1419   <li>Breaking lines
1420   <ul style="list-style-type: none; margin-left: -1em;">
1421     <li><a href="#br">BR</a> &ndash; manually break an output line</li>
1422     <li><a href="#el">EL</a> &ndash; break a line without advancing to the next output line</li>
1423     <li><a href="#space">SPACE</a> &ndash; break a line and add space before the next output line</li>
1424     <li><a href="#spread">SPREAD</a> &ndash; break and force-justify an output line</li>
1425   </ul></li>
1426   <li>Joining input lines in <a href="definitions.html#filled">nofill mode</a>
1427   <ul style="list-style-type: none; margin-left: -1em;">
1428     <li><a href="#join">\c</a> inline escape</li>
1429   </ul></li>
1430 </ul>
1431 </div>
1432
1433 <!-- -JUSTIFY- -->
1434
1435 <div class="macro-id-overline">
1436 <h3 id="justify" class="macro-id">Justify lines</h3>
1437 </div>
1438
1439 <div class="box-macro-args">
1440 Macro: <b>JUSTIFY</b>
1441 </div>
1442
1443 <p class="requires">
1444 (See
1445 <a href="definitions.html#filled">fill mode</a>
1446 for a definition of the difference between &#8220;fill&#8221; and
1447 &#8220;no-fill&#8221; modes.)
1448 </p>
1449
1450 <p>
1451 JUSTIFY doesn&#8217;t take an argument.
1452 <a href="definitions.html#inputline">Input lines</a>
1453 after JUSTIFY are
1454 <a href="definitions.html#filled">filled</a>
1455 and
1456 <a href="definitions.html#just">justified</a>
1457 upon output.
1458 </p>
1459
1460 <p>
1461 To break lines and prevent them from being filled and justified, use
1462 the
1463 <a href="#br">BR</a>
1464 macro.
1465 </p>
1466
1467 <!-- -QUAD- -->
1468
1469 <div class="macro-id-overline">
1470 <h3 id="quad" class="macro-id">Quad lines left, right, or centre</h3>
1471 </div>
1472
1473 <div class="box-macro-args">
1474 Macro: <b>QUAD</b> <kbd class="macro-args">L | LEFT | R | RIGHT | C | CENTER | J | JUSTIFY</kbd>
1475 </div>
1476
1477 <p class="alias" style="margin-bottom: 0;">
1478 <i>Alias:</i> <b>FILL</b>
1479 </p>
1480
1481 <p class="requires">(See
1482 <a href="definitions.html#filled">fill mode</a>
1483 for a definition of the difference between &#8220;fill&#8221; and
1484 &#8220;no-fill&#8221; modes.)
1485 </p>
1486
1487 <p>
1488 QUAD takes one argument: the direction in which lines should be
1489 <a href="definitions.html#quad">quadded</a>.
1490 <a href="definitions.html#inputline">Input lines</a>
1491 after QUAD are
1492 <a href="definitions.html#filled">filled</a>
1493 upon output.
1494 </p>
1495
1496 <p>
1497 If <kbd>L</kbd> or <kbd>LEFT</kbd>, type is set flush along the left
1498 margin.
1499 </p>
1500
1501 <p>
1502 If <kbd>R</kbd> or <kbd>RIGHT</kbd>, type is set flush along the
1503 right margin.
1504 </p>
1505
1506 <p>
1507 If <kbd>C</kbd> or <kbd>CENTER</kbd> type is set centred on the
1508 current line length.
1509 </p>
1510
1511 <p>
1512 <kbd>J</kbd> and <kbd>JUSTIFY</kbd> justify text, and are
1513 included as a convenience only.  Obviously, if text is
1514 justified, it isn&#8217;t quadded. <kbd>.QUAD&nbsp;J</kbd> and
1515 <kbd>.QUAD&nbsp;JUSTIFY</kbd> have exactly the same effect as
1516 <a href="#justify">JUSTIFY</a>.
1517 </p>
1518
1519 <p>
1520 To break lines and prevent them from being filled, use the
1521 <a href="#br">BR</a>
1522 macro.
1523 </p>
1524
1525 <!-- -LEFT, RIGHT, CENTER- -->
1526
1527 <div class="macro-id-overline">
1528 <h3 id="lrc" class="macro-id">Set lines flush left, right or centered in no-fill mode</h3>
1529 </div>
1530
1531 <div class="box-macro-args">
1532 Macro: <b>LEFT</b>
1533 <br/>
1534 Macro: <b>RIGHT</b>
1535 <br/>
1536 Macro: <b>CENTER</b> &nbsp;(alias CENTRE)
1537 </div>
1538
1539 <p class="requires">
1540 (See
1541 <a href="definitions.html#filled">no-fill mode</a>
1542 for a definition of the difference between &#8220;fill&#8221; and
1543 &#8220;no-fill&#8221; modes.)
1544 </p>
1545
1546 <p>
1547 LEFT, RIGHT and CENTER let you enter text on a line for line basis
1548 without having to use the
1549 <a href="#br">BR</a>
1550 macro after each line.  Consider the following:
1551 <br/>
1552 <span class="pre-in-pp">
1553   .QUAD LEFT
1554   So runs my dream, but what am I?
1555   .BR
1556   An infant crying in the night
1557   .BR
1558   An infant crying for the light
1559   .BR
1560   And with no language but a cry.
1561   .BR
1562 </span>
1563 Because text after <kbd>.QUAD LEFT</kbd> is
1564 <a href="definitions.html#filled">filled</a>,
1565 you have to use the
1566 <a href="#br">BR</a>
1567 macro to prevent the lines from running together.  Not only is this
1568 annoying to type, it&#8217;s awkward to read in a text editor.  Much
1569 better to do
1570 <br/>
1571 <span class="pre-in-pp">
1572   .LEFT
1573   So runs my dream, but what am I?
1574   An infant crying in the night
1575   An infant crying for the light
1576   And with no language but a cry.
1577 </span>
1578 </p>
1579
1580 <div class="box-important" style="margin-top: -.5em;">
1581 <p class="tip">
1582 <span class="important">IMPORTANT:</span> Because LEFT,
1583 RIGHT and CENTER are nofill modes, groff does not always respect the
1584 current line length.
1585 <a href="definitions.html#inputline">Input lines</a>
1586 that run long may exceed it, or get broken in undesirable ways.
1587 Therefore, when using these three macros, you should preview your
1588 work to ensure that all lines fit as expected.
1589 </p>
1590 </div>
1591
1592 <!-- -BR- -->
1593
1594 <div class="macro-id-overline">
1595 <h3 id="br" class="macro-id">Manually break lines</h3>
1596 </div>
1597
1598 <div class="box-macro-args">
1599 Macro: <b>BR</b>
1600 </div>
1601
1602 <p>
1603 When using
1604 <a href="#justify">JUSTIFY</a>
1605 or
1606 <a href="#quad">QUAD</a>,
1607 BR tells mom about partial lines that you want broken (as opposed to
1608 <a href="definitions.html#filled">filled</a>).
1609 Any partial
1610 <a href="definitions.html#outputline">output line</a>
1611 that immediately precedes BR will be
1612 <a href="definitions.html#quad">quadded</a>
1613 in the direction of the current quad, or set flush left if text is
1614 <a href="definitions.html#just">justified</a>.
1615 </p>
1616
1617 <p>
1618 Most of the time, you won&#8217;t need the BR macro.  In fill modes,
1619 mom tries to be sensible about where breaks are needed.  If the
1620 nature of a macro is such that under most circumstances you&#8217;d
1621 expect a break, mom puts it in herself.  Equally, in macros where a
1622 break isn&#8217;t normally desirable, no break occurs.  This means
1623 text files don&#8217;t get cluttered with annoying BR&#8217;s.
1624 </p>
1625
1626 <div class="box-tip">
1627 <p class="tip-top">
1628 <span class="note">Note:</span> Lines of text in
1629 <a href="definitions.html#filled">nofill mode</a>
1630 never require a BR.  Furthermore, in nofill mode, ALL macros cause a
1631 break.  If a break is not desired, use the
1632 <a href="#join"><kbd>\c</kbd></a>
1633 <a href="definitions.html#inlines">inline escape</a>.
1634 </p>
1635
1636 <p class="tip-bottom" style="margin-top: -1em">
1637 <span class="experts">Experts:</span> BR is an alias for
1638 <kbd>.br</kbd>.  You can use either, or mix
1639 &#8217;n&#8217; match with impunity.
1640 </p>
1641 </div>
1642
1643 <!-- -EL- -->
1644
1645 <div class="macro-id-overline">
1646 <h3 id="el" class="macro-id">Manually break a line without advancing on the page</h3>
1647 </div>
1648
1649 <div class="box-macro-args">
1650 Macro: <b>EL</b>
1651 </div>
1652
1653 <p class="requires">
1654 In nofill modes
1655 <span style="font-style: normal;">
1656 (<a href="#left">LEFT</a>,
1657 <a href="#right">RIGHT</a>,
1658 <a href="#center">CENTER</a>)
1659 </span>
1660 you must terminate the line input preceding
1661 <span style="font-style: normal;">EL</span>
1662 with the
1663 <span style="font-style: normal;">
1664 <kbd>\c</kbd> inline escape.
1665 </span>
1666 </p>
1667
1668 <p style="margin-top: -.5em">
1669 <i><b>Suggestion:</b> If you find remembering whether to put in the</i>
1670 <kbd>\c</kbd>
1671 <i>bothersome, you may prefer to use the</i>
1672 <a href="definitions.html#inlines">inline escape</a>
1673 <i>alternative to</i> EL,
1674 <a href="inlines.html#b"><kbd>\*[B]</kbd></a>,
1675 <i>which works consistently regardless of the fill mode.
1676 </i>EL <i>does not work after the</i>
1677 <a href="goodies.html#pad">PAD</a>
1678 <i>macro.  See</i>
1679 <a href="goodies.html#nobreak"><kbd>.PAD&nbsp;NOBREAK</kbd></a>
1680 <i>for the way around this.</i>
1681 </p>
1682
1683 <p id="el-example">
1684 EL ("<span style="text-decoration: underline;">E</span>nd <span style="text-decoration: underline;">L</span>ine")
1685 is conceptually equivalent to the notion of a carriage return with
1686 no linefeed.  Its function is simple: it breaks a line without
1687 advancing on the page.  As an example of where you might use it,
1688 imagine that you&#8217;re working from marked-up copy.  The markup
1689 indicates 24 points of space between two given lines, but the
1690 prevailing line spacing is 12.5 points.  You may find it more
1691 convenient to break the first line with EL and instruct mom to
1692 advance 24 points to the next line instead of calculating the lead
1693 that needs to be added to 12.5 to get 24.  To demonstrate:
1694 <br/>
1695 <span class="pre-in-pp">
1696   .LEFT
1697   .LS 12.5
1698   A line of text.\c
1699   .EL
1700   .ALD 24p
1701   The next line of text.
1702 </span>
1703 may be more intuitive than
1704 <br/>
1705 <span class="pre-in-pp">
1706   .LEFT
1707   .LS 12.5
1708   A line of text.
1709   .ALD 11.5p
1710   The next line of text.
1711 </span>
1712 The first example has the further advantage that should you wish to
1713 change the prevailing line space but keep the 24 points lead, you
1714 don&#8217;t have to recalculate the extra space.
1715 </p>
1716
1717 <p>
1718 ALD in the above examples stands for
1719 &#8220;<span style="text-decoration: underline;">A</span>dvance
1720 <span style="text-decoration: underline;">L</span>ea<span style="text-decoration: underline;">D</span>&#8221;,
1721 which is covered in the section
1722 <a href="#aldrld-intro">Vertical movements</a>.
1723 </p>
1724
1725 <!-- -SP- -->
1726
1727 <div class="macro-id-overline">
1728 <h3 id="space" class="macro-id">Break lines and add space between</h3>
1729 </div>
1730
1731 <div class="box-macro-args">
1732 Macro: <b>SPACE</b> <kbd class="macro-args">&lt;space to add between lines&gt;</kbd>
1733 </div>
1734 <p class="alias">
1735 <i>Alias:</i> <b>SP</b>
1736 </p>
1737
1738 <p>
1739 SPACE breaks a line, just like
1740 <a href="#br">BR</a>,
1741 then adds space after the line.  With no argument, it adds an extra
1742 line space of a value equal to the current
1743 <a href="definitions.html#leading">leading</a>.
1744 If you pass it a numeric argument without supplying a
1745 <a href="definitions.html#unitofmeasure">unit of measure</a>,
1746 it advances that number of extra line spaces.  For example:
1747 <br/>
1748 <span class="pre-in-pp">
1749   .SPACE
1750 </span>
1751 breaks the line then adds an extra linespace, whereas
1752 <br/>
1753 <span class="pre-in-pp">
1754   .SPACE 2
1755 </span>
1756 breaks the line and adds two extra linespaces.
1757 </p>
1758
1759 <p>
1760 If you supply a unit of measure, SPACE breaks the line then advances
1761 one linespace (at the current
1762 <a href="definitions.html#leading">leading</a>)
1763 PLUS the specified amount of extra space given to SPACE, as in
1764 <br/>
1765 <span class="pre-in-pp">
1766   .SPACE 6p
1767 </span>
1768 which breaks the line and advances one full linespace plus six
1769 points.
1770 </p>
1771
1772 <div class="box-tip">
1773 <p class="tip-top">
1774 <span class="tip">Tip:</span> SPACE and
1775 <a href="#ald">ALD</a>
1776 can be used interchangeably (<kbd>.SPACE&nbsp;6p</kbd> and
1777 <kbd>.ALD&nbsp;6p</kbd> are equivalent).  However, ALD without an
1778 argument does nothing, whereas SPACE without an argument adds an
1779 extra line space.  I recommend using SPACE when you want an extra
1780 line space (or multiple thereof), and ALD whenever you want some
1781 other value of space after a line.
1782 </p>
1783
1784 <p class="tip-bottom">
1785 <span class="experts">Experts:</span> SPACE is an alias of
1786 <kbd>.sp</kbd>.  You can use either, or mix &#8217;n&#8217; match
1787 with impunity.
1788 </p>
1789 </div>
1790
1791 <!-- -SPREAD- -->
1792
1793 <div class="macro-id-overline">
1794 <h3 id="spread" class="macro-id">Break and force justify (spread) lines</h3>
1795 </div>
1796
1797 <div class="box-macro-args">
1798 Macro: <b>SPREAD</b>
1799 </div>
1800
1801 <p>
1802 Sometimes, you need to break a line of
1803 <a href="definitions.html#just">justified</a>
1804 text and have it come out fully justified, not
1805 <a href="definitions.html#quad">quadded</a>
1806 left the way it would be with the
1807 <a href="#br">BR</a>
1808 macro.  An example of where you&#8217;d do this would be when you
1809 want to prevent a word at the end of a line from being hyphenated
1810 (say, a proper name). SPREAD is the macro that lets you break the
1811 line and have it came out fully justified.
1812 </p>
1813
1814 <div class="box-tip">
1815 <p class="tip">
1816 <span class="experts">Experts:</span> SPREAD is an alias for
1817 <kbd>.brp</kbd> You can use either, or mix &#8217;n&#8217; match
1818 with impunity.
1819 </p>
1820 </div>
1821
1822 <!-- -JOIN- -->
1823
1824 <div class="macro-id-overline">
1825 <h3 id="join" class="macro-id">Join input lines</h3>
1826 </div>
1827
1828 <div class="box-macro-args">
1829 Inline: <kbd class="macro-args">\c</kbd>
1830 </div>
1831
1832 <p>
1833 Sometimes, especially when in one of the
1834 <a href="definitions.html#filled">nofill modes</a>,
1835 a macro will cause a break where you don&#8217;t want one.  In order
1836 to prevent this from happening (in other words, to join
1837 <a href="definitions.html#inputline">input lines</a>
1838 together, forming one
1839 <a href="definitions.html#outputline">output line</a>),
1840 use the groff
1841 <a href="definitions.html#inlines">inline escape</a>
1842 <kbd>\c</kbd> at the end of each input line to be
1843 joined to another, like this:
1844 <br/>
1845 <span class="pre-in-pp">
1846   .LEFT
1847   .FAMILY T
1848   .FT R
1849   Some lines of text to be \c
1850   .FAMILY H
1851   .FT B
1852   joined \c
1853   .FAMILY T
1854   .FT R
1855   together.
1856 </span>
1857 Upon output, the lines will be joined together to read
1858 <br/>
1859 <span class="pre-in-pp">
1860   Some lines of text to be joined together.
1861 </span>
1862 with the word &#8220;joined&#8221; in Helvetica bold.  Note the
1863 spaces before <kbd>\c</kbd>.  Without them, the last three words of
1864 the output line would read
1865 <br/>
1866 <span class="pre-in-pp">
1867   bejoinedtogether
1868 </span>
1869 Please also note that had the example been in one of the
1870 <a href="definitions.html#filled">fill modes</a>,
1871 there&#8217;d have been no need for the <kbd>\c</kbd>.
1872 </p>
1873
1874 <div class="box-tip">
1875 <p class="tip">
1876 <b>Addendum:</b> The example, above, is designed to demonstrate the
1877 use of <kbd>\c</kbd>.  An easier and more intuitive way
1878 to accomplish the family/font change in the example would be with
1879 the groff
1880 <a href="definitions.html#inlines">inline escape</a>,
1881 <kbd><a href="inlines.html#inline-fonts-groff">\f</a></kbd>,
1882 like this:
1883 <br/>
1884 <span class="pre-in-pp" style="padding-bottom: 0px;">
1885   Some lines of text to be \f[HB]joined\*[PREV] together.
1886 </span>
1887 </p>
1888 </div>
1889
1890 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
1891
1892 <!-- ==================================================================== -->
1893
1894 <h2 id="refinements-intro" class="macro-group">Typographic refinements</h2>
1895
1896 <p>
1897 The macros in this section help you tweak groff&#8217;s behaviour,
1898 ensuring that your documents look typographically professional.
1899 </p>
1900
1901 <div id="index-refinements" class="macro-list-container">
1902 <h3 class="macro-list">Typographic refinements macros</h3>
1903
1904 <ul class="macro-list">
1905   <li>Word and sentence spacing
1906   <ul style="list-style-type: none; margin-left: -1em;">
1907     <li><a href="#ws">WS</a> &ndash; word spacing</li>
1908     <li><a href="#ss">SS</a> &ndash; sentence space</li>
1909   </ul></li>
1910   <li>Letter spacing (track kerning)
1911   <ul style="list-style-type: none; margin-left: -1em;">
1912     <li><a href="#rw">RW</a> &ndash; reduce whitespace</li>
1913     <li><a href="#ew">EW</a> &ndash; expand whitespace</li>
1914     <li><a href="#br-at-line-kern">BR_AT_LINE_KERN</a></li>
1915   </ul></li>
1916   <li>Hyphenation
1917   <ul style="list-style-type: none; margin-left: -1em;">
1918     <li><a href="#hy">HY</a> &ndash; turn auto hyphenation on/off, or set specific hyphenation parameters</li>
1919     <li><a href="#hy-set">HY_SET</a> &ndash; set all hyphenation parameters</li>
1920   </ul></li>
1921   <li>Automatic kerning and ligatures
1922   <ul style="list-style-type: none; margin-left: -1em;">
1923     <li><a href="#kern">KERN</a> &ndash; turn automatic pairwise kerning on or off</li>
1924     <li><a href="#ligatures">LIGATURES</a> &ndash; turn automatic generation of ligatures on or off</li>
1925   </ul></li>
1926 </ul>
1927 </div>
1928
1929 <!-- -WS- -->
1930
1931 <div class="macro-id-overline">
1932 <h3 id="ws" class="macro-id">Word spacing</h3>
1933 </div>
1934
1935 <div class="box-macro-args">
1936 Macro: <b>WS</b> <kbd class="macro-args">&lt;+|-wordspace&gt; | DEFAULT</kbd>
1937 </div>
1938
1939 <p>
1940 WS (Word Space) increases or decreases the amount of space between
1941 words.  In
1942 <a href="definitions.html#filled">nofill modes</a>,
1943 or if
1944 <a href="#quad">QUAD</a>
1945 is in effect, the space between words is fixed.  Therefore, if you
1946 change the word spacing with WS, the change applies uniformly to the
1947 space between every word on every line.  However, when text is
1948 <a href="definitions.html#just">justified</a>,
1949 the space between words varies from line to line (in order to
1950 justify the text).  Consequently, the change you make with WS
1951 represents the minimum (and ideal) space groff will try to put
1952 between words before deciding whether to hyphenate a final word or
1953 to stretch the word spacing.
1954 </p>
1955
1956 <p>
1957 Word space is relative to point size.  Generally, in/decreasing the
1958 word space by a value of 1 or 2 produces a difference that in many
1959 cases is scarcely visible; in/decreasing by a value between 3 and 5
1960 produces a subtle but noticeable difference; and in/decreasing by a
1961 value greater than 6 is almost always apparent.  You should preview
1962 your work to assess the effect of WS.
1963 </p>
1964
1965 <p id="ws-usage">
1966 WS takes as its argument a whole number preceded by a plus or minus
1967 sign.  Therefore, to decrease the word space slightly, you might
1968 enter
1969 <br/>
1970 <span class="pre-in-pp">
1971   .WS -2
1972 </span>
1973 To increase it by a noticeable amount, you might enter
1974 <br/>
1975 <span class="pre-in-pp">
1976   .WS +6
1977 </span>
1978 You can reset the word spacing to its previous value by switching
1979 the plus or minus sign, like this:
1980 <br/>
1981 <span class="pre-in-pp">
1982   .WS +2
1983   A line of text
1984   .WS -2
1985 </span>
1986 The <kbd>.WS&nbsp;-2</kbd> undoes the effect of
1987 <kbd>.WS&nbsp;+2</kbd>.  You can also reset WS to its groff default
1988 by entering
1989 <br/>
1990 <span class="pre-in-pp">
1991   .WS DEFAULT
1992 </span>
1993 This can be particularly useful if you&#8217;ve been playing around
1994 with plus and minus values, and can&#8217;t remember by how much to
1995 in/decrease the word space to get it back to normal.
1996 </p>
1997
1998 <!-- -SS- -->
1999
2000 <div class="macro-id-overline">
2001 <h3 id="ss" class="macro-id">Sentence space</h3>
2002 </div>
2003
2004 <div class="box-macro-args">
2005 Macro: <b>SS</b> <kbd class="macro-args">&lt;+sentence space&gt; | 0 | DEFAULT</kbd>
2006 </div>
2007
2008 <p>
2009 SS (Sentence Space) tells groff how to treat double spaces it
2010 encounters between sentences in
2011 <a href="definitions.html#inputline">input lines</a>.
2012 If you use SS, input sentences with two spaces after them <i>and</i>
2013 input sentences that fall at the end of input lines all receive a
2014 normal word space plus an additional amount of space whose size is
2015 determined by the + value passed as an argument to SS.  Thus,
2016 <br/>
2017 <span class="pre-in-pp">
2018   .SS +2
2019 </span>
2020 means that input sentences with two spaces after them receive a
2021 normal word space PLUS the +2 value passed to SS.
2022 </p>
2023
2024 <p>
2025 Like
2026 <a href="#ws">WS</a>,
2027 increasing the sentence space by a value of 1 or 2 produces a
2028 difference that in many cases is scarcely visible; increasing by a
2029 value of 5 or so produces a subtle but noticeable difference (ie
2030 the space between double-spaced input sentences will be slightly but
2031 visibly greater than the space between words); and increasing by a
2032 value greater than 10 is always apparent.  You should preview your
2033 work to assess the effect of SS.
2034 </p>
2035
2036 <p>
2037 There&#8217;s an additional argument you can pass SS: the number
2038 zero (without the + sign).  It&#8217;s the argument you&#8217;ll
2039 use most often.  Typeset copy should never have two spaces between
2040 sentences, and the "zero" argument tells groff to give the extra
2041 spaces no space at all (effectively removing them).  Therefore, if
2042 you double-space your sentences (as you should when writing in a
2043 text editor), get in the habit of putting
2044 <br/>
2045 <span class="pre-in-pp">
2046   .SS 0
2047 </span>
2048 at the top of your files.
2049 </p>
2050
2051 <p>
2052 If you do use SS for something other than ensuring that you
2053 don&#8217;t get unwanted sentence spaces in output copy, you can set
2054 or reset the sentence space to the groff default (the same width
2055 as a word space, ie double-spaced input sentences will appear
2056 double-spaced on output as well) with
2057 <br/>
2058 <span class="pre-in-pp">
2059   .SS DEFAULT
2060 </span>
2061 If you&#8217;re using the
2062 <a href="docprocessing.html">document processing macros</a>
2063 and your
2064 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>
2065 is <kbd>TYPEWRITE</kbd>, <kbd>.SS&nbsp;DEFAULT</kbd> is the
2066 default, because you do want double spaces between sentences in copy
2067 that imitates the look of a typewritten document.
2068 </p>
2069
2070 <div class="box-important">
2071 <p class="tip">
2072 <span class="important">IMPORTANT:</span> SS with an argument other
2073 than <kbd>0</kbd> (zero) should only be used if you&#8217;re of
2074 the old (and wise) school of typists that puts two spaces between
2075 sentences.  If you ignore this advice and use SS when you habitually
2076 put only one space between sentences, you risk producing output
2077 where the space between sentences is not equal.
2078 </p>
2079 </div>
2080
2081 <!-- -HY- -->
2082
2083 <div class="macro-id-overline">
2084 <h3 id="hy" class="macro-id">Automatic hyphenation control</h3>
2085 </div>
2086
2087 <div class="box-macro-args">
2088 Macro: <b>HY</b> <kbd class="macro-args">LINES &lt;max. number of consecutive hyphenated lines&gt;</kbd>
2089   <br/>
2090 Macro: <b>HY</b> <kbd class="macro-args">MARGIN &lt;size of hyphenation margin&gt;</kbd>
2091   <br/>
2092 Macro: <b>HY</b> <kbd class="macro-args">SPACE &lt;extra interword spacing to prevent hyphenation&gt;</kbd>
2093   <br/>
2094 Macro: <b>HY</b> <kbd class="macro-args">DEFAULT</kbd>
2095   <br/>
2096 Macro: <b>HY</b> <kbd class="macro-args">toggle</kbd>
2097 </div>
2098 <p class="alias">
2099 <i>Aliases:</i> <b>HYPHENATE, HYPHENATION</b>
2100 </p>
2101
2102 <p>
2103 HY, as you can see, can be invoked with a number of arguments.  In
2104 all cases, the aliases HYPHENATE or HYPHENATION can be used in place
2105 of HY.  To aid in understanding the various arguments you can pass
2106 to HY, I&#8217;ve broken them down into separate sections.
2107 </p>
2108
2109 <h3 class="docs">1.&nbsp;&nbsp;HY</h3>
2110
2111 <p>
2112 HY by itself (ie with no argument) simply turns automatic
2113 hyphenation on.  Any argument other than LINES, MARGIN, SPACE or
2114 DEFAULT, turns automatic hyphenation off.  For example, as explained
2115 in
2116 <a href="intro.html#macro-args">How to read macro arguments</a>,
2117 you could turn HY off by entering
2118 <br/>
2119 <span class="pre-in-pp">
2120   .HY OFF
2121 </span>
2122 or
2123 <span class="pre-in-pp">
2124   .HY X
2125 </span>
2126 or
2127 <span class="pre-in-pp">
2128   .HY END
2129 </span>
2130 A subsequent call to HY restores hyphenation with the parameters for
2131 LINES, MARGIN, or SPACE that were formerly in effect (see below).
2132 </p>
2133
2134 <p>
2135 HY observes the following default hyphenation rules:
2136 </p>
2137 <ul style="margin-top: -.5em; margin-left: 18px;">
2138   <li>Last lines (ie ones that will spring a trap&mdash;typically
2139       the last line on a page) will not be hyphenated.
2140   </li>
2141   <li>The first and last two characters of a word are never
2142       split off.
2143   </li>
2144 </ul>
2145
2146 <h3 class="docs numbered">2.&nbsp;&nbsp;HY LINES</h3>
2147
2148 <p>
2149 HY LINES sets the maximum number of consecutive hyphenated lines
2150 that will appear in output copy.  2 is a very good choice, and
2151 you&#8217;d set it with
2152 <br/>
2153 <span class="pre-in-pp">
2154   .HY LINES 2
2155 </span>
2156 By default, when you turn automatic hyphenation on, there is no
2157 limit to the number of consecutive hyphenated lines.
2158 </p>
2159
2160 <div class="box-tip">
2161 <p class="tip">
2162 <span class="note">Note:</span>
2163 <a href="definitions.html#discretionaryhyphen">Discretionary hyphens</a>
2164 count when groff is figuring out how many lines to hyphenate;
2165 explicit hyphens (ie the actual hyphen character) do not.
2166 </p>
2167 </div>
2168
2169 <h3 class="docs numbered">3.&nbsp;&nbsp;HY MARGIN</h3>
2170
2171 <p>
2172 HY MARGIN sets the amount of room allowed at the end of a line
2173 before hyphenation is tripped (e.g., if there&#8217;s only 6 points
2174 left at the end of a line, groff won&#8217;t try to hyphenate the
2175 next word).  HY MARGIN only applies if you&#8217;re using
2176 <a href="#quad">QUAD</a>,
2177 and is really only useful if you&#8217;re using QUAD LEFT.
2178 </p>
2179
2180 <p>
2181 As an example, if you don&#8217;t want groff to hyphenate words
2182 when there&#8217;s only 18 points of space left at the end of a
2183 left-quadded line, you&#8217;d enter
2184 <br/>
2185 <span class="pre-in-pp" style="margin-bottom: -1em">
2186   .HY MARGIN 18p
2187 </span>
2188 </p>
2189
2190 <div class="box-tip">
2191 <p class="tip">
2192 <span class="note">Note:</span> The numeric argument after HY
2193 MARGIN requires a
2194 <a href="definitions.html#unitofmeasure">unit of measure</a>.
2195 </p>
2196 </div>
2197
2198 <h3 class="docs numbered">4.&nbsp;&nbsp;HY SPACE</h3>
2199
2200 <p>
2201 HY SPACE sets an amount of extra interword space that groff will try
2202 to put between words on a line in order to PREVENT hyphenation.  HY
2203 SPACE applies only to
2204 <a href="definitions.html#just">justified lines</a>.
2205 Generally speaking, you&#8217;ll want this value to be quite small,
2206 since too big a value will result in lines with gaping holes between
2207 the words.  A reasonable value might be half a point, or one point,
2208 which you&#8217;d set with
2209 <br/>
2210 <span class="pre-in-pp">
2211   .HY SPACE .5p
2212 </span>
2213 or
2214 <span class="pre-in-pp" style="margin-bottom: -1em">
2215   .HY SPACE 1p
2216 </span>
2217 </p>
2218
2219 <div class="box-tip">
2220 <p class="tip">
2221 <span class="note">Note:</span> The numeric argument after HY SPACE
2222 requires a
2223 <a href="definitions.html#unitofmeasure">unit of measure</a>.
2224 </p>
2225 </div>
2226
2227 <h3 class="docs numbered">5.&nbsp;&nbsp;HY DEFAULT</h3>
2228
2229 <p>
2230 HY DEFAULT resets automatic hyphenation to its default behaviour,
2231 cancelling any changes made with HY <kbd>LINES</kbd>, HY
2232 <kbd>MARGIN</kbd>, and/or HY <kbd>SPACE</kbd>.
2233 </p>
2234
2235 <div class="box-notes">
2236 <h3 id="hyphenation-thoughts" class="docs notes">Thoughts on hyphenation in general</h3>
2237
2238 <p style="margin-top: .5em">
2239 Hyphenation is a necessary evil.  If it can be avoided, it
2240 should be.  If it can&#8217;t be, it should occur infrequently.
2241 That&#8217;s the reason for the number of parameters you can set
2242 with HY.
2243 </p>
2244
2245 <p class="tip-bottom">
2246 Furthermore, hyphenation in
2247 <a href="definitions.html#rag">rag</a>
2248 copy requires a great deal of attention.  At best, it should be
2249 avoided completely by individually adjusting the number of words
2250 on consecutive lines to achieve a pleasing, natural-looking rag.
2251 Since such adjustments are often too fussy for document processing,
2252 I recommend playing around with HY MARGIN a bit if your copy looks
2253 hyphen-heavy.
2254 </p>
2255 </div>
2256
2257 <!-- -HY_SET- -->
2258
2259 <div class="macro-id-overline">
2260 <h3 id="hy-set" class="macro-id">Set hyphenation parameters all at once</h3>
2261 </div>
2262
2263 <div class="box-macro-args">
2264 Macro: <b>HY_SET</b> <kbd class="macro-args">&lt;lines&gt; [ &lt;margin&gt; [ &lt;space&gt; ] ]</kbd>
2265 </div>
2266
2267 <p class="alias">
2268 <i>Alias:</i> <b>HYSET</b>
2269 </p>
2270
2271 <p>
2272 HY_SET lets you set the parameters for hyphenation
2273 with a single macro. <kbd>&lt;lines&gt;,</kbd>
2274 <kbd>&lt;margin&gt;</kbd> and
2275 <kbd>&lt;space&gt;</kbd> correspond to the numeric
2276 values required by <kbd>LINES</kbd>,
2277 <kbd>MARGIN</kbd> and <kbd>SPACE</kbd> as described
2278 <a href="#hy">above</a>.
2279 </p>
2280
2281 <p>
2282 To set just the maximum number of consecutive hyphenated lines,
2283 you&#8217;d enter
2284 <br/>
2285 <span class="pre-in-pp">
2286   .HY_SET 2
2287 </span>
2288 If you wanted the same number of maximum consecutive hyphenated
2289 lines and a hyphenation margin for use with
2290 <a href="definitions.html#rag">rag</a>
2291 copy,
2292 <br/>
2293 <span class="pre-in-pp">
2294   .HY_SET 2 36p
2295 </span>
2296 would set the hyphenation margin to 36 points.
2297 </p>
2298
2299 <p>
2300 If you wanted the same number of maximum consecutive hyphenated
2301 lines and a hyphenation space of 2 points for use with
2302 <a href="definitions.html#just">justified</a>
2303 copy,
2304 <br/>
2305 <span class="pre-in-pp">
2306   .HYSET 2 0 2p
2307 </span>
2308 is how you&#8217;d do it.
2309 </p>
2310
2311 <!-- -RW- -->
2312
2313 <div class="macro-id-overline">
2314 <h3 id="rw" class="macro-id">Reduce whitespace</h3>
2315 </div>
2316
2317 <div class="box-macro-args">
2318 Macro: <b>RW</b> <kbd class="macro-args">&lt;amount of whitespace reduction between letters&gt;</kbd>
2319 </div>
2320
2321 <p>
2322 RW (<span style="text-decoration: underline;">R</span>educe <span style="text-decoration: underline;">W</span>hitespace)
2323 and its corresponding macro
2324 EW (<span style="text-decoration: underline;">E</span>xpand <span style="text-decoration: underline;">W</span>hitespace),
2325 allow you to tighten (or loosen)
2326 <a href="definitions.html#outputline">output lines</a>
2327 by uniformly reducing or expanding the space between characters.
2328 This is particularly useful when you want to squeeze or stretch
2329 lines on a narrow measure.
2330 </p>
2331
2332 <p>
2333 The value passed to RW may be a whole number or a decimal fraction.
2334 Since a value of 1 produces a noticeable reduction in the space
2335 between letters at text sizes, you&#8217;ll most likely use small
2336 decimal values when tightening lines.  For example,
2337 <br/>
2338 <span class="pre-in-pp">
2339   .RW .1
2340 </span>
2341 or
2342 <span class="pre-in-pp">
2343   .RW .2
2344 </span>
2345 may be just enough to squeeze an extra character or two on a line
2346 without the change in letter spacing being obvious.  I highly
2347 recommend previewing your work to assess the effect of RW.
2348 </p>
2349
2350 <div class="box-tip">
2351 <p class="tip">
2352 <span class="note">Note:</span> By default, RW does not deposit a
2353 <a href="#br">break</a>
2354 when it&#8217;s invoked if you&#8217;re in one of the
2355 <a href="definitions.html#fill">fill</a>
2356 modes (ie
2357 <a href="#quad">QUAD</a>
2358 L, R, C, J or
2359 <a href="#justify">JUSTIFY</a>).
2360 If you want
2361 RW to break at the ends of the previous
2362 <a href="definitions.html#inputline">input lines</a>
2363 while you&#8217;re in a fill mode, tell mom
2364 that&#8217;s what you want by invoking
2365 <kbd><a href="#br-at-line-kern">.BR_AT_LINE_KERN</a></kbd>.
2366 </p>
2367 </div>
2368
2369 <div class="box-important">
2370 <p class="tip">
2371 <span class="important">IMPORTANT:</span>
2372 RW (and its complement, EW; see below) only affects the current
2373 font, and remains in effect for that font every time it&#8217;s
2374 called, hence it must be reset to zero to cancel its effect
2375 (<kbd>.RW&nbsp;0</kbd>).
2376 </p>
2377 </div>
2378
2379 <!-- -EW- -->
2380
2381 <div class="macro-id-overline">
2382 <h3 id="ew" class="macro-id">Expand whitespace</h3>
2383 </div>
2384
2385 <div class="box-macro-args">
2386 Macro: <b>EW</b> <kbd class="macro-args">&lt;amount of whitespace expansion between letters&gt;</kbd>
2387 </div>
2388
2389 <p>
2390 EW (<span style="text-decoration: underline;">E</span>xpand <span style="text-decoration: underline;">W</span>hitespace)
2391 expands the amount of whitespace between letters, effectively
2392 &#8220;loosening&#8221; lines of type.
2393 </p>
2394
2395 <p>
2396 The value passed to EW may be a whole number or a decimal fraction.
2397 Since a value of 1 produces a noticeable expansion in the space
2398 between letters at text sizes, you&#8217;ll most likely use small
2399 decimal values when loosening lines.  For example,
2400 <br/>
2401 <span class="pre-in-pp">
2402   .EW .1
2403 </span>
2404 or
2405 <span class="pre-in-pp">
2406   .EW .2
2407 </span>
2408 may be just enough to open up a line without the change in letter
2409 spacing being obvious.  I highly recommend previewing your work to
2410 assess the effect of EW.
2411 </p>
2412
2413 <div class="box-tip">
2414 <p class="tip">
2415 <span class="note">Note:</span> By default, EW does not deposit a
2416 <a href="#br">break</a>
2417 when it&#8217;s invoked if you&#8217;re in one of the
2418 <a href="definitions.html#fill">fill</a>
2419 modes (ie
2420 <a href="#quad">QUAD</a>
2421 L, R, C, J or
2422 <a href="#justify">JUSTIFY</a>).
2423 If you want
2424 EW to break at the ends of the previous
2425 <a href="definitions.html#inputline">input lines</a>
2426 while you&#8217;re in a fill mode, tell mom that&#8217;s what you
2427 want by invoking the
2428 <kbd><a href="#br-at-line-kern">.BR_AT_LINE_KERN</a></kbd>
2429 toggle macro.
2430 </p>
2431 </div>
2432
2433 <div class="box-important">
2434 <p class="tip">
2435 <span class="important">IMPORTANT:</span>
2436 EW (and its complement, RW; see above) only affects the current
2437 font, and remains in effect for that font every time it&#8217;s
2438 called, hence it must be reset to zero to cancel its effect
2439 (<kbd>.RW&nbsp;0</kbd>).
2440 </p>
2441 </div>
2442
2443 <!-- -BR_AT_LINE_KERN- -->
2444
2445 <div class="macro-id-overline">
2446 <h3 id="br-at-line-kern" class="macro-id">Break before line kerning</h3>
2447 </div>
2448
2449 <div class="box-macro-args">
2450 Macro: <b>BR_AT_LINE_KERN</b> <kbd class="macro-args">toggle</kbd>
2451 </div>
2452
2453 <p>
2454 By default, in
2455 <a href="definitions.html#filled">fill</a>
2456 modes (ie
2457 <a href="#quad">QUAD</a>
2458 L, R, C, J or
2459 <a href="#justify">JUSTIFY</a>)
2460 mom does not break
2461 <a href="definitions.html#inputline">input lines</a>
2462 when you invoke
2463 <a href="#rw">RW</a>
2464 or
2465 <a href="#ew">EW</a>.
2466 If you&#8217;d like her to break input lines prior to RW or EW,
2467 invoke <kbd>.BR_AT_INPUT_LINE</kbd> without any argument.  To
2468 disable the breaks, invoke <kbd>.BR_AT_INPUT_LINE</kbd> with any
2469 argument (OFF, QUIT, Q, X...), like this
2470 <br/>
2471 <span class="pre-in-pp">
2472   .BR_AT_LINE_KERN OFF
2473 </span>
2474 or
2475 <span class="pre-in-pp">
2476   .BR_AT_LINE_KERN X
2477 </span>
2478 With QUAD L, R or C, mom simply breaks the line.  With QUAD J (or
2479 just JUSTIFY, which is the same thing), she breaks and
2480 <a href="definitions.html#force">force justifies</a>
2481 the line prior to <kbd>.EW</kbd> or <kbd>.RW</kbd>.
2482 </p>
2483
2484 <!-- -KERN- -->
2485
2486 <div class="macro-id-overline">
2487 <h3 id="kern" class="macro-id">Automatic kerning</h3>
2488 </div>
2489
2490 <div class="box-macro-args">
2491 Macro: <b>KERN</b> <kbd class="macro-args">toggle</kbd>
2492 </div>
2493
2494 <p>
2495 By itself (ie with no argument), KERN turns automatic pairwise
2496 <a href="definitions.html#kern">kerning</a>
2497 on.  With any argument (e.g., OFF, Q, X), pairwise kerning is turned
2498 off.
2499 </p>
2500
2501 <p>
2502 Kerning of individual character pairs can be controlled with the
2503 <a href="definitions.html#inlines">inline escapes</a>
2504 <kbd>\*[BU &lt;n&gt;]</kbd> and
2505 <kbd>\*[FU &lt;n&gt;]</kbd>.  See
2506 <a href="inlines.html#inline-kerning-mom">Inline Escapes, kerning</a>.
2507 </p>
2508
2509 <!-- -LIGATURES- -->
2510
2511 <div class="macro-id-overline">
2512 <h3 id="ligatures" class="macro-id">Automatic ligature generation</h3>
2513 </div>
2514
2515 <div class="box-macro-args">
2516 Macro: <b>LIGATURES</b> <kbd class="macro-args">toggle</kbd>
2517 </div>
2518 <p class="alias">
2519 <i>Alias:</i> <b>LIG</b>
2520 </p>
2521
2522 <p>
2523 Provided your current font has
2524 <a href="definitions.html#ligatures">ligatures</a>,
2525 LIGATURES, by itself, turns on automatic generation of ligatures.
2526 When automatic ligature generation is on, simply typing the letters
2527 of a ligature combination will produce the correct ligature upon
2528 output.  For example, if you type the word &#8220;finally&#8221;,
2529 the fi combination will be output as an fi ligature.  Generally
2530 speaking, ligatures are A Good Thing, hence mom has them on by
2531 default.
2532 </p>
2533
2534 <p>
2535 LIGATURES with any argument turns automatic ligature generation off.
2536 </p>
2537
2538 <div class="box-tip">
2539 <p class="tip">
2540 <span class="note">Note:</span> Not all fonts support ligatures.
2541 </p>
2542 </div>
2543
2544 <div class="rule-short"><hr/></div>
2545
2546 <!-- ==================================================================== -->
2547
2548 <h2 id="modifications-intro" class="macro-group">Type modifications (pseudo font styles)</h2>
2549
2550 <p>
2551 It sometimes happens that a
2552 <a href="definitions.html#family">family</a>
2553 doesn&#8217;t contain all the fonts you need.  You might, for
2554 example, be missing an italic font, or a bold font.  Or you might
2555 not be able to get your hands on the condensed version.  That&#8217;s
2556 where these macros and inline escapes come in.  With them, you
2557 can fake the fonts you&#8217;re missing.  A word of caution,
2558 though: &#8220;faked&#8221; fonts are just that&mdash;faked.  You
2559 should only use them as a last resort, and then only sparingly.  A
2560 word or two or a line or two in a faked font will pass unnoticed;
2561 large patches of type in a faked font look typographically cheap.
2562 </p>
2563
2564 <div id="index-modifications" class="macro-list-container">
2565 <h3 class="macro-list">Type modifications macros</h3>
2566
2567 <ul class="macro-list">
2568   <li>Pseudo italic
2569   <ul style="list-style: none; margin-left: -1em;">
2570     <li><a href="#setslant">SETSLANT</a> &ndash; degree of pseudo-italicizing</li>
2571     <li><a href="#slant-inline">\*[SLANT]</a> &ndash; inline escape for pseudo-italicizing type</li>
2572   </ul></li>
2573   <li>Pseudo bold
2574   <ul style="list-style: none; margin-left: -1em;">
2575     <li><a href="#setbolder">SETBOLDER</a> &ndash; amount of emboldening</li>
2576     <li><a href="#bolder-inline">\*[BOLDER]</a> &ndash; inline escape for emboldening type</li>
2577   </ul></li>
2578   <li>Pseudo condensed
2579   <ul style="list-style: none; margin-left: -1em;">
2580     <li><a href="#condense">CONDENSE</a> &ndash; percentage for pseudo-condensed type</li>
2581     <li><a href="#cond-inline">\*[COND]</a> &ndash; inline escape for pseudo-condensed type</li>
2582   </ul></li>
2583   <li>Pseudo extended
2584   <ul style="list-style: none; margin-left: -1em;">
2585     <li><a href="#extend">EXTEND</a> &ndash; percentage for pseudo-extended type</li>
2586     <li><a href="#ext-inline">\*[EXT]</a> &ndash; inline escape for pseudo-extending</li>
2587   </ul></li>
2588   <li>Smallcaps
2589   <ul style="list-style: none; margin-left: -1em;">
2590     <li><a href="#smallcaps">SMALLCAPS</a> &ndash; enable smallcaps</li>
2591     <li><a href="#smallcaps-style">SMALLCAPS_STYLE</a> &ndash; size, weight, and width of smallcaps</li>
2592   </ul></li>
2593 </ul>
2594 </div>
2595
2596 <!-- -SETSLANT- -->
2597
2598 <div class="macro-id-overline">
2599 <h3 id="setslant" class="macro-id">Set degree of slant for pseudo-italicizing</h3>
2600 </div>
2601
2602 <div class="box-macro-args">
2603 Macro: <b>SETSLANT</b> <kbd class="macro-args">&lt;degrees to slant type&gt; | RESET</kbd>
2604 </div>
2605
2606 <p>
2607 Pseudo-italicizing of type is accomplished by slanting a roman font
2608 a certain number of degrees to the right. SETSLANT lets you fix the
2609 number of degrees. Mom&#8217;s default is 15, which produces an
2610 acceptable approximation of an italic font.  If you want another
2611 value&mdash;say, 13 degrees&mdash;you&#8217;d set it by entering
2612 <br/>
2613 <span class="pre-in-pp">
2614   .SETSLANT 13
2615 </span>
2616 If you change the degree of slant and later want to set it back to
2617 the mom default, do
2618 <br/>
2619 <span class="pre-in-pp">
2620   .SETSLANT RESET
2621 </span>
2622 </p>
2623
2624 <div class="box-tip">
2625 <p class="tip">
2626 <span class="note">Note:</span> By itself, SETSLANT will not start
2627 pseudo-italicizing type; it merely tells mom what degree of slant
2628 you want.  To start pseudo-italicizing, use the
2629 <a href="definitions.html#inlines">inline escape</a>
2630 <kbd>\*[SLANT]</kbd>.
2631 </p>
2632 </div>
2633
2634 <!-- -\*[SLANT]- -->
2635
2636 <div class="macro-id-overline">
2637 <h3 id="slant-inline" class="macro-id">Pseudo italic on/off</h3>
2638 </div>
2639
2640 <div class="box-macro-args">
2641 Inline: <kbd class="macro-args">\*[SLANT]</kbd>
2642 <br/>
2643 Inline: <kbd class="macro-args">\*[SLANTX</kbd>]
2644 </div>
2645
2646 <p>
2647 <kbd class="macro-args">\*[SLANT]</kbd> begins pseudo-italicizing type.
2648 <kbd class="macro-args">\*[SLANTX]</kbd> turns the feature off.  Both are
2649 <a href="definitions.html#inlines">inline escapes</a>,
2650 therefore they should not appear as separate lines, but rather be
2651 embedded in text lines, like this:
2652 <br/>
2653 <span class="pre-in-pp">
2654   Not \*[SLANT]everything\*[SLANTX] is as it seems.
2655 </span>
2656 Alternatively, if you wanted the whole line pseudo-italicized,
2657 you&#8217;d do
2658 <br/>
2659 <span class="pre-in-pp">
2660   \*[SLANT]Not everything is as it seems.\*[SLANTX]
2661 </span>
2662 Once <kbd>\*[SLANT]</kbd> is invoked, it remains in effect until
2663 turned off.
2664 </p>
2665
2666 <div class="box-tip" style="margin-top: .5em;">
2667 <p class="tip">
2668 <span class="note">Note:</span> If you&#8217;re using the
2669 <a href="docprocessing.html#docprocessing">document processing macros</a>
2670 with
2671 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
2672 mom underlines pseudo-italics by default.  To change this behaviour,
2673 use the special macro
2674 <a href="docprocessing.html#typewrite-control">SLANT_MEANS_SLANT</a>.
2675 </p>
2676 </div>
2677
2678 <!-- -SETBOLDER- -->
2679
2680 <div class="macro-id-overline">
2681 <h3 id="setbolder" class="macro-id">Set amount of emboldening</h3>
2682 </div>
2683
2684 <div class="box-macro-args">
2685 Macro: <b>SETBOLDER</b> <kbd class="macro-args">&lt;amount of emboldening, in machine units&gt; | RESET</kbd>
2686 </div>
2687
2688 <p>
2689 Emboldening of type is accomplished by printing characters twice;
2690 the second printing is slightly offset from the first, effectively
2691 &#8220;thickening&#8221; the character.  SETBOLDER lets you set the
2692 number of
2693 <a href="definitions.html#units">machine units</a>
2694 for the offset.  Mom&#8217;s default is 700 units, which produces an
2695 acceptable approximation of a bold font.  If you want another
2696 value&mdash;say, 500 units&mdash;you&#8217;d set it by entering
2697 <br/>
2698 <span class="pre-in-pp">
2699   .SETBOLDER 500
2700 </span>
2701 If you change the emboldening offset and later want to set it back
2702 to the mom default, do
2703 <br/>
2704 <span class="pre-in-pp">
2705   .SETBOLDER RESET
2706 </span>
2707 </p>
2708
2709 <div class="box-tip">
2710 <p class="tip">
2711 <span class="note">Note:</span> By itself, SETBOLDER will not start
2712 emboldening type; it merely tells mom what you want the emboldening
2713 offset to be.  To start emboldening, use the
2714 <a href="definitions.html#inlines">inline escape</a>
2715 <kbd>\*[BOLDER]</kbd>.
2716 </p>
2717 </div>
2718
2719 <!-- -\*[BOLDER]- -->
2720
2721 <div class="macro-id-overline">
2722 <h3 id="bolder-inline" class="macro-id">Emboldening on/off</h3>
2723 </div>
2724
2725 <div class="box-macro-args">
2726 Inline: <kbd class="macro-args">\*[BOLDER]</kbd>
2727 <br/>
2728 Inline: <kbd class="macro-args">\*[BOLDERX]</kbd>
2729 </div>
2730
2731 <p>
2732 <kbd class="macro-args">\*[BOLDER]</kbd> begins emboldening type.
2733 <kbd class="macro-args">\*[BOLDERX]</kbd> turns the feature off.  Both are
2734 <a href="definitions.html#inlines">inline escapes</a>,
2735 therefore they should not appear as separate lines, but rather be
2736 embedded in text lines, like this:
2737 <br/>
2738 <span class="pre-in-pp">
2739   Not \*[BOLDER]everything\*[BOLDERX] is as it seems.
2740 </span>
2741 Alternatively, if you wanted the whole line emboldened,
2742 you&#8217;d do
2743 <br/>
2744 <span class="pre-in-pp">
2745   \*[BOLDER]Not everything is as it seems.\*[BOLDERX]
2746 </span>
2747 Once <kbd>\*[BOLDER]</kbd> is invoked, it remains in effect
2748 until turned off.
2749 </p>
2750
2751 <div class="box-tip">
2752 <p class="tip">
2753 <span class="note">Note:</span> If you&#8217;re using the
2754 <a href="docprocessing.html#docprocessing">document processing macros</a>
2755 with
2756 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
2757 mom ignores <kbd>\*[BOLDER]</kbd> requests.
2758 </p>
2759 </div>
2760
2761 <!-- -CONDENSE- -->
2762
2763 <div class="macro-id-overline">
2764 <h3 id="condense" class="macro-id">Set percentage for pseudo-condensed type</h3>
2765 </div>
2766
2767 <div class="box-macro-args">
2768 Macro: <b>CONDENSE</b> <kbd class="macro-args">&lt;pseudo-condense percentage&gt;</kbd>
2769 </div>
2770
2771 <p>
2772 Pseudo-condensing of type is accomplished by reducing the width of
2773 characters at a given point size without reducing their height,
2774 effectively narrowing them so they look like condensed type.
2775 CONDENSE tells mom what percentage of the normal character width you
2776 want the characters to be condensed.
2777 </p>
2778
2779 <p>
2780 Mom has no default value for CONDENSE, therefore you must set it
2781 before using the
2782 <a href="definitions.html#inlines">inline escape</a>
2783 <kbd><a href="#cond-inline">\*[COND]</a></kbd>.
2784 80 percent of the normal character width is a good value, and
2785 you&#8217;d set it like this:
2786 <br/>
2787 <span class="pre-in-pp">
2788   .CONDENSE 80
2789 </span>
2790 </p>
2791
2792 <div class="box-tip">
2793 <p class="tip-top">
2794 <span class="note">Note:</span> By itself, CONDENSE will not start
2795 pseudo-condensing type; it merely tells mom what percentage of the
2796 normal character width you want characters to be condensed.  To
2797 start pseudo-condensing, use the
2798 <a href="definitions.html#inlines">inline escape</a>
2799 <kbd>\*[COND]</kbd>.
2800 </p>
2801
2802 <p class="tip-bottom">
2803 <span class="additional-note">Additional note:</span> Make sure that
2804 pseudo-condensing is off (with
2805 <kbd><a href="#cond-inline">\*[CONDX]</a></kbd>)
2806 before before making any changes to the pseudo-condense percentage
2807 with CONDENSE.
2808 </p>
2809 </div>
2810
2811 <!-- -\*[COND]- -->
2812
2813 <div class="macro-id-overline">
2814 <h3 id="cond-inline" class="macro-id">Pseudo-condensing on/off</h3>
2815 </div>
2816
2817 <div class="box-macro-args">
2818 Inline: <kbd class="macro-args">\*[COND]</kbd>
2819 <br/>
2820 Inline: <kbd class="macro-args">\*[CONDX]</kbd>
2821 </div>
2822
2823 <p>
2824 <kbd>\*[COND]</kbd> begins pseudo-condensing type.
2825 <kbd>\*[CONDX]</kbd> turns the feature off.  Both are
2826 <a href="definitions.html#inlines">inline escapes</a>,
2827 therefore they should not appear as separate lines, but rather be
2828 embedded in text lines, like this:
2829 <br/>
2830 <span class="pre-in-pp">
2831   \*[COND]Not everything is as it seems.\*[CONDX]
2832 </span>
2833 <kbd>\*[COND]</kbd> remains in effect until you turn it
2834 off with <kbd>\*[CONDX]</kbd>.
2835 </p>
2836
2837 <div class="box-important">
2838 <p class="tip">
2839 <span class="important">IMPORTANT:</span> You must turn
2840 <kbd>\*[COND]</kbd>
2841 off before making any changes to the point size of your type, either
2842 via the
2843 <a href="#ps">PT_SIZE</a>
2844 macro or with the <kbd>\s</kbd> inline escape.  If you wish
2845 the new point size to be pseudo-condensed, simply reinvoke
2846 <kbd>\*[COND]</kbd> afterwards.  Equally, <kbd>\*[COND]</kbd> must
2847 be turned off before changing the condense percentage with
2848 <kbd><a href="#condense">.CONDENSE</a></kbd>.
2849 </p>
2850 </div>
2851
2852 <div class="box-tip">
2853 <p class="tip">
2854 <span class="note">Note:</span> If you&#8217;re using the
2855 <a href="docprocessing.html#docprocessing">document processing macros</a>
2856 with
2857 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
2858 mom ignores <kbd>\*[COND]</kbd> requests.
2859 </p>
2860 </div>
2861
2862 <!-- -EXTEND- -->
2863
2864 <div class="macro-id-overline">
2865 <h3 id="extend" class="macro-id">Set percentage for pseudo-extended type</h3>
2866 </div>
2867
2868 <div class="box-macro-args">
2869 Macro: <b>EXTEND</b> <kbd class="macro-args">&lt;pseudo-extend percentage&gt;</kbd>
2870 </div>
2871
2872 <p>
2873 Pseudo-extending of type is accomplished by increasing the width of
2874 characters at a given point size without increasing their height,
2875 effectively widening them so they look like extended type. EXTEND
2876 tells mom what percentage of the normal character width you want the
2877 characters to be extended.
2878 </p>
2879
2880 <p>
2881 Mom has no default value for EXTEND, therefore you must set it
2882 before using the
2883 <a href="definitions.html#inlines">inline escape</a>
2884 <kbd><a href="#ext-inline">\*[EXT]</a></kbd>.
2885 120% of the normal character width is a good value, and you&#8217;d
2886 set it like this:
2887 <br/>
2888 <span class="pre-in-pp">
2889   .EXTEND 120
2890 </span>
2891 </p>
2892
2893 <div class="box-tip">
2894 <p class="tip-top">
2895 <span class="note">Note:</span> By itself, EXTEND will not start
2896 pseudo-extending type; it merely tells mom what percentage of the
2897 normal character width you want characters to be extended.  To start
2898 pseudo-extending, use the
2899 <a href="definitions.html#inlines">inline escape</a>
2900 <kbd>\*[EXT]</kbd>.
2901 </p>
2902
2903 <p class="tip-bottom">
2904 <span class="additional-note">Additional note:</span> Make sure that
2905 pseudo-extending is off (with
2906 <a href="#ext-inline"><kbd>\*[EXTX]</kbd></a>)
2907 before before making any changes to the pseudo-extend percentage
2908 with EXTEND.
2909 </p>
2910 </div>
2911
2912 <!-- -\*[EXT]- -->
2913
2914 <div class="macro-id-overline">
2915 <h3 id="ext-inline" class="macro-id">Pseudo-extending on/off</h3>
2916 </div>
2917
2918 <div class="box-macro-args">
2919 Inline: <kbd class="macro-args">\*[EXT]</kbd>
2920 <br/>
2921 Inline: <kbd class="macro-args">\*[EXTX]</kbd>
2922 </div>
2923
2924 <p>
2925 <kbd>\*[EXT]</kbd> begins pseudo-extending type.
2926 <kbd>\*[EXTX]</kbd> turns the feature off.  Both are
2927 <a href="definitions.html#inlines">inline escapes</a>,
2928 therefore they should not appear as separate lines, but rather be
2929 embedded in text lines, like this:
2930 <br/>
2931 <span class="pre-in-pp">
2932   \*[EXT]Not everything is as it seems.\*[EXTX]
2933 </span>
2934 <kbd>\*[EXT]</kbd> remains in effect until you turn it off with
2935 <kbd>\*[EXTX]</kbd>.
2936 </p> <div class="box-important"> <p class="tip">
2937 <span class="important">IMPORTANT:</span> You must turn
2938 <kbd>\*[EXT]</kbd> off before making any changes to the point size
2939 of your type, either via the
2940 <a href="#ps">PT_SIZE</a>
2941 macro or with the <kbd>\s</kbd> inline escape.  If you wish the new
2942 point size to be pseudo-extended, simply reinvoke <kbd>\*[EXT]</kbd>
2943 afterwards.  Equally, <kbd>\*[EXT]</kbd> must be turned off before
2944 changing the extend percentage with
2945 <a href="#extend">EXTEND</a>.
2946 </p>
2947 </div>
2948 <div class="box-tip">
2949 <p class="tip">
2950 <span class="note">Note:</span> If you&#8217;re using the
2951 <a href="docprocessing.html#docprocessing">document processing macros</a>
2952 with
2953 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
2954 mom ignores <kbd>\*[EXT]</kbd> requests.
2955 </p>
2956 </div>
2957
2958 <!-- SMALLCAPS -->
2959
2960 <div class="macro-id-overline">
2961 <h3 id="smallcaps" class="macro-id">Smallcaps</h3>
2962 </div>
2963
2964 <div class="box-macro-args">
2965 Macro: <b>SMALLCAPS</b> <kbd class="macro-args">&lt;toggle&gt;</kbd>
2966 </div>
2967
2968 <p>
2969 To begin setting type in pseudo-smallcaps, simply invoke
2970 <kbd>.SMALLCAPS</kbd>.  When you no longer want them, invoke
2971 <kbd>SMALLCAPS&nbsp;OFF</kbd> (or <kbd>END</kbd>, <kbd>STOP</kbd>,
2972 <kbd>DONE</kbd>, etc).  If you are currently in a
2973 <a href="definitions.html#filled">no-fill mode</a>,
2974 (i.e. <kbd>.LEFT</kbd>, <kbd>.CENTER</kbd>, or <kbd>.RIGHT</kbd>)
2975 and you want the smallcaps to continue on the same line,
2976 append a <kbd>\c</kbd> to the line, like this
2977 <br/>
2978 <span class="pre-in-pp">
2979   A line of type\c
2980   .SMALLCAPS
2981   with a few words in smallcaps.
2982   .SMALLCAPS OFF
2983 </span>
2984 The line preceding <kbd>.SMALLCAPS OFF</kbd> should also have a
2985 <kbd>\c</kbd> appended to it if you wish it to continue unbroken.
2986 </p>
2987
2988 <div class="box-tip">
2989 <p class="tip-top">
2990 <span class="note">Note:</span>
2991 SMALLCAPS does not have an inline equivalent to
2992 <a href="inlines.html#uc-lc"><kbd>\*[UC]</kbd> / <kbd>\*[LC]</kbd></a>.
2993 Furthermore, if you&#8217;re using the
2994 <a href="docprocessing.html#docprocessing">document processing macros</a>
2995 with
2996 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
2997 mom ignores SMALLCAPS.
2998 </p>
2999
3000 <p class="tip-bottom">
3001 Additionally, be aware that no automatic
3002 <a href="definitions.html#kern">kerning</a>
3003 takes place while pseudo-smallcaps are in effect.
3004 </p>
3005 </div>
3006
3007 <div class="macro-id-overline">
3008 <h3 id="smallcaps-style" class="macro-id">Set size, weight, and width of smallcaps</h3>
3009 </div>
3010
3011 <div class="box-macro-args">
3012 Macro: <b>SMALLCAPS_STYLE</b> <kbd class="macro-args">SIZE &lt;percentage&gt; WEIGHT_ADJ &lt;percentage&gt; EXTEND &lt;percentage&gt;</kbd>
3013 </div>
3014
3015 <p>
3016 True smallcaps are not a font effect, but, like designer cuts of
3017 bold, condensed, and extended, actual fonts provided with some
3018 families.  It is highly recommended that you acquire real smallcaps
3019 fonts rather than relying on mom's pseudo version.
3020 </p>
3021
3022 <p>
3023 To achieve a reasonable facsimile of designer-cut smallcaps fonts,
3024 mom needs to know the percentage of regular caps at a given point
3025 size by which to reduce the small caps.  To make adjustments for
3026 the difference in weight and width of the smaller caps, she also
3027 needs to know by how much to embolden (&#8220;fatten&#8221;) the
3028 smallcaps, and by how much to increase their width.
3029 </p>
3030
3031 <p>
3032 All three arguments to SMALLCAPS_STYLE reflect a
3033 percentage of the point size in effect when
3034 <a href="#smallcaps">SMALLCAPS</a>
3035 is invoked.  Mom&#8217;s defaults for pseudo-smallcaps are:
3036 <br/>
3037 <span class="pre-in-pp">
3038   SIZE       = 74%
3039   WEIGHT_ADJ = .3%
3040   EXTEND     = 5%
3041 </span>
3042 To change any or all of the defaults, you might enter
3043 <br/>
3044 <span class="pre-in-pp">
3045   .SMALLCAPS_STYLE SIZE 80 WEIGHT_ADJ .25 EXTEND 3
3046 </span>
3047 or, more readably,
3048 <br/>
3049 <span class="pre-in-pp">
3050   .SMALLCAPS_STYLE
3051   SIZE 80 \
3052   WEIGHT_ADJ .25 \
3053   EXTEND 3
3054 </span>
3055 Note that you do not have to give SMALLCAPS_STYLE all three
3056 arguments, and that the arguments may be entered in any order.  Any
3057 arguments you omit will remain at their former value.
3058 </p>
3059
3060 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
3061
3062 <!-- ==================================================================== -->
3063
3064 <h2 id="aldrld-intro" class="macro-group">Vertical movements</h2>
3065
3066 The two macros in this section allow you to move down or up on the
3067 page relative to the current
3068 <a href="definitions.html#baseline">baseline</a>.
3069
3070 <div id="index-aldrld" class="macro-list-container">
3071 <h3 class="macro-list">Vertical movements macros</h3>
3072 <ul class="macro-list">
3073   <li><a href="#ald">ALD</a> &ndash; Advance Lead</li>
3074   <li><a href="#rld">RLD</a> &ndash; Reverse Lead</li>
3075 </ul>
3076 </div>
3077
3078 <!-- -ALD- -->
3079
3080 <div class="macro-id-overline">
3081 <h3 id="ald" class="macro-id">Advance Lead (move downward)</h3>
3082 </div>
3083
3084 <div class="box-macro-args">
3085 Macro: <b>ALD</b> <kbd class="macro-args">&lt;distance to move downward&gt;</kbd>
3086 </div>
3087 <p class="requires">
3088 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
3089 </p>
3090
3091 <p>
3092 ALD takes one argument: the distance to move downward on the page
3093 relative to the current vertical position.
3094 </p>
3095
3096 <p>
3097 Used by itself, or preceded by
3098 <a href="#br">BR</a>,
3099 ALD will advance by one line space plus the distance you specify.
3100 Preceded by
3101 <a href="#el">EL</a>,
3102 it will advance by exactly the distance you specify.
3103 </p>
3104
3105 <p>
3106 ALD requires a unit of measure.  Decimal fractions are allowed, and
3107 values may be combined.  Therefore, to move down on the page by 1/4
3108 of an inch, you could enter either
3109 <br/>
3110 <span class="pre-in-pp">
3111   .ALD .25i
3112 </span>
3113 or
3114 <br/>
3115 <span class="pre-in-pp">
3116   .ALD 1P+6p
3117 </span>
3118 As the mnemonic
3119 (<span style="text-decoration: underline;">A</span>dvance <span style="text-decoration: underline;">L</span>ea<span style="text-decoration: underline;">D</span>)
3120 suggests, you&#8217;ll most often use ALD with
3121 <a href="definitions.html#picaspoints">points</a>
3122 of lead.
3123 </p>
3124
3125 <div class="box-tip">
3126 <p class="tip">
3127 <span class="note">Note:</span> if you want to use ALD at the top
3128 of a page (ie to advance to the starting position of type on a
3129 page), combine the value you want with <kbd>-1v</kbd> (minus one
3130 line space), like this:
3131 <br/>
3132 <span class="pre-in-pp">
3133   .ALD 1i-1v
3134 </span>
3135 At the top of a page, this will advance one inch from the top edge
3136 of the paper.  Without the -1v, the same command would advance one
3137 inch from the top of the page plus the distance of one line space.
3138 </p>
3139 </div>
3140
3141 <!-- -RLD- -->
3142
3143 <div class="macro-id-overline">
3144 <h3 id="rld" class="macro-id">Reverse Lead (move upward)</h3>
3145 </div>
3146
3147 <div class="box-macro-args">
3148 Macro: <b>RLD</b> <kbd class="macro-args">&lt;distance to move upward&gt;</kbd>
3149 </div>
3150 <p class="requires">
3151 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
3152 </p>
3153
3154 <p>
3155 RLD takes one argument: the distance to move upward on the page
3156 relative to the current vertical position.
3157 </p>
3158
3159 <p>
3160 Used by itself, or preceded by
3161 <a href="#br">BR</a>,
3162 RLD will advance by one line space, then reverse by the distance you
3163 specify.  Preceded by
3164 <a href="#el">EL</a>,
3165 it will reverse by exactly the distance you specify.
3166 </p>
3167
3168 <p>
3169 RLD requires a unit of measure.  Decimal fractions are allowed, and
3170 values may be combined.  Therefore, to move up on the page by 1/4 of
3171 an inch, you could enter either
3172 <br/>
3173 <span class="pre-in-pp">
3174   .RLD .25i
3175 </span>
3176 or
3177 <span class="pre-in-pp">
3178   .RLD 1P+6p
3179 </span>
3180 As the mnemonic
3181 (<span style="text-decoration: underline;">R</span>everse <span style="text-decoration: underline;">L</span>ea<span style="text-decoration: underline;">D</span>)
3182 suggests, you&#8217;ll most often use RLD with
3183 <a href="definitions.html#picaspoints">points</a>
3184 of lead.
3185 </p>
3186
3187 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
3188
3189 <!-- ==================================================================== -->
3190
3191 <h2 id="tabs-intro" class="macro-group">Tabs</h2>
3192
3193 <p>
3194 Mom provides two different kinds of tab setup: typesetting tabs
3195 and string tabs.  Neither one has anything to do with the tab key
3196 on your keyboard, and both are utterly divorced from groff&#8217;s
3197 notion of tabs.  I recommend reading this section carefully in order
3198 to understand how mom handles tabs.
3199 </p>
3200
3201 <div class="box-tip">
3202 <p class="tip">
3203 <span class="note">Note:</span> see the section
3204 <a href="docprocessing.html#behaviour">Typesetting macros during document processing</a>
3205 for reassuring information on the use of tabs during
3206 <a href="docprocessing.html#docprocessing">document processing</a>.
3207 </p>
3208 </div>
3209
3210 <h3 id="typesetting-tabs" class="docs">Typesetting tabs</h3>
3211
3212 <p>
3213 Typesetting tabs are defined by both an indent from the left margin
3214 and a line length.  This is quite different from typewriter-style
3215 tab stops (the groff norm) that only define the left indent.  In
3216 conjunction with the
3217 <a href="#multicolumns-intro">multi-column macros</a>,
3218 typesetting tabs significantly facilitate tabular and columnar work.
3219 </p>
3220
3221 <p>
3222 Typesetting tabs are created with the
3223 <a href="#tab-set">TAB_SET</a>
3224 macro. TAB_SET identifies the tab (by number), establishes its left
3225 indent and line length, and optionally sets a quad direction and
3226 fill mode.  After tabs have been created with TAB_SET, they can be
3227 called at any time with the
3228 <a href="#tab">TAB</a>
3229 macro.
3230 </p>
3231
3232 <div class="examples-container">
3233 <h3 id="typesetting-tabs-tut" class="docs notes">Quickie tutorial on typesetting tabs</h3>
3234
3235 <p style="margin-top: .5em;">
3236 Say you want to set up three tabs to produce an employee evaluation
3237 that looks something like this:
3238 </p>
3239
3240 <div class="box-code" style="padding-bottom: 0;">
3241 <span id="typsetting-tabs-sample" class="pre-in-pp" style="color: #302419">
3242 CRITERION       EVALUATION     COMMENTS
3243
3244 Service           Good         Many clients specifically request
3245                                support from Joe by name.
3246
3247 Punctuality    Satisfactory    Tends to arrive after 8:00am, but
3248                                often works through lunch hour.
3249
3250 Team spirit     Needs work     Persistently gives higher priority
3251                                to helping clients than respecting
3252                                organizational hierarchy.
3253 </span>
3254 </div>
3255
3256 <p>
3257 You want the first tab, CRITERION,
3258 </p>
3259 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
3260 <li>to begin at the left margin of the page &ndash; ie no indent</li>
3261 <li>to have a line length of 5 picas</li>
3262 <li>to be set flush left</li>
3263 </ul>
3264
3265 <p>
3266 Tabs must be numbered, and each has to be set up with a separate
3267 <a href="#tab-set">TAB_SET</a>
3268 line.  Therefore, to set up tab 1, you enter
3269 <br/>
3270 <span class="pre-in-pp">
3271   .TAB_SET  1  0  5P  L
3272             |  |  |   |
3273      tab #--+  |  |   +--direction
3274                |  |
3275        indent--+  +--length
3276 </span>
3277 You want the second tab, EVALUATION,
3278 </p>
3279 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
3280 <li>to begin 8 picas from the left margin</li>
3281 <li>to have a length of 9 picas</li>
3282 <li>to be set centered</li>
3283 </ul>
3284
3285 <p>
3286 You set it up like this:
3287 <br/>
3288 <span class="pre-in-pp">
3289   .TAB_SET  2  8P  9P  C
3290             |  |   |   |
3291      tab #--+  |   |   +--direction
3292                |   |
3293        indent--+   +--length
3294 </span>
3295 You want the third tab, COMMENTS,
3296 </p>
3297 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
3298 <li>to begin 19 picas from the left margin</li>
3299 <li>to have a length of 17 picas</li>
3300 <li>to be set flush left, <a href="definitions.html#filled">filled</a></li>
3301 </ul>
3302
3303 <p>
3304 The setup looks like this:
3305 <br/>
3306 <span class="pre-in-pp">
3307   .TAB_SET  3  19P  17P  L  QUAD
3308             |   |    |   |    |
3309             |   |    |   |    +--fill output lines
3310             |   |    |   |
3311      tab #--+   |    |   +--direction
3312                 |    |
3313         indent--+    +--length
3314 </span>
3315 Once the tabs are set up, you can call them in one of two ways:
3316 </p>
3317 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
3318 <li>with <kbd><a href="#tab">.TAB</a></kbd> (passing the tab
3319     number as an argument), which breaks the current line,
3320     advances one linespace and calls the tab.</li>
3321 <li>with <kbd><a href="#tn">.TN</a></kbd> (Tab Next), which keeps
3322     you on the current line and moves over to the next
3323     tab in sequence (ie from 1 to 2, 2 to 3, etc.), or, more
3324     conveniently, with the
3325     <kbd><a href="#tn">\*[TB+]</a></kbd>
3326     <a href="definitions.html#inlines">inline escape</a></li>
3327 </ul>
3328
3329 <p>
3330 To exit from tabs and restore your original left margin, line
3331 length, quad direction and fill mode, use
3332 <kbd><a href="#tq">.TQ</a></kbd>
3333 (Tab Quit).
3334 </p>
3335
3336 <p>
3337 Here&#8217;s how the input for our sample employee evaluation looks
3338 (with some introductory parameters):
3339 </p>
3340
3341 <div class="examples" style="margin-bottom: 0px;">Code:</div>
3342 <div class="box-code" style="height: 324px; padding-bottom: 18px; overflow: auto;">
3343 <span class="pre-in-pp">
3344 .PAGE 8.5i 11i 1i 1i 1i
3345 .FAMILY  T
3346 .FT      R
3347 .PT_SIZE 14
3348 .LS      16
3349 .QUAD    LEFT
3350 .KERN
3351 .HY OFF
3352 .SS 0
3353 .TAB_SET 1 0   5P  L
3354 .TAB_SET 2 8P  9P  C
3355 .TAB_SET 3 19P 17P L QUAD
3356 .TAB 1
3357 CRITERION\*[TB+]
3358 EVALUATION\*[TB+]
3359 COMMENTS
3360 .SP
3361 .TAB 1
3362 Service\*[TB+]
3363 Good\*[TB+]
3364 Many clients specifically request support from Joe by name.
3365 .SP
3366 .TAB 1
3367 Punctuality\*[TB+]
3368 Satisfactory\*[TB+]
3369 Tends to arrive after 8:00am, but often works through lunch hour.
3370 .SP
3371 .TAB 1
3372 Team spirit\*[TB+]
3373 Needs work\*[TB+]
3374 Persistently gives higher priority to helping clients
3375 than respecting organizational hierarchy.
3376 .TQ
3377 </span>
3378 </div>
3379
3380 <p>
3381 Try setting this up and processing it it with
3382 <br/>
3383 <span class="pre-in-pp">
3384   pdfmom filename.mom &gt; filename.pdf
3385 </span>
3386 then previewing the .pdf file.  Notice how <kbd>.TN</kbd>
3387 simply moves over to the next tab, while the combination
3388 <kbd>.SP/.TAB&nbsp;1</kbd> breaks the line, advances by one extra
3389 linespace, and calls the first tab.
3390 </p>
3391
3392 <p>
3393 Notice, too, how the <kbd>QUAD</kbd> argument passed to tab 3 means
3394 you don&#8217;t have to worry about the length of
3395 <a href="definitions.html#inputline">input lines</a>;
3396 mom
3397 <a href="definitions.html#filled">fills</a>
3398 the tab and sets the type flush left.
3399 </p>
3400 </div>
3401
3402 <h3 id="string-tabs" class="docs">String tabs (autotabs)</h3>
3403
3404 <p>
3405 String tabs let you mark off tab positions with
3406 <a href="definitions.html#inlines">inline escapes</a>
3407 embedded in
3408 <a href="definitions.html#inputline">input lines</a>.
3409 Left indents and line lengths are calculated from the beginning and
3410 end positions of the marks.  This is especially useful when tab
3411 indents and lengths need to be determined from the text that goes in
3412 each tab.
3413 </p>
3414
3415 <p>
3416 Setting up string tabs is a two-step procedure.  First, you enter an
3417 input line in which you mark off where you want tabs to begin and
3418 end.  (This is often best done in conjunction with the
3419 <a href="goodies.html#silent">SILENT</a>
3420 macro.)
3421 </p>
3422
3423 <p>
3424 Next, you invoke the
3425 <a href="#st">ST</a>
3426 macro for every string tab you defined, and optionally pass quad and
3427 fill information to it.  That done, string tabs are called with the
3428 <a href="#tab">TAB</a>
3429 macro, just like typesetting tabs.
3430 </p>
3431
3432 <p>
3433 In combination with the
3434 <a href="goodies.html#pad">PAD</a>
3435 macro and the groff inline escape
3436 <kbd><a href="inlines.html#inline-horizontal-groff">\h</a></kbd>
3437 (move horizontally across the page) or mom&#8217;s
3438 <kbd><a href="inlines.html#inline-horizontal-mom">\*[FWD &lt;distance&gt;]</a></kbd>
3439 (move forward) inline, string tabs provide tremendous flexibility in
3440 setting up complex tab structures.
3441 </p>
3442
3443 <div class="examples-container">
3444 <h3 id="string-tabs-tut" class="docs notes">Quickie tutorial on string tabs</h3>
3445 <p style="margin-top: .5em;">
3446 Say you want to set up tabs for the
3447 <a href="#typsetting-tabs-sample">employee evaluation form</a>
3448 used as an example in the
3449 <a href="#typesetting-tabs-tut">typesetting tabs tutorial</a>.
3450 This time, though, you want to play around with the point size of
3451 type, so you can&#8217;t know exactly how long the tabs will be or
3452 where they should start.  All you know is
3453 </p>
3454 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
3455 <li>CRITERION is the longest line in tab 1</li>
3456 <li>EVALUATION is the longest line in tab 2</li>
3457 <li>tab 3 should extend to the current right margin</li>
3458 <li>you want a 1 pica gutter between each tab</li>
3459 </ul>
3460
3461 <p>
3462 This is an ideal job for string tabs.
3463 </p>
3464
3465 <p>
3466 The first thing you need for string tabs is an
3467 <a href="definitions.html#inputline">input line</a>
3468 with tab positions marked on it.  Tabs are marked with the
3469 <a href="definitions.html#inlines">inline escapes</a>
3470 <kbd><a href="#inline-st">\*[ST&lt;n&gt;]</a></kbd>
3471 and
3472 <kbd><a href="#inline-st">\*[ST&lt;n&gt;X]</a></kbd>,
3473 where <kbd>&lt;n&gt;</kbd>
3474 is the number you want the tab to have.  (In this example, we
3475 enclose the input line with the
3476 <a href="goodies.html#silent">SILENT</a>
3477 macro so the line doesn&#8217;t print.  We also use the
3478 <a href="goodies.html#pad">PAD</a>
3479 macro to permit defining tab 3 as simply &#8220;the amount of space
3480 remaining on the input line.&#8221;)
3481 </p>
3482
3483 <p>
3484 The setup looks like this:
3485 </p>
3486
3487 <div class="examples" style="margin-bottom: 0px;">Code:</div>
3488
3489 <div class="box-code">
3490 <span class="pre-in-pp">
3491 .SILENT
3492 .PAD "\*[ST1]CRITERION\*[ST1X]\*[FWD 12p]\*[ST2]EVALUATION\*[ST2X]\*[FWD 12p]\*[ST3]#\*[ST3X]"
3493 .SILENT OFF
3494 </span>
3495 </div>
3496
3497 <p>
3498 The long line after <kbd>.PAD</kbd> looks scary, but
3499 it isn&#8217;t really.  Here&#8217;s what it means when broken down
3500 into its component parts:
3501 </p>
3502 <ul style="margin-bottom: -1em;">
3503 <li>The longest line in tab 1 is &#8220;CRITERION&#8221;, so we
3504     enclose CRITERION with begin/end markers for string tab 1:
3505 <br/>
3506 <span class="pre-in-pp" style="margin-bottom: -.25em;">
3507   \*[ST1]CRITERION\*[ST1X]
3508 </span>
3509 </li>
3510 <li>We want a 1 pica (12 points) gutter between tab 1 and 2,
3511     so we insert 12 points of space with \*[FWD 12p]:
3512 <br/>
3513 <span class="pre-in-pp" style="margin-bottom: -.25em;">
3514   \*[FWD 12p]
3515 </span>
3516 </li>
3517 <li>The longest line in tab 2 is &#8220;EVALUATION&#8221;, so
3518     we enclose EVALUATION with begin/end markers for string
3519     tab 2:
3520 <span class="pre-in-pp" style="margin-bottom: -.25em;">
3521   \*[ST2]EVALUATION\*[ST2X]
3522 </span>
3523 </li>
3524 <li>We want 1 pica (12 points) between tab 2 and 3, so we
3525     insert it with:
3526 <br/>
3527 <span class="pre-in-pp" style="margin-bottom: -.25em;">
3528   \*[FWD 12p]
3529 </span>
3530 </li>
3531 <li>We want tab 3 to be as long as whatever space remains on
3532     the current line length, so we enclose the
3533     <a href="goodies.html#pad-marker">pad marker</a>
3534     (#) with begin/end markers for string tab 3:
3535 <span class="pre-in-pp">
3536   \*[ST3]#\*[ST3X]
3537 </span>
3538    </li>
3539 </ul>
3540
3541 <p>
3542 The tabs are now defined, but they require
3543 <a href="definitions.html#quad">quad direction</a>
3544 and
3545 <a href="definitions.html#filled">fill</a>
3546 information.  For each string tab defined above, enter a separate
3547 <kbd><a href="#st">.ST</a></kbd>
3548 line, like this:
3549 <br/>
3550 <span class="pre-in-pp">
3551   .ST  1  L
3552   .ST  2  L
3553   .ST  3  L  QUAD
3554        |  |   |
3555        |  |   +--fill output lines
3556        |  |
3557 tab #--+  +--direction
3558 </span>
3559 From here on in, you call the tabs with
3560 <kbd><a href="#tab">.TAB</a></kbd>,
3561 <kbd><a href="#tn">.TN</a></kbd>,
3562 or
3563 <kbd><a href="#tn">\*[TB+]</a></kbd>
3564 just like typesetting tabs (see
3565 <a href="#typesetting-tabs-tut">typesetting tabs tutorial</a>).
3566 </p>
3567
3568 <p>
3569 Here&#8217;s the complete setup and entry for the sample employee
3570 evaluation form utilizing string tabs.
3571 </p>
3572
3573 <div class="examples" style="margin-bottom: 0px;">Code:</div>
3574 <div class="box-code" style="height: 324px; padding-bottom: 18px; overflow: scroll;">
3575 <span class="pre-in-pp">
3576 .PAGE 8.5i 11i 1i 1i 1i
3577 .FAMILY  T
3578 .FT      R
3579 .PT_SIZE 14
3580 .LS      16
3581 .QUAD    LEFT
3582 .KERN
3583 .HY OFF
3584 .SS 0
3585 .SILENT
3586 .PAD "\*[ST1]CRITERION\*[ST1X]\*[FWD 12p]\*[ST2]EVALUATION\*[ST2X]\*[FWD 12p]\*[ST3]#\*[ST3X]"
3587 .SILENT OFF
3588 .ST  1  L
3589 .ST  2  L
3590 .ST  3  L  QUAD
3591 .TAB 1
3592 CRITERION\*[TB+]
3593 EVALUATION\*[TB+]
3594 COMMENTS
3595 .SP
3596 .TAB 1
3597 Service\*[TB+]
3598 Good\*[TB+]
3599 Many clients specifically request support from Joe by name.
3600 .SP
3601 .TAB 1
3602 Punctuality\*[TB+]
3603 Satisfactory\*[TB+]
3604 Tends to arrive after 8:00am, but often works through lunch hour.
3605 .SP
3606 .TAB 1
3607 Team spirit\*[TB+]
3608 Needs work\*[TB+]
3609 Persistently gives higher priority to helping clients
3610 than respecting organizational hierarchy.
3611 .TQ
3612 </span>
3613 </div>
3614
3615 <p>
3616 Try setting this up and processing it with
3617 <br/>
3618 <span class="pre-in-pp">
3619   pdfmom filename.mom &gt; filename.pdf
3620 </span>
3621 and previewing the .pdf file.
3622 </p>
3623
3624 <p>
3625 Now, change the point size of the above sample to 12 and preview it
3626 again.  You&#8217;ll see that the tab structure remains identical
3627 (tab 1=CRITERION, tab 2=EVALUATION, tab 3=space remaining, and the
3628 gutter between tabs is still 1 pica), while the position and length
3629 of the tabs have altered because of the new point size.
3630 </p>
3631
3632 <p>
3633 Now try increasing the gutters to 2 picas
3634 (<kbd>\*[FWD&nbsp;24p]</kbd> or <kbd>\*[FWD&nbsp;2P]</kbd> instead
3635 of <kbd>\*[FWD&nbsp;12p]</kbd>).  Preview the file again, and notice
3636 how the tab structure remains the same, but the gutters are wider.
3637 </p>
3638 </div>
3639
3640 <div id="index-tabs" class="macro-list-container">
3641 <h3 class="macro-list">Tabs macros</h3>
3642
3643 <ul class="macro-list">
3644   <li><a href="#tab-set">TAB_SET</a> &ndash; create typesetting tabs</li>
3645   <li><a href="#inline-st">\*[ST]...\*[STX]</a> &ndash; inline escapes for marking String Tabs</li>
3646   <li><a href="#st">ST</a> &ndash; set String Tabs</li>
3647   <li><a href="#tab">TAB</a> &ndash; call tabs</li>
3648   <li><a href="#tn">TN</a> &ndash; Tab Next; call next tab in sequence</li>
3649   <li><a href="#tn">\*[TB+]</a> &ndash; inline escape to call next tab in sequence</li>
3650   <li><a href="#tq">TQ</a> &ndash; Tab Quit</li>
3651 </ul>
3652
3653 </div>
3654
3655 <!-- -TAB_SET- -->
3656
3657 <div class="macro-id-overline">
3658 <h3 id="tab-set" class="macro-id">Set up typesetting tabs</h3>
3659 </div>
3660
3661 <div class="box-macro-args">
3662 Macro: <b>TAB_SET</b> <kbd class="macro-args">&lt;tab number&gt; &lt;indent&gt; &lt;length&gt;  L | R | C | J [ QUAD ]</kbd>
3663 </div>
3664 <p class="requires">
3665 &bull;&nbsp;<kbd style="font-style: normal;">&lt;indent&gt;</kbd> and <kbd style="font-style: normal;">&lt;length&gt;</kbd> require a <a href="definitions.html#unitofmeasure">unit of measure</a>
3666 </p>
3667
3668 <p style="margin-bottom: -.5em;">
3669 TAB_SET creates typesetting tabs that later can be called with
3670 <kbd><a href="#tab">.TAB</a></kbd>.
3671 Typesetting tabs are numbered, and defined by an indent, a length,
3672 and a quad direction, hence TAB_SET has four required arguments:
3673 </p>
3674 <ul style="margin-top: .5em; margin-bottom: -.5em;">
3675 <li>a tab number</li>
3676 <li>an indent (measured from the left margin of the page,
3677     or, if you&#8217;re already in a tab, from the left margin of the tab)</li>
3678 <li>a length</li>
3679 <li>a direction</li>
3680 </ul>
3681
3682 <p>
3683 To set up a centred tab 6 picas long and 9 points from the left
3684 margin, you&#8217;d enter
3685 <br/>
3686 <span class="pre-in-pp">
3687   .TAB_SET 1 9p 6P C
3688 </span>
3689 The tab number in the above (&#8221;1&#8221;) is simply an
3690 identifier.  It could have been 4, or 17, or 296.  There&#8217;s no
3691 need to set up tabs in numerical sequence.
3692 </p>
3693
3694 <p>
3695 By default, tabs are in
3696 <a href="definitions.html#filled">nofill</a>
3697 mode, meaning you can enter text in tabs on a line-for-line basis
3698 without having to use the
3699 <a href="#br">BR</a>
3700 macro.  If you want a tab to be
3701 <a href="definitions.html#filled">filled</a>,
3702 pass the optional argument <kbd>QUAD</kbd>,
3703 which will make the tab behave as if you&#8217;d entered
3704 <kbd class="bold">.QUAD&nbsp;L&nbsp;|&nbsp;R&nbsp;|&nbsp;C</kbd>.
3705 </p>
3706
3707 <p>
3708 For
3709 <a href="definitions.html#just">justified</a>
3710 tabs, simply pass the argument J (without the QUAD argument), like
3711 this:
3712 <br/>
3713 <span class="pre-in-pp">
3714   .TAB 1 9p 6P J
3715 </span>
3716 Once tabs are set, they can be called at any time with the
3717 <a href="#tab">TAB &lt;n&gt;</a>
3718 macro, where &lt;n&gt; is the number of the desired tab.
3719 </p>
3720
3721 <p>
3722 You can set up any number of typesetting tabs.  However, be aware
3723 that
3724 <a href="#string-tabs">string tabs</a>
3725 are also called with TAB &lt;n&gt;, so be careful that you
3726 don&#8217;t set up a typesetting tab numbered, say, 4, when you
3727 already have a string tab numbered 4.  Every tab, typesetting or
3728 string, must have a unique numeric identifier. </p>
3729
3730 <div class="box-tip">
3731 <p class="tip">
3732 <span class="note">Note:</span> If you use TAB_SET while
3733 you&#8217;re currently inside a tab, the indent argument is the
3734 distance from the tab&#8217;s left margin, not the left margin of
3735 the page.  Therefore, you should exit tabs (with
3736 <kbd><a href="#tq">.TQ</a></kbd>)
3737 before creating new tabs (unless, of course, you want to set up a
3738 tab structure within the confines of an existing tab).
3739 </p>
3740 </div>
3741
3742 <div class="box-important">
3743 <p class="tip">
3744 <span class="important">IMPORTANT:</span> Turn all indents off (see
3745 <a href="#indents">Indents</a>)
3746 before setting up tabs with TAB_SET, or mom may get confused.
3747 </p>
3748 </div>
3749
3750 <!-- -INLINE_ST- -->
3751
3752 <div class="macro-id-overline">
3753 <h3 id="inline-st" class="macro-id">Mark positions of string tabs</h3>
3754 </div>
3755
3756 <div class="box-macro-args">
3757 Inlines: <kbd class="macro-args">\*[ST&lt;number&gt;]...\*[ST&lt;number&gt;X]</kbd>
3758 </div>
3759
3760 <p class="requires">
3761 The <a href="definitions.html#quad">quad</a>
3762 direction must be
3763 <span style="font-style: normal">LEFT</span>
3764 or
3765 <span style="font-style: normal">JUSTIFY</span>
3766 (see
3767 <a href="#quad"><span style="font-style: normal">QUAD</span></a>
3768 and
3769 <a href="#justify"><span style="font-style: normal">JUSTIFY</span></a>)
3770 or the
3771 <a href="definitions.html#filled">no-fill mode</a>
3772 set to
3773 <a href="#lrc"><span style="font-style: normal">LEFT</span></a>
3774 in order for these inlines to function properly.  Please see
3775 <a href="#important"><span style="font-style: normal">IMPORTANT</span></a>,
3776 below.
3777 </p>
3778
3779 <p>
3780 String tabs need to be marked off with
3781 <a href="definitions.html#inlines">inline escapes</a>
3782 before being set up with the
3783 <a href="#st">ST</a>
3784 macro.  Any input line may contain string tab markers. <kbd
3785 class="bold">&lt;number&gt;</kbd>, above, means the numeric
3786 identifier of the tab.  The following shows a sample input line with
3787 string tab markers.
3788 <br/>
3789 <span class="pre-in-pp">
3790   \*[ST1]Now is the time\*[ST1X] for all \*[ST2]good men\*ST2X] to come to the aid of the party.
3791 </span>
3792 String tab 1 begins at the start of the line and ends after the word
3793 &#8220;time&#8221;.  String tab 2 starts at &#8220;good&#8221; and
3794 ends after &#8220;men&#8221;.  Inline escapes (e.g., font or point
3795 size changes, or horizontal movements, including
3796 <a href="goodies.html#pad">padding</a>)
3797 are taken into account when mom determines the position and length
3798 of string tabs.
3799 </p>
3800
3801 <p>
3802 Up to nineteen string tabs may be marked (not necessarily all on the
3803 same line, of course), and they must be numbered between 1 and 19.
3804 </p>
3805
3806 <p>
3807 Once string tabs have been marked in input lines, they have to be
3808 &#8220;set&#8221; with
3809 <kbd><a href="#st">.ST</a></kbd>,
3810 after which they may be called, by number, with
3811 <kbd><a href="#tab">.TAB</a></kbd>.
3812 </p>
3813
3814 <div class="box-tip">
3815 <p class="tip">
3816 <span class="note">Note:</span> Lines with string tabs marked off
3817 in them are normal input lines, ie they get printed, just like
3818 any input line.  If you want to set up string tabs without the line
3819 printing, use the
3820 <a href="goodies.html#silent">SILENT</a>
3821 macro.
3822 </p>
3823 </div>
3824
3825 <div class="box-important">
3826 <p class="tip-top">
3827 <span id="important" class="important">IMPORTANT:</span>
3828 Owing to the way groff processes
3829 <a href="definitions.html#inputline">input lines</a>
3830 and turns them into
3831 <a href="definitions.html#outputline">output lines</a>,
3832 it is not possible for mom to &#8220;guess&#8221; the correct
3833 starting position of string tabs marked off in lines that are
3834 centered or set flush right.
3835 </p>
3836
3837 <p>
3838 Equally, she cannot guess the starting position if a line is fully
3839 justified and broken with
3840 <a href="#spread">SPREAD</a>.
3841 </p>
3842
3843 <p>
3844 In other words, in order to use string tabs,
3845 <a href="#lrc">LEFT</a>
3846 must be active, or, if
3847 <a href="#quad">QUAD LEFT</a>
3848 or
3849 <a href="#justify">JUSTIFY</a>
3850 are active, the line on which the string tabs are marked must be
3851 broken &#8220;manually&#8221; with
3852 <kbd><a href="#br">.BR</a></kbd>
3853 (but not
3854 <kbd><a href="#spread">.SPREAD</a></kbd>).
3855 </p>
3856
3857 <p class="tip-bottom">
3858 To circumvent this behaviour, I recommend using the
3859 <a href="goodies.html#pad">PAD</a>
3860 to set up string tabs in centered or flush right lines.  Say, for
3861 example, you want to use a string tab to underscore the text of a
3862 centered line with a rule.  Rather than this,
3863 <br/>
3864 <span class="pre-in-pp">
3865   .CENTER
3866   \*[ST1]A line of text\*[ST1X]\c
3867   .EL
3868   .ST 1
3869   .TAB 1
3870   .PT_SIZE 24
3871   .ALD 3p
3872   \*[RULE]
3873   .RLD 3p
3874   .TQ
3875 </span>
3876 you should do:
3877 <br/>
3878 <span class="pre-in-pp">
3879   .QUAD CENTER
3880   .PAD "#\*[ST1]A line of text\*[ST1X]#"
3881   .EL
3882   .ST 1
3883   .TAB 1
3884   .PT_SIZE 24
3885   .ALD 3p
3886   \*[RULE] \" Note that you can&#8217;t use \*[UP ] or \*[DOWN] with \*[RULE]
3887   .RLD 3p
3888   .TQ
3889 </span>
3890 </p>
3891 </div>
3892
3893 <!-- -ST- -->
3894
3895 <div class="macro-id-overline">
3896 <h3 id="st" class="macro-id">Set string tabs</h3>
3897 </div>
3898
3899 <div class="box-macro-args">
3900 Macro: <b>ST</b> <kbd class="macro-args">&lt;tab number&gt;  L | R | C | J [ QUAD ]</kbd>
3901 </div>
3902
3903 <p>
3904 After string tabs have been marked off on an input line (see
3905 <a href="#inline-st"><kbd>\*[ST]...\*[STX]</kbd></a>),
3906 you need to &#8220;set&#8221; them by giving them a direction and,
3907 optionally, the <kbd>QUAD</kbd> argument.  In this respect, ST is
3908 like
3909 <a href="#tab-set">TAB_SET</a>
3910 except that you don&#8217;t have to give ST an indent or a
3911 line length (that&#8217;s already taken care of, inline, by
3912 <kbd>\*[ST]...\*[STX]</kbd>).  If you want string tab 1 to be left,
3913 enter
3914 <br/>
3915 <span class="pre-in-pp">
3916   .ST 1 L
3917 </span>
3918 If you want it to be left and
3919 <a href="definitions.html#filled">filled</a>, enter
3920 <br/>
3921 <span class="pre-in-pp">
3922   .ST 1 L QUAD
3923 </span>
3924 If you want it to be justified, enter
3925 <br/>
3926 <span class="pre-in-pp">
3927   .ST 1 J
3928 </span>
3929 See the
3930 <a href="#string-tabs-tut">Quickie tutorial on string tabs</a>
3931 for a full explanation of setting up string tabs.
3932 </p>
3933
3934 <!-- -TAB- -->
3935
3936 <div class="macro-id-overline">
3937 <h3 id="tab" class="macro-id">Call tabs</h3>
3938 </div>
3939
3940 <div class="box-macro-args">
3941 Macro: <b>TAB</b> <kbd class="macro-args">&lt;tab number&gt;</kbd>
3942 </div>
3943 <p class="alias">
3944 <i>Alias:</i> <b>TB</b>
3945 </p>
3946
3947 <p>
3948 After tabs have been defined (either with
3949 <a href="#tab-set">TAB_SET</a>
3950 or
3951 <a href="#st">ST</a>),
3952 TAB moves to whatever tab number you pass it as an argument.  For
3953 example,
3954 <br/>
3955 <span class="pre-in-pp">
3956   .TAB 3
3957 </span>
3958 moves you to tab 3.
3959 </p>
3960
3961 <div id="note-tn" class="box-tip">
3962 <p class="tip-top">
3963 <span class="note">Note:</span> TAB breaks the line preceding it and
3964 advances 1 linespace.  Hence,
3965 <br/>
3966 <span class="pre-in-pp">
3967   .TAB 1
3968   A line of text in tab 1.
3969   .TAB 2
3970   A line of text in tab 2.
3971 </span>
3972 produces, on output
3973 <br/>
3974 <span class="pre-in-pp">
3975   A line of text in tab 1.
3976                              A line of text in tab 2.
3977 </span>
3978 If you want the tabs to line up, use
3979 <a href="#tn">TN</a>
3980 (Tab Next)
3981 or, more conveniently, the inline escape
3982 <a href="#tn">\*[TB+]</a>:
3983 <br/>
3984 <span class="pre-in-pp">
3985   .TAB 1
3986   A line of text in tab 1.\*[TB+]
3987   A line of text in tab 2.
3988 </span>
3989 which produces
3990 <br/>
3991 <span class="pre-in-pp">
3992   A line of text in tab 1.   A line of text in tab 2.
3993 </span>
3994 If the text in your tabs runs to several lines, and you want the
3995 first lines of each tab to align, you must use the
3996 <a href="#multicolumns-intro">multi-column</a> macros.
3997 </p>
3998
3999 <p id="tab-add-note" class="tip-bottom">
4000 <span class="additional-note">Additional note:</span> Any indents
4001 in effect prior to calling a tab are automatically turned off by
4002 TAB.  If you were happily zipping down the page with a left indent
4003 of 2 picas turned on, and you call a tab whose indent from the left
4004 margin is 6 picas, your new distance from the left margin will be 6
4005 picas, not 6 picas plus the 2 pica indent.
4006 </p>
4007 </div>
4008
4009 <!-- -TN- -->
4010
4011 <div class="macro-id-overline">
4012 <h3 id="tn" class="macro-id">Tab Next</h3>
4013 </div>
4014
4015 <div class="box-macro-args">
4016 Macro: <b>TN</b>
4017 <br/>Inline escape: <b>\*[TB+]</b>
4018 </div>
4019
4020 <p>
4021 TN moves over to the next tab in numeric sequence (tab n+1) without
4022 advancing on the page.  See the
4023 <a href="#note-tn">NOTE</a>
4024 in the description of the TAB macro for an example of how TN works.
4025 </p>
4026
4027 <p>
4028 In tabs that aren&#8217;t given the <kbd class="normal">QUAD</kbd>
4029 argument when they&#8217;re set up with
4030 <a href="#tab-set" class="normal">TAB_SET</a>
4031 or
4032 <a href="#st" class="normal">ST</a>,
4033 you must terminate the line preceding <kbd class="normal">.TN</kbd>
4034 with the <kbd class="normal">\c</kbd> inline escape.  Conversely,
4035 if you did give a <kbd>QUAD</kbd> argument to TAB_SET or ST, the
4036 <kbd>\c</kbd> must not be used.
4037 </p>
4038
4039 <p>
4040 If you find remembering whether to put in the
4041 <kbd class="normal">\c</kbd> bothersome, you may prefer to use the
4042 <a href="definitions.html#inlines" class="normal">inline escape</a>
4043 alternative to
4044 <kbd class="normal">.TN</kbd>,
4045 <kbd class="normal"><a href="inlines.html#tb-plus-mom">\*[TB+]</a></kbd>,
4046 which works consistently regardless of the fill mode.
4047 </p>
4048
4049 <div id="tn-note" class="box-tip">
4050 <p class="tip">
4051 <span class="note">Note:</span> You must put text in the
4052 <a href="definitions.html#inputline">input line</a>
4053 immediately after TN. Stacking of TN&#8217;s is not
4054 allowed.  In other words, you cannot do
4055 <br/>
4056 <span class="pre-in-pp">
4057   .TAB 1
4058   Some text\c
4059   .TN
4060   Some more text\c
4061   .TN
4062   .TN
4063   Yet more text
4064 </span>
4065 The above example, assuming tabs numbered from 1 to 4, should be entered
4066 <br/>
4067 <span class="pre-in-pp">
4068   .TAB 1
4069   Some text\c
4070   .TN
4071   Some more text\c
4072   .TN
4073   \&\c
4074   .TN
4075   Yet more text
4076 </span>
4077
4078 <kbd>\&</kbd> is a zero-width, non-printing character that groff
4079 recognizes as valid input, hence meets the requirement for input
4080 text following <kbd>.TN</kbd>.
4081 </p>
4082 </div>
4083
4084 <!-- -TQ- -->
4085
4086 <div class="macro-id-overline">
4087 <h3 id="tq" class="macro-id">Tab Quit</h3>
4088 </div>
4089
4090 <div class="box-macro-args">
4091 Macro: <b>TQ</b>
4092 </div>
4093
4094 <p>
4095 TQ takes you out of whatever tab you were in, advances 1 linespace,
4096 and restores the left margin, line length, quad direction and
4097 <a href="definitions.html#filled">fill mode</a>
4098 that were in effect prior to invoking any tabs.
4099 </p>
4100
4101 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
4102
4103 <!-- ==================================================================== -->
4104
4105 <h2 id="multicolumns-intro" class="macro-group">Multiple columns</h2>
4106
4107 <p>
4108 Tabs are not by nature columnar, which is to say that if the text
4109 inside a tab runs to several lines, calling another tab does not
4110 automatically move to the
4111 <a href="definitions.html#baseline">baseline</a>
4112 of the first line in the previous tab.  To demonstrate:
4113 <br/>
4114 <span class="pre-in-pp">
4115   .TAB 1
4116   Carrots
4117   Potatoes
4118   Broccoli
4119   .TAB 2
4120   $1.99/5 lbs
4121   $0.25/lb
4122   $0.99/bunch
4123 </span>
4124 produces, on output
4125 <br/>
4126 <span class="pre-in-pp">
4127   Carrots
4128   Potatoes
4129   Broccoli
4130             $1.99/5 lbs
4131             $0.25/lb
4132             $0.99/bunch
4133 </span>
4134 The multi-column macros allow you to set tabs in columnar fashion,
4135 rather than line by line.  When you invoke multi-column mode (with
4136 <kbd><a href="#mco">.MCO</a></kbd> &ndash;
4137 <span style="text-decoration: underline">M</span>ulti-<span style="text-decoration: underline">C</span>olumn <span style="text-decoration: underline">O</span>n),
4138 mom saves the position of the current baseline.
4139 <kbd><a href="#mcr">.MCR</a></kbd>
4140 (<span style="text-decoration: underline">M</span>ulti-<span style="text-decoration: underline">C</span>olumn <span style="text-decoration: underline">R</span>eturn)
4141 at any point while multi-columns are on returns you to the saved
4142 position.  Exiting multi-columns
4143 (<kbd><a href="#mcx">.MCX</a></kbd> &ndash;
4144 <span style="text-decoration: underline">M</span>ulti-<span style="text-decoration: underline">C</span>olumn e<span style="text-decoration: underline">X</span>it)
4145 quits the current tab (if you&#8217;re in one) and moves you to the
4146 bottom of the longest column.  (Note that you do not have to use
4147 multi-columns in conjunction with tabs.)
4148 </p>
4149
4150 <p>
4151 Using our example above, but setting it in multi-column mode,
4152 <br/>
4153 <span class="pre-in-pp">
4154   .MCO
4155   .TAB 1
4156   Carrots
4157   Potatoes
4158   Broccoli
4159   .MCR
4160   .TAB 2
4161   $1.99/5 lbs
4162   $0.25/lb
4163   $0.99/bunch
4164   .MCX
4165 </span>
4166 produces
4167 <br/>
4168 <span class="pre-in-pp">
4169   Carrots   $1.99/5 lbs
4170   Potatoes  $0.25/lb
4171   Broccoli  $0.99/bunch
4172 </span>
4173 </p>
4174
4175 <div class="box-tip">
4176 <p class="tip">
4177 <span class="note">Note:</span> Do not confuse MCO with
4178 the
4179 <a href="docprocessing.html#columns">COLUMNS</a>
4180 macro in the
4181 <a href="docprocessing.html#docprocessing">document processing macros</a>.
4182 </p>
4183 </div>
4184
4185 <div class="box-tip">
4186 <p class="tip">
4187 <span class="note">Additional Note:</span>
4188 Do not use multi-columns with
4189 <a href="docprocessing.html#slide">DOCTYPE SLIDES</a>
4190 because MCX uses the lowest line on the page to determine column
4191 depth.  Owing to the fact that both headers and footers are printed
4192 prior to slides receiving text, MCX will always go to the
4193 footer position.  If you need functionality similar to MCO/MCX, use
4194 the groff requests <kbd>.mk</kbd> and <kbd>.rt</kbd>.  See
4195 <kbd>info groff --index-search=mk</kbd>.
4196 </p>
4197 </div>
4198
4199 <div id="index-multicolumns" class="macro-list-container">
4200 <h3 class="macro-list">Multi-columns macros</h3>
4201
4202 <ul class="macro-list">
4203   <li><a href="#mco">MCO</a> &ndash; begin multi-column setting</li>
4204   <li><a href="#mcr">MCR</a> &ndash; return to top of column</li>
4205   <li><a href="#mcx">MCX</a> &ndash; exit multi-columns</li>
4206 </ul>
4207 </div>
4208
4209 <!-- -MCO- -->
4210
4211 <div class="macro-id-overline">
4212 <h3 id="mco" class="macro-id">Begin multi-column setting</h3>
4213 </div>
4214
4215 <div class="box-macro-args">
4216         Macro: <b>MCO</b>
4217 </div>
4218
4219 <p>
4220 MCO (<span style="text-decoration: underline;">M</span>ulti-<span style="text-decoration: underline;">C</span>olumn <span style="text-decoration: underline;">O</span>n) is the macro you use to begin multi-column
4221 setting.  It marks the current
4222 <a href="definitions.html#baseline">baseline</a>
4223 as the top of your columns, for use later with
4224 <a href="#mcr">MCR</a>.
4225 See the
4226 <a href="#multicolumns-intro">introduction to columns</a>
4227 for an explanation of multi-columns and some sample
4228 input.
4229 </p>
4230
4231 <div class="box-tip">
4232 <p class="tip">
4233 <span class="note">Note:</span> Do not confuse MCO with
4234 the
4235 <a href="docprocessing.html#columns">COLUMNS</a>
4236 macro in the
4237 <a href="docprocessing.html#docprocessing">document processing macros</a>.
4238 </p>
4239 </div>
4240
4241 <!-- -MCR- -->
4242
4243 <div class="macro-id-overline">
4244 <h3 id="mcr" class="macro-id">Return to top of column</h3>
4245 </div>
4246
4247 <div class="box-macro-args">
4248 Macro: <b>MCR</b>
4249 </div>
4250
4251 <p>
4252 Once you&#8217;ve turned multi-columns on (with
4253 <kbd><a href="#mco">.MCO</a></kbd>),
4254 <kbd>.MCR</kbd>, at any time, returns you to the top of
4255 your columns.
4256 </p>
4257
4258 <!-- -MCX- -->
4259
4260 <div class="macro-id-overline">
4261 <h3 id="mcx" class="macro-id">Exit multi-columns</h3>
4262 </div>
4263
4264 <div class="box-macro-args">
4265 Macro: <b>MCX</b> <kbd class="macro-args">[ &lt;distance to advance below longest column&gt; ]</kbd>
4266 </div>
4267 <p class="requires">
4268 &bull;&nbsp;Optional argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4269 </p>
4270
4271 <p>
4272 MCX takes you out of any tab you were in (by silently invoking
4273 <kbd><a href="#tq">.TQ</a></kbd>)
4274 and advances to the bottom of the longest column.
4275 </p>
4276
4277 <p>
4278 Without an argument, MCX advances 1 linespace below the longest
4279 column.  Linespace, in this instance, is the
4280 <a href="definitions.html#leading">leading</a>
4281 in effect at the moment MCX is invoked.
4282 </p>
4283
4284 <p>
4285 If you pass the <kbd>&lt;distance&gt;</kbd> argument to MCX, it
4286 advances 1 linespace below the longest column (see above) PLUS the
4287 distance specified by the argument.  The argument requires a unit
4288 of measure; therefore, to advance an extra 6 points below where MCX
4289 would normally place you, you&#8217;d enter
4290 <br/>
4291 <span class="pre-in-pp">
4292   .MCX 6p
4293 </span>
4294 </p>
4295
4296 <div class="box-tip">
4297 <p class="tip">
4298 <span class="note">Note:</span> If you wish to advance a precise
4299 distance below the
4300 <a href="definitions.html#baseline">baseline</a>
4301 of the longest column, use MCX with an argument of 0 (zero; no unit
4302 of measure required) in conjunction with the
4303 <a href="#ald">ALD</a>
4304 macro, like this:
4305 <br/>
4306 <span class="pre-in-pp" style="margin-bottom: -12px;">
4307   .MCX 0
4308   .ALD 24p
4309 </span>
4310 </p>
4311 </div>
4312
4313 <p>
4314 The above advances to precisely 24 points below the baseline
4315 of the longest column.
4316 </p>
4317
4318 <div class="rule-short" style="margin-bottom: 24px;"><hr/></div>
4319
4320 <!-- ==================================================================== -->
4321
4322 <h2 id="indents-intro" class="macro-group">Indents</h2>
4323
4324 <p>
4325 With mom&#8217;s indents, you can indent from the left, the right,
4326 or both margins.  In addition, mom provides temporary left indents
4327 (ie only one line is indented, as at the start of a paragraph)
4328 and &#8220;hanging&#8221; left indents (the reverse of a temporary
4329 indent; the first line isn&#8217;t indented, subsequent lines are).
4330 </p>
4331
4332 <h3 id="indents-handling" class="docs">How mom handles indents</h3>
4333
4334 <p>
4335 Mom provides five kinds of indents: left, right, both, temporary,
4336 and hanging.  Each is invoked by its own name:
4337 </p>
4338 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
4339 <li>IL &ndash; Indent Left</li>
4340 <li>IR &ndash; Indent Right</li>
4341 <li>IB &ndash; Indent Both</li>
4342 <li>HI &ndash; Hanging Indent</li>
4343 <li>TI &ndash; Temporary Indent</li>
4344 </ul>
4345
4346 <p>
4347 In addition, there are four macros to control exiting from
4348 indents:
4349 </p>
4350 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
4351 <li>IQ &ndash; quit all active indents</li>
4352 <li>ILX &ndash; exit indent style left</li>
4353 <li>IRX &ndash; exit indent style right</li>
4354 <li>IBX &ndash; exit indent style both</li>
4355 </ul>
4356
4357 <p>
4358 This section deals exclusively with IL, IR and IB.  For an
4359 explanation of hanging and temporary indents&mdash;how they work and
4360 how to use them&mdash;see
4361 <a href="#hi">Hanging indents</a>
4362 and
4363 <a href="#ti">Temporary indents</a>.
4364 </p>
4365
4366 <p>
4367 The first time you invoke any of mom&#8217;s indents, you must
4368 supply a measure.  For example,
4369 <br/>
4370 <span class="pre-in-pp">
4371   .IL 2P
4372 </span>
4373 indents text 2 picas from the left margin (or current tab indent).
4374 </p>
4375
4376 <p>
4377 When you want to exit the above indent, use either
4378 <br/>
4379 <span class="pre-in-pp" style="margin-bottom: -1em;">
4380   .IQ
4381 </span>
4382 or
4383 <span class="pre-in-pp" style="margin-top: -.5em;">
4384   .ILX
4385 </span>
4386 The next time you want the same indent, invoke it without the
4387 argument, like this:
4388 <br/>
4389 <span class="pre-in-pp">
4390   .IL
4391 </span>
4392 As you can see, once you&#8217;ve supplied a measure to an indent
4393 macro, mom stores the value, obviating the need to repeat it on
4394 subsequent invocations.  And mom doesn&#8217;t just store the
4395 measure&mdash;she hangs on to it tenaciously.  Arguments passed to
4396 IL, IR and IB are additive.  Consider the following:
4397 <br/>
4398 <span class="pre-in-pp">
4399   .LL 20P
4400   .IR 2P    \"Indent right by 2 picas
4401   A first block of text...
4402   ...
4403   ...
4404   .IQ       \"Turn indent off
4405   A second block of text...
4406   ...
4407   ...
4408   .IR 2P    \"Indent right by an additional 2 picas (ie 4 picas)
4409   A third block of text...
4410   ...
4411   ...
4412 </span>
4413 The first block of text is right indented by 2 picas (ie the line
4414 length is shortened by 2 picas to 18 picas).  The second block of
4415 text, after IQ, is, as you&#8217;d expect, set to the full measure.
4416 The third block of text&mdash;the one to pay attention to&mdash;is
4417 not right indented by 2 picas, but rather by 4 picas.  Mom adds
4418 the value of arguments to IL, IR and IB to whatever value is already
4419 in effect.
4420 </p>
4421
4422 <p>
4423 If you wanted the third block of text in the example above to be
4424 right indented by just 2 picas (the original measure given to IR),
4425 you would enter <kbd>.IR</kbd> without an argument.
4426 </p>
4427
4428 <p>
4429 Because indent arguments are additive, putting a minus sign in front
4430 of the argument can be used to subtract from the current value.
4431 In the following example, the first line is indented 18 points,
4432 the second is indented 36 points (18 + 18), and the third is again
4433 indented 18 points (36 - 18).
4434 <br/>
4435 <span class="pre-in-pp">
4436   .IL 18p     \"Indent left by 18 points      = 18 points
4437   Now is the time
4438   .IL 18p     \"Indent left by 18 points more = 36 points
4439   for all good men to come
4440   .IL -18p    \"Indent left by 18 points less = 18 points
4441   to the aid of the party.
4442 </span>
4443 Sometimes, you may want to clear out the stored indent
4444 values&mdash;let mom start indenting with a clean slate, as it
4445 were.  Giving the optional argument <kbd>CLEAR</kbd> to any of the
4446 &#8220;indent quit&#8221; macros resets them to zero.
4447 </p>
4448 <ul style="margin-top: -.5em; margin-bottom: -.5em;">
4449   <li>IQ CLEAR &ndash; quit and clear all indents</li>
4450   <li>ILX CLEAR &ndash; quit and clear indent style left</li>
4451   <li>IRX CLEAR &ndash; quit and clear indent style right</li>
4452   <li>IBX CLEAR &ndash; quit and clear indent style both</li>
4453 </ul>
4454
4455 <p>
4456 Indent styles may be combined and manipulated separately.  You
4457 could, for example, have a left indent of 4 picas and a right indent
4458 of 6 picas and control each separately, as in the following example.
4459 <br/>
4460 <span class="pre-in-pp">
4461   .IL 4P     \"Indent left 4 picas
4462   .IR 6P     \"Indent right 6 picas
4463   Some text
4464   .IRX       \"Turn off the right indent only
4465   More text  \"Text is still indented 4 picas left
4466 </span>
4467 If, at <kbd>.IRX</kbd>, you wanted the text afterwards to have no
4468 indents (either left or right), you would enter <kbd>.IQ</kbd>,
4469 which exits all indent styles at once.
4470 </p>
4471
4472 <p>
4473 A word of advice: Indents are best used only when you have a
4474 compelling reason not to change the current left margin or line
4475 length.  In many instances where indents might seem expedient,
4476 it&#8217;s better to use tabs, or actually change the left margin
4477 or the line length. Mom&#8217;s indenting macros are flexible and
4478 powerful, but easy to get tangled up in.
4479 </p>
4480
4481 <div class="box-tip">
4482 <p class="tip">
4483 <span class="note">Note:</span> see the section
4484 <a href="docprocessing.html#behaviour">Typesetting macros during document processing</a>
4485 for information and advice on using indents with the
4486 <a href="docprocessing.html#docprocessing">document processing macros</a>.
4487 </p>
4488 </div>
4489
4490 <div id="index-indents" class="macro-list-container">
4491 <h3 class="macro-list">Indents macros</h3>
4492
4493 <ul class="macro-list">
4494   <li><a href="#il">IL</a> &ndash; Indent left</li>
4495   <li><a href="#ir">IR</a> &ndash; Indent right</li>
4496   <li><a href="#ib">IB</a> &ndash; Indent both</li>
4497   <li><a href="#ti">TI</a> &ndash; Temporary indent, left</li>
4498   <li><a href="#hi">HI</a> &ndash; Hanging Indent
4499   <ul style="margin-left: -.5em; list-style-type: disc;">
4500     <li><a href="#num-lists">Recipe: a numbered list using hanging indents</a></li>
4501   </ul></li>
4502   <li><a href="#iq">IQ</a> &ndash; Quit indents, all</li>
4503   <li><a href="#iq">ILX</a> &ndash; Exit indent style left</li>
4504   <li><a href="#iq">IRX</a> &ndash; Exit indent style right</li>
4505   <li><a href="#iq">IBX</a> &ndash; Exit indent style both</li>
4506 </ul>
4507 </div>
4508
4509 <!-- -IL- -->
4510
4511 <div class="macro-id-overline">
4512 <h3 id="il" class="macro-id">Indent left</h3>
4513 </div>
4514
4515 <div class="box-macro-args">
4516 Macro: <b>IL</b> <kbd class="macro-args">[ &lt;measure&gt; ]</kbd>
4517 </div>
4518 <p class="requires">
4519 &bull;&nbsp;The optional argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4520 </p>
4521
4522 <p>
4523 IL indents text from the left margin of the page, or if you&#8217;re
4524 in a tab, from the left edge of the tab.  Once IL is on, the left
4525 indent is applied uniformly to every subsequent line of text, even
4526 if you change the line length.
4527 </p>
4528
4529 <p>
4530 The first time you invoke <kbd>.IL</kbd>, you must give it a
4531 measure.  Subsequent invocations with a measure add to the previous
4532 measure.  A minus sign may be prepended to the argument to subtract
4533 from the current measure.  The
4534 <kbd><a href="inlines.html#inline-stringwidth-groff">\w</a></kbd>
4535 <a href="definitions.html#inlines">inline escape</a>
4536 may be used to specify a text-dependent measure, in which case no
4537 unit of measure is required.  For example,
4538 <br/>
4539 <span class="pre-in-pp">
4540   .IL \w'margarine'
4541 </span>
4542 indents text by the width of the word &#8220;margarine&#8221;.
4543 </p>
4544
4545 <p>
4546 With no argument, IL after an ILX indents by its last active value.  See the
4547 <a href="#indents-handling">explanation of how mom handles indents</a>
4548 for more details.
4549 </p>
4550
4551 <div class="box-tip">
4552 <p class="tip-top">
4553 <span class="note">Note:</span> Calling a tab (with
4554 <kbd><a href="#tab">.TAB &lt;n&gt;</a></kbd>)
4555 automatically cancels any active indents.
4556 </p>
4557
4558 <p class="tip-bottom">
4559 <span class="additional-note">Additional note:</span> Invoking IL
4560 automatically turns off IB.
4561 </p>
4562 </div>
4563
4564 <!-- -IR- -->
4565
4566 <div class="macro-id-overline">
4567 <h3 id="ir" class="macro-id">Indent right</h3>
4568 </div>
4569
4570 <div class="box-macro-args">
4571 Macro: <b>IR</b> <kbd class="macro-args">[ &lt;measure&gt; ]</kbd>
4572 </div>
4573 <p class="requires">
4574 &bull;&nbsp;The optional argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4575 </p>
4576
4577 <p>
4578 IR indents text from the right margin of the page, or if
4579 you&#8217;re in a tab, from the end of the tab.
4580 </p>
4581
4582 <p>
4583 The first time you invoke <kbd>.IR</kbd>, you must give it a
4584 measure.  Subsequent invocations with a measure add to the previous
4585 indent measure.  A minus sign may be prepended to the argument to
4586 subtract from the current indent measure.  The
4587 <kbd><a href="inlines.html#inline-stringwidth-groff">\w</a></kbd>
4588 <a href="definitions.html#inlines">inline escape</a>
4589 may be used to specify a text-dependent measure, in which case no
4590 unit of measure is required.  For example, <br/>
4591 <span class="pre-in-pp">
4592   .IR \w'jello'
4593 </span>
4594 indents text by the width of the word &#8220;jello&#8221;.
4595 </p>
4596
4597 <p>
4598 With no argument, IR after an IRX indents by its last active value.  See the
4599 <a href="#indents-handling">explanation of how mom handles indents</a>
4600 for more details.
4601 </p>
4602
4603 <div class="box-tip">
4604 <p class="tip-top">
4605 <span class="note">Note:</span> Calling a tab (with
4606 <kbd><a href="#tab">.TAB &lt;n&gt;</a></kbd>)
4607 automatically cancels any active indents.
4608 </p>
4609
4610 <p class="tip-bottom">
4611 <span class="additional-note">Additional note:</span> Invoking IR
4612 automatically turns off IB.
4613 </p>
4614 </div>
4615
4616 <!-- -IB- -->
4617
4618 <div class="macro-id-overline">
4619 <h3 id="ib" class="macro-id">Indent both</h3>
4620 </div>
4621
4622 <div class="box-macro-args">
4623 Macro: <b>IB</b> <kbd class="macro-args">[ &lt;indent-1&gt; &lt;indent-2&gt; ]</kbd>
4624 </div>
4625 <p class="requires">
4626 &bull;&nbsp;The optional arguments require a <a href="definitions.html#unitofmeasure">unit of measure</a>
4627 </p>
4628
4629 <p>
4630 IB allows you to set or invoke a left and a right indent at the same
4631 time.
4632 </p>
4633
4634 <p>
4635 If you supply only an <kbd>indent-1</kbd> argument, the argument is
4636 the amount to indent from both the left and right margins.  If you
4637 give both <kbd>indent-1</kbd> and <kbd>indent-2</kbd>, the first is
4638 the indent from the left margin and the second is the indent from
4639 the right margin.
4640 </p>
4641
4642 <p>
4643 As with IL and IR, the measures are added to the values previously
4644 passed to the macro.  Hence, if you wish to change just one of the
4645 values, you must give an argument of zero to the other.  (A word of
4646 advice: If you need to manipulate left and right indents separately,
4647 use a combination of IL and IR instead of IB.  You&#8217;ll save
4648 yourself a lot of grief.)
4649 </p>
4650
4651 <p>
4652 A minus sign may be prepended to the arguments to subtract from
4653 their current values.  The
4654 <a href="inlines.html#inline-stringwidth-groff"><kbd>\w</kbd></a>
4655 <a href="definitions.html#inlines">inline escape</a>
4656 may be used to specify text-dependent measures, in which case no
4657 unit of measure is required.  For example,
4658 <br/>
4659 <span class="pre-in-pp">
4660   .IB \w&#8217;margarine&#8217; \w'jello'
4661 </span>
4662 left indents text by the width of the word &#8220;margarine&#8221;
4663 and right indents by the width of &#8220;jello&#8221;.
4664 </p>
4665
4666 <p>
4667 Like IL and IR, IB with no argument after an IBX indents by its
4668 last active values.  See the
4669 <a href="#indents-handling">explanation of how mom handles indents</a>
4670 for more details.
4671 </p>
4672
4673 <div class="box-tip">
4674 <p class="tip-top">
4675 <span class="note">Note:</span> Calling a tab (with
4676 <kbd><a href="#tab">.TAB &lt;n&gt;</a></kbd>)
4677 automatically cancels any active indents.
4678 </p>
4679
4680 <p class="tip-bottom">
4681 <span class="additional-note">Additional note:</span> Invoking IB
4682 automatically turns off IL and IR.
4683 </p>
4684 </div>
4685
4686 <!-- -TI- -->
4687
4688 <div class="macro-id-overline">
4689 <h3 id="ti" class="macro-id">Temporary (left) indent</h3>
4690 </div>
4691
4692 <div class="box-macro-args">
4693 Macro: <b>TI</b> <kbd class="macro-args">[ &lt;measure&gt; ]</kbd>
4694 </div>
4695 <p class="requires">
4696 &bull;&nbsp;The optional argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4697 </p>
4698
4699 <p>
4700 A temporary indent is one that applies only to the first line of
4701 text that comes after it.  Its chief use is indenting the first line
4702 of paragraphs.  (Mom&#8217;s
4703 <a href="docelement.html#pp">PP</a>
4704 macro, for example, uses a temporary indent.)
4705 </p>
4706
4707 <p>
4708 The first time you invoke <kbd>.TI</kbd>, you must give
4709 it a measure.  If you want to indent the first line of a paragraph
4710 by, say, 2
4711 <a href="definitions.html#em">ems</a>,
4712 do
4713 <br/>
4714 <span class="pre-in-pp">
4715   .TI 2m
4716 </span>
4717 Subsequent invocations of TI do not require you to supply a measure;
4718 mom keeps track of the last measure you gave it.
4719 </p>
4720
4721 <p>
4722 Because temporary indents are temporary, there&#8217;s no need to
4723 turn them off.
4724 </p>
4725
4726 <div class="box-important">
4727 <p class="tip">
4728 <span class="important">IMPORTANT:</span> Unlike IL, IR and IB,
4729 measures given to TI are NOT additive.  In the following example,
4730 the second <kbd>.TI&nbsp;2P</kbd> is exactly 2 picas.
4731 <br/>
4732 <span class="pre-in-pp" style="margin-bottom: -18px;">
4733   .TI 1P
4734   The beginning of a paragraph...
4735   .TI 2P
4736   The beginning of another paragraph...
4737 </span>
4738 </p>
4739 </div>
4740
4741 <!-- -HI- -->
4742
4743 <div class="macro-id-overline">
4744 <h3 id="hi" class="macro-id">Hanging indent</h3>
4745 </div>
4746
4747 <div class="box-macro-args">
4748 Macro: <b>HI</b> <kbd class="macro-args">[ &lt;measure&gt; ]</kbd>
4749 </div>
4750 <p class="requires">
4751 &bull;&nbsp;The optional argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4752 </p>
4753
4754 <p>
4755 A hanging indent looks like this:
4756 <br/>
4757 <span class="pre-in-pp">
4758   The thousand injuries of Fortunato I had borne as best I
4759     could, but when he ventured upon insult, I vowed
4760     revenge.  You who so well know the nature of my soul
4761     will not suppose, however, that I gave utterance to a
4762     threat, at length I would be avenged...
4763 </span>
4764 The first line of text &#8220;hangs&#8221; outside the left margin.
4765 </p>
4766
4767 <p>
4768 In order to use hanging indents, you must first have a left indent
4769 active (set with either
4770 <kbd><a href="#il">.IL</a></kbd>
4771 or
4772 <kbd><a href="#ib">.IB</a></kbd>).
4773 Mom will not hang text outside the left margin set with
4774 <kbd><a href="#l-margin">.L_MARGIN</a></kbd>
4775 or outside the left margin of a tab.
4776 </p>
4777
4778 <p>
4779 The first time you invoke <kbd>.HI</kbd>, you must give
4780 it a measure.  If you want the first line of a paragraph to hang by,
4781 say, 1 pica, do
4782 <br/>
4783 <span class="pre-in-pp">
4784   .IL 1P
4785   .HI 1P
4786 </span>
4787 Subsequent invocations of HI do not require you to supply a measure;
4788 mom keeps track of the last measure you gave it.
4789 </p>
4790
4791 <p>
4792 Generally speaking, you should invoke HI immediately prior to the
4793 line you want hung (ie without any intervening
4794 <a href="definitions.html#controllines">control lines</a>).
4795 And because hanging indents affect only one line, there&#8217;s no
4796 need to turn them off.
4797 </p>
4798
4799 <div class="box-important">
4800 <p class="tip">
4801 <span class="important">IMPORTANT:</span> Unlike IL, IR and IB,
4802 measures given to HI are NOT additive.  Each time you pass a measure
4803 to HI, the measure is treated literally.
4804 </p>
4805 </div>
4806
4807 <h4 id="num-lists" class="macro-id">Recipe: A numbered list using hanging indents</h4>
4808
4809 <div class="box-tip" style="margin-top: -.5em; margin-bottom: -.5em;">
4810 <p class="tip">
4811 <span class="note">Note:</span> mom has macros for setting lists (see
4812 <a href="docelement.html#list-intro">Nested lists</a>).
4813 This recipe exists to demonstrate the use of hanging indents only.
4814 </p>
4815 </div>
4816
4817 <p style="margin-top: 1.5em;">
4818 <span class="pre-in-pp">
4819   .PAGE 8.5i 11i 1i 1i 1i 1i
4820   .FAMILY  T
4821   .FT      R
4822   .PT_SIZE 12
4823   .LS      14
4824   .JUSTIFY
4825   .KERN
4826   .SS 0
4827   .IL \w'\0\0.'
4828   .HI \w'\0\0.'
4829   1.\0The most important point to be considered is whether the
4830   answer to the meaning of Life, the Universe, and Everything
4831   really is 42.  We have no-one&#8217;s word on the subject except
4832   Mr. Adams&#8217;.
4833   .HI
4834   2.\0If the answer to the meaning of Life, the Universe,
4835   and Everything is indeed 42, what impact does this have on
4836   the politics of representation?  42 is, after all not a
4837   prime number.  Are we to infer that prime numbers don&#8217;t
4838   deserve equal rights and equal access in the universe?
4839   .HI
4840   3.\0If 42 is deemed non-exclusionary, how do we present it
4841   as the answer and, at the same time, forestall debate on its
4842   exclusionary implications?
4843 </span>
4844 First, we invoke a left indent with a measure equal to the width of
4845 2
4846 <a href="definitions.html#figurespace">figures spaces</a>
4847 plus a period (using the
4848 <a href="inlines.html#inline-stringwidth-groff"><kbd>\w</kbd></a>
4849 inline escape).  At this point, the left indent is active; text
4850 afterwards would normally be indented.  However, we invoke a
4851 hanging indent of exactly the same width, which hangs the first
4852 line (and first line only!) to the left of the indent by the
4853 same distance (in this case, that means &#8220;out to the left
4854 margin&#8221;).  Because we begin the first line with a number,
4855 a period, and a figure space, the actual text (&#8220;The most
4856 important point...&#8221;) starts at exactly the same spot as the
4857 indented lines that follow.
4858 </p>
4859
4860 <p>
4861 Notice that subsequent invocations of <kbd>.HI</kbd> don&#8217;t
4862 require a measure to be given.
4863 </p>
4864
4865 <p>
4866 Paste the example above into a file and preview it with
4867 <br/>
4868 <span class="pre-in-pp">
4869   pdfmom filename.mom &gt; filename.pdf
4870 </span>
4871 to see hanging indents in action.
4872 </p>
4873
4874 <!-- -IX- -->
4875
4876 <div class="macro-id-overline">
4877 <h3 id="iq" class="macro-id">Quitting indents</h3>
4878 </div>
4879
4880 <div class="box-macro-args">
4881 Macro: <b>IQ</b> <kbd class="macro-args">[ CLEAR ]</kbd> (quit any/all indents &mdash; see IMPORTANT NOTE)
4882 </div>
4883 <br/>
4884
4885 Macro: <b>ILX</b> <kbd class="macro-args">[ CLEAR ]</kbd> (exit Indent Left)
4886 <br/>
4887
4888 Macro: <b>IRX</b> <kbd class="macro-args">[ CLEAR ]</kbd> (exit Indent Right)
4889 <br/>
4890
4891 Macro: <b>IBX</b> <kbd class="macro-args">[ CLEAR ]</kbd> (exit Indent Both)
4892
4893 <div class="box-important">
4894 <p class="tip-top">
4895 <span class="important">IMPORTANT NOTE:</span> The original macro
4896 for quitting all indents was IX.  This usage has been deprecated in
4897 favour of IQ.  IX will continue to behave as before, but mom will
4898 issue a warning to stderr indicating that you should update your
4899 documents.
4900 </p>
4901
4902 <p class="tip-bottom">
4903 As a consequence of this change, ILX, IRX and IBX may now also be
4904 invoked as ILQ, IRQ and IBQ.  Both forms are acceptable.
4905 </p>
4906 </div>
4907
4908 <p>
4909 Without an argument, the macros to quit indents merely restore your
4910 original margins and line length.  The measures stored in the indent
4911 macros themselves are saved so you can call them again without
4912 having to supply a measure.
4913 </p>
4914
4915 <p>
4916 If you pass these macros the optional argument <kbd>CLEAR</kbd>,
4917 they not only restore your original left margin and line length, but
4918 also clear any values associated with a particular indent style.
4919 The next time you need an indent of the same style, you have to
4920 supply a measure again.
4921 </p>
4922
4923 <p>
4924 <kbd>.IQ&nbsp;CLEAR</kbd>, as you&#8217;d suspect,
4925 quits and clears the values for all indent styles at once.
4926 </p>
4927
4928 <div class="rule-long"><hr/></div>
4929
4930 <!-- Navigation links -->
4931 <table style="width: 100%; margin-top: 12px;">
4932 <tr>
4933   <td style="width: 33%;"><a href="toc.html">Back to Table of Contents</a></td>
4934   <td style="width: 33%; text-align: center;"><a href="#top">Top</a></td>
4935   <td style="width: 33%; text-align: right;"><a href="goodies.html#top">Next: Goodies</a></td>
4936 </tr>
4937 </table>
4938
4939 </div>
4940
4941 <div class="bottom-spacer"><br/></div>
4942
4943 </body>
4944 </html>