[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi
From: |
Karl Berry |
Subject: |
texinfo ChangeLog doc/texinfo.txi |
Date: |
Thu, 19 Jan 2012 01:41:18 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: Karl Berry <karl> 12/01/19 01:41:18
Modified files:
. : ChangeLog
doc : texinfo.txi
Log message:
new node for the program behavior variables, etc.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1311&r2=1.1312
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.412&r2=1.413
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1311
retrieving revision 1.1312
diff -u -b -r1.1311 -r1.1312
--- ChangeLog 17 Jan 2012 21:23:31 -0000 1.1311
+++ ChangeLog 19 Jan 2012 01:41:17 -0000 1.1312
@@ -1,3 +1,8 @@
+2012-01-18 Karl Berry <address@hidden>
+
+ * doc/texinfo.txi (Configuration Variables for Program Behavior):
+ split out into new node, other text tweaks.
+
2012-01-17 Patrice Dumas <address@hidden>
* TODO, tp/TODO: clean tests related TODO parts.
@@ -12,8 +17,8 @@
* tp/texi2any.pl: if SORT_ELEMENT_COUNT is set, dump elements names
sorted by line count (or word count if ISORT_ELEMENT_COUNT_COUNT_WORDS
is set) in the associated file.
- * doc/texinfo.txi (Configuration Variables): document SORT_ELEMENT_COUNT
- and SORT_ELEMENT_COUNT_COUNT_WORDS.
+ * doc/texinfo.txi (Configuration Variables): document
+ SORT_ELEMENT_COUNT and SORT_ELEMENT_COUNT_COUNT_WORDS.
2012-01-15 Patrice Dumas <address@hidden>
@@ -21,7 +26,8 @@
remove @-commands that have no effect and add new @-commands available
as customization options.
- * tp/texi2any.pl, tp/Texinfo/Convert/TextContent.pm, tp/Makefile.am,
TODO:
+ * tp/texi2any.pl, tp/Texinfo/Convert/TextContent.pm,
+ tp/Makefile.am, TODO:
New converter that strips commands from output.
2012-01-14 Patrice Dumas <address@hidden>
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.412
retrieving revision 1.413
diff -u -b -r1.412 -r1.413
--- doc/texinfo.txi 17 Jan 2012 00:18:02 -0000 1.412
+++ doc/texinfo.txi 19 Jan 2012 01:41:17 -0000 1.413
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.412 2012/01/17 00:18:02 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.413 2012/01/19 01:41:17 karl 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.
@@ -620,6 +620,13 @@
* Pointer Validation:: How to check that pointers point somewhere.
* Configuration Variables:: Configuring @command{texi2any}.
+Configuration Variables
+
+* Configuration Variables for Program Behavior::
+* Configuration Variables for @@-Commands::
+* Configuration Variables and Options::
+* Other Configuration Variables::
+
Creating and Installing Info Files
* Creating an Info File::
@@ -15108,7 +15115,7 @@
meaning line 1 of @file{/usr/include/stdio.h}:
@example
-# 1 "/usr/include/stdio.h" 1 3 4
address@hidden 1 "/usr/include/stdio.h" 1 3 4
@end example
@@ -17002,57 +17009,77 @@
@end cartouche
Many aspects of the behavior and output of @command{texi2any} may be
-modified by modifying configuration variables. These
address@hidden variables} fall into four general categories:
+modified by modifying so-called @dfn{configuration variables}. These
+fall into four general categories:
address@hidden @bullet
address@hidden those changing the program behaviour. Those variables
-may only be set on the command line:
address@hidden @code
address@hidden DEBUGTREE
-Instead of generating a regular output format, output a text representation
-of the tree obtained by parsing the input texinfo document.
-
address@hidden RAW_TEXT
-Output raw text, with minimal formatting. For example footnotes are ignored
-and there is no paragraph filling. This output is used by the parser, for
-file names, for example or for copyright code in comments in HTML.
-
address@hidden TEXI2HTML
-Generate HTML and try to be as compatible as possible with
@command{texi2html}.
address@hidden bullet
address@hidden
+Those changing fundamental program behavior; for example,
address@hidden for maximum compatibility with the
address@hidden program. These variables may only be set on the
+command line.
address@hidden TEXTCONTENT
-Output the text contents stripped of commands, useful for spell checking or
-word counting, for example.
address@hidden
+Those associated with @@-commands in the document; for example,
address@hidden@@documentlanguage}.
address@hidden vtable
address@hidden
+Those associated with command-line options; for example, the
+configuration variable @code{SPLIT} is associated with the
address@hidden command-line option.
address@hidden those associated with @@-commands in the document,
-for example, @code{@@documentlanguage}.
address@hidden
+Other ad hoc variables.
address@hidden itemize
address@hidden associated with command-line options,
-for example, the configuration variable @code{SPLIT} is associated
-with the @option{--split} command-line option.
-
address@hidden other ad hoc variables,
-for example, @code{NO_CSS} which can be set to 0 to avoid using
-CSS. These ad hoc variables can be set on the command line, using
+Configuration variables may set on the command line using
@code{--set-init-variable '@var{var} @var{value}'} (quoting the
variable/value pair) or @code{--set-init-variable
@address@hidden (using @code{=}). A special @var{value} is
address@hidden, which sets the variable to this special Perl value for
-undefined.
address@hidden itemize
address@hidden, which sets the variable to this special ``undefined''
+Perl value.
The sections below give the details for each of these.
@menu
+* Behavior: Configuration Variables for Program Behavior.
* Commands: Configuration Variables for @@-Commands.
* Options: Configuration Variables and Options.
* Other: Other Configuration Variables.
@end menu
address@hidden Configuration Variables for Program Behavior
address@hidden Configuration Variables for Program Behavior
address@hidden Configuration variables for program behavior
address@hidden Program behavior, configuration variables for
+
address@hidden @code
address@hidden DEBUGTREE
address@hidden tree representation, for debugging
address@hidden debugging document, with tree representation
+Instead of generating a regular output format, output a text representation
+of the tree obtained by parsing the input texinfo document.
+
address@hidden RAW_TEXT
address@hidden raw text output
+Output raw text, with minimal formatting. For example, footnotes are
+ignored and there is no paragraph filling. This is used by the parser
+for file names and copyright text in HTML comments, for example
+
address@hidden TEXI2HTML
address@hidden compatibility, with @command{texi2html}
+Generate HTML and try to be as compatible as possible with
address@hidden
+
address@hidden TEXTCONTENT
address@hidden spell checking
address@hidden word counting
+Output the text content only, stripped of commands; this is useful for
+spell checking or word counting, for example.
address@hidden vtable
+
+
@node Configuration Variables for @@-Commands
@subsection Configuration Variables for @@-Commands
@@ -17432,7 +17459,7 @@
each HTML file.
@item PREFIX
-the output file prefix, which is prepended to some output files. By
+The output file prefix, which is prepended to some output files. By
default 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, such as split output
@@ -17447,9 +17474,9 @@
information in the page footers.
@item RENAMED_NODES_FILE
-Use the value for the renamed nodes description file. If not set, the
-file is @file{<input_file_basename>-noderename.cnf}. @xref{HTML Xref
-Link Preservation}.
+If set, use the value for the renamed nodes description file. If not
+set, the file is @file{<input_file_basename>-noderename.cnf}.
address@hidden Xref Link Preservation}.
@item RENAMED_NODES_REDIRECTIONS
If set, do redirection files for renamed nodes. Set for HTML by default.
@@ -17474,13 +17501,13 @@
breaking down the different parts of the menu. @xref{Menu Parts}.
@item SORT_ELEMENT_COUNT
-Name of a file where a list of elements (nodes or sections, depending
-on the output format generated) sorted by the number of lines they contain
-after removal of @@-commands are dumped.
+If set, the name of a file to which a list of elements (nodes or
+sections, depending on the output format) is dumped, sorted by the
+number of lines they contain after removal of @@-commands.
@item SORT_ELEMENT_COUNT_COUNT_WORDS
-When sorting elements by their counting, use words count instead
-of line counts.
+When dumping the elements-by-size file (see preceding item), use word
+counts instead of line counts.
@c @item SPLIT_INDEX
@c For address@hidden If set, the output is split, and the output from
@@ -21548,7 +21575,7 @@
Revision Control System}) or other version control systems, which
expand it into a string such as:
@example
-$Id: texinfo.txi,v 1.412 2012/01/17 00:18:02 pertusus Exp $
+$Id: texinfo.txi,v 1.413 2012/01/19 01:41:17 karl 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}