binutils/texinfo/texinfo.tex

1 % texinfo.tex -- TeX macros to handle Texinfo files.
12 % This texinfo.tex file is free software; you can redistribute it and/or
17 % This texinfo.tex file is distributed in the hope that it will be
23 % along with this texinfo.tex file; see the file COPYING.  If not, write
31 % Please try the latest version of texinfo.tex before submitting bug
33 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 %   ftp://tug.org/tex/texinfo.tex
36 % The texinfo.tex in any given distribution could well be out
39 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
46 %   tex foo.texi
48 %   tex foo.texi
49 %   tex foo.texi
55 % It is possible to adapt texinfo.tex for other languages, to some
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
481 % Define the framework for environments in texinfo.tex.  It's used like this:
673 % percent of a page (\vfilllimit can be changed inside of @tex).
1038 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1046   \tex
1052 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1110 % @setfilename is done at the beginning of every texinfo file.
1112 % This makes it possible to make a .fmt file for texinfo.
1114    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1123    % If texinfo.cnf is present on the system, read it.
1125    \openin 1 texinfo.cnf
1126    \ifeof 1 \else \input texinfo.cnf \fi
1436 % before you read in texinfo.tex.
1572 % texinfo doesn't allow for producing subscripts and superscripts except
1930 % Adapted from the plain.tex definition of \copyright.
1965     % No rule at page bottom unless we print one at the top with @title.
2028   % print a rule at the page bottom also.
2172 % Only define if not already defined, in case a txi-??.tex file has set
2173 % up a different format (e.g., txi-cs.tex does this).
2767 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2924 % Define \newwrite to be identical to plain tex's \newwrite
3015   % Need these in case \tex is in effect and \{ is a \delimiter again.
3120   \definedummyword{print}%
3210   % Likewise with the other plain tex font commands.
3251   \def\print{-|}%
3301       % so it will be output as is; and it will print as backslash.
3425 % It does not print any chapter heading (usually an @unnumbered).
3610 % the manmac.tex format used to print the TeXbook itself.
3626     % runs and this will be a no-op.  See the indexspread.tex test case.
4140     % number, and don't print the unnumbered ``number''.
4559 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4567 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4593 % @tex ... @end tex    escapes into raw Tex temporarily.
4594 % One exception: @ is still an escape character, so that @end tex works.
4595 % But \@ or @@ will get a plain tex @ character.
4597 \envdef\tex{%
4917   % print special symbols as themselves, and
4951   % print special symbols as themselves, and
4979 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5027   % \ is the escape char in this texinfo.tex file, so it is the
5280   % (plain.tex says that \dimen1 should be used only as global.)
5332 % We want ()&[] to print specially on the defun line.
5364     % At the first level, print parens in roman,
5484 % (as in normal texinfo). It is necessary to change the definition of \.
5849     % If the user specified the print name (third arg) to the ref,
5850     % print it instead of our usual "Figure 1.2".
5865     % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6122 % Don't bother with the trickery in plain.tex to not require the
6227 % @image.  We use the macros from epsf.tex to support this.
6228 % If epsf.tex is not installed and @image is used, we complain.
6230 % Check for and read epsf.tex up front.  If we read it only at @image
6233 \openin 1 = epsf.tex
6235   % Do not bother showing banner with epsf.tex v2.7k (available in
6236   % doc/epsf.tex and on ctan).
6238   \input epsf.tex
6242 % We will only complain once about lack of epsf.tex.
6244 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6246   it from ftp://tug.org/tex/epsf.tex.}
6252       \errmessage{epsf.tex not found, images will be ignored}%
6405     % If we have anything to print, print it, with space before.
6491 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6548   \tex % read txi-??.tex file in plain TeX.
6550     \openin 1 txi-#1.tex
6553       \errmessage{Cannot read language file txi-#1.tex}%
6555       \input txi-#1.tex
6668 % Use @afourpaper to print on European A4 paper.
6678   % your texinfo source file like this:
6679   % @tex
6682   % @end tex
6694 % Use @afivepaper to print on European A5 paper.
6726 % Use @afourwide to print on A4 paper in landscape format.
6765 \message{and turning on texinfo input format.}
6787 % This macro is used to make a character print one way in \tt
6791 % #1 is what to print if we are indeed using \tt; #2 is what to print
6806 % Most of these we simply print from the \tt font, but for some, we can
6891 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6895 @gdef@eatinput input texinfo{@fixbackslash}
6898 % On the other hand, perhaps the file did not have a `\input texinfo'. Then