6 Copyright (C) 1989-2014 Free Software Foundation, Inc.
7 Written by James Clark (jjc@jclark.com)
9 This file is part of groff.
11 groff is free software; you can redistribute it and/or modify it under
12 the terms of the GNU General Public License as published by the Free
13 Software Foundation, either version 3 of the License, or
14 (at your option) any later version.
16 groff is distributed in the hope that it will be useful, but WITHOUT ANY
17 WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 .if !\n(.g .ab These ms macros require groff.
26 . ab The groff ms macros do not work in compatibility mode.
27 .\" Enable warnings (only if none are given on the command line).
28 .\" You can delete this if you want.
29 .if (\n[.warn] == 65543) .warn
30 .\" See if already loaded.
37 .tm \\n(.F:\\n(.c: macro error: \\$*
40 .tm \\n(.F:\\n(.c: macro warning: \\$*
43 .ab \\n(.F:\\n(.c: fatal macro error: \\$*
46 .@error sorry, \\$0 not implemented
49 .als TM @not-implemented
50 .als CT @not-implemented
54 .if !rPO .nr PO \\n(.o
55 .\" a non-empty environment
63 .ds REFERENCES References
65 .ds TOC Table of Contents
78 .ds MO \E*[MONTH\n[mo]]
79 .ds DY \n[dy] \*[MO] \n[year]
81 .if \\n[.$] .ds DY "\\$*
84 .if \\n[.$] .ds DY "\\$*
89 .tm \\$1\t\\$2\t\\$3\t\\$4 ... \\n[PN]
91 .\" print an error message and then try to recover
93 .@error \\$@ (recovering)
96 . \"@warning automatically terminating diversion \\n(.z
97 . ie d @div-end!\\n(.z .@div-end!\\n(.z
98 . el .*div-end-default
100 . \" ensure that we don't loop forever
101 . if \\n[*pop-count]>20 .@fatal recovery failed
103 .while !'\\n[.ev]'0' .ev
115 .\" ****************************
116 .\" ******** module cov ********
117 .\" ****************************
118 .\" Cover sheet and first page.
119 .de cov*err-not-after-first-page
120 .@error \\$0 is not allowed after the first page has started
122 .de cov*err-not-before-tl
123 .@error \\$0 is not allowed before TL
125 .de cov*err-not-again
126 .@error \\$0 is not allowed more than once
128 .de cov*err-not-after-ab
129 .@error \\$0 is not allowed after first AB, LP, PP, IP, SH or NH
131 .als AU cov*err-not-before-tl
132 .als AI cov*err-not-before-tl
133 .als AB cov*err-not-before-tl
134 .de cov*first-page-init
135 .\" Invoked by `.wh 0' trap on first page.
136 .\" We should not come here again, but at short page length,
137 .\" recursion may occur; remove trap and macro to avoid it.
138 .ch cov*first-page-init
139 .rm cov*first-page-init
140 .if !'\\n[.ev]'0' \{\
141 . @error must be in top-level environment, not `\\n[.ev]',
142 . @error when first page is started
145 .als RP cov*err-not-after-first-page
147 .ie \\n[cov*rp-format] \{\
158 .CHECK-FOOTER-AND-KEEP
160 .wh 0 cov*first-page-init
161 .\" This handles the case where FS occurs before TL or LP.
168 .\" released paper format
171 .if \\n[.$] .if '\\$1'no' .nr cov*rp-no 1
177 .als TL cov*err-not-again
197 .di cov*au-div!\\n[cov*n-au]
200 .ie (\\n[PS] >= 1000) \
201 . ps (\\n[PS]z / 1000u)
211 .ie !\\n[cov*n-au] .@error AI before AU
213 . di cov*ai-div!\\n[cov*n-au]
216 . ie (\\n[PS] >= 1000) \
217 . ps (\\n[PS]z / 1000u)
246 .als cov*ab-init @nop
264 .als AB cov*err-not-after-ab
278 . als cov*tl-au-print @nop
284 . if '\*(.T'html' \{\
298 . als cov*tl-au-print @nop
306 . als AE cov*err-not-again
309 . ie '\\n(.z'cov*ab-div' \{\
310 . als AE cov*err-not-again
313 .\" nr cov*ab-height \\n[dn]
318 . el .@error AE without AB
321 .de @div-end!cov*ab-div
327 . ie \\n[cov*rp-format] .cov*rp-print
328 . el .cov*draft-print
331 . if \\n[cov*rp-format] \{\
332 . @warning RP format but no TL
336 . CHECK-FOOTER-AND-KEEP
342 .nr cov*page-length \\n[.p]
347 . if !'\*(.T'html' .nf
354 .if \\n[cov*fn-height] \{\
355 . sp |(u;\\n[cov*page-length]-\\n[FM]\
356 -\\n[cov*fn-height]-\\n[fn@sep-dist]>?\\n[nl])
361 . ie \\n[cov*rp-no] .rm cov*fn-div
363 . rn cov*fn-div fn@overflow-div
364 . nr fn@have-overflow 1
369 .CHECK-FOOTER-AND-KEEP
370 .\" If anything was printed below where the footer line is normally printed,
371 .\" then that's an overflow.
372 .if -\\n[FM]/2+1v+\\n[cov*page-length]<\\n[nl] .@error cover sheet overflow
373 .pl \\n[cov*page-length]u
375 .if !\\n[cov*rp-no] .cov*tl-au-print
400 .while \\n[cov*i]<=\\n[cov*n-au] \{\
401 . ie '\*(.T'html' .br
402 . el .sp \\n[cov*sp]u
403 . cov*au-div!\\n[cov*i]
404 . ie d cov*ai-div!\\n[cov*i] \{\
406 . cov*ai-div!\\n[cov*i]
416 .\" start of footnote on cover
418 .if \\n[cov*in-fn] \{\
426 .if !\\n[cov*fn-height] .ns
427 .ie \\n[.$] .FP "\\$1" no
430 .de @div-end!cov*fn-div
433 .\" end of footnote on cover
435 .ie '\\n(.z'cov*fn-div' \{\
440 . nr cov*fn-height +\\n[dn]
442 .el .@error FE without matching FS
444 .\" ***************************
445 .\" ******** module pg ********
446 .\" ***************************
447 .\" Page-level formatting.
448 .\" > 0 if we have a footnote on the current page
460 .ds pg*OH '\E*[LH]'\E*[CH]'\E*[RH]'
461 .ds pg*EH '\E*[LH]'\E*[CH]'\E*[RH]'
462 .ds pg*OF '\E*[LF]'\E*[CF]'\E*[RF]'
463 .ds pg*EF '\E*[LF]'\E*[CF]'\E*[RF]'
471 .ie \\n%=1 .if \\n[pg*P1] .tl \\*[pg*OH]
473 . ie o .tl \\*[pg*OH]
483 .ie r bell_localisms \{\
489 .wh -\n[FM]u pg@bottom
490 .wh -\n[FM]u/2u pg*footer
494 .if !'\\n(.z'' .error-recover MC while diversion open
496 .ie \\n[pg@ncols]>1 .pg@super-eject
498 . \" flush out any floating keeps
499 . while \\n[kp@tail]>\\n[kp@head] \{\
505 . nr pg@colw \\n[LL]*7/15
506 . nr pg*gutw \\n[LL]-(2*\\n[pg@colw])
510 . nr pg@colw (n;\\$1)<?\\n[LL]
511 . ie \\n[.$]<2 .nr pg*gutw \\n[MINGW]
512 . el .nr pg*gutw (n;\\$2)
513 . nr pg@ncols \\n[LL]-\\n[pg@colw]/(\\n[pg@colw]+\\n[pg*gutw])+1
514 . ie \\n[pg@ncols]>1 \
515 . nr pg*gutw \\n[LL]-(\\n[pg@ncols]*\\n[pg@colw])/(\\n[pg@ncols]-1)
518 .DEVTAG ".mc \\n[pg@ncols] \\n[pg@colw] \\n[pg*gutw]"
521 .nr pg@fn-colw \\n[pg@colw]*5/6
531 .\" top of page macro
533 .ch pg*footer -\\n[FM]u/2u
536 .nr pg@fn-bottom-margin 0
550 .\" Handle footnote overflow before floating keeps, because the keep
551 .\" might contain an embedded footnote.
559 .\" move pg@bottom and pg*footer out of the way
560 .ch pg@bottom \\n[.p]u*2u
561 .ch pg*footer \\n[.p]u*2u
566 .if \\n[pg@fn-flag] .fn@bottom-hook
568 .ie \\n[pg*col-num]<\\n[pg@ncols] .pg*end-col
572 'sp |\\n[pg*col-top]u
573 .po (u;\\n[PO]+(\\n[pg@colw]+\\n[pg*gutw]*\\n[pg*col-num]))
574 .\"po +(u;\\n[pg@colw]+\\n[pg*gutw])
579 .\" Make sure we don't exit if there are still floats or footnotes left-over.
580 .ie \\n[kp@head]<\\n[kp@tail]:\\n[fn@have-overflow] \{\
581 . \" Switching environments ensures that we don't get an unnecessary
582 . \" blank line at the top of the page.
588 . \" If the text has ended and there are no more footnotes or keeps, exit.
589 . if \\n[pg@text-ended] .ex
590 . if r pg*next-number \{\
591 . pn \\n[pg*next-number]
593 . if d pg*next-format \{\
594 . af PN \\*[pg*next-format]
601 .\" pg@begin number format
604 . nr pg*next-number (;\\$1)
605 . ie \\n[.$]>1 .ds pg*next-format \\$2
606 . el .rm pg*next-format
608 .el .rr pg*next-number
611 .\" print the footer line
618 .\" flush out any keeps or footnotes
621 .if !'\\n(.z'' .@error-recover diversion open while ejecting page
622 .\" Make sure we stay in the end macro while there is still footnote overflow
623 .\" left, or floating keeps.
624 .while \\n[kp@tail]>\\n[kp@head]:\\n[pg@fn-flag] \{\
637 .\" ***************************
638 .\" ******** module fn ********
639 .\" ***************************
643 .\" Round it vertically
645 .nr fn@sep-dist \n[.v]
649 .ds * \E*[par@sup-start]\En+[fn*text-num]\E*[par@sup-end]
653 .ie \\n[.$] .fn*do-FS "\\$1" no
655 . ie \\n[fn*text-num]>\\n[fn*note-num] .fn*do-FS \\n+[fn*note-num]
659 .\" Second argument of `no' means don't embellish the first argument.
661 .if \\n[fn*open] .@error-recover nested FS
664 . \" Ensure that the first line of the footnote is on the same page
665 . \" as the reference. I think this is minimal.
669 . ie \\n[pg@fn-flag] .nr fn*need +\\n[fn:PD]
670 . el .nr fn*need +\\n[fn@sep-dist]
671 . ne \\n[fn*need]u+\\n[.V]u>?0
681 .ie !\\n[fn*open] .@error FE without FS
689 .nr fn@have-overflow 0
690 .\" called at the top of each column
693 .nr fn*page-bottom-pos 0-\\n[FM]-\\n[pg@fn-bottom-margin]
694 .ch pg@bottom \\n[fn*page-bottom-pos]u
695 .if \\n[fn@have-overflow] \{\
696 . nr fn@have-overflow 0
704 .\" This is called at the bottom of the column if pg@fn-flag is set.
707 .nr fn@have-overflow 0
708 .nr fn@bottom-pos \\n[.p]-\\n[FM]-\\n[pg@fn-bottom-margin]+\\n[.v]
710 .nr fn@bottom-pos -\\n[.v]
712 .ie \\n[nl]+\\n[fn@sep-dist]+\n[.V]>\\n[fn@bottom-pos] \{\
713 . rn fn@div fn@overflow-div
714 . nr fn@have-overflow 1
717 . if \\n[pg@ncols]>1 \
718 . if \\n[fn*max-width]>\\n[pg@fn-colw] \
719 . nr pg@fn-bottom-margin \\n[.p]-\\n[FM]-\\n[nl]+1v
720 . wh \\n[fn@bottom-pos]u fn*catch-overflow
726 . if '\\n(.z'fn@overflow-div' \{\
728 . nr fn@have-overflow \\n[dn]>0
730 . ch fn*catch-overflow
733 .de fn*catch-overflow
739 .if '\\n[.ev]'fn' .ev
743 .als @div-end!fn*embed-div @div-end!fn@div
747 . if !\\n[pg@fn-flag] .ns
752 .ie '\\n(.z'fn@div' \{\
754 . nr fn*page-bottom-pos -\\n[dn]
755 . nr fn*max-width \\n[fn*max-width]>?\\n[dl]
756 . if !\\n[pg@fn-flag] .nr fn*page-bottom-pos -\\n[fn@sep-dist]
758 . nr fn*page-bottom-pos \\n[nl]-\\n[.p]+\n[.V]>?\\n[fn*page-bottom-pos]
759 . ch pg@bottom \\n[fn*page-bottom-pos]u
762 . ie '\\n(.z'fn*embed-div' \{\
764 . rn fn*embed-div fn*embed-div!\\n[fn*embed-count]
765 \!. fn*embed-start \\n[fn*embed-count]
767 ' sp (u;\\n[dn]+\\n[fn@sep-dist]+\\n[.V])
769 . nr fn*embed-count +1
773 . @error-recover unclosed diversion within footnote
782 . rm fn*embed-div!\\$1
788 \!. fn*embed-start \\$1
793 .ie '\\n(.z'fn*null' \{\
799 .\" It's important that fn@print-sep use up exactly fn@sep-dist vertical space.
803 .vs \\n[fn@sep-dist]u
808 .\" ***************************
809 .\" ******** module kp ********
810 .\" ***************************
817 .if !'\\n(.z'' .@error-recover KF while open diversion
824 .ie '\\n(.z'kp*div' .kp*end
826 . ie '\\n(.z'kp*fdiv' .kp*fend
827 . el .@error KE without KS or KF
837 .ie '\\n(.z'' .ds@need \\$1
840 .\" end non-floating keep
853 .\" end floating keep
858 .ie \\n[.t]-(\\n[.k]>0*1v)>\\n[dn] \{\
866 . rn kp*fdiv kp*div!\\n[kp@tail]
867 . nr kp*ht!\\n[kp@tail] 0\\n[dn]
871 .\" top of page processing for KF
874 .if !\\n[kp*doing-top] \{\
881 .\" If the first keep won't fit, only force it out if we haven't had a footnote
882 .\" and we're at the top of the page.
883 .nr kp*force \\n[pg@fn-flag]=0&(\\n[nl]<=\\n[pg@header-bottom])
885 .while \\n[kp@tail]>\\n[kp@head]&\\n[kp*fits] \{\
886 . ie \\n[.t]>\\n[kp*ht!\\n[kp@head]]:\\n[kp*force] \{\
888 . \" It's important to advance kp@head before bringing
889 . \" back the keep, so that if the last line of the
890 . \" last keep springs the bottom of page trap, a new
891 . \" page will not be started unnecessarily.
892 . rn kp*div!\\n[kp@head] kp*temp
902 .\" ***************************
903 .\" ******** module ds ********
904 .\" ***************************
905 .\" Displays and non-floating keeps.
907 .ds*end!\\n[\\n[.ev]:ds-type]
908 .nr \\n[.ev]:ds-type 0
911 .if \\n[\\n[.ev]:ds-type] \{\
912 . @error automatically terminating display
917 .ie \\n[\\n[.ev]:ds-type] .DE
921 .@error DE without DS, ID, CD, LD or BD
925 .nr \\n[.ev]:ds-type 1
932 .ie \\n[.$] .in +(n;\\$1)
947 .als ds*end!1 ds*common-end
950 .nr \\n[.ev]:ds-type 2
955 .ie '\\n(.z'ds*div' \{\
958 . in (u;\\n[.l]-\\n[dl]/2>?0)
963 .el .@error-recover mismatched DE
970 . nr \\n[.ev]:ds-type 4
979 . ie '\\$1'I' .ID \\$2
984 . nr \\n[.ev]:ds-type 3
989 . while \\n[.t]<=(\\$1)&(\\n[nl]>\\n[pg@header-bottom]) \{\
997 .ie '\\n(.z'ds*div' \{\
1006 .el .@error-recover mismatched DE
1009 .ie '\\n(.z'ds*div' \{\
1013 . in (u;\\n[.l]-\\n[dl]/2>?0)
1019 .el .@error-recover mismatched DE
1021 .\" ****************************
1022 .\" ******** module par ********
1023 .\" ****************************
1024 .\" Paragraph-level formatting.
1025 .\" Load time initialization.
1027 .\" PS and VS might have been set on the command-line
1031 .\" don't set LT so that it can be defaulted from LL
1032 .ie rLT .lt \\n[LT]u
1034 .ie (\\n[PS] >= 1000) \
1035 . ps (\\n[PS]z / 1000u)
1038 .\" don't set VS so that it can be defaulted from PS
1040 . ie (\\n[VS] >= 1000) \
1041 . par*vs "(\\n[VS]p / 1000u)"
1046 . ie (\\n[PS] >= 1000) \
1047 . par*vs "((\\n[PS]p / 1000u) + 2p)"
1049 . par*vs "(\\n[PS] + 2)"
1051 .if dFAM .fam \\*[FAM]
1055 .CHECK-FOOTER-AND-KEEP
1058 .\" If it's too big to be in points, treat it as units.
1059 .ie (p;\\$1)>=40p .vs (u;\\$1)
1063 .nr 0:li (u;\\n[LL]/12)
1070 .aln \\n[.ev]:MCLL LL
1072 .aln \\n[.ev]:MCLT LT
1078 .\" happens when the first page begins
1080 .if !rLT .nr LT \\n[LL]
1081 .if !rFL .nr FL \\n[LL]*5/6
1083 . ie (\\n[PS] >= 1000) \
1084 . nr VS (\\n[PS] + 2000)
1086 . nr VS (\\n[PS] + 2)
1090 . ie (\\n[PS] >= 1000) \
1091 . nr FPS (\\n[PS] - 2000)
1093 . nr FPS (\\n[PS] - 2)
1096 . ie (\\n[FPS] >= 1000) \
1097 . nr FVS (\\n[FPS] + 2000)
1099 . nr FVS (\\n[FPS] + 2)
1101 .\" don't change environment 0
1103 .ie (\\n[PS] >= 1000) \
1104 . ps (\\n[PS]z / 1000u)
1109 .ie (\\n[VS] >= 1000) \
1110 . par*vs "(\\n[VS]p / 1000u)"
1113 .if !rPD .nr PD .3v>?\n(.V
1114 .if !rDD .nr DD .5v>?\n(.V
1116 .if !rFPD .nr FPD \\n[PD]/2
1118 .if !dFAM .ds FAM \\n[.fam]
1140 .aln fn:MCLL pg@fn-colw
1141 .aln fn:MCLT pg@fn-colw
1147 .nr \\n[.ev]:ai \\n[\\n[.ev]:PI]
1150 .nr \\n[.ev]:ds-type 0
1155 .if \\n[need_eo_tl]>0 .DEVTAG-EO-TL
1157 .if \\n[need_eo_h]>0 .DEVTAG-EO-H
1163 .ie \\n[pg@ncols]>1 \{\
1164 . ll (u;\\n[\\n[.ev]:MCLL]-\\n[\\n[.ev]:ri]-\\n[\\n[.ev]:pri])
1165 . lt \\n[\\n[.ev]:MCLT]u
1168 . ll (u;\\n[\\n[.ev]:LL]-\\n[\\n[.ev]:ri]-\\n[\\n[.ev]:pri])
1169 . lt \\n[\\n[.ev]:LT]u
1171 .in (u;\\n[\\n[.ev]:li]+\\n[\\n[.ev]:pli])
1174 .ie (\\n[\\n[.ev]:PS] >= 1000) \
1175 . ps (\\n[\\n[.ev]:PS]z / 1000u)
1177 . ps \\n[\\n[.ev]:PS]
1178 .ie (\\n[\\n[.ev]:VS] >= 1000) \
1179 . par*vs "(\\n[\\n[.ev]:VS]p / 1000u)"
1181 . par*vs \\n[\\n[.ev]:VS]
1191 .\" This can be redefined by the user.
1195 .\" \n[PORPHANS] sets number of initial lines of any paragraph,
1196 .\" which must be kept together, without any included page break.
1197 .\" Initialise to reproduce original behaviour; user may adjust it.
1198 .if !rPORPHANS .nr PORPHANS 1
1202 .nr \\n[.ev]:pli \\$1
1203 .nr \\n[.ev]:pri \\$2
1205 .sp \\n[\\n[.ev]:PD]u
1206 .ne \\n[PORPHANS]v+\\n(.Vu
1216 .nr \\n[.ev]:ai \\n[\\n[.ev]:PI]
1220 .nr \\n[.ev]:ai \\n[\\n[.ev]:PI]
1221 .if !'\*(.T'html' .ti +\\n[\\n[.ev]:ai]u
1224 .nr \\n[.ev]:ai \\n[\\n[.ev]:PI]
1225 .par*start \\n[QI] \\n[QI]
1228 .par*start \\n[\\n[.ev]:PI] 0
1229 .ti -\\n[\\n[.ev]:PI]u
1232 .if \\n[.$]>1 .nr \\n[.ev]:ai (n;\\$2)
1233 .par*start \\n[\\n[.ev]:ai] 0
1235 . \" Divert the label so as to freeze any spaces.
1242 . ti -\\n[\\n[.ev]:ai]u
1243 . ie \\n[dl]+1n<=\\n[\\n[.ev]:ai] \{\
1245 \\*[par*label]\h'|\\n[\\n[.ev]:ai]u'\c
1257 .\" We don't want margin characters to be attached when we divert
1258 .\" the tag. Since there's no way to save and restore the current
1259 .\" margin character, we have to switch to a new environment, taking
1260 .\" what we need of the old environment with us.
1261 .de par*push-tag-env
1262 .nr par*saved-font \\n[.f]
1263 .nr par*saved-size \\n[.s]z
1264 .nr par*saved-ss \\n[.ss]
1265 .ds par*saved-fam \\n[.fam]
1269 .ft \\n[par*saved-font]
1270 .ps \\n[par*saved-size]u
1271 .ss \\n[par*saved-ss]
1272 .fam \\*[par*saved-fam]
1279 .nr \\n[.ev]:li!\\n[\\n[.ev]:il] \\n[\\n[.ev]:li]
1280 .nr \\n[.ev]:ri!\\n[\\n[.ev]:il] \\n[\\n[.ev]:ri]
1281 .nr \\n[.ev]:ai!\\n[\\n[.ev]:il] \\n[\\n[.ev]:ai]
1282 .nr \\n[.ev]:pli!\\n[\\n[.ev]:il] \\n[\\n[.ev]:pli]
1283 .nr \\n[.ev]:pri!\\n[\\n[.ev]:il] \\n[\\n[.ev]:pri]
1285 .nr \\n[.ev]:li +\\n[\\n[.ev]:ai]
1286 .nr \\n[.ev]:ai \\n[\\n[.ev]:PI]
1291 .ie \\n[\\n[.ev]:il] \{\
1293 . nr \\n[.ev]:ai \\n[\\n[.ev]:ai!\\n[\\n[.ev]:il]]
1294 . nr \\n[.ev]:li \\n[\\n[.ev]:li!\\n[\\n[.ev]:il]]
1295 . nr \\n[.ev]:ri \\n[\\n[.ev]:ri!\\n[\\n[.ev]:il]]
1296 . nr \\n[.ev]:pli \\n[\\n[.ev]:pli!\\n[\\n[.ev]:il]]
1297 . nr \\n[.ev]:pri \\n[\\n[.ev]:pri!\\n[\\n[.ev]:il]]
1299 .el .@error unbalanced \\$0
1304 .nr \\n[.ev]:li!\\n[\\n[.ev]:il] \\n[\\n[.ev]:li]
1305 .nr \\n[.ev]:ri!\\n[\\n[.ev]:il] \\n[\\n[.ev]:ri]
1306 .nr \\n[.ev]:ai!\\n[\\n[.ev]:il] \\n[\\n[.ev]:ai]
1307 .nr \\n[.ev]:pli!\\n[\\n[.ev]:il] \\n[\\n[.ev]:pli]
1308 .nr \\n[.ev]:pri!\\n[\\n[.ev]:il] \\n[\\n[.ev]:pri]
1310 .nr \\n[.ev]:li +\\n[QI]
1311 .nr \\n[.ev]:ri +\\n[QI]
1312 .nr \\n[.ev]:ai \\n[\\n[.ev]:PI]
1316 .\" start boxed text
1323 .nr par*box-in \\n[.in]
1324 .\" remember what 1n is, just in case the point size changes
1329 .ti \\n[par*box-in]u+1n
1331 .de @div-end!par*box-div
1335 .\" Postpone the drawing of the box until we're in the top-level diversion,
1336 .\" in case there's a footnote inside the box.
1338 .ie '\\n(.z'par*box-div' \{\
1340 . if \n[.V]>.25m .sp
1342 . if \n[.V]>.25m .sp
1348 . nr \\n[.ev]:ri -\\n[par*box-n]
1349 . nr \\n[.ev]:li -\\n[par*box-n]
1350 . in -\\n[par*box-n]u
1351 . ll +\\n[par*box-n]u
1352 . lt +\\n[par*box-n]u
1353 . par*box-draw \\n[.i]u \\n[.l]u-(\\n[.H]u==1n*1n)
1355 .el .@error B2 without B1
1358 .de par*box-mark-top
1363 .el \!.par*box-mark-top
1367 . nr par*box-in \\n[.i]
1368 . nr par*box-ll \\n[.l]
1369 . nr par*box-vpt \\n[.vpt]
1370 . nr par*box-ad \\n[.j]
1376 \D'l (u;\\n[.l]-\\n[.i]) 0'\
1377 \D'l 0 |\\n[par*box-top]u'\
1378 \D'l -(u;\\n[.l]-\\n[.i]) 0'\
1379 \D'l 0 -|\\n[par*box-top]u'
1382 . in \\n[par*box-in]u
1383 . ll \\n[par*box-ll]u
1384 . vpt \\n[par*box-vpt]
1385 . ad \\n[par*box-ad]
1387 .el \!.par*box-draw \\$1 \\$2
1389 .\" \n[HORPHANS] sets how many lines of the following paragraph must be
1390 .\" kept together, with a preceding section header. Initialise it,
1391 .\" to reproduce original behaviour; user may change it.
1392 .if !rHORPHANS .nr HORPHANS 1
1394 .\" \n[GROWPS] and \n[PSINCR] cause auto-increment of header point size.
1395 .\" Initialise them, so they have no effect, unless explicitly set by the user.
1396 .if !rGROWPS .nr GROWPS 0
1397 .if !rPSINCR .nr PSINCR 1p
1401 .\" Keep the heading and the first few lines of the next paragraph together.
1402 .\" (\n[HORPHANS] defines "first few" -- default = 1; user may redefine it).
1403 .nr sh*minvs \\n[HORPHANS]v
1404 .if \\n[sh*psincr]<0 .nr sh*psincr 0
1405 .ie \\n(VS<1000 .par*vs \\n(VSp+\\n[sh*psincr]u
1406 .el .par*vs \\n(VSp/1000u+\\n[sh*psincr]u
1407 .ne 2v+\\n[sh*minvs]u+\\n[\\n[.ev]:PD]u+\\n(.Vu
1408 .\" Adjust point size for heading text, as specified by \n[GROWPS] and \n[PSINCR].
1409 .ie \\n(PS<1000 .ps \\n(PS+\\n[sh*psincr]u
1410 .el .ps \\n(PSz/1000u+\\n[sh*psincr]u
1415 .\" Standard ms implementation does not expect an argument,
1416 .\" but allow ".SH n" to make heading point size match ".NH n",
1417 .\" for same "n", when \n[GROWPS] and \n[PSINCR] are set.
1419 . if 0\\$1>0 .nr sh*psincr (\\n[GROWPS]-0\\$1)*\\n[PSINCR]
1422 . if '\*(.T'html' .nr need_eo_h 1
1424 .\" TL, AU, and AI are aliased to these in cov*ab-init.
1446 .\" In paragraph macros.
1448 .ie (\\n[\\n[.ev]:PS] >= 1000) \
1449 . ps (\\n[\\n[.ev]:PS]z / 1000u)
1451 . ps \\n[\\n[.ev]:PS]
1462 .\" par*define-font-macro macro font
1463 .de par*define-font-macro
1466 . nr par*prev-font \En[.f]
1467 \&\E$3\f[\\$2]\E$1\f[\En[par*prev-font]]\E$2
1472 .par*define-font-macro B B
1473 .par*define-font-macro I I
1474 .par*define-font-macro BI BI
1475 .par*define-font-macro CW CR
1476 .\" underline a word
1478 \Z'\\$1'\v'.25m'\D'l \w'\\$1'u 0'\v'-.25m'\\$2
1482 .nr par*bxw \w'\\$1'+.4m
1483 \Z'\v'.25m'\D'l 0 -1m'\D'l \\n[par*bxw]u 0'\D'l 0 1m'\D'l -\\n[par*bxw]u 0''\
1487 .\" The first time UX is used, put a registered mark after it.
1490 \s[\\n[.s]*8u/10u]UNIX\s0\\$1\\*[par*ux-rg]
1493 .ds par@sup-start \v'-.9m\s'\En[.s]*7u/10u'+.7m'
1494 .als { par@sup-start
1495 .ds par@sup-end \v'-.7m\s0+.9m'
1497 .\" footnote paragraphs
1498 .\" FF is the footnote format
1500 .\" This can be redefined. It gets a second argument of `no' if the first
1501 .\" argument was supplied by the user, rather than automatically.
1504 .if !d par*fp!\\n[FF] \{\
1505 . @error unknown footnote format `\\n[FF]'
1508 .ie '\\$2'no' .par*fp!\\n[FF]-no "\\$1"
1509 .el .par*fp!\\n[FF] "\\$1"
1513 \&\\*[par@sup-start]\\$1\\*[par@sup-end]\ \c
1536 .@IP "\\$1." (u;\\n[\\n[.ev]:PI]*2)
1539 .@IP "\\$1" (u;\\n[\\n[.ev]:PI]*2)
1541 .\" ***************************
1542 .\" ******** module nh ********
1543 .\" ***************************
1544 .\" Numbered headings.
1545 .\" nh*hl is the level of the last heading
1547 .\" SN-DOT and SN-NO-DOT represent the section number of
1548 .\" the current heading, with and without a terminating dot.
1551 .\" SN-STYLE sets the statement numbering style used in headings
1552 .\" (either SN-DOT or SN-NO-DOT); for backward compatibility with
1553 .\" earlier ms versions, the default is SN-DOT
1554 .als SN-STYLE SN-DOT
1555 .\" Also for backward compatibility, let SN represent SN-DOT.
1557 .\" numbered heading
1564 . nr H\\n[nh*hl] 0\\$1
1567 . if !\\n[nh*hl] \{\
1570 . @error missing arguments to .NH S
1574 . nr nh*ohl \\n[nh*hl]
1577 . ie \\n[nh*hl]<=0 \{\
1582 . if \\n[nh*hl]-\\n[nh*ohl]>1 \
1583 . @warning .NH \\n[nh*ohl] followed by .NH \\n[nh*hl]
1587 . while \\n[nh*hl]>\\n[nh*ohl] \{\
1593 .ds SN-NO-DOT \\n(H1
1595 .while \\n[nh*i]<\\n[nh*hl] \{\
1597 . as SN-NO-DOT .\\n[H\\n[nh*i]]
1599 .ds SN-DOT \\*[SN-NO-DOT].
1600 .nr sh*psincr (\\n[GROWPS]-\\n[nh*hl])*\\n[PSINCR]
1603 . if '\*(.T'html' .nr need_eo_h 1
1606 .\" ****************************
1607 .\" ******** module toc ********
1608 .\" ****************************
1609 .\" Table of contents generation.
1613 .ie \\n[.$] .XA "\\$1"
1616 .de @div-end!toc*div
1620 .ie '\\n(.z'toc*div' \{\
1621 . if d toc*num .toc*end-entry
1623 . ie '\\$1'no' .ds toc*num
1624 . el .ds toc*num "\\$1
1626 . el .ds toc*num \\n[PN]
1633 .el .@error XA without XS
1636 .ie '\\n(.z'toc*div' \{\
1637 . if d toc*num .toc*end-entry
1641 .el .@error XE without XS
1652 . ie (\\n[PS] >= 1000) \
1653 . ps ((\\n[PS]z / 1000u) + 2z)
1662 .char \[toc*leader-char] .\h'1m'
1663 .lc \[toc*leader-char]
1664 .ta (u;\\n[.l]-\\n[.i]-\w'000') (u;\\n[.l]-\\n[.i])R
1669 .\" print the table of contents on page i
1675 .\" ****************************
1676 .\" ******** module eqn ********
1677 .\" ****************************
1686 .ie '\\$1'L' .nr eqn*type 0
1688 . ie '\\$1'I' .nr eqn*type 1
1691 . if !'\\$1'C' .ds eqn*num "\\$1
1696 .if '\*(.T'html' \{\
1700 .if \\n[eqn*type]=0 .EQN-HTML-IMAGE-LEFT
1701 .if \\n[eqn*type]=1 \{\
1702 . if '\*(.T'html' .RS
1703 .EQN-HTML-IMAGE-INLINE
1705 .if \\n[eqn*type]=2 .EQN-HTML-IMAGE
1708 .de @div-end!eqn*div
1711 .\" Note that geqn mark and lineup work correctly in centered equations.
1713 .ie !'\\n(.z'eqn*div' .@error-recover mismatched EN
1718 . if !'\\*[eqn*num]'' .nr eqn*have-num 1
1719 . ie \\n[dl]:\\n[eqn*have-num] \{\
1722 . ds eqn*tabs \\n[.tabs]
1725 .\" --fixme-- this really should not be necessary
1726 .\" and indicates that there is extra space creeping into
1727 .\" an equation when ps4html is enabled..
1728 . ie r ps4html .ds@need \\n[dn]u-1v+\n[.V]u+1i
1729 . el .ds@need \\n[dn]u-1v+\n[.V]u
1731 . ie \\n[eqn*type]=0 \{\
1732 . ta (u;\\n[.l]-\\n[.i])R
1733 \\*[eqn*div]\t\\*[eqn*num]
1736 . ie \\n[eqn*type]=1 .ta \\n[DI]u \
1737 (u;\\n[.l]-\\n[.i])R
1738 . el .ta (u;\\n[.l]-\\n[.i]/2)C \
1739 (u;\\n[.l]-\\n[.i])R
1740 \t\\*[eqn*div]\t\\*[eqn*num]
1744 . ta (u;\\n[.l]-\\n[.i])R
1747 .\". if !'\*(.T'html' .sp \\n[DD]u
1752 .\" must terminate empty equations in html and ps4html as they contain
1753 .\" the EQN-HTML-IMAGE-END suppression nodes
1754 . if \\n[dl] .chop eqn*div
1755 . if '\*(.T'html' \\*[eqn*div]
1756 . if r ps4html \\*[eqn*div]
1758 . if !'\*(.T'html' .fi
1759 . if \\n[eqn*type]=0 .EQN-HTML-IMAGE-END
1760 . if \\n[eqn*type]=1 \{\
1761 . EQN-HTML-IMAGE-END
1762 . if '\*(.T'html' .RE
1764 . if \\n[eqn*type]=2 .EQN-HTML-IMAGE-END
1770 .\" ****************************
1771 .\" ******** module tbl ********
1772 .\" ****************************
1774 .nr tbl*have-header 0
1775 .\" This gets called if TS occurs before the first paragraph.
1778 .\" cov*ab-init aliases TS to @TS
1783 .if '\\$1'H' .di tbl*header-div
1784 .if '\*(.T'html' \{\
1791 .if \\n[tbl*have-header] \{\
1792 . ie \\n[.t]-\\n[tbl*header-ht]-1v .tbl*print-header
1796 .de tbl*print-header
1803 .ie '\\n[.z]'tbl*header-div' \{\
1808 . ie \\n[dn]+\\n[FM]+\\n[HM]+2v>=\\n[.p] \{\
1809 . @error ridiculously long table header
1814 . nr tbl*header-ht \\n[dn]
1815 . ds@need \\n[dn]u+1v
1817 . nr tbl*have-header 1
1820 .el .@error-recover .TH without .TS H
1822 .de @div-end!tbl*header-div
1827 .ie '\\n(.z'tbl*header-div' .@error-recover .TS H but no .TH before .TE
1829 . nr tbl*have-header 0
1830 . if !'\*(.T'html' .sp \\n[DD]u
1839 .if \\n[tbl*have-header] \{\
1846 .\" ****************************
1847 .\" ******** module pic ********
1848 .\" ****************************
1854 .ie \\n[.$]<2 .@error bad arguments to PS (not preprocessed with pic?)
1856 . ds@need (u;\\$1)+1v
1857 . in +(u;\\n[.l]-\\n[.i]-\\$2/2>?0)
1866 .\" ****************************
1867 .\" ******** module ref ********
1868 .\" ****************************
1871 .\" ****************************
1872 .\" ******** module acc ********
1873 .\" ****************************
1874 .\" Accents and special characters.
1879 .\" The idea of this definition is for the top of the 3 to be at the x-height.
1880 .if !c\[yogh] .char \[yogh] \Z'\v'\w'x'*0-\En[rst]u'\s[\En[.s]*8u/10u]\
1881 \v'\w'3'*0+\En[rst]u'3\s0'\h'\w'\s[\En[.s]*8u/10u]3'u'
1884 .ds \\$1 \Z'\v'(u;\w'x'*0+\En[rst]-\En[.cht])'\
1885 \h'(u;-\En[skw]+(-\En[.w]-\w'\\$2'/2)+\En[.csk])'\\$2'
1888 .ds \\$1 \Z'\v'\En[.cdp]u'\h'(u;-\En[.w]-\w'\\$2'/2)'\\$2'
1891 .ds \\$1 \Z'\h'(u;-\En[.w]-\w'\\$2'/2)'\
1892 \v'(u;\En[.cdp]-\En[.cht]+\En[rst]+\En[rsb]/2)'\\$2'
1895 .ds \\$1 \Z'\h'(u;\w'x'-\w'\\$2'/2)'\\$2'
1897 .acc*prefix-def ' \'
1898 .acc*prefix-def ` \`
1900 .acc*prefix-def , \(ac
1901 .acc*prefix-def : \(ad
1903 .\" improved accent marks
1909 .acc*over-def : \(ad
1910 .acc*over-def v \(ah
1911 .acc*over-def _ \(a-
1912 .acc*over-def o \(ao
1913 .acc*under-def , \(ac
1914 .acc*under-def . \s[\En[.s]*8u/10u]\v'.2m'.\v'-.2m'\s0
1915 .acc*under-def hook \(ho
1917 .char \[hooko] o\E*[hook]
1920 .ds D- \(-D\" Icelandic uppercase eth
1921 .ds d- \(Sd\" Icelandic lowercase eth
1922 .ds Th \(TP\" Icelandic uppercase thorn
1923 .ds th \(Tp\" Icelandic lowercase thorn
1924 .ds 8 \(ss\" German double s
1925 .ds Ae \(AE\" AE ligature
1926 .ds ae \(ae\" ae ligature
1927 .ds Oe \(OE\" OE ligature
1928 .ds oe \(oe\" oe ligature
1929 .ds ? \(r?\" upside down ?
1930 .ds ! \(r!\" upside down !
1932 .de CHECK-FOOTER-AND-KEEP
1933 .if '\*(.T'html' \{\
1950 .\" ****************************
1951 .\" ******** module bell ********
1952 .\" ****************************
1953 .\" Emulate Bell Labs localisms. Note, (a) they're not documented, and
1954 .\" (b) the .P1 and .UC macros collide with different ones in Berkeley ms.
1955 .\" We hack around this by conditionalizing the behavior of P1; UC was
1956 .\" not defined by groff and will be a no-op if called Berkeley style
1957 .\" with no arguments, so there is no problem with hijacking it here.
1959 .\" What's done here is sufficient to give back the Guide to EQN (1976) its
1960 .\" section headings and restore some text that had gone missing as macro
1961 .\" arguments; no warranty express or implied is given as to how well the
1962 .\" typographic details these produce match the original Bell Labs macros.
1964 .\" P1 is now defined in module pg.
1966 .nr bell_localisms 1
1971 .if r bell_localisms \f(CW\\$*\fP
1974 .if r bell_localisms \{\
1979 .\" Make sure that no blank lines creep in at the end of this file.