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