bash-3.2/doc/texinfo.tex

11 % This texinfo.tex file is free software; you can redistribute it and/or
26 % In other words, you are welcome to use, share and improve this program.
27 % You are forbidden to forbid anyone else to use, share and improve
33 %     (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
35 %     (and all CTAN mirrors, see http://www.ctan.org),
36 %   and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
56 % Sometimes one run after texindex suffices, and sometimes you need more
66 % and turn on active characters that we couldn't do earlier because
177 % and nothing on the terminal.  We don't just call \tracingall here,
257       % Do this early so pdf references go to the beginning of the page.
347 % the like), remove it and recurse.  Otherwise, we're done.
385 % `itemize'.  Here we remove all active spaces from #1, and assign the
393 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
473 % and you can use @w{...} around a quote to suppress ligatures.
474 %% Define @` and @' to be the same as ` and '
485   % Definitions to produce \{ and \} commands for indices,
486   % and @{ and @} for the aux file.
510 % Dotless i and dotless j, used for accents.
523 % at the beginning of a line will start with \penalty -- and
558 % therefore, no glue is inserted, and the space between the headline and
577   % The \vtop we start below produces a box with normal height and large
578   % depth; thus, TeX puts \baselineskip glue before it, and (when the
588     % if the group doesn't fit on the current page, and it's a big big
603     % and the first line afterwards is too small.  But we can't put the
736 % This defn is used inside fill environments such as @defun.
895 % _ within @math be active (mathcode "8000), and distinguish by seeing
904 % Another complication: we want \\ (and @\) to output a \ character.
906 % this is not advertised and we don't care.  Texinfo does not
937 % @bullet and @minus need the same treatment as @math, just above.
945 % be able to disable indexing, cross-referencing, and contents, for test runs.
1183 % Set the baselineskip to #1, and the lineskip and strut size
1253 % A few fonts for @defun, etc.
1296 % Chapter (and unnumbered) fonts (17.28pt).
1331 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1334 % In order for the font changes to affect most math symbols and letters,
1336 % texinfo doesn't allow for producing subscripts and superscripts except
1337 % in the main text, we don't bother to reset \scriptfont and
1429 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1430 %% serif) and @ii for TeX italic
1455 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1510 % We *must* turn on hyphenation at `-' and `_' in \code.
1515 % both hyphenation at - and hyphenation within words.
1517 % and arrange explicitly to hyphenate at a dash.
1538   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1553 %   `example' (@kbd uses ttsl only inside of @example and friends),
1588 % second argument specifying the text to display and an optional third
1606         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1633 % Computer Modern typewriter fonts have zero interword stretch (and
1634 % shrink), and it is reasonable to expect all typewriter fonts to have
1647 % and it is not used as such in any manual I can find.  We need it for
1656 % @acronym downcases the argument and prints in smallcaps.
1730    % because the headline and footline are only empty inside the group.
1761 %%% Set up page headings and footings.
1830 % and turned `on' after @end titlepage.
1841 % title on inside top of left hand pages, and page numbers on outside top
1911 % default indentation of @itemize and @enumerate text
1913 % margin between end of table item and start of table text.
1919 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1951   % by itself, and do not allow a page break either before or after that
1957     % Make this a paragraph so we get the \parskip glue and wrapping,
1974     % the negative vskip we just would cause the example and the item to
1979     % maybe section titles are the only special case and they should be
1988     % Do this with kerns and \unhbox so that if there is a footnote in
1989     % the item text, it can migrate to the main vertical list and
2088 % TOKENS, and \rest to be the remainder.
2114     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2171 % Call itemizey, adding a period to the first argument and supplying the
2180 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2226 % the preamble, break the line within one argument and it
2299     \let\go = \relax
2305          \let\go\pickupwholefraction
2313     \ifx\go\pickupwholefraction
2316       \def\go{\pickupwholefraction#1}%
2318       \let\go = \setuptable
2321   \go
2331   % line is not enough.  That is bad.  So let's go back to just & until
2349   % To parse everything between @multitable and @item:
2366   % \vtop will set a single line and will also let text wrap and
2379   % use that dimension as the width of the column, and the \leftskip
2381   % left margin and final column will justify at right margin.
2397   % Ignoring space at the beginning and end avoids an occasional spurious
2437 % text to a box and make the \insert when a row of the table is
2458 % Used in @ignore and in failing conditionals.
2487 % and so want to turn off most commands, in case they are used
2499 % since it might be syntactically correct and intended to be ignored.
2553   \let\defun = \empty
2587 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2636     % and the @end ifinfo will be properly ignored.
2681   % text into a \vbox and then do nothing with the result.  To minimize
2702     % Set the current font to be \nullfont, a TeX primitive, and define
2746 % own to delimit the rest of the line, and then take it out again if we
2751   \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2761 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2850 % just start and end a group (to keep the @end definition undefined at
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,
2955   % Need these in case \tex is in effect and \{ is a \delimiter again.
2956   % But can't use \lbracecmd and \rbracecmd because texindex assumes
2957   % braces and backslashes are used only as delimiters.
2970   % These can be used both for control words that take an argument and
3007 % Called from \indexdummies and \atdummies.  \definedummyword and
3014   % Control letters and accents.
3099   % contain - or _, and the value does not contain any
3118 % by, and when constructing control sequence names.  It eliminates all
3119 % control sequences and just writes whatever the best ASCII sort string
3164   % and is used in the definitions of the active chars like <, >, |, etc.
3203 % Most index entries go through here, but \dosubind is the general case.
3225         % so it will be output as is; and it will print as backslash.
3245         % Set up the complete index entry, with both the sort key and
3260         % @end defun
3262         % @defun ...
3264         % start of the @defun won't see the skip inserted by the @end of
3265         % the previous defun.
3268         % don't want to do a \vskip and prematurely end a paragraph.
3292 % The texindex program reads in these files and writes files
3331   % See if the index file exists and is nonempty.
3340     % and it loses the chapter title and the aux file entries for the
3394 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3395 % flush to the right margin.  It is used for index and table of contents
3413   % \hangindent is only relevant when the entry text and page number
3417   % lines.  So we use a small indentation and put up with long leaders.
3445     % If we must, put the page number on a line of its own, and fill out
3502     % runs and this will be a no-op.  See the indexspread.tex test case.
3519   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3564 % followed by the two boxes we just split, in box0 and box2.
3676 % page headings and footings can use it.  @section does likewise.
3944 % Define @majorheading, @heading and @subheading
3946 % NOTE on use of \vbox for chapter headings, section headings, and such:
3951 %       3) Likewise, headings look best if no \parindent is used, and
3977 %%% Args are the skip and penalty (usually negative)
3982 %%% Define plain chapter starts, and page on/off switching for it
4036 % @centerchap -- centered and unnumbered.
4152   % just do it on every page because the title pages are numbered 1 and
4153   % 2 (the page numbers aren't printed), and so are the first two pages
4154   % of the document.  Thus, we'd have two destinations named `1', and
4163 % Finish up the main text and prepare to read what we've written
4167    % If @setchapternewpage on, and @headings double, the contents should
4253 % See comments in \dochapentry re vbox and related settings.
4274   % This space should be enough, since a single number is .5em, and the
4303 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4335 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4344 % Space between chapter (or whatever) number and the title.
4430 % Define @lisp ... @end lisp.
4431 % @lisp does a \begingroup so it can rebind things,
4432 % including the definition of @end lisp (which normally is erroneous).
4434 % Amount to narrow the margins by for @lisp.
4437 % This is the definition that ^^M gets inside @lisp, @example, and other
4455 % This space is always present above and below environments.
4458 % Make spacing and below environment symmetrical.  We use \parskip here
4480 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
4513 %                                    side, and for 6pt waste from
4514 %                                    each corner char, and rule thickness
4516         % Flag to tell @lisp, etc., not to narrow margin.
4571 % \afterenvbreak's vertical glue), and then the group.  That way we keep
4578 % @lisp: indented, narrowed, typewriter font.
4579 \def\lisp{\begingroup
4587 % @example: Same as @lisp.
4588 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4590 % @smallexample and @smalllisp: use smaller fonts.
4596   \lisp
4601 % @display: same as @lisp except keep current font.
4650 % and narrows the margins.
4670 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4691 % Disable Spanish ligatures ?` and !` of \tt font
4705   \tt  % easiest (and conventionally used) font for verbatim
4710   % print special symbols as themselves, and
4736   % Easiest (and conventionally used) font for verbatim
4742   % print special symbols as themselves, and
4771 % we need not redefine '\', '{' and '}'.
4840 % beforehand -- and a) we want @copying to be done first in the source
4867 % Our approach is to make ^^M insert a space and a penalty1 normally;
4903 % @defun etc.
4914 % We want ()&[] to print specially on the defun line.
4939 % Definitions of (, ) and & used in args for functions.
4958 %% contained text.  This is especially needed for [ and ]
4985   % Get the values of \leftskip and \rightskip as they were outside the @def...
5026   % commands insert a \penalty10000, and we don't want to allow a break
5027   % between a section heading and a defun.
5050 % Process body of @defun, @deffn, @defmac, etc.
5074 % Used for @deftypemethod and @deftypeivar.
5089 % to account for this both in the \...x definition and in parsing the
5144 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5154 % Fine, but then we have to eventually remove the \empty *and* the
5160 % thing to call, #2 the type name (which starts with \empty), and #3
5172 % and the second is passed as empty.
5184 % Define @defun.
5196 % This expands the args and terminates the paragraph they comprise.
5201 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5218 % Do complete processing of one @defun or @defunx line already parsed.
5229 % @defun == @deffn Function
5231 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5243 % #1 is the data type.  #2 is the name and args.
5261 % #1 is the classification.  #2 is the data type.  #3 is the name and args.
5393 % This must expand the args and terminate the paragraph they make up
5458 % anywhere other than immediately after a @defun or @defunx.
5490    % Undo catcode changes of \startcontents and \doprintindex
5504 % Undo catcode changes of \startcontents and \doprintindex
5524 % Trim leading and trailing spaces off a string.
5547 % body, and then making it the \newlinechar in \scanmacro.
5590   \getargs{#1}%           now \macname is the macname and \argl the arglist
5642 % an opening brace, and that opening brace is not consumed.
5648 % Parse the optional {params} list.  Set up \paramno and \paramlist
5655 % unexpandable, insert that wherever you need a #, and then redefine
5672 % These two commands read recursive and nonrecursive macro bodies.
5673 % (They're different since rec and nonrec macros end differently.)
5680 % This defines the macro itself. There are six cases: recursive and
5681 % nonrecursive macros of zero, one, and many arguments.
5763 % sign.  Just make them active and then expand them all to nothing.
5824 % NAME-pg (the page number), and NAME-snt (section number and type).
5832 % and backslash work in node names.
5844 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
5881   % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5912      % @unnumbered and @anchor, it won't be.
6044   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6045   % argument, and \hat is not an expandable control sequence.  It could
6050   % and then to call \auxhat in \setq.
6081   % For example, @xrdef{$\leq $-fun}{page ...} made by @defun ^^
6140 % Oh yes, they do; otherwise, @ifset and anything else that uses
6190 % vertical list for the beginning and end of each change).
6198     % We want to insert a rule with the height and depth of the current
6209       % This is the space between the bar and the text.
6222 % If epsf.tex is not installed and @image is used, we complain.
6224 % Check for and read epsf.tex up front.  If we read it only at @image
6225 % time, we might be inside a group, and then its definitions would get
6226 % undone and the next image would fail.
6231   % doc/epsf.tex and on ctan).
6270     % above and below.
6291 % and i18n.
6337 % Following George Bush, just get rid of widows and orphans.
6427   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6429   % \normaloffset until the front-side and back-side texts align.  Then
6449 % He also recommends making @example and @lisp be small.
6491 % and/or leading, also. Or perhaps we should compute them somehow.
6519 \message{and turning on texinfo input format.}
6542 % where it can probably just be output, and another way in other fonts,
6547 % interword stretch (and shrink), and it is reasonable to expect all
6554 % italic fonts.  But since this is only used by $ and it uses \sl anyway
6559 % (and those which the user can use as if they were ordinary).
6599 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6646 % Make _ and + \other characters, temporarily.
6683 @c eval: (add-hook 'write-file-hooks 'time-stamp)