1TEXUTIL(1) General Commands Manual TEXUTIL(1)
2texutil(1) CONTEXT texutil(1)
6
10 texutil - ConTeXt auxiliary program
11
13 texutil [ OPTION... ] FILENAME[...]
14
16 When processing a source file, ConTeXt (via texexec(1)) saves informa‐
17 tion (including table of contents, tables of figures and tables, index
18 entries, cross-references) in a ``utility file´´ called FILENAME.tui.
19 After each successful run, this utility file is postprocessed by texu‐
20 til to organize the information for the next run.
21 texutil performs a number of useful functions:
23 o Postprocessing references, including sorting index and list
25 entries (with --references)
26 o Extracting documentation and other types of information from
28 ConTeXt source files (with --documents)
29 o Logfile analysis (with --logfile)
31 o Collecting information about graphic files to help with typeset‐
33 ting (with --figures)
34 o Converting EPS files to a PDF format suitable for inclusion in
36 PDF files generated with pdftex(1) (with ----epspage and
37 --epstopdf)
38
40 All switches are specified here in full, but can be abbreviated to the
41 shortest unique string. Thus, --ver works the same as --verbose pro‐
42 vided that there is no other flag beginning with ``ver´´.
43
45 --help Print a usage summary to stdout.
46 --interface=LANGUAGECODE
48 Specify the language for messages. One of en (English), de
49 (German), or nl (Dutch). The default language is English.
50 --outputfile=FILENAME
52 Specify the name of the output file.
53 --purge [ BASENAME ]
55 Delete temporary files. Specifying an optional BASENAME will
56 only affect the temporary files that begin with that BASENAME.
57 --silent
59 Redirects stdout to the log file (texutil.log, by default).
60 When used with --verbose, a summary is printed to stdout, while
61 any other output is written to the log file.
62 For example,
64 texutil --figures --silent --verbose somefile.png
66 will output something like
69 n=somefile.png t=png x=0bp y=0bp w=443bp h=591bp
71 to stdout, placing other output into texutil.log. This informa‐
74 tion can be piped into another program for further processing.
75 --type=SUFFIX
77 Specify the SUFFIX of the file you want texutil to process.
78 --verbose
80 Print diagnostic messages to the screen.
81
83 The --references flag instructs texutil to process information about
84 cross-references, index entries, and other data requiring more than one
85 pass to process in the ConTeXt utility file.
86 Index and sorted list entries are sorted before being written out;
88 redundant index entries are removed.
89 texutil is called automatically by texexec(1) during its processing
91 runs unless you specify otherwise. texutil can also be run by hand,
92 using the form
93 texutil --references FILENAME
95 This command would cause texutil to load the utility file FILENAME.tui,
98 sort and convert the contents of that file, and write the results to
99 FILENAME.tuo.
100 Options specific to this mode are:
102 --ij Sort ``IJ´´ as ``Y´´. Often used when processing files written
104 in Dutch.
105 --high Convert ``high´´ ASCII values into equivalent TeX commands.
107 This switch is provided for backward compatibility.
108 --quotes
110 Take tex(1) accent commands into consideration when sorting.
111 (Otherwise, quotes are considered to be boundary characters for
112 strings.)
113 --tcxpath=PATH
115 Specify path to tcx filter files for translating between encod‐
116 ings.
117
119 ConTeXt source files often contain documentation (see USAGE for more
120 information about the format) or other information that can be
121 extracted by texutil when called with the --documents flag:
122 texutil --documents FILENAME
124 This command produces a file called FILENAME.ted from a ConTeXt file
127 called FILENAME.tex.
128 The --sources flag does the opposite: Documentation lines are stripped
130 out of the output, which is written to a file called FILENAME.tes.
131 Historically, ConTeXt source files included other forms of information
133 -- such as syntax definitions, macro definitions, and editor templates
134 -- that can be extracted with the following flags:
135 --infos
137 Extract TeXEdit macro information (tex->tud -- see USAGE)
138 --setups
140 Extract ConTeXt syntax definitions (tex->texutil.tus)
141 --templates
143 Extract TeXEdit editor templates (tex->tud)
144
146 Calling texutil with the --logfile option allows you to extract infor‐
147 mation about problems with your ConTeXt source file from the log file
148 produced during a texexec(1) run.
149 You can specify what information texutil should report with the follow‐
151 ing options:
152 --box Extract information about overfull boxes. By default, this flag
154 will cause texedit to report both horizontal and vertical over‐
155 full boxes. If you´re only interested in one kind, you can
156 specify --hbox or --vbox instead.
157 --criterium=SIZE
159 Exclude reports about boxes that are less than SIZE points too
160 large.
161 --unknown
163 Extract messages about missing references or figures.
164
166 The --figures flag tells texutil to generate information about one or
167 more (non-EPS) graphics files for use in typesetting. Called as, for
168 example,
169 texutil --figures *.png *.tif
171 texutil will scan the current directory for PNG and TIFF files and
174 extract some useful information about their sizes and types. By
175 default, this information is stored in a file called texutil.tuf, which
176 is consulted by ConTeXt when typesetting a page with a non-EPS image
177 file -- see the example given for the --silent flag for an alternative.
178 This flag is especially useful when you plan to typeset a file of pre‐
180 views of graphic files -- see the discussion of the --figures flag in
181 the texexec(1) manpage.
182
184 texutil can also convert EPS files to PDF format for inclusion in PDF
185 files generated with pdftex(1) or pdfetex(1).
186 --epspage
188 Adjust the bounding box of an EPS file to the dimensions of the
189 output page. This option also removes some redundant informa‐
190 tion and marks files as converted so that they will not be
191 affected by subsequent runs.
192 --epstopdf
194 Calls gs(1) to convert the specified EPS graphic files into PDF
195 format.
196
199 Documentation lines included in ConTeXt source files can be specified
200 by beginning lines with the following strings:
201 %C Copyright information
203 %D Documentation lines
205 %I TeXEdit information lines (mostly in Dutch)
207 %M Macro code needed to processs the documentation
209 %S ``Suppressed´´ lines
211 The same forms can be used for Perl scripts, except that the ``%´´
213 characters are replaced by ``#´´ characters. See the source for texu‐
214 til for an example.
215
217 gs(1), pdfetex(1), pdftex(1), texexec(1), texshow(1).
218 Web page: <http://www.pragma-ade.com/>
220
222 This manpage was written by C.M. Connelly <c@eskimo.com> and Tobias
223 Burnus <burnus@gmx.de>. It is based on the texutil manual written by
224 Hans Hagen <pragma@wxs.nl>.
225 The PDF manual and texutil itself can be obtained at
227 <http://www.pragma-ade.com/pragma-ade/texutil.htm>.
228ConTeXt October 2000 texutil(1)