bc/doc/texinfo.tex

11 % This texinfo.tex file is free software; you can redistribute it and/or
16 % This texinfo.tex file is distributed in the hope that it will be
22 % along with this texinfo.tex file; see the file COPYING.  If not, write
32 %   ftp://ftp.gnu.org/gnu/texinfo.tex
33 %   (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 %   ftp://texinfo.org/tex/texinfo.tex
35 %   ftp://us.ctan.org/macros/texinfo/texinfo.tex
36 %   (and all CTAN mirrors, finger ctan@us.ctan.org for a list).
40 % Texinfo has a small home page at http://texinfo.org/.
42 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
53 %   dvips foo.dvi -o # or whatever, to process the dvi file; this makes foo.ps.
59 % the existing language-specific files from ftp://ftp.gnu.org/gnu/texinfo/.
63 % If in a .fmt file, print the version number
65 % they might have appeared in the input file name.
99 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
152 % Sometimes it is convenient to have everything in the transcript file
213     \indexdummies         % don't expand commands in the output.
363 % Change the active space to expand to nothing.
495  % if the definition is written into an index file.
701 % @include file    insert text of that file as input.
702 % Allow normal characters that  we make active in the argument (a file name).
713 % Restore active chars for included file.
715   % Read the included file in a group so nested @include's work.
789 % sequences like \math are expanded when the toc file is written.  Then,
790 % we read the toc file back, the $'s will be normal characters (as they
814 % @setfilename is done at the beginning of every texinfo file.
816 % This makes it possible to make a .fmt file for texinfo.
892   \def\pdfmkdest#1{\pdfdest name{#1@} xyz}
923         \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
925         \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
927         \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
929         \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
931         \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
933         \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
935         \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
937         \pdfoutline goto name{\pdfmkpgn{##2}}{##1}}
950         goto name{\pdfmkpgn{\the\pgn}}%
1016     \startlink attr{/Border [0 0 0]} goto name{\mkpgn{#1}}
1282 % @file, @option are the same as @samp.
1283 \let\file=\samp
1627 % For double-sided printing, put current file name in lower left corner,
1628 % chapter name on inside top of right hand pages, document
1706 % to index the item name in whatever manner is desired (perhaps none).
2108 % --karl, nathan@acm.org, 20apr99.
2307 % @dircategory CATEGORY  -- specify a category of the dir file
2308 % which this file should belong to.  Ignore this in TeX.
2319   % this texinfo.tex file).  We change the catcode of @ below to match.
2339   % And now expand that command.
2358     \immediate\write16{  (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2368 % workaround (which requires the file ``dummy.tfm'' to be installed),
2377   % We must actually expand the ignored text to look for the @end
2455 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2483 % winds up in the index file.  This means that if the variable's value
2555 % We need to expand lots of \csname's, but we don't want to expand the
2576 % the file that accumulates this index.  The file's extension is foo.
2577 % The name of an index should be no more than 2 characters long
2583     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2630 %  and it is "foo", the name of the index.
2717 \def\file##1{\realbackslash file {##1}}%
2724 % Handle some cases of @value -- where the variable name does not
2735 % therein should become regular spaces in the raw index file, not the
2794 \let\file=\indexdummyfont
2822 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2834       \indexdummies % Must do this here, since \bf, etc expand at this stage
2837         \let\folio = 0% We will expand all macros now EXCEPT \folio.
2865         % three arguments to \entry to the .?? file, texindex reduces to
2906 % The index entry written in the file actually looks like
2938 % @printindex causes a particular index (the ??s file) to get printed.
2949   % See if the index file exists and is nonempty.
2950   % Change catcode of @ here so that if the index file contains
2958     % and it loses the chapter title and the aux file entries for the
2964     % If the index file exists but is empty, then \openin leaves \ifeof
2965     % false.  We have to make TeX try to read something from the file, so
2985 % These macros are used by the sorted index file itself.
3275   % expanded while writing the .toc file.  \char\appendixno is not
3282 % Each @chapter defines this as the name of the chapter.
3292 \let\up=\raisesections % original BFox name
3296 \let\down=\lowersections % original BFox name
3367 % We don't substitute the actual chapter name into \thischapter
3756 % Write an entry to the toc file, opening it if necessary.
3760 % We open the .toc file here instead of at @setfilename or any other
3856 % The first argument is the chapter or section name.
3871 % command in the toc file for appendices, instead of using \chapentry
4100 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4314 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4358 % #1 should be the function name.
4382 {\df #1}\enskip        % Generate function name
4387 % #2 should be the "another name" control sequence, such as \defunx.
4407 % #4, delimited by the space, is the class name.
4424 % #4, delimited by a space, is the class name.
4441 % the \E... definition to assign the category name to.
4509 % So, to get around this, we put \empty in with the type name.  That
4524 % thing to call, #2 the type name (which starts with \empty), and #3
4561 % Use this to expand the args and terminate the paragraph they make up
4612 % #1 is the data type.  #2 is the name and args.
4614 % #1 is the data type, #2 the name, #3 the args.
4630 % #1 is the classification.  #2 is the data type.  #3 is the name and args.
4632 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4680 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4695 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4709 % #1 is the class name, #2 the data type, #3 the variable name.
4722 % #1 is the class name, #2 the method name, #3 the args.
4757 % This must expand the args and terminate the paragraph they make up
4791 % #1 is the data type.  #2 is the name, perhaps followed by text that
4851 % which we arrange to emulate with a temporary file in ordinary TeX.
4876 \newtoks\macname    % Macro name
4966      \else \errmessage{The name \the\macname\space is reserved}\fi
4984     % Remove the macro name from \macrolist
5048 % \xdef is used so that macro definitions will survive the file
5049 % they're defined in; @include reads the file inside a group.
5128 % sign.  Just make them active and then expand them all to nothing.
5147 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5190 % aren't expanded.  It would be nicer not to expand the titles in the
5202 % the node name, #2 the name of the Info cross-reference, #3 the printed
5203 % node name, #4 the name of the Info file, #5 the name of the printed
5204 % manual.  All but the node name can be omitted.
5216     % No printed node name was explicitly given.
5218       % Use the node name inside the square brackets.
5231           % Otherwise just copy the Info node name.
5242   % is a loss.  Therefore, we give the text of the node name again, so it
5249         goto file{\the\filename.pdf} name{#1@}%
5252         goto name{#1@}%
5261     % control sequence corresponding to the node, but it has to expand
5295 % When the aux file is read, ' is the escape character
5360 % This is the macro invoked by entries in the aux file.
5369 % Read the last existing aux file, if any.  No error if none exists.
5434   % The aux file uses ' as the escape (for now).
5439   % but at least they do not bomb out when the aux file is read in.
5453   % Open the new aux file.  TeX will close it automatically at exit.
5605   it from ftp://tug.org/tex/epsf.tex.}
5657 % It would be nice if we could set up a hyphenation file here.
5661   \tex % read txi-??.tex file in plain TeX.
5662   % Read the file if it exists.
5666     \errmessage{Cannot read language file txi-#1.tex}%
5674 \newhelp\nolanghelp{The given language definition file cannot be found or
5903 % If a .fmt file is being used, characters that might appear in a file
5904 % name cannot be active until we have parsed the command line.
5906 % \otherifyactive is called near the end of this file.
5954 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
5961 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
5962 % the first `\{ in the file would cause an error. This macro tries to fix
5965 % file name, in case not using a pre-dumped format.
5987 @c eval: (add-hook 'write-file-hooks 'time-stamp)