bash-3.2/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/texinfo.tex
33 %     (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 %   ftp://tug.org/tex/texinfo.tex
35 %     (and all CTAN mirrors, see http://www.ctan.org),
38 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
43 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
65 % If in a .fmt file, print the version number
67 % they might have appeared in the input file name.
105 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
176 % Sometimes it is convenient to have everything in the transcript file
180 % file; cf. trace.sty in LaTeX.
253     \indexdummies         % don't expand commands in the output.
404 % Change the active space to expand to nothing.
486   % and @{ and @} for the aux file.
528  % if the definition is written into an index file.
794 % @include file    insert text of that file as input.
795 % Allow normal characters that  we make active in the argument (a file name).
806 % Restore active chars for included file.
808   % Read the included file in a group so nested @include's work.
951 % @setfilename is done at the beginning of every texinfo file.
953 % This makes it possible to make a .fmt file for texinfo.
1035   \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
1065         \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1067         \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1069         \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1071         \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1078       % Make special characters normal for writing to the pdf file.
1095         goto name{\pdfmkpgn{\the\pgn}}%
1162     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1483 % @file, @option are the same as @samp.
1484 \let\file=\samp
1539   % will therefore expand the active definition of _, which is us
1839 % For double-sided printing, put current file name in lower left corner,
1840 % chapter name on inside top of right hand pages, document
1886 % Only define if not already defined, in case a txi-??.tex file has set
1922 % to index the item name in whatever manner is desired (perhaps none).
2333   % nathan@acm.org, 20apr99.
2498 % nested conditionals.  But we don't want to expand the actual @deffn,
2602 % @dircategory CATEGORY  -- specify a category of the dir file
2603 % which this file should belong to.  Ignore this in TeX.
2614   % this texinfo.tex file).  We change the catcode of @ below to match.
2641   % And now expand the command defined above.
2660     \immediate\write16{  (See ftp://ftp.gnu.org/non-gnu/TeX.README.)}
2670 % workaround (which requires the file ``dummy.tfm'' to be installed),
2679   % We must actually expand the ignored text to look for the @end
2761 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2789 % is set), since the result winds up in the index file.  This means that
2873 % the file that accumulates this index.  The file's extension is foo.
2874 % The name of an index should be no more than 2 characters long
2880     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2933 %  and it is "foo", the name of the index.
2949 % Since there are some commands we want to expand, and others we don't,
2985 % For the aux file, @ is the escape character.  So we want to redefine
3072   \definedummyword{file}%
3098   % Handle some cases of @value -- where the variable name does not
3111 % therein should become regular spaces in the raw index file, not the
3184   \let\file=\asis
3208 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3220       \indexdummies % Must do this here, since \bf, etc expand at this stage
3223         \let\folio = 0% We will expand all macros now EXCEPT \folio.
3247         % three arguments to \entry to the .?? file (four in the
3288 % The index entry written in the file actually looks like
3320 % @printindex causes a particular index (the ??s file) to get printed.
3331   % See if the index file exists and is nonempty.
3332   % Change catcode of @ here so that if the index file contains
3340     % and it loses the chapter title and the aux file entries for the
3346     % If the index file exists but is empty, then \openin leaves \ifeof
3347     % false.  We have to make TeX try to read something from the file, so
3367 % These macros are used by the sorted index file itself.
3668   % expanded while writing the .toc file.  \char\appendixno is not
3675 % Each @chapter defines this as the name of the chapter.
3685 \let\up=\raisesections % original BFox name
3689 \let\down=\lowersections % original BFox name
3760   % We don't substitute the actual chapter name into \thischapter
4129 % Write an entry to the toc file, opening it if necessary.
4134 % We open the .toc file for writing here instead of at @setfilename (or
4245 % The first argument is the chapter or section name.
4268 % command in the toc file for appendices, instead of using \chapentry
4491 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4673 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
4799 % @verbatiminclude FILE - insert text of file in verbatim environment.
4801 % Allow normal characters that we make active in the argument (a file name).
4822      % Restore active chars for included file.
4841 % file; b) letting users define the frontmatter in as flexible order as
4846   % \ is the escape char in this texinfo.tex file, so it is the
4851   % We must preserve ^^M's in the input file; see \insertcopying below.
4928 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4971 % \defname, which formats the name of the @def (not the args).
4972 % #1 is the function name.
4976   % How we'll output the type name.  Putting it in brackets helps
5010   {\df #1}\enskip        % output function name
5061 % #4, delimited by the space, is the class name.
5076 % #4, delimited by a space, is the class name.
5091 % the \E... definition to assign the category name to.
5143 % So, to get around this, we put \empty in with the type name.  That
5160 % thing to call, #2 the type name (which starts with \empty), and #3
5243 % #1 is the data type.  #2 is the name and args.
5245 % #1 is the data type, #2 the name, #3 the args.
5261 % #1 is the classification.  #2 is the data type.  #3 is the name and args.
5263 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5313 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5328 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5342 % #1 is the class name, #2 the data type, #3 the variable name.
5356 % #1 is the class name, #2 the method name, #3 the args.
5393 % This must expand the args and terminate the paragraph they make up
5427 % #1 is the data type.  #2 is the name, perhaps followed by text that
5485 % which we arrange to emulate with a temporary file in ordinary TeX.
5510 \newtoks\macname    % Macro name
5600      \else \errmessage{Macro name \the\macname\space already defined}\fi
5618     % Remove the macro name from \macrolist:
5683 % \xdef is used so that macro definitions will survive the file
5684 % they're defined in; @include reads the file inside a group.
5763 % sign.  Just make them active and then expand them all to nothing.
5782 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5823 % anchor), namely NAME-title (the corresponding @chapter/etc. name),
5828 % title aren't expanded.  It would be nicer not to expand the titles in
5845 % the node name, #2 the name of the Info cross-reference, #3 the printed
5846 % node name, #4 the name of the Info file, #5 the name of the printed
5847 % manual.  All but the node name can be omitted.
5859     % No printed node name was explicitly given.
5861       % Use the node name inside the square brackets.
5874           % Otherwise just copy the Info node name.
5885   % is a loss.  Therefore, we give the text of the node name again, so it
5893          goto file{\the\filename.pdf} name{#1}%
5896          goto name{#1}%
5906     % control sequence corresponding to the node, but it has to expand
6006 % This is the macro invoked by entries in the aux file.
6010 % Read the last existing aux file, if any.  No error if none exists.
6083   % but at least they do not bomb out when the aux file is read in.
6098   % Open the new aux file.  TeX will close it automatically at exit.
6240   it from ftp://tug.org/tex/epsf.tex.}
6296 % It would be nice if we could set up a hyphenation file here.
6300   \tex % read txi-??.tex file in plain TeX.
6301   % Read the file if it exists.
6305     \errmessage{Cannot read language file txi-#1.tex}%
6313 \newhelp\nolanghelp{The given language definition file cannot be found or
6431   % your texinfo source file like this:
6597 % If a .fmt file is being used, characters that might appear in a file
6598 % name cannot be active until we have parsed the command line.
6600 % \otherifyactive is called near the end of this file.
6650 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6657 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6658 % the first `\{ in the file would cause an error. This macro tries to fix
6661 % file name, in case not using a pre-dumped format.
6683 @c eval: (add-hook 'write-file-hooks 'time-stamp)