1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
|
<?xml version="1.0" encoding="utf-8"?>
<!--
This file is part of groff, the GNU roff type-setting system.
Copyright (C) 2004-2020 Free Software Foundation, Inc.
Written by Peter Schaffter (peter@schaffter.ca).
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.
A copy of the Free Documentation License is included as a file called
FDL in the main directory of the groff source package.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
<title>Mom -- Inline escapes</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>
<body style="background-color: #f5faff;">
<!-- ==================================================================== -->
<div id="top" class="page">
<!-- Navigation links -->
<table style="width: 100%;">
<tr>
<td><a href="toc.html">Back to Table of Contents</a></td>
<td style="text-align: right;"><a href="color.html#top">Next: Coloured text</a></td>
</tr>
</table>
<h1 id="inline-escapes" class="docs">Inline escapes</h1>
<div style="text-align: center;">
<a href="#index-inlines">List of inline escapes</a>
</div>
<div class="rule-medium"><hr/></div>
<h2 id="intro-inlines" class="docs">Introduction</h2>
<p>
Inline escapes, as described in the
<a href="definitions.html#inlines">groff terms</a>
section of this manual, are typesetting commands that appear in text
<a href="definitions.html#inputline">input lines</a>,
as opposed to macros and other
<a href="definitions.html#controllines">control lines</a>
that must appear on lines by themselves.
</p>
<p>
Aside from altering type parameters within a line, inlines also tell
groff about special characters—em-dashes, bullets,
<a href="definitions.html#figurespace">figure/digit-width spaces</a>,
and so on. It is beyond the scope of this manual to provide
a complete list of groff’s inline functions and special
characters. I recommend having a look at the
<a href="intro.html#canonical">canonical reference materials</a>
should you need more information than is contained herein.
</p>
<p>
In groff, the escape character is the backslash (<kbd>\</kbd>).
Groff interprets everything following the backslash as instructions,
not literal text, until the escape sequence is complete. Should
you need the actual backslash character as part of a line of text,
simply enter it twice (<kbd>\\</kbd>). Groff understands that this
means “please print a backslash character.”
</p>
<p>
You can also use <kbd>\e</kbd> to print a literal backslash, or use
<a href="goodies.html#esc-char">ESC_CHAR</a> to change the escape
character to something other than the backslash, which lets you
use a single backslash as a literal backslash.
</p>
<p>
Groff has a number of ways of recognizing what constitutes a
complete escape sequence. This is both a boon and a curse; some
escape sequences have no terminating delimiter and consequently
become difficult to distinguish from real input text. Others
require the use of an opening parenthesis with no corresponding
closing parenthesis. Still others need to be enclosed in square
brackets.
</p>
<p>
Mom recognizes that certain escapes get used more often than others.
For these, she has a consistent input style that takes the form
<kbd><span class="nobr">\*[...]</span></kbd>, which makes them stand out well
from the text of your documents. These escapes are the ones listed
under
<a href="#inlines-mom">Mom’s personal inline escapes</a>.
</p>
<p>
Despite mom’s best intentions, there are still
a number of typesetting functions that can only be accomplished
with groff’s native inline escapes. I’ve listed the
ones that strike me as essential, but there are many others. If you
want to know what they are, please read the
<a href="intro.html#canonical">canonical reference materials</a>
pertaining to groff.
</p>
<div class="box-tip">
<p class="tip">
<span class="tip">Helpful bit of information:</span>
Inline escapes can be used in
<a href="docprocessing.html#docprocessing">document processing macros</a>
that take
<a href="definitions.html#stringargument">string arguments</a>.
</p>
</div>
<div class="macro-list-container">
<h3 id="index-inlines" class="macro-list">List of inline escapes</h3>
<ul class="macro-list">
<li id="inlines-mom"><a href="#inlines-mom-top">Mom’s personal inline escapes</a>
<ul class="no-enumerator" style="margin-left: -1.5em;">
<li><a href="#inline-fonts-mom">Changing fonts</a></li>
<li><a href="#inline-size-mom">Changing point size</a></li>
<li><a href="#uc-lc">Capitalise a section of type</a></li>
<li><a href="#inline-kerning-mom">Pairwise kerning</a></li>
<li><a href="#inline-horizontal-mom">Horizontal movement</a></li>
<li><a href="#inline-vertical-mom">Vertical movement</a></li>
<li><a href="#inline-b-mom">Terminate a line without advancing on the page</a></li>
<li><a href="#tb-plus-mom">Call the next sequential tab without advancing on the page</a></li>
<li><a href="#inline-rule-mom">Full measure rules</a>
<ul class="sublist" style="font-size: 100%;">
<li><a href="#rule-weight">Macro to control the weight of rules</a></li>
</ul></li>
</ul></li>
<li id="inlines-groff"><a href="#inlines-groff-top">Commonly-used groff inline escapes</a>
<ul class="no-enumerator" style="margin-left: -1.5em;">
<li><kbd>\f</kbd> <a href="#inline-fonts-groff">Font control</a></li>
<li><kbd>\h</kbd> <a href="#inline-horizontal-groff">Inline horizontal motions</a></li>
<li><kbd>\v</kbd> <a href="#inline-vertical-groff">Inline vertical motions</a></li>
<li><kbd>\w</kbd> <a href="#inline-stringwidth-groff">String width function</a></li>
<li><kbd>\l</kbd> <a href="#inline-linedrawing-groff">Horizontal line drawing function</a></li>
<li style="margin-left: 1.6em;"><a href="#inline-characters-groff">Special characters</a></li>
</ul></li>
</ul>
</div>
<div class="rule-medium"><hr/></div>
<!-- -INLINE_FONTS_MOM- -->
<h2 id="inlines-mom-top" class="macro-group">Mom’s personal inline escapes</h2>
<h3 id="inline-fonts-mom" class="docs">Changing fonts</h3>
<p>
Mom provides five escapes for changing fonts inline:
<br/>
<span class="pre-in-pp">
\*[ROM] Change to the medium roman font
\*[IT] Change to the medium italic font
\*[BD] Change to the bold roman font
\*[BDI] Change to the bold italic font
\*[PREV] Revert to the previous font (once only)*
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">*Note:</span>
<kbd><span class="nobr">\*[PREV]</span></kbd> does not operate "stack
style". It returns to the previous font once only, and
afterwards has no effect. In other words, in the case of
<kbd><span class="nobr">\*[PREV]\*[PREV]</span></kbd>, only the first
<kbd><span class="nobr">\*[PREV]</span></kbd> is respected; the second one is silently
ignored.
</p>
</div>
<p>
These escapes are provided for merely for convenience, legibility,
and consistency when typesetting with mom. For more complete and
flexible inline font control, please see
<a href="#inline-fonts-groff">font control with <kbd>\f</kbd></a>.
</p>
<div class="box-notes">
<h3 id="inlines-docprocessing-fonts" class="docs notes">Notes concerning document processing</h3>
<p style="margin-top: .5em;">
If you’re using the
<a href="docprocessing.html#docprocessing">document processing macros</a>,
inline font changes remain in effect only for the duration of the
current document element tag.
</p>
<p class="tip-bottom">
Additionally, if you’re designing your own
<a href="headfootpage.html#headfootpage-intro">HEADERS or FOOTERS</a>
and want to use mom’s inline escapes for changing fonts as
part of the left, centre and/or right strings, or in the strings
for
<a href="headfootpage.html#hdrftr-rectoverso">recto</a>
and/or
<a href="headfootpage.html#hdrftr-rectoverso">verso</a>
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you must enter the inlines beginning with <kbd>\E*</kbd>
rather than just <kbd><span class="nobr">\*</span></kbd>, e.g.
<kbd><span class="nobr">\E*[BD]</span></kbd>. You may, in such cases, prefer to
use the simpler groff inline escape
<a href="#inline-fonts-groff"><kbd>\f</kbd></a>.
</p>
</div>
<!-- -INLINE_SIZE_MOM- -->
<h3 id="inline-size-mom" class="docs">Changing point size</h3>
<p>
Mom has two inline escapes for changing point size:
<br/>
<span class="pre-in-pp">
\*[SIZE <size>]
</span>
and
<br/>
<span class="pre-in-pp">
\*S[<size>]
</span>
where “size” is the new size you want. You can use
either; they behave exactly the same way. For example, to change
the point size of type inline to 12 points, you could enter either
<br/>
<span class="pre-in-pp">
\*[SIZE 12]
</span>
or
<br/>
<span class="pre-in-pp">
\*S[12]
</span>
Entering either <kbd><span class="nobr">\*[SIZE]</span></kbd> or
<kbd><span class="nobr">\*S[]</span></kbd> with no argument reverts to the former
point size.
</p>
<p>
The advantage of the first form is that it’s easy to remember,
and follows mom’s usual inline syntax. The advantage of the
second is that it’s more concise.
</p>
<p>
Notice that in both cases, the new size does not require a
<a href="definitions.html#unitofmeasure">unit of measure</a>;
<a href="definitions.html#picaspoints">points</a>
is assumed. However, a unit of measure may be appended to the size
if that’s what you wish. Fractional sizes are, of course,
allowed.
</p>
<p>
The size given to <kbd><span class="nobr">\*[SIZE <size>]</span></kbd>
or <kbd><span class="nobr">\*S[<size>]</span></kbd> may be expressed in
plus or minus terms, which can be very useful. In the following
examples, the word “mom” will be output 2 points larger
than the point size of the rest of the line.
<br/>
<span class="pre-in-pp">
While she isn't perfect, \*S[+2]mom\*S[-2] isn't half bad.
While she isn't perfect, \*[SIZE +2]mom\*[SIZE -2] isn't half bad.
</span>
Please note that inline size changes do not update the leading if
<a href="typesetting.html#autolead">AUTOLEAD</a>
is enabled.
</p>
<div class="box-notes">
<h3 id="inline-docprocessing-ps" class="docs notes">NOTE CONCERNING DOCUMENT PROCESSING</h3>
<p style="margin-top: .5em;">
If you’re using the
<a href="docprocessing.html#docprocessing">document processing macros</a>
and wish to design your own
<a href="headfootpage.html#headfootpage-intro">HEADERS or FOOTERS</a>
using mom’s inline escape for changing point size as part of
the left, centre and/or right strings, or in the strings for
<a href="headfootpage.html#hdrftr-rectoverso">recto</a>
and/or
<a href="headfootpage.html#hdrftr-rectoverso">verso</a>
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the form <kbd><span class="nobr">\*S[<n>]</span></kbd>
and enter the inline beginning with <kbd>\E*</kbd>, like this:
<kbd><span class="nobr">\E*S[<+|-><n>]</span></kbd>.
</p>
<p class="tip-bottom">
<span class="additional-note">Additional note:</span>
If you’re accustomed to groff’s usual way of handling
inline size requests <kbd>(\sN, \s±N, \s(NN, \s±(NN, \s[NNN],
\s±[NNN]),</kbd> feel free to continue with your old habits. Mom
doesn’t care.
</p>
</div>
<!-- -CAPITALISATION- -->
<h3 id="uc-lc" class="docs">Capitalise a section of type</h3>
<p>
If you need to capitalise a region of type inline,
bracket the region of type with the inline escapes,
<kbd><span class="nobr">\*[UC]</span></kbd> (Upper Case) and
<kbd><span class="nobr">\*[LC]</span></kbd> (Lower Case), like this:
<br/>
<span class="pre-in-pp">
All work \*[UC]and\*[LC] no play makes Jack a dull boy.
</span>
The above produces, on output
<br/>
<span class="pre-in-pp">
All work AND no play makes Jack a dull boy.
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>\*[UC]</kbd> and <kbd>\*[LC]</kbd> must not be used inside the
<a href="definitions.html#stringargument">string arguments</a>
passed to the
<a href="headfootpage.html#hdrftr-strings">HEADER_<POSITION></a>
macro. Instead, use the control macro
<a href="headfootpage.html#_caps">HEADER_<POSITION>_CAPS.</a>
For
<a href="headfootpage.html#hdrftr-rectoverso">HEADER_RECTO</a>
(or _VERSO) or
<a href="headfootpage.html#hdrftr-rectoverso">FOOTER_RECTO</a>
(or _VERSO), supply the <kbd>CAPS</kbd> option to the appropriate
macro.
</p>
</div>
<!-- -INLINE_KERNING_MOM- -->
<h3 id="inline-kerning-mom" class="docs">Pairwise kerning</h3>
<p>
Pairwise kerning means moving specific letter pairs closer
together or further apart (see
<a href="definitions.html#kern">Typesetting terms, kerning</a>
for more details).
</p>
<p>
Mom permits inline pairwise kerning through the use of the inline
escapes
<br/>
<span class="pre-in-pp">
\*[BU <n>] Closes the space between letters (Back Units).
\*[FU <n>] Opens the space between letters (Forward Units).
</span>
<b><n></b> is the number of
<a href="definitions.html#kernunit">kern units</a>
by which to close or open the space between letters.
</p>
<p>
For example,
<br/>
<span class="pre-in-pp">
THE HUMAN COST OF COMMODIF\*[FU 1]YING FRESH W\*[BU 4]A\*[BU 5]TER
</span>
moves the letter Y in “COMMODIFYING” one kern unit away
from the letter F, and the letter A in “WATER” four
kern units closer to the letter W. Additionally, the letter T in
“WATER” is moved five kern units closer to the letter A.
</p>
<p>
For backward compatibility, the forms
<br/>
<span class="pre-in-pp">
\*[BU1]...\*[BU36] Move backward 1...36 <a href="definitions.html#kernunit">kern units</a>
\*[FU1]...\*[FU36] Move forward 1...36 <a href="definitions.html#kernunit">kern units</a>
</span>
also exist (i.e. with no space before the number of kern units desired,
up to a limit of 36).
</p>
<p id="kernunit">
The default size of a kern unit is 1/36 of the current point size;
this may be changed by invoking the macro <kbd>.KERN_UNIT</kbd>
with the desired value, which represents a fraction of the current
point size. For example, to change the kern unit to 1/54 of the
current point size,
<br/>
<span class="pre-in-pp">
.KERN_UNIT 54
</span>
To restore the kern unit to its default, invoke
<kbd>.KERN_UNIT</kbd> with an argument of <kbd>DEFAULT</kbd>.
</p>
<div class="box-notes">
<h3 id="inlines-docprocessing-kerning" class="docs notes">Notes concerning document processing</h3>
<p style="margin-top: .5em;">
If you’re using the
<a href="docprocessing.html#docprocessing">document processing macros</a>
and wish to design your own
<a href="headfootpage.html#headfootpage-intro">HEADERS or FOOTERS</a>
using mom’s inline escapes for kerning as part of the left,
centre and/or right strings, or in the strings for
<a href="headfootpage.html#hdrftr-rectoverso">recto</a>
and/or
<a href="headfootpage.html#hdrftr-rectoverso">verso</a>
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the forms
<kbd><span class="nobr">\E*[BU<n>]</span></kbd> and
<kbd><span class="nobr">\E*[FU<n>]</span></kbd> (i.e. with no space),
and enter the inline beginning with <kbd><span class="nobr">\E*</span></kbd>
rather than just <kbd><span class="nobr">\*</span></kbd>, e.g.
<kbd><span class="nobr">\E*[BU4]</span></kbd>.
</p>
<p class="tip-bottom">
<span class="additional-note">Additional note:</span>
Using the <kbd>BU</kbd> or <kbd>FU</kbd> escapes between characters
pairs that are already automatically kerned (see
<a href="typesetting.html#kern">KERN</a>)
disables the automatic kerning and uses the value you give to
<kbd>BU</kbd> or <kbd>FU</kbd> instead.
</p>
</div>
<!-- -INLINE_HORIZONTAL_MOM- -->
<h3 id="inline-horizontal-mom" class="docs">Horizontal inline movement</h3>
<p>
Sometimes, you may need to insert a specified amount of white
space into an
<a href="definitions.html#outputline">output line</a>,
or—occasionally—back up to a previous position on an
<a href="definitions.html#inputline">output</a>
line in order to create special typographic effects.
</p>
<p>
Mom’s inline escapes for these horizontal movements are
<br/>
<span id="bck" class="pre-in-pp">
\*[BCK <n unit>] Move backward inline the specified number of
<a href="definitions.html#unitofmeasure">units of measure</a>; decimal fractions are allowed.
</span>
and
<span id="fwd" class="pre-in-pp">
\*[FWD <n unit>] Move forward inline the specified number of
<a href="definitions.html#unitofmeasure">units of measure</a>; decimal fractions are allowed.
</span>
</p>
<p>
For example,
<br/>
<span class="pre-in-pp">
1.\*[FWD 12p]The Free Trade Play-Offs: WalMart 100, Mexico 0
</span>
puts 12 points of space between <kbd>1.</kbd> and
<kbd>The</kbd>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
For backward compatibility, the forms
<br/>
<span class="pre-in-pp">
\*[BP.25]...\*[BP12.75] Move backward .25...12.75 points
\*[FP.25]...\*[FP12.75] Move forward .25...12.75 points
</span>
also exist (i.e. with no space before the digit and points being
the unit of measure, hence no unit of measure required). Both
accept quarter points, so it’s possible to do,
for example, <kbd><span class="nobr">\*[FP.5]</span></kbd> or
<kbd><span class="nobr">\*[BP1.25]</span></kbd> up to a limit of 12.75 points.
</p>
</div>
<div class="box-notes">
<h3 id="inlines-docprocessing-horizontal" class="docs notes">Note concerning document processing</h3>
<p style="margin-top: .5em; padding-bottom: .5em;">
If you’re using the
<a href="docprocessing.html#docprocessing">document processing macros</a>
and wish to design your own
<a href="headfootpage.html#headfootpage-intro">HEADERS or FOOTERS</a>
using mom’s inline escapes for horizontal movements as part of
the left, centre and/or right strings, or in the strings for
<a href="headfootpage.html#hdrftr-rectoverso">recto</a>
and/or
<a href="headfootpage.html#hdrftr-rectoverso">verso</a>
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the forms
<kbd><span class="nobr">\E*[BP<n>]</span></kbd> and
<kbd><span class="nobr">\E*[FP<n>]</span></kbd> (i.e. with no space),
and enter the inline beginning with <kbd><span class="nobr">\E*</span></kbd>
rather than just <kbd><span class="nobr">\*</span></kbd>, e.g.
<kbd><span class="nobr">\E*[BP.75]</span></kbd>. You may, in such cases, prefer
to use the native groff inline escape
<a href="#inline-horizontal-groff"><kbd>\h</kbd></a>.
</p>
</div>
<!-- -INLINE_VERTICAL_MOM- -->
<h3 id="inline-vertical-mom" class="docs">Vertical inline movement</h3>
<p>
If you need to move portions of type up or down on a line, mom
provides the following inline escapes:
<br/>
<span id="down" class="pre-in-pp">
\*[DOWN <n unit>] Move down inline the specified number of
<a href="definitions.html#unitofmeasure">units of measure</a>
<span id="up">\*[UP <n unit>] Move up inline the specified number of
<a href="definitions.html#unitofmeasure">units of measure</a></span>
</span>
For example,
<br/>
<span class="pre-in-pp">
Tel: 905\*[UP 1p]-\*[DOWN 1p]4072
</span>
moves the hyphen in the telephone number up by 1 point, then
moves back down by the same amount.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd><span class="nobr">\*[UP]</span></kbd> and
<kbd><span class="nobr">\*[DOWN]</span></kbd>
do not work in conjunction with the inline escape,
<a href="#inline-rule-mom"><kbd><span class="nobr">\*[RULE]</span></kbd></a>.
</p>
<p>
<span class="additional-note">Additional note:</span>
For backward compatibility, the following are also available:
<br/>
<span class="pre-in-pp">
\*[ALD.25]...\*[ALD12.75] Advance lead .25...12.75 points (move downward)
\*[RLD.25]...\*[RLD12.75] Reverse lead .25...12.75 points (move upward)
</span>
</p>
<p class="tip-bottom">
Both <kbd><span class="nobr">\*[ALD]</span></kbd> and
<kbd><span class="nobr">\*[RLD]</span></kbd> work in points, hence you
mustn’t use a unit of measure.
</p>
</div>
<div class="box-notes">
<h3 id="inline-docprocessing-vertical" class="docs notes">Note concerning document processing</h3>
<p style="margin-top: .5em; padding-bottom: .5em;">
If you’re using the
<a href="docprocessing.html#docprocessing">document processing macros</a>
and wish to design your own
<a href="headfootpage.html#headfootpage-intro">HEADERS or FOOTERS</a>
using mom’s inline escapes for vertical movements as part of
the left, centre and/or right strings, or in the strings for
<a href="headfootpage.html#hdrftr-rectoverso">recto</a>
and/or
<a href="headfootpage.html#hdrftr-rectoverso">verso</a>
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the forms
<kbd><span class="nobr">\E*[ALD<n>]</span></kbd> and
<kbd>\E*[RLD<n>]</kbd> (i.e. with no space), and enter the
inline beginning with <kbd><span class="nobr">\E*</span></kbd> rather than just
<kbd><span class="nobr">\*</span></kbd>,
e.g. <kbd><span class="nobr">\E*[ALD.5]</span></kbd>.
You may, in such cases, prefer to use the native groff inline
escape
<a href="#inline-vertical-groff"><kbd>\v</kbd></a>.
</p>
</div>
<!-- -INLINE_B_MOM- -->
<h3 id="inline-b-mom" class="docs">Terminate a line without advancing on the page</h3>
<p>
Sometimes, you want mom to break a line but not advance on the page.
This can be accomplished with the macro
<a href="typesetting.html#el">EL</a>
or with the escape <kbd><span class="nobr">\*[B]</span></kbd>. Simply attach
<kbd><span class="nobr">\*[B]</span></kbd> to the end of any input line. Using
the example given in the document entry for EL, you’d use
<kbd><span class="nobr">\*[B]</span></kbd> like this:
<br/>
<span class="pre-in-pp">
.LEFT
.LS 12.5
A line of text.\*[B]
.ALD 24p
The next line of text.
</span>
<kbd>\*[B]</kbd> works reliably regardless of the current
<a href="definitions.html#filled">fill mode</a>.
</p>
<!-- -INLINE_TB+_MOM- -->
<h3 id="tb-plus-mom" class="docs">Call the next sequential tab without advancing on the page</h3>
<p>
Sometimes, you want mom to move to the next tab in sequence (e.g.
from TAB 1 to TAB 2, or TAB 8 to TAB 9) without mom advancing on the
page. (See the NOTE
<a href="typesetting.html#note-tn">here</a>
if you’re not clear how mom manages tabs and linebreaks.) To
do so, simply attach the escape <kbd><span class="nobr">\*[TB+]</span></kbd> to
the end of the input line in previous tab, like this:
<br/>
<span class="pre-in-pp">
.TAB 1
Some text\*[TB+] \" In tab 1
Some more text \" In tab 2, same baseline.
</span>
<kbd><span class="nobr">\*[TB+]</span></kbd> works reliably regardless of the
current
<a href="definitions.html#filled">fill mode</a>.
</p>
<!-- -INLINE_RULE_MOM- -->
<h3 id="inline-rule-mom" class="docs">Full measure rules</h3>
<p>
I find I often need rules drawn to the full measure of the
current line or tab length. The official way to do this is
<kbd><span class="nobr">\l'\n[.l]u'</span></kbd>, which is annoying to type,
and doesn’t mean a whole heck of a lot if you’re new
to groff. The inline, <kbd><span class="nobr">\*[RULE]</span></kbd>, is a
simple replacement for <kbd><span class="nobr">\l'\n[.l]u'</span></kbd>. Use it
whenever you need a rule drawn to the full measure of the current
line or tab length, for example:
<br/>
<span class="pre-in-pp">
.LL 6P
\*[RULE]
</span>
The above draws a rule the full measure of the 6-pica line length.
For another way to draw full measure rules, see the macro
<a href="graphical.html#drh">DRH</a>.
</p>
<p>
<kbd>\*[RULE]</kbd> must appear on an
<a href="definitions.html#inputline">input line</a>
by itself, and always causes a break when entered after a normal
input line of text. It does not, however, deposit a break when used
immediately after a macro.
</p>
<p>
The weight of the rule drawn with <kbd><span class="nobr">\*[RULE]</span></kbd>
is controlled with the macro
<a href="#rule-weight">RULE_WEIGHT</a>.
Mom’s default is 1/2 point.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd><span class="nobr">\*[RULE]</span></kbd> draws the rule to the full measure,
hence it cannot be used to fill the remainder of a partial line with
a rule in this way:
<br/>
<span class="pre-in-pp">
Signature__________________________________________
</span>
If you wish to accomplish this effect, you have to use
<kbd>\*[RULE]</kbd> in conjunction with the
<a href="goodies.html#pad">PAD</a>
macro and
<a href="typesetting.html#string-tabs">string tabs</a>.
(See the
<a href="goodies.html#pad-example">example</a>
provided with PAD.)
<a name="RULE_EXCEPTION"></a>
</p>
<p>
Please also note that the inline escapes
<a href="#up"><kbd><span class="nobr">\*[UP]</span></kbd></a>
and
<a href="#down"><kbd>\*[DOWN]</kbd></a>
cannot be used in conjunction with <kbd><span class="nobr">\*[RULE]</span></kbd>.
</p>
<p>
This <i>doesn’t</i> work:
<br/>
<span class="pre-in-pp">
\*[DOWN 2p]\*[RULE]\*[UP 2p]
</span>
whereas this does:
<br/>
<span class="pre-in-pp">
.ALD 2p
\*[RULE]
.RLD 2p
</span>
</p>
<p class="tip-bottom">
See groff’s
<a href="#inline-linedrawing-groff">Horizontal line drawing function</a>
for more information on drawing horizontal rules.
</p>
</div>
<!-- -RULE_WEIGHT- -->
<div id="rule-weight" class="box-macro-args">
Macro: <b>RULE_WEIGHT</b> <kbd><weight in points></kbd>
</div>
<p class="requires">
• Must <span class="normal">not</span> have a
<a href="definitions.html#unitofmeasure">unit of measure</a>
appended.
<br/>
Argument must be greater than 0 and less than 100; decimal
fractions are allowed.
</p>
<p>
RULE_WEIGHT allows you to tell mom how heavy (in other words, how
“thick”) you want the rules drawn with the inline
escape,
<a href="#inline-rule-mom"><kbd><span class="nobr">\*[RULE]</span></kbd></a>.
It takes a single argument: the weight of the rule in
<a href="definitions.html#picaspoints">points</a>
<i>but without the</i>
<a href="definitions.html#unitofmeasure">unit of measure</a>
<kbd>p</kbd> <i>attached</i>. Thus, to set the weight of rules
drawn with <kbd><span class="nobr">\*[RULE]</span></kbd> to 1-1/4 points,
you’d do
<br/>
<span class="pre-in-pp">
.RULE_WEIGHT 1.25
</span>
</p>
<p>
RULE_WEIGHT also sets the weight of rules drawn
with
<a href="graphical.html#drh"><kbd>.DRH</kbd></a>
when DRH is not given any arguments.
</p>
<div class="rule-medium"><hr/></div>
<!-- -INLINE_FONT_GROFF- -->
<h2 id="inlines-groff-top" class="macro-group">Commonly-used groff inline escapes</h2>
<h3 id="inline-fonts-groff" class="docs">Font control (<kbd style="text-transform: none">\f</kbd>)</h3>
<p>
Groff’s basic mechanism for inline font control is the escape
<kbd>\f[<font>]</kbd>.
<br/>
<span class="pre-in-pp">
\f[R] Change to the medium roman font (equivalent to mom's \*[ROM])
\f[I] Change to the medium italic font (equivalent to mom's \*[IT])
\f[B] Change to the bold roman font (equivalent to mom's \*[BD])
\f[BI] Change to the bold italic font (equivalent to mom's \*[BDI])
\f[P] Revert to the previous font (equivalent to mom's \*[PREV])
</span>
</p>
<p>
<kbd>\f[<font>]</kbd> can be used with any valid
<a href="definitions.html#font">font style</a>
registered with groff. (See
<a href="appendices.html#style-extensions">here</a>
for a list of pre-registered font styles provided by mom).
</p>
<p>
<kbd>\f[<family><font>]</kbd> can also take a complete valid
family+font name combo. This is especially useful should you
need to change both family and font inline. For example, if your
prevailing family and font are Times Roman and you want a few words
in Courier Bold Italic, you could do this:
<br/>
<span class="pre-in-pp">
.FAM T
.FT R
The command \f[CBI]ls -l\f[P] gives a "long" directory listing.
</span>
The Unix command <kbd>ls -l</kbd> will appear in Courier Bold Italic
in a line that is otherwise in Times Roman.
</p>
<!-- -INLINE_HORIZONTAL_GROFF- -->
<h3 id="inline-horizontal-groff" class="docs">Inline horizontal motions (<kbd style="text-transform: none;">\h</kbd>)</h3>
<p>
Whenever you need to move forward or backward on a line, use the
inline
<br/>
<span class="pre-in-pp">
\h'<distance>'
</span>
In order to avoid unpleasant surprises, always append a
<a href="definitions.html#unitofmeasure">unit of measure</a>
to <kbd><distance></kbd>. For example,
<br/>
<span class="pre-in-pp">
\h'1.25i'
</span>
moves you 1.25 inches to the right (forward) of the horizontal
position on the current
<a href="definitions.html#outputline">output line</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>\h'<distance>'</kbd> is exactly equivalent to a
<a href="#fwd"><kbd><span class="nobr">\*[FWD n<unit>]</span></kbd></a>.
</p>
</div>
<p>
To move backwards by the same amount, do
<br/>
<span class="pre-in-pp">
\h'-1.25i'
</span>
</p>
<div class="box-tip">
<p class="tip" style="margin-top: -1em;">
<span class="note">Note:</span>
<kbd>\h'-<distance>'</kbd> is exactly equivalent to
<a href="#bck"><kbd><span class="nobr">\*[BCK n<unit>]</span></kbd></a>.
</p>
</div>
<!-- -INLINE_VERTICAL_GROFF- -->
<h3 id="inline-vertical-groff" class="docs">Inline vertical motions (<kbd style="text-transform: none;">\v</kbd>)</h3>
<p>
If you need to raise or lower type on a line (say, for sub- or
superscripts, or any other special effect), use
<br/>
<span class="pre-in-pp">
\v'<distance>'
</span>
In order to avoid unpleasant surprises, always append a
<a href="definitions.html#unitofmeasure">unit of measure</a>
to <kbd><distance></kbd>. For example,
<br/>
<span class="pre-in-pp">
\v'.6m'
</span>
moves you (approx.) 2/3 of an
<a href="definitions.html#em">em</a>
downward on the current
<a href="definitions.html#outputline">output line</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>\v'<distance>'</kbd> is exactly equivalent to
<a href="#down"><kbd><span class="nobr">\*[DOWN n<unit>]</span></kbd></a>.
</p>
</div>
<p style="margin-top: -.5em;">
To move upward an equivalent amount, do
<br/>
<span class="pre-in-pp">
\v'-.6m'
</span>
</p>
<div class="box-tip" style="margin-top: -1em;">
<p class="tip">
<span class="note">Note:</span>
<kbd>\v'<-distance>'</kbd> is exactly equivalent to
<a href="#up"><kbd><span class="nobr">\*[UP n<unit>]</span></kbd></a>.
</p>
</div>
<div class="box-important">
<p class="tip">
<span class="important">Important:</span>
The vertical motion of <kbd>\v</kbd> only affects type on the
current
<a href="definitions.html#outputline">output line</a>.
When groff breaks the output line, the effect of
<kbd>\v</kbd> is cancelled; the baseline of the next output line
is where it would be if you hadn’t used <kbd>\v</kbd>.
</p>
</div>
<div class="box-tip">
<p class="tip">
<span class="tip">Tip:</span>
When using <kbd>\v</kbd> for occasional effects in a line,
don’t forget to reverse it when you’ve done what you
want to do. Otherwise, the remaining type will be set too high (if
you used <kbd>\v</kbd> with the minus sign) or too low (if you used
<kbd>\v</kbd> without the minus sign).
</p>
</div>
<!-- -INLINE_STRINGWIDTH_GROFF- -->
<h3 id="inline-stringwidth-groff" class="docs">String width function (<kbd style="text-transform: none;">\w</kbd>)</h3>
<p>
In the context of mom, the string width inline
<kbd>\w'<string>'</kbd> primarily serves to let you establish the
horizontal measure of something (e.g. indents) based on the length
of a bit of text. For example, if you want a left indent the length
of the word “Examples:” plus a space, you can set it with
the <kbd>\w</kbd> inline escape:
<br/>
<span class="pre-in-pp">
.IL "\w'Examples: '"
</span>
</p>
<div class="box-tip" style="margin-top: -1em;">
<p class="tip">
<span class="note">Note:</span>
Whenever you pass <kbd>\w'string'</kbd>
to a macro that normally requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>,
<i>do NOT add a unit of measure to the</i>
<kbd>\w'string'</kbd> <i>argument.</i>
</p>
<p class="tip-bottom">
Furthermore, if the <kbd>\w</kbd> is used in place of a
<a href="definitions.html#numericargument">numeric argument</a>
to a macro and <kbd>string</kbd> is composed of several words
separated by spaces, you must surround the whole escape with double
quotes, as in the example above.
</p>
</div>
<!-- -INLINE_LINEDRAWING_GROFF- -->
<h3 id="inline-linedrawing-groff" class="docs">Horizontal line drawing function (<kbd style="text-transform: none;">\l</kbd>)</h3>
<p>
The <kbd>\l'distance'</kbd> inline allows you to draw a horizontal
rule of the specified distance. You must supply a
<a href="definitions.html#unitofmeasure">unit of measure</a>.
Therefore, to set a 3-pica rule into a line of text, you’d do
<br/>
<span class="pre-in-pp">
A line of text with a superfluous \l'3P' 3-pica rule in it.
</span>
<kbd>\l'3P'</kbd>, above, not only draws the rule, but advances 3
picas horizontally as well, just as you’d expect.
</p>
<p>
For an easy way of drawing rules to the full measure of the current
line or tab length, see
<a href="#inline-rule-mom">Full measure rules</a>.
</p>
<p>
The weight (thickness) of rules varies according to the point
size in effect when you invoke <kbd>\l</kbd>, but you can’t fix
the weight with any real precision. A point size of 12 produces
a tastefully moderate rule weight of between one-half and one
point (depending on your printer).
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Besides <kbd>\l</kbd>, <b>groff</b> provides a number of more
sophisticated “drawing” escapes. It is well beyond
the scope of this documentation to demonstrate their usage; see
<br/>
<span class="pre-in-pp">
info groff \\D
</span>
for directions concerning their use. The drawing escapes can be a
bit unwieldy, so mom provides “user-friendly” macros for
the
<a href="graphical.html#top">graphical objects</a>
most commonly encountered in typesetting: horizontal and vertical
rules, boxes, and circles (ellipses).
</p>
<p class="tip-bottom">
Additionally, groff comes with two “preprocessors” that
let you create ruled tables and vector diagrams (line drawings):
<b>tbl</b> and <b>pic</b>. The documentation for <b>tbl</b> can be
downloaded from
<br/>
<a style="display: inline-block; margin-left: 2em; margin-top: .5em; margin-bottom: .5em" href="http://cm.bell-labs.com/cm/cs/doc/76/tbl.ps.gz">http://cm.bell-labs.com/cm/cs/doc/76/tbl.ps.gz</a>
<br/>
and <b>pic</b> from
<br/>
<a style="display: inline-block; margin-left: 2em; margin-top: .5em; margin-bottom: .5em" href="http://www.kohala.com/start/troff/gpic.raymond.ps">http://www.kohala.com/start/troff/gpic.raymond.ps</a>
<br/>
Both are powerful tools, but they can be nasty to learn—at
first, anyway. You may prefer to use a vector drawing program
to create diagrams and tables; inserting the results into a
document is easy enough with
<a href="images.html#pdf-image">PDF_IMAGE</a>
or
<a href="images.html#pspic">PSPIC</a>.
</p>
</div>
<!-- -INLINE_CHARACTERS_GROFF- -->
<h3 id="inline-characters-groff" class="docs">Special characters and symbols</h3>
<p>
Here follows a short list of commonly-used special characters
available via inline escapes. If you’re not sure of the
meaning of some of these characters, consult the
<a href="definitions.html#top">Definitions of Terms</a>.
</p>
<p>
For a complete list of special characters and glyphs (i.e. just
about anything you’d ever want to appear on the printed
page, including mathematical symbols, accented characters, unusual
ligatures and letters unique to various European languages), consult
<kbd>man groff_char</kbd>.
</p>
<span class="pre">
CHARACTER ESCAPE SEQUENCE
--------- ---------------
Comment line \# or .\"
Fixed-width space \<space>
Unbreakable space \~
Digit-width (figure) space \0
Zero-width character \&
Discretionary hyphen \%
Backslash \\ or \e
Plus/minus (arithmetic) \[+-]
Subtract (arithmetic) \[mi]
Multiply (arithmetic) \[mu]
Divide (arithmetic) \[di]
Em-dash \[em]
En-dash \[en]
Left double-quote \[lq]
Right double-quote \[rq]
Open (left) single-quote \[oq]
Close (right) single-quote \[cq]
Bullet \[bu]
Ballot box \[sq]
One-quarter \[14]
One-half \[12]
Three-quarters \[34]
Degree sign \[de]
Dagger \[dg]
Foot mark \[fm]
Cent sign \[ct]
Registered trademark \[rg]
Copyright \[co]
Section symbol \[se]
</span>
<br/>
<div class="rule-long"><hr/></div>
<!-- Navigation links -->
<table style="width: 100%; margin-top: 12px;">
<tr>
<td style="width: 33%;"><a href="toc.html">Back to Table of Contents</a></td>
<td style="width: 33%; text-align: center;"><a href="#top">Top</a></td>
<td style="width: 33%; text-align: right;"><a href="color.html#top">Next: Coloured text</a></td>
</tr>
</table>
</div>
<div class="bottom-spacer"><br/></div>
</body>
</html>
|
