xemacs-beta: man/texinfo.texi comparison

comparison man/texinfo.texi @ 294:4b85ae5eabfb r21-0b45

Import from CVS: tag r21-0b45

author	cvs
date	Mon, 13 Aug 2007 10:38:01 +0200
parents	c9fe270a4101
children	70ad99077275

comparison

equal deleted inserted replaced

-:403535bfea94
+:4b85ae5eabfb
 \input texinfo.tex    @c -*-texinfo-*-
-@c $Id: texinfo.texi,v 1.6 1998/06/13 04:28:16 steve Exp $
+@c $Id: texinfo.texi,v 1.7 1998/06/20 00:58:34 steve Exp $
 @c %**start of header
 @c All text is ignored before the setfilename.
-@setfilename texinfo
+@setfilename ../info/texinfo
 @settitle Texinfo @value{edition}
 @c Edition number is now the same as the Texinfo distribution version number.
 @set edition 3.12
 @set update-month February 1998
 light-hearted, young and cheery.@refill
 @TeX{} is freely distributable.  It is written in a superset of Pascal
 called WEB and can be compiled either in Pascal or (by using a
 conversion program that comes with the @TeX{} distribution) in C.
-(@xref{TeX Mode, ,@TeX{} Mode, emacs, The GNU Emacs Manual}, for information
+(@xref{TeX Mode, ,@TeX{} Mode, xemacs, XEmacs User's Manual}, for information
 about @TeX{}.)@refill
 @TeX{} is very powerful and has a great many features.  Because a
 Texinfo file must be able to present information both on a
 character-only terminal in Info form and in a typeset book, the
 a regular expression matching the commands for chapters and their
 equivalents, such as appendices.  With this value for the page
 delimiter, you can jump from chapter title to chapter title with the
 @kbd{C-x ]} (@code{forward-page}) and @kbd{C-x [}
 (@code{backward-page}) commands and narrow to a chapter with the
-@kbd{C-x p} (@code{narrow-to-page}) command.  (@xref{Pages, , ,emacs,
+@kbd{C-x p} (@code{narrow-to-page}) command.  (@xref{Pages, , , xemacs,
-The GNU Emacs Manual}, for details about the page commands.)@refill
+XEmacs User's Manual}, for details about the page commands.)@refill
 You may name a Texinfo file however you wish, but the convention is to
 end a Texinfo file name with one of the three extensions
 @file{.texinfo}, @file{.texi}, or @file{.tex}.  A longer extension is
 preferred, since it is explicit, but a shorter extension may be
 in the structure of the current chapter.  In this case, you can mark
 off the region of the buffer that you are interested in by using the
 @kbd{C-x n n} (@code{narrow-to-region}) command and
 @code{texinfo-show-structure} will work on only that region.  To see
 the whole buffer again, use @w{@kbd{C-x n w}} (@code{widen}).
-(@xref{Narrowing, , , emacs, The GNU Emacs Manual}, for more
+(@xref{Narrowing, , , xemacs, XEmacs User's Manual}, for more
 information about the narrowing commands.)@refill
 @vindex page-delimiter
 @cindex Page delimiter in Texinfo mode
 In addition to providing the @code{texinfo-show-structure} command,
 Texinfo mode sets the value of the page delimiter variable to match
 the chapter-level @@-commands.  This enables you to use the @kbd{C-x
 ]} (@code{forward-page}) and @kbd{C-x [} (@code{backward-page})
 commands to move forward and backward by chapter, and to use the
 @kbd{C-x p} (@code{narrow-to-page}) command to narrow to a chapter.
-@xref{Pages, , , emacs, The GNU Emacs Manual}, for more information
+@xref{Pages, , , xemacs, XEmacs User's Manual}, for more information
 about the page commands.@refill
 @node Updating Nodes and Menus, Info Formatting, Showing the Structure, Texinfo Mode
 @comment  node-name,  next,  previous,  up
 @section Updating Nodes and Menus
 The @code{texinfo-column-for-description} variable specifies the
 column to which menu descriptions are indented.  By default, the value
 is 32 although it is often useful to reduce it to as low as 24.  You
 can set the variable with the @kbd{M-x edit-options} command
-(@pxref{Edit Options, , Editing Variable Values, emacs, The GNU Emacs
+(@pxref{Edit Options, , Editing Variable Values, xemacs, XEmacs User's
-Manual}) or with the @kbd{M-x set-variable} command (@pxref{Examining,
+Manual}) or with the @kbd{M-x set-variable} command (@pxref{Examining, ,
-, Examining and Setting Variables, emacs, The GNU Emacs
+Examining and Setting Variables, xemacs, XEmacs User's Manual}).@refill
-Manual}).@refill
 Also, the @code{texinfo-indent-menu-description} command may be used to
 indent existing menu descriptions to a specified column.  Finally, if
 you wish, you can use the @code{texinfo-insert-node-lines} command to
 insert missing @code{@@node} lines into a file.  (@xref{Other Updating
 @example
 The official GNU ftp site is
 @@uref@{ftp://ftp.gnu.ai.mit.edu/pub/gnu@}
 @end example
-@noindent produces (in text):
+@noindent
+produces (in text):
 @display
 The official GNU ftp site is
 @uref{ftp://ftp.gnu.ai.mit.edu/pub/gnu}
 @end display
-@noindent whereas
+@noindent
+whereas
 @example
 The official
 @@uref@{ftp://ftp.gnu.ai.mit.edu/pub/gnu,
 GNU ftp site@} holds programs and texts.
 @end example
-@noindent produces (in text):
+@noindent
+produces (in text):
 @display
 The official @uref{ftp://ftp.gnu.ai.mit.edu/pub/gnu, GNU ftp site} holds
 programs and texts.
 @end display
-@noindent and (in HTML):
+@noindent
+and (in HTML):
 @example
 The official <A HREF="ftp://ftp.gnu.ai.mit.edu/pub/gnu">GNU ftp
 site</A> holds programs and texts.
 @end example
 @example
 Send bug reports to @@email@{bug-texinfo@@@@gnu.org@}.
 Send suggestions to the @@email@{bug-texinfo@@@@gnu.org, same place@}.
 @end example
-@noindent produces
+@noindent
+produces
 @example
 Send bug reports to @email{bug-texinfo@@gnu.org}.
 Send suggestions to the @email{bug-texinfo@@gnu.org, same place}.
 @end example
 @example
 @@multitable @@columnfractions .33 .33 .33
 @end example
-@noindent The fractions need not add up exactly to 1.0, as these do
+@noindent
+The fractions need not add up exactly to 1.0, as these do
 not.  This allows you to produce tables that do not need the full line
 length.
 @item
 @cindex Prototype row, column widths defined by
 Line breaks are not special within the table body, and you may break
 input lines in your source file as necessary.
 Here is a complete example of a multi-column table (the text is from
 @cite{The GNU Emacs Manual}, @pxref{Split Window,, Splitting Windows,
-emacs, The GNU Emacs Manual}):
+xemacs, XEmacs User's Manual}):
 @example
 @@multitable @@columnfractions .15 .45 .4
 @@item Key @@tab Command @@tab Description
 @@item C-x 2
 @@tab In the mode line or scroll bar of a window,
 split that window.
 @@end multitable
 @end example
-@noindent produces:
+@noindent
+produces:
 @multitable @columnfractions .15 .45 .4
 @item Key @tab Command @tab Description
 @item C-x 2
 @tab @code{split-window-vertically}
 In the Info file output, @code{@@.}@: is equivalent to a simple
 @samp{.}; likewise for @code{@@!}@: and @code{@@?}@:.
 The meanings of @code{@@:} and @code{@@.}@: in Texinfo are designed to
 work well with the Emacs sentence motion commands (@pxref{Sentences,,,
-emacs, The GNU Emacs Manual}).  This made it necessary for them to be
+xemacs, XEmacs User's Manual}).  This made it necessary for them to be
 incompatible with some other formatting systems that use @@-commands.
 Do not put braces after any of these commands.
 @example
 Spacey@@ @@ @@ @@
 example.
 @end example
-@noindent produces
+@noindent
+produces
 @example
 Spacey@ @ @ @
 example.
 @end example
 Tell @TeX{} how to hyphenate @var{hy-phen-a-ted words}.  As shown, you
 put a @samp{-} at each hyphenation point.  For example:
 @example
 @@hyphenation@{man-u-script man-u-scripts@}
 @end example
-@noindent @TeX{} only uses the specified hyphenation points when the
+@noindent
+@TeX{} only uses the specified hyphenation points when the
 words match exactly, so give all necessary variants.
 @end table
 Info output is not hyphenated, so these commands have no effect there.
 @findex defspec
 @item @@defspec @var{name} @var{arguments}@dots{}
 The @code{@@defspec} command is the definition command for special
 forms.  (In Lisp, a special form is an entity much like a function,
-@pxref{Special Forms,,, elisp, GNU Emacs Lisp Reference Manual}.)
+@pxref{Special Forms,,, lispref, XEmacs Lisp Reference Manual}.)
 @code{@@defspec} is equivalent to @samp{@@deffn @{Special Form@}
 @dots{}} and works like @code{@@defun}.@refill
 @end table
 @node Variables Commands, Typed Functions, Functions Commands, Def Cmds in Detail
 @findex defopt
 @item @@defopt @var{name}
 @cindex User options, marking
 The @code{@@defopt} command is the definition command for @dfn{user
 options}, i.e., variables intended for users to change according to
-taste; Emacs has many such (@pxref{Variables,,, emacs, The GNU Emacs
+taste; Emacs has many such (@pxref{Variables,,, xemacs, XEmacs User's
 Manual}).  @code{@@defopt} is equivalent to @samp{@@defvr @{User
 Option@} @dots{}} and works like @code{@@defvar}.@refill
 @end table
 A function definition uses the @code{@@defun} and @code{@@end defun}
 commands.  The name of the function follows immediately after the
 @code{@@defun} command and it is followed, on the same line, by the
 parameter list.@refill
-Here is a definition from @ref{Calling Functions,,, elisp, The GNU Emacs
+Here is a definition from @ref{Calling Functions,,, lispref, XEmacs Lisp
-Lisp Reference Manual}.
+Reference Manual}.
 @quotation
 @defun apply function &rest arguments
 @code{apply} calls @var{function} with @var{arguments}, just
 like @code{funcall} but with one difference: the last of
 @code{texinfo-format-region} to create the Info file, the value of the
 @code{texinfo-footnote-style} variable controls the footnote style.
 It can be either @samp{"separate"} for the separate node style or
 @samp{"end"} for the end of node style.  (You can change the value of
 this variable with the @kbd{M-x edit-options} command (@pxref{Edit
-Options, , Editing Variable Values, emacs, The GNU Emacs Manual}), or
+Options, , Editing Variable Values, xemacs, XEmacs User's Manual}), or
 with the @kbd{M-x set-variable} command (@pxref{Examining, , Examining
-and Setting Variables, emacs, The GNU Emacs Manual}).@refill
+and Setting Variables, xemacs, XEmacs User's Manual}).@refill
 The @code{texinfo-footnote-style} variable also controls the style if
 you use the @kbd{M-x makeinfo-region} or @kbd{M-x makeinfo-buffer}
 command in Emacs.@refill
 @end ignore
 @example
 @@@var{macro-name} @{@var{arg1}, @var{arg2}, @dots{}@}
 @end example
-@noindent and the result will be just as if you typed the body of
+@noindent
+and the result will be just as if you typed the body of
 @var{macro-name} at that spot.  For example:
 @example
 @@macro foo @{p, q@}
 Together: \p\ & \q\.
 @@end macro
 @@foo@{a, b@}
 @end example
-@noindent produces:
+@noindent
+produces:
 @display
 Together: a & b.
 @end display
 Twice: \p\, \p\.
 @@end macro
 @@bar aah
 @end example
-@noindent produces:
+@noindent
+produces:
 @display
 Twice: aah, aah.
 @end display
 @example
 tex foo.texi
 @end example
-@noindent @TeX{} will produce a @dfn{DVI file} as well as several auxiliary
+@noindent
+@TeX{} will produce a @dfn{DVI file} as well as several auxiliary
 files containing information for indices, cross references, etc.  The
 DVI file (for @dfn{DeVice Independent} file) can be printed on virtually
 any printe (see the following sections).
 @pindex texindex
 @end group
 @end example
 You can change the values of these variables with the @kbd{M-x
 edit-options} command (@pxref{Edit Options, , Editing Variable Values,
-emacs, The GNU Emacs Manual}), with the @kbd{M-x set-variable} command
+xemacs, XEmacs User's Manual}), with the @kbd{M-x set-variable} command
-(@pxref{Examining, , Examining and Setting Variables, emacs, The GNU
+(@pxref{Examining, , Examining and Setting Variables, xemacs, XEmacs
-Emacs Manual}), or with your @file{.emacs} initialization file
+User's Manual}), or with your @file{.emacs} initialization file
-(@pxref{Init File, , , emacs, The GNU Emacs Manual}).@refill
+(@pxref{Init File, , , xemacs, XEmacs User's Manual}).@refill
 @node Compile-Command, Requirements Summary, Texinfo Mode Printing, Format/Print Hardcopy
 @comment  node-name,  next,  previous,  up
 @section Using the Local Variables List
 @cindex Local variables
 @end group
 @end example
 @noindent
 This technique is most often used by programmers who also compile programs
-this way; see @ref{Compilation, , , emacs, The GNU Emacs Manual}.@refill
+this way; see @ref{Compilation, , , xemacs, XEmacs User's Manual}.@refill
 @node Requirements Summary, Preparing for TeX, Compile-Command, Format/Print Hardcopy
 @comment  node-name,  next,  previous,  up
 @section @TeX{} Formatting Requirements Summary
 @findex next-error
 You can parse the error messages by typing @kbd{C-x `}
 (@code{next-error}).  This causes Emacs to go to and position the
 cursor on the line in the Texinfo source that @code{makeinfo} thinks
 caused the error.  @xref{Compilation, , Running @code{make} or
-Compilers Generally, emacs, The GNU Emacs Manual}, for more
+Compilers Generally, xemacs, XEmacs User's Manual}, for more
 information about using the @code{next-error} command.@refill
 In addition, you can kill the shell in which the @code{makeinfo}
 command is running or make the shell buffer display its most recent
 output.@refill
 Manual}.
 @end iftex
 @noindent
 @ifinfo
 For more information, see@*
-@ref{Edit Options, , Editing Variable Values, emacs, The GNU Emacs Manual},@*
+@ref{Edit Options, , Editing Variable Values, xemacs, XEmacs User's Manual},@*
-@ref{Examining, , Examining and Setting Variables, emacs, The GNU Emacs Manual},@*
+@ref{Examining, , Examining and Setting Variables, xemacs, XEmacs User's Manual},@*
-@ref{Init File, , , emacs, The GNU Emacs Manual}, and@*
+@ref{Init File, , , xemacs, XEmacs User's Manual}, and@*
 @ref{makeinfo options, , Options for @code{makeinfo}}.
 @end ifinfo
 @node texinfo-format commands, Batch Formatting, makeinfo in Emacs, Create an Info File
 @comment  node-name,  next,  previous,  up
 @cindex Info batch formatting
 You can format Texinfo files for Info using @code{batch-texinfo-format}
 and Emacs Batch mode.  You can run Emacs in Batch mode from any shell,
 including a shell inside of Emacs.  (@xref{Command Switches, , Command
-Line Switches and Arguments, emacs, The GNU Emacs Manual}.)@refill
+Line Switches and Arguments, xemacs, XEmacs User's Manual}.)@refill
 Here is a shell command to format all the files that end in
 @file{.texinfo} in the current directory:
 @example
 off file that is needed at the time.  This way, Emacs avoids wasting
 memory when you run Info.  (Before splitting was implemented, Info
 files were always kept short and @dfn{include files} were designed as
 a way to create a single, large printed manual out of the smaller Info
 files.  @xref{Include Files}, for more information.  Include files are
-still used for very large documents, such as @cite{The Emacs Lisp
+still used for very large documents, such as @cite{The XEmacs Lisp
 Reference Manual}, in which each chapter is a separate file.)@refill
 When a file is split, Info itself makes use of a shortened version of
 the original file that contains just the tag table and references to
 the files that were split off.  The split off files are called
 and the printed manual.@refill
 Also, if you are writing a manual about software, you should explain
 that the software is free and either include the GNU General Public
 License (GPL) or provide a reference to it.  @xref{Distrib, ,
-Distribution, emacs, The GNU Emacs Manual}, for an example of the text
+Distribution, xemacs, XEmacs User's Manual}, for an example of the text
 that could be used in the software ``Distribution'', ``General Public
 License'', and ``NO WARRANTY'' sections of a document.  @xref{Copying,
 , Texinfo Copying Conditions}, for an example of a brief explanation
 of how the copying conditions provide you with rights. @refill
 @@printindex cp
 @end group
 @end example
-The outer Texinfo source file for @cite{The GNU Emacs Lisp Reference
+The outer Texinfo source file for @cite{The XEmacs Lisp Reference
 Manual} is named @file{elisp.texi}.  This outer file contains a master
 menu with 417 entries and a list of 41 @code{@@include}
 files.@refill
 @node Include Files Evolution,  , Sample Include File, Include Files
 However, because large Info files are now split automatically, it is
 no longer necessary to keep them small.@refill
 Nowadays, multiple Texinfo files are used mostly for large documents,
-such as @cite{The GNU Emacs Lisp Reference Manual}, and for projects
+such as @cite{The XEmacs Lisp Reference Manual}, and for projects
 in which several different people write different sections of a
 document simultaneously.@refill
 In addition, the Info formatting commands have been extended to work
 with the @code{@@include} command so as to create a single large Info
 @code{texinfo-format-xref} and @code{texinfo-format-parse-args}.
 Inside the function @code{texinfo-format-parse-args}, the function
 @code{re-search-forward} was called; it was this function that could
 not find the missing right-hand brace.@refill
-@xref{Lisp Debug, , Debugging Emacs Lisp, emacs, The GNU Emacs
+@xref{Lisp Debug, , Debugging Emacs Lisp, xemacs, XEmacs User's Manual},
-Manual}, for more information.@refill
+for more information.@refill
 @end ignore
 @node Debugging with TeX, Using texinfo-show-structure, Debugging with Info, Catching Mistakes
 @comment  node-name,  next,  previous,  up
 @appendixsec Catching Errors with @TeX{} Formatting
 with the @code{@@section}, @code{@@subheading}, and @code{@@subsection}
 commands respectively.  If you move your cursor into the @samp{*Occur*}
 window, you can position the cursor over one of the lines and use the
 @kbd{C-c C-c} command (@code{occur-mode-goto-occurrence}), to jump to
 the corresponding spot in the Texinfo file.  @xref{Other Repeating
-Search, , Using Occur, emacs, The GNU Emacs Manual}, for more
+Search, , Using Occur, xemacs, XEmacs User's Manual}, for more
 information about @code{occur-mode-goto-occurrence}.@refill
 The first line in the @samp{*Occur*} window describes the @dfn{regular
 expression} specified by @var{texinfo-heading-pattern}.  This regular
 expression is the pattern that @code{texinfo-show-structure} looks for.
-@xref{Regexps, , Using Regular Expressions, emacs, The GNU Emacs Manual},
+@xref{Regexps, , Using Regular Expressions, xemacs, XEmacs User's Manual},
 for more information.@refill
 When you invoke the @code{texinfo-show-structure} command, Emacs will
 display the structure of the whole buffer.  If you want to see the
 structure of just a part of the buffer, of one chapter, for example,
 use the @kbd{C-x n n} (@code{narrow-to-region}) command to mark the
-region.  (@xref{Narrowing, , , emacs, The GNU Emacs Manual}.)  This is
+region.  (@xref{Narrowing, , , xemacs, XEmacs User's Manual}.)  This is
 how the example used above was generated.  (To see the whole buffer
 again, use @kbd{C-x n w} (@code{widen}).)@refill
 If you call @code{texinfo-show-structure} with a prefix argument by
 typing @w{@kbd{C-u C-c C-s}}, it will list lines beginning with
 @end example
 @noindent
 and then, when prompted, type a @dfn{regexp}, a regular expression for
 the pattern you want to match.  (@xref{Regexps, , Regular Expressions,
-emacs, The GNU Emacs Manual}.)  The @code{occur} command works from
+xemacs, XEmacs User's Manual}.)  The @code{occur} command works from the
-the current location of the cursor in the buffer to the end of the
+current location of the cursor in the buffer to the end of the buffer.
-buffer.  If you want to run @code{occur} on the whole buffer, place
+If you want to run @code{occur} on the whole buffer, place the cursor at
-the cursor at the beginning of the buffer.@refill
+the beginning of the buffer.@refill
 For example, to see all the lines that contain the word
 @samp{@@chapter} in them, just type @samp{@@chapter}.  This will
 produce a list of the chapters.  It will also list all the sentences
 with @samp{@@chapter} in the middle of the line.@refill
 or phrase, end the last word with a @samp{$}; for example,
 @samp{catching mistakes$}.  This can be helpful when you want to see
 all the nodes that are part of the same chapter or section and
 therefore have the same `Up' pointer.@refill
-@xref{Other Repeating Search, , Using Occur, emacs , The GNU Emacs Manual},
+@xref{Other Repeating Search, , Using Occur, xemacs, XEmacs User's Manual},
 for more information.@refill
 @node Running Info-Validate,  , Using occur, Catching Mistakes
 @comment  node-name,  next,  previous,  up
 @appendixsec Finding Badly Referenced Nodes
 Telephone: +1-206-543-2268
 Electronic mail: @code{mackay@@cs.washington.edu}
 @end group
 @end display
-@noindent Please make checks payable to the University of Washington.
+@noindent
+Please make checks payable to the University of Washington.
 Checks must be in U.S.@: dollars, drawn on a U.S.@: bank.  Overseas
 sites: please add to the base cost, if desired, $20.00 for shipment via
 air parcel post, or $30.00 for shipment via courier.
 @end itemize

Mercurial > hg > xemacs-beta

comparison man/texinfo.texi @ 294:4b85ae5eabfb r21-0b45