[7685] texi2any environment variables document TEXINFO_XS

[gavinsmith0123]

Revision: 7685
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=7685
Author:   gavin
Date:     2017-03-11 17:31:10 -0500 (Sat, 11 Mar 2017)
Log Message:
-----------
texi2any environment variables document TEXINFO_XS

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/texinfo.texi

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2017-03-07 20:05:47 UTC (rev 7684)
+++ trunk/ChangeLog     2017-03-11 22:31:10 UTC (rev 7685)
@@ -1,3 +1,8 @@
+2017-03-11  Gavin Smith  <address@hidden>
+
+       * doc/texinfo.texi (texi2any Environment Variables): New node.
+       Document TEXINFO_XS.
+
 2017-03-07  Gavin Smith  <address@hidden>
 
        * doc/texinfo.tex (\begindoublecolumns): Reduce \vsize to

Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi      2017-03-07 20:05:47 UTC (rev 7684)
+++ trunk/doc/texinfo.texi      2017-03-11 22:31:10 UTC (rev 7685)
@@ -583,6 +583,7 @@
 
 * Reference Implementation::    @command{texi2any}: the reference 
implementation.
 * Invoking @command{texi2any}::           Running the translator from a shell.
+* @command{texi2any} Environment Variables::
 * @command{texi2any} Printed Output::     Calling @command{texi2dvi}.
 * Pointer Validation::          How to check that pointers point somewhere.
 * Customization Variables::     Configuring @command{texi2any}.
@@ -15927,6 +15928,7 @@
 @menu
 * Reference Implementation::    @command{texi2any}: the reference 
implementation.
 * Invoking @command{texi2any}::           Running the translator from a shell.
+* @command{texi2any} Environment Variables::
 * @command{texi2any} Printed Output::     Calling @command{texi2dvi}.
 * Pointer Validation::          How to check that pointers point somewhere.
 * Customization Variables::     Configuring @command{texi2any}.
@@ -16500,6 +16502,10 @@
 
 @end table
 
+
address@hidden @command{texi2any} Environment Variables
address@hidden Environment Variables Recognized by @command{texi2any}
+
 @vindex TEXINFO_OUTPUT_FORMAT
 @cindex Environment variable @code{TEXINFO_OUTPUT_FORMAT}
 @command{makeinfo} also reads the environment variable
@@ -16516,7 +16522,39 @@
 overrides an environment variable setting, but not a command-line
 option.  @xref{Customization Variables and Options}.
 
address@hidden TEXINFO_XS
address@hidden Perl extension modules (XS)
+You can control @command{texi2any}'s use of Perl extension modules
+by setting the @env{TEXINFO_XS} environment variable.  These modules
+are compiled native code that the interpreted Perl code can use.
+Ideally, these extension modules should just work, and the only noticable
+difference they should make is that @command{texi2any} finishes running
+sooner.  However, you can use this environment variable for the purposes
+of troubleshooting: for example, if you have problems with the output of
address@hidden varying depending on whether the extension modules are
+in use.
 
+The following values of @env{TEXINFO_XS} are recognized by
address@hidden:
+
address@hidden @samp
address@hidden default
+The default behavior.  Try to load extension modules, and silently fall
+back to the interpreted Perl implementations if this fails.
+
address@hidden warn
+Try to load extension modules, and if this fails, give a warning message
+before falling back to the interpreted Perl implementations.
+
address@hidden debug
+Try to load extension modules, printing many messages while doing so.
+
address@hidden omit
+Do not use extension modules.
+
address@hidden table
+
+
 @node @command{texi2any} Printed Output
 @section @command{texi2any} Printed Output