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
29 % Please try the latest version of texinfo.tex before submitting bug
31 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 %   ftp://tug.org/tex/texinfo.tex
34 % The texinfo.tex in any given distribution could well be out
37 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
53 % It is possible to adapt texinfo.tex for other languages, to some
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
295 % marks for the sectioning macros, one before the section break, and
357                % the page break happens to be in the middle of an example.
522   % space in the output.  Don't allow a line break at this space, as this
537 % Define the framework for environments in texinfo.tex.  It's used like this:
685 % penalty on the vertical list instead of in the new paragraph.
696 % @* forces a line break.
697 \def\*{\hfil\break\hbox{}\ignorespaces}
699 % @/ allows a line break.
726 % @w prevents a word break.  Without the \leavevmode, @w at the
727 % beginning of a paragraph, when TeX is still in vertical mode, would
728 % produce a whole line of output instead of starting the paragraph.
781   % group, force a page break.
800 % forces a page break if there is not space-in-mils remaining.
806 %% This method tries to make TeX break the page naturally
815   % paragraph.
826     % And a page break here is fine.
832     % page breaks.  On the other hand, we don't want to actually break the
835     % There is an extremely small chance that TeX will actually break the
844     % Back up by the size of the box, whether we did a page break or not.
847     % Do not allow a page break right after this kern.
852 % @br   forces paragraph break (and is undocumented).
868 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
875 % paragraph.  For more general purposes, use the \margin insertion
984     \hfil\break
988     \break
1046 % If WORD is `none', then suppress indentation of the first paragraph
1050 % The paragraph indentation is suppressed or not by calling
1074 % paragraph.
1128   % make the texinfo accent commands work in math mode
1211 % @setfilename is done at the beginning of every texinfo file.
1213 % This makes it possible to make a .fmt file for texinfo.
1215    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1224    % If texinfo.cnf is present on the system, read it.
1226    \openin 1 texinfo.cnf
1227    \ifeof 1 \else \input texinfo.cnf \fi
1249 % adobe `portable' document format
1330 be supported due to the design of the PDF format; use regular TeX (DVI
1384     % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1961 % before you read in texinfo.tex.
2272 % texinfo doesn't allow for producing subscripts and superscripts except
2542 % the end of a paragraph.  Restore normal hyphenation at the end of the
2955 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
2988 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
3048     % It is important to do the page break before ending the group,
3260 % up a different format (e.g., txi-cs.tex does this).
3308   \nobreak % This prevents a break before @itemx.
3311   % by itself, and do not allow a page break either before or after that
3312   % line.  We do not start a paragraph here because then if the next
3317     % Make this a paragraph so we get the \parskip glue and wrapping,
3326     % We're going to be starting a paragraph, but we don't want the
3330     % Stop a page break at the \parskip glue coming up.  However, if
3341     % The item text fits into the space.  Start a paragraph, so that the
3449   {\let\par=\endgraf \smallbreak}% reasonable place to break
3463    \vadjust{\penalty 1200}}% not good to break after first line of item.
3574 % Table can continue over pages but will only break between lines.
3619 % @multitableparindent is paragraph indent in table.
3780       % blank line, when TeX decides to break the line at the space before the
3803   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3880 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4151   % help-texinfo, 22may06):
4513 % don't want to do a \vskip and prematurely end a paragraph.
4564     % would allow a break between the index-whatever whatsit
4565     % and the "Description." paragraph.
4679   % Do our best not to break after the initial.
4684 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4686 % and table of contents entries.  The paragraph is indented by \leftskip.
4699     % Start a new paragraph if necessary, so our assignments below can't
4706     % No extra space above this paragraph.
4719     % of each paragraph, so we need not do anything with that.
4785     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4794 % the manmac.tex format used to print the TeXbook itself.
4828   % format, but then we repeat the same computation.  Repeating a couple
4834   % changes automatically with the paper format.  The magic constant
4889   % break occurs before the last section starts.  However, the last
4899   % break.  The two columns and the broken-off section both fit on the
4913     % current page, no automatic page break.
4917     % though, there will be another page break right after this \output
5205   % Well, we could do the following in a group, but that would break
5379   % Insert the first mark before the heading break (see notes for \domark).
5420   % Insert the chapter heading break.
5423   % Now the second mark, after the heading break.  No break points
5459     % the pdfdest) after any page break, but before the actual text has
5471   \nobreak\bigskip % no page break after a chapter title
5539     % Insert first mark before the heading break (see notes for \domark).
5577     % don't want the following whatsit to end up in a preceding paragraph
5588     % Now the second mark, after the heading break.  No break points
5625     % break, since then the whatsits could end up on page n while the
5642   % We'll almost certainly start a paragraph next, so don't let that
5707 % with the Texinfo input format setup at the end of this file.
5991 % start of the next paragraph will insert \parskip.
6001       % it's not a good place to break if the last penalty was \nobreak
6037   \ifhmode\par\fi  % can't be in the midst of a paragraph.
6088   % Turn off paragraph indentation but redefine \indent to emulate
6125 %    @example, @display, @format, @lisp
6132     % end paragraph for sake of leading, in case document has no blank
6181 % @format/@smallformat: same as @display except don't narrow margins.
6183 \makedispenv{format}{%
6189 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6387 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6438     \parindent = 0pt  % paragraph indentation looks wrong on title page
6462     % break somewhere.  Check specifically for penalty 10002, inserted
6465     % a break between a section heading and a defun.
6473     % Similarly, after a section heading, do not allow a break.
6487   % As above, allow line break if we have multiple x headers in a row.
6637   % How we'll format the type name.  Putting it in brackets helps
6643   % Figure out line sizes for the paragraph shape.
6876 % (as in normal texinfo). It is necessary to change the definition of \.
7275     % not find a line break at a hyphen in a node names.  Since some manuals
7552   % We want to typeset this text as a normal paragraph, even if the
7575   % footnote extends for more than one paragraph.
7580   % expands into a box, it must come within the paragraph, lest it
7704   % it's at the top level, we don't want the normal paragraph indentation.
7755   % We can't be used inside a paragraph.
7786         % labels (which have a completely different output format) from
8035 % The language names to pass are determined when the format is built.
9017   % your texinfo source file like this:
9065 % Use @afourwide to print on A4 paper in landscape format.
9104 \message{and turning on texinfo input format.}
9203 % In texinfo, backslash is an active character; it prints the backslash
9239 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9243 @gdef@eatinput input texinfo{@fixbackslash}
9246 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9250 % file name, in case not using a pre-dumped format.
9283 @c time-stamp-format: "%:y-%02m-%02d.%02H"