texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

texinfo ChangeLog doc/texinfo.txi doc/version.texi


From: Patrice Dumas
Subject: texinfo ChangeLog doc/texinfo.txi doc/version.texi
Date: Sun, 18 Jul 2010 23:01:03 +0000

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Patrice Dumas <pertusus>        10/07/18 23:01:03

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi version.texi 

Log message:
                * doc/texinfo.txi (Generic converter texi2any/makeinfo): add a
                chapter for texi2any/makeinfo. Merge Invoking makeinfo and
                makeinfo options and put it in the chapter as Invoking 
texi2any, 
                together with Pointer Validation and the description of 
                texi2any Configuration variables.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1062&r2=1.1063
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.257&r2=1.258
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/version.texi?cvsroot=texinfo&r1=1.81&r2=1.82

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1062
retrieving revision 1.1063
diff -u -b -r1.1062 -r1.1063
--- ChangeLog   18 Jul 2010 18:49:02 -0000      1.1062
+++ ChangeLog   18 Jul 2010 23:01:02 -0000      1.1063
@@ -1,3 +1,11 @@
+2010-07-19  Patrice Dumas  <address@hidden>
+
+       * doc/texinfo.txi (Generic converter texi2any/makeinfo): add a
+       chapter for texi2any/makeinfo. Merge Invoking makeinfo and
+       makeinfo options and put it in the chapter as Invoking texi2any, 
+       together with Pointer Validation and the description of 
+       texi2any Configuration variables.
+
 2010-07-18  Karl Berry  <address@hidden>
 
        * AUTHORS, 

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.257
retrieving revision 1.258
diff -u -b -r1.257 -r1.258
--- doc/texinfo.txi     18 Jul 2010 10:47:08 -0000      1.257
+++ doc/texinfo.txi     18 Jul 2010 23:01:02 -0000      1.258
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.257 2010/07/18 10:47:08 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.258 2010/07/18 23:01:02 pertusus Exp $
 @c Ordinarily, Texinfo files have the extension .texi.  But texinfo.texi
 @c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
 
@@ -160,6 +160,7 @@
 * Defining New Texinfo Commands:: User-defined macros and aliases.
 * Include Files::                 How to incorporate other Texinfo files.
 * Hardcopy::                            Output for paper, with @TeX{}.
+* Generic converter texi2any/makeinfo:: The all purpose converter.
 * Creating and Installing Info Files::  Details on Info output.
 * Generating HTML::               Details on HTML output.
 
@@ -599,6 +600,13 @@
 * PDF Output::                  Portable Document Format output.
 * Obtaining TeX::               How to Obtain @TeX{}.
 
+Generic converter texi2any/makeinfo
+
+* Invoking texi2any::           How to run @command{texi2any} and 
@command{makeinfo} 
+                                from a shell.
+* Pointer Validation::          How to check that pointers point somewhere.
+* Configuration variables::     Description of configuration variables.
+
 Creating and Installing Info Files
 
 * Creating an Info File::
@@ -607,9 +615,6 @@
 Creating an Info File
 
 * makeinfo advantages::         @code{makeinfo} provides better error checking.
-* Invoking makeinfo::           How to run @code{makeinfo} from a shell.
-* makeinfo options::            Specify fill-column and other options.
-* Pointer Validation::          How to check that pointers point somewhere.
 * makeinfo in Emacs::           How to run @code{makeinfo} from Emacs.
 * texinfo-format commands::     Two Info formatting commands written
                                  in Emacs Lisp are an alternative
@@ -15883,97 +15888,82 @@
 Many other @TeX{} distributions are available; see
 @uref{http://tug.org/}.
 
address@hidden Generic converter texi2any/makeinfo
address@hidden A generic converter for Texinfo: 
@command{texi2any}/@command{makeinfo}
 
address@hidden Creating and Installing Info Files
address@hidden Creating and Installing Info Files
-
-This chapter describes how to create and install Info files.  @xref{Info
-Files}, for general information about the file format itself.
-
address@hidden
-* Creating an Info File::
-* Installing an Info File::
address@hidden menu
-
-
address@hidden Creating an Info File
address@hidden Creating an Info File
address@hidden Creating an Info file
address@hidden Info, creating an online file
address@hidden Formatting a file for Info
-
address@hidden is a program that converts a Texinfo file into an Info
-file, HTML file, or plain text.  @code{texinfo-format-region} and
address@hidden are GNU Emacs functions that convert
-Texinfo to Info.
-
-For information on installing the Info file in the Info system,
address@hidden an Info File}.
address@hidden is a generic converter for Texinfo that can produce
+different output formats and is highly customizable. 
+By default, the formats that may be produced are 
+Info (with @option{--info}), HTML (with
address@hidden), plain text (with @option{--plaintext}), Docbook 
+(with @option{--docbook}), Texinfo XML (with @option{--xml}). 
address@hidden is an alias of @command{texi2any}, and using this command
+is the same as using @code{texi2any --info}.
+
+Without any command line option, @command{texi2any} generates raw text with
+minimal formatting, well suited for customization. It is not advised to
+use this output format to generate documents, however, since it is 
+very basic. You should produce plain text instead, with 
address@hidden
+
+Beside those default formats, with @command{texi2any} some important
+aspects of the result may be specified via command line options,
+and configuration files provide an even finer degree of control
+over the final output, allowing most every aspect of the final output not
+specified in the Texinfo input file to be specified.  Configuration files are
+written in @command{perl}, like the main program, and anything which may be
+specified on the command line may also be specified within a configuration
+file.
 
 @menu
-* makeinfo advantages::         @code{makeinfo} provides better error checking.
-* Invoking makeinfo::           How to run @code{makeinfo} from a shell.
-* makeinfo options::            Specify fill-column and other options.
+* Invoking texi2any::           How to run @command{texi2any} or 
@command{makeinfo} 
+                                from a shell.
 * Pointer Validation::          How to check that pointers point somewhere.
-* makeinfo in Emacs::           How to run @code{makeinfo} from Emacs.
-* texinfo-format commands::     Two Info formatting commands written
-                                 in Emacs Lisp are an alternative
-                                 to @code{makeinfo}.
-* Batch Formatting::            How to format for Info in Emacs Batch mode.
-* Tag and Split Files::         How tagged and split files help Info
-                                 to run better.
+* Configuration variables::     Description of configuration variables.
 @end menu
 
address@hidden Invoking texi2any
address@hidden Running @command{texi2any}/@code{makeinfo} from a Shell
address@hidden makeinfo
address@hidden texi2any
 
address@hidden makeinfo advantages
address@hidden @code{makeinfo} Preferred
-
-The @code{makeinfo} utility creates an Info file from a Texinfo source
-file more quickly than either of the Emacs formatting commands and
-provides better error messages.  We recommend it.  @code{makeinfo} is a
-C program that is independent of Emacs.  You do not need to run Emacs to
-use @code{makeinfo}, which means you can use @code{makeinfo} on machines
-that are too small to run Emacs.  You can run @code{makeinfo} in any one
-of three ways: from an operating system shell, from a shell inside
-Emacs, or by typing the @kbd{C-c C-m C-r} or the @kbd{C-c C-m C-b}
-command in Texinfo mode in Emacs.
-
-The @code{texinfo-format-region} and the @code{texinfo-format-buffer}
-commands are useful if you cannot run @code{makeinfo}.  Also, in some
-circumstances, they format short regions or buffers more quickly than
address@hidden
-
+To process a Texinfo file, invoke @command{texi2any} or 
address@hidden followed by the 
+name of the Texinfo file.  Also select the format you want to output
+with the appropriate command line option (default is Info for 
address@hidden).  Thus, to create the Info file for Bison, type 
+the following to the shell:
 
address@hidden Invoking makeinfo
address@hidden Running @code{makeinfo} from a Shell
address@hidden makeinfo
address@hidden
+texi2any --info bison.texinfo
address@hidden example
 
-To create an Info file from a Texinfo file, invoke @command{makeinfo}
-followed by the name of the Texinfo file.  Thus, to create the Info
-file for Bison, type the following to the shell:
+or
 
 @example
 makeinfo bison.texinfo
 @end example
 
-(You can run a shell inside Emacs by typing @kbd{M-x shell}.)
 
address@hidden has many options to control its actions and output;
-see the next section.
address@hidden FIXME is it relevant here?
address@hidden (You can run a shell inside Emacs by typing @kbd{M-x shell}.)
+
address@hidden @command{makeinfo} has many options to control its actions and 
output;
address@hidden see the next section.
 
 You can give @command{makeinfo} more than one input file name; each is
 processed in turn.  If an input file name is @samp{-}, or no input
 file names are given at all, standard input is read.
 
-
address@hidden makeinfo options
address@hidden Options for @code{makeinfo}
address@hidden options}
 @cindex @code{makeinfo} options
 @cindex Options for @code{makeinfo}
 
-The @command{makeinfo} program accepts many options.  Perhaps the most
+The @command{texi2any}/@command{makeinfo} programs accept 
+many options.  Perhaps the most
 commonly needed are those that change the output format.  By default,
address@hidden outputs Info files.
address@hidden outputs Info files, while @command{texi2any} outputs
+raw text with minimal formatting.
 
 Each command line option is a word preceded by @samp{--} or a letter
 preceded by @samp{-}.  You can use abbreviations for the long option
@@ -16125,11 +16115,20 @@
 
 @item --html
 @opindex --html
-Generate HTML output rather than Info.  @xref{Generating HTML}.  By
+Generate HTML output.  @xref{Generating HTML}.  By
 default, the HTML output is split into one output file per Texinfo
 source node, and the split output is written into a subdirectory with
 the name of the top-level info file.
 
address@hidden --info
address@hidden --info
+Generate Info output.  By default, if the output file contains more 
+than about 300,000 bytes, the large Info output file is split 
+into shorter @dfn{indirect} subfiles of about 300,000 bytes each.  
+The name of the output file and of the indirect subfiles is 
+determined by @code{@@setfilename} (@pxref{setfilename}).  
address@hidden and Split Files}.
+
 @item -I @var{dir}
 @opindex -I @var{dir}
 Append @var{dir} to the directory search list for finding files that
@@ -16407,14 +16406,14 @@
 
 
 @node Pointer Validation
address@hidden Pointer Validation
address@hidden Pointer Validation
 @cindex Pointer validation with @code{makeinfo}
 @cindex Validation of pointers
 
 If you do not suppress pointer validation with the @samp{--no-validate}
 option or the @code{@@novalidate} command in the source file (@pxref{Use
-TeX,,Use @TeX{}}), @code{makeinfo} will check the validity of the final
-Info file.  Mostly, this means ensuring that nodes you have referenced
+TeX,,Use @TeX{}}), @code{makeinfo} will check the validity of the
+Texinfo file.  Mostly, this means ensuring that nodes you have referenced
 really exist.  Here is a complete list of what is checked:
 
 @enumerate
@@ -16449,6 +16448,421 @@
 address@hidden
 @end enumerate
 
address@hidden Configuration variables
address@hidden Configuration variables
+
+Many aspects of the behaviour and output may be modified by modifying 
+configuration variables. 
+The Configuration variables are either
address@hidden @bullet
address@hidden associated with @@-commands in the document,
+for example @code{@@documentlanguage},
address@hidden associated with 
+configuration variables that
+may also be set on the command-line, for example @code{SPLIT} which is
+associated with the @option{--split} command-line switch,
address@hidden other 
+configuration variables, for example @code{NO_CSS} which may be set to 0
+in case one does not want CSS. Those configuration variables may always be set
+on the command-line, using
address@hidden
+--set-init-variable 'VAR_NAME value'
address@hidden example
+or
address@hidden
+--set-init-variable VAR_NAME=value
address@hidden example
+
+where @var{VAR_NAME} is the variable name, for example @code{SPLIT} or
address@hidden, and @var{value} is the value of the variable. A special
+value is @samp{undef} the sets the variable to this special @command{perl}
+value.
address@hidden itemize
+
+The list of configuration variables associated with @@-commands is
+in @ref{Configuration variables for @@-commands}, the list and mapping
+of configuration variables associated with command line options is at 
address@hidden variables and options}.
+
+The other configuration variables are:
+
address@hidden @code
address@hidden DEBUG
+The integer value specifies what kind of debugging output is generated.
+It is a bitmask. Setting it to 255 ensures having all the debugging
+set.
address@hidden FRAMES
+For HTML. If set, a file describing the frame layout is generated, 
+together with a file with the short table of contents.
address@hidden DOCTYPE
+For HTML, XML, Docbook.
+The SystemLiteral, the entity's system identifier.  It is a URI, which 
+may be used to retrieve the entity, and it identifies the canonical DTD 
+for the document.
address@hidden FRAMESET_DOCTYPE
+For HTML.  Same as DOCTYPE, but for the file containing the frame description.
address@hidden TEST
+If this value is true, some variables which should be dynamically generated
+(the date, the program name, the version) are set to fixed and given values. 
+This is usefull in case the resulting manual is compared with a reference. 
+For example this is used in the tests.
address@hidden DUMP_TEXI
+Mainly useful for debugging.  If set, the result of the first pass is
+put in @file{<document name>.passtexi}, the result of the second pass is 
+put in @file{<document name>.passfirst}.
address@hidden TOP_FILE
+This file name may be used for the top-level file.  The extension is set 
+appropriately, if necessary. This is used to override the default, and is, in
+general only taken into account when split.
address@hidden TOC_FILE
+This file name is used for the table of contents.  The extension is set 
+appropriately, if necessary.  It is only used if split and 
address@hidden is not set.  Default is @file{<document name>_toc.html}.
address@hidden SHOW_MENU
+If set, the Texinfo menus are shown.  It is set in all the formats, for 
+exmaple it is true for HTML (except if @option{--no-headers} is used),
+Info and XML, but not for Docbook.
address@hidden USE_NODES
+Use nodes preferentially to decide where elements are separated.
address@hidden USE_SECTIONS
+Use sectionning @@-commands preferentially to decide where elements are 
+separated.
address@hidden TOC_LINKS
+For HTML. If set links from headings to toc entries are created.
address@hidden SHORTEXTN
+The default extension is set to @samp{.htm}.
address@hidden PREFIX
+This set the output file prefix, that may be prepended to some output 
+files.  In the default case it is set by @code{@@setfilename} or from
+the input file (@pxref{setfilename}).  How this value is used depends
+on the value of other configuration variables or command line options,
+like split, @code{NODE_FILENAMES}.
address@hidden SHORT_REF
+For HTML.  If this is set internal cross-references are given without the 
address@hidden word, even if the target of the reference is a section.
address@hidden IDX_SUMMARY
+If set, for each @code{@@printindex}, a file @file{<document name>_<index 
name>.idx}
+is created which contains lines of the form
address@hidden
address@hidden @var{reference}
address@hidden example
+sorted alphabetically (case matters).
address@hidden DEF_TABLE
+For HTML.  If this is set a table construction for @code{@@deffn} and similar
+@@-commands is used (looking more like @TeX{} output), instead of 
+definition lists.
address@hidden L2H
+For HTML.  If set, @command{latex2html} is used to convert @code{@@math}
+and @code{@@tex} sections.  Best used with @option{--iftex}.
address@hidden L2H_L2H
+Program invoked as @command{latex2html} if @code{L2H} is set.
address@hidden L2H_SKIP
+Relevant only is @code{L2H} is set. 
+If this is set the actual call to @command{latex2html} is skipped. 
+The previously generated content is reused, instead.
+If set to 0, the cache is not used.
+If undef the cache is used for as many @TeX{} fragments as possible
+and for the remaining the command is run.
address@hidden L2H_TMP
+Relevant only is @code{L2H} is set.  Set the directory used for temporary 
+files. The path leading to this directory may not contain a dot 
address@hidden otherwise, @command{latex2html} will fail (because of dvips).
address@hidden L2H_FILE
+Relevant only is @code{L2H} is set. 
+If set, this file is sued as @command{latex2html} init file.
address@hidden L2H_CLEAN
+Relevant only is @code{L2H} is set. 
+if this is set the intermediate files generated in relation with
address@hidden with @command{latex2html} are cleaned.
address@hidden L2H_HTML_VERSION
+Relevant only is @code{L2H} is set.
+The HTML version used in the @command{latex2html} call.
address@hidden MONOLITHIC
+For HTML.  Output only one file including the table of content. 
+It only makes sense when not split, and it is set in the default case.
address@hidden IGNORE_PREAMBLE_TEXT
+If this is set the text before @@node and sectioning commands is ignored.
+This is a backward compatibility configuration variable you certainly 
+shouldn't use.
address@hidden EXTERNAL_DIR
+For HTML.
+Base directory for external manuals. You shouldn't use this variable,
+but instead use the mechanism described in @ref{HTML Xref Configuration}.
address@hidden USE_ISO
+For HTML.
+Use entities for doubled single-quote characters (@pxref{Inserting Quotation 
Marks}, @samp{---} and @samp{--} 
+(@pxref{Conventions, General Syntactic Conventions}).
address@hidden SPLIT_INDEX
+For HTML.
+If set, document is split, and a @code{@@printindex} happens in a sectionning 
+element at the level of splitting, then split index pages at the next letter
+after they have more than that many entries. If set to 0, no index splitting.
address@hidden IN_ENCODING
+Input file encoding using perl encoding names. Set according to 
address@hidden@@documentencoding}.
address@hidden USE_NLS
+If set use Native Language Support support fully. In the default case, 
+this is determined automatically at buildtime or at runtime.
address@hidden VERTICAL_HEAD_NAVIGATION
+For HTML.  
+If set, a vertical navigation panel is used.
address@hidden INLINE_CONTENTS
+If set, output the contents where the @code{@@contents} and similar 
+@@-commands are located. Ignored if @code{@@set*contentsaftertitlepage}
+is set.
address@hidden NODE_FILE_EXTENSION
+Extension for node files if @code{NODE_FILENAMES} is set.
address@hidden NO_CSS
+For HTML.
+Do not use CSS (@pxref{HTML CSS}).
address@hidden INLINE_CSS_STYLE
+For HTML.
+Put CSS directly in HTML elements and not at the beginning of the file.
address@hidden USE_TITLEPAGE_FOR_TITLE
+Use the full @code{@@titlepage} as title, not a simple title.
address@hidden SIMPLE_MENU
+If set use simply a preformatted style for the menu, instead of breaking 
+down the different parts of the menu. @xref{Menu Parts}.
address@hidden EXTENSION
+Extension added to the output file.
address@hidden INLINE_INSERTCOPYING
+If set @code{@@insertcopying} is replaced by the @code{@@copying}
+content as if @code{@@insertcopying} was a user defined macro.
address@hidden USE_NUMERIC_ENTITY
+For in XML, HTML.
+If set, use numeric entity when there is no corresponding textual entity.
address@hidden I18N_PERL_HASH
+If set use the old system for the translation of strings output by 
+the program in the document.
address@hidden ENABLE_ENCODING_USE_ENTITY
+For HTMl and XML.
+If @option{--enable-encoding} is set, but there is an entity corresponding
+with the letter or the symbol being output, prefer the entity.
address@hidden ICONS
+For HTML.  Use icons for the navigation panel.
address@hidden USE_UNICODE
+Use perl support for unicode. This is automatically detected.
address@hidden USE_UNIDECODE
+Use the @code{Text::Unidecode} perl module to transliterate more characters.
+This is automatically detected.
address@hidden DATE_IN_HEADER
+For HTML.
+Put the document generation date in the header.
address@hidden OPEN_QUOTE_SYMBOL
+When an opening quote is needed, use the corresponding character.
address@hidden CLOSE_QUOTE_SYMBOL
+When a closing quote is needed, use the corresponding character.
address@hidden TOP_NODE_UP
+Up node for the Top node. Default is @samp{(dir)}.
address@hidden TOP_NODE_FILE
+File used for the Top node, if @code{NODE_FILENAMES} is set.
address@hidden TOP_NODE_FILE_TARGET
+File used for Top node in cross-reference.
address@hidden SHOW_TITLE
+For HTML.
+If set, output the title at the beginning of the document.
address@hidden WORDS_IN_PAGE
+For HTML split at node.
+Specifies the approximate
+minimum page length required before a navigation panel
+is placed at the bottom of a page.
address@hidden HEADER_IN_TABLE
+For HTML.
+Use simple headers formatting, not in a table and using node names.
address@hidden USE_ACCESSKEY
+For HTML.
+Use accesskey in cross-references.
address@hidden USE_REL_REV
+For HTML.
+Use @code{rel} in cross-references.
address@hidden USE_LINKS
+For HTML.
+generate @code{<link>} elements in HTML @code{<head>}.
address@hidden OVERVIEW_LINK_TO_TOC
+If set the cross-refeerences in Overview link to the corresponding 
+Table of Contents entry.
address@hidden AVOID_MENU_REDUNDANCY
+if set and menu entry equals menu description, then do not print 
+menu description.
address@hidden NODE_NAME_IN_MENU
+If set, use node names in menu entries, otherwise prefer section names.
address@hidden NODE_NAME_IN_INDEX
+If set, use node names in index entries, otherwise prefer section names.
address@hidden USE_SETFILENAME
+If set, use @code{@@setfilename} to set document name, otherwise base the 
+document name only on th einput file name. @xref{setfilename}.
address@hidden USE_SETFILENAME_EXTENSION
+Default for Info, not for other output.
+If set use what @code{@@setfilename} gives for the output file name, 
+including th eextension. You should not need to set this variable.
address@hidden COMPLEX_FORMAT_IN_TABLE
+For HTML.
+If set, use table for indentation of complex formats.
address@hidden USE_UP_FOR_ADJACENT_NODES
+If set, try up sections to complete node directions.
address@hidden @item TOP_HEADING_AT_BEGINNING
address@hidden SEPARATE_DESCRIPTION
+If set, always separate menu description and menu link, even in 
+preformatted environment.
address@hidden IGNORE_BEFORE_SETFILENAME
+If set, begin outputting at @code{@@setfilename}, if @code{@@setfilename}
+is present.
address@hidden COMPLETE_IMAGE_PATHS
+If set, the image files are completed to be relative from the
+document directory, to the source manual directory and then to
+the image.
address@hidden USE_NODE_TARGET
+If set, use the node associated with a section for section target in
+cross-references.
address@hidden NEW_CROSSREF_STYLE
+If unset use an old cross-reference schenm. This is a backward compatibility
+setting, you should certainly never unset this variable.
address@hidden PROGRAM_NAME_IN_FOOTER
+For HTML.
+If set, output the program name and misc information in the pages footers.
address@hidden NODE_FILENAMES
+If set, node names are used to construct file names. In the 
+default case, it is set if split at node, or @code{NODE_FILES} is set
+and document is split.
address@hidden DEFAULT_ENCODING
+The default out file encoding. Currently @samp{utf8} or @samp{ascii} for Info.
address@hidden OUT_ENCODING
+Output files encoding using perl encoding name. In the default
+case set auotmatically based on @code{@@documentencoding}.
address@hidden ENCODING_NAME
+Output document encoding. In the default case set automatically
+based on @code{@@documentencoding}. This encoding name is
+the classical charset name in HTML.
address@hidden EXTERNAL_CROSSREF_SPLIT
+For cross-references to other manuals, this determines if the other
+manual is considered to be split or monolithic. In the default case
+set based on @code{SPLIT}. @xref{HTML Xref}. @xref{HTML Xref Configuration}.
address@hidden BODYTEXT
+For HTML.  The text appearing in @code{<body>}.  Set automatically
+taking into account the document language in the default case.
address@hidden CSS_LINES
+Lines of CSS, automatically determined in the default 
+case.  @xref{HTML CSS}.
address@hidden RENAMED_NODES_REDIRECTIONS
+If set do redirection files for renamed nodes. Set for HTML in the
+default case.
address@hidden RENAMED_NODES_FILE
+Use the value for the renamed nodes description file. If not set, the 
+file is @file{<input_file_basename>-noderename.cnf}.
address@hidden vtable
+
address@hidden
+* Configuration variables for @@-commands::   configuration variables
+                                associated with @@-commands.
+* Configuration variables and options::      correspondence between 
+                                configuration variables and command line
+                                options. 
address@hidden menu
+
address@hidden Configuration variables for @@-commands
address@hidden Configuration variables for @@-commands
+
+Configuration variables with the same name than @@-commands are associated
+with the following @@-commands:
+
address@hidden
+@@everyheading @@everyfooting @@evenheading @@evenfooting @@oddheading 
+@@oddfooting @@headings @@allowcodebreaks @@frenchspacing @@exampleindent
+@@firstparagraphindent @@paragraphindent @@clickstyle @@documentlanguage 
+@@contents @@shortcontents @@setcontentsaftertitlepage 
+@@setshortcontentsaftertitlepage @@footnotestyle @@novalidate 
+@@kbdinputstyle @@documentencoding @@setfilename @@today 
+@@documentdescription @@everyheadingmarks @@everyfootingmarks 
+@@evenheadingmarks @@oddheadingmarks @@evenfootingmarks @@oddfootingmarks 
+@@fonttextsize @@pagesizes @@setchapternewpage
address@hidden example
+
address@hidden Configuration variables and options
address@hidden Configuration variables and options
+
+The following table describes the association of command-line options and
+variables. For the meaning of the options, @ref{Invoking texi2any}.
+
address@hidden @columnfractions 0.5 0.5
address@hidden option @tab variable
address@hidden @option{--enable-encoding} @tab @code{ENABLE_ENCODING}
address@hidden @option{--document-language} @tab @code{documentlanguage}
address@hidden @option{--error-limit} @tab @code{ERROR_LIMIT}
address@hidden @option{--fill-column} @tab @code{FILLCOLUMN}
address@hidden @option{--footnote-style} @tab @code{footnotestyle}
address@hidden @option{--force} @tab @code{FORCE}
address@hidden @option{--internal-links} @tab @code{INTERNAL_LINKS}
address@hidden @option{--macro-expand} @tab @code{MACRO_EXPAND}
address@hidden @option{--headers} @tab @code{HEADERS} and @code{SHOW_MENU}
address@hidden @option{--no-warn} @tab @code{NO_WARN}
address@hidden @option{--no-validate} @tab @code{novalidate}
address@hidden @option{--number-footnotes} @tab @code{NUMBER_FOOTNOTES}
address@hidden @option{--number-sections} @tab @code{NUMBER_SECTIONS}
address@hidden @option{--node-files} @tab @code{NODE_FILES}
address@hidden @option{--output} @tab @code{OUT}, @code{OUTFILE} and 
@code{SUBDIR}
address@hidden @option{--paragraph-indent} @tab @code{paragraphindent}
address@hidden @option{--split} @tab @code{SPLIT}
address@hidden @option{--split-size} @tab @code{SPLIT_SIZE}
address@hidden @option{--verbose} @tab @code{VERBOSE}
address@hidden multitable
+
address@hidden Creating and Installing Info Files
address@hidden Creating and Installing Info Files
+
+This chapter describes how to create and install Info files.  @xref{Info
+Files}, for general information about the file format itself.
+
address@hidden
+* Creating an Info File::
+* Installing an Info File::
address@hidden menu
+
+
address@hidden Creating an Info File
address@hidden Creating an Info File
address@hidden Creating an Info file
address@hidden Info, creating an online file
address@hidden Formatting a file for Info
+
address@hidden is a program that converts a Texinfo file into an Info
+file, HTML file, or plain text.  @code{texinfo-format-region} and
address@hidden are GNU Emacs functions that convert
+Texinfo to Info.
+
+For information on installing the Info file in the Info system,
address@hidden an Info File}.
+
address@hidden
+* makeinfo advantages::         @code{makeinfo} provides better error checking.
+* makeinfo in Emacs::           How to run @code{makeinfo} from Emacs.
+* texinfo-format commands::     Two Info formatting commands written
+                                 in Emacs Lisp are an alternative
+                                 to @code{makeinfo}.
+* Batch Formatting::            How to format for Info in Emacs Batch mode.
+* Tag and Split Files::         How tagged and split files help Info
+                                 to run better.
address@hidden menu
+
+
address@hidden makeinfo advantages
address@hidden @code{makeinfo} Preferred
+
+The @code{makeinfo} utility creates an Info file from a Texinfo source
+file more quickly than either of the Emacs formatting commands and
+provides better error messages.  We recommend it.  @code{makeinfo} is a
+C program that is independent of Emacs.  You do not need to run Emacs to
+use @code{makeinfo}, which means you can use @code{makeinfo} on machines
+that are too small to run Emacs.  You can run @code{makeinfo} in any one
+of three ways: from an operating system shell, from a shell inside
+Emacs, or by typing the @kbd{C-c C-m C-r} or the @kbd{C-c C-m C-b}
+command in Texinfo mode in Emacs.
+
+The @code{texinfo-format-region} and the @code{texinfo-format-buffer}
+commands are useful if you cannot run @code{makeinfo}.  Also, in some
+circumstances, they format short regions or buffers more quickly than
address@hidden
+
+
 @node makeinfo in Emacs
 @subsection Running @code{makeinfo} Within Emacs
 @cindex Running @code{makeinfo} in Emacs
