Few last minute patches from main on 960811
[glibc.git] / manual / texinfo.tex
blob93b2803568704c243b5409ae74f8e8041b715886
1 %% TeX macros to handle texinfo files
3 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93,
4 % 94, 95, 1996 Free Software Foundation, Inc.
6 %This texinfo.tex file is free software; you can redistribute it and/or
7 %modify it under the terms of the GNU General Public License as
8 %published by the Free Software Foundation; either version 2, or (at
9 %your option) any later version.
11 %This texinfo.tex file is distributed in the hope that it will be
12 %useful, but WITHOUT ANY WARRANTY; without even the implied warranty
13 %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 %General Public License for more details.
16 %You should have received a copy of the GNU General Public License
17 %along with this texinfo.tex file; see the file COPYING. If not, write
18 %to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 %Boston, MA 02111-1307, USA.
22 %In other words, you are welcome to use, share and improve this program.
23 %You are forbidden to forbid anyone else to use, share and improve
24 %what you give them. Help stamp out software-hoarding!
27 % Send bug reports to bug-texinfo@prep.ai.mit.edu.
28 % Please include a *precise* test case in each bug report.
31 % Make it possible to create a .fmt file just by loading this file:
32 % if the underlying format is not loaded, start by loading it now.
33 % Added by gildea November 1993.
34 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
36 % This automatically updates the version number based on RCS.
37 \def\deftexinfoversion$#1: #2 ${\def\texinfoversion{#2}}
38 \deftexinfoversion$Revision: 2.178 $
39 \message{Loading texinfo package [Version \texinfoversion]:}
41 % If in a .fmt file, print the version number
42 % and turn on active characters that we couldn't do earlier because
43 % they might have appeared in the input file name.
44 \everyjob{\message{[Texinfo version \texinfoversion]}\message{}
45 \catcode`+=\active \catcode`\_=\active}
47 % Save some parts of plain tex whose names we will redefine.
49 \let\ptextilde=\~
50 \let\ptexlbrace=\{
51 \let\ptexrbrace=\}
52 \let\ptexdots=\dots
53 \let\ptexdot=\.
54 \let\ptexstar=\*
55 \let\ptexend=\end
56 \let\ptexbullet=\bullet
57 \let\ptexb=\b
58 \let\ptexc=\c
59 \let\ptexi=\i
60 \let\ptext=\t
61 \let\ptexl=\l
62 \let\ptexL=\L
64 % Be sure we're in horizontal mode when doing a tie, since we make space
65 % equivalent to this in @example-like environments. Otherwise, a space
66 % at the beginning of a line will start with \penalty -- and
67 % since \penalty is valid in vertical mode, we'd end up putting the
68 % penalty on the vertical list instead of in the new paragraph.
69 {\catcode`@ = 11
70 % Avoid using \@M directly, because that causes trouble
71 % if the definition is written into an index file.
72 \global\let\tiepenalty = \@M
73 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
75 \let\~ = \tie % And make it available as @~.
77 \message{Basics,}
78 \chardef\other=12
80 % If this character appears in an error message or help string, it
81 % starts a new line in the output.
82 \newlinechar = `^^J
84 % Set up fixed words for English.
85 \ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter}}\fi%
86 \def\putwordInfo{Info}%
87 \ifx\putwordSee\undefined{\gdef\putwordSee{See}}\fi%
88 \ifx\putwordsee\undefined{\gdef\putwordsee{see}}\fi%
89 \ifx\putwordfile\undefined{\gdef\putwordfile{file}}\fi%
90 \ifx\putwordpage\undefined{\gdef\putwordpage{page}}\fi%
91 \ifx\putwordsection\undefined{\gdef\putwordsection{section}}\fi%
92 \ifx\putwordSection\undefined{\gdef\putwordSection{Section}}\fi%
93 \ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents}}\fi%
94 \ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents}}\fi%
95 \ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix}}\fi%
97 % Ignore a token.
99 \def\gobble#1{}
101 \hyphenation{ap-pen-dix}
102 \hyphenation{mini-buf-fer mini-buf-fers}
103 \hyphenation{eshell}
105 % Margin to add to right of even pages, to left of odd pages.
106 \newdimen \bindingoffset \bindingoffset=0pt
107 \newdimen \normaloffset \normaloffset=\hoffset
108 \newdimen\pagewidth \newdimen\pageheight
109 \pagewidth=\hsize \pageheight=\vsize
111 % Sometimes it is convenient to have everything in the transcript file
112 % and nothing on the terminal. We don't just call \tracingall here,
113 % since that produces some useless output on the terminal.
115 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
116 \def\loggingall{\tracingcommands2 \tracingstats2
117 \tracingpages1 \tracingoutput1 \tracinglostchars1
118 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
119 \showboxbreadth\maxdimen\showboxdepth\maxdimen
122 %---------------------Begin change-----------------------
124 %%%% For @cropmarks command.
125 % Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986
127 \newdimen\cornerlong \newdimen\cornerthick
128 \newdimen \topandbottommargin
129 \newdimen \outerhsize \newdimen \outervsize
130 \cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks
131 \outerhsize=7in
132 %\outervsize=9.5in
133 % Alternative @smallbook page size is 9.25in
134 \outervsize=9.25in
135 \topandbottommargin=.75in
137 %---------------------End change-----------------------
139 % \onepageout takes a vbox as an argument. Note that \pagecontents
140 % does insertions itself, but you have to call it yourself.
141 \chardef\PAGE=255 \output={\onepageout{\pagecontents\PAGE}}
142 \def\onepageout#1{\hoffset=\normaloffset
143 \ifodd\pageno \advance\hoffset by \bindingoffset
144 \else \advance\hoffset by -\bindingoffset\fi
145 {\escapechar=`\\\relax % makes sure backslash is used in output files.
146 \shipout\vbox{{\let\hsize=\pagewidth \makeheadline} \pagebody{#1}%
147 {\let\hsize=\pagewidth \makefootline}}}%
148 \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
150 %%%% For @cropmarks command %%%%
152 % Here is a modification of the main output routine for Near East Publications
153 % This provides right-angle cropmarks at all four corners.
154 % The contents of the page are centerlined into the cropmarks,
155 % and any desired binding offset is added as an \hskip on either
156 % site of the centerlined box. (P. A. MacKay, 12 November, 1986)
158 \def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up
159 {\escapechar=`\\\relax % makes sure backslash is used in output files.
160 \shipout
161 \vbox to \outervsize{\hsize=\outerhsize
162 \vbox{\line{\ewtop\hfill\ewtop}}
163 \nointerlineskip
164 \line{\vbox{\moveleft\cornerthick\nstop}
165 \hfill
166 \vbox{\moveright\cornerthick\nstop}}
167 \vskip \topandbottommargin
168 \centerline{\ifodd\pageno\hskip\bindingoffset\fi
169 \vbox{
170 {\let\hsize=\pagewidth \makeheadline}
171 \pagebody{#1}
172 {\let\hsize=\pagewidth \makefootline}}
173 \ifodd\pageno\else\hskip\bindingoffset\fi}
174 \vskip \topandbottommargin plus1fill minus1fill
175 \boxmaxdepth\cornerthick
176 \line{\vbox{\moveleft\cornerthick\nsbot}
177 \hfill
178 \vbox{\moveright\cornerthick\nsbot}}
179 \nointerlineskip
180 \vbox{\line{\ewbot\hfill\ewbot}}
182 \advancepageno
183 \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
185 % Do @cropmarks to get crop marks
186 \def\cropmarks{\let\onepageout=\croppageout }
188 \newinsert\margin \dimen\margin=\maxdimen
190 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
191 {\catcode`\@ =11
192 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
193 % marginal hacks, juha@viisa.uucp (Juha Takala)
194 \ifvoid\margin\else % marginal info is present
195 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
196 \dimen@=\dp#1 \unvbox#1
197 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
198 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
202 % Here are the rules for the cropmarks. Note that they are
203 % offset so that the space between them is truly \outerhsize or \outervsize
204 % (P. A. MacKay, 12 November, 1986)
206 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
207 \def\nstop{\vbox
208 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
209 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
210 \def\nsbot{\vbox
211 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
213 % Parse an argument, then pass it to #1. The argument is the rest of
214 % the input line (except we remove a trailing comment). #1 should be a
215 % macro which expects an ordinary undelimited TeX argument.
217 \def\parsearg#1{%
218 \let\next = #1%
219 \begingroup
220 \obeylines
221 \futurelet\temp\parseargx
224 % If the next token is an obeyed space (from an @example environment or
225 % the like), remove it and recurse. Otherwise, we're done.
226 \def\parseargx{%
227 % \obeyedspace is defined far below, after the definition of \sepspaces.
228 \ifx\obeyedspace\temp
229 \expandafter\parseargdiscardspace
230 \else
231 \expandafter\parseargline
235 % Remove a single space (as the delimiter token to the macro call).
236 {\obeyspaces %
237 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
239 {\obeylines %
240 \gdef\parseargline#1^^M{%
241 \endgroup % End of the group started in \parsearg.
243 % First remove any @c comment, then any @comment.
244 % Result of each macro is put in \toks0.
245 \argremovec #1\c\relax %
246 \expandafter\argremovecomment \the\toks0 \comment\relax %
248 % Call the caller's macro, saved as \next in \parsearg.
249 \expandafter\next\expandafter{\the\toks0}%
253 % Since all \c{,omment} does is throw away the argument, we can let TeX
254 % do that for us. The \relax here is matched by the \relax in the call
255 % in \parseargline; it could be more or less anything, its purpose is
256 % just to delimit the argument to the \c.
257 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
258 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
260 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
261 % @end itemize @c foo
262 % will have two active spaces as part of the argument with the
263 % `itemize'. Here we remove all active spaces from #1, and assign the
264 % result to \toks0.
266 % This loses if there are any *other* active characters besides spaces
267 % in the argument -- _ ^ +, for example -- since they get expanded.
268 % Fortunately, Texinfo does not define any such commands. (If it ever
269 % does, the catcode of the characters in questionwill have to be changed
270 % here.) But this means we cannot call \removeactivespaces as part of
271 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
272 % that \parsearg gets might well have any character at all in it.
274 \def\removeactivespaces#1{%
275 \begingroup
276 \ignoreactivespaces
277 \edef\temp{#1}%
278 \global\toks0 = \expandafter{\temp}%
279 \endgroup
282 % Change the active space to expand to nothing.
284 \begingroup
285 \obeyspaces
286 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
287 \endgroup
290 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
292 %% These are used to keep @begin/@end levels from running away
293 %% Call \inENV within environments (after a \begingroup)
294 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
295 \def\ENVcheck{%
296 \ifENV\errmessage{Still within an environment. Type Return to continue.}
297 \endgroup\fi} % This is not perfect, but it should reduce lossage
299 % @begin foo is the same as @foo, for now.
300 \newhelp\EMsimple{Type <Return> to continue.}
302 \outer\def\begin{\parsearg\beginxxx}
304 \def\beginxxx #1{%
305 \expandafter\ifx\csname #1\endcsname\relax
306 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
307 \csname #1\endcsname\fi}
309 % @end foo executes the definition of \Efoo.
311 \def\end{\parsearg\endxxx}
312 \def\endxxx #1{%
313 \removeactivespaces{#1}%
314 \edef\endthing{\the\toks0}%
316 \expandafter\ifx\csname E\endthing\endcsname\relax
317 \expandafter\ifx\csname \endthing\endcsname\relax
318 % There's no \foo, i.e., no ``environment'' foo.
319 \errhelp = \EMsimple
320 \errmessage{Undefined command `@end \endthing'}%
321 \else
322 \unmatchedenderror\endthing
324 \else
325 % Everything's ok; the right environment has been started.
326 \csname E\endthing\endcsname
330 % There is an environment #1, but it hasn't been started. Give an error.
332 \def\unmatchedenderror#1{%
333 \errhelp = \EMsimple
334 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
337 % Define the control sequence \E#1 to give an unmatched @end error.
339 \def\defineunmatchedend#1{%
340 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
344 % Single-spacing is done by various environments (specifically, in
345 % \nonfillstart and \quotations).
346 \newskip\singlespaceskip \singlespaceskip = 12.5pt
347 \def\singlespace{%
348 % Why was this kern here? It messes up equalizing space above and below
349 % environments. --karl, 6may93
350 %{\advance \baselineskip by -\singlespaceskip
351 %\kern \baselineskip}%
352 \setleading \singlespaceskip
355 %% Simple single-character @ commands
357 % @@ prints an @
358 % Kludge this until the fonts are right (grr).
359 \def\@{{\tt \char '100}}
361 % This is turned off because it was never documented
362 % and you can use @w{...} around a quote to suppress ligatures.
363 %% Define @` and @' to be the same as ` and '
364 %% but suppressing ligatures.
365 %\def\`{{`}}
366 %\def\'{{'}}
368 % Used to generate quoted braces.
370 \def\mylbrace {{\tt \char '173}}
371 \def\myrbrace {{\tt \char '175}}
372 \let\{=\mylbrace
373 \let\}=\myrbrace
375 % @: forces normal size whitespace following.
376 \def\:{\spacefactor=1000 }
378 % @* forces a line break.
379 \def\*{\hfil\break\hbox{}\ignorespaces}
381 % @. is an end-of-sentence period.
382 \def\.{.\spacefactor=3000 }
384 % @enddots{} is an end-of-sentence ellipsis.
385 \gdef\enddots{$\mathinner{\ldotp\ldotp\ldotp\ldotp}$\spacefactor=3000}
387 % @! is an end-of-sentence bang.
388 \gdef\!{!\spacefactor=3000 }
390 % @? is an end-of-sentence query.
391 \gdef\?{?\spacefactor=3000 }
393 % @w prevents a word break. Without the \leavevmode, @w at the
394 % beginning of a paragraph, when TeX is still in vertical mode, would
395 % produce a whole line of output instead of starting the paragraph.
396 \def\w#1{\leavevmode\hbox{#1}}
398 % @group ... @end group forces ... to be all on one page, by enclosing
399 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
400 % to keep its height that of a normal line. According to the rules for
401 % \topskip (p.114 of the TeXbook), the glue inserted is
402 % max (\topskip - \ht (first item), 0). If that height is large,
403 % therefore, no glue is inserted, and the space between the headline and
404 % the text is small, which looks bad.
406 \def\group{\begingroup
407 \ifnum\catcode13=\active \else
408 \errhelp = \groupinvalidhelp
409 \errmessage{@group invalid in context where filling is enabled}%
412 % The \vtop we start below produces a box with normal height and large
413 % depth; thus, TeX puts \baselineskip glue before it, and (when the
414 % next line of text is done) \lineskip glue after it. (See p.82 of
415 % the TeXbook.) Thus, space below is not quite equal to space
416 % above. But it's pretty close.
417 \def\Egroup{%
418 \egroup % End the \vtop.
419 \endgroup % End the \group.
422 \vtop\bgroup
423 % We have to put a strut on the last line in case the @group is in
424 % the midst of an example, rather than completely enclosing it.
425 % Otherwise, the interline space between the last line of the group
426 % and the first line afterwards is too small. But we can't put the
427 % strut in \Egroup, since there it would be on a line by itself.
428 % Hence this just inserts a strut at the beginning of each line.
429 \everypar = {\strut}%
431 % Since we have a strut on every line, we don't need any of TeX's
432 % normal interline spacing.
433 \offinterlineskip
435 % OK, but now we have to do something about blank
436 % lines in the input in @example-like environments, which normally
437 % just turn into \lisppar, which will insert no space now that we've
438 % turned off the interline space. Simplest is to make them be an
439 % empty paragraph.
440 \ifx\par\lisppar
441 \edef\par{\leavevmode \par}%
443 % Reset ^^M's definition to new definition of \par.
444 \obeylines
447 % Do @comment since we are called inside an environment such as
448 % @example, where each end-of-line in the input causes an
449 % end-of-line in the output. We don't want the end-of-line after
450 % the `@group' to put extra space in the output. Since @group
451 % should appear on a line by itself (according to the Texinfo
452 % manual), we don't worry about eating any user text.
453 \comment
456 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
457 % message, so this ends up printing `@group can only ...'.
459 \newhelp\groupinvalidhelp{%
460 group can only be used in environments such as @example,^^J%
461 where each line of input produces a line of output.}
463 % @need space-in-mils
464 % forces a page break if there is not space-in-mils remaining.
466 \newdimen\mil \mil=0.001in
468 \def\need{\parsearg\needx}
470 % Old definition--didn't work.
471 %\def\needx #1{\par %
472 %% This method tries to make TeX break the page naturally
473 %% if the depth of the box does not fit.
474 %{\baselineskip=0pt%
475 %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
476 %\prevdepth=-1000pt
479 \def\needx#1{%
480 % Go into vertical mode, so we don't make a big box in the middle of a
481 % paragraph.
482 \par
484 % Don't add any leading before our big empty box, but allow a page
485 % break, since the best break might be right here.
486 \allowbreak
487 \nointerlineskip
488 \vtop to #1\mil{\vfil}%
490 % TeX does not even consider page breaks if a penalty added to the
491 % main vertical list is 10000 or more. But in order to see if the
492 % empty box we just added fits on the page, we must make it consider
493 % page breaks. On the other hand, we don't want to actually break the
494 % page after the empty box. So we use a penalty of 9999.
496 % There is an extremely small chance that TeX will actually break the
497 % page at this \penalty, if there are no other feasible breakpoints in
498 % sight. (If the user is using lots of big @group commands, which
499 % almost-but-not-quite fill up a page, TeX will have a hard time doing
500 % good page breaking, for example.) However, I could not construct an
501 % example where a page broke at this \penalty; if it happens in a real
502 % document, then we can reconsider our strategy.
503 \penalty9999
505 % Back up by the size of the box, whether we did a page break or not.
506 \kern -#1\mil
508 % Do not allow a page break right after this kern.
509 \nobreak
512 % @br forces paragraph break
514 \let\br = \par
516 % @dots{} output some dots
518 \def\dots{$\ldots$}
520 % @page forces the start of a new page
522 \def\page{\par\vfill\supereject}
524 % @exdent text....
525 % outputs text on separate line in roman font, starting at standard page margin
527 % This records the amount of indent in the innermost environment.
528 % That's how much \exdent should take out.
529 \newskip\exdentamount
531 % This defn is used inside fill environments such as @defun.
532 \def\exdent{\parsearg\exdentyyy}
533 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
535 % This defn is used inside nofill environments such as @example.
536 \def\nofillexdent{\parsearg\nofillexdentyyy}
537 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
538 \leftline{\hskip\leftskip{\rm#1}}}}
540 % @inmargin{TEXT} puts TEXT in the margin next to the current paragraph.
542 \def\inmargin#1{%
543 \strut\vadjust{\nobreak\kern-\strutdepth
544 \vtop to \strutdepth{\baselineskip\strutdepth\vss
545 \llap{\rightskip=\inmarginspacing \vbox{\noindent #1}}\null}}}
546 \newskip\inmarginspacing \inmarginspacing=1cm
547 \def\strutdepth{\dp\strutbox}
549 %\hbox{{\rm#1}}\hfil\break}}
551 % @include file insert text of that file as input.
552 % Allow normal characters that we make active in the argument (a file name).
553 \def\include{\begingroup
554 \catcode`\\=12
555 \catcode`~=12
556 \catcode`^=12
557 \catcode`_=12
558 \catcode`|=12
559 \catcode`<=12
560 \catcode`>=12
561 \catcode`+=12
562 \parsearg\includezzz}
563 % Restore active chars for included file.
564 \def\includezzz#1{\endgroup\begingroup
565 % Read the included file in a group so nested @include's work.
566 \def\thisfile{#1}%
567 \input\thisfile
568 \endgroup}
570 \def\thisfile{}
572 % @center line outputs that line, centered
574 \def\center{\parsearg\centerzzz}
575 \def\centerzzz #1{{\advance\hsize by -\leftskip
576 \advance\hsize by -\rightskip
577 \centerline{#1}}}
579 % @sp n outputs n lines of vertical space
581 \def\sp{\parsearg\spxxx}
582 \def\spxxx #1{\par \vskip #1\baselineskip}
584 % @comment ...line which is ignored...
585 % @c is the same as @comment
586 % @ignore ... @end ignore is another way to write a comment
588 \def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
589 \parsearg \commentxxx}
591 \def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
593 \let\c=\comment
595 % @paragraphindent is defined for the Info formatting commands only.
596 \let\paragraphindent=\comment
598 % Prevent errors for section commands.
599 % Used in @ignore and in failing conditionals.
600 \def\ignoresections{%
601 \let\chapter=\relax
602 \let\unnumbered=\relax
603 \let\top=\relax
604 \let\unnumberedsec=\relax
605 \let\unnumberedsection=\relax
606 \let\unnumberedsubsec=\relax
607 \let\unnumberedsubsection=\relax
608 \let\unnumberedsubsubsec=\relax
609 \let\unnumberedsubsubsection=\relax
610 \let\section=\relax
611 \let\subsec=\relax
612 \let\subsubsec=\relax
613 \let\subsection=\relax
614 \let\subsubsection=\relax
615 \let\appendix=\relax
616 \let\appendixsec=\relax
617 \let\appendixsection=\relax
618 \let\appendixsubsec=\relax
619 \let\appendixsubsection=\relax
620 \let\appendixsubsubsec=\relax
621 \let\appendixsubsubsection=\relax
622 \let\contents=\relax
623 \let\smallbook=\relax
624 \let\titlepage=\relax
627 % Used in nested conditionals, where we have to parse the Texinfo source
628 % and so want to turn off most commands, in case they are used
629 % incorrectly.
631 \def\ignoremorecommands{%
632 \let\defcodeindex = \relax
633 \let\defcv = \relax
634 \let\deffn = \relax
635 \let\deffnx = \relax
636 \let\defindex = \relax
637 \let\defivar = \relax
638 \let\defmac = \relax
639 \let\defmethod = \relax
640 \let\defop = \relax
641 \let\defopt = \relax
642 \let\defspec = \relax
643 \let\deftp = \relax
644 \let\deftypefn = \relax
645 \let\deftypefun = \relax
646 \let\deftypevar = \relax
647 \let\deftypevr = \relax
648 \let\defun = \relax
649 \let\defvar = \relax
650 \let\defvr = \relax
651 \let\ref = \relax
652 \let\xref = \relax
653 \let\printindex = \relax
654 \let\pxref = \relax
655 \let\settitle = \relax
656 \let\setchapternewpage = \relax
657 \let\setchapterstyle = \relax
658 \let\everyheading = \relax
659 \let\evenheading = \relax
660 \let\oddheading = \relax
661 \let\everyfooting = \relax
662 \let\evenfooting = \relax
663 \let\oddfooting = \relax
664 \let\headings = \relax
665 \let\include = \relax
666 \let\lowersections = \relax
667 \let\down = \relax
668 \let\raisesections = \relax
669 \let\up = \relax
670 \let\set = \relax
671 \let\clear = \relax
672 \let\item = \relax
675 % Ignore @ignore ... @end ignore.
677 \def\ignore{\doignore{ignore}}
679 % Also ignore @ifinfo, @ifhtml, @html, @menu, and @direntry text.
681 \def\ifinfo{\doignore{ifinfo}}
682 \def\ifhtml{\doignore{ifhtml}}
683 \def\html{\doignore{html}}
684 \def\menu{\doignore{menu}}
685 \def\direntry{\doignore{direntry}}
687 % @dircategory CATEGORY -- specify a category of the dir file
688 % which this file should belong to. Ignore this in TeX.
690 \def\dircategory{\comment}
692 % Ignore text until a line `@end #1'.
694 \def\doignore#1{\begingroup
695 % Don't complain about control sequences we have declared \outer.
696 \ignoresections
698 % Define a command to swallow text until we reach `@end #1'.
699 \long\def\doignoretext##1\end #1{\enddoignore}%
701 % Make sure that spaces turn into tokens that match what \doignoretext wants.
702 \catcode32 = 10
704 % And now expand that command.
705 \doignoretext
708 % What we do to finish off ignored text.
710 \def\enddoignore{\endgroup\ignorespaces}%
712 \newif\ifwarnedobs\warnedobsfalse
713 \def\obstexwarn{%
714 \ifwarnedobs\relax\else
715 % We need to warn folks that they may have trouble with TeX 3.0.
716 % This uses \immediate\write16 rather than \message to get newlines.
717 \immediate\write16{}
718 \immediate\write16{***WARNING*** for users of Unix TeX 3.0!}
719 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
720 \immediate\write16{If you are running another version of TeX, relax.}
721 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
722 \immediate\write16{ Then upgrade your TeX installation if you can.}
723 \immediate\write16{If you are stuck with version 3.0, run the}
724 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
725 \immediate\write16{ to use a workaround.}
726 \immediate\write16{}
727 \global\warnedobstrue
731 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
732 % workaround (which requires the file ``dummy.tfm'' to be installed),
733 % uncomment the following line:
734 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
736 % Ignore text, except that we keep track of conditional commands for
737 % purposes of nesting, up to an `@end #1' command.
739 \def\nestedignore#1{%
740 \obstexwarn
741 % We must actually expand the ignored text to look for the @end
742 % command, so that nested ignore constructs work. Thus, we put the
743 % text into a \vbox and then do nothing with the result. To minimize
744 % the change of memory overflow, we follow the approach outlined on
745 % page 401 of the TeXbook: make the current font be a dummy font.
747 \setbox0 = \vbox\bgroup
748 % Don't complain about control sequences we have declared \outer.
749 \ignoresections
751 % Define `@end #1' to end the box, which will in turn undefine the
752 % @end command again.
753 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
755 % We are going to be parsing Texinfo commands. Most cause no
756 % trouble when they are used incorrectly, but some commands do
757 % complicated argument parsing or otherwise get confused, so we
758 % undefine them.
760 % We can't do anything about stray @-signs, unfortunately;
761 % they'll produce `undefined control sequence' errors.
762 \ignoremorecommands
764 % Set the current font to be \nullfont, a TeX primitive, and define
765 % all the font commands to also use \nullfont. We don't use
766 % dummy.tfm, as suggested in the TeXbook, because not all sites
767 % might have that installed. Therefore, math mode will still
768 % produce output, but that should be an extremely small amount of
769 % stuff compared to the main input.
771 \nullfont
772 \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont
773 \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont
774 \let\tensf = \nullfont
775 % Similarly for index fonts (mostly for their use in
776 % smallexample)
777 \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont
778 \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont
779 \let\indsf = \nullfont
781 % Don't complain when characters are missing from the fonts.
782 \tracinglostchars = 0
784 % Don't bother to do space factor calculations.
785 \frenchspacing
787 % Don't report underfull hboxes.
788 \hbadness = 10000
790 % Do minimal line-breaking.
791 \pretolerance = 10000
793 % Do not execute instructions in @tex
794 \def\tex{\doignore{tex}}
797 % @set VAR sets the variable VAR to an empty value.
798 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
800 % Since we want to separate VAR from REST-OF-LINE (which might be
801 % empty), we can't just use \parsearg; we have to insert a space of our
802 % own to delimit the rest of the line, and then take it out again if we
803 % didn't need it. Make sure the catcode of space is correct to avoid
804 % losing inside @example, for instance.
806 \def\set{\begingroup\catcode` =10 \parsearg\setxxx}
807 \def\setxxx#1{\setyyy#1 \endsetyyy}
808 \def\setyyy#1 #2\endsetyyy{%
809 \def\temp{#2}%
810 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
811 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
813 \endgroup
815 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
816 % \next or other control sequences that we've defined might get us into
817 % an infinite loop. Consider `@set foo @cite{bar}'.
818 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
820 % @clear VAR clears (i.e., unsets) the variable VAR.
822 \def\clear{\parsearg\clearxxx}
823 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
825 % @value{foo} gets the text saved in variable foo.
827 \def\value#1{\expandafter
828 \ifx\csname SET#1\endcsname\relax
829 {\{No value for ``#1''\}}
830 \else \csname SET#1\endcsname \fi}
832 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
833 % with @set.
835 \def\ifset{\parsearg\ifsetxxx}
836 \def\ifsetxxx #1{%
837 \expandafter\ifx\csname SET#1\endcsname\relax
838 \expandafter\ifsetfail
839 \else
840 \expandafter\ifsetsucceed
843 \def\ifsetsucceed{\conditionalsucceed{ifset}}
844 \def\ifsetfail{\nestedignore{ifset}}
845 \defineunmatchedend{ifset}
847 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
848 % defined with @set, or has been undefined with @clear.
850 \def\ifclear{\parsearg\ifclearxxx}
851 \def\ifclearxxx #1{%
852 \expandafter\ifx\csname SET#1\endcsname\relax
853 \expandafter\ifclearsucceed
854 \else
855 \expandafter\ifclearfail
858 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
859 \def\ifclearfail{\nestedignore{ifclear}}
860 \defineunmatchedend{ifclear}
862 % @iftex always succeeds; we read the text following, through @end
863 % iftex). But `@end iftex' should be valid only after an @iftex.
865 \def\iftex{\conditionalsucceed{iftex}}
866 \defineunmatchedend{iftex}
868 % We can't just want to start a group at @iftex (for example) and end it
869 % at @end iftex, since then @set commands inside the conditional have no
870 % effect (they'd get reverted at the end of the group). So we must
871 % define \Eiftex to redefine itself to be its previous value. (We can't
872 % just define it to fail again with an ``unmatched end'' error, since
873 % the @ifset might be nested.)
875 \def\conditionalsucceed#1{%
876 \edef\temp{%
877 % Remember the current value of \E#1.
878 \let\nece{prevE#1} = \nece{E#1}%
880 % At the `@end #1', redefine \E#1 to be its previous value.
881 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
883 \temp
886 % We need to expand lots of \csname's, but we don't want to expand the
887 % control sequences after we've constructed them.
889 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
891 % @asis just yields its argument. Used with @table, for example.
893 \def\asis#1{#1}
895 % @math means output in math mode.
896 % We don't use $'s directly in the definition of \math because control
897 % sequences like \math are expanded when the toc file is written. Then,
898 % we read the toc file back, the $'s will be normal characters (as they
899 % should be, according to the definition of Texinfo). So we must use a
900 % control sequence to switch into and out of math mode.
902 % This isn't quite enough for @math to work properly in indices, but it
903 % seems unlikely it will ever be needed there.
905 \let\implicitmath = $
906 \def\math#1{\implicitmath #1\implicitmath}
908 % @bullet and @minus need the same treatment as @math, just above.
909 \def\bullet{\implicitmath\ptexbullet\implicitmath}
910 \def\minus{\implicitmath-\implicitmath}
912 \def\node{\ENVcheck\parsearg\nodezzz}
913 \def\nodezzz#1{\nodexxx [#1,]}
914 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
915 \let\nwnode=\node
916 \let\lastnode=\relax
918 \def\donoderef{\ifx\lastnode\relax\else
919 \expandafter\expandafter\expandafter\setref{\lastnode}\fi
920 \global\let\lastnode=\relax}
922 \def\unnumbnoderef{\ifx\lastnode\relax\else
923 \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
924 \global\let\lastnode=\relax}
926 \def\appendixnoderef{\ifx\lastnode\relax\else
927 \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
928 \global\let\lastnode=\relax}
930 \let\refill=\relax
932 % @setfilename is done at the beginning of every texinfo file.
933 % So open here the files we need to have open while reading the input.
934 % This makes it possible to make a .fmt file for texinfo.
935 \def\setfilename{%
936 \readauxfile
937 \opencontents
938 \openindices
939 \fixbackslash % Turn off hack to swallow `\input texinfo'.
940 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
941 \comment % Ignore the actual filename.
944 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
946 \def\inforef #1{\inforefzzz #1,,,,**}
947 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
948 node \samp{\ignorespaces#1{}}}
950 \def\macro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\macroxxx}
951 \def\macroxxx#1#2 \end macro{%
952 \expandafter\gdef\macrotemp#1{#2}%
953 \endgroup}
955 %\def\linemacro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\linemacroxxx}
956 %\def\linemacroxxx#1#2 \end linemacro{%
957 %\let\parsearg=\relax
958 %\edef\macrotempx{\csname M\butfirst\expandafter\string\macrotemp\endcsname}%
959 %\expandafter\xdef\macrotemp{\parsearg\macrotempx}%
960 %\expandafter\gdef\macrotempx#1{#2}%
961 %\endgroup}
963 %\def\butfirst#1{}
965 \message{fonts,}
967 % Font-change commands.
969 % Texinfo supports the sans serif font style, which plain TeX does not.
970 % So we set up a \sf analogous to plain's \rm, etc.
971 \newfam\sffam
972 \def\sf{\fam=\sffam \tensf}
973 \let\li = \sf % Sometimes we call it \li, not \sf.
975 % We don't need math for this one.
976 \def\ttsl{\tenttsl}
978 %% Try out Computer Modern fonts at \magstephalf
979 \let\mainmagstep=\magstephalf
981 % Set the font macro #1 to the font named #2, adding on the
982 % specified font prefix (normally `cm').
983 % #3 is the font's design size, #4 is a scale factor
984 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
986 % Use cm as the default font prefix.
987 % To specify the font prefix, you must define \fontprefix
988 % before you read in texinfo.tex.
989 \ifx\fontprefix\undefined
990 \def\fontprefix{cm}
992 % Support font families that don't use the same naming scheme as CM.
993 \def\rmshape{r}
994 \def\rmbshape{bx} %where the normal face is bold
995 \def\bfshape{b}
996 \def\bxshape{bx}
997 \def\ttshape{tt}
998 \def\ttbshape{tt}
999 \def\ttslshape{sltt}
1000 \def\itshape{ti}
1001 \def\itbshape{bxti}
1002 \def\slshape{sl}
1003 \def\slbshape{bxsl}
1004 \def\sfshape{ss}
1005 \def\sfbshape{ss}
1006 \def\scshape{csc}
1007 \def\scbshape{csc}
1009 \ifx\bigger\relax
1010 \let\mainmagstep=\magstep1
1011 \setfont\textrm\rmshape{12}{1000}
1012 \setfont\texttt\ttshape{12}{1000}
1013 \else
1014 \setfont\textrm\rmshape{10}{\mainmagstep}
1015 \setfont\texttt\ttshape{10}{\mainmagstep}
1017 % Instead of cmb10, you many want to use cmbx10.
1018 % cmbx10 is a prettier font on its own, but cmb10
1019 % looks better when embedded in a line with cmr10.
1020 \setfont\textbf\bfshape{10}{\mainmagstep}
1021 \setfont\textit\itshape{10}{\mainmagstep}
1022 \setfont\textsl\slshape{10}{\mainmagstep}
1023 \setfont\textsf\sfshape{10}{\mainmagstep}
1024 \setfont\textsc\scshape{10}{\mainmagstep}
1025 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1026 \font\texti=cmmi10 scaled \mainmagstep
1027 \font\textsy=cmsy10 scaled \mainmagstep
1029 % A few fonts for @defun, etc.
1030 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1031 \setfont\deftt\ttshape{10}{\magstep1}
1032 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1034 % Fonts for indices and small examples (9pt).
1035 % We actually use the slanted font rather than the italic,
1036 % because texinfo normally uses the slanted fonts for that.
1037 % Do not make many font distinctions in general in the index, since they
1038 % aren't very useful.
1039 \setfont\ninett\ttshape{9}{1000}
1040 \setfont\indrm\rmshape{9}{1000}
1041 \setfont\indit\slshape{9}{1000}
1042 \let\indsl=\indit
1043 \let\indtt=\ninett
1044 \let\indttsl=\ninett
1045 \let\indsf=\indrm
1046 \let\indbf=\indrm
1047 \setfont\indsc\scshape{10}{900}
1048 \font\indi=cmmi9
1049 \font\indsy=cmsy9
1051 % Chapter (and unnumbered) fonts (17.28pt).
1052 \setfont\chaprm\rmbshape{12}{\magstep2}
1053 \setfont\chapit\itbshape{10}{\magstep3}
1054 \setfont\chapsl\slbshape{10}{\magstep3}
1055 \setfont\chaptt\ttbshape{12}{\magstep2}
1056 \setfont\chapttsl\ttslshape{10}{\magstep3}
1057 \setfont\chapsf\sfbshape{12}{\magstep2}
1058 \let\chapbf=\chaprm
1059 \setfont\chapsc\scbshape{10}{\magstep3}
1060 \font\chapi=cmmi12 scaled \magstep2
1061 \font\chapsy=cmsy10 scaled \magstep3
1063 % Section fonts (14.4pt).
1064 \setfont\secrm\rmbshape{12}{\magstep1}
1065 \setfont\secit\itbshape{10}{\magstep2}
1066 \setfont\secsl\slbshape{10}{\magstep2}
1067 \setfont\sectt\ttbshape{12}{\magstep1}
1068 \setfont\secttsl\ttslshape{10}{\magstep2}
1069 \setfont\secsf\sfbshape{12}{\magstep1}
1070 \let\secbf\secrm
1071 \setfont\secsc\scbshape{10}{\magstep2}
1072 \font\seci=cmmi12 scaled \magstep1
1073 \font\secsy=cmsy10 scaled \magstep2
1075 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1076 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1077 % \setfont\ssecsl\slshape{10}{\magstep1}
1078 % \setfont\ssectt\ttshape{10}{\magstep1}
1079 % \setfont\ssecsf\sfshape{10}{\magstep1}
1081 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1082 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1083 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1084 %\setfont\ssectt\ttshape{10}{1315}
1085 %\setfont\ssecsf\sfshape{10}{1315}
1087 %\let\ssecbf=\ssecrm
1089 % Subsection fonts (13.15pt).
1090 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1091 \setfont\ssecit\itbshape{10}{1315}
1092 \setfont\ssecsl\slbshape{10}{1315}
1093 \setfont\ssectt\ttbshape{12}{\magstephalf}
1094 \setfont\ssecttsl\ttslshape{10}{\magstep1}
1095 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1096 \let\ssecbf\ssecrm
1097 \setfont\ssecsc\scbshape{10}{\magstep1}
1098 \font\sseci=cmmi12 scaled \magstephalf
1099 \font\ssecsy=cmsy10 scaled \magstep1
1100 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1101 % but that is not a standard magnification.
1103 % Fonts for title page:
1104 \setfont\titlerm\rmbshape{12}{\magstep3}
1105 \let\authorrm = \secrm
1107 % In order for the font changes to affect most math symbols and letters,
1108 % we have to define the \textfont of the standard families. Since
1109 % texinfo doesn't allow for producing subscripts and superscripts, we
1110 % don't bother to reset \scriptfont and \scriptscriptfont (which would
1111 % also require loading a lot more fonts).
1113 \def\resetmathfonts{%
1114 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1115 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1116 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1120 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1121 % of just \STYLE. We do this so that font changes will continue to work
1122 % in math mode, where it is the current \fam that is relevant in most
1123 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1124 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1125 % redefine \bf itself.
1126 \def\textfonts{%
1127 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1128 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1129 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1130 \resetmathfonts}
1131 \def\chapfonts{%
1132 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1133 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1134 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1135 \resetmathfonts \setleading{19pt}}
1136 \def\secfonts{%
1137 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1138 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1139 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1140 \resetmathfonts \setleading{16pt}}
1141 \def\subsecfonts{%
1142 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1143 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1144 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1145 \resetmathfonts \setleading{15pt}}
1146 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1147 \def\indexfonts{%
1148 \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
1149 \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
1150 \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy \let\tenttsl=\indttsl
1151 \resetmathfonts \setleading{12pt}}
1153 % Set up the default fonts, so we can use them for creating boxes.
1155 \textfonts
1157 % Count depth in font-changes, for error checks
1158 \newcount\fontdepth \fontdepth=0
1160 % Fonts for short table of contents.
1161 \setfont\shortcontrm\rmshape{12}{1000}
1162 \setfont\shortcontbf\bxshape{12}{1000}
1163 \setfont\shortcontsl\slshape{12}{1000}
1165 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1166 %% serif) and @ii for TeX italic
1168 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1169 % unless the following character is such as not to need one.
1170 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1171 \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1173 \let\i=\smartitalic
1174 \let\var=\smartitalic
1175 \let\dfn=\smartitalic
1176 \let\emph=\smartitalic
1177 \let\cite=\smartitalic
1179 \def\b#1{{\bf #1}}
1180 \let\strong=\b
1182 % We can't just use \exhyphenpenalty, because that only has effect at
1183 % the end of a paragraph. Restore normal hyphenation at the end of the
1184 % group within which \nohyphenation is presumably called.
1186 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1187 \def\restorehyphenation{\hyphenchar\font = `- }
1189 \def\t#1{%
1190 {\tt \rawbackslash \frenchspacing #1}%
1191 \null
1193 \let\ttfont=\t
1194 \def\samp #1{`\tclose{#1}'\null}
1195 \def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1196 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1198 \let\file=\samp
1199 \let\email=\samp
1200 \let\url=\samp % perhaps include a hypertex \special eventually
1202 % @code is a modification of @t,
1203 % which makes spaces the same size as normal in the surrounding text.
1204 \def\tclose#1{%
1206 % Change normal interword space to be same as for the current font.
1207 \spaceskip = \fontdimen2\font
1209 % Switch to typewriter.
1212 % But `\ ' produces the large typewriter interword space.
1213 \def\ {{\spaceskip = 0pt{} }}%
1215 % Turn off hyphenation.
1216 \nohyphenation
1218 \rawbackslash
1219 \frenchspacing
1222 \null
1225 % We *must* turn on hyphenation at `-' and `_' in \code.
1226 % Otherwise, it is too hard to avoid overfull hboxes
1227 % in the Emacs manual, the Library manual, etc.
1229 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1230 % both hyphenation at - and hyphenation within words.
1231 % We must therefore turn them both off (\tclose does that)
1232 % and arrange explicitly to hyphenate an a dash.
1233 % -- rms.
1235 \catcode`\-=\active
1236 \catcode`\_=\active
1237 \global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex}
1238 % The following is used by \doprintindex to insure that long function names
1239 % wrap around. It is necessary for - and _ to be active before the index is
1240 % read from the file, as \entry parses the arguments long before \code is
1241 % ever called. -- mycroft
1242 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash \catcode`\_=\active \let_\realunder}
1245 \def\realdash{-}
1246 \def\realunder{_}
1247 \def\codedash{-\discretionary{}{}{}}
1248 \def\codeunder{\normalunderscore\discretionary{}{}{}}
1249 \def\codex #1{\tclose{#1}\endgroup}
1251 %\let\exp=\tclose %Was temporary
1253 % @kbd is like @code, except that if the argument is just one @key command,
1254 % then @kbd has no effect.
1256 \def\xkey{\key}
1257 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1258 \ifx\one\xkey\ifx\threex\three \key{#2}%
1259 \else{\tclose{\ttsl\look}}\fi
1260 \else{\tclose{\ttsl\look}}\fi}
1262 % Check if we are currently using a typewriter font. Since all the
1263 % Computer Modern typewriter fonts have zero interword stretch (and
1264 % shrink), and it is reasonable to expect all typewriter fonts to have
1265 % this property, we can check that font parameter.
1267 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1269 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1270 % argument is to make the input look right: @dmn{pt} instead of
1271 % @dmn{}pt.
1273 \def\dmn#1{\thinspace #1}
1275 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1277 \def\l#1{{\li #1}\null} %
1279 \def\r#1{{\rm #1}} % roman font
1280 % Use of \lowercase was suggested.
1281 \def\sc#1{{\smallcaps#1}} % smallcaps font
1282 \def\ii#1{{\it #1}} % italic font
1284 \message{page headings,}
1286 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1287 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1289 % First the title page. Must do @settitle before @titlepage.
1290 \def\titlefont#1{{\titlerm #1}}
1292 \newif\ifseenauthor
1293 \newif\iffinishedtitlepage
1295 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1296 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1297 \endgroup\page\hbox{}\page}
1299 \def\titlepage{\begingroup \parindent=0pt \textfonts
1300 \let\subtitlerm=\tenrm
1301 % I deinstalled the following change because \cmr12 is undefined.
1302 % This change was not in the ChangeLog anyway. --rms.
1303 % \let\subtitlerm=\cmr12
1304 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1306 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1308 % Leave some space at the very top of the page.
1309 \vglue\titlepagetopglue
1311 % Now you can print the title using @title.
1312 \def\title{\parsearg\titlezzz}%
1313 \def\titlezzz##1{\leftline{\titlefont{##1}}
1314 % print a rule at the page bottom also.
1315 \finishedtitlepagefalse
1316 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1317 % No rule at page bottom unless we print one at the top with @title.
1318 \finishedtitlepagetrue
1320 % Now you can put text using @subtitle.
1321 \def\subtitle{\parsearg\subtitlezzz}%
1322 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1324 % @author should come last, but may come many times.
1325 \def\author{\parsearg\authorzzz}%
1326 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1327 {\authorfont \leftline{##1}}}%
1329 % Most title ``pages'' are actually two pages long, with space
1330 % at the top of the second. We don't want the ragged left on the second.
1331 \let\oldpage = \page
1332 \def\page{%
1333 \iffinishedtitlepage\else
1334 \finishtitlepage
1336 \oldpage
1337 \let\page = \oldpage
1338 \hbox{}}%
1339 % \def\page{\oldpage \hbox{}}
1342 \def\Etitlepage{%
1343 \iffinishedtitlepage\else
1344 \finishtitlepage
1346 % It is important to do the page break before ending the group,
1347 % because the headline and footline are only empty inside the group.
1348 % If we use the new definition of \page, we always get a blank page
1349 % after the title page, which we certainly don't want.
1350 \oldpage
1351 \endgroup
1352 \HEADINGSon
1355 \def\finishtitlepage{%
1356 \vskip4pt \hrule height 2pt width \hsize
1357 \vskip\titlepagebottomglue
1358 \finishedtitlepagetrue
1361 %%% Set up page headings and footings.
1363 \let\thispage=\folio
1365 \newtoks \evenheadline % Token sequence for heading line of even pages
1366 \newtoks \oddheadline % Token sequence for heading line of odd pages
1367 \newtoks \evenfootline % Token sequence for footing line of even pages
1368 \newtoks \oddfootline % Token sequence for footing line of odd pages
1370 % Now make Tex use those variables
1371 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1372 \else \the\evenheadline \fi}}
1373 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1374 \else \the\evenfootline \fi}\HEADINGShook}
1375 \let\HEADINGShook=\relax
1377 % Commands to set those variables.
1378 % For example, this is what @headings on does
1379 % @evenheading @thistitle|@thispage|@thischapter
1380 % @oddheading @thischapter|@thispage|@thistitle
1381 % @evenfooting @thisfile||
1382 % @oddfooting ||@thisfile
1384 \def\evenheading{\parsearg\evenheadingxxx}
1385 \def\oddheading{\parsearg\oddheadingxxx}
1386 \def\everyheading{\parsearg\everyheadingxxx}
1388 \def\evenfooting{\parsearg\evenfootingxxx}
1389 \def\oddfooting{\parsearg\oddfootingxxx}
1390 \def\everyfooting{\parsearg\everyfootingxxx}
1392 {\catcode`\@=0 %
1394 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1395 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1396 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1398 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1399 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1400 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1402 \gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish}
1403 \gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{%
1404 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1405 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1407 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1408 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1409 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1411 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1412 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1413 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1415 \gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish}
1416 \gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{%
1417 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1418 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1420 }% unbind the catcode of @.
1422 % @headings double turns headings on for double-sided printing.
1423 % @headings single turns headings on for single-sided printing.
1424 % @headings off turns them off.
1425 % @headings on same as @headings double, retained for compatibility.
1426 % @headings after turns on double-sided headings after this page.
1427 % @headings doubleafter turns on double-sided headings after this page.
1428 % @headings singleafter turns on single-sided headings after this page.
1429 % By default, they are off at the start of a document,
1430 % and turned `on' after @end titlepage.
1432 \def\headings #1 {\csname HEADINGS#1\endcsname}
1434 \def\HEADINGSoff{
1435 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1436 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1437 \HEADINGSoff
1438 % When we turn headings on, set the page number to 1.
1439 % For double-sided printing, put current file name in lower left corner,
1440 % chapter name on inside top of right hand pages, document
1441 % title on inside top of left hand pages, and page numbers on outside top
1442 % edge of all pages.
1443 \def\HEADINGSdouble{
1444 \global\pageno=1
1445 \global\evenfootline={\hfil}
1446 \global\oddfootline={\hfil}
1447 \global\evenheadline={\line{\folio\hfil\thistitle}}
1448 \global\oddheadline={\line{\thischapter\hfil\folio}}
1449 \global\let\contentsalignmacro = \chapoddpage
1451 \let\contentsalignmacro = \chappager
1453 % For single-sided printing, chapter title goes across top left of page,
1454 % page number on top right.
1455 \def\HEADINGSsingle{
1456 \global\pageno=1
1457 \global\evenfootline={\hfil}
1458 \global\oddfootline={\hfil}
1459 \global\evenheadline={\line{\thischapter\hfil\folio}}
1460 \global\oddheadline={\line{\thischapter\hfil\folio}}
1461 \global\let\contentsalignmacro = \chappager
1463 \def\HEADINGSon{\HEADINGSdouble}
1465 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1466 \let\HEADINGSdoubleafter=\HEADINGSafter
1467 \def\HEADINGSdoublex{%
1468 \global\evenfootline={\hfil}
1469 \global\oddfootline={\hfil}
1470 \global\evenheadline={\line{\folio\hfil\thistitle}}
1471 \global\oddheadline={\line{\thischapter\hfil\folio}}
1472 \global\let\contentsalignmacro = \chapoddpage
1475 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1476 \def\HEADINGSsinglex{%
1477 \global\evenfootline={\hfil}
1478 \global\oddfootline={\hfil}
1479 \global\evenheadline={\line{\thischapter\hfil\folio}}
1480 \global\oddheadline={\line{\thischapter\hfil\folio}}
1481 \global\let\contentsalignmacro = \chappager
1484 % Subroutines used in generating headings
1485 % Produces Day Month Year style of output.
1486 \def\today{\number\day\space
1487 \ifcase\month\or
1488 January\or February\or March\or April\or May\or June\or
1489 July\or August\or September\or October\or November\or December\fi
1490 \space\number\year}
1492 % Use this if you want the Month Day, Year style of output.
1493 %\def\today{\ifcase\month\or
1494 %January\or February\or March\or April\or May\or June\or
1495 %July\or August\or September\or October\or November\or December\fi
1496 %\space\number\day, \number\year}
1498 % @settitle line... specifies the title of the document, for headings
1499 % It generates no output of its own
1501 \def\thistitle{No Title}
1502 \def\settitle{\parsearg\settitlezzz}
1503 \def\settitlezzz #1{\gdef\thistitle{#1}}
1505 \message{tables,}
1507 % @tabs -- simple alignment
1509 % These don't work. For one thing, \+ is defined as outer.
1510 % So these macros cannot even be defined.
1512 %\def\tabs{\parsearg\tabszzz}
1513 %\def\tabszzz #1{\settabs\+#1\cr}
1514 %\def\tabline{\parsearg\tablinezzz}
1515 %\def\tablinezzz #1{\+#1\cr}
1516 %\def\&{&}
1518 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1520 % default indentation of table text
1521 \newdimen\tableindent \tableindent=.8in
1522 % default indentation of @itemize and @enumerate text
1523 \newdimen\itemindent \itemindent=.3in
1524 % margin between end of table item and start of table text.
1525 \newdimen\itemmargin \itemmargin=.1in
1527 % used internally for \itemindent minus \itemmargin
1528 \newdimen\itemmax
1530 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1531 % these defs.
1532 % They also define \itemindex
1533 % to index the item name in whatever manner is desired (perhaps none).
1535 \newif\ifitemxneedsnegativevskip
1537 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1539 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1540 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1542 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1543 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1545 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1546 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1548 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1549 \itemzzz {#1}}
1551 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1552 \itemzzz {#1}}
1554 \def\itemzzz #1{\begingroup %
1555 \advance\hsize by -\rightskip
1556 \advance\hsize by -\tableindent
1557 \setbox0=\hbox{\itemfont{#1}}%
1558 \itemindex{#1}%
1559 \nobreak % This prevents a break before @itemx.
1561 % Be sure we are not still in the middle of a paragraph.
1562 %{\parskip = 0in
1563 %\par
1566 % If the item text does not fit in the space we have, put it on a line
1567 % by itself, and do not allow a page break either before or after that
1568 % line. We do not start a paragraph here because then if the next
1569 % command is, e.g., @kindex, the whatsit would get put into the
1570 % horizontal list on a line by itself, resulting in extra blank space.
1571 \ifdim \wd0>\itemmax
1573 % Make this a paragraph so we get the \parskip glue and wrapping,
1574 % but leave it ragged-right.
1575 \begingroup
1576 \advance\leftskip by-\tableindent
1577 \advance\hsize by\tableindent
1578 \advance\rightskip by0pt plus1fil
1579 \leavevmode\unhbox0\par
1580 \endgroup
1582 % We're going to be starting a paragraph, but we don't want the
1583 % \parskip glue -- logically it's part of the @item we just started.
1584 \nobreak \vskip-\parskip
1586 % Stop a page break at the \parskip glue coming up. Unfortunately
1587 % we can't prevent a possible page break at the following
1588 % \baselineskip glue.
1589 \nobreak
1590 \endgroup
1591 \itemxneedsnegativevskipfalse
1592 \else
1593 % The item text fits into the space. Start a paragraph, so that the
1594 % following text (if any) will end up on the same line. Since that
1595 % text will be indented by \tableindent, we make the item text be in
1596 % a zero-width box.
1597 \noindent
1598 \rlap{\hskip -\tableindent\box0}\ignorespaces%
1599 \endgroup%
1600 \itemxneedsnegativevskiptrue%
1604 \def\item{\errmessage{@item while not in a table}}
1605 \def\itemx{\errmessage{@itemx while not in a table}}
1606 \def\kitem{\errmessage{@kitem while not in a table}}
1607 \def\kitemx{\errmessage{@kitemx while not in a table}}
1608 \def\xitem{\errmessage{@xitem while not in a table}}
1609 \def\xitemx{\errmessage{@xitemx while not in a table}}
1611 %% Contains a kludge to get @end[description] to work
1612 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1614 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1615 {\obeylines\obeyspaces%
1616 \gdef\tablex #1^^M{%
1617 \tabley\dontindex#1 \endtabley}}
1619 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1620 {\obeylines\obeyspaces%
1621 \gdef\ftablex #1^^M{%
1622 \tabley\fnitemindex#1 \endtabley
1623 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1624 \let\Etable=\relax}}
1626 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1627 {\obeylines\obeyspaces%
1628 \gdef\vtablex #1^^M{%
1629 \tabley\vritemindex#1 \endtabley
1630 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1631 \let\Etable=\relax}}
1633 \def\dontindex #1{}
1634 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1635 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1637 {\obeyspaces %
1638 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1639 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1641 \def\tablez #1#2#3#4#5#6{%
1642 \aboveenvbreak %
1643 \begingroup %
1644 \def\Edescription{\Etable}% Necessary kludge.
1645 \let\itemindex=#1%
1646 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1647 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1648 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1649 \def\itemfont{#2}%
1650 \itemmax=\tableindent %
1651 \advance \itemmax by -\itemmargin %
1652 \advance \leftskip by \tableindent %
1653 \exdentamount=\tableindent
1654 \parindent = 0pt
1655 \parskip = \smallskipamount
1656 \ifdim \parskip=0pt \parskip=2pt \fi%
1657 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1658 \let\item = \internalBitem %
1659 \let\itemx = \internalBitemx %
1660 \let\kitem = \internalBkitem %
1661 \let\kitemx = \internalBkitemx %
1662 \let\xitem = \internalBxitem %
1663 \let\xitemx = \internalBxitemx %
1666 % This is the counter used by @enumerate, which is really @itemize
1668 \newcount \itemno
1670 \def\itemize{\parsearg\itemizezzz}
1672 \def\itemizezzz #1{%
1673 \begingroup % ended by the @end itemsize
1674 \itemizey {#1}{\Eitemize}
1677 \def\itemizey #1#2{%
1678 \aboveenvbreak %
1679 \itemmax=\itemindent %
1680 \advance \itemmax by -\itemmargin %
1681 \advance \leftskip by \itemindent %
1682 \exdentamount=\itemindent
1683 \parindent = 0pt %
1684 \parskip = \smallskipamount %
1685 \ifdim \parskip=0pt \parskip=2pt \fi%
1686 \def#2{\endgraf\afterenvbreak\endgroup}%
1687 \def\itemcontents{#1}%
1688 \let\item=\itemizeitem}
1690 % Set sfcode to normal for the chars that usually have another value.
1691 % These are `.?!:;,'
1692 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1693 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1695 % \splitoff TOKENS\endmark defines \first to be the first token in
1696 % TOKENS, and \rest to be the remainder.
1698 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1700 % Allow an optional argument of an uppercase letter, lowercase letter,
1701 % or number, to specify the first label in the enumerated list. No
1702 % argument is the same as `1'.
1704 \def\enumerate{\parsearg\enumeratezzz}
1705 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1706 \def\enumeratey #1 #2\endenumeratey{%
1707 \begingroup % ended by the @end enumerate
1709 % If we were given no argument, pretend we were given `1'.
1710 \def\thearg{#1}%
1711 \ifx\thearg\empty \def\thearg{1}\fi
1713 % Detect if the argument is a single token. If so, it might be a
1714 % letter. Otherwise, the only valid thing it can be is a number.
1715 % (We will always have one token, because of the test we just made.
1716 % This is a good thing, since \splitoff doesn't work given nothing at
1717 % all -- the first parameter is undelimited.)
1718 \expandafter\splitoff\thearg\endmark
1719 \ifx\rest\empty
1720 % Only one token in the argument. It could still be anything.
1721 % A ``lowercase letter'' is one whose \lccode is nonzero.
1722 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1723 % not equal to itself.
1724 % Otherwise, we assume it's a number.
1726 % We need the \relax at the end of the \ifnum lines to stop TeX from
1727 % continuing to look for a <number>.
1729 \ifnum\lccode\expandafter`\thearg=0\relax
1730 \numericenumerate % a number (we hope)
1731 \else
1732 % It's a letter.
1733 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1734 \lowercaseenumerate % lowercase letter
1735 \else
1736 \uppercaseenumerate % uppercase letter
1739 \else
1740 % Multiple tokens in the argument. We hope it's a number.
1741 \numericenumerate
1745 % An @enumerate whose labels are integers. The starting integer is
1746 % given in \thearg.
1748 \def\numericenumerate{%
1749 \itemno = \thearg
1750 \startenumeration{\the\itemno}%
1753 % The starting (lowercase) letter is in \thearg.
1754 \def\lowercaseenumerate{%
1755 \itemno = \expandafter`\thearg
1756 \startenumeration{%
1757 % Be sure we're not beyond the end of the alphabet.
1758 \ifnum\itemno=0
1759 \errmessage{No more lowercase letters in @enumerate; get a bigger
1760 alphabet}%
1762 \char\lccode\itemno
1766 % The starting (uppercase) letter is in \thearg.
1767 \def\uppercaseenumerate{%
1768 \itemno = \expandafter`\thearg
1769 \startenumeration{%
1770 % Be sure we're not beyond the end of the alphabet.
1771 \ifnum\itemno=0
1772 \errmessage{No more uppercase letters in @enumerate; get a bigger
1773 alphabet}
1775 \char\uccode\itemno
1779 % Call itemizey, adding a period to the first argument and supplying the
1780 % common last two arguments. Also subtract one from the initial value in
1781 % \itemno, since @item increments \itemno.
1783 \def\startenumeration#1{%
1784 \advance\itemno by -1
1785 \itemizey{#1.}\Eenumerate\flushcr
1788 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1789 % to @enumerate.
1791 \def\alphaenumerate{\enumerate{a}}
1792 \def\capsenumerate{\enumerate{A}}
1793 \def\Ealphaenumerate{\Eenumerate}
1794 \def\Ecapsenumerate{\Eenumerate}
1796 % Definition of @item while inside @itemize.
1798 \def\itemizeitem{%
1799 \advance\itemno by 1
1800 {\let\par=\endgraf \smallbreak}%
1801 \ifhmode \errmessage{\in hmode at itemizeitem}\fi
1802 {\parskip=0in \hskip 0pt
1803 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1804 \vadjust{\penalty 1200}}%
1805 \flushcr}
1807 % @multitable macros
1808 % Amy Hendrickson, 8/18/94, 3/6/96
1810 % @multitable ... @end multitable will make as many columns as desired.
1811 % Contents of each column will wrap at width given in preamble. Width
1812 % can be specified either with sample text given in a template line,
1813 % or in percent of \hsize, the current width of text on page.
1815 % Table can continue over pages but will only break between lines.
1817 % To make preamble:
1819 % Either define widths of columns in terms of percent of \hsize:
1820 % @multitable @columnfractions .25 .3 .45
1821 % @item ...
1823 % Numbers following @columnfractions are the percent of the total
1824 % current hsize to be used for each column. You may use as many
1825 % columns as desired.
1827 % Or use a template:
1828 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1829 % @item ...
1830 % using the widest term desired in each column.
1832 % For those who want to use more than one line's worth of words in
1833 % the preamble, break the line within one argument and it
1834 % will parse correctly, i.e.,
1836 % @multitable {Column 1 template} {Column 2 template} {Column 3
1837 % template}
1838 % Not:
1839 % @multitable {Column 1 template} {Column 2 template}
1840 % {Column 3 template}
1842 % Each new table line starts with @item, each subsequent new column
1843 % starts with @tab. Empty columns may be produced by supplying @tab's
1844 % with nothing between them for as many times as empty columns are needed,
1845 % ie, @tab@tab@tab will produce two empty columns.
1847 % @item, @tab, @multicolumn or @endmulticolumn do not need to be on their
1848 % own lines, but it will not hurt if they are.
1850 % Sample multitable:
1852 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1853 % @item first col stuff @tab second col stuff @tab third col
1854 % @item
1855 % first col stuff
1856 % @tab
1857 % second col stuff
1858 % @tab
1859 % third col
1860 % @item first col stuff @tab second col stuff
1861 % @tab Many paragraphs of text may be used in any column.
1863 % They will wrap at the width determined by the template.
1864 % @item@tab@tab This will be in third column.
1865 % @end multitable
1867 % Default dimensions may be reset by user.
1868 % @multitableparskip is vertical space between paragraphs in table.
1869 % @multitableparindent is paragraph indent in table.
1870 % @multitablecolmargin is horizontal space to be left between columns.
1871 % @multitablelinespace is space to leave between table items, baseline
1872 % to baseline.
1873 % 0pt means it depends on current normal line spacing.
1875 %%%%
1876 % Dimensions
1878 \newskip\multitableparskip
1879 \newskip\multitableparindent
1880 \newdimen\multitablecolspace
1881 \newskip\multitablelinespace
1882 \multitableparskip=0pt
1883 \multitableparindent=6pt
1884 \multitablecolspace=12pt
1885 \multitablelinespace=0pt
1887 %%%%
1888 % Macros used to set up halign preamble:
1889 \let\endsetuptable\relax
1890 \def\xendsetuptable{\endsetuptable}
1891 \let\columnfractions\relax
1892 \def\xcolumnfractions{\columnfractions}
1893 \newif\ifsetpercent
1895 %% 2/1/96, to allow fractions to be given with more than one digit.
1896 \def\pickupwholefraction#1 {\global\advance\colcount by1 %
1897 \expandafter\xdef\csname col\the\colcount\endcsname{.#1\hsize}%
1898 \setuptable}
1900 \newcount\colcount
1901 \def\setuptable#1{\def\firstarg{#1}%
1902 \ifx\firstarg\xendsetuptable\let\go\relax%
1903 \else
1904 \ifx\firstarg\xcolumnfractions\global\setpercenttrue%
1905 \else
1906 \ifsetpercent
1907 \let\go\pickupwholefraction % In this case arg of setuptable
1908 % is the decimal point before the
1909 % number given in percent of hsize.
1910 % We don't need this so we don't use it.
1911 \else
1912 \global\advance\colcount by1
1913 \setbox0=\hbox{#1}%
1914 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
1915 \fi%
1916 \fi%
1917 \ifx\go\pickupwholefraction\else\let\go\setuptable\fi%
1918 \fi\go}
1920 %%%%
1921 % multitable syntax
1922 \def\tab{&\hskip1sp\relax} % 2/2/96
1923 % tiny skip here makes sure this column space is
1924 % maintained, even if it is never used.
1927 %%%%
1928 % @multitable ... @end multitable definitions:
1930 \def\multitable{\parsearg\dotable}
1932 \def\dotable#1{\bgroup
1933 \let\item\cr
1934 \tolerance=9500
1935 \hbadness=9500
1936 \setmultitablespacing
1937 \parskip=\multitableparskip
1938 \parindent=\multitableparindent
1939 \overfullrule=0pt
1940 \global\colcount=0\relax%
1941 \def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}%
1942 % To parse everything between @multitable and @item :
1943 \setuptable#1 \endsetuptable
1944 % Need to reset this to 0 after \setuptable.
1945 \global\colcount=0\relax%
1947 % This preamble sets up a generic column definition, which will
1948 % be used as many times as user calls for columns.
1949 % \vtop will set a single line and will also let text wrap and
1950 % continue for many paragraphs if desired.
1951 \halign\bgroup&\global\advance\colcount by 1\relax%
1952 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
1953 % In order to keep entries from bumping into each other
1954 % we will add a \leftskip of \multitablecolspace to all columns after
1955 % the first one.
1956 % If a template has been used, we will add \multitablecolspace
1957 % to the width of each template entry.
1958 % If user has set preamble in terms of percent of \hsize
1959 % we will use that dimension as the width of the column, and
1960 % the \leftskip will keep entries from bumping into each other.
1961 % Table will start at left margin and final column will justify at
1962 % right margin.
1963 \ifnum\colcount=1
1964 \else
1965 \ifsetpercent
1966 \else
1967 % If user has <not> set preamble in terms of percent of \hsize
1968 % we will advance \hsize by \multitablecolspace
1969 \advance\hsize by \multitablecolspace
1971 % In either case we will make \leftskip=\multitablecolspace:
1972 \leftskip=\multitablecolspace
1974 \noindent##}\cr%
1975 % \everycr will reset column counter, \colcount, at the end of
1976 % each line. Every column entry will cause \colcount to advance by one.
1977 % The table preamble
1978 % looks at the current \colcount to find the correct column width.
1979 \global\everycr{\noalign{%
1980 \filbreak%% keeps underfull box messages off when table breaks over pages.
1981 \global\colcount=0\relax}}
1984 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
1985 % If so, do nothing. If not, give it an appropriate dimension based on
1986 % current baselineskip.
1987 \setbox0=\vbox{Xy}
1988 \ifdim\multitablelinespace=0pt
1989 %% strut to put in table in case some entry doesn't have descenders,
1990 %% to keep lines equally spaced
1991 \gdef\multistrut{\vrule height\ht0 depth\dp0 width0pt\relax}
1992 %% Test to see if parskip is larger than space between lines of
1993 %% table. If not, do nothing.
1994 %% If so, set to same dimension as multitablelinespace.
1995 \else
1996 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
1997 width0pt\relax} \fi
1998 \ifdim\multitableparskip>\multitablelinespace
1999 \global\multitableparskip=\multitablelinespace
2000 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2001 %% than skip between lines in the table.
2002 \fi%
2003 \ifdim\multitableparskip=0pt
2004 \global\multitableparskip=\multitablelinespace
2005 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2006 %% than skip between lines in the table.
2007 \fi}
2008 \message{indexing,}
2009 % Index generation facilities
2011 % Define \newwrite to be identical to plain tex's \newwrite
2012 % except not \outer, so it can be used within \newindex.
2013 {\catcode`\@=11
2014 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2016 % \newindex {foo} defines an index named foo.
2017 % It automatically defines \fooindex such that
2018 % \fooindex ...rest of line... puts an entry in the index foo.
2019 % It also defines \fooindfile to be the number of the output channel for
2020 % the file that accumulates this index. The file's extension is foo.
2021 % The name of an index should be no more than 2 characters long
2022 % for the sake of vms.
2024 \def\newindex #1{
2025 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
2026 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2027 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2028 \noexpand\doindex {#1}}
2031 % @defindex foo == \newindex{foo}
2033 \def\defindex{\parsearg\newindex}
2035 % Define @defcodeindex, like @defindex except put all entries in @code.
2037 \def\newcodeindex #1{
2038 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
2039 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2040 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2041 \noexpand\docodeindex {#1}}
2044 \def\defcodeindex{\parsearg\newcodeindex}
2046 % @synindex foo bar makes index foo feed into index bar.
2047 % Do this instead of @defindex foo if you don't want it as a separate index.
2048 \def\synindex #1 #2 {%
2049 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2050 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
2051 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2052 \noexpand\doindex {#2}}%
2055 % @syncodeindex foo bar similar, but put all entries made for index foo
2056 % inside @code.
2057 \def\syncodeindex #1 #2 {%
2058 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2059 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
2060 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
2061 \noexpand\docodeindex {#2}}%
2064 % Define \doindex, the driver for all \fooindex macros.
2065 % Argument #1 is generated by the calling \fooindex macro,
2066 % and it is "foo", the name of the index.
2068 % \doindex just uses \parsearg; it calls \doind for the actual work.
2069 % This is because \doind is more useful to call from other macros.
2071 % There is also \dosubind {index}{topic}{subtopic}
2072 % which makes an entry in a two-level index such as the operation index.
2074 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2075 \def\singleindexer #1{\doind{\indexname}{#1}}
2077 % like the previous two, but they put @code around the argument.
2078 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2079 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2081 \def\indexdummies{%
2082 % Take care of the plain tex accent commands.
2083 \def\"{\realbackslash "}%
2084 \def\`{\realbackslash `}%
2085 \def\'{\realbackslash '}%
2086 \def\^{\realbackslash ^}%
2087 \def\~{\realbackslash ~}%
2088 \def\={\realbackslash =}%
2089 \def\b{\realbackslash b}%
2090 \def\c{\realbackslash c}%
2091 \def\d{\realbackslash d}%
2092 \def\u{\realbackslash u}%
2093 \def\v{\realbackslash v}%
2094 \def\H{\realbackslash H}%
2095 % Take care of the plain tex special European modified letters.
2096 \def\oe{\realbackslash oe}%
2097 \def\ae{\realbackslash ae}%
2098 \def\aa{\realbackslash aa}%
2099 \def\OE{\realbackslash OE}%
2100 \def\AE{\realbackslash AE}%
2101 \def\AA{\realbackslash AA}%
2102 \def\o{\realbackslash o}%
2103 \def\O{\realbackslash O}%
2104 \def\l{\realbackslash l}%
2105 \def\L{\realbackslash L}%
2106 \def\ss{\realbackslash ss}%
2107 % Take care of texinfo commands likely to appear in an index entry.
2108 \def\_{{\realbackslash _}}%
2109 \def\w{\realbackslash w }%
2110 \def\bf{\realbackslash bf }%
2111 \def\rm{\realbackslash rm }%
2112 \def\sl{\realbackslash sl }%
2113 \def\sf{\realbackslash sf}%
2114 \def\tt{\realbackslash tt}%
2115 \def\gtr{\realbackslash gtr}%
2116 \def\less{\realbackslash less}%
2117 \def\hat{\realbackslash hat}%
2118 \def\char{\realbackslash char}%
2119 \def\TeX{\realbackslash TeX}%
2120 \def\dots{\realbackslash dots }%
2121 \def\copyright{\realbackslash copyright }%
2122 \def\tclose##1{\realbackslash tclose {##1}}%
2123 \def\code##1{\realbackslash code {##1}}%
2124 \def\samp##1{\realbackslash samp {##1}}%
2125 \def\t##1{\realbackslash r {##1}}%
2126 \def\r##1{\realbackslash r {##1}}%
2127 \def\i##1{\realbackslash i {##1}}%
2128 \def\b##1{\realbackslash b {##1}}%
2129 \def\cite##1{\realbackslash cite {##1}}%
2130 \def\key##1{\realbackslash key {##1}}%
2131 \def\file##1{\realbackslash file {##1}}%
2132 \def\var##1{\realbackslash var {##1}}%
2133 \def\kbd##1{\realbackslash kbd {##1}}%
2134 \def\dfn##1{\realbackslash dfn {##1}}%
2135 \def\emph##1{\realbackslash emph {##1}}%
2136 \unsepspaces
2139 % If an index command is used in an @example environment, any spaces
2140 % therein should become regular spaces in the raw index file, not the
2141 % expansion of \tie (\\leavevmode \penalty \@M \ ).
2142 {\obeyspaces
2143 \gdef\unsepspaces{\obeyspaces\let =\space}}
2145 % \indexnofonts no-ops all font-change commands.
2146 % This is used when outputting the strings to sort the index by.
2147 \def\indexdummyfont#1{#1}
2148 \def\indexdummytex{TeX}
2149 \def\indexdummydots{...}
2151 \def\indexnofonts{%
2152 % Just ignore accents.
2153 \let\"=\indexdummyfont
2154 \let\`=\indexdummyfont
2155 \let\'=\indexdummyfont
2156 \let\^=\indexdummyfont
2157 \let\~=\indexdummyfont
2158 \let\==\indexdummyfont
2159 \let\b=\indexdummyfont
2160 \let\c=\indexdummyfont
2161 \let\d=\indexdummyfont
2162 \let\u=\indexdummyfont
2163 \let\v=\indexdummyfont
2164 \let\H=\indexdummyfont
2165 % Take care of the plain tex special European modified letters.
2166 \def\oe{oe}%
2167 \def\ae{ae}%
2168 \def\aa{aa}%
2169 \def\OE{OE}%
2170 \def\AE{AE}%
2171 \def\AA{AA}%
2172 \def\o{o}%
2173 \def\O{O}%
2174 \def\l{l}%
2175 \def\L{L}%
2176 \def\ss{ss}%
2177 \let\w=\indexdummyfont
2178 \let\t=\indexdummyfont
2179 \let\r=\indexdummyfont
2180 \let\i=\indexdummyfont
2181 \let\b=\indexdummyfont
2182 \let\emph=\indexdummyfont
2183 \let\strong=\indexdummyfont
2184 \let\cite=\indexdummyfont
2185 \let\sc=\indexdummyfont
2186 %Don't no-op \tt, since it isn't a user-level command
2187 % and is used in the definitions of the active chars like <, >, |...
2188 %\let\tt=\indexdummyfont
2189 \let\tclose=\indexdummyfont
2190 \let\code=\indexdummyfont
2191 \let\file=\indexdummyfont
2192 \let\samp=\indexdummyfont
2193 \let\kbd=\indexdummyfont
2194 \let\key=\indexdummyfont
2195 \let\var=\indexdummyfont
2196 \let\TeX=\indexdummytex
2197 \let\dots=\indexdummydots
2200 % To define \realbackslash, we must make \ not be an escape.
2201 % We must first make another character (@) an escape
2202 % so we do not become unable to do a definition.
2204 {\catcode`\@=0 \catcode`\\=\other
2205 @gdef@realbackslash{\}}
2207 \let\indexbackslash=0 %overridden during \printindex.
2209 \let\SETmarginindex=\relax %initialize!
2210 % workhorse for all \fooindexes
2211 % #1 is name of index, #2 is stuff to put there
2212 \def\doind #1#2{%
2213 % Put the index entry in the margin if desired.
2214 \ifx\SETmarginindex\relax\else%
2215 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2216 \fi%
2217 {\count10=\lastpenalty %
2218 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2219 \escapechar=`\\%
2220 {\let\folio=0% Expand all macros now EXCEPT \folio
2221 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2222 % so it will be output as is; and it will print as backslash in the indx.
2224 % Now process the index-string once, with all font commands turned off,
2225 % to get the string to sort the index by.
2226 {\indexnofonts
2227 \xdef\temp1{#2}%
2229 % Now produce the complete index entry. We process the index-string again,
2230 % this time with font commands expanded, to get what to print in the index.
2231 \edef\temp{%
2232 \write \csname#1indfile\endcsname{%
2233 \realbackslash entry {\temp1}{\folio}{#2}}}%
2234 \temp }%
2235 }\penalty\count10}}
2237 \def\dosubind #1#2#3{%
2238 {\count10=\lastpenalty %
2239 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2240 \escapechar=`\\%
2241 {\let\folio=0%
2242 \def\rawbackslashxx{\indexbackslash}%
2244 % Now process the index-string once, with all font commands turned off,
2245 % to get the string to sort the index by.
2246 {\indexnofonts
2247 \xdef\temp1{#2 #3}%
2249 % Now produce the complete index entry. We process the index-string again,
2250 % this time with font commands expanded, to get what to print in the index.
2251 \edef\temp{%
2252 \write \csname#1indfile\endcsname{%
2253 \realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
2254 \temp }%
2255 }\penalty\count10}}
2257 % The index entry written in the file actually looks like
2258 % \entry {sortstring}{page}{topic}
2259 % or
2260 % \entry {sortstring}{page}{topic}{subtopic}
2261 % The texindex program reads in these files and writes files
2262 % containing these kinds of lines:
2263 % \initial {c}
2264 % before the first topic whose initial is c
2265 % \entry {topic}{pagelist}
2266 % for a topic that is used without subtopics
2267 % \primary {topic}
2268 % for the beginning of a topic that is used with subtopics
2269 % \secondary {subtopic}{pagelist}
2270 % for each subtopic.
2272 % Define the user-accessible indexing commands
2273 % @findex, @vindex, @kindex, @cindex.
2275 \def\findex {\fnindex}
2276 \def\kindex {\kyindex}
2277 \def\cindex {\cpindex}
2278 \def\vindex {\vrindex}
2279 \def\tindex {\tpindex}
2280 \def\pindex {\pgindex}
2282 \def\cindexsub {\begingroup\obeylines\cindexsub}
2283 {\obeylines %
2284 \gdef\cindexsub "#1" #2^^M{\endgroup %
2285 \dosubind{cp}{#2}{#1}}}
2287 % Define the macros used in formatting output of the sorted index material.
2289 % This is what you call to cause a particular index to get printed.
2290 % Write
2291 % @unnumbered Function Index
2292 % @printindex fn
2294 \def\printindex{\parsearg\doprintindex}
2296 \def\doprintindex#1{\begingroup
2297 \dobreak \chapheadingskip{10000}%
2299 \indexfonts \rm
2300 \tolerance = 9500
2301 \indexbreaks
2302 \def\indexbackslash{\rawbackslashxx}%
2303 % Index files are almost Texinfo source, but we use \ as the escape
2304 % character. It would be better to use @, but that's too big a change
2305 % to make right now.
2306 \catcode`\\ = 0
2307 \begindoublecolumns
2309 % See if the index file exists and is nonempty.
2310 \openin 1 \jobname.#1s
2311 \ifeof 1
2312 % \enddoublecolumns gets confused if there is no text in the index,
2313 % and it loses the chapter title and the aux file entries for the
2314 % index. The easiest way to prevent this problem is to make sure
2315 % there is some text.
2316 (Index is nonexistent)
2317 \else
2319 % If the index file exists but is empty, then \openin leaves \ifeof
2320 % false. We have to make TeX try to read something from the file, so
2321 % it can discover if there is anything in it.
2322 \read 1 to \temp
2323 \ifeof 1
2324 (Index is empty)
2325 \else
2326 \input \jobname.#1s
2329 \closein 1
2330 \enddoublecolumns
2331 \endgroup}
2333 % These macros are used by the sorted index file itself.
2334 % Change them to control the appearance of the index.
2336 % Same as \bigskipamount except no shrink.
2337 % \balancecolumns gets confused if there is any shrink.
2338 \newskip\initialskipamount \initialskipamount 12pt plus4pt
2340 \def\initial #1{%
2341 {\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
2342 \ifdim\lastskip<\initialskipamount
2343 \removelastskip \penalty-200 \vskip \initialskipamount\fi
2344 \line{\secbf#1\hfill}\kern 2pt\penalty10000}}
2346 % This typesets a paragraph consisting of #1, dot leaders, and then #2
2347 % flush to the right margin. It is used for index and table of contents
2348 % entries. The paragraph is indented by \leftskip.
2350 \def\entry #1#2{\begingroup
2352 % Start a new paragraph if necessary, so our assignments below can't
2353 % affect previous text.
2354 \par
2356 % Do not fill out the last line with white space.
2357 \parfillskip = 0in
2359 % No extra space above this paragraph.
2360 \parskip = 0in
2362 % Do not prefer a separate line ending with a hyphen to fewer lines.
2363 \finalhyphendemerits = 0
2365 % \hangindent is only relevant when the entry text and page number
2366 % don't both fit on one line. In that case, bob suggests starting the
2367 % dots pretty far over on the line. Unfortunately, a large
2368 % indentation looks wrong when the entry text itself is broken across
2369 % lines. So we use a small indentation and put up with long leaders.
2371 % \hangafter is reset to 1 (which is the value we want) at the start
2372 % of each paragraph, so we need not do anything with that.
2373 \hangindent=2em
2375 % When the entry text needs to be broken, just fill out the first line
2376 % with blank space.
2377 \rightskip = 0pt plus1fil
2379 % Start a ``paragraph'' for the index entry so the line breaking
2380 % parameters we've set above will have an effect.
2381 \noindent
2383 % Insert the text of the index entry. TeX will do line-breaking on it.
2385 % The following is kludged to not output a line of dots in the index if
2386 % there are no page numbers. The next person who breaks this will be
2387 % cursed by a Unix daemon.
2388 \def\tempa{{\rm }}%
2389 \def\tempb{#2}%
2390 \edef\tempc{\tempa}%
2391 \edef\tempd{\tempb}%
2392 \ifx\tempc\tempd\ \else%
2394 % If we must, put the page number on a line of its own, and fill out
2395 % this line with blank space. (The \hfil is overwhelmed with the
2396 % fill leaders glue in \indexdotfill if the page number does fit.)
2397 \hfil\penalty50
2398 \null\nobreak\indexdotfill % Have leaders before the page number.
2400 % The `\ ' here is removed by the implicit \unskip that TeX does as
2401 % part of (the primitive) \par. Without it, a spurious underfull
2402 % \hbox ensues.
2403 \ #2% The page number ends the paragraph.
2404 \fi%
2405 \par
2406 \endgroup}
2408 % Like \dotfill except takes at least 1 em.
2409 \def\indexdotfill{\cleaders
2410 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
2412 \def\primary #1{\line{#1\hfil}}
2414 \newskip\secondaryindent \secondaryindent=0.5cm
2416 \def\secondary #1#2{
2417 {\parfillskip=0in \parskip=0in
2418 \hangindent =1in \hangafter=1
2419 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
2422 %% Define two-column mode, which is used in indexes.
2423 %% Adapted from the TeXbook, page 416.
2424 \catcode `\@=11
2426 \newbox\partialpage
2428 \newdimen\doublecolumnhsize
2430 \def\begindoublecolumns{\begingroup
2431 % Grab any single-column material above us.
2432 \output = {\global\setbox\partialpage
2433 =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}%
2434 \eject
2436 % Now switch to the double-column output routine.
2437 \output={\doublecolumnout}%
2439 % Change the page size parameters. We could do this once outside this
2440 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2441 % format, but then we repeat the same computation. Repeating a couple
2442 % of assignments once per index is clearly meaningless for the
2443 % execution time, so we may as well do it once.
2445 % First we halve the line length, less a little for the gutter between
2446 % the columns. We compute the gutter based on the line length, so it
2447 % changes automatically with the paper format. The magic constant
2448 % below is chosen so that the gutter has the same value (well, +- <
2449 % 1pt) as it did when we hard-coded it.
2451 % We put the result in a separate register, \doublecolumhsize, so we
2452 % can restore it in \pagesofar, after \hsize itself has (potentially)
2453 % been clobbered.
2455 \doublecolumnhsize = \hsize
2456 \advance\doublecolumnhsize by -.04154\hsize
2457 \divide\doublecolumnhsize by 2
2458 \hsize = \doublecolumnhsize
2460 % Double the \vsize as well. (We don't need a separate register here,
2461 % since nobody clobbers \vsize.)
2462 \vsize = 2\vsize
2463 \doublecolumnpagegoal
2466 \def\enddoublecolumns{\eject \endgroup \pagegoal=\vsize \unvbox\partialpage}
2468 \def\doublecolumnsplit{\splittopskip=\topskip \splitmaxdepth=\maxdepth
2469 \global\dimen@=\pageheight \global\advance\dimen@ by-\ht\partialpage
2470 \global\setbox1=\vsplit255 to\dimen@ \global\setbox0=\vbox{\unvbox1}
2471 \global\setbox3=\vsplit255 to\dimen@ \global\setbox2=\vbox{\unvbox3}
2472 \ifdim\ht0>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2473 \ifdim\ht2>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2475 \def\doublecolumnpagegoal{%
2476 \dimen@=\vsize \advance\dimen@ by-2\ht\partialpage \global\pagegoal=\dimen@
2478 \def\pagesofar{\unvbox\partialpage %
2479 \hsize=\doublecolumnhsize % have to restore this since output routine
2480 \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}}
2481 \def\doublecolumnout{%
2482 \setbox5=\copy255
2483 {\vbadness=10000 \doublecolumnsplit}
2484 \ifvbox255
2485 \setbox0=\vtop to\dimen@{\unvbox0}
2486 \setbox2=\vtop to\dimen@{\unvbox2}
2487 \onepageout\pagesofar \unvbox255 \penalty\outputpenalty
2488 \else
2489 \setbox0=\vbox{\unvbox5}
2490 \ifvbox0
2491 \dimen@=\ht0 \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
2492 \divide\dimen@ by2 \splittopskip=\topskip \splitmaxdepth=\maxdepth
2493 {\vbadness=10000
2494 \loop \global\setbox5=\copy0
2495 \setbox1=\vsplit5 to\dimen@
2496 \setbox3=\vsplit5 to\dimen@
2497 \ifvbox5 \global\advance\dimen@ by1pt \repeat
2498 \setbox0=\vbox to\dimen@{\unvbox1}
2499 \setbox2=\vbox to\dimen@{\unvbox3}
2500 \global\setbox\partialpage=\vbox{\pagesofar}
2501 \doublecolumnpagegoal
2507 \catcode `\@=\other
2508 \message{sectioning,}
2509 % Define chapters, sections, etc.
2511 \newcount \chapno
2512 \newcount \secno \secno=0
2513 \newcount \subsecno \subsecno=0
2514 \newcount \subsubsecno \subsubsecno=0
2516 % This counter is funny since it counts through charcodes of letters A, B, ...
2517 \newcount \appendixno \appendixno = `\@
2518 \def\appendixletter{\char\the\appendixno}
2520 \newwrite \contentsfile
2521 % This is called from \setfilename.
2522 \def\opencontents{\openout \contentsfile = \jobname.toc}
2524 % Each @chapter defines this as the name of the chapter.
2525 % page headings and footings can use it. @section does likewise
2527 \def\thischapter{} \def\thissection{}
2528 \def\seccheck#1{\if \pageno<0 %
2529 \errmessage{@#1 not allowed after generating table of contents}\fi
2533 \def\chapternofonts{%
2534 \let\rawbackslash=\relax%
2535 \let\frenchspacing=\relax%
2536 \def\result{\realbackslash result}
2537 \def\equiv{\realbackslash equiv}
2538 \def\expansion{\realbackslash expansion}
2539 \def\print{\realbackslash print}
2540 \def\TeX{\realbackslash TeX}
2541 \def\dots{\realbackslash dots}
2542 \def\copyright{\realbackslash copyright}
2543 \def\tt{\realbackslash tt}
2544 \def\bf{\realbackslash bf }
2545 \def\w{\realbackslash w}
2546 \def\less{\realbackslash less}
2547 \def\gtr{\realbackslash gtr}
2548 \def\hat{\realbackslash hat}
2549 \def\char{\realbackslash char}
2550 \def\tclose##1{\realbackslash tclose {##1}}
2551 \def\code##1{\realbackslash code {##1}}
2552 \def\samp##1{\realbackslash samp {##1}}
2553 \def\r##1{\realbackslash r {##1}}
2554 \def\b##1{\realbackslash b {##1}}
2555 \def\key##1{\realbackslash key {##1}}
2556 \def\file##1{\realbackslash file {##1}}
2557 \def\kbd##1{\realbackslash kbd {##1}}
2558 % These are redefined because @smartitalic wouldn't work inside xdef.
2559 \def\i##1{\realbackslash i {##1}}
2560 \def\cite##1{\realbackslash cite {##1}}
2561 \def\var##1{\realbackslash var {##1}}
2562 \def\emph##1{\realbackslash emph {##1}}
2563 \def\dfn##1{\realbackslash dfn {##1}}
2566 \newcount\absseclevel % used to calculate proper heading level
2567 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
2569 % @raisesections: treat @section as chapter, @subsection as section, etc.
2570 \def\raisesections{\global\advance\secbase by -1}
2571 \let\up=\raisesections % original BFox name
2573 % @lowersections: treat @chapter as section, @section as subsection, etc.
2574 \def\lowersections{\global\advance\secbase by 1}
2575 \let\down=\lowersections % original BFox name
2577 % Choose a numbered-heading macro
2578 % #1 is heading level if unmodified by @raisesections or @lowersections
2579 % #2 is text for heading
2580 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2581 \ifcase\absseclevel
2582 \chapterzzz{#2}
2584 \seczzz{#2}
2586 \numberedsubseczzz{#2}
2588 \numberedsubsubseczzz{#2}
2589 \else
2590 \ifnum \absseclevel<0
2591 \chapterzzz{#2}
2592 \else
2593 \numberedsubsubseczzz{#2}
2598 % like \numhead, but chooses appendix heading levels
2599 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2600 \ifcase\absseclevel
2601 \appendixzzz{#2}
2603 \appendixsectionzzz{#2}
2605 \appendixsubseczzz{#2}
2607 \appendixsubsubseczzz{#2}
2608 \else
2609 \ifnum \absseclevel<0
2610 \appendixzzz{#2}
2611 \else
2612 \appendixsubsubseczzz{#2}
2617 % like \numhead, but chooses numberless heading levels
2618 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2619 \ifcase\absseclevel
2620 \unnumberedzzz{#2}
2622 \unnumberedseczzz{#2}
2624 \unnumberedsubseczzz{#2}
2626 \unnumberedsubsubseczzz{#2}
2627 \else
2628 \ifnum \absseclevel<0
2629 \unnumberedzzz{#2}
2630 \else
2631 \unnumberedsubsubseczzz{#2}
2637 \def\thischaptername{No Chapter Title}
2638 \outer\def\chapter{\parsearg\chapteryyy}
2639 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2640 \def\chapterzzz #1{\seccheck{chapter}%
2641 \secno=0 \subsecno=0 \subsubsecno=0
2642 \global\advance \chapno by 1 \message{\putwordChapter \the\chapno}%
2643 \chapmacro {#1}{\the\chapno}%
2644 \gdef\thissection{#1}%
2645 \gdef\thischaptername{#1}%
2646 % We don't substitute the actual chapter name into \thischapter
2647 % because we don't want its macros evaluated now.
2648 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
2649 {\chapternofonts%
2650 \edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}%
2651 \escapechar=`\\%
2652 \write \contentsfile \temp %
2653 \donoderef %
2654 \global\let\section = \numberedsec
2655 \global\let\subsection = \numberedsubsec
2656 \global\let\subsubsection = \numberedsubsubsec
2659 \outer\def\appendix{\parsearg\appendixyyy}
2660 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2661 \def\appendixzzz #1{\seccheck{appendix}%
2662 \secno=0 \subsecno=0 \subsubsecno=0
2663 \global\advance \appendixno by 1 \message{Appendix \appendixletter}%
2664 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
2665 \gdef\thissection{#1}%
2666 \gdef\thischaptername{#1}%
2667 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
2668 {\chapternofonts%
2669 \edef\temp{{\realbackslash chapentry
2670 {#1}{\putwordAppendix{} \appendixletter}{\noexpand\folio}}}%
2671 \escapechar=`\\%
2672 \write \contentsfile \temp %
2673 \appendixnoderef %
2674 \global\let\section = \appendixsec
2675 \global\let\subsection = \appendixsubsec
2676 \global\let\subsubsection = \appendixsubsubsec
2679 % @centerchap is like @unnumbered, but the heading is centered.
2680 \outer\def\centerchap{\parsearg\centerchapyyy}
2681 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
2683 \outer\def\top{\parsearg\unnumberedyyy}
2684 \outer\def\unnumbered{\parsearg\unnumberedyyy}
2685 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2686 \def\unnumberedzzz #1{\seccheck{unnumbered}%
2687 \secno=0 \subsecno=0 \subsubsecno=0
2689 % This used to be simply \message{#1}, but TeX fully expands the
2690 % argument to \message. Therefore, if #1 contained @-commands, TeX
2691 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2692 % expanded @cite (which turns out to cause errors because \cite is meant
2693 % to be executed, not expanded).
2695 % Anyway, we don't want the fully-expanded definition of @cite to appear
2696 % as a result of the \message, we just want `@cite' itself. We use
2697 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
2698 % simply yielding the contents of the <toks register>.
2699 \toks0 = {#1}\message{(\the\toks0)}%
2701 \unnumbchapmacro {#1}%
2702 \gdef\thischapter{#1}\gdef\thissection{#1}%
2703 {\chapternofonts%
2704 \edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}%
2705 \escapechar=`\\%
2706 \write \contentsfile \temp %
2707 \unnumbnoderef %
2708 \global\let\section = \unnumberedsec
2709 \global\let\subsection = \unnumberedsubsec
2710 \global\let\subsubsection = \unnumberedsubsubsec
2713 \outer\def\numberedsec{\parsearg\secyyy}
2714 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2715 \def\seczzz #1{\seccheck{section}%
2716 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2717 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2718 {\chapternofonts%
2719 \edef\temp{{\realbackslash secentry %
2720 {#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
2721 \escapechar=`\\%
2722 \write \contentsfile \temp %
2723 \donoderef %
2724 \penalty 10000 %
2727 \outer\def\appendixsection{\parsearg\appendixsecyyy}
2728 \outer\def\appendixsec{\parsearg\appendixsecyyy}
2729 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2730 \def\appendixsectionzzz #1{\seccheck{appendixsection}%
2731 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2732 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2733 {\chapternofonts%
2734 \edef\temp{{\realbackslash secentry %
2735 {#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
2736 \escapechar=`\\%
2737 \write \contentsfile \temp %
2738 \appendixnoderef %
2739 \penalty 10000 %
2742 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2743 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2744 \def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
2745 \plainsecheading {#1}\gdef\thissection{#1}%
2746 {\chapternofonts%
2747 \edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}%
2748 \escapechar=`\\%
2749 \write \contentsfile \temp %
2750 \unnumbnoderef %
2751 \penalty 10000 %
2754 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
2755 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
2756 \def\numberedsubseczzz #1{\seccheck{subsection}%
2757 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2758 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
2759 {\chapternofonts%
2760 \edef\temp{{\realbackslash subsecentry %
2761 {#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2762 \escapechar=`\\%
2763 \write \contentsfile \temp %
2764 \donoderef %
2765 \penalty 10000 %
2768 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
2769 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
2770 \def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
2771 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2772 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
2773 {\chapternofonts%
2774 \edef\temp{{\realbackslash subsecentry %
2775 {#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2776 \escapechar=`\\%
2777 \write \contentsfile \temp %
2778 \appendixnoderef %
2779 \penalty 10000 %
2782 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
2783 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
2784 \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
2785 \plainsubsecheading {#1}\gdef\thissection{#1}%
2786 {\chapternofonts%
2787 \edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}%
2788 \escapechar=`\\%
2789 \write \contentsfile \temp %
2790 \unnumbnoderef %
2791 \penalty 10000 %
2794 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
2795 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
2796 \def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
2797 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2798 \subsubsecheading {#1}
2799 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2800 {\chapternofonts%
2801 \edef\temp{{\realbackslash subsubsecentry %
2802 {#1}
2803 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
2804 {\noexpand\folio}}}%
2805 \escapechar=`\\%
2806 \write \contentsfile \temp %
2807 \donoderef %
2808 \penalty 10000 %
2811 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
2812 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
2813 \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
2814 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2815 \subsubsecheading {#1}
2816 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2817 {\chapternofonts%
2818 \edef\temp{{\realbackslash subsubsecentry{#1}%
2819 {\appendixletter}
2820 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
2821 \escapechar=`\\%
2822 \write \contentsfile \temp %
2823 \appendixnoderef %
2824 \penalty 10000 %
2827 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
2828 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
2829 \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
2830 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
2831 {\chapternofonts%
2832 \edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}%
2833 \escapechar=`\\%
2834 \write \contentsfile \temp %
2835 \unnumbnoderef %
2836 \penalty 10000 %
2839 % These are variants which are not "outer", so they can appear in @ifinfo.
2840 % Actually, they should now be obsolete; ordinary section commands should work.
2841 \def\infotop{\parsearg\unnumberedzzz}
2842 \def\infounnumbered{\parsearg\unnumberedzzz}
2843 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
2844 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
2845 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
2847 \def\infoappendix{\parsearg\appendixzzz}
2848 \def\infoappendixsec{\parsearg\appendixseczzz}
2849 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
2850 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
2852 \def\infochapter{\parsearg\chapterzzz}
2853 \def\infosection{\parsearg\sectionzzz}
2854 \def\infosubsection{\parsearg\subsectionzzz}
2855 \def\infosubsubsection{\parsearg\subsubsectionzzz}
2857 % These macros control what the section commands do, according
2858 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
2859 % Define them by default for a numbered chapter.
2860 \global\let\section = \numberedsec
2861 \global\let\subsection = \numberedsubsec
2862 \global\let\subsubsection = \numberedsubsubsec
2864 % Define @majorheading, @heading and @subheading
2866 % NOTE on use of \vbox for chapter headings, section headings, and
2867 % such:
2868 % 1) We use \vbox rather than the earlier \line to permit
2869 % overlong headings to fold.
2870 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
2871 % heading is obnoxious; this forbids it.
2872 % 3) Likewise, headings look best if no \parindent is used, and
2873 % if justification is not attempted. Hence \raggedright.
2876 \def\majorheading{\parsearg\majorheadingzzz}
2877 \def\majorheadingzzz #1{%
2878 {\advance\chapheadingskip by 10pt \chapbreak }%
2879 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2880 \parindent=0pt\raggedright
2881 \rm #1\hfill}}\bigskip \par\penalty 200}
2883 \def\chapheading{\parsearg\chapheadingzzz}
2884 \def\chapheadingzzz #1{\chapbreak %
2885 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2886 \parindent=0pt\raggedright
2887 \rm #1\hfill}}\bigskip \par\penalty 200}
2889 % @heading, @subheading, @subsubheading.
2890 \def\heading{\parsearg\plainsecheading}
2891 \def\subheading{\parsearg\plainsubsecheading}
2892 \def\subsubheading{\parsearg\plainsubsubsecheading}
2894 % These macros generate a chapter, section, etc. heading only
2895 % (including whitespace, linebreaking, etc. around it),
2896 % given all the information in convenient, parsed form.
2898 %%% Args are the skip and penalty (usually negative)
2899 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
2901 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
2903 %%% Define plain chapter starts, and page on/off switching for it
2904 % Parameter controlling skip before chapter headings (if needed)
2906 \newskip \chapheadingskip \chapheadingskip = 30pt plus 8pt minus 4pt
2908 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
2909 \def\chappager{\par\vfill\supereject}
2910 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
2912 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
2914 \def\CHAPPAGoff{
2915 \global\let\contentsalignmacro = \chappager
2916 \global\let\pchapsepmacro=\chapbreak
2917 \global\let\pagealignmacro=\chappager}
2919 \def\CHAPPAGon{
2920 \global\let\contentsalignmacro = \chappager
2921 \global\let\pchapsepmacro=\chappager
2922 \global\let\pagealignmacro=\chappager
2923 \global\def\HEADINGSon{\HEADINGSsingle}}
2925 \def\CHAPPAGodd{
2926 \global\let\contentsalignmacro = \chapoddpage
2927 \global\let\pchapsepmacro=\chapoddpage
2928 \global\let\pagealignmacro=\chapoddpage
2929 \global\def\HEADINGSon{\HEADINGSdouble}}
2931 \CHAPPAGon
2933 \def\CHAPFplain{
2934 \global\let\chapmacro=\chfplain
2935 \global\let\unnumbchapmacro=\unnchfplain
2936 \global\let\centerchapmacro=\centerchfplain}
2938 % #1 is the text, #2 the chapter number.
2939 \def\chfplain #1#2{%
2940 \pchapsepmacro
2942 \chapfonts \rm
2943 \setbox0 = \hbox{#2\enspace}%
2944 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
2945 \hangindent = \wd0
2946 \unhbox0 #1}%
2948 \nobreak\bigskip % no page break after a chapter title
2949 \nobreak
2952 \def\unnchfplain #1{%
2953 \pchapsepmacro %
2954 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2955 \parindent=0pt\raggedright
2956 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2959 \def\centerchfplain #1{%
2960 \pchapsepmacro %
2961 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2962 \parindent=0pt
2963 {\rm #1}\hfill}}\bigskip \par\penalty 10000 %
2966 \CHAPFplain % The default
2968 \def\unnchfopen #1{%
2969 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2970 \parindent=0pt\raggedright
2971 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2974 \def\chfopen #1#2{\chapoddpage {\chapfonts
2975 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
2976 \par\penalty 5000 %
2979 \def\centerchfopen #1{%
2980 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2981 \parindent=0pt
2982 \hfill {\rm #1}\hfill}}\bigskip \par\penalty 10000 %
2985 \def\CHAPFopen{
2986 \global\let\chapmacro=\chfopen
2987 \global\let\unnumbchapmacro=\unnchfopen
2988 \global\let\centerchapmacro=\centerchfopen}
2991 % Section titles.
2992 \newskip \secheadingskip \secheadingskip = 21pt plus 8pt minus 4pt
2993 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
2994 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
2995 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
2997 % Subsection titles.
2998 \newskip \subsecheadingskip \subsecheadingskip = 17pt plus 8pt minus 4pt
2999 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3000 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3001 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3003 % Subsubsection titles.
3004 \let\subsubsecheadingskip = \subsecheadingskip
3005 \let\subsubsecheadingbreak = \subsecheadingbreak
3006 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
3007 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
3010 % Print any size section title.
3012 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3013 % number (maybe empty), #3 the text.
3014 \def\sectionheading#1#2#3{%
3016 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3017 \csname #1headingbreak\endcsname
3020 \csname #1fonts\endcsname \rm
3021 \def\secnum{#2}%
3022 % Only insert the separating space if we have a section number.
3023 \setbox0 = \hbox{#2\ifx\secnum\empty\else \enspace \fi}%
3024 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3025 \hangindent = \wd0 % zero if no section number
3026 \unhbox0 #3}%
3028 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3032 \message{toc printing,}
3034 % Finish up the main text and prepare to read what we've written
3035 % to \contentsfile.
3037 \newskip\contentsrightmargin \contentsrightmargin=1in
3038 \def\startcontents#1{%
3039 % If @setchapternewpage on, and @headings double, the contents should
3040 % start on an odd page, unlike chapters. Thus, we maintain
3041 % \contentsalignmacro in parallel with \pagealignmacro.
3042 % From: Torbjorn Granlund <tege@matematik.su.se>
3043 \contentsalignmacro
3044 \immediate\closeout \contentsfile
3045 \ifnum \pageno>0
3046 \pageno = -1 % Request roman numbered pages.
3048 % Don't need to put `Contents' or `Short Contents' in the headline.
3049 % It is abundantly clear what they are.
3050 \unnumbchapmacro{#1}\def\thischapter{}%
3051 \begingroup % Set up to handle contents files properly.
3052 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
3053 \catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3054 \raggedbottom % Worry more about breakpoints than the bottom.
3055 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3059 % Normal (long) toc.
3060 \outer\def\contents{%
3061 \startcontents{\putwordTableofContents}%
3062 \input \jobname.toc
3063 \endgroup
3064 \vfill \eject
3067 % And just the chapters.
3068 \outer\def\summarycontents{%
3069 \startcontents{\putwordShortContents}%
3071 \let\chapentry = \shortchapentry
3072 \let\unnumbchapentry = \shortunnumberedentry
3073 % We want a true roman here for the page numbers.
3074 \secfonts
3075 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3077 \advance\baselineskip by 1pt % Open it up a little.
3078 \def\secentry ##1##2##3##4{}
3079 \def\unnumbsecentry ##1##2{}
3080 \def\subsecentry ##1##2##3##4##5{}
3081 \def\unnumbsubsecentry ##1##2{}
3082 \def\subsubsecentry ##1##2##3##4##5##6{}
3083 \def\unnumbsubsubsecentry ##1##2{}
3084 \input \jobname.toc
3085 \endgroup
3086 \vfill \eject
3088 \let\shortcontents = \summarycontents
3090 % These macros generate individual entries in the table of contents.
3091 % The first argument is the chapter or section name.
3092 % The last argument is the page number.
3093 % The arguments in between are the chapter number, section number, ...
3095 % Chapter-level things, for both the long and short contents.
3096 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3098 % See comments in \dochapentry re vbox and related settings
3099 \def\shortchapentry#1#2#3{%
3100 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
3103 % Typeset the label for a chapter or appendix for the short contents.
3104 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3105 % We could simplify the code here by writing out an \appendixentry
3106 % command in the toc file for appendices, instead of using \chapentry
3107 % for both, but it doesn't seem worth it.
3108 \setbox0 = \hbox{\shortcontrm \putwordAppendix }
3109 \newdimen\shortappendixwidth \shortappendixwidth = \wd0
3111 \def\shortchaplabel#1{%
3112 % We typeset #1 in a box of constant width, regardless of the text of
3113 % #1, so the chapter titles will come out aligned.
3114 \setbox0 = \hbox{#1}%
3115 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3117 % This space should be plenty, since a single number is .5em, and the
3118 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3119 % (This space doesn't include the extra space that gets added after
3120 % the label; that gets put in in \shortchapentry above.)
3121 \advance\dimen0 by 1.1em
3122 \hbox to \dimen0{#1\hfil}%
3125 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3126 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
3128 % Sections.
3129 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
3130 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
3132 % Subsections.
3133 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
3134 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
3136 % And subsubsections.
3137 \def\subsubsecentry#1#2#3#4#5#6{%
3138 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
3139 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
3142 % This parameter controls the indentation of the various levels.
3143 \newdimen\tocindent \tocindent = 3pc
3145 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
3146 % page number.
3148 % If the toc has to be broken over pages, we would want to be at chapters
3149 % if at all possible; hence the \penalty.
3150 \def\dochapentry#1#2{%
3151 \penalty-300 \vskip\baselineskip
3152 \begingroup
3153 \chapentryfonts
3154 \tocentry{#1}{\dopageno{#2}}%
3155 \endgroup
3156 \nobreak\vskip .25\baselineskip
3159 \def\dosecentry#1#2{\begingroup
3160 \secentryfonts \leftskip=\tocindent
3161 \tocentry{#1}{\dopageno{#2}}%
3162 \endgroup}
3164 \def\dosubsecentry#1#2{\begingroup
3165 \subsecentryfonts \leftskip=2\tocindent
3166 \tocentry{#1}{\dopageno{#2}}%
3167 \endgroup}
3169 \def\dosubsubsecentry#1#2{\begingroup
3170 \subsubsecentryfonts \leftskip=3\tocindent
3171 \tocentry{#1}{\dopageno{#2}}%
3172 \endgroup}
3174 % Final typesetting of a toc entry; we use the same \entry macro as for
3175 % the index entries, but we want to suppress hyphenation here. (We
3176 % can't do that in the \entry macro, since index entries might consist
3177 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3179 % \turnoffactive is for the sake of @" used for umlauts.
3180 \def\tocentry#1#2{\begingroup
3181 \hyphenpenalty = 10000
3182 \entry{\turnoffactive #1}{\turnoffactive #2}%
3183 \endgroup}
3185 % Space between chapter (or whatever) number and the title.
3186 \def\labelspace{\hskip1em \relax}
3188 \def\dopageno#1{{\rm #1}}
3189 \def\doshortpageno#1{{\rm #1}}
3191 \def\chapentryfonts{\secfonts \rm}
3192 \def\secentryfonts{\textfonts}
3193 \let\subsecentryfonts = \textfonts
3194 \let\subsubsecentryfonts = \textfonts
3197 \message{environments,}
3199 % Since these characters are used in examples, it should be an even number of
3200 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3201 % Furthermore, these definitions must come after we define our fonts.
3202 \newbox\dblarrowbox \newbox\longdblarrowbox
3203 \newbox\pushcharbox \newbox\bullbox
3204 \newbox\equivbox \newbox\errorbox
3206 \let\ptexequiv = \equiv
3208 %{\tentt
3209 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3210 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3211 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3212 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3213 % Adapted from the manmac format (p.420 of TeXbook)
3214 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3215 % depth .1ex\hfil}
3218 \def\point{$\star$}
3220 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3221 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
3222 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3224 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3226 % Adapted from the TeXbook's \boxit.
3227 {\tentt \global\dimen0 = 3em}% Width of the box.
3228 \dimen2 = .55pt % Thickness of rules
3229 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3230 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
3232 \global\setbox\errorbox=\hbox to \dimen0{\hfil
3233 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3234 \advance\hsize by -2\dimen2 % Rules.
3235 \vbox{
3236 \hrule height\dimen2
3237 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3238 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3239 \kern3pt\vrule width\dimen2}% Space to right.
3240 \hrule height\dimen2}
3241 \hfil}
3243 % The @error{} command.
3244 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3246 % @tex ... @end tex escapes into raw Tex temporarily.
3247 % One exception: @ is still an escape character, so that @end tex works.
3248 % But \@ or @@ will get a plain tex @ character.
3250 \def\tex{\begingroup
3251 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
3252 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
3253 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
3254 \catcode `\%=14
3255 \catcode 43=12
3256 \catcode`\"=12
3257 \catcode`\==12
3258 \catcode`\|=12
3259 \catcode`\<=12
3260 \catcode`\>=12
3261 \escapechar=`\\
3263 \let\~=\ptextilde
3264 \let\{=\ptexlbrace
3265 \let\}=\ptexrbrace
3266 \let\.=\ptexdot
3267 \let\*=\ptexstar
3268 \let\dots=\ptexdots
3269 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}
3270 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}
3271 \def\@{@}%
3272 \let\bullet=\ptexbullet
3273 \let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext \let\l=\ptexl
3274 \let\L=\ptexL
3276 \let\Etex=\endgroup}
3278 % Define @lisp ... @endlisp.
3279 % @lisp does a \begingroup so it can rebind things,
3280 % including the definition of @endlisp (which normally is erroneous).
3282 % Amount to narrow the margins by for @lisp.
3283 \newskip\lispnarrowing \lispnarrowing=0.4in
3285 % This is the definition that ^^M gets inside @lisp, @example, and other
3286 % such environments. \null is better than a space, since it doesn't
3287 % have any width.
3288 \def\lisppar{\null\endgraf}
3290 % Make each space character in the input produce a normal interword
3291 % space in the output. Don't allow a line break at this space, as this
3292 % is used only in environments like @example, where each line of input
3293 % should produce a line of output anyway.
3295 {\obeyspaces %
3296 \gdef\sepspaces{\obeyspaces\let =\tie}}
3298 % Define \obeyedspace to be our active space, whatever it is. This is
3299 % for use in \parsearg.
3300 {\sepspaces%
3301 \global\let\obeyedspace= }
3303 % This space is always present above and below environments.
3304 \newskip\envskipamount \envskipamount = 0pt
3306 % Make spacing and below environment symmetrical. We use \parskip here
3307 % to help in doing that, since in @example-like environments \parskip
3308 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
3309 % start of the next paragraph will insert \parskip
3311 \def\aboveenvbreak{{\advance\envskipamount by \parskip
3312 \endgraf \ifdim\lastskip<\envskipamount
3313 \removelastskip \penalty-50 \vskip\envskipamount \fi}}
3315 \let\afterenvbreak = \aboveenvbreak
3317 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
3318 \let\nonarrowing=\relax
3320 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3321 % \cartouche: draw rectangle w/rounded corners around argument
3322 \font\circle=lcircle10
3323 \newdimen\circthick
3324 \newdimen\cartouter\newdimen\cartinner
3325 \newskip\normbskip\newskip\normpskip\newskip\normlskip
3326 \circthick=\fontdimen8\circle
3328 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
3329 \def\ctr{{\hskip 6pt\circle\char'010}}
3330 \def\cbl{{\circle\char'012\hskip -6pt}}
3331 \def\cbr{{\hskip 6pt\circle\char'011}}
3332 \def\carttop{\hbox to \cartouter{\hskip\lskip
3333 \ctl\leaders\hrule height\circthick\hfil\ctr
3334 \hskip\rskip}}
3335 \def\cartbot{\hbox to \cartouter{\hskip\lskip
3336 \cbl\leaders\hrule height\circthick\hfil\cbr
3337 \hskip\rskip}}
3339 \newskip\lskip\newskip\rskip
3341 \long\def\cartouche{%
3342 \begingroup
3343 \lskip=\leftskip \rskip=\rightskip
3344 \leftskip=0pt\rightskip=0pt %we want these *outside*.
3345 \cartinner=\hsize \advance\cartinner by-\lskip
3346 \advance\cartinner by-\rskip
3347 \cartouter=\hsize
3348 \advance\cartouter by 18pt % allow for 3pt kerns on either
3349 % side, and for 6pt waste from
3350 % each corner char
3351 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
3352 % Flag to tell @lisp, etc., not to narrow margin.
3353 \let\nonarrowing=\comment
3354 \vbox\bgroup
3355 \baselineskip=0pt\parskip=0pt\lineskip=0pt
3356 \carttop
3357 \hbox\bgroup
3358 \hskip\lskip
3359 \vrule\kern3pt
3360 \vbox\bgroup
3361 \hsize=\cartinner
3362 \kern3pt
3363 \begingroup
3364 \baselineskip=\normbskip
3365 \lineskip=\normlskip
3366 \parskip=\normpskip
3367 \vskip -\parskip
3368 \def\Ecartouche{%
3369 \endgroup
3370 \kern3pt
3371 \egroup
3372 \kern3pt\vrule
3373 \hskip\rskip
3374 \egroup
3375 \cartbot
3376 \egroup
3377 \endgroup
3381 % This macro is called at the beginning of all the @example variants,
3382 % inside a group.
3383 \def\nonfillstart{%
3384 \aboveenvbreak
3385 \inENV % This group ends at the end of the body
3386 \hfuzz = 12pt % Don't be fussy
3387 \sepspaces % Make spaces be word-separators rather than space tokens.
3388 \singlespace
3389 \let\par = \lisppar % don't ignore blank lines
3390 \obeylines % each line of input is a line of output
3391 \parskip = 0pt
3392 \parindent = 0pt
3393 \emergencystretch = 0pt % don't try to avoid overfull boxes
3394 % @cartouche defines \nonarrowing to inhibit narrowing
3395 % at next level down.
3396 \ifx\nonarrowing\relax
3397 \advance \leftskip by \lispnarrowing
3398 \exdentamount=\lispnarrowing
3399 \let\exdent=\nofillexdent
3400 \let\nonarrowing=\relax
3404 % To ending an @example-like environment, we first end the paragraph
3405 % (via \afterenvbreak's vertical glue), and then the group. That way we
3406 % keep the zero \parskip that the environments set -- \parskip glue
3407 % will be inserted at the beginning of the next paragraph in the
3408 % document, after the environment.
3410 \def\nonfillfinish{\afterenvbreak\endgroup}%
3412 % This macro is
3413 \def\lisp{\begingroup
3414 \nonfillstart
3415 \let\Elisp = \nonfillfinish
3417 \rawbackslash % have \ input char produce \ char from current font
3418 \gobble
3421 % Define the \E... control sequence only if we are inside the
3422 % environment, so the error checking in \end will work.
3424 % We must call \lisp last in the definition, since it reads the
3425 % return following the @example (or whatever) command.
3427 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
3428 \def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
3429 \def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
3431 % @smallexample and @smalllisp. This is not used unless the @smallbook
3432 % command is given. Originally contributed by Pavel@xerox.
3434 \def\smalllispx{\begingroup
3435 \nonfillstart
3436 \let\Esmalllisp = \nonfillfinish
3437 \let\Esmallexample = \nonfillfinish
3439 % Smaller fonts for small examples.
3440 \indexfonts \tt
3441 \rawbackslash % make \ output the \ character from the current font (tt)
3442 \gobble
3445 % This is @display; same as @lisp except use roman font.
3447 \def\display{\begingroup
3448 \nonfillstart
3449 \let\Edisplay = \nonfillfinish
3450 \gobble
3453 % This is @format; same as @display except don't narrow margins.
3455 \def\format{\begingroup
3456 \let\nonarrowing = t
3457 \nonfillstart
3458 \let\Eformat = \nonfillfinish
3459 \gobble
3462 % @flushleft (same as @format) and @flushright.
3464 \def\flushleft{\begingroup
3465 \let\nonarrowing = t
3466 \nonfillstart
3467 \let\Eflushleft = \nonfillfinish
3468 \gobble
3470 \def\flushright{\begingroup
3471 \let\nonarrowing = t
3472 \nonfillstart
3473 \let\Eflushright = \nonfillfinish
3474 \advance\leftskip by 0pt plus 1fill
3475 \gobble}
3477 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
3478 % and narrows the margins.
3480 \def\quotation{%
3481 \begingroup\inENV %This group ends at the end of the @quotation body
3482 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
3483 \singlespace
3484 \parindent=0pt
3485 % We have retained a nonzero parskip for the environment, since we're
3486 % doing normal filling. So to avoid extra space below the environment...
3487 \def\Equotation{\parskip = 0pt \nonfillfinish}%
3489 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
3490 \ifx\nonarrowing\relax
3491 \advance\leftskip by \lispnarrowing
3492 \advance\rightskip by \lispnarrowing
3493 \exdentamount = \lispnarrowing
3494 \let\nonarrowing = \relax
3498 \message{defuns,}
3499 % Define formatter for defuns
3500 % First, allow user to change definition object font (\df) internally
3501 \def\setdeffont #1 {\csname DEF#1\endcsname}
3503 \newskip\defbodyindent \defbodyindent=.4in
3504 \newskip\defargsindent \defargsindent=50pt
3505 \newskip\deftypemargin \deftypemargin=12pt
3506 \newskip\deflastargmargin \deflastargmargin=18pt
3508 \newcount\parencount
3509 % define \functionparens, which makes ( and ) and & do special things.
3510 % \functionparens affects the group it is contained in.
3511 \def\activeparens{%
3512 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
3513 \catcode`\[=\active \catcode`\]=\active}
3515 % Make control sequences which act like normal parenthesis chars.
3516 \let\lparen = ( \let\rparen = )
3518 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3520 % Be sure that we always have a definition for `(', etc. For example,
3521 % if the fn name has parens in it, \boldbrax will not be in effect yet,
3522 % so TeX would otherwise complain about undefined control sequence.
3523 \global\let(=\lparen \global\let)=\rparen
3524 \global\let[=\lbrack \global\let]=\rbrack
3526 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
3527 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
3528 % This is used to turn on special parens
3529 % but make & act ordinary (given that it's active).
3530 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
3532 % Definitions of (, ) and & used in args for functions.
3533 % This is the definition of ( outside of all parentheses.
3534 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested %
3535 \global\advance\parencount by 1 }
3537 % This is the definition of ( when already inside a level of parens.
3538 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
3540 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
3541 % also in that case restore the outer-level definition of (.
3542 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
3543 \global\advance \parencount by -1 }
3544 % If we encounter &foo, then turn on ()-hacking afterwards
3545 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
3547 \gdef\normalparens{\boldbrax\let&=\ampnr}
3548 } % End of definition inside \activeparens
3549 %% These parens (in \boldbrax) actually are a little bolder than the
3550 %% contained text. This is especially needed for [ and ]
3551 \def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&}
3552 \def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}}
3554 % First, defname, which formats the header line itself.
3555 % #1 should be the function name.
3556 % #2 should be the type of definition, such as "Function".
3558 \def\defname #1#2{%
3559 % Get the values of \leftskip and \rightskip as they were
3560 % outside the @def...
3561 \dimen2=\leftskip
3562 \advance\dimen2 by -\defbodyindent
3563 \dimen3=\rightskip
3564 \advance\dimen3 by -\defbodyindent
3565 \noindent %
3566 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3567 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
3568 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
3569 \parshape 2 0in \dimen0 \defargsindent \dimen1 %
3570 % Now output arg 2 ("Function" or some such)
3571 % ending at \deftypemargin from the right margin,
3572 % but stuck inside a box of width 0 so it does not interfere with linebreaking
3573 {% Adjust \hsize to exclude the ambient margins,
3574 % so that \rightline will obey them.
3575 \advance \hsize by -\dimen2 \advance \hsize by -\dimen3
3576 \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3577 % Make all lines underfull and no complaints:
3578 \tolerance=10000 \hbadness=10000
3579 \advance\leftskip by -\defbodyindent
3580 \exdentamount=\defbodyindent
3581 {\df #1}\enskip % Generate function name
3584 % Actually process the body of a definition
3585 % #1 should be the terminating control sequence, such as \Edefun.
3586 % #2 should be the "another name" control sequence, such as \defunx.
3587 % #3 should be the control sequence that actually processes the header,
3588 % such as \defunheader.
3590 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3591 \medbreak %
3592 % Define the end token that this defining construct specifies
3593 % so that it will exit this group.
3594 \def#1{\endgraf\endgroup\medbreak}%
3595 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3596 \parindent=0in
3597 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3598 \exdentamount=\defbodyindent
3599 \begingroup %
3600 \catcode 61=\active % 61 is `='
3601 \obeylines\activeparens\spacesplit#3}
3603 \def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3604 \medbreak %
3605 % Define the end token that this defining construct specifies
3606 % so that it will exit this group.
3607 \def#1{\endgraf\endgroup\medbreak}%
3608 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
3609 \parindent=0in
3610 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3611 \exdentamount=\defbodyindent
3612 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3614 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3615 \medbreak %
3616 % Define the end token that this defining construct specifies
3617 % so that it will exit this group.
3618 \def#1{\endgraf\endgroup\medbreak}%
3619 \def#2##1 ##2 {\def#4{##1}%
3620 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
3621 \parindent=0in
3622 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3623 \exdentamount=\defbodyindent
3624 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3626 % These parsing functions are similar to the preceding ones
3627 % except that they do not make parens into active characters.
3628 % These are used for "variables" since they have no arguments.
3630 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3631 \medbreak %
3632 % Define the end token that this defining construct specifies
3633 % so that it will exit this group.
3634 \def#1{\endgraf\endgroup\medbreak}%
3635 \def#2{\begingroup\obeylines\spacesplit#3}%
3636 \parindent=0in
3637 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3638 \exdentamount=\defbodyindent
3639 \begingroup %
3640 \catcode 61=\active %
3641 \obeylines\spacesplit#3}
3643 % This is used for \def{tp,vr}parsebody. It could probably be used for
3644 % some of the others, too, with some judicious conditionals.
3646 \def\parsebodycommon#1#2#3{%
3647 \begingroup\inENV %
3648 \medbreak %
3649 % Define the end token that this defining construct specifies
3650 % so that it will exit this group.
3651 \def#1{\endgraf\endgroup\medbreak}%
3652 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
3653 \parindent=0in
3654 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3655 \exdentamount=\defbodyindent
3656 \begingroup\obeylines
3659 \def\defvrparsebody#1#2#3#4 {%
3660 \parsebodycommon{#1}{#2}{#3}%
3661 \spacesplit{#3{#4}}%
3664 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3665 % type is just `struct', because we lose the braces in `{struct
3666 % termios}' when \spacesplit reads its undelimited argument. Sigh.
3667 % \let\deftpparsebody=\defvrparsebody
3669 % So, to get around this, we put \empty in with the type name. That
3670 % way, TeX won't find exactly `{...}' as an undelimited argument, and
3671 % won't strip off the braces.
3673 \def\deftpparsebody #1#2#3#4 {%
3674 \parsebodycommon{#1}{#2}{#3}%
3675 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3678 % Fine, but then we have to eventually remove the \empty *and* the
3679 % braces (if any). That's what this does, putting the result in \tptemp.
3681 \def\removeemptybraces\empty#1\relax{\def\tptemp{#1}}%
3683 % After \spacesplit has done its work, this is called -- #1 is the final
3684 % thing to call, #2 the type name (which starts with \empty), and #3
3685 % (which might be empty) the arguments.
3687 \def\parsetpheaderline#1#2#3{%
3688 \removeemptybraces#2\relax
3689 #1{\tptemp}{#3}%
3692 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3693 \medbreak %
3694 % Define the end token that this defining construct specifies
3695 % so that it will exit this group.
3696 \def#1{\endgraf\endgroup\medbreak}%
3697 \def#2##1 ##2 {\def#4{##1}%
3698 \begingroup\obeylines\spacesplit{#3{##2}}}%
3699 \parindent=0in
3700 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3701 \exdentamount=\defbodyindent
3702 \begingroup\obeylines\spacesplit{#3{#5}}}
3704 % Split up #2 at the first space token.
3705 % call #1 with two arguments:
3706 % the first is all of #2 before the space token,
3707 % the second is all of #2 after that space token.
3708 % If #2 contains no space token, all of it is passed as the first arg
3709 % and the second is passed as empty.
3711 {\obeylines
3712 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3713 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3714 \ifx\relax #3%
3715 #1{#2}{}\else #1{#2}{#3#4}\fi}}
3717 % So much for the things common to all kinds of definitions.
3719 % Define @defun.
3721 % First, define the processing that is wanted for arguments of \defun
3722 % Use this to expand the args and terminate the paragraph they make up
3724 \def\defunargs #1{\functionparens \sl
3725 % Expand, preventing hyphenation at `-' chars.
3726 % Note that groups don't affect changes in \hyphenchar.
3727 \hyphenchar\tensl=0
3729 \hyphenchar\tensl=45
3730 \ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi%
3731 \interlinepenalty=10000
3732 \advance\rightskip by 0pt plus 1fil
3733 \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3736 \def\deftypefunargs #1{%
3737 % Expand, preventing hyphenation at `-' chars.
3738 % Note that groups don't affect changes in \hyphenchar.
3739 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
3740 \boldbraxnoamp
3741 \tclose{#1}% avoid \code because of side effects on active chars
3742 \interlinepenalty=10000
3743 \advance\rightskip by 0pt plus 1fil
3744 \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3747 % Do complete processing of one @defun or @defunx line already parsed.
3749 % @deffn Command forward-char nchars
3751 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
3753 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
3754 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
3755 \catcode 61=\other % Turn off change made in \defparsebody
3758 % @defun == @deffn Function
3760 \def\defun{\defparsebody\Edefun\defunx\defunheader}
3762 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3763 \begingroup\defname {#1}{Function}%
3764 \defunargs {#2}\endgroup %
3765 \catcode 61=\other % Turn off change made in \defparsebody
3768 % @deftypefun int foobar (int @var{foo}, float @var{bar})
3770 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
3772 % #1 is the data type. #2 is the name and args.
3773 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
3774 % #1 is the data type, #2 the name, #3 the args.
3775 \def\deftypefunheaderx #1#2 #3\relax{%
3776 \doind {fn}{\code{#2}}% Make entry in function index
3777 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Function}%
3778 \deftypefunargs {#3}\endgroup %
3779 \catcode 61=\other % Turn off change made in \defparsebody
3782 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
3784 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
3786 % \defheaderxcond#1\relax$$$
3787 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
3788 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
3790 % #1 is the classification. #2 is the data type. #3 is the name and args.
3791 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
3792 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
3793 \def\deftypefnheaderx #1#2#3 #4\relax{%
3794 \doind {fn}{\code{#3}}% Make entry in function index
3795 \begingroup
3796 \normalparens % notably, turn off `&' magic, which prevents
3797 % at least some C++ text from working
3798 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
3799 \deftypefunargs {#4}\endgroup %
3800 \catcode 61=\other % Turn off change made in \defparsebody
3803 % @defmac == @deffn Macro
3805 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
3807 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3808 \begingroup\defname {#1}{Macro}%
3809 \defunargs {#2}\endgroup %
3810 \catcode 61=\other % Turn off change made in \defparsebody
3813 % @defspec == @deffn Special Form
3815 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
3817 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3818 \begingroup\defname {#1}{Special Form}%
3819 \defunargs {#2}\endgroup %
3820 \catcode 61=\other % Turn off change made in \defparsebody
3823 % This definition is run if you use @defunx
3824 % anywhere other than immediately after a @defun or @defunx.
3826 \def\deffnx #1 {\errmessage{@deffnx in invalid context}}
3827 \def\defunx #1 {\errmessage{@defunx in invalid context}}
3828 \def\defmacx #1 {\errmessage{@defmacx in invalid context}}
3829 \def\defspecx #1 {\errmessage{@defspecx in invalid context}}
3830 \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
3831 \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
3833 % @defmethod, and so on
3835 % @defop {Funny Method} foo-class frobnicate argument
3837 \def\defop #1 {\def\defoptype{#1}%
3838 \defopparsebody\Edefop\defopx\defopheader\defoptype}
3840 \def\defopheader #1#2#3{%
3841 \dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
3842 \begingroup\defname {#2}{\defoptype{} on #1}%
3843 \defunargs {#3}\endgroup %
3846 % @defmethod == @defop Method
3848 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
3850 \def\defmethodheader #1#2#3{%
3851 \dosubind {fn}{\code{#2}}{on #1}% entry in function index
3852 \begingroup\defname {#2}{Method on #1}%
3853 \defunargs {#3}\endgroup %
3856 % @defcv {Class Option} foo-class foo-flag
3858 \def\defcv #1 {\def\defcvtype{#1}%
3859 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
3861 \def\defcvarheader #1#2#3{%
3862 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3863 \begingroup\defname {#2}{\defcvtype{} of #1}%
3864 \defvarargs {#3}\endgroup %
3867 % @defivar == @defcv {Instance Variable}
3869 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
3871 \def\defivarheader #1#2#3{%
3872 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3873 \begingroup\defname {#2}{Instance Variable of #1}%
3874 \defvarargs {#3}\endgroup %
3877 % These definitions are run if you use @defmethodx, etc.,
3878 % anywhere other than immediately after a @defmethod, etc.
3880 \def\defopx #1 {\errmessage{@defopx in invalid context}}
3881 \def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
3882 \def\defcvx #1 {\errmessage{@defcvx in invalid context}}
3883 \def\defivarx #1 {\errmessage{@defivarx in invalid context}}
3885 % Now @defvar
3887 % First, define the processing that is wanted for arguments of @defvar.
3888 % This is actually simple: just print them in roman.
3889 % This must expand the args and terminate the paragraph they make up
3890 \def\defvarargs #1{\normalparens #1%
3891 \interlinepenalty=10000
3892 \endgraf\penalty 10000\vskip -\parskip\penalty 10000}
3894 % @defvr Counter foo-count
3896 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
3898 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
3899 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
3901 % @defvar == @defvr Variable
3903 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
3905 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3906 \begingroup\defname {#1}{Variable}%
3907 \defvarargs {#2}\endgroup %
3910 % @defopt == @defvr {User Option}
3912 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
3914 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3915 \begingroup\defname {#1}{User Option}%
3916 \defvarargs {#2}\endgroup %
3919 % @deftypevar int foobar
3921 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
3923 % #1 is the data type. #2 is the name.
3924 \def\deftypevarheader #1#2{%
3925 \doind {vr}{\code{#2}}% Make entry in variables index
3926 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Variable}%
3927 \interlinepenalty=10000
3928 \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3929 \endgroup}
3931 % @deftypevr {Global Flag} int enable
3933 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
3935 \def\deftypevrheader #1#2#3{\doind {vr}{\code{#3}}%
3936 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
3937 \interlinepenalty=10000
3938 \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3939 \endgroup}
3941 % This definition is run if you use @defvarx
3942 % anywhere other than immediately after a @defvar or @defvarx.
3944 \def\defvrx #1 {\errmessage{@defvrx in invalid context}}
3945 \def\defvarx #1 {\errmessage{@defvarx in invalid context}}
3946 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
3947 \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
3948 \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
3950 % Now define @deftp
3951 % Args are printed in bold, a slight difference from @defvar.
3953 \def\deftpargs #1{\bf \defvarargs{#1}}
3955 % @deftp Class window height width ...
3957 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
3959 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
3960 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
3962 % This definition is run if you use @deftpx, etc
3963 % anywhere other than immediately after a @deftp, etc.
3965 \def\deftpx #1 {\errmessage{@deftpx in invalid context}}
3967 \message{cross reference,}
3968 % Define cross-reference macros
3969 \newwrite \auxfile
3971 \newif\ifhavexrefs % True if xref values are known.
3972 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
3974 % \setref{foo} defines a cross-reference point named foo.
3976 \def\setref#1{%
3977 \dosetq{#1-title}{Ytitle}%
3978 \dosetq{#1-pg}{Ypagenumber}%
3979 \dosetq{#1-snt}{Ysectionnumberandtype}}
3981 \def\unnumbsetref#1{%
3982 \dosetq{#1-title}{Ytitle}%
3983 \dosetq{#1-pg}{Ypagenumber}%
3984 \dosetq{#1-snt}{Ynothing}}
3986 \def\appendixsetref#1{%
3987 \dosetq{#1-title}{Ytitle}%
3988 \dosetq{#1-pg}{Ypagenumber}%
3989 \dosetq{#1-snt}{Yappendixletterandtype}}
3991 % \xref, \pxref, and \ref generate cross-references to specified points.
3992 % For \xrefX, #1 is the node name, #2 the name of the Info
3993 % cross-reference, #3 the printed node name, #4 the name of the Info
3994 % file, #5 the name of the printed manual. All but the node name can be
3995 % omitted.
3997 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
3998 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
3999 \def\ref#1{\xrefX[#1,,,,,,,]}
4000 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
4001 \def\printedmanual{\ignorespaces #5}%
4002 \def\printednodename{\ignorespaces #3}%
4003 \setbox1=\hbox{\printedmanual}%
4004 \setbox0=\hbox{\printednodename}%
4005 \ifdim \wd0 = 0pt
4006 % No printed node name was explicitly given.
4007 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
4008 % Use the node name inside the square brackets.
4009 \def\printednodename{\ignorespaces #1}%
4010 \else
4011 % Use the actual chapter/section title appear inside
4012 % the square brackets. Use the real section title if we have it.
4013 \ifdim \wd1>0pt%
4014 % It is in another manual, so we don't have it.
4015 \def\printednodename{\ignorespaces #1}%
4016 \else
4017 \ifhavexrefs
4018 % We know the real title if we have the xref values.
4019 \def\printednodename{\refx{#1-title}{}}%
4020 \else
4021 % Otherwise just copy the Info node name.
4022 \def\printednodename{\ignorespaces #1}%
4023 \fi%
4028 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
4029 % insert empty discretionaries after hyphens, which means that it will
4030 % not find a line break at a hyphen in a node names. Since some manuals
4031 % are best written with fairly long node names, containing hyphens, this
4032 % is a loss. Therefore, we give the text of the node name again, so it
4033 % is as if TeX is seeing it for the first time.
4034 \ifdim \wd1 > 0pt
4035 \putwordsection{} ``\printednodename'' in \cite{\printedmanual}%
4036 \else
4037 % _ (for example) has to be the character _ for the purposes of the
4038 % control sequence corresponding to the node, but it has to expand
4039 % into the usual \leavevmode...\vrule stuff for purposes of
4040 % printing. So we \turnoffactive for the \refx-snt, back on for the
4041 % printing, back off for the \refx-pg.
4042 {\turnoffactive \refx{#1-snt}{}}%
4043 \space [\printednodename],\space
4044 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
4046 \endgroup}
4048 % \dosetq is the interface for calls from other macros
4050 % Use \turnoffactive so that punctuation chars such as underscore
4051 % work in node names.
4052 \def\dosetq #1#2{{\let\folio=0 \turnoffactive \auxhat%
4053 \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
4054 \next}}
4056 % \internalsetq {foo}{page} expands into
4057 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
4058 % When the aux file is read, ' is the escape character
4060 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
4062 % Things to be expanded by \internalsetq
4064 \def\Ypagenumber{\folio}
4066 \def\Ytitle{\thissection}
4068 \def\Ynothing{}
4070 \def\Ysectionnumberandtype{%
4071 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
4072 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
4073 \else \ifnum \subsubsecno=0 %
4074 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
4075 \else %
4076 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
4077 \fi \fi \fi }
4079 \def\Yappendixletterandtype{%
4080 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
4081 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
4082 \else \ifnum \subsubsecno=0 %
4083 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
4084 \else %
4085 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
4086 \fi \fi \fi }
4088 \gdef\xreftie{'tie}
4090 % Use TeX 3.0's \inputlineno to get the line number, for better error
4091 % messages, but if we're using an old version of TeX, don't do anything.
4093 \ifx\inputlineno\thisisundefined
4094 \let\linenumber = \empty % Non-3.0.
4095 \else
4096 \def\linenumber{\the\inputlineno:\space}
4099 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
4100 % If its value is nonempty, SUFFIX is output afterward.
4102 \def\refx#1#2{%
4103 \expandafter\ifx\csname X#1\endcsname\relax
4104 % If not defined, say something at least.
4105 $\langle$un\-de\-fined$\rangle$%
4106 \ifhavexrefs
4107 \message{\linenumber Undefined cross reference `#1'.}%
4108 \else
4109 \ifwarnedxrefs\else
4110 \global\warnedxrefstrue
4111 \message{Cross reference values unknown; you must run TeX again.}%
4114 \else
4115 % It's defined, so just use it.
4116 \csname X#1\endcsname
4118 #2% Output the suffix in any case.
4121 % Read the last existing aux file, if any. No error if none exists.
4123 % This is the macro invoked by entries in the aux file.
4124 \def\xrdef #1#2{
4125 {\catcode`\'=\other\expandafter \gdef \csname X#1\endcsname {#2}}}
4127 \def\readauxfile{%
4128 \begingroup
4129 \catcode `\^^@=\other
4130 \catcode `\\x01=\other
4131 \catcode `\\x02=\other
4132 \catcode `\^^C=\other
4133 \catcode `\^^D=\other
4134 \catcode `\^^E=\other
4135 \catcode `\^^F=\other
4136 \catcode `\^^G=\other
4137 \catcode `\^^H=\other
4138 \catcode `\\v=\other
4139 \catcode `\^^L=\other
4140 \catcode `\\x0e=\other
4141 \catcode `\\x0f=\other
4142 \catcode `\\x10=\other
4143 \catcode `\\x11=\other
4144 \catcode `\\x12=\other
4145 \catcode `\\x13=\other
4146 \catcode `\\x14=\other
4147 \catcode `\\x15=\other
4148 \catcode `\\x16=\other
4149 \catcode `\\x17=\other
4150 \catcode `\\x18=\other
4151 \catcode `\\x19=\other
4152 \catcode 26=\other
4153 \catcode `\^^[=\other
4154 \catcode `\^^\=\other
4155 \catcode `\^^]=\other
4156 \catcode `\^^^=\other
4157 \catcode `\^^_=\other
4158 \catcode `\@=\other
4159 \catcode `\^=\other
4160 \catcode `\~=\other
4161 \catcode `\[=\other
4162 \catcode `\]=\other
4163 \catcode`\"=\other
4164 \catcode`\_=\other
4165 \catcode`\|=\other
4166 \catcode`\<=\other
4167 \catcode`\>=\other
4168 \catcode `\$=\other
4169 \catcode `\#=\other
4170 \catcode `\&=\other
4171 % `\+ does not work, so use 43.
4172 \catcode 43=\other
4173 % Make the characters 128-255 be printing characters
4175 \count 1=128
4176 \def\loop{%
4177 \catcode\count 1=\other
4178 \advance\count 1 by 1
4179 \ifnum \count 1<256 \loop \fi
4182 % the aux file uses ' as the escape.
4183 % Turn off \ as an escape so we do not lose on
4184 % entries which were dumped with control sequences in their names.
4185 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
4186 % Reference to such entries still does not work the way one would wish,
4187 % but at least they do not bomb out when the aux file is read in.
4188 \catcode `\{=1 \catcode `\}=2
4189 \catcode `\%=\other
4190 \catcode `\'=0
4191 \catcode`\^=7 % to make ^^e4 etc usable in xref tags
4192 \catcode `\\=\other
4193 \openin 1 \jobname.aux
4194 \ifeof 1 \else \closein 1 \input \jobname.aux \global\havexrefstrue
4195 \global\warnedobstrue
4197 % Open the new aux file. Tex will close it automatically at exit.
4198 \openout \auxfile=\jobname.aux
4199 \endgroup}
4202 % Footnotes.
4204 \newcount \footnoteno
4206 % The trailing space in the following definition for supereject is
4207 % vital for proper filling; pages come out unaligned when you do a
4208 % pagealignmacro call if that space before the closing brace is
4209 % removed. (Generally, numeric constants should always be followed by a
4210 % space to prevent strange expansion errors.)
4211 \def\supereject{\par\penalty -20000\footnoteno =0 }
4213 % @footnotestyle is meaningful for info output only..
4214 \let\footnotestyle=\comment
4216 \let\ptexfootnote=\footnote
4218 {\catcode `\@=11
4220 % Auto-number footnotes. Otherwise like plain.
4221 \gdef\footnote{%
4222 \global\advance\footnoteno by \@ne
4223 \edef\thisfootno{$^{\the\footnoteno}$}%
4225 % In case the footnote comes at the end of a sentence, preserve the
4226 % extra spacing after we do the footnote number.
4227 \let\@sf\empty
4228 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
4230 % Remove inadvertent blank space before typesetting the footnote number.
4231 \unskip
4232 \thisfootno\@sf
4233 \footnotezzz
4236 % Don't bother with the trickery in plain.tex to not require the
4237 % footnote text as a parameter. Our footnotes don't need to be so general.
4239 \long\gdef\footnotezzz#1{\insert\footins{%
4240 % We want to typeset this text as a normal paragraph, even if the
4241 % footnote reference occurs in (for example) a display environment.
4242 % So reset some parameters.
4243 \interlinepenalty\interfootnotelinepenalty
4244 \splittopskip\ht\strutbox % top baseline for broken footnotes
4245 \splitmaxdepth\dp\strutbox
4246 \floatingpenalty\@MM
4247 \leftskip\z@skip
4248 \rightskip\z@skip
4249 \spaceskip\z@skip
4250 \xspaceskip\z@skip
4251 \parindent\defaultparindent
4253 % Hang the footnote text off the number.
4254 \hang
4255 \textindent{\thisfootno}%
4257 % Don't crash into the line above the footnote text. Since this
4258 % expands into a box, it must come within the paragraph, lest it
4259 % provide a place where TeX can split the footnote.
4260 \footstrut
4261 #1\strut}%
4264 }%end \catcode `\@=11
4266 % Set the baselineskip to #1, and the lineskip and strut size
4267 % correspondingly. There is no deep meaning behind these magic numbers
4268 % used as factors; they just match (closely enough) what Knuth defined.
4270 \def\lineskipfactor{.08333}
4271 \def\strutheightpercent{.70833}
4272 \def\strutdepthpercent {.29167}
4274 \def\setleading#1{%
4275 \normalbaselineskip = #1\relax
4276 \normallineskip = \lineskipfactor\normalbaselineskip
4277 \normalbaselines
4278 \setbox\strutbox =\hbox{%
4279 \vrule width0pt height\strutheightpercent\baselineskip
4280 depth \strutdepthpercent \baselineskip
4284 % @| inserts a changebar to the left of the current line. It should
4285 % surround any changed text. This approach does *not* work if the
4286 % change spans more than two lines of output. To handle that, we would
4287 % have adopt a much more difficult approach (putting marks into the main
4288 % vertical list for the beginning and end of each change).
4290 \def\|{%
4291 % \vadjust can only be used in horizontal mode.
4292 \leavevmode
4294 % Append this vertical mode material after the current line in the output.
4295 \vadjust{%
4296 % We want to insert a rule with the height and depth of the current
4297 % leading; that is exactly what \strutbox is supposed to record.
4298 \vskip-\baselineskip
4300 % \vadjust-items are inserted at the left edge of the type. So
4301 % the \llap here moves out into the left-hand margin.
4302 \llap{%
4304 % For a thicker or thinner bar, change the `1pt'.
4305 \vrule height\baselineskip width1pt
4307 % This is the space between the bar and the text.
4308 \hskip 12pt
4313 % For a final copy, take out the rectangles
4314 % that mark overfull boxes (in case you have decided
4315 % that the text looks ok even though it passes the margin).
4317 \def\finalout{\overfullrule=0pt}
4320 % End of control word definitions.
4322 \message{and turning on texinfo input format.}
4324 \def\openindices{%
4325 \newindex{cp}%
4326 \newcodeindex{fn}%
4327 \newcodeindex{vr}%
4328 \newcodeindex{tp}%
4329 \newcodeindex{ky}%
4330 \newcodeindex{pg}%
4333 % Set some numeric style parameters, for 8.5 x 11 format.
4335 %\hsize = 6.5in
4336 \newdimen\defaultparindent \defaultparindent = 15pt
4337 \parindent = \defaultparindent
4338 \parskip 18pt plus 1pt
4339 \setleading{15pt}
4340 \advance\topskip by 1.2cm
4342 % Prevent underfull vbox error messages.
4343 \vbadness=10000
4345 % Following George Bush, just get rid of widows and orphans.
4346 \widowpenalty=10000
4347 \clubpenalty=10000
4349 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
4350 % using an old version of TeX, don't do anything. We want the amount of
4351 % stretch added to depend on the line length, hence the dependence on
4352 % \hsize. This makes it come to about 9pt for the 8.5x11 format.
4354 \ifx\emergencystretch\thisisundefined
4355 % Allow us to assign to \emergencystretch anyway.
4356 \def\emergencystretch{\dimen0}%
4357 \else
4358 \emergencystretch = \hsize
4359 \divide\emergencystretch by 45
4362 % Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
4363 \def\smallbook{
4365 % These values for secheadingskip and subsecheadingskip are
4366 % experiments. RJC 7 Aug 1992
4367 \global\secheadingskip = 17pt plus 6pt minus 3pt
4368 \global\subsecheadingskip = 14pt plus 6pt minus 3pt
4370 \global\lispnarrowing = 0.3in
4371 \setleading{12pt}
4372 \advance\topskip by -1cm
4373 \global\parskip 3pt plus 1pt
4374 \global\hsize = 5in
4375 \global\vsize=7.5in
4376 \global\tolerance=700
4377 \global\hfuzz=1pt
4378 \global\contentsrightmargin=0pt
4379 \global\deftypemargin=0pt
4380 \global\defbodyindent=.5cm
4382 \global\pagewidth=\hsize
4383 \global\pageheight=\vsize
4385 \global\let\smalllisp=\smalllispx
4386 \global\let\smallexample=\smalllispx
4387 \global\def\Esmallexample{\Esmalllisp}
4390 % Use @afourpaper to print on European A4 paper.
4391 \def\afourpaper{
4392 \global\tolerance=700
4393 \global\hfuzz=1pt
4394 \setleading{12pt}
4395 \global\parskip 15pt plus 1pt
4397 \global\vsize= 53\baselineskip
4398 \advance\vsize by \topskip
4399 %\global\hsize= 5.85in % A4 wide 10pt
4400 \global\hsize= 6.5in
4401 \global\outerhsize=\hsize
4402 \global\advance\outerhsize by 0.5in
4403 \global\outervsize=\vsize
4404 \global\advance\outervsize by 0.6in
4406 \global\pagewidth=\hsize
4407 \global\pageheight=\vsize
4410 % Allow control of the text dimensions. Parameters in order: textheight;
4411 % textwidth; voffset; hoffset; binding offset; topskip.
4412 % All require a dimension;
4413 % header is additional; added length extends the bottom of the page.
4415 \def\changepagesizes#1#2#3#4#5#6{
4416 \global\vsize= #1
4417 \global\topskip= #6
4418 \advance\vsize by \topskip
4419 \global\voffset= #3
4420 \global\hsize= #2
4421 \global\outerhsize=\hsize
4422 \global\advance\outerhsize by 0.5in
4423 \global\outervsize=\vsize
4424 \global\advance\outervsize by 0.6in
4425 \global\pagewidth=\hsize
4426 \global\pageheight=\vsize
4427 \global\normaloffset= #4
4428 \global\bindingoffset= #5}
4430 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
4431 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
4432 \def\afourlatex
4433 {\global\tolerance=700
4434 \global\hfuzz=1pt
4435 \setleading{12pt}
4436 \global\parskip 15pt plus 1pt
4437 \advance\baselineskip by 1.6pt
4438 \changepagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}
4441 % Use @afourwide to print on European A4 paper in wide format.
4442 \def\afourwide{\afourpaper
4443 \changepagesizes{9.5in}{6.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}}
4445 % Define macros to output various characters with catcode for normal text.
4446 \catcode`\"=\other
4447 \catcode`\~=\other
4448 \catcode`\^=\other
4449 \catcode`\_=\other
4450 \catcode`\|=\other
4451 \catcode`\<=\other
4452 \catcode`\>=\other
4453 \catcode`\+=\other
4454 \def\normaldoublequote{"}
4455 \def\normaltilde{~}
4456 \def\normalcaret{^}
4457 \def\normalunderscore{_}
4458 \def\normalverticalbar{|}
4459 \def\normalless{<}
4460 \def\normalgreater{>}
4461 \def\normalplus{+}
4463 % This macro is used to make a character print one way in ttfont
4464 % where it can probably just be output, and another way in other fonts,
4465 % where something hairier probably needs to be done.
4467 % #1 is what to print if we are indeed using \tt; #2 is what to print
4468 % otherwise. Since all the Computer Modern typewriter fonts have zero
4469 % interword stretch (and shrink), and it is reasonable to expect all
4470 % typewriter fonts to have this, we can check that font parameter.
4472 \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
4474 % Turn off all special characters except @
4475 % (and those which the user can use as if they were ordinary).
4476 % Most of these we simply print from the \tt font, but for some, we can
4477 % use math or other variants that look better in normal text.
4479 \catcode`\"=\active
4480 \def\activedoublequote{{\tt \char '042}}
4481 \let"=\activedoublequote
4482 \catcode`\~=\active
4483 \def~{{\tt \char '176}}
4484 \chardef\hat=`\^
4485 \catcode`\^=\active
4486 \def\auxhat{\def^{'hat}}
4487 \def^{{\tt \hat}}
4489 \catcode`\_=\active
4490 \def_{\ifusingtt\normalunderscore\_}
4491 % Subroutine for the previous macro.
4492 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
4494 \catcode`\|=\active
4495 \def|{{\tt \char '174}}
4496 \chardef \less=`\<
4497 \catcode`\<=\active
4498 \def<{{\tt \less}}
4499 \chardef \gtr=`\>
4500 \catcode`\>=\active
4501 \def>{{\tt \gtr}}
4502 \catcode`\+=\active
4503 \def+{{\tt \char 43}}
4504 %\catcode 27=\active
4505 %\def^^[{$\diamondsuit$}
4507 % Set up an active definition for =, but don't enable it most of the time.
4508 {\catcode`\==\active
4509 \global\def={{\tt \char 61}}}
4511 \catcode`+=\active
4512 \catcode`\_=\active
4514 % If a .fmt file is being used, characters that might appear in a file
4515 % name cannot be active until we have parsed the command line.
4516 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
4517 % \otherifyactive is called near the end of this file.
4518 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
4520 \catcode`\@=0
4522 % \rawbackslashxx output one backslash character in current font
4523 \global\chardef\rawbackslashxx=`\\
4524 %{\catcode`\\=\other
4525 %@gdef@rawbackslashxx{\}}
4527 % \rawbackslash redefines \ as input to do \rawbackslashxx.
4528 {\catcode`\\=\active
4529 @gdef@rawbackslash{@let\=@rawbackslashxx }}
4531 % \normalbackslash outputs one backslash in fixed width font.
4532 \def\normalbackslash{{\tt\rawbackslashxx}}
4534 % Say @foo, not \foo, in error messages.
4535 \escapechar=`\@
4537 % \catcode 17=0 % Define control-q
4538 \catcode`\\=\active
4540 % Used sometimes to turn off (effectively) the active characters
4541 % even after parsing them.
4542 @def@turnoffactive{@let"=@normaldoublequote
4543 @let\=@realbackslash
4544 @let~=@normaltilde
4545 @let^=@normalcaret
4546 @let_=@normalunderscore
4547 @let|=@normalverticalbar
4548 @let<=@normalless
4549 @let>=@normalgreater
4550 @let+=@normalplus}
4552 @def@normalturnoffactive{@let"=@normaldoublequote
4553 @let\=@normalbackslash
4554 @let~=@normaltilde
4555 @let^=@normalcaret
4556 @let_=@normalunderscore
4557 @let|=@normalverticalbar
4558 @let<=@normalless
4559 @let>=@normalgreater
4560 @let+=@normalplus}
4562 % Make _ and + \other characters, temporarily.
4563 % This is canceled by @fixbackslash.
4564 @otherifyactive
4566 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4567 % That is what \eatinput is for; after that, the `\' should revert to printing
4568 % a backslash.
4570 @gdef@eatinput input texinfo{@fixbackslash}
4571 @global@let\ = @eatinput
4573 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
4574 % the first `\{ in the file would cause an error. This macro tries to fix
4575 % that, assuming it is called before the first `\' could plausibly occur.
4576 % Also back turn on active characters that might appear in the input
4577 % file name, in case not using a pre-dumped format.
4579 @gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi
4580 @catcode`+=@active @catcode`@_=@active}
4582 %% These look ok in all fonts, so just make them not special. The @rm below
4583 %% makes sure that the current font starts out as the newly loaded cmr10
4584 @catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
4586 @textfonts
4589 @c Local variables:
4590 @c page-delimiter: "^\\\\message"
4591 @c End: