xemacs-beta: man/texinfo.texi comparison

comparison man/texinfo.texi @ 181:bfd6434d15b3 r20-3b17

Import from CVS: tag r20-3b17

author	cvs
date	Mon, 13 Aug 2007 09:53:19 +0200
parents	2d532a89d707
children	c9fe270a4101

comparison

equal deleted inserted replaced

-:add28d59e586
+:bfd6434d15b3
 \input texinfo.tex    @c -*-texinfo-*-
-@comment $Id: texinfo.texi,v 1.4 1997/07/19 22:11:50 steve Exp $
+@c $Id: texinfo.texi,v 1.5 1997/08/10 04:40:35 steve Exp $
-@comment %**start of header
+@c %**start of header
+@c All text is ignored before the setfilename.
+@setfilename texinfo
+@settitle Texinfo @value{edition}
 @set edition 2.24
 @set update-month July 1997
-@set update-date 15 @value{update-month}
+@set update-date 25 @value{update-month}
-@setfilename texinfo
-@settitle Texinfo @value{edition}
 @c Define a new index for options.
 @defcodeindex op
 @c Put everything except function (command, in this case) names in one
 @c index (arbitrarily chosen to be the concept index).
 @direntry
 * Texinfo: (texinfo).           The GNU documentation format.
 * install-info: (texinfo)Invoking install-info. Updating info/dir entries.
 * texi2dvi: (texinfo)Format with texi2dvi.      Printing Texinfo documentation.
 * texindex: (texinfo)Format with tex/texindex.  Sorting Texinfo index files.
-* makeinfo: (texinfo)makeinfo preferred.        Translate Texinfo source.
+* makeinfo: (texinfo)makeinfo Preferred.        Translate Texinfo source.
 @end direntry
 @c Set smallbook if printing in smallbook format so the example of the
 @c smallbook font is actually written using smallbook; in bigbook, a kludge
-@c is used for TeX output.
+@c is used for TeX output.  Do this through the -t option to texi2dvi,
-@smallbook
+@c so this same source can be used for other paper sizes as well.
-@set smallbook
+@c smallbook
+@c set smallbook
 @c @@clear smallbook
 @c Currently undocumented command, 5 December 1993:
 @c
 @c nwnode          (Same as node, but no warnings; for `makeinfo'.)
 * Heading Choice::              How to specify the type of page heading.
 * Custom Headings::             How to create your own headings and footings.
 Formatting Mistakes
-* makeinfo preferred::          @code{makeinfo} finds errors.
+* makeinfo Preferred::          @code{makeinfo} finds errors.
 * Debugging with Info::         How to catch errors with Info formatting.
 * Debugging with TeX::          How to catch errors with @TeX{} formatting.
 * Using texinfo-show-structure::  How to use @code{texinfo-show-structure}.
 * Using occur::                 How to list all lines containing a pattern.
 * Running Info-Validate::       How to find badly referenced nodes.
 file name.  (@xref{Tag and Split Files, , Tag Files and Split Files}.)
 The subfile name @file{texinfo.info-10}, for example, is too long for
 some systems; so the Info file name for this document is @file{texinfo}
 rather than @file{texinfo.info}.
+@cindex Ignored before @code{@@setfilename}
 The Info formatting commands ignore everything written before the
 @code{@@setfilename} line, which is why the very first line of
-the file (the @code{\input} line) does not need to be commented out.
+the file (the @code{\input} line) does not show up in the output.
 @pindex texinfo.cnf
 The @code{@@setfilename} line produces no output when you typeset a
 manual with @TeX{}, but it nevertheless is essential: it opens the
 index, cross-reference, and other auxiliary files used by Texinfo, and
 The converse of @code{@@inforef} is @code{@@cite}, which is used to
 refer to printed works for which no Info form exists.  @xref{cite, ,
 @code{@@cite}}.@refill
 @node uref,  , inforef, Cross References
 @section @code{@@uref@{@var{url}[, @var{displayed-text}]@}}
 @findex uref
 @cindex Uniform resource locator, referring to
 @cindex URL, referring to
 Indicate a uniform resource locator for the World Wide Web.
 @item @@file@{@var{file-name}@}
 Indicate the name of a file.@refill
-@item @@email@{@var{email-address}@}
+@item @@email@{@var{email-address}[, @var{displayed-text}]@}
 Indicate an electronic mail address.
 @item @@dfn@{@var{term}@}
 Indicate the introductory or defining use of a term.@refill
 In a printed manual, @code{@@ctrl} generates text to describe or
 identify that control character: an uparrow followed by the character
 @var{ch}.@refill
 @end ignore
 @node url, email, cite, Indicating
 @subsection @code{@@url}@{@var{uniform-resource-locator}@}
 @findex url
 @cindex Uniform resource locator, indicating
 @cindex URL, indicating
 @@url@{http://host.domain.org/path@}.
 @end example
 @node email,  , url, Indicating
-@subsection @code{@@email}@{@var{email-address}@}
+@subsection @code{@@email}@{@var{email-address}[, @var{displayed-text}]@}
 @findex email
 Use the @code{@@email} command to indicate an electronic mail address.
+It takes one mandatory argument, the address, and one optional argument, the
+text to display (the default is the address itself).
+@cindex mailto link
+In Info and @TeX{}, the address is shown in angle brackets, preceded by
+the text to display if any.  In HTML output, @code{@@email} produces a
+@samp{mailto} link that usually brings up a mail composition window.
 For example:
 @example
-Send bug reports to @@email@{bug-texinfo@@prep.ai.mit.edu@}.
+Send bug reports to @@email@{bug-texinfo@@@@prep.ai.mit.edu@}.
-@end example
+Send suggestions to the @@email@{bug-texinfo@@@@prep.ai.mit.edu, same place@}.
+@end example
-In Info and @TeX{}, this acts like @code{@@key} (it puts the argument in
+@noindent produces
-angle brackets).  When we have support for converting Texinfo to HTML,
+@example
-this will produce a link you can follow to bring up a mail composition
+Send bug reports to @email{bug-texinfo@@prep.ai.mit.edu}.
-window initialized with @var{email-address}.
+Send suggestions to the @email{bug-texinfo@@prep.ai.mit.edu, same place}.
+@end example
 @node Emphasis,  , Indicating, Marking Text
 @comment node-name,  next,  previous,  up
 @section Emphasizing Text
 @cindex Emphasizing text
 centimeter (2.54cm = 1in)
 @item mm
 @cindex Millimeters
 millimeter (10mm = 1cm)
 @item dd
-@cindex Did\^ot points
+@cindex Did@^ot points
-did\^ot point (1157dd = 1238pt)
+did@^ot point (1157dd = 1238pt)
 @item cc
 @cindex Ciceros
 cicero (1cc = 12dd)
 @item sp
 @cindex Scaled points
 @item @@dots@{@}
 Insert an ellipsis: @samp{@dots{}}.
 @xref{dots, , @code{@@dots}}.@refill
-@item @@email@{@var{address}@}
+@item @@email@{@var{address}[, @var{displayed-text}]@}
 Indicate an electronic mail address.
 @xref{email, , @code{@@email}}.@refill
 @need 100
 @item @@emph@{@var{text}@}
 Highlight @var{text}; text is displayed in @emph{italics} in printed
-output, and surrounded by asterisks in Info.  @xref{Emphasis, , Emphasizing Text}.@refill
+output, and surrounded by asterisks in Info.  @xref{Emphasis, ,
+Emphasizing Text}.
 @item @@end @var{environment}
 Ends @var{environment}, as in @samp{@@end example}.  @xref{Formatting
 Commands,,@@-commands}.
 For finding problems with the structure of nodes and chapters, you can use
 @kbd{C-c C-s} (@code{texinfo-show-structure}) and the related @code{occur}
 command and you can use the @kbd{M-x Info-validate} command.@refill
 @menu
-* makeinfo preferred::          @code{makeinfo} finds errors.
+* makeinfo Preferred::          @code{makeinfo} finds errors.
 * Debugging with Info::         How to catch errors with Info formatting.
 * Debugging with TeX::          How to catch errors with @TeX{} formatting.
 * Using texinfo-show-structure::  How to use @code{texinfo-show-structure}.
 * Using occur::                 How to list all lines containing a pattern.
 * Running Info-Validate::       How to find badly referenced nodes.
 @end menu
-@node makeinfo preferred, Debugging with Info, Catching Mistakes, Catching Mistakes
+@node makeinfo Preferred, Debugging with Info, Catching Mistakes, Catching Mistakes
 @ifinfo
 @heading @code{makeinfo} Find Errors
 @end ifinfo
 The @code{makeinfo} program does an excellent job of catching errors
 @code{makeinfo-buffer}) to format your file and check for other
 errors.  This is the best way to work with Texinfo.  But if you
 cannot use @code{makeinfo}, or your problem is very puzzling, then you
 may want to use the tools described in this appendix.@refill
-@node Debugging with Info, Debugging with TeX, makeinfo preferred, Catching Mistakes
+@node Debugging with Info, Debugging with TeX, makeinfo Preferred, Catching Mistakes
 @comment  node-name,  next,  previous,  up
 @appendixsec Catching Errors with Info Formatting
 @cindex Catching errors with Info formatting
 @cindex Debugging with Info formatting

Mercurial > hg > xemacs-beta

comparison man/texinfo.texi @ 181:bfd6434d15b3 r20-3b17