@@ -17694,8 +18108,8 @@
 the text of the argument is recursively transformed:
 @example
 @@asis @@b @@cite @@code @@command @@dfn @@dmn @@dotless
-@@emph @@env @@file @@indicateurl @@kbd @@key
-@@samp @@sc @@slanted @@strong @@t @@var @@w
+@@emph @@env @@file @@i @@indicateurl @@kbd @@key
+@@samp @@sansserif @@sc @@slanted @@strong @@t @@var @@w
 @end example
 
 @noindent For @code{@@sc}, any letters are capitalized.
@@ -19855,7 +20269,7 @@
 (@url{http://www.gnu.org/software/rcs}) version control systems, which
 expand it into a string such as:
 @example
-$Id: texinfo.txi,v 1.257 2010/07/18 10:47:08 pertusus Exp $
+$Id: texinfo.txi,v 1.258 2010/07/18 23:01:02 pertusus Exp $
 @end example
 (This is useful in all sources that use version control, not just manuals.)
 You may wish to include the @samp{$Id:} comment in the @code{@@copying}
@@ -19934,7 +20348,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.257 2010/07/18 10:47:08 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.258 2010/07/18 23:01:02 pertusus Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi

Index: doc/version.texi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/version.texi,v
retrieving revision 1.81
retrieving revision 1.82
diff -u -b -r1.81 -r1.82
--- doc/version.texi    18 Jul 2010 10:47:09 -0000      1.81
+++ doc/version.texi    18 Jul 2010 23:01:02 -0000      1.82
@@ -1,4 +1,4 @@
address@hidden UPDATED 18 July 2010
address@hidden UPDATED 19 July 2010
 @set UPDATED-MONTH July 2010
 @set EDITION 5.0
 @set VERSION 5.0



reply via email to

[Prev in Thread] Current Thread [Next in Thread]