summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/tex4ht/mn34.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/tex4ht/mn34.html')
-rw-r--r--Master/texmf-dist/doc/generic/tex4ht/mn34.html157
1 files changed, 123 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/generic/tex4ht/mn34.html b/Master/texmf-dist/doc/generic/tex4ht/mn34.html
index 5b8f30e6f91..90ea257ee70 100644
--- a/Master/texmf-dist/doc/generic/tex4ht/mn34.html
+++ b/Master/texmf-dist/doc/generic/tex4ht/mn34.html
@@ -1,50 +1,139 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "xhtml1-transitional.dtd">
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->
<html xmlns="http://www.w3.org/1999/xhtml"
>
-<head><title>bookkeeping file</title>
+<head><title>Modify</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-<meta name="generator" content="TeX4ht (http://www.cis.ohio-state.edu/~gurari/TeX4ht/mn.html)" />
-<meta name="originator" content="TeX4ht (http://www.cis.ohio-state.edu/~gurari/TeX4ht/mn.html)" />
+<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)" />
+<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)" />
<!-- xhtml,th4,index -->
<meta name="src" content="mn.tex" />
-<meta name="date" content="2004-02-11 18:07:00" />
<link rel="stylesheet" type="text/css" href="mn.css" />
</head><body
>
<a
- href="mn33.html#mn34.html" >exit</a> <h3 class="SubSectionHead"><a
- name="QQ1-34-43"></a>Placement of the Bookkeeping File</h3>
+ href="mn31.html#mn34.html" >exit Modify</a>
+ <h3 class="SubSectionHead"><a
+ name="QQ1-34-73"></a>The Composition of tex4ht.env</h3>
<a
- name="index34-43001"></a> <a
- name="index34-43002"></a> <a
- name="index34-43003"></a> <a
- name="index34-43004"></a><a
- name="TEX4HTWR"></a>To cut down on the time invested to locate files, the <span class="cmtt-10">tex4ht.c </span>program maintains a bookkeeping file where it
-records the addresses of the files it finds. Whenever the program needs to locate a file, it first searches the address in
-the bookkeeping file. If it doesn&#8217;t find the address there, the program embarks on a search throughout the physical
-directories of its platform.
-<!--l. 5565--><p class="indent"> The program places the bookkeeping file at the first applicable location of the following list.
-</p><!--l. 5568--><p class="indent">
-</p><ol type="1" >
-<li>The pointer specified by an optional &#8216;<span class="cmtt-10">-l</span>&#8217; switch provided to the invocation of the <span class="cmtt-10">tex4ht </span>program.
-</li>
-<li>A file named <span class="cmtt-10">tex4ht.fls </span>in the directory specified by an optional environment variable named <span class="cmtt-10">TEX4HTWR</span>.
-</li>
-<li>The location specified by an optional &#8216;<span class="cmtt-10">l</span>&#8217; record provided in the environment file. </li>
-<li>A file named <span class="cmtt-10">tex4ht.fls </span>in the work directory. </li></ol>
- A given address may start with the character &#8216;<span class="cmtt-10">~</span>&#8217; or the character pair &#8216;<span class="cmtt-10">~~</span>&#8217;. The single character &#8216;<span class="cmtt-10">~</span>&#8217; is
-interpreted to be the directory address of the root, provided in an environment variable named <span class="cmtt-10">HOME</span>. The
-character pair &#8216;<span class="cmtt-10">~~</span>&#8217; is interpreted to be a directory address provided in an environment variable named
-<span class="cmtt-10">TEX4HTWR</span>. The address stored in the latter environment variable may also start with a single character
-&#8216;<span class="cmtt-10">~</span>&#8217;.
-<!--l. 5595--><p class="indent"> The bookkeeping file must have writable access mode, and the directory which contains the file should have a
-compatible access mode.
-</p><!--l. 5599--><p class="indent"> The bookkeeping file is a dynamically constructed variant of the ls-R file of kpathsea. TeX4ht
-ignores its own bookkeeping mechanism, if the program <span class="cmtt-10">tex4ht.c </span>is compiled with a raised <span class="cmtt-10">-DKPATHSEA</span>
-switch.
+ name="index34-73001"></a>TeX4ht consults this file for system-dependent information. The file consists of a sequence of directives, where
+each directive occupies a line and is identified with a distinguished character code in the first column. The following
+are the possible character codes and their meaning.
+<dl >
+ <dt>b</dt><dd>
+This character identifies for <span class="cmtt-10">tex4ht </span>a comment to be placed in the &#8216;<span class="cmtt-10">.lg</span>&#8217; file, before the <a
+ href="mn38.html#bsc" name="bsc-1">scripts</a> for creating pictures
+for symbols.
+ </dd><dt>g</dt><dd>
+<a
+ name="index34-73002"></a>This character identifies the extension tex4ht should associate to names of the files of pictures the
+postprocessor requests (for instance, bitmap files of glyphs.). The default corresponds to a setting of the form
+&#8216;<span class="cmtt-10">g.png</span>&#8217;.
+<!--l. 8142--><p class="indent" > An extension name can also be encoded into tex4ht during compilation time through the variable
+<a
+ href="mn37.html#x-LGTYP" name="LGTYP">LGTYP</a>.
+</p><!--l. 8146--><p class="indent" > Alternatively, an extension can be provided in the command line of tex4ht, in which case the character code
+should be present and immediately preceded by a &#8216;<span class="cmtt-10">-</span>&#8217; character.
+</p>
+ </dd><dt>i</dt><dd>
+This character identifies to <span class="cmtt-10">tex4ht </span>a directory <a
+ href="mn40.html#ch-i" name="ch.i">where</a> the hypertext font (.htf) files of <span class="cmtt-10">tex4ht </span>are
+stored.
+ </dd><dt>l</dt><dd>
+<a
+ name="index34-73003"></a>This character identifies a <a
+ href="mn35.html" name="mn35.html" >bookkeeping file</a> where <span class="cmtt-10">tex4ht </span>can record information about paths to files it uses.
+ </dd><dt>s</dt><dd>
+This character identifies to <span class="cmtt-10">tex4ht </span>a <a
+ href="mn38.html#sc" name="sc-1">command</a> for requesting in the <span class="cmtt-10">lg </span>file the translation of dvi pictures to
+bitmaps. When needed, a sequence of such commands can be placed in consecutive lines to form a block of
+commands for handling the translation.
+ </dd><dt>t</dt><dd>
+<a
+ name="index34-74005"></a>This character identifies to <span class="cmtt-10">tex4ht </span>the directory <a
+ href="mn36.html" name="mn36.html" >where</a> the font metric (.tfm) files of TeX are stored.
+ </dd><dt>A</dt><dd>
+This character identifies to <span class="cmtt-10">t4ht </span>a <a
+ href="mn-upgrade.html#accscript">script</a> for changing access mode of files.
+ </dd><dt>C</dt><dd>
+This character identifies a <a
+ href="mn-upgrade.html#mvscript">script</a> for satisfying requests made in the <span class="cmtt-10">lg </span>file to copy files between directories.
+ </dd><dt>E</dt><dd>
+This character identifies a <a
+ href="mn-upgrade.html#mvscript">script</a> for satisfying requests made in the <span class="cmtt-10">lg </span>file to get substitutions for empty
+pictures.
+ </dd><dt>F</dt><dd>
+This character identifies to <span class="cmtt-10">t4ht </span>a <a
+ href="mn-upgrade.html#dv2png">script</a> for translating into other formats characters from dvi files.
+<!--l. 8351--><p class="indent" > A &#8216;F.ext&#8217; record marks a conditional F-subscript. It states that the following F-records will apply only to
+pictures whose extension names are &#8216;ext&#8217;.
+</p><!--l. 8355--><p class="indent" > A &#8216;F.&#8217; record marks a default F-subscript. It applies to pictures whose extension names do not get dedicated
+F-subscripts.
+</p><!--l. 8358--><p class="indent" > The &#8216;F.ext&#8217; and &#8216;F.&#8217; records are not needed, in case all the pictures are to be processed by a single set of
+F-records.
+</p><!--l. 8361--><p class="noindent" ><span class="cmbx-10">Example</span>:
+</p><div class="Verbatim"><span class="cmtt-10">F.gif</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">F-gif-script</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">F.png</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">F-png-script</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">F.</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">F-script</span><span class="cmtt-10">&#x00A0;</span>
+<br /></div>
+ </dd><dt>G</dt><dd>
+This character identifies to <span class="cmtt-10">t4ht </span>a <a
+ href="mn-upgrade.html#dv2png">script</a> for translating general dvi figures into other formats.
+<!--l. 8380--><p class="indent" > A &#8216;G.ext&#8217; record marks a conditional G-subscript. It states that the following G-records will apply only to
+pictures whose extension names are &#8216;ext&#8217;.
+</p><!--l. 8384--><p class="indent" > A &#8216;G.&#8217; record marks a default G-subscript. It applies to pictures whose extension names do not get dedicated
+G-subscripts.
+</p><!--l. 8387--><p class="indent" > The &#8216;G.ext&#8217; and &#8216;G.&#8217; records are not needed, in case all the pictures are to be processed by a single set of
+G-records.
+</p><!--l. 8390--><p class="noindent" ><span class="cmbx-10">Example</span>:
+</p><div class="Verbatim"><span class="cmtt-10">G.gif</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">G-gif-script</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">G.png</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">G-png-script</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">G.</span><span class="cmtt-10">&#x00A0;</span>
+<br /><span class="cmtt-10">G-script</span><span class="cmtt-10">&#x00A0;</span>
+<br /></div>
+ </dd><dt>M</dt><dd>
+This character identifies a <a
+ href="mn-upgrade.html#mvscript">script</a> for satisfying requests made in the <span class="cmtt-10">lg </span>file to move files between directories.
+ </dd><dt>S</dt><dd>
+This character specifies what security measures <span class="cmtt-10">t4ht </span>should take when invoking other utilities. In the absence of
+this directive, all the calls to system services are ignored. On the other hand, a directive of the form &#8216;<span class="cmtt-10">S*</span>&#8217; allows all
+system calls. A selective access to system calls can be obtained with <span class="cmtt-10">S </span>directives, which specify the prefixes of
+command names that should be allowed to go through.
+<!--l. 8417--><p class="indent" > The <span class="cmtt-10">S </span>directives can be fed as switches to the command lines <span class="cmtt-10">t4ht</span>.
+</p>
+ </dd><dt>P</dt><dd>
+A variant of he <span class="cmtt-10">S </span>switch for <span class="cmtt-10">tex4ht</span>. Rarely useful.
+
+ </dd><dt>X</dt><dd>
+This character identifies to <span class="cmtt-10">t4ht </span>a script for postprocessing the files which <span class="cmtt-10">tex4ht </span>outputs. The file names are
+represented by &#8216;<span class="cmtt-10">%%1</span>&#8217;, and their extensions by &#8216;<span class="cmtt-10">%%2</span>&#8217;. Such scripts, for instance, may invoke validators to check the
+correctness of the files against given DTD&#8217;s and request XSL transformations.
+<!--l. 8430--><p class="indent" > The command line of <span class="cmtt-10">t4ht </span>may include a flag &#8216;<span class="cmtt-10">-X</span>&#8217; whose content is represented by &#8216;<span class="cmtt-10">%%3</span>&#8217; in the
+script.
+</p><!--l. 8434--><p class="indent" > Example: <span class="cmtt-10">Xmake -f mymake name=%%1 ext=%%2 %%3</span>
+</p>
+ </dd><dt><span class="cmbx-10">. </span>(dot)</dt><dd>
+A variant of the X script applied to files whose extension names are provided after the dot. The file names are
+represented by &#8216;<span class="cmtt-10">%%1</span>&#8217;, and the jobnames by &#8216;<span class="cmtt-10">%%0</span>&#8217;.
+<!--l. 8440--><p class="indent" > Example: <span class="cmtt-10">.xml echo "name=%%1.xml"</span>
+</p>
+ </dd><dt><span class="cmtt-10">&#x003C;</span></dt><dd>
+Tagged script segments <span class="cmtt-10">&#x003C;tag&#x003E;...&#x003C;/tag&#x003E; </span>are scanned only if their names are specified within <span class="cmtt-10">-ctag </span>switches of
+<span class="cmtt-10">tex4ht.c </span>and <span class="cmtt-10">t4ht.c</span>. When such switches are not supplied, a the switch <span class="cmtt-10">-cdefault </span>is implicitly
+assumed.
+ </dd></dl>
+<!--l. 8450--><p class="indent" > Lines starting with other characters are treated as comments, and empty lines may be treated as file
+terminators by <span class="cmtt-10">tex4ht </span>and <span class="cmtt-10">t4ht</span>.
+</p><!--l. 8456--><p class="noindent" ><span class="cmbx-10">Examples: </span><a
+ href="tex4ht-env-unix.txt" >Unix-oriented</a>, <a
+ href="tex4ht-env-win32.txt" >MS-oriented</a>
</p>