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