* assuan.h (assuan_error_t, assuan_context_t): New aliases.
[pinentry.git] / doc / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2004-10-31.06}
7 %
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
10 % Foundation, Inc.
11 %
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
16 %
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 % General Public License for more details.
21 %
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING.  If not, write
24 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 % Boston, MA 02111-1307, USA.
26 %
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction.  (This has been our intent since Texinfo was invented.)
30 %
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 %   ftp://tug.org/tex/texinfo.tex
35 %     (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
38 %
39 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem.  Patches are, of course, greatly appreciated.
42 %
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution.  For a simple
45 % manual foo.texi, however, you can get away with this:
46 %   tex foo.texi
47 %   texindex foo.??
48 %   tex foo.texi
49 %   tex foo.texi
50 %   dvips foo.dvi -o  # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
54 %
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent.  You can get the existing language-specific files from the
57 % full Texinfo distribution.
58 %
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60
61
62 \message{Loading texinfo [version \texinfoversion]:}
63
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68   \catcode`+=\active \catcode`\_=\active}
69
70 \message{Basics,}
71 \chardef\other=12
72
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
76
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexnoindent=\noindent
93 \let\ptexinsert=\insert
94 \let\ptexlbrace=\{
95 \let\ptexless=<
96 \let\ptexplus=+
97 \let\ptexrbrace=\}
98 \let\ptexslash=\/
99 \let\ptexstar=\*
100 \let\ptext=\t
101
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
104 \newlinechar = `^^J
105
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
108 %
109 \ifx\inputlineno\thisisundefined
110   \let\linenumber = \empty % Pre-3.0.
111 \else
112   \def\linenumber{l.\the\inputlineno:\space}
113 \fi
114
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined     \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
135 %
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
148 %
149 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
154
155 % In some macros, we cannot use the `\? notation---the left quote is
156 % in some cases the escape char.
157 \chardef\colonChar = `\:
158 \chardef\commaChar = `\,
159 \chardef\dotChar   = `\.
160 \chardef\exclamChar= `\!
161 \chardef\questChar = `\?
162 \chardef\semiChar  = `\;
163 \chardef\underChar = `\_
164
165 \chardef\spaceChar = `\ %
166 \chardef\spacecat = 10
167 \def\spaceisspace{\catcode\spaceChar=\spacecat}
168
169 % Ignore a token.
170 %
171 \def\gobble#1{}
172
173 % The following is used inside several \edef's.
174 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
175
176 % Hyphenation fixes.
177 \hyphenation{
178   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
179   ap-pen-dix bit-map bit-maps
180   data-base data-bases eshell fall-ing half-way long-est man-u-script
181   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
182   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
183   spell-ing spell-ings
184   stand-alone strong-est time-stamp time-stamps which-ever white-space
185   wide-spread wrap-around
186 }
187
188 % Margin to add to right of even pages, to left of odd pages.
189 \newdimen\bindingoffset
190 \newdimen\normaloffset
191 \newdimen\pagewidth \newdimen\pageheight
192
193 % For a final copy, take out the rectangles
194 % that mark overfull boxes (in case you have decided
195 % that the text looks ok even though it passes the margin).
196 %
197 \def\finalout{\overfullrule=0pt}
198
199 % @| inserts a changebar to the left of the current line.  It should
200 % surround any changed text.  This approach does *not* work if the
201 % change spans more than two lines of output.  To handle that, we would
202 % have adopt a much more difficult approach (putting marks into the main
203 % vertical list for the beginning and end of each change).
204 %
205 \def\|{%
206   % \vadjust can only be used in horizontal mode.
207   \leavevmode
208   %
209   % Append this vertical mode material after the current line in the output.
210   \vadjust{%
211     % We want to insert a rule with the height and depth of the current
212     % leading; that is exactly what \strutbox is supposed to record.
213     \vskip-\baselineskip
214     %
215     % \vadjust-items are inserted at the left edge of the type.  So
216     % the \llap here moves out into the left-hand margin.
217     \llap{%
218       %
219       % For a thicker or thinner bar, change the `1pt'.
220       \vrule height\baselineskip width1pt
221       %
222       % This is the space between the bar and the text.
223       \hskip 12pt
224     }%
225   }%
226 }
227
228 % Sometimes it is convenient to have everything in the transcript file
229 % and nothing on the terminal.  We don't just call \tracingall here,
230 % since that produces some useless output on the terminal.  We also make
231 % some effort to order the tracing commands to reduce output in the log
232 % file; cf. trace.sty in LaTeX.
233 %
234 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
235 \def\loggingall{%
236   \tracingstats2
237   \tracingpages1
238   \tracinglostchars2  % 2 gives us more in etex
239   \tracingparagraphs1
240   \tracingoutput1
241   \tracingmacros2
242   \tracingrestores1
243   \showboxbreadth\maxdimen \showboxdepth\maxdimen
244   \ifx\eTeXversion\undefined\else % etex gives us more logging
245     \tracingscantokens1
246     \tracingifs1
247     \tracinggroups1
248     \tracingnesting2
249     \tracingassigns1
250   \fi
251   \tracingcommands3  % 3 gives us more in etex
252   \errorcontextlines16
253 }%
254
255 % add check for \lastpenalty to plain's definitions.  If the last thing
256 % we did was a \nobreak, we don't want to insert more space.
257 %
258 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
259   \removelastskip\penalty-50\smallskip\fi\fi}
260 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
261   \removelastskip\penalty-100\medskip\fi\fi}
262 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
263   \removelastskip\penalty-200\bigskip\fi\fi}
264
265 % For @cropmarks command.
266 % Do @cropmarks to get crop marks.
267 %
268 \newif\ifcropmarks
269 \let\cropmarks = \cropmarkstrue
270 %
271 % Dimensions to add cropmarks at corners.
272 % Added by P. A. MacKay, 12 Nov. 1986
273 %
274 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
275 \newdimen\cornerlong  \cornerlong=1pc
276 \newdimen\cornerthick \cornerthick=.3pt
277 \newdimen\topandbottommargin \topandbottommargin=.75in
278
279 % Main output routine.
280 \chardef\PAGE = 255
281 \output = {\onepageout{\pagecontents\PAGE}}
282
283 \newbox\headlinebox
284 \newbox\footlinebox
285
286 % \onepageout takes a vbox as an argument.  Note that \pagecontents
287 % does insertions, but you have to call it yourself.
288 \def\onepageout#1{%
289   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
290   %
291   \ifodd\pageno  \advance\hoffset by \bindingoffset
292   \else \advance\hoffset by -\bindingoffset\fi
293   %
294   % Do this outside of the \shipout so @code etc. will be expanded in
295   % the headline as they should be, not taken literally (outputting ''code).
296   \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
297   \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
298   %
299   {%
300     % Have to do this stuff outside the \shipout because we want it to
301     % take effect in \write's, yet the group defined by the \vbox ends
302     % before the \shipout runs.
303     %
304     \escapechar = `\\     % use backslash in output files.
305     \indexdummies         % don't expand commands in the output.
306     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
307                    % the page break happens to be in the middle of an example.
308     \shipout\vbox{%
309       % Do this early so pdf references go to the beginning of the page.
310       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
311       %
312       \ifcropmarks \vbox to \outervsize\bgroup
313         \hsize = \outerhsize
314         \vskip-\topandbottommargin
315         \vtop to0pt{%
316           \line{\ewtop\hfil\ewtop}%
317           \nointerlineskip
318           \line{%
319             \vbox{\moveleft\cornerthick\nstop}%
320             \hfill
321             \vbox{\moveright\cornerthick\nstop}%
322           }%
323           \vss}%
324         \vskip\topandbottommargin
325         \line\bgroup
326           \hfil % center the page within the outer (page) hsize.
327           \ifodd\pageno\hskip\bindingoffset\fi
328           \vbox\bgroup
329       \fi
330       %
331       \unvbox\headlinebox
332       \pagebody{#1}%
333       \ifdim\ht\footlinebox > 0pt
334         % Only leave this space if the footline is nonempty.
335         % (We lessened \vsize for it in \oddfootingxxx.)
336         % The \baselineskip=24pt in plain's \makefootline has no effect.
337         \vskip 2\baselineskip
338         \unvbox\footlinebox
339       \fi
340       %
341       \ifcropmarks
342           \egroup % end of \vbox\bgroup
343         \hfil\egroup % end of (centering) \line\bgroup
344         \vskip\topandbottommargin plus1fill minus1fill
345         \boxmaxdepth = \cornerthick
346         \vbox to0pt{\vss
347           \line{%
348             \vbox{\moveleft\cornerthick\nsbot}%
349             \hfill
350             \vbox{\moveright\cornerthick\nsbot}%
351           }%
352           \nointerlineskip
353           \line{\ewbot\hfil\ewbot}%
354         }%
355       \egroup % \vbox from first cropmarks clause
356       \fi
357     }% end of \shipout\vbox
358   }% end of group with \normalturnoffactive
359   \advancepageno
360   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
361 }
362
363 \newinsert\margin \dimen\margin=\maxdimen
364
365 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
366 {\catcode`\@ =11
367 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
368 % marginal hacks, juha@viisa.uucp (Juha Takala)
369 \ifvoid\margin\else % marginal info is present
370   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
371 \dimen@=\dp#1 \unvbox#1
372 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
373 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
374 }
375
376 % Here are the rules for the cropmarks.  Note that they are
377 % offset so that the space between them is truly \outerhsize or \outervsize
378 % (P. A. MacKay, 12 November, 1986)
379 %
380 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
381 \def\nstop{\vbox
382   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
383 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
384 \def\nsbot{\vbox
385   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
386
387 % Parse an argument, then pass it to #1.  The argument is the rest of
388 % the input line (except we remove a trailing comment).  #1 should be a
389 % macro which expects an ordinary undelimited TeX argument.
390 %
391 \def\parsearg{\parseargusing{}}
392 \def\parseargusing#1#2{%
393   \def\next{#2}%
394   \begingroup
395     \obeylines
396     \spaceisspace
397     #1%
398     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
399 }
400
401 {\obeylines %
402   \gdef\parseargline#1^^M{%
403     \endgroup % End of the group started in \parsearg.
404     \argremovecomment #1\comment\ArgTerm%
405   }%
406 }
407
408 % First remove any @comment, then any @c comment.
409 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
410 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
411
412 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
413 %
414 % \argremovec might leave us with trailing space, e.g.,
415 %    @end itemize  @c foo
416 % This space token undergoes the same procedure and is eventually removed
417 % by \finishparsearg.
418 %
419 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
420 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
421 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
422   \def\temp{#3}%
423   \ifx\temp\empty
424     % We cannot use \next here, as it holds the macro to run;
425     % thus we reuse \temp.
426     \let\temp\finishparsearg
427   \else
428     \let\temp\argcheckspaces
429   \fi
430   % Put the space token in:
431   \temp#1 #3\ArgTerm
432 }
433
434 % If a _delimited_ argument is enclosed in braces, they get stripped; so
435 % to get _exactly_ the rest of the line, we had to prevent such situation.
436 % We prepended an \empty token at the very beginning and we expand it now,
437 % just before passing the control to \next.
438 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
439 % either the null string, or it ends with \^^M---thus there is no danger
440 % that a pair of braces would be stripped.
441 %
442 % But first, we have to remove the trailing space token.
443 %
444 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
445
446 % \parseargdef\foo{...}
447 %       is roughly equivalent to
448 % \def\foo{\parsearg\Xfoo}
449 % \def\Xfoo#1{...}
450 %
451 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
452 % favourite TeX trick.  --kasal, 16nov03
453
454 \def\parseargdef#1{%
455   \expandafter \doparseargdef \csname\string#1\endcsname #1%
456 }
457 \def\doparseargdef#1#2{%
458   \def#2{\parsearg#1}%
459   \def#1##1%
460 }
461
462 % Several utility definitions with active space:
463 {
464   \obeyspaces
465   \gdef\obeyedspace{ }
466
467   % Make each space character in the input produce a normal interword
468   % space in the output.  Don't allow a line break at this space, as this
469   % is used only in environments like @example, where each line of input
470   % should produce a line of output anyway.
471   %
472   \gdef\sepspaces{\obeyspaces\let =\tie}
473
474   % If an index command is used in an @example environment, any spaces
475   % therein should become regular spaces in the raw index file, not the
476   % expansion of \tie (\leavevmode \penalty \@M \ ).
477   \gdef\unsepspaces{\let =\space}
478 }
479
480
481 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
482
483 % Define the framework for environments in texinfo.tex.  It's used like this:
484 %
485 %   \envdef\foo{...}
486 %   \def\Efoo{...}
487 %
488 % It's the responsibility of \envdef to insert \begingroup before the
489 % actual body; @end closes the group after calling \Efoo.  \envdef also
490 % defines \thisenv, so the current environment is known; @end checks
491 % whether the environment name matches.  The \checkenv macro can also be
492 % used to check whether the current environment is the one expected.
493 %
494 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
495 % are not treated as enviroments; they don't open a group.  (The
496 % implementation of @end takes care not to call \endgroup in this
497 % special case.)
498
499
500 % At runtime, environments start with this:
501 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
502 % initialize
503 \let\thisenv\empty
504
505 % ... but they get defined via ``\envdef\foo{...}'':
506 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
507 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
508
509 % Check whether we're in the right environment:
510 \def\checkenv#1{%
511   \def\temp{#1}%
512   \ifx\thisenv\temp
513   \else
514     \badenverr
515   \fi
516 }
517
518 % Evironment mismatch, #1 expected:
519 \def\badenverr{%
520   \errhelp = \EMsimple
521   \errmessage{This command can appear only \inenvironment\temp,
522     not \inenvironment\thisenv}%
523 }
524 \def\inenvironment#1{%
525   \ifx#1\empty
526     out of any environment%
527   \else
528     in environment \expandafter\string#1%
529   \fi
530 }
531
532 % @end foo executes the definition of \Efoo.
533 % But first, it executes a specialized version of \checkenv
534 %
535 \parseargdef\end{%
536   \if 1\csname iscond.#1\endcsname
537   \else
538     % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
539     \expandafter\checkenv\csname#1\endcsname
540     \csname E#1\endcsname
541     \endgroup
542   \fi
543 }
544
545 \newhelp\EMsimple{Press RETURN to continue.}
546
547
548 %% Simple single-character @ commands
549
550 % @@ prints an @
551 % Kludge this until the fonts are right (grr).
552 \def\@{{\tt\char64}}
553
554 % This is turned off because it was never documented
555 % and you can use @w{...} around a quote to suppress ligatures.
556 %% Define @` and @' to be the same as ` and '
557 %% but suppressing ligatures.
558 %\def\`{{`}}
559 %\def\'{{'}}
560
561 % Used to generate quoted braces.
562 \def\mylbrace {{\tt\char123}}
563 \def\myrbrace {{\tt\char125}}
564 \let\{=\mylbrace
565 \let\}=\myrbrace
566 \begingroup
567   % Definitions to produce \{ and \} commands for indices,
568   % and @{ and @} for the aux file.
569   \catcode`\{ = \other \catcode`\} = \other
570   \catcode`\[ = 1 \catcode`\] = 2
571   \catcode`\! = 0 \catcode`\\ = \other
572   !gdef!lbracecmd[\{]%
573   !gdef!rbracecmd[\}]%
574   !gdef!lbraceatcmd[@{]%
575   !gdef!rbraceatcmd[@}]%
576 !endgroup
577
578 % @comma{} to avoid , parsing problems.
579 \let\comma = ,
580
581 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
582 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
583 \let\, = \c
584 \let\dotaccent = \.
585 \def\ringaccent#1{{\accent23 #1}}
586 \let\tieaccent = \t
587 \let\ubaraccent = \b
588 \let\udotaccent = \d
589
590 % Other special characters: @questiondown @exclamdown @ordf @ordm
591 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
592 \def\questiondown{?`}
593 \def\exclamdown{!`}
594 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
595 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
596
597 % Dotless i and dotless j, used for accents.
598 \def\imacro{i}
599 \def\jmacro{j}
600 \def\dotless#1{%
601   \def\temp{#1}%
602   \ifx\temp\imacro \ptexi
603   \else\ifx\temp\jmacro \j
604   \else \errmessage{@dotless can be used only with i or j}%
605   \fi\fi
606 }
607
608 % The \TeX{} logo, as in plain, but resetting the spacing so that a
609 % period following counts as ending a sentence.  (Idea found in latex.)
610 %
611 \edef\TeX{\TeX \spacefactor=1000 }
612
613 % @LaTeX{} logo.  Not quite the same results as the definition in
614 % latex.ltx, since we use a different font for the raised A; it's most
615 % convenient for us to use an explicitly smaller font, rather than using
616 % the \scriptstyle font (since we don't reset \scriptstyle and
617 % \scriptscriptstyle).
618 %
619 \def\LaTeX{%
620   L\kern-.36em
621   {\setbox0=\hbox{T}%
622    \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
623   \kern-.15em
624   \TeX
625 }
626
627 % Be sure we're in horizontal mode when doing a tie, since we make space
628 % equivalent to this in @example-like environments. Otherwise, a space
629 % at the beginning of a line will start with \penalty -- and
630 % since \penalty is valid in vertical mode, we'd end up putting the
631 % penalty on the vertical list instead of in the new paragraph.
632 {\catcode`@ = 11
633  % Avoid using \@M directly, because that causes trouble
634  % if the definition is written into an index file.
635  \global\let\tiepenalty = \@M
636  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
637 }
638
639 % @: forces normal size whitespace following.
640 \def\:{\spacefactor=1000 }
641
642 % @* forces a line break.
643 \def\*{\hfil\break\hbox{}\ignorespaces}
644
645 % @/ allows a line break.
646 \let\/=\allowbreak
647
648 % @. is an end-of-sentence period.
649 \def\.{.\spacefactor=3000 }
650
651 % @! is an end-of-sentence bang.
652 \def\!{!\spacefactor=3000 }
653
654 % @? is an end-of-sentence query.
655 \def\?{?\spacefactor=3000 }
656
657 % @w prevents a word break.  Without the \leavevmode, @w at the
658 % beginning of a paragraph, when TeX is still in vertical mode, would
659 % produce a whole line of output instead of starting the paragraph.
660 \def\w#1{\leavevmode\hbox{#1}}
661
662 % @group ... @end group forces ... to be all on one page, by enclosing
663 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
664 % to keep its height that of a normal line.  According to the rules for
665 % \topskip (p.114 of the TeXbook), the glue inserted is
666 % max (\topskip - \ht (first item), 0).  If that height is large,
667 % therefore, no glue is inserted, and the space between the headline and
668 % the text is small, which looks bad.
669 %
670 % Another complication is that the group might be very large.  This can
671 % cause the glue on the previous page to be unduly stretched, because it
672 % does not have much material.  In this case, it's better to add an
673 % explicit \vfill so that the extra space is at the bottom.  The
674 % threshold for doing this is if the group is more than \vfilllimit
675 % percent of a page (\vfilllimit can be changed inside of @tex).
676 %
677 \newbox\groupbox
678 \def\vfilllimit{0.7}
679 %
680 \envdef\group{%
681   \ifnum\catcode`\^^M=\active \else
682     \errhelp = \groupinvalidhelp
683     \errmessage{@group invalid in context where filling is enabled}%
684   \fi
685   \startsavinginserts
686   %
687   \setbox\groupbox = \vtop\bgroup
688     % Do @comment since we are called inside an environment such as
689     % @example, where each end-of-line in the input causes an
690     % end-of-line in the output.  We don't want the end-of-line after
691     % the `@group' to put extra space in the output.  Since @group
692     % should appear on a line by itself (according to the Texinfo
693     % manual), we don't worry about eating any user text.
694     \comment
695 }
696 %
697 % The \vtop produces a box with normal height and large depth; thus, TeX puts
698 % \baselineskip glue before it, and (when the next line of text is done)
699 % \lineskip glue after it.  Thus, space below is not quite equal to space
700 % above.  But it's pretty close.
701 \def\Egroup{%
702     % To get correct interline space between the last line of the group
703     % and the first line afterwards, we have to propagate \prevdepth.
704     \endgraf % Not \par, as it may have been set to \lisppar.
705     \global\dimen1 = \prevdepth
706   \egroup           % End the \vtop.
707   % \dimen0 is the vertical size of the group's box.
708   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
709   % \dimen2 is how much space is left on the page (more or less).
710   \dimen2 = \pageheight   \advance\dimen2 by -\pagetotal
711   % if the group doesn't fit on the current page, and it's a big big
712   % group, force a page break.
713   \ifdim \dimen0 > \dimen2
714     \ifdim \pagetotal < \vfilllimit\pageheight
715       \page
716     \fi
717   \fi
718   \box\groupbox
719   \prevdepth = \dimen1
720   \checkinserts
721 }
722 %
723 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
724 % message, so this ends up printing `@group can only ...'.
725 %
726 \newhelp\groupinvalidhelp{%
727 group can only be used in environments such as @example,^^J%
728 where each line of input produces a line of output.}
729
730 % @need space-in-mils
731 % forces a page break if there is not space-in-mils remaining.
732
733 \newdimen\mil  \mil=0.001in
734
735 % Old definition--didn't work.
736 %\parseargdef\need{\par %
737 %% This method tries to make TeX break the page naturally
738 %% if the depth of the box does not fit.
739 %{\baselineskip=0pt%
740 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
741 %\prevdepth=-1000pt
742 %}}
743
744 \parseargdef\need{%
745   % Ensure vertical mode, so we don't make a big box in the middle of a
746   % paragraph.
747   \par
748   %
749   % If the @need value is less than one line space, it's useless.
750   \dimen0 = #1\mil
751   \dimen2 = \ht\strutbox
752   \advance\dimen2 by \dp\strutbox
753   \ifdim\dimen0 > \dimen2
754     %
755     % Do a \strut just to make the height of this box be normal, so the
756     % normal leading is inserted relative to the preceding line.
757     % And a page break here is fine.
758     \vtop to #1\mil{\strut\vfil}%
759     %
760     % TeX does not even consider page breaks if a penalty added to the
761     % main vertical list is 10000 or more.  But in order to see if the
762     % empty box we just added fits on the page, we must make it consider
763     % page breaks.  On the other hand, we don't want to actually break the
764     % page after the empty box.  So we use a penalty of 9999.
765     %
766     % There is an extremely small chance that TeX will actually break the
767     % page at this \penalty, if there are no other feasible breakpoints in
768     % sight.  (If the user is using lots of big @group commands, which
769     % almost-but-not-quite fill up a page, TeX will have a hard time doing
770     % good page breaking, for example.)  However, I could not construct an
771     % example where a page broke at this \penalty; if it happens in a real
772     % document, then we can reconsider our strategy.
773     \penalty9999
774     %
775     % Back up by the size of the box, whether we did a page break or not.
776     \kern -#1\mil
777     %
778     % Do not allow a page break right after this kern.
779     \nobreak
780   \fi
781 }
782
783 % @br   forces paragraph break (and is undocumented).
784
785 \let\br = \par
786
787 % @page forces the start of a new page.
788 %
789 \def\page{\par\vfill\supereject}
790
791 % @exdent text....
792 % outputs text on separate line in roman font, starting at standard page margin
793
794 % This records the amount of indent in the innermost environment.
795 % That's how much \exdent should take out.
796 \newskip\exdentamount
797
798 % This defn is used inside fill environments such as @defun.
799 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
800
801 % This defn is used inside nofill environments such as @example.
802 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
803   \leftline{\hskip\leftskip{\rm#1}}}}
804
805 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
806 % paragraph.  For more general purposes, use the \margin insertion
807 % class.  WHICH is `l' or `r'.
808 %
809 \newskip\inmarginspacing \inmarginspacing=1cm
810 \def\strutdepth{\dp\strutbox}
811 %
812 \def\doinmargin#1#2{\strut\vadjust{%
813   \nobreak
814   \kern-\strutdepth
815   \vtop to \strutdepth{%
816     \baselineskip=\strutdepth
817     \vss
818     % if you have multiple lines of stuff to put here, you'll need to
819     % make the vbox yourself of the appropriate size.
820     \ifx#1l%
821       \llap{\ignorespaces #2\hskip\inmarginspacing}%
822     \else
823       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
824     \fi
825     \null
826   }%
827 }}
828 \def\inleftmargin{\doinmargin l}
829 \def\inrightmargin{\doinmargin r}
830 %
831 % @inmargin{TEXT [, RIGHT-TEXT]}
832 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
833 % else use TEXT for both).
834 %
835 \def\inmargin#1{\parseinmargin #1,,\finish}
836 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
837   \setbox0 = \hbox{\ignorespaces #2}%
838   \ifdim\wd0 > 0pt
839     \def\lefttext{#1}%  have both texts
840     \def\righttext{#2}%
841   \else
842     \def\lefttext{#1}%  have only one text
843     \def\righttext{#1}%
844   \fi
845   %
846   \ifodd\pageno
847     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
848   \else
849     \def\temp{\inleftmargin\lefttext}%
850   \fi
851   \temp
852 }
853
854 % @include file    insert text of that file as input.
855 %
856 \def\include{\parseargusing\filenamecatcodes\includezzz}
857 \def\includezzz#1{%
858   \pushthisfilestack
859   \def\thisfile{#1}%
860   {%
861     \makevalueexpandable
862     \def\temp{\input #1 }%
863     \expandafter
864   }\temp
865   \popthisfilestack
866 }
867 \def\filenamecatcodes{%
868   \catcode`\\=\other
869   \catcode`~=\other
870   \catcode`^=\other
871   \catcode`_=\other
872   \catcode`|=\other
873   \catcode`<=\other
874   \catcode`>=\other
875   \catcode`+=\other
876   \catcode`-=\other
877 }
878
879 \def\pushthisfilestack{%
880   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
881 }
882 \def\pushthisfilestackX{%
883   \expandafter\pushthisfilestackY\thisfile\StackTerm
884 }
885 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
886   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
887 }
888
889 \def\popthisfilestack{\errthisfilestackempty}
890 \def\errthisfilestackempty{\errmessage{Internal error:
891   the stack of filenames is empty.}}
892
893 \def\thisfile{}
894
895 % @center line
896 % outputs that line, centered.
897 %
898 \parseargdef\center{%
899   \ifhmode
900     \let\next\centerH
901   \else
902     \let\next\centerV
903   \fi
904   \next{\hfil \ignorespaces#1\unskip \hfil}%
905 }
906 \def\centerH#1{%
907   {%
908     \hfil\break
909     \advance\hsize by -\leftskip
910     \advance\hsize by -\rightskip
911     \line{#1}%
912     \break
913   }%
914 }
915 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
916
917 % @sp n   outputs n lines of vertical space
918
919 \parseargdef\sp{\vskip #1\baselineskip}
920
921 % @comment ...line which is ignored...
922 % @c is the same as @comment
923 % @ignore ... @end ignore  is another way to write a comment
924
925 \def\comment{\begingroup \catcode`\^^M=\other%
926 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
927 \commentxxx}
928 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
929
930 \let\c=\comment
931
932 % @paragraphindent NCHARS
933 % We'll use ems for NCHARS, close enough.
934 % NCHARS can also be the word `asis' or `none'.
935 % We cannot feasibly implement @paragraphindent asis, though.
936 %
937 \def\asisword{asis} % no translation, these are keywords
938 \def\noneword{none}
939 %
940 \parseargdef\paragraphindent{%
941   \def\temp{#1}%
942   \ifx\temp\asisword
943   \else
944     \ifx\temp\noneword
945       \defaultparindent = 0pt
946     \else
947       \defaultparindent = #1em
948     \fi
949   \fi
950   \parindent = \defaultparindent
951 }
952
953 % @exampleindent NCHARS
954 % We'll use ems for NCHARS like @paragraphindent.
955 % It seems @exampleindent asis isn't necessary, but
956 % I preserve it to make it similar to @paragraphindent.
957 \parseargdef\exampleindent{%
958   \def\temp{#1}%
959   \ifx\temp\asisword
960   \else
961     \ifx\temp\noneword
962       \lispnarrowing = 0pt
963     \else
964       \lispnarrowing = #1em
965     \fi
966   \fi
967 }
968
969 % @firstparagraphindent WORD
970 % If WORD is `none', then suppress indentation of the first paragraph
971 % after a section heading.  If WORD is `insert', then do indent at such
972 % paragraphs.
973 %
974 % The paragraph indentation is suppressed or not by calling
975 % \suppressfirstparagraphindent, which the sectioning commands do.
976 % We switch the definition of this back and forth according to WORD.
977 % By default, we suppress indentation.
978 %
979 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
980 \def\insertword{insert}
981 %
982 \parseargdef\firstparagraphindent{%
983   \def\temp{#1}%
984   \ifx\temp\noneword
985     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
986   \else\ifx\temp\insertword
987     \let\suppressfirstparagraphindent = \relax
988   \else
989     \errhelp = \EMsimple
990     \errmessage{Unknown @firstparagraphindent option `\temp'}%
991   \fi\fi
992 }
993
994 % Here is how we actually suppress indentation.  Redefine \everypar to
995 % \kern backwards by \parindent, and then reset itself to empty.
996 %
997 % We also make \indent itself not actually do anything until the next
998 % paragraph.
999 %
1000 \gdef\dosuppressfirstparagraphindent{%
1001   \gdef\indent{%
1002     \restorefirstparagraphindent
1003     \indent
1004   }%
1005   \gdef\noindent{%
1006     \restorefirstparagraphindent
1007     \noindent
1008   }%
1009   \global\everypar = {%
1010     \kern -\parindent
1011     \restorefirstparagraphindent
1012   }%
1013 }
1014
1015 \gdef\restorefirstparagraphindent{%
1016   \global \let \indent = \ptexindent
1017   \global \let \noindent = \ptexnoindent
1018   \global \everypar = {}%
1019 }
1020
1021
1022 % @asis just yields its argument.  Used with @table, for example.
1023 %
1024 \def\asis#1{#1}
1025
1026 % @math outputs its argument in math mode.
1027 %
1028 % One complication: _ usually means subscripts, but it could also mean
1029 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
1030 % _ active, and distinguish by seeing if the current family is \slfam,
1031 % which is what @var uses.
1032 {
1033   \catcode\underChar = \active
1034   \gdef\mathunderscore{%
1035     \catcode\underChar=\active
1036     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1037   }
1038 }
1039 % Another complication: we want \\ (and @\) to output a \ character.
1040 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1041 % this is not advertised and we don't care.  Texinfo does not
1042 % otherwise define @\.
1043 %
1044 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1045 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1046 %
1047 \def\math{%
1048   \tex
1049   \mathunderscore
1050   \let\\ = \mathbackslash
1051   \mathactive
1052   $\finishmath
1053 }
1054 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1055
1056 % Some active characters (such as <) are spaced differently in math.
1057 % We have to reset their definitions in case the @math was an argument
1058 % to a command which sets the catcodes (such as @item or @section).
1059 %
1060 {
1061   \catcode`^ = \active
1062   \catcode`< = \active
1063   \catcode`> = \active
1064   \catcode`+ = \active
1065   \gdef\mathactive{%
1066     \let^ = \ptexhat
1067     \let< = \ptexless
1068     \let> = \ptexgtr
1069     \let+ = \ptexplus
1070   }
1071 }
1072
1073 % @bullet and @minus need the same treatment as @math, just above.
1074 \def\bullet{$\ptexbullet$}
1075 \def\minus{$-$}
1076
1077 % @dots{} outputs an ellipsis using the current font.
1078 % We do .5em per period so that it has the same spacing in a typewriter
1079 % font as three actual period characters.
1080 %
1081 \def\dots{%
1082   \leavevmode
1083   \hbox to 1.5em{%
1084     \hskip 0pt plus 0.25fil
1085     .\hfil.\hfil.%
1086     \hskip 0pt plus 0.5fil
1087   }%
1088 }
1089
1090 % @enddots{} is an end-of-sentence ellipsis.
1091 %
1092 \def\enddots{%
1093   \dots
1094   \spacefactor=3000
1095 }
1096
1097 % @comma{} is so commas can be inserted into text without messing up
1098 % Texinfo's parsing.
1099 %
1100 \let\comma = ,
1101
1102 % @refill is a no-op.
1103 \let\refill=\relax
1104
1105 % If working on a large document in chapters, it is convenient to
1106 % be able to disable indexing, cross-referencing, and contents, for test runs.
1107 % This is done with @novalidate (before @setfilename).
1108 %
1109 \newif\iflinks \linkstrue % by default we want the aux files.
1110 \let\novalidate = \linksfalse
1111
1112 % @setfilename is done at the beginning of every texinfo file.
1113 % So open here the files we need to have open while reading the input.
1114 % This makes it possible to make a .fmt file for texinfo.
1115 \def\setfilename{%
1116    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1117    \iflinks
1118      \tryauxfile
1119      % Open the new aux file.  TeX will close it automatically at exit.
1120      \immediate\openout\auxfile=\jobname.aux
1121    \fi % \openindices needs to do some work in any case.
1122    \openindices
1123    \let\setfilename=\comment % Ignore extra @setfilename cmds.
1124    %
1125    % If texinfo.cnf is present on the system, read it.
1126    % Useful for site-wide @afourpaper, etc.
1127    \openin 1 texinfo.cnf
1128    \ifeof 1 \else \input texinfo.cnf \fi
1129    \closein 1
1130    %
1131    \comment % Ignore the actual filename.
1132 }
1133
1134 % Called from \setfilename.
1135 %
1136 \def\openindices{%
1137   \newindex{cp}%
1138   \newcodeindex{fn}%
1139   \newcodeindex{vr}%
1140   \newcodeindex{tp}%
1141   \newcodeindex{ky}%
1142   \newcodeindex{pg}%
1143 }
1144
1145 % @bye.
1146 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1147
1148
1149 \message{pdf,}
1150 % adobe `portable' document format
1151 \newcount\tempnum
1152 \newcount\lnkcount
1153 \newtoks\filename
1154 \newcount\filenamelength
1155 \newcount\pgn
1156 \newtoks\toksA
1157 \newtoks\toksB
1158 \newtoks\toksC
1159 \newtoks\toksD
1160 \newbox\boxA
1161 \newcount\countA
1162 \newif\ifpdf
1163 \newif\ifpdfmakepagedest
1164
1165 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1166 % can be set).  So we test for \relax and 0 as well as \undefined,
1167 % borrowed from ifpdf.sty.
1168 \ifx\pdfoutput\undefined
1169 \else
1170   \ifx\pdfoutput\relax
1171   \else
1172     \ifcase\pdfoutput
1173     \else
1174       \pdftrue
1175     \fi
1176   \fi
1177 \fi
1178 %
1179 \ifpdf
1180   \input pdfcolor
1181   \pdfcatalog{/PageMode /UseOutlines}%
1182   \def\dopdfimage#1#2#3{%
1183     \def\imagewidth{#2}%
1184     \def\imageheight{#3}%
1185     % without \immediate, pdftex seg faults when the same image is
1186     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1187     \ifnum\pdftexversion < 14
1188       \immediate\pdfimage
1189     \else
1190       \immediate\pdfximage
1191     \fi
1192       \ifx\empty\imagewidth\else width \imagewidth \fi
1193       \ifx\empty\imageheight\else height \imageheight \fi
1194       \ifnum\pdftexversion<13
1195          #1.pdf%
1196        \else
1197          {#1.pdf}%
1198        \fi
1199     \ifnum\pdftexversion < 14 \else
1200       \pdfrefximage \pdflastximage
1201     \fi}
1202   \def\pdfmkdest#1{{%
1203     % We have to set dummies so commands such as @code in a section title
1204     % aren't expanded.
1205     \atdummies
1206     \normalturnoffactive
1207     \pdfdest name{#1} xyz%
1208   }}
1209   \def\pdfmkpgn#1{#1}
1210   \let\linkcolor = \Blue  % was Cyan, but that seems light?
1211   \def\endlink{\Black\pdfendlink}
1212   % Adding outlines to PDF; macros for calculating structure of outlines
1213   % come from Petr Olsak
1214   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1215     \else \csname#1\endcsname \fi}
1216   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1217     \advance\tempnum by 1
1218     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1219   %
1220   % #1 is the section text.  #2 is the pdf expression for the number
1221   % of subentries (or empty, for subsubsections).  #3 is the node
1222   % text, which might be empty if this toc entry had no
1223   % corresponding node.  #4 is the page number.
1224   %
1225   \def\dopdfoutline#1#2#3#4{%
1226     % Generate a link to the node text if that exists; else, use the
1227     % page number.  We could generate a destination for the section
1228     % text in the case where a section has no node, but it doesn't
1229     % seem worthwhile, since most documents are normally structured.
1230     \def\pdfoutlinedest{#3}%
1231     \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1232     %
1233     \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1234   }
1235   %
1236   \def\pdfmakeoutlines{%
1237     \begingroup
1238       % Thanh's hack / proper braces in bookmarks
1239       \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1240       \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1241       %
1242       % Read toc silently, to get counts of subentries for \pdfoutline.
1243       \def\numchapentry##1##2##3##4{%
1244         \def\thischapnum{##2}%
1245         \let\thissecnum\empty
1246         \let\thissubsecnum\empty
1247       }%
1248       \def\numsecentry##1##2##3##4{%
1249         \advancenumber{chap\thischapnum}%
1250         \def\thissecnum{##2}%
1251         \let\thissubsecnum\empty
1252       }%
1253       \def\numsubsecentry##1##2##3##4{%
1254         \advancenumber{sec\thissecnum}%
1255         \def\thissubsecnum{##2}%
1256       }%
1257       \def\numsubsubsecentry##1##2##3##4{%
1258         \advancenumber{subsec\thissubsecnum}%
1259       }%
1260       \let\thischapnum\empty
1261       \let\thissecnum\empty
1262       \let\thissubsecnum\empty
1263       %
1264       % use \def rather than \let here because we redefine \chapentry et
1265       % al. a second time, below.
1266       \def\appentry{\numchapentry}%
1267       \def\appsecentry{\numsecentry}%
1268       \def\appsubsecentry{\numsubsecentry}%
1269       \def\appsubsubsecentry{\numsubsubsecentry}%
1270       \def\unnchapentry{\numchapentry}%
1271       \def\unnsecentry{\numsecentry}%
1272       \def\unnsubsecentry{\numsubsecentry}%
1273       \def\unnsubsubsecentry{\numsubsubsecentry}%
1274       \input \jobname.toc
1275       %
1276       % Read toc second time, this time actually producing the outlines.
1277       % The `-' means take the \expnumber as the absolute number of
1278       % subentries, which we calculated on our first read of the .toc above.
1279       %
1280       % We use the node names as the destinations.
1281       \def\numchapentry##1##2##3##4{%
1282         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1283       \def\numsecentry##1##2##3##4{%
1284         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1285       \def\numsubsecentry##1##2##3##4{%
1286         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1287       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1288         \dopdfoutline{##1}{}{##3}{##4}}%
1289       %
1290       % PDF outlines are displayed using system fonts, instead of
1291       % document fonts.  Therefore we cannot use special characters,
1292       % since the encoding is unknown.  For example, the eogonek from
1293       % Latin 2 (0xea) gets translated to a | character.  Info from
1294       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1295       %
1296       % xx to do this right, we have to translate 8-bit characters to
1297       % their "best" equivalent, based on the @documentencoding.  Right
1298       % now, I guess we'll just let the pdf reader have its way.
1299       \indexnofonts
1300       \turnoffactive
1301       \input \jobname.toc
1302     \endgroup
1303   }
1304   %
1305   \def\makelinks #1,{%
1306     \def\params{#1}\def\E{END}%
1307     \ifx\params\E
1308       \let\nextmakelinks=\relax
1309     \else
1310       \let\nextmakelinks=\makelinks
1311       \ifnum\lnkcount>0,\fi
1312       \picknum{#1}%
1313       \startlink attr{/Border [0 0 0]}
1314         goto name{\pdfmkpgn{\the\pgn}}%
1315       \linkcolor #1%
1316       \advance\lnkcount by 1%
1317       \endlink
1318     \fi
1319     \nextmakelinks
1320   }
1321   \def\picknum#1{\expandafter\pn#1}
1322   \def\pn#1{%
1323     \def\p{#1}%
1324     \ifx\p\lbrace
1325       \let\nextpn=\ppn
1326     \else
1327       \let\nextpn=\ppnn
1328       \def\first{#1}
1329     \fi
1330     \nextpn
1331   }
1332   \def\ppn#1{\pgn=#1\gobble}
1333   \def\ppnn{\pgn=\first}
1334   \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1335   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1336     \ifx\PP\D\let\nextsp\relax
1337     \else\let\nextsp\skipspaces
1338       \ifx\p\space\else\addtokens{\filename}{\PP}%
1339         \advance\filenamelength by 1
1340       \fi
1341     \fi
1342     \nextsp}
1343   \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1344   \ifnum\pdftexversion < 14
1345     \let \startlink \pdfannotlink
1346   \else
1347     \let \startlink \pdfstartlink
1348   \fi
1349   \def\pdfurl#1{%
1350     \begingroup
1351       \normalturnoffactive\def\@{@}%
1352       \makevalueexpandable
1353       \leavevmode\Red
1354       \startlink attr{/Border [0 0 0]}%
1355         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1356     \endgroup}
1357   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1358   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1359   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1360   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1361   \def\maketoks{%
1362     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1363     \ifx\first0\adn0
1364     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1365     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1366     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1367     \else
1368       \ifnum0=\countA\else\makelink\fi
1369       \ifx\first.\let\next=\done\else
1370         \let\next=\maketoks
1371         \addtokens{\toksB}{\the\toksD}
1372         \ifx\first,\addtokens{\toksB}{\space}\fi
1373       \fi
1374     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1375     \next}
1376   \def\makelink{\addtokens{\toksB}%
1377     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1378   \def\pdflink#1{%
1379     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1380     \linkcolor #1\endlink}
1381   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1382 \else
1383   \let\pdfmkdest = \gobble
1384   \let\pdfurl = \gobble
1385   \let\endlink = \relax
1386   \let\linkcolor = \relax
1387   \let\pdfmakeoutlines = \relax
1388 \fi  % \ifx\pdfoutput
1389
1390
1391 \message{fonts,}
1392
1393 % Change the current font style to #1, remembering it in \curfontstyle.
1394 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1395 % italics, not bold italics.
1396 %
1397 \def\setfontstyle#1{%
1398   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1399   \csname ten#1\endcsname  % change the current font
1400 }
1401
1402 % Select #1 fonts with the current style.
1403 %
1404 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1405
1406 \def\rm{\fam=0 \setfontstyle{rm}}
1407 \def\it{\fam=\itfam \setfontstyle{it}}
1408 \def\sl{\fam=\slfam \setfontstyle{sl}}
1409 \def\bf{\fam=\bffam \setfontstyle{bf}}
1410 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1411
1412 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1413 % So we set up a \sf.
1414 \newfam\sffam
1415 \def\sf{\fam=\sffam \setfontstyle{sf}}
1416 \let\li = \sf % Sometimes we call it \li, not \sf.
1417
1418 % We don't need math for this font style.
1419 \def\ttsl{\setfontstyle{ttsl}}
1420
1421 % Default leading.
1422 \newdimen\textleading  \textleading = 13.2pt
1423
1424 % Set the baselineskip to #1, and the lineskip and strut size
1425 % correspondingly.  There is no deep meaning behind these magic numbers
1426 % used as factors; they just match (closely enough) what Knuth defined.
1427 %
1428 \def\lineskipfactor{.08333}
1429 \def\strutheightpercent{.70833}
1430 \def\strutdepthpercent {.29167}
1431 %
1432 \def\setleading#1{%
1433   \normalbaselineskip = #1\relax
1434   \normallineskip = \lineskipfactor\normalbaselineskip
1435   \normalbaselines
1436   \setbox\strutbox =\hbox{%
1437     \vrule width0pt height\strutheightpercent\baselineskip
1438                     depth \strutdepthpercent \baselineskip
1439   }%
1440 }
1441
1442 % Set the font macro #1 to the font named #2, adding on the
1443 % specified font prefix (normally `cm').
1444 % #3 is the font's design size, #4 is a scale factor
1445 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1446
1447 % Use cm as the default font prefix.
1448 % To specify the font prefix, you must define \fontprefix
1449 % before you read in texinfo.tex.
1450 \ifx\fontprefix\undefined
1451 \def\fontprefix{cm}
1452 \fi
1453 % Support font families that don't use the same naming scheme as CM.
1454 \def\rmshape{r}
1455 \def\rmbshape{bx}               %where the normal face is bold
1456 \def\bfshape{b}
1457 \def\bxshape{bx}
1458 \def\ttshape{tt}
1459 \def\ttbshape{tt}
1460 \def\ttslshape{sltt}
1461 \def\itshape{ti}
1462 \def\itbshape{bxti}
1463 \def\slshape{sl}
1464 \def\slbshape{bxsl}
1465 \def\sfshape{ss}
1466 \def\sfbshape{ss}
1467 \def\scshape{csc}
1468 \def\scbshape{csc}
1469
1470 % Text fonts (11.2pt, magstep1).
1471 \newcount\mainmagstep
1472 \ifx\bigger\relax
1473   % not really supported.
1474   \mainmagstep=\magstep1
1475   \setfont\textrm\rmshape{12}{1000}
1476   \setfont\texttt\ttshape{12}{1000}
1477 \else
1478   \mainmagstep=\magstephalf
1479   \setfont\textrm\rmshape{10}{\mainmagstep}
1480   \setfont\texttt\ttshape{10}{\mainmagstep}
1481 \fi
1482 \setfont\textbf\bfshape{10}{\mainmagstep}
1483 \setfont\textit\itshape{10}{\mainmagstep}
1484 \setfont\textsl\slshape{10}{\mainmagstep}
1485 \setfont\textsf\sfshape{10}{\mainmagstep}
1486 \setfont\textsc\scshape{10}{\mainmagstep}
1487 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1488 \font\texti=cmmi10 scaled \mainmagstep
1489 \font\textsy=cmsy10 scaled \mainmagstep
1490
1491 % A few fonts for @defun names and args.
1492 \setfont\defbf\bfshape{10}{\magstep1}
1493 \setfont\deftt\ttshape{10}{\magstep1}
1494 \setfont\defttsl\ttslshape{10}{\magstep1}
1495 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1496
1497 % Fonts for indices, footnotes, small examples (9pt).
1498 \setfont\smallrm\rmshape{9}{1000}
1499 \setfont\smalltt\ttshape{9}{1000}
1500 \setfont\smallbf\bfshape{10}{900}
1501 \setfont\smallit\itshape{9}{1000}
1502 \setfont\smallsl\slshape{9}{1000}
1503 \setfont\smallsf\sfshape{9}{1000}
1504 \setfont\smallsc\scshape{10}{900}
1505 \setfont\smallttsl\ttslshape{10}{900}
1506 \font\smalli=cmmi9
1507 \font\smallsy=cmsy9
1508
1509 % Fonts for small examples (8pt).
1510 \setfont\smallerrm\rmshape{8}{1000}
1511 \setfont\smallertt\ttshape{8}{1000}
1512 \setfont\smallerbf\bfshape{10}{800}
1513 \setfont\smallerit\itshape{8}{1000}
1514 \setfont\smallersl\slshape{8}{1000}
1515 \setfont\smallersf\sfshape{8}{1000}
1516 \setfont\smallersc\scshape{10}{800}
1517 \setfont\smallerttsl\ttslshape{10}{800}
1518 \font\smalleri=cmmi8
1519 \font\smallersy=cmsy8
1520
1521 % Fonts for title page (20.4pt):
1522 \setfont\titlerm\rmbshape{12}{\magstep3}
1523 \setfont\titleit\itbshape{10}{\magstep4}
1524 \setfont\titlesl\slbshape{10}{\magstep4}
1525 \setfont\titlett\ttbshape{12}{\magstep3}
1526 \setfont\titlettsl\ttslshape{10}{\magstep4}
1527 \setfont\titlesf\sfbshape{17}{\magstep1}
1528 \let\titlebf=\titlerm
1529 \setfont\titlesc\scbshape{10}{\magstep4}
1530 \font\titlei=cmmi12 scaled \magstep3
1531 \font\titlesy=cmsy10 scaled \magstep4
1532 \def\authorrm{\secrm}
1533 \def\authortt{\sectt}
1534
1535 % Chapter (and unnumbered) fonts (17.28pt).
1536 \setfont\chaprm\rmbshape{12}{\magstep2}
1537 \setfont\chapit\itbshape{10}{\magstep3}
1538 \setfont\chapsl\slbshape{10}{\magstep3}
1539 \setfont\chaptt\ttbshape{12}{\magstep2}
1540 \setfont\chapttsl\ttslshape{10}{\magstep3}
1541 \setfont\chapsf\sfbshape{17}{1000}
1542 \let\chapbf=\chaprm
1543 \setfont\chapsc\scbshape{10}{\magstep3}
1544 \font\chapi=cmmi12 scaled \magstep2
1545 \font\chapsy=cmsy10 scaled \magstep3
1546
1547 % Section fonts (14.4pt).
1548 \setfont\secrm\rmbshape{12}{\magstep1}
1549 \setfont\secit\itbshape{10}{\magstep2}
1550 \setfont\secsl\slbshape{10}{\magstep2}
1551 \setfont\sectt\ttbshape{12}{\magstep1}
1552 \setfont\secttsl\ttslshape{10}{\magstep2}
1553 \setfont\secsf\sfbshape{12}{\magstep1}
1554 \let\secbf\secrm
1555 \setfont\secsc\scbshape{10}{\magstep2}
1556 \font\seci=cmmi12 scaled \magstep1
1557 \font\secsy=cmsy10 scaled \magstep2
1558
1559 % Subsection fonts (13.15pt).
1560 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1561 \setfont\ssecit\itbshape{10}{1315}
1562 \setfont\ssecsl\slbshape{10}{1315}
1563 \setfont\ssectt\ttbshape{12}{\magstephalf}
1564 \setfont\ssecttsl\ttslshape{10}{1315}
1565 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1566 \let\ssecbf\ssecrm
1567 \setfont\ssecsc\scbshape{10}{1315}
1568 \font\sseci=cmmi12 scaled \magstephalf
1569 \font\ssecsy=cmsy10 scaled 1315
1570
1571 % Reduced fonts for @acro in text (10pt).
1572 \setfont\reducedrm\rmshape{10}{1000}
1573 \setfont\reducedtt\ttshape{10}{1000}
1574 \setfont\reducedbf\bfshape{10}{1000}
1575 \setfont\reducedit\itshape{10}{1000}
1576 \setfont\reducedsl\slshape{10}{1000}
1577 \setfont\reducedsf\sfshape{10}{1000}
1578 \setfont\reducedsc\scshape{10}{1000}
1579 \setfont\reducedttsl\ttslshape{10}{1000}
1580 \font\reducedi=cmmi10
1581 \font\reducedsy=cmsy10
1582
1583 % In order for the font changes to affect most math symbols and letters,
1584 % we have to define the \textfont of the standard families.  Since
1585 % texinfo doesn't allow for producing subscripts and superscripts except
1586 % in the main text, we don't bother to reset \scriptfont and
1587 % \scriptscriptfont (which would also require loading a lot more fonts).
1588 %
1589 \def\resetmathfonts{%
1590   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1591   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1592   \textfont\ttfam=\tentt \textfont\sffam=\tensf
1593 }
1594
1595 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1596 % of just \STYLE.  We do this because \STYLE needs to also set the
1597 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
1598 % \tenSTYLE to set the current font.
1599 %
1600 % Each font-changing command also sets the names \lsize (one size lower)
1601 % and \lllsize (three sizes lower).  These relative commands are used in
1602 % the LaTeX logo and acronyms.
1603 %
1604 % This all needs generalizing, badly.
1605 %
1606 \def\textfonts{%
1607   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1608   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1609   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1610   \let\tenttsl=\textttsl
1611   \def\lsize{reduced}\def\lllsize{smaller}%
1612   \resetmathfonts \setleading{\textleading}}
1613 \def\titlefonts{%
1614   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1615   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1616   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1617   \let\tenttsl=\titlettsl
1618   \def\lsize{chap}\def\lllsize{subsec}%
1619   \resetmathfonts \setleading{25pt}}
1620 \def\titlefont#1{{\titlefonts\rm #1}}
1621 \def\chapfonts{%
1622   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1623   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1624   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1625   \def\lsize{sec}\def\lllsize{text}%
1626   \resetmathfonts \setleading{19pt}}
1627 \def\secfonts{%
1628   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1629   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1630   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1631   \let\tenttsl=\secttsl
1632   \def\lsize{subsec}\def\lllsize{reduced}%
1633   \resetmathfonts \setleading{16pt}}
1634 \def\subsecfonts{%
1635   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1636   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1637   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1638   \let\tenttsl=\ssecttsl
1639   \def\lsize{text}\def\lllsize{small}%
1640   \resetmathfonts \setleading{15pt}}
1641 \let\subsubsecfonts = \subsecfonts
1642 \def\reducedfonts{%
1643   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1644   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1645   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1646   \let\tenttsl=\reducedttsl
1647   \def\lsize{small}\def\lllsize{smaller}%
1648   \resetmathfonts \setleading{10.5pt}}
1649 \def\smallfonts{%
1650   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1651   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1652   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1653   \let\tenttsl=\smallttsl
1654   \def\lsize{smaller}\def\lllsize{smaller}%
1655   \resetmathfonts \setleading{10.5pt}}
1656 \def\smallerfonts{%
1657   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1658   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1659   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1660   \let\tenttsl=\smallerttsl
1661   \def\lsize{smaller}\def\lllsize{smaller}%
1662   \resetmathfonts \setleading{9.5pt}}
1663
1664 % Set the fonts to use with the @small... environments.
1665 \let\smallexamplefonts = \smallfonts
1666
1667 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
1668 % can fit this many characters:
1669 %   8.5x11=86   smallbook=72  a4=90  a5=69
1670 % If we use \scriptfonts (8pt), then we can fit this many characters:
1671 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
1672 % For me, subjectively, the few extra characters that fit aren't worth
1673 % the additional smallness of 8pt.  So I'm making the default 9pt.
1674 %
1675 % By the way, for comparison, here's what fits with @example (10pt):
1676 %   8.5x11=71  smallbook=60  a4=75  a5=58
1677 %
1678 % I wish the USA used A4 paper.
1679 % --karl, 24jan03.
1680
1681
1682 % Set up the default fonts, so we can use them for creating boxes.
1683 %
1684 \textfonts \rm
1685
1686 % Define these so they can be easily changed for other fonts.
1687 \def\angleleft{$\langle$}
1688 \def\angleright{$\rangle$}
1689
1690 % Count depth in font-changes, for error checks
1691 \newcount\fontdepth \fontdepth=0
1692
1693 % Fonts for short table of contents.
1694 \setfont\shortcontrm\rmshape{12}{1000}
1695 \setfont\shortcontbf\bfshape{10}{\magstep1}  % no cmb12
1696 \setfont\shortcontsl\slshape{12}{1000}
1697 \setfont\shortconttt\ttshape{12}{1000}
1698
1699 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1700 %% serif) and @ii for TeX italic
1701
1702 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1703 % unless the following character is such as not to need one.
1704 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1705                     \ptexslash\fi\fi\fi}
1706 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1707 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1708
1709 % like \smartslanted except unconditionally uses \ttsl.
1710 % @var is set to this for defun arguments.
1711 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1712
1713 % like \smartslanted except unconditionally use \sl.  We never want
1714 % ttsl for book titles, do we?
1715 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1716
1717 \let\i=\smartitalic
1718 \let\slanted=\smartslanted
1719 \let\var=\smartslanted
1720 \let\dfn=\smartslanted
1721 \let\emph=\smartitalic
1722
1723 \def\b#1{{\bf #1}}
1724 \let\strong=\b
1725
1726 % We can't just use \exhyphenpenalty, because that only has effect at
1727 % the end of a paragraph.  Restore normal hyphenation at the end of the
1728 % group within which \nohyphenation is presumably called.
1729 %
1730 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
1731 \def\restorehyphenation{\hyphenchar\font = `- }
1732
1733 % Set sfcode to normal for the chars that usually have another value.
1734 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1735 % sometimes \x has an active definition that messes things up.
1736 %
1737 \catcode`@=11
1738   \def\frenchspacing{%
1739     \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1740     \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1741   }
1742 \catcode`@=\other
1743
1744 \def\t#1{%
1745   {\tt \rawbackslash \frenchspacing #1}%
1746   \null
1747 }
1748 \def\samp#1{`\tclose{#1}'\null}
1749 \setfont\keyrm\rmshape{8}{1000}
1750 \font\keysy=cmsy9
1751 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1752   \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1753     \vbox{\hrule\kern-0.4pt
1754      \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1755     \kern-0.4pt\hrule}%
1756   \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1757 % The old definition, with no lozenge:
1758 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1759 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1760
1761 % @file, @option are the same as @samp.
1762 \let\file=\samp
1763 \let\option=\samp
1764
1765 % @code is a modification of @t,
1766 % which makes spaces the same size as normal in the surrounding text.
1767 \def\tclose#1{%
1768   {%
1769     % Change normal interword space to be same as for the current font.
1770     \spaceskip = \fontdimen2\font
1771     %
1772     % Switch to typewriter.
1773     \tt
1774     %
1775     % But `\ ' produces the large typewriter interword space.
1776     \def\ {{\spaceskip = 0pt{} }}%
1777     %
1778     % Turn off hyphenation.
1779     \nohyphenation
1780     %
1781     \rawbackslash
1782     \frenchspacing
1783     #1%
1784   }%
1785   \null
1786 }
1787
1788 % We *must* turn on hyphenation at `-' and `_' in @code.
1789 % Otherwise, it is too hard to avoid overfull hboxes
1790 % in the Emacs manual, the Library manual, etc.
1791
1792 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1793 % both hyphenation at - and hyphenation within words.
1794 % We must therefore turn them both off (\tclose does that)
1795 % and arrange explicitly to hyphenate at a dash.
1796 %  -- rms.
1797 {
1798   \catcode`\-=\active
1799   \catcode`\_=\active
1800   %
1801   \global\def\code{\begingroup
1802     \catcode`\-=\active \let-\codedash
1803     \catcode`\_=\active \let_\codeunder
1804     \codex
1805   }
1806 }
1807
1808 \def\realdash{-}
1809 \def\codedash{-\discretionary{}{}{}}
1810 \def\codeunder{%
1811   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
1812   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1813   % will therefore expand the active definition of _, which is us
1814   % (inside @code that is), therefore an endless loop.
1815   \ifusingtt{\ifmmode
1816                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1817              \else\normalunderscore \fi
1818              \discretionary{}{}{}}%
1819             {\_}%
1820 }
1821 \def\codex #1{\tclose{#1}\endgroup}
1822
1823 % @kbd is like @code, except that if the argument is just one @key command,
1824 % then @kbd has no effect.
1825
1826 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1827 %   `example' (@kbd uses ttsl only inside of @example and friends),
1828 %   or `code' (@kbd uses normal tty font always).
1829 \parseargdef\kbdinputstyle{%
1830   \def\arg{#1}%
1831   \ifx\arg\worddistinct
1832     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1833   \else\ifx\arg\wordexample
1834     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1835   \else\ifx\arg\wordcode
1836     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1837   \else
1838     \errhelp = \EMsimple
1839     \errmessage{Unknown @kbdinputstyle option `\arg'}%
1840   \fi\fi\fi
1841 }
1842 \def\worddistinct{distinct}
1843 \def\wordexample{example}
1844 \def\wordcode{code}
1845
1846 % Default is `distinct.'
1847 \kbdinputstyle distinct
1848
1849 \def\xkey{\key}
1850 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1851 \ifx\one\xkey\ifx\threex\three \key{#2}%
1852 \else{\tclose{\kbdfont\look}}\fi
1853 \else{\tclose{\kbdfont\look}}\fi}
1854
1855 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1856 \let\indicateurl=\code
1857 \let\env=\code
1858 \let\command=\code
1859
1860 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1861 % second argument specifying the text to display and an optional third
1862 % arg as text to display instead of (rather than in addition to) the url
1863 % itself.  First (mandatory) arg is the url.  Perhaps eventually put in
1864 % a hypertex \special here.
1865 %
1866 \def\uref#1{\douref #1,,,\finish}
1867 \def\douref#1,#2,#3,#4\finish{\begingroup
1868   \unsepspaces
1869   \pdfurl{#1}%
1870   \setbox0 = \hbox{\ignorespaces #3}%
1871   \ifdim\wd0 > 0pt
1872     \unhbox0 % third arg given, show only that
1873   \else
1874     \setbox0 = \hbox{\ignorespaces #2}%
1875     \ifdim\wd0 > 0pt
1876       \ifpdf
1877         \unhbox0             % PDF: 2nd arg given, show only it
1878       \else
1879         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1880       \fi
1881     \else
1882       \code{#1}% only url given, so show it
1883     \fi
1884   \fi
1885   \endlink
1886 \endgroup}
1887
1888 % @url synonym for @uref, since that's how everyone uses it.
1889 %
1890 \let\url=\uref
1891
1892 % rms does not like angle brackets --karl, 17may97.
1893 % So now @email is just like @uref, unless we are pdf.
1894 %
1895 %\def\email#1{\angleleft{\tt #1}\angleright}
1896 \ifpdf
1897   \def\email#1{\doemail#1,,\finish}
1898   \def\doemail#1,#2,#3\finish{\begingroup
1899     \unsepspaces
1900     \pdfurl{mailto:#1}%
1901     \setbox0 = \hbox{\ignorespaces #2}%
1902     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1903     \endlink
1904   \endgroup}
1905 \else
1906   \let\email=\uref
1907 \fi
1908
1909 % Check if we are currently using a typewriter font.  Since all the
1910 % Computer Modern typewriter fonts have zero interword stretch (and
1911 % shrink), and it is reasonable to expect all typewriter fonts to have
1912 % this property, we can check that font parameter.
1913 %
1914 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1915
1916 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
1917 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1918 %
1919 \def\dmn#1{\thinspace #1}
1920
1921 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1922
1923 % @l was never documented to mean ``switch to the Lisp font'',
1924 % and it is not used as such in any manual I can find.  We need it for
1925 % Polish suppressed-l.  --karl, 22sep96.
1926 %\def\l#1{{\li #1}\null}
1927
1928 % Explicit font changes: @r, @sc, undocumented @ii.
1929 \def\r#1{{\rm #1}}              % roman font
1930 \def\sc#1{{\smallcaps#1}}       % smallcaps font
1931 \def\ii#1{{\it #1}}             % italic font
1932
1933 % @acronym for "FBI", "NATO", and the like.
1934 % We print this one point size smaller, since it's intended for
1935 % all-uppercase.
1936
1937 \def\acronym#1{\doacronym #1,,\finish}
1938 \def\doacronym#1,#2,#3\finish{%
1939   {\selectfonts\lsize #1}%
1940   \def\temp{#2}%
1941   \ifx\temp\empty \else
1942     \space ({\unsepspaces \ignorespaces \temp \unskip})%
1943   \fi
1944 }
1945
1946 % @abbr for "Comput. J." and the like.
1947 % No font change, but don't do end-of-sentence spacing.
1948
1949 \def\abbr#1{\doabbr #1,,\finish}
1950 \def\doabbr#1,#2,#3\finish{%
1951   {\frenchspacing #1}%
1952   \def\temp{#2}%
1953   \ifx\temp\empty \else
1954     \space ({\unsepspaces \ignorespaces \temp \unskip})%
1955   \fi
1956 }
1957
1958 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
1959 %
1960 \def\pounds{{\it\$}}
1961
1962 % @registeredsymbol - R in a circle.  The font for the R should really
1963 % be smaller yet, but lllsize is the best we can do for now.
1964 % Adapted from the plain.tex definition of \copyright.
1965 %
1966 \def\registeredsymbol{%
1967   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
1968                \hfil\crcr\Orb}}%
1969     }$%
1970 }
1971
1972 % Laurent Siebenmann reports \Orb undefined with:
1973 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
1974 % so we'll define it if necessary.
1975
1976 \ifx\Orb\undefined
1977 \def\Orb{\mathhexbox20D}
1978 \fi
1979
1980
1981 \message{page headings,}
1982
1983 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1984 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1985
1986 % First the title page.  Must do @settitle before @titlepage.
1987 \newif\ifseenauthor
1988 \newif\iffinishedtitlepage
1989
1990 % Do an implicit @contents or @shortcontents after @end titlepage if the
1991 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1992 %
1993 \newif\ifsetcontentsaftertitlepage
1994  \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1995 \newif\ifsetshortcontentsaftertitlepage
1996  \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1997
1998 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1999         \endgroup\page\hbox{}\page}
2000
2001 \envdef\titlepage{%
2002   % Open one extra group, as we want to close it in the middle of \Etitlepage.
2003   \begingroup
2004     \parindent=0pt \textfonts
2005     % Leave some space at the very top of the page.
2006     \vglue\titlepagetopglue
2007     % No rule at page bottom unless we print one at the top with @title.
2008     \finishedtitlepagetrue
2009     %
2010     % Most title ``pages'' are actually two pages long, with space
2011     % at the top of the second.  We don't want the ragged left on the second.
2012     \let\oldpage = \page
2013     \def\page{%
2014       \iffinishedtitlepage\else
2015          \finishtitlepage
2016       \fi
2017       \let\page = \oldpage
2018       \page
2019       \null
2020     }%
2021 }
2022
2023 \def\Etitlepage{%
2024     \iffinishedtitlepage\else
2025         \finishtitlepage
2026     \fi
2027     % It is important to do the page break before ending the group,
2028     % because the headline and footline are only empty inside the group.
2029     % If we use the new definition of \page, we always get a blank page
2030     % after the title page, which we certainly don't want.
2031     \oldpage
2032   \endgroup
2033   %
2034   % Need this before the \...aftertitlepage checks so that if they are
2035   % in effect the toc pages will come out with page numbers.
2036   \HEADINGSon
2037   %
2038   % If they want short, they certainly want long too.
2039   \ifsetshortcontentsaftertitlepage
2040     \shortcontents
2041     \contents
2042     \global\let\shortcontents = \relax
2043     \global\let\contents = \relax
2044   \fi
2045   %
2046   \ifsetcontentsaftertitlepage
2047     \contents
2048     \global\let\contents = \relax
2049     \global\let\shortcontents = \relax
2050   \fi
2051 }
2052
2053 \def\finishtitlepage{%
2054   \vskip4pt \hrule height 2pt width \hsize
2055   \vskip\titlepagebottomglue
2056   \finishedtitlepagetrue
2057 }
2058
2059 %%% Macros to be used within @titlepage:
2060
2061 \let\subtitlerm=\tenrm
2062 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2063
2064 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2065                 \let\tt=\authortt}
2066
2067 \parseargdef\title{%
2068   \checkenv\titlepage
2069   \leftline{\titlefonts\rm #1}
2070   % print a rule at the page bottom also.
2071   \finishedtitlepagefalse
2072   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2073 }
2074
2075 \parseargdef\subtitle{%
2076   \checkenv\titlepage
2077   {\subtitlefont \rightline{#1}}%
2078 }
2079
2080 % @author should come last, but may come many times.
2081 % It can also be used inside @quotation.
2082 %
2083 \parseargdef\author{%
2084   \def\temp{\quotation}%
2085   \ifx\thisenv\temp
2086     \def\quotationauthor{#1}% printed in \Equotation.
2087   \else
2088     \checkenv\titlepage
2089     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2090     {\authorfont \leftline{#1}}%
2091   \fi
2092 }
2093
2094
2095 %%% Set up page headings and footings.
2096
2097 \let\thispage=\folio
2098
2099 \newtoks\evenheadline    % headline on even pages
2100 \newtoks\oddheadline     % headline on odd pages
2101 \newtoks\evenfootline    % footline on even pages
2102 \newtoks\oddfootline     % footline on odd pages
2103
2104 % Now make TeX use those variables
2105 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2106                             \else \the\evenheadline \fi}}
2107 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2108                             \else \the\evenfootline \fi}\HEADINGShook}
2109 \let\HEADINGShook=\relax
2110
2111 % Commands to set those variables.
2112 % For example, this is what  @headings on  does
2113 % @evenheading @thistitle|@thispage|@thischapter
2114 % @oddheading @thischapter|@thispage|@thistitle
2115 % @evenfooting @thisfile||
2116 % @oddfooting ||@thisfile
2117
2118
2119 \def\evenheading{\parsearg\evenheadingxxx}
2120 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2121 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2122 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2123
2124 \def\oddheading{\parsearg\oddheadingxxx}
2125 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2126 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2127 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2128
2129 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2130
2131 \def\evenfooting{\parsearg\evenfootingxxx}
2132 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2133 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2134 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2135
2136 \def\oddfooting{\parsearg\oddfootingxxx}
2137 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2138 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2139   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2140   %
2141   % Leave some space for the footline.  Hopefully ok to assume
2142   % @evenfooting will not be used by itself.
2143   \global\advance\pageheight by -\baselineskip
2144   \global\advance\vsize by -\baselineskip
2145 }
2146
2147 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2148
2149
2150 % @headings double      turns headings on for double-sided printing.
2151 % @headings single      turns headings on for single-sided printing.
2152 % @headings off         turns them off.
2153 % @headings on          same as @headings double, retained for compatibility.
2154 % @headings after       turns on double-sided headings after this page.
2155 % @headings doubleafter turns on double-sided headings after this page.
2156 % @headings singleafter turns on single-sided headings after this page.
2157 % By default, they are off at the start of a document,
2158 % and turned `on' after @end titlepage.
2159
2160 \def\headings #1 {\csname HEADINGS#1\endcsname}
2161
2162 \def\HEADINGSoff{%
2163 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2164 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2165 \HEADINGSoff
2166 % When we turn headings on, set the page number to 1.
2167 % For double-sided printing, put current file name in lower left corner,
2168 % chapter name on inside top of right hand pages, document
2169 % title on inside top of left hand pages, and page numbers on outside top
2170 % edge of all pages.
2171 \def\HEADINGSdouble{%
2172 \global\pageno=1
2173 \global\evenfootline={\hfil}
2174 \global\oddfootline={\hfil}
2175 \global\evenheadline={\line{\folio\hfil\thistitle}}
2176 \global\oddheadline={\line{\thischapter\hfil\folio}}
2177 \global\let\contentsalignmacro = \chapoddpage
2178 }
2179 \let\contentsalignmacro = \chappager
2180
2181 % For single-sided printing, chapter title goes across top left of page,
2182 % page number on top right.
2183 \def\HEADINGSsingle{%
2184 \global\pageno=1
2185 \global\evenfootline={\hfil}
2186 \global\oddfootline={\hfil}
2187 \global\evenheadline={\line{\thischapter\hfil\folio}}
2188 \global\oddheadline={\line{\thischapter\hfil\folio}}
2189 \global\let\contentsalignmacro = \chappager
2190 }
2191 \def\HEADINGSon{\HEADINGSdouble}
2192
2193 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2194 \let\HEADINGSdoubleafter=\HEADINGSafter
2195 \def\HEADINGSdoublex{%
2196 \global\evenfootline={\hfil}
2197 \global\oddfootline={\hfil}
2198 \global\evenheadline={\line{\folio\hfil\thistitle}}
2199 \global\oddheadline={\line{\thischapter\hfil\folio}}
2200 \global\let\contentsalignmacro = \chapoddpage
2201 }
2202
2203 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2204 \def\HEADINGSsinglex{%
2205 \global\evenfootline={\hfil}
2206 \global\oddfootline={\hfil}
2207 \global\evenheadline={\line{\thischapter\hfil\folio}}
2208 \global\oddheadline={\line{\thischapter\hfil\folio}}
2209 \global\let\contentsalignmacro = \chappager
2210 }
2211
2212 % Subroutines used in generating headings
2213 % This produces Day Month Year style of output.
2214 % Only define if not already defined, in case a txi-??.tex file has set
2215 % up a different format (e.g., txi-cs.tex does this).
2216 \ifx\today\undefined
2217 \def\today{%
2218   \number\day\space
2219   \ifcase\month
2220   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2221   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2222   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2223   \fi
2224   \space\number\year}
2225 \fi
2226
2227 % @settitle line...  specifies the title of the document, for headings.
2228 % It generates no output of its own.
2229 \def\thistitle{\putwordNoTitle}
2230 \def\settitle{\parsearg{\gdef\thistitle}}
2231
2232
2233 \message{tables,}
2234 % Tables -- @table, @ftable, @vtable, @item(x).
2235
2236 % default indentation of table text
2237 \newdimen\tableindent \tableindent=.8in
2238 % default indentation of @itemize and @enumerate text
2239 \newdimen\itemindent  \itemindent=.3in
2240 % margin between end of table item and start of table text.
2241 \newdimen\itemmargin  \itemmargin=.1in
2242
2243 % used internally for \itemindent minus \itemmargin
2244 \newdimen\itemmax
2245
2246 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2247 % these defs.
2248 % They also define \itemindex
2249 % to index the item name in whatever manner is desired (perhaps none).
2250
2251 \newif\ifitemxneedsnegativevskip
2252
2253 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2254
2255 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2256 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2257
2258 \def\itemzzz #1{\begingroup %
2259   \advance\hsize by -\rightskip
2260   \advance\hsize by -\tableindent
2261   \setbox0=\hbox{\itemindicate{#1}}%
2262   \itemindex{#1}%
2263   \nobreak % This prevents a break before @itemx.
2264   %
2265   % If the item text does not fit in the space we have, put it on a line
2266   % by itself, and do not allow a page break either before or after that
2267   % line.  We do not start a paragraph here because then if the next
2268   % command is, e.g., @kindex, the whatsit would get put into the
2269   % horizontal list on a line by itself, resulting in extra blank space.
2270   \ifdim \wd0>\itemmax
2271     %
2272     % Make this a paragraph so we get the \parskip glue and wrapping,
2273     % but leave it ragged-right.
2274     \begingroup
2275       \advance\leftskip by-\tableindent
2276       \advance\hsize by\tableindent
2277       \advance\rightskip by0pt plus1fil
2278       \leavevmode\unhbox0\par
2279     \endgroup
2280     %
2281     % We're going to be starting a paragraph, but we don't want the
2282     % \parskip glue -- logically it's part of the @item we just started.
2283     \nobreak \vskip-\parskip
2284     %
2285     % Stop a page break at the \parskip glue coming up.  However, if
2286     % what follows is an environment such as @example, there will be no
2287     % \parskip glue; then the negative vskip we just inserted would
2288     % cause the example and the item to crash together.  So we use this
2289     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2290     % \parskip glue after all.  Section titles are handled this way also.
2291     % 
2292     \penalty 10001
2293     \endgroup
2294     \itemxneedsnegativevskipfalse
2295   \else
2296     % The item text fits into the space.  Start a paragraph, so that the
2297     % following text (if any) will end up on the same line.
2298     \noindent
2299     % Do this with kerns and \unhbox so that if there is a footnote in
2300     % the item text, it can migrate to the main vertical list and
2301     % eventually be printed.
2302     \nobreak\kern-\tableindent
2303     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2304     \unhbox0
2305     \nobreak\kern\dimen0
2306     \endgroup
2307     \itemxneedsnegativevskiptrue
2308   \fi
2309 }
2310
2311 \def\item{\errmessage{@item while not in a list environment}}
2312 \def\itemx{\errmessage{@itemx while not in a list environment}}
2313
2314 % @table, @ftable, @vtable.
2315 \envdef\table{%
2316   \let\itemindex\gobble
2317   \tablecheck{table}%
2318 }
2319 \envdef\ftable{%
2320   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2321   \tablecheck{ftable}%
2322 }
2323 \envdef\vtable{%
2324   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2325   \tablecheck{vtable}%
2326 }
2327 \def\tablecheck#1{%
2328   \ifnum \the\catcode`\^^M=\active
2329     \endgroup
2330     \errmessage{This command won't work in this context; perhaps the problem is
2331       that we are \inenvironment\thisenv}%
2332     \def\next{\doignore{#1}}%
2333   \else
2334     \let\next\tablex
2335   \fi
2336   \next
2337 }
2338 \def\tablex#1{%
2339   \def\itemindicate{#1}%
2340   \parsearg\tabley
2341 }
2342 \def\tabley#1{%
2343   {%
2344     \makevalueexpandable
2345     \edef\temp{\noexpand\tablez #1\space\space\space}%
2346     \expandafter
2347   }\temp \endtablez
2348 }
2349 \def\tablez #1 #2 #3 #4\endtablez{%
2350   \aboveenvbreak
2351   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2352   \ifnum 0#2>0 \tableindent=#2\mil \fi
2353   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2354   \itemmax=\tableindent
2355   \advance \itemmax by -\itemmargin
2356   \advance \leftskip by \tableindent
2357   \exdentamount=\tableindent
2358   \parindent = 0pt
2359   \parskip = \smallskipamount
2360   \ifdim \parskip=0pt \parskip=2pt \fi
2361   \let\item = \internalBitem
2362   \let\itemx = \internalBitemx
2363 }
2364 \def\Etable{\endgraf\afterenvbreak}
2365 \let\Eftable\Etable
2366 \let\Evtable\Etable
2367 \let\Eitemize\Etable
2368 \let\Eenumerate\Etable
2369
2370 % This is the counter used by @enumerate, which is really @itemize
2371
2372 \newcount \itemno
2373
2374 \envdef\itemize{\parsearg\doitemize}
2375
2376 \def\doitemize#1{%
2377   \aboveenvbreak
2378   \itemmax=\itemindent
2379   \advance\itemmax by -\itemmargin
2380   \advance\leftskip by \itemindent
2381   \exdentamount=\itemindent
2382   \parindent=0pt
2383   \parskip=\smallskipamount
2384   \ifdim\parskip=0pt \parskip=2pt \fi
2385   \def\itemcontents{#1}%
2386   % @itemize with no arg is equivalent to @itemize @bullet.
2387   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2388   \let\item=\itemizeitem
2389 }
2390
2391 % Definition of @item while inside @itemize and @enumerate.
2392 %
2393 \def\itemizeitem{%
2394   \advance\itemno by 1  % for enumerations
2395   {\let\par=\endgraf \smallbreak}% reasonable place to break
2396   {%
2397    % If the document has an @itemize directly after a section title, a
2398    % \nobreak will be last on the list, and \sectionheading will have
2399    % done a \vskip-\parskip.  In that case, we don't want to zero
2400    % parskip, or the item text will crash with the heading.  On the
2401    % other hand, when there is normal text preceding the item (as there
2402    % usually is), we do want to zero parskip, or there would be too much
2403    % space.  In that case, we won't have a \nobreak before.  At least
2404    % that's the theory.
2405    \ifnum\lastpenalty<10000 \parskip=0in \fi
2406    \noindent
2407    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2408    \vadjust{\penalty 1200}}% not good to break after first line of item.
2409   \flushcr
2410 }
2411
2412 % \splitoff TOKENS\endmark defines \first to be the first token in
2413 % TOKENS, and \rest to be the remainder.
2414 %
2415 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2416
2417 % Allow an optional argument of an uppercase letter, lowercase letter,
2418 % or number, to specify the first label in the enumerated list.  No
2419 % argument is the same as `1'.
2420 %
2421 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
2422 \def\enumeratey #1 #2\endenumeratey{%
2423   % If we were given no argument, pretend we were given `1'.
2424   \def\thearg{#1}%
2425   \ifx\thearg\empty \def\thearg{1}\fi
2426   %
2427   % Detect if the argument is a single token.  If so, it might be a
2428   % letter.  Otherwise, the only valid thing it can be is a number.
2429   % (We will always have one token, because of the test we just made.
2430   % This is a good thing, since \splitoff doesn't work given nothing at
2431   % all -- the first parameter is undelimited.)
2432   \expandafter\splitoff\thearg\endmark
2433   \ifx\rest\empty
2434     % Only one token in the argument.  It could still be anything.
2435     % A ``lowercase letter'' is one whose \lccode is nonzero.
2436     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2437     %   not equal to itself.
2438     % Otherwise, we assume it's a number.
2439     %
2440     % We need the \relax at the end of the \ifnum lines to stop TeX from
2441     % continuing to look for a <number>.
2442     %
2443     \ifnum\lccode\expandafter`\thearg=0\relax
2444       \numericenumerate % a number (we hope)
2445     \else
2446       % It's a letter.
2447       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2448         \lowercaseenumerate % lowercase letter
2449       \else
2450         \uppercaseenumerate % uppercase letter
2451       \fi
2452     \fi
2453   \else
2454     % Multiple tokens in the argument.  We hope it's a number.
2455     \numericenumerate
2456   \fi
2457 }
2458
2459 % An @enumerate whose labels are integers.  The starting integer is
2460 % given in \thearg.
2461 %
2462 \def\numericenumerate{%
2463   \itemno = \thearg
2464   \startenumeration{\the\itemno}%
2465 }
2466
2467 % The starting (lowercase) letter is in \thearg.
2468 \def\lowercaseenumerate{%
2469   \itemno = \expandafter`\thearg
2470   \startenumeration{%
2471     % Be sure we're not beyond the end of the alphabet.
2472     \ifnum\itemno=0
2473       \errmessage{No more lowercase letters in @enumerate; get a bigger
2474                   alphabet}%
2475     \fi
2476     \char\lccode\itemno
2477   }%
2478 }
2479
2480 % The starting (uppercase) letter is in \thearg.
2481 \def\uppercaseenumerate{%
2482   \itemno = \expandafter`\thearg
2483   \startenumeration{%
2484     % Be sure we're not beyond the end of the alphabet.
2485     \ifnum\itemno=0
2486       \errmessage{No more uppercase letters in @enumerate; get a bigger
2487                   alphabet}
2488     \fi
2489     \char\uccode\itemno
2490   }%
2491 }
2492
2493 % Call \doitemize, adding a period to the first argument and supplying the
2494 % common last two arguments.  Also subtract one from the initial value in
2495 % \itemno, since @item increments \itemno.
2496 %
2497 \def\startenumeration#1{%
2498   \advance\itemno by -1
2499   \doitemize{#1.}\flushcr
2500 }
2501
2502 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2503 % to @enumerate.
2504 %
2505 \def\alphaenumerate{\enumerate{a}}
2506 \def\capsenumerate{\enumerate{A}}
2507 \def\Ealphaenumerate{\Eenumerate}
2508 \def\Ecapsenumerate{\Eenumerate}
2509
2510
2511 % @multitable macros
2512 % Amy Hendrickson, 8/18/94, 3/6/96
2513 %
2514 % @multitable ... @end multitable will make as many columns as desired.
2515 % Contents of each column will wrap at width given in preamble.  Width
2516 % can be specified either with sample text given in a template line,
2517 % or in percent of \hsize, the current width of text on page.
2518
2519 % Table can continue over pages but will only break between lines.
2520
2521 % To make preamble:
2522 %
2523 % Either define widths of columns in terms of percent of \hsize:
2524 %   @multitable @columnfractions .25 .3 .45
2525 %   @item ...
2526 %
2527 %   Numbers following @columnfractions are the percent of the total
2528 %   current hsize to be used for each column. You may use as many
2529 %   columns as desired.
2530
2531
2532 % Or use a template:
2533 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2534 %   @item ...
2535 %   using the widest term desired in each column.
2536
2537 % Each new table line starts with @item, each subsequent new column
2538 % starts with @tab. Empty columns may be produced by supplying @tab's
2539 % with nothing between them for as many times as empty columns are needed,
2540 % ie, @tab@tab@tab will produce two empty columns.
2541
2542 % @item, @tab do not need to be on their own lines, but it will not hurt
2543 % if they are.
2544
2545 % Sample multitable:
2546
2547 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2548 %   @item first col stuff @tab second col stuff @tab third col
2549 %   @item
2550 %   first col stuff
2551 %   @tab
2552 %   second col stuff
2553 %   @tab
2554 %   third col
2555 %   @item first col stuff @tab second col stuff
2556 %   @tab Many paragraphs of text may be used in any column.
2557 %
2558 %         They will wrap at the width determined by the template.
2559 %   @item@tab@tab This will be in third column.
2560 %   @end multitable
2561
2562 % Default dimensions may be reset by user.
2563 % @multitableparskip is vertical space between paragraphs in table.
2564 % @multitableparindent is paragraph indent in table.
2565 % @multitablecolmargin is horizontal space to be left between columns.
2566 % @multitablelinespace is space to leave between table items, baseline
2567 %                                                            to baseline.
2568 %   0pt means it depends on current normal line spacing.
2569 %
2570 \newskip\multitableparskip
2571 \newskip\multitableparindent
2572 \newdimen\multitablecolspace
2573 \newskip\multitablelinespace
2574 \multitableparskip=0pt
2575 \multitableparindent=6pt
2576 \multitablecolspace=12pt
2577 \multitablelinespace=0pt
2578
2579 % Macros used to set up halign preamble:
2580 %
2581 \let\endsetuptable\relax
2582 \def\xendsetuptable{\endsetuptable}
2583 \let\columnfractions\relax
2584 \def\xcolumnfractions{\columnfractions}
2585 \newif\ifsetpercent
2586
2587 % #1 is the @columnfraction, usually a decimal number like .5, but might
2588 % be just 1.  We just use it, whatever it is.
2589 %
2590 \def\pickupwholefraction#1 {%
2591   \global\advance\colcount by 1
2592   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2593   \setuptable
2594 }
2595
2596 \newcount\colcount
2597 \def\setuptable#1{%
2598   \def\firstarg{#1}%
2599   \ifx\firstarg\xendsetuptable
2600     \let\go = \relax
2601   \else
2602     \ifx\firstarg\xcolumnfractions
2603       \global\setpercenttrue
2604     \else
2605       \ifsetpercent
2606          \let\go\pickupwholefraction
2607       \else
2608          \global\advance\colcount by 1
2609          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2610                    % separator; typically that is always in the input, anyway.
2611          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2612       \fi
2613     \fi
2614     \ifx\go\pickupwholefraction
2615       % Put the argument back for the \pickupwholefraction call, so
2616       % we'll always have a period there to be parsed.
2617       \def\go{\pickupwholefraction#1}%
2618     \else
2619       \let\go = \setuptable
2620     \fi%
2621   \fi
2622   \go
2623 }
2624
2625 % multitable-only commands.
2626 %
2627 % @headitem starts a heading row, which we typeset in bold.
2628 % Assignments have to be global since we are inside the implicit group
2629 % of an alignment entry.  Note that \everycr resets \everytab.
2630 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2631 %
2632 % A \tab used to include \hskip1sp.  But then the space in a template
2633 % line is not enough.  That is bad.  So let's go back to just `&' until
2634 % we encounter the problem it was intended to solve again.
2635 %                                       --karl, nathan@acm.org, 20apr99.
2636 \def\tab{\checkenv\multitable &\the\everytab}%
2637
2638 % @multitable ... @end multitable definitions:
2639 %
2640 \newtoks\everytab  % insert after every tab.
2641 %
2642 \envdef\multitable{%
2643   \vskip\parskip
2644   \startsavinginserts
2645   %
2646   % @item within a multitable starts a normal row.
2647   % We use \def instead of \let so that if one of the multitable entries
2648   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2649   % \endtemplate) expanding \doitemize.
2650   \def\item{\crcr}%
2651   %
2652   \tolerance=9500
2653   \hbadness=9500
2654   \setmultitablespacing
2655   \parskip=\multitableparskip
2656   \parindent=\multitableparindent
2657   \overfullrule=0pt
2658   \global\colcount=0
2659   %
2660   \everycr = {%
2661     \noalign{%
2662       \global\everytab={}%
2663       \global\colcount=0 % Reset the column counter.
2664       % Check for saved footnotes, etc.
2665       \checkinserts
2666       % Keeps underfull box messages off when table breaks over pages.
2667       %\filbreak
2668         % Maybe so, but it also creates really weird page breaks when the
2669         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
2670         % problem manifests itself, so it can be fixed for real --karl.
2671     }%
2672   }%
2673   %
2674   \parsearg\domultitable
2675 }
2676 \def\domultitable#1{%
2677   % To parse everything between @multitable and @item:
2678   \setuptable#1 \endsetuptable
2679   %
2680   % This preamble sets up a generic column definition, which will
2681   % be used as many times as user calls for columns.
2682   % \vtop will set a single line and will also let text wrap and
2683   % continue for many paragraphs if desired.
2684   \halign\bgroup &%
2685     \global\advance\colcount by 1
2686     \multistrut
2687     \vtop{%
2688       % Use the current \colcount to find the correct column width:
2689       \hsize=\expandafter\csname col\the\colcount\endcsname
2690       %
2691       % In order to keep entries from bumping into each other
2692       % we will add a \leftskip of \multitablecolspace to all columns after
2693       % the first one.
2694       %
2695       % If a template has been used, we will add \multitablecolspace
2696       % to the width of each template entry.
2697       %
2698       % If the user has set preamble in terms of percent of \hsize we will
2699       % use that dimension as the width of the column, and the \leftskip
2700       % will keep entries from bumping into each other.  Table will start at
2701       % left margin and final column will justify at right margin.
2702       %
2703       % Make sure we don't inherit \rightskip from the outer environment.
2704       \rightskip=0pt
2705       \ifnum\colcount=1
2706         % The first column will be indented with the surrounding text.
2707         \advance\hsize by\leftskip
2708       \else
2709         \ifsetpercent \else
2710           % If user has not set preamble in terms of percent of \hsize
2711           % we will advance \hsize by \multitablecolspace.
2712           \advance\hsize by \multitablecolspace
2713         \fi
2714        % In either case we will make \leftskip=\multitablecolspace:
2715       \leftskip=\multitablecolspace
2716       \fi
2717       % Ignoring space at the beginning and end avoids an occasional spurious
2718       % blank line, when TeX decides to break the line at the space before the
2719       % box from the multistrut, so the strut ends up on a line by itself.
2720       % For example:
2721       % @multitable @columnfractions .11 .89
2722       % @item @code{#}
2723       % @tab Legal holiday which is valid in major parts of the whole country.
2724       % Is automatically provided with highlighting sequences respectively
2725       % marking characters.
2726       \noindent\ignorespaces##\unskip\multistrut
2727     }\cr
2728 }
2729 \def\Emultitable{%
2730   \crcr
2731   \egroup % end the \halign
2732   \global\setpercentfalse
2733 }
2734
2735 \def\setmultitablespacing{%
2736   \def\multistrut{\strut}% just use the standard line spacing
2737   %
2738   % Compute \multitablelinespace (if not defined by user) for use in
2739   % \multitableparskip calculation.  We used define \multistrut based on
2740   % this, but (ironically) that caused the spacing to be off.
2741   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2742 \ifdim\multitablelinespace=0pt
2743 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2744 \global\advance\multitablelinespace by-\ht0
2745 \fi
2746 %% Test to see if parskip is larger than space between lines of
2747 %% table. If not, do nothing.
2748 %%        If so, set to same dimension as multitablelinespace.
2749 \ifdim\multitableparskip>\multitablelinespace
2750 \global\multitableparskip=\multitablelinespace
2751 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2752                                       %% than skip between lines in the table.
2753 \fi%
2754 \ifdim\multitableparskip=0pt
2755 \global\multitableparskip=\multitablelinespace
2756 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2757                                       %% than skip between lines in the table.
2758 \fi}
2759
2760
2761 \message{conditionals,}
2762
2763 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2764 % @ifnotxml always succeed.  They currently do nothing; we don't
2765 % attempt to check whether the conditionals are properly nested.  But we
2766 % have to remember that they are conditionals, so that @end doesn't
2767 % attempt to close an environment group.
2768 %
2769 \def\makecond#1{%
2770   \expandafter\let\csname #1\endcsname = \relax
2771   \expandafter\let\csname iscond.#1\endcsname = 1
2772 }
2773 \makecond{iftex}
2774 \makecond{ifnotdocbook}
2775 \makecond{ifnothtml}
2776 \makecond{ifnotinfo}
2777 \makecond{ifnotplaintext}
2778 \makecond{ifnotxml}
2779
2780 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2781 %
2782 \def\direntry{\doignore{direntry}}
2783 \def\documentdescription{\doignore{documentdescription}}
2784 \def\docbook{\doignore{docbook}}
2785 \def\html{\doignore{html}}
2786 \def\ifdocbook{\doignore{ifdocbook}}
2787 \def\ifhtml{\doignore{ifhtml}}
2788 \def\ifinfo{\doignore{ifinfo}}
2789 \def\ifnottex{\doignore{ifnottex}}
2790 \def\ifplaintext{\doignore{ifplaintext}}
2791 \def\ifxml{\doignore{ifxml}}
2792 \def\ignore{\doignore{ignore}}
2793 \def\menu{\doignore{menu}}
2794 \def\xml{\doignore{xml}}
2795
2796 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2797 %
2798 % A count to remember the depth of nesting.
2799 \newcount\doignorecount
2800
2801 \def\doignore#1{\begingroup
2802   % Scan in ``verbatim'' mode:
2803   \catcode`\@ = \other
2804   \catcode`\{ = \other
2805   \catcode`\} = \other
2806   %
2807   % Make sure that spaces turn into tokens that match what \doignoretext wants.
2808   \spaceisspace
2809   %
2810   % Count number of #1's that we've seen.
2811   \doignorecount = 0
2812   %
2813   % Swallow text until we reach the matching `@end #1'.
2814   \dodoignore{#1}%
2815 }
2816
2817 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2818   \obeylines %
2819   %
2820   \gdef\dodoignore#1{%
2821     % #1 contains the command name as a string, e.g., `ifinfo'.
2822     %
2823     % Define a command to find the next `@end #1', which must be on a line
2824     % by itself.
2825     \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2826     % And this command to find another #1 command, at the beginning of a
2827     % line.  (Otherwise, we would consider a line `@c @ifset', for
2828     % example, to count as an @ifset for nesting.)
2829     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2830     %
2831     % And now expand that command.
2832     \obeylines %
2833     \doignoretext ^^M%
2834   }%
2835 }
2836
2837 \def\doignoreyyy#1{%
2838   \def\temp{#1}%
2839   \ifx\temp\empty                       % Nothing found.
2840     \let\next\doignoretextzzz
2841   \else                                 % Found a nested condition, ...
2842     \advance\doignorecount by 1
2843     \let\next\doignoretextyyy           % ..., look for another.
2844     % If we're here, #1 ends with ^^M\ifinfo (for example).
2845   \fi
2846   \next #1% the token \_STOP_ is present just after this macro.
2847 }
2848
2849 % We have to swallow the remaining "\_STOP_".
2850 %
2851 \def\doignoretextzzz#1{%
2852   \ifnum\doignorecount = 0      % We have just found the outermost @end.
2853     \let\next\enddoignore
2854   \else                         % Still inside a nested condition.
2855     \advance\doignorecount by -1
2856     \let\next\doignoretext      % Look for the next @end.
2857   \fi
2858   \next
2859 }
2860
2861 % Finish off ignored text.
2862 \def\enddoignore{\endgroup\ignorespaces}
2863
2864
2865 % @set VAR sets the variable VAR to an empty value.
2866 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2867 %
2868 % Since we want to separate VAR from REST-OF-LINE (which might be
2869 % empty), we can't just use \parsearg; we have to insert a space of our
2870 % own to delimit the rest of the line, and then take it out again if we
2871 % didn't need it.
2872 % We rely on the fact that \parsearg sets \catcode`\ =10.
2873 %
2874 \parseargdef\set{\setyyy#1 \endsetyyy}
2875 \def\setyyy#1 #2\endsetyyy{%
2876   {%
2877     \makevalueexpandable
2878     \def\temp{#2}%
2879     \edef\next{\gdef\makecsname{SET#1}}%
2880     \ifx\temp\empty
2881       \next{}%
2882     \else
2883       \setzzz#2\endsetzzz
2884     \fi
2885   }%
2886 }
2887 % Remove the trailing space \setxxx inserted.
2888 \def\setzzz#1 \endsetzzz{\next{#1}}
2889
2890 % @clear VAR clears (i.e., unsets) the variable VAR.
2891 %
2892 \parseargdef\clear{%
2893   {%
2894     \makevalueexpandable
2895     \global\expandafter\let\csname SET#1\endcsname=\relax
2896   }%
2897 }
2898
2899 % @value{foo} gets the text saved in variable foo.
2900 \def\value{\begingroup\makevalueexpandable\valuexxx}
2901 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2902 {
2903   \catcode`\- = \active \catcode`\_ = \active
2904   %
2905   \gdef\makevalueexpandable{%
2906     \let\value = \expandablevalue
2907     % We don't want these characters active, ...
2908     \catcode`\-=\other \catcode`\_=\other
2909     % ..., but we might end up with active ones in the argument if
2910     % we're called from @code, as @code{@value{foo-bar_}}, though.
2911     % So \let them to their normal equivalents.
2912     \let-\realdash \let_\normalunderscore
2913   }
2914 }
2915
2916 % We have this subroutine so that we can handle at least some @value's
2917 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2918 % The command has to be fully expandable (if the variable is set), since
2919 % the result winds up in the index file.  This means that if the
2920 % variable's value contains other Texinfo commands, it's almost certain
2921 % it will fail (although perhaps we could fix that with sufficient work
2922 % to do a one-level expansion on the result, instead of complete).
2923 %
2924 \def\expandablevalue#1{%
2925   \expandafter\ifx\csname SET#1\endcsname\relax
2926     {[No value for ``#1'']}%
2927     \message{Variable `#1', used in @value, is not set.}%
2928   \else
2929     \csname SET#1\endcsname
2930   \fi
2931 }
2932
2933 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2934 % with @set.
2935 %
2936 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2937 %
2938 \makecond{ifset}
2939 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
2940 \def\doifset#1#2{%
2941   {%
2942     \makevalueexpandable
2943     \let\next=\empty
2944     \expandafter\ifx\csname SET#2\endcsname\relax
2945       #1% If not set, redefine \next.
2946     \fi
2947     \expandafter
2948   }\next
2949 }
2950 \def\ifsetfail{\doignore{ifset}}
2951
2952 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2953 % defined with @set, or has been undefined with @clear.
2954 %
2955 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2956 % above code: if the variable is not set, do nothing, if it is set,
2957 % then redefine \next to \ifclearfail.
2958 %
2959 \makecond{ifclear}
2960 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
2961 \def\ifclearfail{\doignore{ifclear}}
2962
2963 % @dircategory CATEGORY  -- specify a category of the dir file
2964 % which this file should belong to.  Ignore this in TeX.
2965 \let\dircategory=\comment
2966
2967 % @defininfoenclose.
2968 \let\definfoenclose=\comment
2969
2970
2971 \message{indexing,}
2972 % Index generation facilities
2973
2974 % Define \newwrite to be identical to plain tex's \newwrite
2975 % except not \outer, so it can be used within \newindex.
2976 {\catcode`\@=11
2977 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2978
2979 % \newindex {foo} defines an index named foo.
2980 % It automatically defines \fooindex such that
2981 % \fooindex ...rest of line... puts an entry in the index foo.
2982 % It also defines \fooindfile to be the number of the output channel for
2983 % the file that accumulates this index.  The file's extension is foo.
2984 % The name of an index should be no more than 2 characters long
2985 % for the sake of vms.
2986 %
2987 \def\newindex#1{%
2988   \iflinks
2989     \expandafter\newwrite \csname#1indfile\endcsname
2990     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2991   \fi
2992   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
2993     \noexpand\doindex{#1}}
2994 }
2995
2996 % @defindex foo  ==  \newindex{foo}
2997 %
2998 \def\defindex{\parsearg\newindex}
2999
3000 % Define @defcodeindex, like @defindex except put all entries in @code.
3001 %
3002 \def\defcodeindex{\parsearg\newcodeindex}
3003 %
3004 \def\newcodeindex#1{%
3005   \iflinks
3006     \expandafter\newwrite \csname#1indfile\endcsname
3007     \openout \csname#1indfile\endcsname \jobname.#1
3008   \fi
3009   \expandafter\xdef\csname#1index\endcsname{%
3010     \noexpand\docodeindex{#1}}%
3011 }
3012
3013
3014 % @synindex foo bar    makes index foo feed into index bar.
3015 % Do this instead of @defindex foo if you don't want it as a separate index.
3016 %
3017 % @syncodeindex foo bar   similar, but put all entries made for index foo
3018 % inside @code.
3019 %
3020 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3021 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3022
3023 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3024 % #3 the target index (bar).
3025 \def\dosynindex#1#2#3{%
3026   % Only do \closeout if we haven't already done it, else we'll end up
3027   % closing the target index.
3028   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3029     % The \closeout helps reduce unnecessary open files; the limit on the
3030     % Acorn RISC OS is a mere 16 files.
3031     \expandafter\closeout\csname#2indfile\endcsname
3032     \expandafter\let\csname\donesynindex#2\endcsname = 1
3033   \fi
3034   % redefine \fooindfile:
3035   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3036   \expandafter\let\csname#2indfile\endcsname=\temp
3037   % redefine \fooindex:
3038   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3039 }
3040
3041 % Define \doindex, the driver for all \fooindex macros.
3042 % Argument #1 is generated by the calling \fooindex macro,
3043 %  and it is "foo", the name of the index.
3044
3045 % \doindex just uses \parsearg; it calls \doind for the actual work.
3046 % This is because \doind is more useful to call from other macros.
3047
3048 % There is also \dosubind {index}{topic}{subtopic}
3049 % which makes an entry in a two-level index such as the operation index.
3050
3051 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3052 \def\singleindexer #1{\doind{\indexname}{#1}}
3053
3054 % like the previous two, but they put @code around the argument.
3055 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3056 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3057
3058 % Take care of Texinfo commands that can appear in an index entry.
3059 % Since there are some commands we want to expand, and others we don't,
3060 % we have to laboriously prevent expansion for those that we don't.
3061 %
3062 \def\indexdummies{%
3063   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3064   \def\ {\realbackslash\space }%
3065   % Need these in case \tex is in effect and \{ is a \delimiter again.
3066   % But can't use \lbracecmd and \rbracecmd because texindex assumes
3067   % braces and backslashes are used only as delimiters.
3068   \let\{ = \mylbrace
3069   \let\} = \myrbrace
3070   %
3071   % \definedummyword defines \#1 as \realbackslash #1\space, thus
3072   % effectively preventing its expansion.  This is used only for control
3073   % words, not control letters, because the \space would be incorrect
3074   % for control characters, but is needed to separate the control word
3075   % from whatever follows.
3076   %
3077   % For control letters, we have \definedummyletter, which omits the
3078   % space.
3079   %
3080   % These can be used both for control words that take an argument and
3081   % those that do not.  If it is followed by {arg} in the input, then
3082   % that will dutifully get written to the index (or wherever).
3083   %
3084   \def\definedummyword##1{%
3085     \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3086   }%
3087   \def\definedummyletter##1{%
3088     \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3089   }%
3090   \let\definedummyaccent\definedummyletter
3091   %
3092   % Do the redefinitions.
3093   \commondummies
3094 }
3095
3096 % For the aux file, @ is the escape character.  So we want to redefine
3097 % everything using @ instead of \realbackslash.  When everything uses
3098 % @, this will be simpler.
3099 %
3100 \def\atdummies{%
3101   \def\@{@@}%
3102   \def\ {@ }%
3103   \let\{ = \lbraceatcmd
3104   \let\} = \rbraceatcmd
3105   %
3106   % (See comments in \indexdummies.)
3107   \def\definedummyword##1{%
3108     \expandafter\def\csname ##1\endcsname{@##1\space}%
3109   }%
3110   \def\definedummyletter##1{%
3111     \expandafter\def\csname ##1\endcsname{@##1}%
3112   }%
3113   \let\definedummyaccent\definedummyletter
3114   %
3115   % Do the redefinitions.
3116   \commondummies
3117 }
3118
3119 % Called from \indexdummies and \atdummies.  \definedummyword and
3120 % \definedummyletter must be defined first.
3121 %
3122 \def\commondummies{%
3123   %
3124   \normalturnoffactive
3125   %
3126   \commondummiesnofonts
3127   %
3128   \definedummyletter{_}%
3129   %
3130   % Non-English letters.
3131   \definedummyword{AA}%
3132   \definedummyword{AE}%
3133   \definedummyword{L}%
3134   \definedummyword{OE}%
3135   \definedummyword{O}%
3136   \definedummyword{aa}%
3137   \definedummyword{ae}%
3138   \definedummyword{l}%
3139   \definedummyword{oe}%
3140   \definedummyword{o}%
3141   \definedummyword{ss}%
3142   \definedummyword{exclamdown}%
3143   \definedummyword{questiondown}%
3144   \definedummyword{ordf}%
3145   \definedummyword{ordm}%
3146   %
3147   % Although these internal commands shouldn't show up, sometimes they do.
3148   \definedummyword{bf}%
3149   \definedummyword{gtr}%
3150   \definedummyword{hat}%
3151   \definedummyword{less}%
3152   \definedummyword{sf}%
3153   \definedummyword{sl}%
3154   \definedummyword{tclose}%
3155   \definedummyword{tt}%
3156   %
3157   \definedummyword{LaTeX}%
3158   \definedummyword{TeX}%
3159   %
3160   % Assorted special characters.
3161   \definedummyword{bullet}%
3162   \definedummyword{comma}%
3163   \definedummyword{copyright}%
3164   \definedummyword{registeredsymbol}%
3165   \definedummyword{dots}%
3166   \definedummyword{enddots}%
3167   \definedummyword{equiv}%
3168   \definedummyword{error}%
3169   \definedummyword{expansion}%
3170   \definedummyword{minus}%
3171   \definedummyword{pounds}%
3172   \definedummyword{point}%
3173   \definedummyword{print}%
3174   \definedummyword{result}%
3175   %
3176   % Handle some cases of @value -- where it does not contain any
3177   % (non-fully-expandable) commands.
3178   \makevalueexpandable
3179   %
3180   % Normal spaces, not active ones.
3181   \unsepspaces
3182   %
3183   % No macro expansion.
3184   \turnoffmacros
3185 }
3186
3187 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3188 %
3189 % Better have this without active chars.
3190 {
3191   \catcode`\~=\other
3192   \gdef\commondummiesnofonts{%
3193     % Control letters and accents.
3194     \definedummyletter{!}%
3195     \definedummyaccent{"}%
3196     \definedummyaccent{'}%
3197     \definedummyletter{*}%
3198     \definedummyaccent{,}%
3199     \definedummyletter{.}%
3200     \definedummyletter{/}%
3201     \definedummyletter{:}%
3202     \definedummyaccent{=}%
3203     \definedummyletter{?}%
3204     \definedummyaccent{^}%
3205     \definedummyaccent{`}%
3206     \definedummyaccent{~}%
3207     \definedummyword{u}%
3208     \definedummyword{v}%
3209     \definedummyword{H}%
3210     \definedummyword{dotaccent}%
3211     \definedummyword{ringaccent}%
3212     \definedummyword{tieaccent}%
3213     \definedummyword{ubaraccent}%
3214     \definedummyword{udotaccent}%
3215     \definedummyword{dotless}%
3216     %
3217     % Texinfo font commands.
3218     \definedummyword{b}%
3219     \definedummyword{i}%
3220     \definedummyword{r}%
3221     \definedummyword{sc}%
3222     \definedummyword{t}%
3223     %
3224     % Commands that take arguments.
3225     \definedummyword{acronym}%
3226     \definedummyword{cite}%
3227     \definedummyword{code}%
3228     \definedummyword{command}%
3229     \definedummyword{dfn}%
3230     \definedummyword{emph}%
3231     \definedummyword{env}%
3232     \definedummyword{file}%
3233     \definedummyword{kbd}%
3234     \definedummyword{key}%
3235     \definedummyword{math}%
3236     \definedummyword{option}%
3237     \definedummyword{samp}%
3238     \definedummyword{strong}%
3239     \definedummyword{tie}%
3240     \definedummyword{uref}%
3241     \definedummyword{url}%
3242     \definedummyword{var}%
3243     \definedummyword{verb}%
3244     \definedummyword{w}%
3245   }
3246 }
3247
3248 % \indexnofonts is used when outputting the strings to sort the index
3249 % by, and when constructing control sequence names.  It eliminates all
3250 % control sequences and just writes whatever the best ASCII sort string
3251 % would be for a given command (usually its argument).
3252 %
3253 \def\indexnofonts{%
3254   % Accent commands should become @asis.
3255   \def\definedummyaccent##1{%
3256     \expandafter\let\csname ##1\endcsname\asis
3257   }%
3258   % We can just ignore other control letters.
3259   \def\definedummyletter##1{%
3260     \expandafter\def\csname ##1\endcsname{}%
3261   }%
3262   % Hopefully, all control words can become @asis.
3263   \let\definedummyword\definedummyaccent
3264   %
3265   \commondummiesnofonts
3266   %
3267   % Don't no-op \tt, since it isn't a user-level command
3268   % and is used in the definitions of the active chars like <, >, |, etc.
3269   % Likewise with the other plain tex font commands.
3270   %\let\tt=\asis
3271   %
3272   \def\ { }%
3273   \def\@{@}%
3274   % how to handle braces?
3275   \def\_{\normalunderscore}%
3276   %
3277   % Non-English letters.
3278   \def\AA{AA}%
3279   \def\AE{AE}%
3280   \def\L{L}%
3281   \def\OE{OE}%
3282   \def\O{O}%
3283   \def\aa{aa}%
3284   \def\ae{ae}%
3285   \def\l{l}%
3286   \def\oe{oe}%
3287   \def\o{o}%
3288   \def\ss{ss}%
3289   \def\exclamdown{!}%
3290   \def\questiondown{?}%
3291   \def\ordf{a}%
3292   \def\ordm{o}%
3293   %
3294   \def\LaTeX{LaTeX}%
3295   \def\TeX{TeX}%
3296   %
3297   % Assorted special characters.
3298   % (The following {} will end up in the sort string, but that's ok.)
3299   \def\bullet{bullet}%
3300   \def\comma{,}%
3301   \def\copyright{copyright}%
3302   \def\registeredsymbol{R}%
3303   \def\dots{...}%
3304   \def\enddots{...}%
3305   \def\equiv{==}%
3306   \def\error{error}%
3307   \def\expansion{==>}%
3308   \def\minus{-}%
3309   \def\pounds{pounds}%
3310   \def\point{.}%
3311   \def\print{-|}%
3312   \def\result{=>}%
3313   %
3314   % Don't write macro names.
3315   \emptyusermacros
3316 }
3317
3318 \let\indexbackslash=0  %overridden during \printindex.
3319 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3320
3321 % Most index entries go through here, but \dosubind is the general case.
3322 % #1 is the index name, #2 is the entry text.
3323 \def\doind#1#2{\dosubind{#1}{#2}{}}
3324
3325 % Workhorse for all \fooindexes.
3326 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3327 % empty if called from \doind, as we usually are (the main exception
3328 % is with most defuns, which call us directly).
3329 %
3330 \def\dosubind#1#2#3{%
3331   \iflinks
3332   {%
3333     % Store the main index entry text (including the third arg).
3334     \toks0 = {#2}%
3335     % If third arg is present, precede it with a space.
3336     \def\thirdarg{#3}%
3337     \ifx\thirdarg\empty \else
3338       \toks0 = \expandafter{\the\toks0 \space #3}%
3339     \fi
3340     %
3341     \edef\writeto{\csname#1indfile\endcsname}%
3342     %
3343     \ifvmode
3344       \dosubindsanitize
3345     \else
3346       \dosubindwrite
3347     \fi
3348   }%
3349   \fi
3350 }
3351
3352 % Write the entry in \toks0 to the index file:
3353 %
3354 \def\dosubindwrite{%
3355   % Put the index entry in the margin if desired.
3356   \ifx\SETmarginindex\relax\else
3357     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3358   \fi
3359   %
3360   % Remember, we are within a group.
3361   \indexdummies % Must do this here, since \bf, etc expand at this stage
3362   \escapechar=`\\
3363   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3364       % so it will be output as is; and it will print as backslash.
3365   %
3366   % Process the index entry with all font commands turned off, to
3367   % get the string to sort by.
3368   {\indexnofonts
3369    \edef\temp{\the\toks0}% need full expansion
3370    \xdef\indexsorttmp{\temp}%
3371   }%
3372   %
3373   % Set up the complete index entry, with both the sort key and
3374   % the original text, including any font commands.  We write
3375   % three arguments to \entry to the .?? file (four in the
3376   % subentry case), texindex reduces to two when writing the .??s
3377   % sorted result.
3378   \edef\temp{%
3379     \write\writeto{%
3380       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3381   }%
3382   \temp
3383 }
3384
3385 % Take care of unwanted page breaks:
3386 %
3387 % If a skip is the last thing on the list now, preserve it
3388 % by backing up by \lastskip, doing the \write, then inserting
3389 % the skip again.  Otherwise, the whatsit generated by the
3390 % \write will make \lastskip zero.  The result is that sequences
3391 % like this:
3392 % @end defun
3393 % @tindex whatever
3394 % @defun ...
3395 % will have extra space inserted, because the \medbreak in the
3396 % start of the @defun won't see the skip inserted by the @end of
3397 % the previous defun.
3398 %
3399 % But don't do any of this if we're not in vertical mode.  We
3400 % don't want to do a \vskip and prematurely end a paragraph.
3401 %
3402 % Avoid page breaks due to these extra skips, too.
3403 %
3404 % But wait, there is a catch there:
3405 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
3406 % sufficient for this purpose, as it ignores stretch and shrink parts
3407 % of the skip.  The only way seems to be to check the textual
3408 % representation of the skip.
3409 %
3410 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3411 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3412 %
3413 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3414 %
3415 % ..., ready, GO:
3416 %
3417 \def\dosubindsanitize{%
3418   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3419   \skip0 = \lastskip
3420   \edef\lastskipmacro{\the\lastskip}%
3421   \count255 = \lastpenalty
3422   %
3423   % If \lastskip is nonzero, that means the last item was a
3424   % skip.  And since a skip is discardable, that means this
3425   % -\skip0 glue we're inserting is preceded by a
3426   % non-discardable item, therefore it is not a potential
3427   % breakpoint, therefore no \nobreak needed.
3428   \ifx\lastskipmacro\zeroskipmacro
3429   \else
3430     \vskip-\skip0
3431   \fi
3432   %
3433   \dosubindwrite
3434   %
3435   \ifx\lastskipmacro\zeroskipmacro
3436     % If \lastskip was zero, perhaps the last item was a penalty, and
3437     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
3438     % to re-insert the same penalty (values >10000 are used for various
3439     % signals); since we just inserted a non-discardable item, any
3440     % following glue (such as a \parskip) would be a breakpoint.  For example:
3441     % 
3442     %   @deffn deffn-whatever
3443     %   @vindex index-whatever
3444     %   Description.
3445     % would allow a break between the index-whatever whatsit
3446     % and the "Description." paragraph.
3447     \ifnum\count255>9999 \penalty\count255 \fi
3448   \else
3449     % On the other hand, if we had a nonzero \lastskip,
3450     % this make-up glue would be preceded by a non-discardable item
3451     % (the whatsit from the \write), so we must insert a \nobreak.
3452     \nobreak\vskip\skip0
3453   \fi
3454 }
3455
3456 % The index entry written in the file actually looks like
3457 %  \entry {sortstring}{page}{topic}
3458 % or
3459 %  \entry {sortstring}{page}{topic}{subtopic}
3460 % The texindex program reads in these files and writes files
3461 % containing these kinds of lines:
3462 %  \initial {c}
3463 %     before the first topic whose initial is c
3464 %  \entry {topic}{pagelist}
3465 %     for a topic that is used without subtopics
3466 %  \primary {topic}
3467 %     for the beginning of a topic that is used with subtopics
3468 %  \secondary {subtopic}{pagelist}
3469 %     for each subtopic.
3470
3471 % Define the user-accessible indexing commands
3472 % @findex, @vindex, @kindex, @cindex.
3473
3474 \def\findex {\fnindex}
3475 \def\kindex {\kyindex}
3476 \def\cindex {\cpindex}
3477 \def\vindex {\vrindex}
3478 \def\tindex {\tpindex}
3479 \def\pindex {\pgindex}
3480
3481 \def\cindexsub {\begingroup\obeylines\cindexsub}
3482 {\obeylines %
3483 \gdef\cindexsub "#1" #2^^M{\endgroup %
3484 \dosubind{cp}{#2}{#1}}}
3485
3486 % Define the macros used in formatting output of the sorted index material.
3487
3488 % @printindex causes a particular index (the ??s file) to get printed.
3489 % It does not print any chapter heading (usually an @unnumbered).
3490 %
3491 \parseargdef\printindex{\begingroup
3492   \dobreak \chapheadingskip{10000}%
3493   %
3494   \smallfonts \rm
3495   \tolerance = 9500
3496   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3497   %
3498   % See if the index file exists and is nonempty.
3499   % Change catcode of @ here so that if the index file contains
3500   % \initial {@}
3501   % as its first line, TeX doesn't complain about mismatched braces
3502   % (because it thinks @} is a control sequence).
3503   \catcode`\@ = 11
3504   \openin 1 \jobname.#1s
3505   \ifeof 1
3506     % \enddoublecolumns gets confused if there is no text in the index,
3507     % and it loses the chapter title and the aux file entries for the
3508     % index.  The easiest way to prevent this problem is to make sure
3509     % there is some text.
3510     \putwordIndexNonexistent
3511   \else
3512     %
3513     % If the index file exists but is empty, then \openin leaves \ifeof
3514     % false.  We have to make TeX try to read something from the file, so
3515     % it can discover if there is anything in it.
3516     \read 1 to \temp
3517     \ifeof 1
3518       \putwordIndexIsEmpty
3519     \else
3520       % Index files are almost Texinfo source, but we use \ as the escape
3521       % character.  It would be better to use @, but that's too big a change
3522       % to make right now.
3523       \def\indexbackslash{\backslashcurfont}%
3524       \catcode`\\ = 0
3525       \escapechar = `\\
3526       \begindoublecolumns
3527       \input \jobname.#1s
3528       \enddoublecolumns
3529     \fi
3530   \fi
3531   \closein 1
3532 \endgroup}
3533
3534 % These macros are used by the sorted index file itself.
3535 % Change them to control the appearance of the index.
3536
3537 \def\initial#1{{%
3538   % Some minor font changes for the special characters.
3539   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3540   %
3541   % Remove any glue we may have, we'll be inserting our own.
3542   \removelastskip
3543   %
3544   % We like breaks before the index initials, so insert a bonus.
3545   \nobreak
3546   \vskip 0pt plus 3\baselineskip
3547   \penalty 0
3548   \vskip 0pt plus -3\baselineskip
3549   %
3550   % Typeset the initial.  Making this add up to a whole number of
3551   % baselineskips increases the chance of the dots lining up from column
3552   % to column.  It still won't often be perfect, because of the stretch
3553   % we need before each entry, but it's better.
3554   %
3555   % No shrink because it confuses \balancecolumns.
3556   \vskip 1.67\baselineskip plus .5\baselineskip
3557   \leftline{\secbf #1}%
3558   % Do our best not to break after the initial.
3559   \nobreak
3560   \vskip .33\baselineskip plus .1\baselineskip
3561 }}
3562
3563 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3564 % then page number (#2) flushed to the right margin.  It is used for index
3565 % and table of contents entries.  The paragraph is indented by \leftskip.
3566 %
3567 % A straightforward implementation would start like this:
3568 %       \def\entry#1#2{...
3569 % But this frozes the catcodes in the argument, and can cause problems to
3570 % @code, which sets - active.  This problem was fixed by a kludge---
3571 % ``-'' was active throughout whole index, but this isn't really right.
3572 %
3573 % The right solution is to prevent \entry from swallowing the whole text.
3574 %                                 --kasal, 21nov03
3575 \def\entry{%
3576   \begingroup
3577     %
3578     % Start a new paragraph if necessary, so our assignments below can't
3579     % affect previous text.
3580     \par
3581     %
3582     % Do not fill out the last line with white space.
3583     \parfillskip = 0in
3584     %
3585     % No extra space above this paragraph.
3586     \parskip = 0in
3587     %
3588     % Do not prefer a separate line ending with a hyphen to fewer lines.
3589     \finalhyphendemerits = 0
3590     %
3591     % \hangindent is only relevant when the entry text and page number
3592     % don't both fit on one line.  In that case, bob suggests starting the
3593     % dots pretty far over on the line.  Unfortunately, a large
3594     % indentation looks wrong when the entry text itself is broken across
3595     % lines.  So we use a small indentation and put up with long leaders.
3596     %
3597     % \hangafter is reset to 1 (which is the value we want) at the start
3598     % of each paragraph, so we need not do anything with that.
3599     \hangindent = 2em
3600     %
3601     % When the entry text needs to be broken, just fill out the first line
3602     % with blank space.
3603     \rightskip = 0pt plus1fil
3604     %
3605     % A bit of stretch before each entry for the benefit of balancing
3606     % columns.
3607     \vskip 0pt plus1pt
3608     %
3609     % Swallow the left brace of the text (first parameter):
3610     \afterassignment\doentry
3611     \let\temp =
3612 }
3613 \def\doentry{%
3614     \bgroup % Instead of the swallowed brace.
3615       \noindent
3616       \aftergroup\finishentry
3617       % And now comes the text of the entry.
3618 }
3619 \def\finishentry#1{%
3620     % #1 is the page number.
3621     %
3622     % The following is kludged to not output a line of dots in the index if
3623     % there are no page numbers.  The next person who breaks this will be
3624     % cursed by a Unix daemon.
3625     \def\tempa{{\rm }}%
3626     \def\tempb{#1}%
3627     \edef\tempc{\tempa}%
3628     \edef\tempd{\tempb}%
3629     \ifx\tempc\tempd
3630       \ %
3631     \else
3632       %
3633       % If we must, put the page number on a line of its own, and fill out
3634       % this line with blank space.  (The \hfil is overwhelmed with the
3635       % fill leaders glue in \indexdotfill if the page number does fit.)
3636       \hfil\penalty50
3637       \null\nobreak\indexdotfill % Have leaders before the page number.
3638       %
3639       % The `\ ' here is removed by the implicit \unskip that TeX does as
3640       % part of (the primitive) \par.  Without it, a spurious underfull
3641       % \hbox ensues.
3642       \ifpdf
3643         \pdfgettoks#1.%
3644         \ \the\toksA
3645       \else
3646         \ #1%
3647       \fi
3648     \fi
3649     \par
3650   \endgroup
3651 }
3652
3653 % Like \dotfill except takes at least 1 em.
3654 \def\indexdotfill{\cleaders
3655   \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3656
3657 \def\primary #1{\line{#1\hfil}}
3658
3659 \newskip\secondaryindent \secondaryindent=0.5cm
3660 \def\secondary#1#2{{%
3661   \parfillskip=0in
3662   \parskip=0in
3663   \hangindent=1in
3664   \hangafter=1
3665   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3666   \ifpdf
3667     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3668   \else
3669     #2
3670   \fi
3671   \par
3672 }}
3673
3674 % Define two-column mode, which we use to typeset indexes.
3675 % Adapted from the TeXbook, page 416, which is to say,
3676 % the manmac.tex format used to print the TeXbook itself.
3677 \catcode`\@=11
3678
3679 \newbox\partialpage
3680 \newdimen\doublecolumnhsize
3681
3682 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3683   % Grab any single-column material above us.
3684   \output = {%
3685     %
3686     % Here is a possibility not foreseen in manmac: if we accumulate a
3687     % whole lot of material, we might end up calling this \output
3688     % routine twice in a row (see the doublecol-lose test, which is
3689     % essentially a couple of indexes with @setchapternewpage off).  In
3690     % that case we just ship out what is in \partialpage with the normal
3691     % output routine.  Generally, \partialpage will be empty when this
3692     % runs and this will be a no-op.  See the indexspread.tex test case.
3693     \ifvoid\partialpage \else
3694       \onepageout{\pagecontents\partialpage}%
3695     \fi
3696     %
3697     \global\setbox\partialpage = \vbox{%
3698       % Unvbox the main output page.
3699       \unvbox\PAGE
3700       \kern-\topskip \kern\baselineskip
3701     }%
3702   }%
3703   \eject % run that output routine to set \partialpage
3704   %
3705   % Use the double-column output routine for subsequent pages.
3706   \output = {\doublecolumnout}%
3707   %
3708   % Change the page size parameters.  We could do this once outside this
3709   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3710   % format, but then we repeat the same computation.  Repeating a couple
3711   % of assignments once per index is clearly meaningless for the
3712   % execution time, so we may as well do it in one place.
3713   %
3714   % First we halve the line length, less a little for the gutter between
3715   % the columns.  We compute the gutter based on the line length, so it
3716   % changes automatically with the paper format.  The magic constant
3717   % below is chosen so that the gutter has the same value (well, +-<1pt)
3718   % as it did when we hard-coded it.
3719   %
3720   % We put the result in a separate register, \doublecolumhsize, so we
3721   % can restore it in \pagesofar, after \hsize itself has (potentially)
3722   % been clobbered.
3723   %
3724   \doublecolumnhsize = \hsize
3725     \advance\doublecolumnhsize by -.04154\hsize
3726     \divide\doublecolumnhsize by 2
3727   \hsize = \doublecolumnhsize
3728   %
3729   % Double the \vsize as well.  (We don't need a separate register here,
3730   % since nobody clobbers \vsize.)
3731   \vsize = 2\vsize
3732 }
3733
3734 % The double-column output routine for all double-column pages except
3735 % the last.
3736 %
3737 \def\doublecolumnout{%
3738   \splittopskip=\topskip \splitmaxdepth=\maxdepth
3739   % Get the available space for the double columns -- the normal
3740   % (undoubled) page height minus any material left over from the
3741   % previous page.
3742   \dimen@ = \vsize
3743   \divide\dimen@ by 2
3744   \advance\dimen@ by -\ht\partialpage
3745   %
3746   % box0 will be the left-hand column, box2 the right.
3747   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3748   \onepageout\pagesofar
3749   \unvbox255
3750   \penalty\outputpenalty
3751 }
3752 %
3753 % Re-output the contents of the output page -- any previous material,
3754 % followed by the two boxes we just split, in box0 and box2.
3755 \def\pagesofar{%
3756   \unvbox\partialpage
3757   %
3758   \hsize = \doublecolumnhsize
3759   \wd0=\hsize \wd2=\hsize
3760   \hbox to\pagewidth{\box0\hfil\box2}%
3761 }
3762 %
3763 % All done with double columns.
3764 \def\enddoublecolumns{%
3765   \output = {%
3766     % Split the last of the double-column material.  Leave it on the
3767     % current page, no automatic page break.