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