Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
texutil(1)
Edit
PageHistory
Diff
Info
LikePages
texutil !!!texutil NAME SYNOPSIS DESCRIPTION OPTIONS General Options Postprocessing References Extracting Information from !ConTeXt Source Files Analyzing Log Files Gathering Information about Figures Converting EPS Files for PDF Inclusion USAGE Embedded Documentation Format SEE ALSO AUTHOR ---- !!NAME texutil - !ConTeXt auxiliary program !!SYNOPSIS __texutil__ [[ ''OPTION''... ] ''FILENAME''[[...] !!DESCRIPTION When processing a source file, __!ConTeXt__ (via texexec(1)) saves information (including table of contents, tables of figures and tables, index entries, cross-references) in a ``utility file called ''FILENAME.tui''. After each successful run, this utility file is postprocessed by __texutil__ to organize the information for the next run. __texutil__ performs a number of useful functions: o Postprocessing references, including sorting index and list entries (with __--references__) o Extracting documentation and other types of information from __!ConTeXt__ source files (with __--documents__) o Logfile analysis (with __--logfile__) o Collecting information about graphic files to help with typesetting (with __--figures__) o Converting EPS files to a PDF format suitable for inclusion in PDF files generated with pdftex(1) (with --__--epspage__ and __--epstopdf__) !!OPTIONS All switches are specified here in full, but can be abbreviated to the shortest unique string. Thus, __--ver__ works the same as __--verbose__ provided that there is no other flag beginning with ``ver. !!General Options __--help__ Print a usage summary to stdout. __--interface=__''LANGUAGECODE'' Specify the language for messages. One of __en__ (English), __de__ (German), or __nl__ (Dutch). The default language is English. __--outputfile=__''FILENAME'' Specify the name of the output file. __--purge__ [[ ''BASENAME'' ] Delete temporary files. Specifying an optional ''BASENAME'' will only affect the temporary files that begin with that ''BASENAME''. __--silent__ Redirects stdout to the ''log'' file (''texutil.log'', by default). When used with __--verbose__, a summary is printed to stdout, while any other output is written to the ''log'' file. For example, texutil --figures --silent --verbose somefile.png will output something like n=somefile.png t=png x=0bp y=0bp w=443bp h=591bp to stdout, placing other output into ''texutil.log''. This information can be piped into another program for further processing. __--type=__''SUFFIX'' Specify the ''SUFFIX'' of the file you want __texutil__ to process. __--verbose__ Print diagnostic messages to the screen. !!Postprocessing References The __--references__ flag instructs __texutil__ to process information about cross-references, index entries, and other data requiring more than one pass to process in the __!ConTeXt__ utility file. Index and sorted list entries are sorted before being written out; redundant index entries are removed. __texutil__ is called automatically by texexec(1) during its processing runs unless you specify otherwise. __texutil__ can also be run by hand, using the form texutil --references ''FILENAME'' This command would cause __texutil__ to load the utility file ''FILENAME.tui'', sort and convert the contents of that file, and write the results to ''FILENAME.tuo''. Options specific to this mode are: __--ij__ Sort ``IJ as ``Y. Often used when processing files written in Dutch. __--high__ Convert ``high ASCII values into equivalent TeX commands. This switch is provided for backward compatibility. __--quotes__ Take tex(1) accent commands into consideration when sorting. (Otherwise, quotes are considered to be boundary characters for strings.) __--tcxpath=__''PATH'' Specify path to ''tcx'' filter files for translating between encodings. !!Extracting Information from !ConTeXt Source Files __!ConTeXt__ source files often contain documentation (see USAGE for more information about the format) or other information that can be extracted by __texutil__ when called with the __--documents__ flag: texutil --documents ''FILENAME'' This command produces a file called ''FILENAME.ted'' from a !ConTeXt file called ''FILENAME.tex''. The __--sources__ flag does the opposite: Documentation lines are stripped out of the output, which is written to a file called ''FILENAME.tes''. Historically, __!ConTeXt__ source files included other forms of information -- such as syntax definitions, macro definitions, and editor templates -- that can be extracted with the following flags: __--infos__ Extract TeXEdit macro information (''tex''-''tud'' -- see USAGE) __--setups__ Extract __!ConTeXt__ syntax definitions (''tex''-''texutil.tus'') __--templates__ Extract TeXEdit editor templates (''tex''-''tud'') !!Analyzing Log Files Calling __texutil__ with the __--logfile__ option allows you to extract information about problems with your __!ConTeXt__ source file from the log file produced during a texexec(1) run. You can specify what information __texutil__ should report with the following options: __--box__ Extract information about overfull boxes. By default, this flag will cause __texedit__ to report both horizontal and vertical overfull boxes. If youre only interested in one kind, you can specify __--hbox__ or __--vbox__ instead. __--criterium=__''SIZE'' Exclude reports about boxes that are less than ''SIZE'' points too large. __--unknown__ Extract messages about missing references or figures. !!Gathering Information about Figures The __--figures__ flag tells __texutil__ to generate information about one or more (non-EPS) graphics files for use in typesetting. Called as, for example, texutil --figures *.png *.tif __texutil__ will scan the current directory for PNG and TIFF files and extract some useful information about their sizes and types. By default, this information is stored in a file called ''texutil.tuf'', which is consulted by __!ConTeXt__ when typesetting a page with a non-EPS image file -- see the example given for the __--silent__ flag for an alternative. This flag is especially useful when you plan to typeset a file of previews of graphic files -- see the discussion of the __--figures__ flag in the texexec(1) manpage. !!Converting EPS Files for PDF Inclusion __texutil__ can also convert EPS files to PDF format for inclusion in PDF files generated with pdftex(1) or pdfetex(1). __--epspage__ Adjust the bounding box of an EPS file to the dimensions of the output page. This option also removes some redundant information and marks files as converted so that they will not be affected by subsequent runs. __--epstopdf__ Calls gs(1) to convert the specified EPS graphic files into PDF format. !!USAGE !!Embedded Documentation Format Documentation lines included in __!ConTeXt__ source files can be specified by beginning lines with the following strings: %C Copyright information %D Documentation lines %I TeXEdit information lines (mostly in Dutch) %M Macro code needed to processs the documentation %S ``Suppressed lines The same forms can be used for Perl scripts, except that the ``% characters are replaced by ``# characters. See the source for __texutil__ for an example. !!SEE ALSO gs(1), pdfetex(1), pdftex(1), texexec(1), texshow(1). Web page: !!AUTHOR This manpage was written by C.M. Connelly texutil__ manual written by Hans Hagen __ The PDF manual and __texutil__ itself can be obtained at __ ----
3 pages link to
texutil(1)
:
texexec(1)
texshow(1)
Man1t
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
