diff options
author | Karl Berry <karl@freefriends.org> | 2006-12-05 01:27:49 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2006-12-05 01:27:49 +0000 |
commit | 08fd63c1875eab1f9aa5095f441ccf0ff00ab9db (patch) | |
tree | b205669a8c7c88aba51d7452c00a918971e54047 /Build/source/texk | |
parent | 008a7401df99e3e2aceb774f9d2254f43788bd63 (diff) |
new context man pages from Sanjoy Mahajan
git-svn-id: svn://tug.org/texlive/trunk@2592 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/texk')
-rw-r--r-- | Build/source/texk/tetex/context/ctxtools.man | 79 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/fdf2tex.man | 52 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/makempy.man | 72 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/pdftools.man | 59 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/pstopdf.man | 74 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/texexec.man | 640 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/texfind.man | 87 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/texfont.man (renamed from Build/source/texk/tetex/texfont.man) | 77 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/texmfstart.man | 363 | ||||
-rw-r--r-- | Build/source/texk/tetex/context/texutil.man | 22 | ||||
-rw-r--r-- | Build/source/texk/tetex/makempy.man | 60 | ||||
-rw-r--r-- | Build/source/texk/tetex/texexec.man | 574 | ||||
-rw-r--r-- | Build/source/texk/tetex/texutil.man | 266 |
13 files changed, 1494 insertions, 931 deletions
diff --git a/Build/source/texk/tetex/context/ctxtools.man b/Build/source/texk/tetex/context/ctxtools.man new file mode 100644 index 00000000000..f855debb654 --- /dev/null +++ b/Build/source/texk/tetex/context/ctxtools.man @@ -0,0 +1,79 @@ +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. +.TH CTXTOOLS "1" "December 2006" "ctxtools 1.3" "ConTeXt" + +.SH NAME +ctxtools \- clean up temporary ConTeXt files, install latest ConTeXt + +.SH "SYNOPSIS" +\fBctxtools\fP [ \fIOPTION\fP ... ] + +.SH DESCRIPTION +\fBctxtools\fP is useful for dealing with ConTeXt source and generated +files and for installing new versions of ConTeXt. +Many of its options are +not documented here (since I don't understand what they do). + +.SH "OPTIONS" +.TP +.B --help +Print the available options. +.TP +.B --purgefiles +Get rid of many temporary files generated by ConTeXt. You can give the +.TP +.B --all +option to remove a larger fraction of those files, +and the +.TP +.B --recurse +option to remove these files also in subdirectories. +.TP +.B --updatecontext +Download the latest ConTeXt distribution and install it in the +TEXMFLOCAL tree (see +.BR kpsewhich (1) +for information on +TeX path searching). TEXMFLOCAL usually points to a system-wide +location. If you want to install the new ConTeXt in your home +directory (i.e. an install for one user), then set the TEXMFLOCAL +environment variable while running +.BR ctxtools . +For example, using the syntax of the Bourne shell +.BR sh (1): +.EX +TEXMFLOCAL=$HOME/texmf ctxtools --updatecontext +.EE +.TP +.B --documentation +Generate a \fI.ted\fP file from the source file. See also the +\fB--module\fP option to +.BR texexec (1). + +.SH "ENVIRONMENT" +.TP +TEXMFLOCAL +Used by \f(CW--updatecontext\fP to decide where to install the distribution. + +.SH "SEE ALSO" +.IP \(bu +.BR texexec (1), +.BR texmfstart (1). +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" +This (incomplete) manual page was written by Sanjoy Mahajan. It is in +the public domain. diff --git a/Build/source/texk/tetex/context/fdf2tex.man b/Build/source/texk/tetex/context/fdf2tex.man new file mode 100644 index 00000000000..5183aba95cb --- /dev/null +++ b/Build/source/texk/tetex/context/fdf2tex.man @@ -0,0 +1,52 @@ +.TH FDF2TEX "1" "December 2006" "fdf2tex 1.02" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH NAME +fdf2tex \- Convert PDF formular data (FDF) into something (Con)TeX(t) can +handle +.PP +.SH "SYNOPSIS" +\fBfdf2tex\fP \fIinfile\fP [ \fIoutfile\fP ] +.PP +\fBfdf2tan\fP \fIinfile\fP +.PP +.SH DESCRIPTION +.PP +Converts PDF formular data (FDF) into something (Con)TeX(t) can +handle. This command is usually called indirectly during ConTeXt +file processing, so most users do not need to worry about it. +.HP +.SH "BUGS" +.PP +Probably none -- all errors are in this manpage +.PP +.SH "SEE ALSO" +.IP \(bu +\fBtexexec\fP(1). +.IP \(bu +The TeXExec manual, \fImtexexec.pdf\fP. +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" + +This manual page was written by Frank Küster <frank@kuesterei.ch>, +for the Debian GNU/Linux system, and modified by Sanjoy Mahajan +<sanjoy@mit.edu>. It may be used and modified by others without +contacting the authors. + diff --git a/Build/source/texk/tetex/context/makempy.man b/Build/source/texk/tetex/context/makempy.man new file mode 100644 index 00000000000..98af35224a4 --- /dev/null +++ b/Build/source/texk/tetex/context/makempy.man @@ -0,0 +1,72 @@ +.TH MAKEMPY "1" "December 2006" "makempy 1.1" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH NAME +makempy \- convert PDF or PostScript text to MetaPost graphics + +.SH "SYNOPSIS" +\fBmakempy\fP \fIfilenam\fP + +.SH DESCRIPTION + +\fBmakempy\fP takes MetaPost output files (\fI*.mpo\fP) and +translates them to \fI*.mpy\fP files. In order to include text as a +graphic into a file typeset with (Con)TeX(t), you extract the text +from Postscript of PDF files using \fBpdftops\fP(1) and \fBpstoedit\fP(1), +creating a Metapost input file. + +This file can then be processed by \fBmakempy\fP. The \fBmakempy\fP +script does its work without user intervention. When it deduces that +there are no changes, it does not do anything; otherwise it reports +its steps and any errors. +.SH "OPTIONS" +.IP "\fB--help\fP" +print basic usage information +.IP "\fB--silent\fP" +don't report status messages +.IP "\fB--force\fP" +always process the file (no checksum test) +.IP "\fB--noclean\fP" +don't remove temporary files when finished +.IP "\fB--pdftops\fP" +use \fBpdftops\fP(1), part of the \fBxpdf\fP(1) programs, +to convert PDF to PostScript +.IP "\fB--ghostscript\fP" +use GhostScript (see \fBpdf2ps\fP(1)) to convert PDF to PostScript + +.SH "VARIABLES" +.PP +When set, the environment variables GS and GS_PROG will be used to +identify GHOSTSCRIPT. The names of the other programs that +are used can be set with PDFTOPS and PSTOEDIT. +.HP + +.SH "SEE ALSO" + +.IP \(bu +\fBmpost\fP(1), \fBpstoedit\fP(1), \fBtexexec\fP(1). +.IP \(bu +The makempy manual, \fImmakempy.pdf\fP, +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" + +This manual page was written by Frank Küster <frank@kuesterei.ch>, +for the Debian GNU/Linux system. It may be used and modified by +others without contacting the author. diff --git a/Build/source/texk/tetex/context/pdftools.man b/Build/source/texk/tetex/context/pdftools.man new file mode 100644 index 00000000000..f028b1ffb91 --- /dev/null +++ b/Build/source/texk/tetex/context/pdftools.man @@ -0,0 +1,59 @@ +.TH PDFTOOLS "1" "December 2006" "pdftools 1.2" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH NAME +pdftools \- analyze PDF files, change image colors +.PP +.SH "SYNOPSIS" +\fBpdftools\fP [ \fIOPTION\fP ... ] <file> [ <file> ... ] + +.SH DESCRIPTION + +\fBpdftools\fP analyzes PDF files and changes image colors. +It is used by the ConTeXt programs. The image-processing features are +not documented here (since I don't understand what they do). +.PP +.SH "OPTIONS" +.PP +.IP "\fB--help\fP" +Print the available options. +.IP "\fB--analyzefile\fP" +Print statistics about each PDF file, including +size, number of xforms, annotations, links, etc. +.IP "\fB--info\fP" +Print, in XML format, information about the PDF files. +It gives the number of pages, producer, author, subject, creation date, +bounding boxes, ... See also \fBpdfinfo\fP(1). +.IP "\fB--countpages\fP" +Print the number of pages in each PDF file. + +.SH "SEE ALSO" + +.IP \(bu +\fBtexexec\fP(1), \fBpdfinfo\fP(1), \fBpdftk\fP(1) +.IP \(bu +The pdftools manual \f(CWmpdftools.pdf\fP +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . +.IP \(bu +The PDF specification <http://www.adobe.com/devnet/pdf/pdf_reference.html> + +.SH "AUTHOR" + +This (incomplete) manual page was written by Sanjoy Mahajan +<sanjoy@mit.edu>. It is in the public domain. diff --git a/Build/source/texk/tetex/context/pstopdf.man b/Build/source/texk/tetex/context/pstopdf.man new file mode 100644 index 00000000000..24b3fe68c74 --- /dev/null +++ b/Build/source/texk/tetex/context/pstopdf.man @@ -0,0 +1,74 @@ +.TH "PSTOPDF" "1" "December 2006" "pstopdf 2.0" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +pstopdf \- convert EPS to PDF + +.SH "SYNOPSIS" +\fBpstopdf\fP [ \fIOPTION\fP ... ] \fIFILE\fP [ ... ] + +.SH "DESCRIPTION" + +\fBpstopdf\fP converts EPS (encapsulated PostScript) to PDF. + +.SH OPTIONS +.TP +.B --help +Print usage and version information. +.TP +.B --convert +Convert EPS to PDF. This option is assumed if none is given. +.TP +.BI --method= string +What method to use for bounding boxes when converting to PDF. +Specify one of \fBcrop\fP, \fBbounded\fP (the default), or \fBraw\fP. +Older versions of ConTeXt used numerical methods (1, 2, or 3). +.TP +.BI --resolution= string +The resolution to use when when converting to pdf. +Specify one of \fBlow\fP, \fBnormal\fP, \fBmedium\fP, \fBhigh\fP, +\fBprinter\fP, \fBprint\fP, \fBscreen\fP, \fBebook\fP, or +\fBdefault\fP. +.TP +.B --request +Handle exa request file. +.TP +.B --watch +Watch folders for conversions (\fIuntested\fP). + +.SH EXAMPLES + +To make \fIcow.pdf\fP: +.EX +pstopdf cow.eps +.EE +or (one of several equivalences): +.EX +pstopdf --convert cow.eps cow.pdf +.EE + + +.SH "SEE ALSO" +.IP \(bu +.BR epstopdf (1), +.BR mptopdf (1), +.BR texexec (1). +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" +This (incomplete) manual page was written by Sanjoy Mahajan +<sanjoy@mit.edu>. It is in the public domain. diff --git a/Build/source/texk/tetex/context/texexec.man b/Build/source/texk/tetex/context/texexec.man new file mode 100644 index 00000000000..2cb3e94ca5f --- /dev/null +++ b/Build/source/texk/tetex/context/texexec.man @@ -0,0 +1,640 @@ +.TH "TEXEXEC" "1" "December 2006" "texexec 6.2" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +texexec \- front end to the ConTeXt typesetting system + +.SH "SYNOPSIS" +\fBtexexec\fP [ \fIOPTION\fP ... ] \fIFILE\fP [ ... ] + +.SH "DESCRIPTION" + +\fBtexexec\fP, a \fBruby\fP(1) script, +is the command-line front end to the ConTeXt typesetting +system, an extensive macro package +built on the \fBtex\fP(1) family of typesetting programs. +\fBtexexec\fP provides several facilties: +.IP \(bu +Process a ConTeXt source file, +performing as many runs as +necessary of \fBtex\fP(1), \fBtexutil\fP(1), and +MetaPost (\fBmpost\fP(1)). Options control the output +format, the pages to process, paper size, and so forth. +.IP \(bu +Create new ConTeXt formats, useful during installation. +.IP \(bu +Post-process existing PDF files, including merging multiple +files, and extracting and rearranging pages within a file, +similar to the facilities provided for PostScript files by +\fBpsnup\fP(1) or for PDF files by \fBpdftk\fP(1). +.IP \(bu +Extract or strip documentation from ConTeXt source files +using \fBtexutil\fP(1). +.IP \(bu +Run MetaPost (\fBmpost\fP(1)) to generate figures from MetaPost source. +.IP \(bu +Produce proof sheets of figures used in a ConTeXt source file. +.IP +.SH "OPTIONS" + +All switches are specified in full here but can be abbreviated to the +shortest unique prefix. Thus, \fB--env\fP works the same as +\fB--environment\fP. With no options, \fBtexexec\fP assumes that +the file on the command line is a ConTeXt source file, i.e. a TeX file +in the ConTeXt dialect, and produces a PDF file using the source file. + +.SS "General Options" + +.IP "\fB--alone\fP" +Avoid calling other programs when possible. For +example, \fB--alone\fP will prevent \fBtexexec\fP from +using \fBfmtutil\fP(1) to generate formats (this prevention can +be handy when tracing installation problems). +.IP "\fB--environments\fP\fI=\fP\fIfile[,file[,...]]\fP" +Specify ConTeXt environment file(s), separated by commas, to use when +processing the source file. This option is useful when converting +from non-ConTeXt file formats without environment or layout settings. +.IP "\fB--help\fP" +Produce a summary of switches +and arguments. A more detailed help is produced by including +\fB--all\fP. +.IP "\fB--interface=\fP\fIlanguage\fP" +Specify the language +ConTeXt should use to communicate with you. +Options are +.IP +.RS +.IP "\fBen\fP" +US English +.IP "\fBnl\fP" +Dutch +.IP "\fBde\fP" +German +.IP "\fBuk\fP" +British English +.IP "\fBcz\fP" +Czech +.IP "\fBit\fP" +Italian +.RE +.IP "\fB--keep\fP" +Preserve a few of the temporary files generated while processing by +appending \fI.keep\fP to their name. For example, after +.EX +texexec --keep document.tex +.EE +you will find (besides \fIdocument.pdf\fP) \fIdocument.log.keep\fP +and \fIdocument.top.keep\fP. The \fIdocument.top\fP file is where +\fBtexexec\fP wraps \fIdocument.tex\fP with the proper ConTeXt macro +commands to set the output format, etc. +.IP "\fB--once\fP" +Process a file exactly once. (By default, +\fBtexexec\fP processes the file as many times as +necessary to sort out all references, typeset +\fBMetaPost\fP code, and so forth.) +.IP "\fB--purge\fP" +Get rid of most temporary files generated while processing the source +file. For example, +.EX +texexec --purge somefile.tex +.EE +will generate \fIsomefile.pdf\fP, cleaning up after itself and leaving +only one extra file, \fIsomefile.tuo\fP. See also the \fB--purge\fP +option of +.BR ctxtools (1) +.IP "\fB--purgeall\fP" +Get rid of all temporary files generated while processing the source +file, including the \fIfilename.tuo\fP file. See also the \fB--purge +--all\fP option combination of +.BR ctxtools (1) +.IP "\fB--randomseed=\fP\fINNNN\fP" +Set the random seed. +.IP "\fB--result=\fP\fIFILENAME\fP" +Allows you to change the +basename of the output file. See +\fB--mode\fP for an example. +.IP "\fB--runs=\fP\fINUMBER\fP" +Specify the number of runs to +perform on a file. Overrides +\fBtexexec\fP's calculations. +.IP "\fB--separation\fP" +Perform color separations. +.IP "\fB--silent\fP" +Suppress a few diagnostic and progress messages. +.IP "\fB--timeout=\fP\fINNN\fP" +Abort the run if a subprocess waits for more than \fINNN\fP seconds; +e.g. while waiting for user input when \fBtex\fP reports an undefined +control sequence. Useful for automated testing scripts, to make sure +the runs finish. +.IP "\fB--usemodules=\fP\fImodule1[,module2,[...]]\fP +Use the comma-separated list of modules. For example, to typeset +\fIdocument.tex\fP using the \fIbib\fP and \fIunits\fP modules: +.EX +texexec --usemodules=bib,units document.tex +.EE +.IP "\fB--verbose\fP" +Output extra diagnostic information. +.IP "\fB--version\fP" +Print the version number. +.IP + +.SS "Processing ConTeXt Source Files" + +Including specifying paper sizes, formats, and so forth. + +.IP "\fB--arrange\fP" +Perform page rearrangements, which are used to produce booklets. This +option tells ConTeXt to the first \fIn\fP-1 runs without taking +account of arrangements, then on the last run to pay attention to +the arrangement commands in the source file. +.IP "\fB--batchmode\fP" +Process the file in batchmode, which means +to typeset the whole document even if there are errors. More +imformation about \f(CWbatchmode\fP can be found in Donald +E. Knuth's \fITeXbook\fP. +.IP "\fB--nonstopmode\fP" +Process the file in nonstopmode, which means +to typeset the document and report errors, but not to stop at any +error. It is similar to batchmode but more verbose. More +imformation about \f(CWnonstopmode\fP can be found in Donald +E. Knuth's \fITeXbook\fP. +.IP "\fB--bodyfont=\fP\fIfont\fP" +The name of a font to preload for use in +setting the body of the text (OBSOLETE). +.IP "\fB--centerpage\fP" +Center the document on the page. +.IP "\fB--color\fP" +Turn on color mode. Color mode can also be set by +commands embedded in the document. These commands +override the \fB--color\fP option. +.IP "\fB--convert=\fP\fIFORMAT\fP" +Convert the input file to +ConTeXt format from \fIFORMAT\fP before +processing. In most cases, this conversion will result +in a TeX file. Currently supported input +\fIFORMAT\fPs are \fBxml\fP and +\fBsgml\fP. +.IP "\fB--dvipdfmx, --dvipdfm, --dpx, --dpm\fP" +Use the TeX engine (e.g. \fBpdftex\fP or \fBpdfetex\fP) +to make a DVI file and \fBdvipdfmx\fP(1) to turn it +into PDF. +.IP "\fB--dvi, --ps, --dvips\fP" +Use the TeX engine (e.g. \fBpdftex\fP or \fBpdfetex\fP) +to make a DVI file and \fBdvips\fP(1) to turn it +into PostScript. It's counterintuitive that \fB--dvi\fP produces +a PostScript file in addition to the DVI file. But that's because +\fB--dvi\fP is shorthand for \fB--dvips\fP; adding the \fB--nobackend\fP +option prevents \fBtexexec\fP's running \fBdvips\fP(1). See also the +\fB--engine\fP option. +.IP "\fB--fast\fP" +Typeset the document(s) as fast as possible without +causing problems. +.IP "\fB--final\fP" +Perform a final run without skipping anything. +This option is typically used with \fB--fast\fP. +.IP "\fB--language=\fP\fILANGUAGE\fP" +Set the language for +hyphenation. Can be specified in your source file. +Options are the same as those for \fB--interface\fP. +.IP "\fB--mode=\fP\fIMODELIST\fP, \fB--modes=\fP\fIMODELIST\fP" +Allows you to change the mode used while typesetting the +source file. The \fIMODELIST\fP is a comma separated list of modes. +Modes are a conditional-compilation facility +like \f(CW#ifdef\fP in C. So one source file can be used to produce +several typeset documents: one for A4 paper, one for +screen display in full color, one for letter paper, etc. For +example: +.IP +.EX +\f(CWtexexec --pdf --mode=A4 --result=manual-a manual-t.tex\fP +\f(CWtexexec --pdf --mode=letter --result=manual-l manual-t.tex\fP +\f(CWtexexec --pdf --mode=screen --result=manual-s manual-t.tex\fP +.EE +.IP +Here the \fB--mode\fP tells ConTeXt which +mode directives to use when typesetting the source file. The +\fB--result\fP option tells ConTeXt +where to put the output file. +.IP "\fB--modefile=\fP\fIfile\fP" +Load this file before most of the usual processing; usually used for +mode-related material. +.IP "\fB--noarrange\fP" +Ignore arrangement commands in the source file. +.IP "\fB--nobackend\fP" +Do not run the backend, e.g. \fBdvips\fP(1) or \fBdvipdfmx\fP(1). See +the \fB--dvips\fP or \fB--dvipdfmx\fP options. Why would you give one +of those options to choose a backend, yet tell \fBtexexec\fP not to +run the backend? Because each backend has its own syntax for +\f(CW\\special\fP calls. Specifying the backend allows the ConTeXt +macros to use the correct syntax so that when you later run the +backend to produce PostScript or PDF, the specials will be interpreted +correctly. +.IP "\fB--pages=\fP\fIPAGENUMBERLIST\fP" +Specify the pages or page +range to appear in the output file. +\fIPAGENUMBERLIST\fP may be the keyword \fBodd\fP +or \fBeven\fP; or one or more pages or page ranges separated by commas. +For example, +.EX +\f(CWtexexec --pages=1,7,8-11,14 somefile.tex\fP +.EE +.IP "\fB--paperformat=\fP\fIKEY\fP" +For typesetting multiple pages on a +single piece of paper. \fIKEY\fP has the form \fBa4a3\fP +(for printing A4 pages on A3 paper), \fBa5a4\fP +(for printing A5 pages on A4 paper), or in general \fBaMaN\fP. +The actual layout of the pages is specified with the +\fB--printformat\fP option. +.IP "\fB--pdf, --pdftex\fP" +Use \fBpdftex\fP(1) to produce a pdf document (the default). +.IP "\fB--printformat=\fP\fIKEY\fP" +Specify the layout of the final +output. \fIKEY\fP can be \fBup\fP, resulting in 2 +pages per sheet, double sided; or \fBdown\fP, resulting +in 2 rotated pages per sheet, double sided. Use the +\fB--paperformat\fP option to specify the original page +and sheet size. +.IP "\fB--utfbom\fP" +Turn on UTF-8 encoding. +.IP "\fB--xetex, --xtx\fP" +Use \fBxetex\fP(1) to produce a pdf document. +.IP + +.SS "Creating ConTeXt Format Files" + +.IP "\fB--make\fP" +Generate a ConTeXt format file. For example, to make +\fIcont-en.fmt\fP and have it placed in a default format directory: +.EX +texexec --make de +.EE +The most common invocation, which is used by scripts that install a new version +of ConTeXt (see \fBctxtools\fP(1)), uses \fB--all\fP +so that \fBtexexec\fP makes the usual formats: +.EX +texexec --make --all +.EE +.IP "\fB--local\fP" +When searching for TeX or MetaPost formats, look in the current directory +rather than in the location set by the kpse library. See +.BR kpathsea (1) +for more information on path searching. +.IP "\fB--check\fP" +Check and report information about the ConTeXt version, the +distribution, the TeX engine, and the language interfaces/formats. + +.SS "Expert options" + +You should know what you're doing if you use these options! +.IP "\fB--alpha" +Use the TEXMFALPHA environment variable to find and +run an alpha release of ConTeXt. +.IP "\fB--beta" +Use the TEXMFBETA environment variable to find and +run a beta release of ConTeXt. +.IP "\fB--distribution\fP\fI=dist\fP" +Usually one of \fBstandard\fP, \fBweb2c\fP, or \fBmiktex\fP. +\fBtexexec\fP should figure it out automatically, and you shouldn't +need to use this option. +.IP "\fB--engine\fP\fI=texengine\fP" +Specify the program to do the hard work of typesetting. Currently +either \fBpdftex\fP (the default), \fBxetex\fP, or \fBaleph\fP. +The \fBluatex\fP value is experimental. The \fB--engine\fP +option is not usually needed. Instead, let +\fBtexexec\fP figure out the setting based on other command-line +information. See for example the \fB--xetex\fP or \fB--pdf\fP +switches. + +.SS "Postprocess PDF Files" + +.IP "\fB--combination=\fP\fIROWS\fP\fB*\fP\fICOLS\fP" +Specify the number of pages to show on a single page. Use with +\fB--pdfcombine\fP. +.IP "\fB--pdfarrange\fP" +For rearranging pages in PDF files. +.EX +\f(CWtexexec --pdfarrange --paperformat=a5a4 --printformat=up foo.pdf\fP +.EE +This command creates an A5 booklet from a PDF file +\fIfoo.pdf\fP. \fB--pdfarrange\fP is used in +conjunction with the following options. +.IP "\fB--pdfcopy\fP" +Copy and perhaps process pages from the pdf file. +The resulting file is \fItexexec.pdf\fP by default, but you can change +that using \fB--result\fP. Use the \fB--scale\fP option to magnify or +demagnify the original pages and the \fB--pages\fP option to select +the pages to copy. Here is an example using all these options: +.EX +texexec --pages=4-7 --pdfcopy --scale=750 --result=one images.pdf +.EE +It takes pages 4-7 from \fIimages.pdf\fP, scales them by 75%, +and copies them to \fIone.pdf\fP. +.IP "\fB--scale=\fP\fIinteger\fP" +If the integer is less than 10, then it is taken as an (integer) +magnification factor. Otherwise, it is taken as a magnification +factor in TeX terms, i.e. with 1000 meaning full scale. +.IP "\fB--paperoffset=\fP\fIdimen\fP" +Specify the space between the +edge of the pages and the beginning of the text block. +.IP "\fB--backspace=\fP\fIdimen\fP" +Specify the inside (gutter) margins. +.IP "\fB--topspace=\fP\fIdimen\fP" +Specify the top and bottom margin. +.IP "\fB--markings\fP" +Add crop marks. +.IP "\fB--addempty=\fP\fIPAGES\fP" +Add empty pages after the pages specified in \fIPAGES\fP. (Useful +for, among other things, adding blank pages after a table of +contents.) +.IP "\fB--textwidth=\fP\fIWIDTH\fP" +Set the width of +the original text. Specifying this parameter with a +single-sided original will allow ConTeXt to adjust +the page layout for double-sided output, producing much +more attractive results. + +With the \fB--pdfarrange\fP flag, specifying more +than one file will result in all of the files being +combined in the final result, allowing you to add title +pages, decorated part separators, and so forth. + +You can also do more complex manipulations, such as +adding additional text to the page by setting up a +small file with layout definitions and a simple figure +insertion loop. +.IP "\fB--pdfcombine\fP" +Combine multiple pages. Requires the \fB--combination\fP option. +.IP "\fB--pdfselect\fP" +Extract pages from a file. Use in combination with the +\fB--selection\fP switch, as in +.EX +\f(CWtexexec --pdfselect --paperformat=S6 +--selection=1,9,14 file-1\fP +.EE +which extracts pages 1, 9, and 14 from +\fIfile-1.pdf\fP, and places them in +\fItexexec.pdf\fP (the default output filename if +an output file isn't specified). + +See \fB--pdfarrange\fP for other +options. +.IP "\fB--selection=\fP\fIPAGES\fP" +Specify pages to be affected by +another option. See \fB--pdfarrange\fP and +\fB--pdfselect\fP for examples. + +.SS "XML handling" +.IP "\fB--filters=\fP\fIfilter1[,filter2[,...]]\fP +Specify XML filters to use. + +.SS "Extract or Strip Out Documentation" + +.IP "\fB--listing\fP" +Produce a typeset version of the source code in +\fIFILE\fP. You can specify the format of the output +file. For example, use +.EX +\f(CWtexexec --ps --listing readme.now\fP +.EE +to produce a PostScript file called +\fItexexec.ps\fP. + +See also \fB--backspace\fP, \fB--topspace\fP, and \fB--result\fP. +.IP "\fB--module\fP" +Create documentation for ConTeXt, +MetaPost (see \fBmpost\fP(1)), +.BR perl (1), +and +.BR ruby (1) +modules. +Converts the documentation to ConTeXt format and +then typesets a documentated version of the source file. + +Documentation lines in ConTeXt source files are +specified by beginning lines with these strings: + +\f(CW%C\fP : Copyright information + +\f(CW%D\fP : Documentation lines + +\f(CW%I\fP : TeXEdit information lines (mostly in Dutch) + +\f(CW%M\fP : Macro code needed to processs the documentation + +\f(CW%S\fP : Suppressed lines + +The same forms can be used for Perl or ruby scripts, except that the \f(CW%\fP +character (the TeX comment character) is replaced by \f(CW#\fP (the +Perl comment character). + +See also the \fB--documentation\fP option to +.BR ctxtools (1). + +.SS "Process MetaPost Figures" + +.IP "\fB--mpsformats=\fP\fIname\fP" +The name of a MetaPost format file, e.g. \fBmetafun\fP (the default). +.IP "\fB--mptex\fP" +Strips out and typesets TeX code embedded in a +MetaPost file. +.IP "\fB--nomp\fP" +Do not run \fBmpost\fP(1), even if needed. +.IP "\fB--nomprun\fP" +Do not run \fBmpost\fP(1) on embedded +MetaPost code. + +.SS "Producing Proof Sheets of Figures" + +Generate information and proof sheets of one or more (non-EPS) +graphics files. For example, +.EX +texexec --figures *.png *.jpg +.EE +scans the current directory for PNG and JPG files +and extracts useful information about their sizes and types. By +default, this information is stored in +.IR rlxtools.rli . +Then the given figures are made into a proof sheet (by default +\fItexexec.pdf\fP) according to the method specified by the +\fB--method\fP option. Note that newer versions of +.BR pdftex (1) +do not support TIFF inclusion. +.IP "\fB--method=\fP\fIALTERNATIVE\fP" +Specify one of three options to produce the document containing the images +used in the source file: + +\fBa\fP : A proof sheet with additional +information provided for each figure (the default) + +\fBb\fP : A proof sheet with the graphics only + +\fBc\fP : One figure per page, with the page +clipped to the bounding box of the +figure + +See also \fB--paperoffset\fP, +which allows you to specify an offset to be added to +the page, as in +.EX +texexec --figures --method=c --paperoffset=.5cm *.pdf *.png *.jpg +.EE + +.SH "USAGE" + +Each ConTeXt user interface (language) has its own format. The +following command generates two formats, one using the English +interface for typesetting in English, and one for Dutch: +.EX +\f(CWtexexec --make en nl\fP +.EE + +By default, the language used for typesetting matches the +user-interface language (set with +\fB--interface\fP. It is possible to use one +language for typesetting and another for messages by changing the +relevant settings in \fIcont-usr.tex\fP. These languages can +also be changed on the command line with a command such as +.IP +.RS +\f(CWtexexec --make --language=pl,cz,sk en\fP +.RE +.IP +That command generates a ConTeXt format file with an English user +interface, and the main language set to Polish (\fBpl\fP). Czech +and Slovak hyphenation patterns are also loaded +so that Czech and Slovak text included in a source file will be +typeset properly (\fBcz\fP and \fBsk\fP). +.IP o +When the appropriate formats are present, a file can be typeset +by typing +.EX +\f(CWtexexec test\fP +.EE +.IP +\fBtexexec\fP tries to determine what interface it should use to +typeset \fItest.tex\fP by looking for a line such as +.IP +.EX +\f(CW% interface=en tex=pdftex output=pdftex\fP +.EE +.IP +at the top of the file (i.e., on the very first line). This line is +equivalent to \fBTeX\fP's format line, ``&\fIFORMAT\fP''). +.IP +By default, \fBtexexec\fP will produce a PDF file using \fBpdftex\fP(1). The +\fB--dvips\fP flag tells \fBtexexec\fP to produce a PostScript +file instead. +.IP +After an error-free run, \fBtexexec\fP will run \fBtexutil\fP(1) to +determine whether additional runs of \fBtex\fP(1) (or +\fBpdftex\fP(1)) or any utility programs (e.g., \fBbibtex\fP(1), +\fBmakeindex\fP(1)) are necessary. You can suppress these +additional runs by specifying the \fB--once\fP or +\fB--runs\fP flags: +.IP +.EX +\f(CWtexexec --once test\fP +\f(CWtexexec --runs=2 test\fP +.EE +.IP + +.SH EXAMPLES +.TP +Produce PDF from ConTeXt source (the .tex extension is optional): +\f(CWtexexec file.tex\fP +.TP +Same as the above but without rerunning for crossreferences, etc.: +\f(CWtexexec --once file.tex\fP +.TP +Produce PostScript from ConTeXt source: +\f(CWtexexec --ps file.tex\fP +.TP +Produce file-a4.pdf using conditional compilation (modes): +\f(CWtexexec --mode=a4 --result=file-a4 file.tex\fP +.TP +Generate format (.fmt) files used by ConTeXt (used during installation): +\f(CWtexexec --make --all\fP + + +.SH "INITIALIZATION" +.IP +\fBtexexec\fP requires ruby. On Unix and Unix-like systems, no special +steps have to be taken to get \fBtexexec\fP to work beyond installing +ruby and having the \fBruby\fP(1) binary in your path. + +.SH "ENCODINGS" +.IP +Some languages require specific character encodings to represent their +alphabets (beyond the basic ASCII encoding). Although you can use TeX +commands to represent these characters, such as ``\f(CW\e.z\fP'', it's +easier to use a text editor that includes direct support for these +characters and let ConTeXt translate them to the necessary TeX +commands. For some languages, this approach can also improve the +performance of TeX's hyphenation algorithms. +.IP +ConTeXt supports several of the most commonly used encodings. +Check the files beginning with \fIenco-\fP, \fIlang-\fP, and +\fIfont-\fP in the ConTeXt distribution for more information. +.IP +\fBweb2c\fP distributions (such as \fBteTeX\fP) support a mechanism to +map document encodings to ConTeXt's internal encoding, font +encodings, and hyphenation patterns. \fBtexexec\fP provides a document +option and a command-line flag to pass the necessary information to +\fBtex\fP(1) or \fBpdftex\fP(1). You can add lines such as +.EX +\f(CW%& --translate-file=cp1250pl\fP +.EE + +or + +.EX +\f(CW% --translate=cp1250pl\fP +.EE + +to the beginning of your document, or you can specify the \fB--translate\fP +flag on the command line, as +.EX +\f(CWtexexec --translate=il2pl somefile\fP +.EE + +Using language-specific encodings will make your file less +portable than using ASCII. It may then not be possible for other people to +typeset your documents on their systems. + +.SH "SEE ALSO" +.IP \(bu +\fBbibtex\fP(1), \fBdvipdfmx\fP(1), \fBdvips\fP(1), \fBfmtutil\fP(1), +\fBmakeindex\fP(1), \fBmpost\fP(1), +\fBpdftex\fP(1), \fBpdftk\fP(1), \fBxetex\fP(1), +\fBruby\fP(1), \fBpsnup\fP(1), \fBtex\fP(1), \fBtexshow\fP(1), +\fBtexutil\fP(1). +.IP \(bu +The texexec manual +.IR mtexexec.pdf , +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . +.IP \(bu +Donald E. Knuth's \fIThe TeXbook\fP. +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" +This manpage was written by Tobias Burnus +<burnus@gmx.de> and C.M. Connelly +<c@eskimo.com> and updated by Sanjoy Mahajan <sanjoy@mit.edu>. +It is based on the +.I mtexexec.pdf +manual written by Hans Hagen <pragma@wxs.nl>. diff --git a/Build/source/texk/tetex/context/texfind.man b/Build/source/texk/tetex/context/texfind.man new file mode 100644 index 00000000000..ca39d87599b --- /dev/null +++ b/Build/source/texk/tetex/context/texfind.man @@ -0,0 +1,87 @@ +.TH "TEXFIND" "1" "December 2006" "texfind" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +texfind \- graphical tool to search for text in TeX input files + +.SH "SYNOPSIS" +.PP +\fBtexfind\fP [ \fIOPTION\fP ... ] + +.SH "DESCRIPTION" +.PP +\fBtexfind\fP is a graphical, interactive tool that helps you +searching through TeX input files, including subdirectories, and +allows you to do search/replace tasks using \fBperl\fP(1) regular +expressions. It opens two windows: One displays the directory +hierarchy and allows to select different search directories. The +second window is used to enter the query and display the results. + +.SH "SEARCHING" + +Enter a search string in the input box at the top, choose the file +extension (\fItex\fP by default) and hit ENTER to start the search. The +results will be displayed in the rest of the window. + +The search string is a perl regular expression (see \fBperlre\fP(1)), +which gives you lots of flexibility. The search-and-replace function +also uses perl regex syntax, but you can also just use simple +strings. Currently there is no way to save changed files. + +.SH "MENU" + +Use the right mouse button to open a menu. +.HP +\fBFile\fP : Currently only used to exit the program +.HP +\fBEdit\fP : Copy selections, select or unselect all +.HP +\fBSearch\fP : Open a \fBFind\fP dialog that allows further searching +through the displayed results. The \fBReplace\fP option can be used to +replace single or all occurrences of a string, but currently it is not +possible to change the file. +.PP +\fBView\fP : Select specific lines, and adjust word or character +wrapping. + +.SH "OPTIONS" +.HP +\fB\-\-font\fR : specify the font used for the menu. Default is +courier. +.HP +Other options probably exist. I appreciate input by the program +authors, experienced users, or Perl geeks. +.HP +.SH "SEE ALSO" + +.IP \(bu +\fBperl\fP(1), \fBperlre\fP(1). +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "BUGS" + +None known. However, the replace function isn't the most useful one. + +.SH "AUTHOR" + +\fBtexfind\fP was written for the ConTeXt package by Hans Hagen and +Ton Otten, PRAGMA. + +This manual page was written by Frank Küster <frank@kuesterei.ch> +for the Debian GNU/Linux system, and modified by Sanjoy Mahajan +<sanjoy@mit.edu>. It may be used and modified by +others without contacting the authors. diff --git a/Build/source/texk/tetex/texfont.man b/Build/source/texk/tetex/context/texfont.man index 692d5bcf3d9..07071d1cc2f 100644 --- a/Build/source/texk/tetex/texfont.man +++ b/Build/source/texk/tetex/context/texfont.man @@ -1,19 +1,36 @@ -.TH TEXFONT "1" "May 2004" "teTeX " "texfont.pdf" +.TH TEXFONT "1" "December 2006" "texfont 2.2" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + .SH NAME texfont \- font installation tool for ConTeXt -.PP + .SH "SYNOPSIS" -\fBtexfont\fP [ \fIOPTION\fP \&.\&.\&. ] -.PP +\fBtexfont\fP [ \fIOPTION\fP ... ] + .SH DESCRIPTION -.PP -TeXFont is a perl script that helps to set up and install TeX fonts. + +TeXFont is a +.BR perl (1) +script that helps to set up and install TeX fonts. It was designed for use with ConTeXt, but may also be helpful for users of other formats, like plain TeX or LaTeX. Its use is described -in detail in the files mtexfont.pdf and mfont.pdf. -.PP +in detail in the files \fImtexfont.pdf\fP and \fImfont.pdf\fP. + .SH "OPTIONS" -.PP + .HP \fB\-\-fontroot\fR=\fIpath\fR : texmf font root (automatically determined) .HP @@ -59,26 +76,24 @@ directory) \fB\-\-help\fR : show some more info .HP .SH "SEE ALSO" -.PP -\fBtexexec\fP(1), \fBfontinst\fP(1), \fBtexshow\fP(1), -\fBtexutil\fP(1)\&. -.PP -The TeXFont manual, \fImtexfont\&.pdf\fP\& -.PP -The ConTeXt Font manual, \fImfonts\&.pdf\fP\& -.PP -The TeXExec manual, \fImtexexec\&.pdf\fP\&. -.PP -Donald E\&. Knuth\'s \fIThe TeXbook\fP\&. -.PP +.IP \(bu +\fBtexexec\fP(1), \fBfontinst\fP(1), \fBperl\fP(1), \fBtexshow\fP(1). +.IP \(bu +The ConTeXt Font manual, \fImfonts.pdf\fP +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . +.IP \(bu +The TeXFont manual, \fImtexfont.pdf\fP +.IP \(bu +The TeXExec manual, \fImtexexec.pdf\fP. +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . +.IP \(bu +Donald E. Knuth\'s \fIThe TeXbook\fP. + .SH "AUTHOR" -.IP -This manual page was written by Frank Küster <frank@kuesterei\&.ch>, -for the Debian GNU/Linux system\&. It may be used and modified by -others without contacting the author\&. Any mistakes or omissions in -the manual page are my fault; inquiries about or corrections to this -manual page should be directed to me (and not to the primary -author)\&. -.IP -The PDF manual and \fBtexfont\fP itself can be obtained from -<http://www\&.pragma-ade\&.com> + +This manual page was written by Frank Küster <frank@kuesterei.ch>, +for the Debian GNU/Linux system, and modified by Sanjoy Mahajan +<sanjoy@mit.edu>. It may be used and modified by others without +contacting the authors. diff --git a/Build/source/texk/tetex/context/texmfstart.man b/Build/source/texk/tetex/context/texmfstart.man new file mode 100644 index 00000000000..75240d8afe6 --- /dev/null +++ b/Build/source/texk/tetex/context/texmfstart.man @@ -0,0 +1,363 @@ +.TH "TEXMFSTART" "1" "December 2006" "texmfstart 2.0" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +texmfstart \- run ConTeXt scripts, make ConTeXt wrapper scripts, view documents + +.SH "SYNOPSIS" +\fB texmfstart\fP [ \fIoptions ...\fP ] [ \fIfilename\fP ] [ \fIarguments ...\fP ] + +.SH "DESCRIPTION" +ConTeXt is a typesetting system based on +the .BR tex (1) +family of programs. +.B texmfstart +is a ConTeXt meta-script that can run subordinate +scripts (subscripts?) such +as +.BR texexec (1), +.BR ctxtools (1), +or +.BR pdftools (1). +It can also generate short wrapper scripts to simplify common uses. +These scripts are often called +.I stubs +in the ConTeXt documentation. The options control +.BR texmfstart 's +behaviour, and the arguments are passed +to the program identified by +.IR filename . + +If the filename is a document, then +.B texmfstart +will start a viewer for that document. For example: +.EX +texmfstart showcase.pdf +.EE +will start an appropriate viewer for +.IR showcase.pdf . +See the +.B EXAMPLES +section. + +.SH OPTIONS + +.SS General: +.TP +.B --help, --version +print version information, usage, and examples. +.TP +.B --verbose +print status and progress information, for example what commands are +being executed. +.TP +.B --clear +don't pass info about locations to child processes. + +.SS Running a program: +.TP +.B --arguments=\fIstr\fP +an alternative for providing the arguments to be passed. For example, +.EX +texmfstart --arguments=b.tex texexec +.EE +will pass +.I b.tex +as the argument to +.BR texexec . +.TP +.B --report +dry run: report what command would be run, but do not run it +.TP +.B --locate +dry run: like \f(CW--report\fP but doesn't print the trailing newline. +.TP +.B --browser +view the document in a web browser (for Windows). +.TP +.B --file=\fIfilename\fP +an alternative way to specify the file (the program to run or document +to open). +.TP +.B --direct +run a program without searching for its location (assumes that the +program is on the PATH). +.TP +.B --execute +use the +.BR ruby (1) +.I exec +function instead of its +.I system +function. +.TP +.B --program=\fIstr\fP +the program space where +.BR kpsewhich (1) +will search (default: context). This information is given to +.B kpsewhich +as its \f(CW-progname\fP option. Usually you don't need this option. + +.SS Creating startup scripts: +.TP +.B --make +create a wrapper script or batch file to run the given file. +The wrapper scripts are put in the current path, which usually means +the current directory. If +\fIall\fP is given as the file, e.g. +.EX +texmfstart --make all +.EE +then make all the ConTeXt wrapper scripts (the stubs). +.TP +.B --windows +when making a wrapper script (stub), create a Windows batch (.bat) file. +Usually you +do not need to specify this option, as +.B texmfstart +will figure out what operating system you are using. +.TP +.B --linux +when making a wrapper script, create a Unix shell script. Usually you +do not need to specify this option, as +.B texmfstart +will figure out what operating system you are using. +.TP +.B --stubpath=\fIpath\fP +specify where to put the wrapper scripts (stubs). +.TP +.B --indirect +always use +.I texmfstart +in the wrapper script (stub). + +.SS Document viewing: +.TP +.B --page=\fInumber\fP +open the document at this page. + +.SS Environments and paths: +.TP +.B --path=\fIstr\fP +change to the specified path. +.TP +.B --tree=\fIstr\fP +use the given TEXMF tree. +.TP +.B --autotree +automatically determine the TEXMF tree to use (the default). +.TP +.B --environment=\fIstr\fP +use the given environment file. Its syntax is given in the +.I mtexmfstart.pdf +manual. +.TP +.B --showenv +print the environment variables known at runtime + +.SS Conditional execution: +.TP +.B --iftouched=\fIfile1,file2\fP +run only when the given files have different timestamps. +.TP +.B --ifchanged=\fIstr\fP +run only when the given file has changed (based on its last-computed MD5 +checksum). + +.SS Special features: +.TP +.B --edit +open the given file in an editor. + +.SH "FILENAME PREFIXES" +.SS +Optional prefixes determine the method used to search for the specified file: +.TP +.I bin:filename +expanded name based on the PATH environment variable +.TP +.I kpse:filename +expanded name based on +.BR kpsewhich (1) +result +.TP +.I rel:filename +expanded name relative to the current directory +.TP +.I env:name +expanded pathname based on environment variable +.I name +.TP +.I path:filename +path part of filename as located by +.BR kpsewhich (1) + +.SH EXAMPLES +.TP +\f(CWtexmfstart texexec.rb file.tex\fP +Locate the +.I texexec.rb +script and run it with +.I file.tex +as its argument. In other words, make +.I file.pdf +from +.IR file.tex . +If +.BR texexec (1) +is properly installed on your system, +this common invocation can be shortened to +.EX +\f(CWtexexec file.tex\fP +.EE +.TP +\f(CWtexmfstart texexec file.tex\fP +Locate the +.BR texexec (1) +program (currently a +.BR ruby (1) +script, +.IR texexec.rb ) +and run it with +.I file.tex +as its argument, producing +.I file.pdf. +This invocation can be shortened to +.EX +texexec file.tex +.EE +.TP +\f(CWtexmfstart ctxtools --updatecontext\fP +Run the +.BR ctxtools (1) +script, updating the ConTeXt installation. This +invocation is equivalent to +.EX +ctxtools --updatecontext +.EE +.TP +\f(CWtexmfstart pstopdf --method=3 cow.eps\fP +Convert +.I cow.eps +to PDF using method 3 of +.BR pstopdf (1). +This invocation is equivalent to +.EX +pstopdf --method=3 cow.eps +.EE +.TP +\f(CWtexmfstart --make --stubpath=/usr/local/bin texexec\fP +Make a wrapper script (stub), either a shell script +.I /usr/local/bin/texexec +on Unix, or a batch file \fI\\usr\\local\\bin\\texexec.bat\fP +on Windows. On Unix (and maybe on Windows?), you need to make +the script executable; see +.BR chmod (1). +.TP +\f(CWtexmfstart --edit kpse:cont-sys.tex\fP +Locate and edit the \fIcont-sys.tex\fP configuration file. +.TP +\f(CWtexmfstart --ifchanged=whatever.mp texexec --mpgraphic whatever.mp\fP +Rerun +.B texexec +if +.I whatever.mp +has changed since the last use of +.IR --ifchanged . +.TP +\f(CWtexmfstart --ifchanged=whatever.mp bin:echo rerun MetaPost\fP +If the +.I whatever.mp +source file has changed since the last use of +.IR --ifchanged , +then use the +.BR echo (1) +command to tell the user to rerun MetaPost +.RB "(see " mpost (1)). +This example shows that +.B texmfstart +can be used to run any script, not just ConTeXt scripts. The +\f(CWbin:\fP prefix tells +.B texmfstart +not to search for +.I echo +in the TEXMF tree(s), but to assume that it's an executable somewhere +on the PATH. +.TP +\f(CWtexmfstart --ifchanged=whatever.mp --direct echo rerun MetaPost\fP +This invocation has the same effect as the preceding example, but +using \f(CW--direct\fP instead of the \f(CWbin:\fP prefix, again to tell +.B texmfstart +not to search for the +.I echo +command. + +.SH FILES +.TP +.I file.md5 +MD5 checksum file used for the \f(CW--ifchanged\fP option. + +.SH ENVIRONMENT +.TP +PATH +For expanding filenames given with a +.I bin +prefix. +.TP +TEXMFSTART_EDITOR, EDITOR, editor +Editor to use with +.IR --edit . +The environment variables are looked up in that order, with the first +setting found taking priority. + +.SH "SEE ALSO" +.IP \(bu +.BR ctxtools (1), +.BR kpsewhich (1), +.BR makempy (1), +.BR mpost (1), +.BR pdftools (1), +.BR pstopdf (1), +.BR texexec (1), +.BR texfont (1), +.BR texutil (1). +.IP \(bu +.URL "http://www.contextgarden.net" "ConTeXt wiki" . +.IP \(bu +The +.B texmfstart +manual, +.IR mtexmfstart.pdf , +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . + +.SH BUGS +On Unix, opening a PDF document first tries +.B pdfopen +then +.BR acroread , +neither of which may be present on your system. + +The \f(CW--report\fP option doesn't work if you specify a filename +prefix (i.e. it does a real run instead of a dry run). + +.SH "AUTHOR" +ConTeXt is written and maintained by +.URL "http://www.pragma-ade.com" "Hans Hagen" . +This man page, which is in the public domain, was written by Sanjoy +Mahajan based on the +.I mtexmfstart.pdf +manual. diff --git a/Build/source/texk/tetex/context/texutil.man b/Build/source/texk/tetex/context/texutil.man new file mode 100644 index 00000000000..51ac904d503 --- /dev/null +++ b/Build/source/texk/tetex/context/texutil.man @@ -0,0 +1,22 @@ +.TH "TEXUTIL" "1" "December 2006" "texutil 9.1" "ConTeXt" + +.SH "NAME" +texutil \- ConTeXt utility program + +.SH "SYNOPSIS" +\fBtexutil\fP [ \fIOPTION\fP... ] \fIFILENAME\fP[...] + +.SH "DESCRIPTION" + +This program, whether as a Perl or the newer ruby script, is +deprecated and many of its features are available in +\fBctxtools\fP(1), \fBgs\fP(1), \fBpdftools\fP(1), and +\fBtexexec\fP(1). + +.SH SEE ALSO + +\fBctxtools\fP(1), \fBgs\fP(1), \fBpdftools\fP(1), \fBtexexec\fP(1) + +.SH "AUTHOR" + +This skeleton man page was written by Sanjoy Mahajan <sanjoy@mit.edu>. diff --git a/Build/source/texk/tetex/makempy.man b/Build/source/texk/tetex/makempy.man deleted file mode 100644 index 5e37e1e9f33..00000000000 --- a/Build/source/texk/tetex/makempy.man +++ /dev/null @@ -1,60 +0,0 @@ -.TH makempy "1" "May 2004" "teTeX " "ConTeXt" -.SH NAME -makempy \- Helper script for conversion of (PDF or PostScript) text to -\fBMetaPost\fP graphics -.PP -.SH "SYNOPSIS" -\fBmakempy\fP \fIfilenam\fP -.PP -.SH DESCRIPTION -.PP -\fBmakempy\fP takes \fBMetapost\fP output files (*\&.mpo) and -translates them to *\&.mpy files. In order to include text as a -graphic into a file typeset with (Con)TeX(t), you extract the text -from Postscript of PDF files using \fBpdftops\fP and \fBpstoedit\fP, -creating a Metapost input file. -.PP -This file can then be processed by \fBmakempy\fP. The \fBmakempy\fP -script does its work without user intervention. When it deduces that -there are no changes, it will not run at all, otherwise it will report -its steps and/or encountered error. -.SH "OPTIONS" -.IP -.IP "\fB--help\fP" -returns some basic help information -.IP -.IP "\fB--silent\fP" -don t report status messages -.IP -.IP "\fB--force\fP" -always process the file (no checksum test) -.IP -.IP "\fB--noclean\fP" -don t remove temporary files when finished -.IP -.IP "\fB--acrobat\fP" -use ACROBAT for conversion (only unix) -.IP -.IP "\fB--pdftops\fP" -use PDFTOPS for conversion -.IP -.IP "\fB--ghostscript\fP" -use GHOSTSCRIPT for conversion -.IP -.SH "VARIABLES" -.PP -When set, the environment variables GS and GS_PROG will be used to -identify GHOSTSCRIPT. If needed, the names of the other programs that -are used can be set with PDFTOPS, ACROREAD and PSTOEDIT. -.HP -.SH "SEE ALSO" -.PP -\fBtexexec\fP(1)\&. -.PP -The makempy manual, \fImmakempy\&.pdf\fP\&. -.PP -.SH "AUTHOR" -.IP -This manual page was written by Frank Küster <frank@kuesterei\&.ch>, -for the Debian GNU/Linux system\&. It may be used and modified by -others without contacting the author\&. diff --git a/Build/source/texk/tetex/texexec.man b/Build/source/texk/tetex/texexec.man deleted file mode 100644 index 2d8593b674c..00000000000 --- a/Build/source/texk/tetex/texexec.man +++ /dev/null @@ -1,574 +0,0 @@ -.de EX -.sp -.in +5 -.nf -.ft CW -.. -.de EE -.in -5 -.ft R -.sp -.fi -.. -.TH "texexec" "1" "October 2000" "ConTeXt" "ConTeXt" -.PP -.SH "NAME" -texexec \- ConTeXt and PDF auxiliary program and batch processor -.PP -.SH "SYNOPSIS" -\fBtexexec\fP [ \fIOPTION\fP \&.\&.\&. ] \fIFILE\fP [ \&.\&.\&. ] -.PP -.SH "DESCRIPTION" -.PP -\fBtexexec\fP is a Perl script that provides several functions: -.IP o -Process a TeX file\&. This includes performing as many runs as -necessary of \fBtex\fP(1), \fBtexutil\fP(1), and -\fBmetapost\fP(1)\&. Options allow you to select the output -format, the pages to process, paper size, and so forth\&. -.IP o -Create new ConTeXt formats (with \fB--format\fP)\&. -.IP o -Post-process existing PDF files, including merging multiple -files, and extracting and rearranging pages within a file -(similar to the functions provided by \fBpsnup\fP(1) and -\fBpdfmerge\fP(1))\&. -.IP o -Extract or strip documentation from com{ConTeXt} source files -(using \fBtexutil\fP(1))\&. -.IP o -Run METAPOST (\fBmpost\fP(1)) to generate figures from METAPOST -source\&. -.IP o -Produce ``proof sheets\'\' of figures used in a \fBConTeXt\fP source -file\&. -.IP -.PP -.SH "OPTIONS" -.PP -All switches are specified in full, but can be abbreviated to the -shortest unique string\&. Thus, \fB--ver\fP works the same as -\fB--verbose\fP\&. -.PP -.SH "General Options" -.PP -.IP "\fB--alone\fP" -Avoid calling other programs when possible\&. For -example, \fB--alone\fP will prevent \fBtexexec\fP from -using \fBfmtutil\fP(1) to generate formats (which can -be handy when tracing installation problems)\&. -.IP "\fB--environment=\fP\fIENVIRONMENT\fP" -Specify a ConTeXt -\fIENVIRONMENT\fP to use when processing the file\&. -This option can be useful when converting from -non-ConTeXt file formats where no environment or layout -settings are present in the file\&. -.IP "\fB--help\fP [ \fISWITCH\fP ]" -Produce a summary of switches -and arguments\&. Many switches have additional -information that can be seen by typing ``\f(CWtexexec ---help optvar(SWITCH)\fP\'\'\&. -.IP "\fB--interface=\fP\fILANGUAGE\fP" -Specify the language -\fBConTeXt\fP should use to communicate with you\&. -Options are -.IP -.RS -.IP "\fBen\fP" -US English -.IP "\fBnl\fP" -Dutch -.IP "\fBde\fP" -German -.IP "\fBuk\fP" -British English -.IP "\fBcz\fP" -Czech -.IP "\fBit\fP" -Italian -.RE -.IP "\fB--once\fP" -Process a file once and only once\&. (By default, -\fBtexexec\fP processes the file as many times as -necessary to sort out all references, typeset -\fBMETAPOST\fP code, and so forth\&.) -.IP "\fB--output=\fP\fIDRIVER\fP" -Specify the output \fIDRIVER\fP -for use with \f(CW\especial\fP primitives\&. Defaults to the setting in -the local \fIcont-sys\&.tex\fP file, but can be set to one of -.IP -.RS -.IP "\fBpdftex\fP" -Native \fBpdftex\fP(1) code -.IP "\fBdvips\fP" -For \fBdvips\fP(1) (the default) -.IP "\fBdvipsone\fP" -For \fBdvipsone\fP -.IP "\fBdviwindo\fP" -For \fBdviwindo\fP, the oldest -\fBConTeXt\fP drivers -.IP "\fBdviview\fP" -For \fBdviview\fP (experimental) -.IP -.RE -.IP -There may be other supported drivers -- check the most -recent \fBConTeXt\fP documentation\&. -.IP "\fB--pages=\fP\fIPAGENUMBERLIST\fP" -Specify the pages or page -range to appear in the output file\&. -\fIPAGENUMBERLIST\fP may be the keyword \fBodd\fP -or \fBeven\fP; one or more pages separated by commas -(\f(CWx,y\fP); or a page range in the form \f(CW:z\fP\&. -.IP "\fB--passon=\fP\fISTRING\fP" -Pass additional command-line -switches and arguments to the \fBtex\fP(1) process -run by \fBtexexec\fP\&. -.IP -For example, the \fBMikTeX\fP TeX system (for -DOS/Windows) can embed information in the DVI file that -will allow you to find the line in a source code file -corresponding to the line in the typeset output\&. It -uses a switch called ``--src\'\' to activate this -functionality, and can be used from \fBtexexec\fP as -.IP -.EX -\f(CWtexexec --passon="--src" somefile\fP -.EE -.IP -The double quotes (\f(CW"\fP) are required to prevent -\fBtexexec\fP from using the switch itself\&. -.IP "\fB--program\fP" -The name of the TeX program to use -(\fBtex\fP(1), by default)\&. -.IP "\fB--result=\fP\fIFILENAME\fP" -Allows you to change the -basename of the output file\&. See -\fB--mode\fP for an example\&. -.IP "\fB--runs=\fP\fINUMBER\fP" -Specify the number of runs to -perform on a file\&. Overrides -\fBtexexec\fP\'s calculations\&. -.IP "\fB--silent\fP" -Suppress diagnostic and progress messages\&. -.IP "\fB--suffix=\fP\fISUFFIX\fP" -Specify the suffix of the output file\&. -.IP "\fB--tex=\fP\fIPROGRAMNAME\fP" -Allows you specify the program -to use instead of \fBtex\fP(1)\&. Useful for trying -different versions of \fBtex\fP(1) installed on the -same machine\&. -.IP "\fB--texutil\fP" -Force a run of \fBtexutil\fP(1)\&. -.IP "\fB--verbose\fP" -Output diagnostic information, including the -contents of \fItexexec\&.ini\fP\&. -.IP -.PP -.SH "Processing \fBConTeXt\fP Source Files" -.PP -Including specifying paper sizes, formats, and so forth\&. -.PP -.IP "\fB--arrange\fP" -Don\'t perform page rearrangements (e\&.g\&., for -producing a booklet) until the last run\&. -.IP "\fB--batch\fP" -Process the file in batch mode -- continue to -typeset the document after finding errors\&. More -imformation about batch mode can be found in Donald -E\&. Knuth\'s \fITeXbook\fP\&. -.IP "\fB--bodyfont\fP" -The name of a font to preload for use in -setting the body of the text\&. -.IP "\fB--centerpage\fP" -Center the document image on the page\&. -.IP "\fB--color\fP" -Turn on color mode\&. Color mode can also be set by -commands embedded in the document\&. These commands -override the \fB--color\fP option\&. -.IP "\fB--convert=\fP\fIFORMAT\fP" -Convert the input file to -ConTeXt format from \fIFORMAT\fP before -processing\&. In most cases, this conversion will result -in a TeX file\&. Currently supported input -\fIFORMAT\fPs are \fBxml\fP and -\fBsgml\fP\&. -.IP "\fB--dvi\fP" -Shortcut for \fB--output=dvi\fP\&. -.IP "\fB--fast\fP" -Typeset the document(s) as fast as possible without -causing problems\&. -.IP "\fB--final\fP" -Perform a final run without skipping anything\&. -This option is typically used with \fB--fast\fP\&. -.IP "\fB--language=\fP\fILANGUAGE\fP" -Set the language for -hyphenation\&. Can be specified in your source file\&. -Options are the same as those for \fB--interface\fP\&. -.IP "\fB--mode=\fP\fIMODELIST\fP" -Allows you to change the mode -(page size and resolution) of the output file\&. -.IP -.EX -\f(CWtexexec --pdf --mode=A4 --result=pdftex-a pdftex-t\fP -\f(CWtexexec --pdf --mode=letter --result=pdftex-l pdftex-t\fP -\f(CWtexexec --pdf --mode=screen --result=pdftex-s pdftex-t\fP -.EE -.IP -Here the mode switch tells \fBConTeXt\fP to obey -the mode directives in the layout specifications\&. The -\fB--result\fP flag allows you to -rename the output file\&. -.IP "\fB--noarrange\fP" -Ignore arrangement commands in the source -file\&. -.IP "\fB--paper=\fP\fIKEY\fP" -For typesetting multiple pages on a -single piece of paper\&. \fIKEY\fP can be \fBa4a3\fP -(for printing A4 pages on A3 paper) or \fBa5a4\fP -(for printing A5 pages on A4 paper)\&. The actual layout -of the pages is specified with the -\fB--print\fP switch\&. -.IP "\fB--pdf\fP" -Shorthand for \fB--output=pdftex\fP\&. -.IP "\fB--print=\fP\fIKEY\fP" -Specify the layout of the final -output\&. \fIKEY\fP can be \fBup\fP, resulting in 2 -pages per sheet, double sided, or \fBdown\fP, resulting -in 2 rotated pages per sheet, double sided\&. Use the ---paper switch to specify the original page -and sheet size\&. -.IP -.PP -.SH "Creating \fBConTeXt\fP Format Files" -.PP -.IP "\fB--format=\fP\fIFORMATFILE\fP" -Specify a \fIFORMATFILE\fP -to use when typesetting\&. \fBtexexec\fP will prepend the -string \f(CWcont- \fP to the name you give, so you can -type \f(CWplain\fP instead of \f(CWcont-plain\fP, as in -.IP -.EX -\f(CWtexexec --format=plain --program=pdftex somefile\fP -.EE -.IP "\fB--make\fP" -Generate a \fBConTeXt\fP format file\&. -.PP -.SH "Postprocess PDF Files" -.PP -.IP "\fB--combination=\fP\fIROWS\fP\fB*\fP\fICOLS\fP" -Specify -the number of pages to show on a single page\&. Use with -\fB--pdfcombine\fP\&. -.IP "\fB--pdfarrange\fP" -For rearranging pages in PDF files\&. -.IP -.EX -\f(CWtexexec --pdfarrange --paper=a5a4 --print=up foo\&.pdf\fP -.EE -.IP -This command creates an A5 booklet from a PDF file -\fIfoo\&.pdf\fP\&. \fB--pdfarrange\fP is used in -conjunction with the following switches: -.IP "\fB--paperoffset\fP" -Adjust the space between the -edge of the pages and the beginning of the text block\&. -.IP "\fB--backspace\fP" -Adjust the inside (``gutter\'\') -margins\&. -.IP "\fB--topspace\fP" -Adjust the top and bottom -margin\&. -.IP "\fB--markings\fP" -Add crop marks\&. -.IP "\fB--addempty=\fP\fIPAGES\fP" -Add empty pages -after the pages specified in \fIPAGES\fP\&. (Useful -for, among other things, adding blank pages after a -table of contents\&.) -.IP "\fB--textwidth=\fP\fIWIDTH\fP" -Set the width of -the original text\&. Specifying this parameter with a -single-sided original will allow \fBConTeXt\fP to adjust -the page layout for double-sided output, producing much -more attractive results\&. -.IP -With the \fB--pdfarrange\fP flag, specifying more -than one file will result in all of the files being -combined in the final result, allowing you to add title -pages, decorated part separators, and so forth\&. -.IP -You can also do more complex manipulations, such as -adding additional text to the page by setting up a -small file with layout definitions and a simple figure -insertion loop\&. -.IP "\fB--pdfcombine\fP" -Combine multiple pages\&. Requires you to -specify the -\fB--combination\fP -switch\&. -.IP "\fB--pdfselect\fP" -Extract pages from a file\&. Use in combination with -the \fB--selection\fP switch, as -in -.IP -.RS -\f(CWtexexec --pdfselect --paper=S6 ---selection=1,9,14 file-1\fP -.RE -.IP -which extracts pages 1, 9, and 14 from -\fIfile-1\&.pdf\fP, and places them in -\fItexexec\&.pdf\fP (the default output filename if -an output file isn\'t specified)\&. -.IP -See \fB--pdfarrange\fP for other -options\&. -.IP "\fB--selection=\fP\fIPAGES\fP" -Specify pages to be affected by -another option\&. See \fB--pdfarrange\fP and -\fB--pdfselect\fP for examples\&. -.PP -.SH "Extract or Strip Out Documentation" -.PP -.IP "\fB--listing\fP" -Produce a typeset version of the source code in -\fIFILE\fP\&. You can specify the form of the output -file, as in -.RS -\f(CWtexexec --listing --pdf readme\&.now\fP -.RE -.IP -which will produce a PDF file called -\fItexexec\&.pdf\fP\&. Without the -\fB--pdf\fP flag, \fBtexexec\fP will -produce a DVI file\&. -.IP -See also \fB--backspace\fP and -\fB--topspace\fP\&. -.IP "\fB--module\fP" -Create documentation for \fBConTeXt\fP, -\fBMetaPost\fP (see \fBmpost\fP(1)), and Perl modules\&. -Converts the documentation to \fBConTeXt\fP format and -then typesets that documentation\&. See -\fBtexutil\fP(1) for more information about the -format of the documentation strings\&. -.PP -.SH "Process METAPOST Figures" -.PP -.IP "\fB--mpformat\fP" -The name of a \fBMetaPost\fP format file\&. -.IP "\fB--mptex\fP" -Strips out and typesets TeX code embedded in a -\fBMetaPost\fP file\&. -.IP "\fB--nomp\fP" -Do not run \fBMetaPost\fP, even if needed\&. -.IP "\fB--nomprun\fP" -Do not run \fBmpost\fP(1) on embedded -\fBMetaPost\fP code\&. -.PP -.SH "Producing Proof Sheets of Figures" -.PP -.IP "\fB--figures=\fP\fIALTERNATIVE\fP" -Specify one of three -options to produce a document containing the images -used in the source file: -.IP -.RS -.IP "\fBa\fP" -A proof sheet with additional -information provided for each figure -.IP "\fBb\fP" -A proof sheet with the graphics only -.IP "\fBc\fP" -One figure per page, with the page -clipped to the bounding box of the -figure -.IP -See also \fB--paperoffset\fP, -which allows you to specify an offset to be added to -the page, as in -.IP -.EX -\f(CWtexexec --figures=c --paperoffset=\&.5cm *\&.pdf -*\&.png *\&.jpg\fP -.EE -.IP -.RE -.IP -\fBtexexec\fP uses \fBtexutil\fP(1) to obtain the list -of figures to process\&. -.PP -.SH "USAGE" -.PP -.IP o -Each \fBConTeXt\fP user interface (language) has its own format\&. The -following command generates two formats, one using the English -interface for typesetting in English, and one for Dutch: -.IP -.EX -\f(CWtexexec --make en nl\fP -.EE -.IP -By default, the language used for typesetting matches the -user-interface language (set with -\fB--interface\fP\&. It\'s possible to use one -language for typesetting and another for messages by changing the -relevant settings in \fIcont-usr\&.tex\fP, but these languages can -also be changed on the command line with a command such as -.IP -.RS -\f(CWtexexec --make --language=pl,cz,sk --bodyfont=plr en\fP -.RE -.IP -That command generates a \fBConTeXt\fP format file with an English user -interface, and the main language set to Polish (\fBpl\fP)\&. The -default body font is the Polish version of Computer Modern Roman -(\fBplr\fP)\&. Czech and Slovak hyphenation patterns are also loaded -so that Czech and Slovak text included in a source file will be -typeset properly (\fBcz\fP and \fBsk\fP)\&. -.IP o -When the appropriate formats are present, a file can be typeset -by typing -.IP -.EX -\f(CWtexexec test\fP -.EE -.IP -\fBtexexec\fP tries to determine what interface it should use to -typeset \fItest\&.tex\fP by looking for a line such as -.IP -.EX -\f(CW% interface=en tex=pdfetex output=pdftex\fP -.EE -.IP -at the top of the file (i\&.e\&., on the very first line)\&. This line is -equivalent to \fBTeX\fP\'s format line, ``&\fIFORMAT\fP\'\')\&. -.IP -By default, \fBtexexec\fP will produce a DVI file\&. The -\fB--pdf\fP flag tells \fBtexexec\fP to produce a PDF -file, instead (by running \fBpdftex\fP(1))\&. You can also be more -specific about what drivers \fBtexexec\fP should use, by specifying a -command line such as -.IP -.EX -\f(CWtexexec --output=dvips,acrobat test\fP -.EE -.IP -which specifies the use of the \fBdvips\fP driver (which is the -default), combined with the use of Acrobat-specific PDF instructions\&. -.IP -After an error-free run, \fBtexexec\fP will run \fBtexutil\fP(1) to -determine whether additional runs of \fBtex\fP(1) (or -\fBpdftex\fP(1)) or any utility programs (e\&.g\&., \fBbibtex\fP(1), -\fBmakeindex\fP(1)) are necessary\&. You can suppress these -additional runs by specifying the \fB--once\fP or -\fB--runs\fP flags: -.IP -.EX -\f(CWtexexec --once test\fP -\f(CWtexexec --runs=2 test\fP -.EE -.IP -.SH "INITIALIZATION" -.IP -When starting, \fBtexexec\fP first looks for the file -\fItexexec\&.ini\fP, which specifies the location of various -programs and configuration files, and specifies the programs to use\&. -The \fB--verbose\fP flag causes \fBtexexec\fP to print -the information in \fItexexec\&.ini\fP to the terminal and the log -file\&. -.IP -\fBtexexec\fP requires Perl\&. On Unix and Unix-like systems, no special -steps have to be taken to get \fBtexexec\fP to work beyond installing -Perl and having the \fBperl\fP(1) binary in your path\&. On Windows -systems, however, you may need to run Perl by typing commands such as -``\f(CWperl texexec\&.pl optvar(ARGS)\fP\'\'\&. -.IP -The \fBfpTeX\fP distribution comes with a program called -\fBrunperl\&.exe\fP that can be copied and renamed to \fBtexexec\&.exe\fP\&. -You will also have to rename a copy to \fBtexutil\&.exe\fP (see -\fBtexutil\fP(1))\&. The \fBteTeX\fP and \fBfpTeX\fP distributions, at -least, should perform the necessary steps as part of their -installation sequence -- if you have problems, however, you may need -to follow the advice given here\&. -.IP -The file \fItexexec\&.rme\fP contains default configuration -information\&. If no file \fItexexec\&.ini\fP exists (in -\fITEXMF/context/config/\fP, you should copy \fItexexec\&.rme\fP -to that directory and rename it to \fItexexec\&.ini\fP\&. Make any -necessary changes to this file to reflect the layout of programs and -directories on your system\&. -.SH "ENCODINGS" -.IP -Some languages require specific character encodings to represent their -alphabets (beyond the basic ASCII encoding)\&. Although you can use TeX -commands to represent these characters, such as ``\f(CW\e\&.z\fP\'\', it\'s -easier to use a text editor that includes direct support for these -characters and let \fBConTeXt\fP translate them to the necessary TeX -commands\&. For some languages, this approach can also improve the -performance of TeX\'s hyphenation algorithms\&. -.IP -\fBConTeXt\fP supports several of the most commonly used encodings\&. -Check the files beginning with \fIenco-\fP, \fIlang-\fP, and -\fIfont-\fP in the \fBConTeXt\fP distribution for more information\&. -.IP -\fBweb2c\fP distributions (such as \fBteTeX\fP) support a mechanism to -map document encodings to \fBConTeXt\fP\'s internal encoding, font -encodings, and hyphenation patterns\&. \fBtexexec\fP provides a document -option and a command-line flag to pass the necessary information to -\fBtex\fP(1) or \fBpdftex\fP(1)\&. You can add lines such as -.IP -.EX -\f(CW%& --translate-file=cp1250pl\fP -.EE -or -.IP -.EX -\f(CW% --translate=cp1250pl\fP -.EE -.IP -to the beginning of your document, or specify the \fB--translate\fP -flag on the command line, as -.IP -.EX -\f(CWtexexec --translate=il2pl somefile\fP -.EE -.IP -Note that using language-specific encodings will make your file less -portable than using ASCII\&. It may not be possible for other people to -typeset your documents on their systems\&. -.SH "FILES" -.IP -.IP "\fITEXMF/context/config/texexec\&.ini\fP" -TeXExec configuration file -.IP "\fITEXMF/context/config/texexec\&.rme\fP" -TeXExec configuration file defaults -.IP -.SH "SEE ALSO" -.IP -\fBbibtex\fP(1), \fBdvips\fP(1), \fBfmtutil\fP(1), -\fBmakeindex\fP(1), \fBmetapost\fP(1), \fBmpost\fP(1), -\fBpdfetex\fP(1), \fBpdfmerge\fP(1), \fBpdftex\fP(1), -\fBperl\fP(1), \fBpsnup\fP(1), \fBtex\fP(1), \fBtexshow\fP(1), -\fBtexutil\fP(1)\&. -.IP -The TeXExec manual, \fImtexexec\&.pdf\fP\&. -.IP -The TeXExec configuration README files: -.IP o -\fITEXMF/context/config/texexec\&.rme\fP -.IP o -\fITEXMF/context/perltk/texexec\&.rme\fP -.IP -Donald E\&. Knuth\'s \fIThe TeXbook\fP\&. -.SH "AUTHOR" -.IP -This manpage was written by Tobias Burnus -<burnus@gmx\&.de> and C\&.M\&. Connelly -<c@eskimo\&.com>\&. It is based on -the \fBTeXExec\fP manual written by Hans Hagen -<pragma@wxs\&.nl>\&. -.IP -The PDF manual and \fBtexexec\fP itself can be obtained from -<http://www\&.pragma-ade\&.com/pragma-ade/texexec\&.htm> diff --git a/Build/source/texk/tetex/texutil.man b/Build/source/texk/tetex/texutil.man deleted file mode 100644 index 5a6ea8d365e..00000000000 --- a/Build/source/texk/tetex/texutil.man +++ /dev/null @@ -1,266 +0,0 @@ -.TH TEXUTIL 1 UMFT -.de EX -.sp -.in +5 -.nf -.ft CW -.. -.de EE -.in -5 -.ft R -.sp -.fi -.. -.TH "texutil" "1" "October 2000" "ConTeXt" "CONTEXT" -.PP -.SH "NAME" -texutil \- ConTeXt auxiliary program -.PP -.SH "SYNOPSIS" -\fBtexutil\fP [ \fIOPTION\fP\&.\&.\&. ] \fIFILENAME\fP[\&.\&.\&.] -.PP -.SH "DESCRIPTION" -.PP -When processing a source file, \fBConTeXt\fP (via \fBtexexec\fP(1)) -saves information (including table of contents, tables of figures and -tables, index entries, cross-references) in a ``utility file\'\' called -\fIFILENAME\fP\fI\&.tui\fP\&. After each successful run, this -utility file is postprocessed by \fBtexutil\fP to organize the -information for the next run\&. -.PP -\fBtexutil\fP performs a number of useful functions: -.PP -.IP o -Postprocessing references, including sorting index and list -entries (with \fB--references\fP) -.IP o -Extracting documentation and other types of information from -\fBConTeXt\fP source files (with -\fB--documents\fP) -.IP o -Logfile analysis (with \fB--logfile\fP) -.IP o -Collecting information about graphic files to help with -typesetting (with \fB--figures\fP) -.IP o -Converting EPS files to a PDF format suitable for inclusion in -PDF files generated with \fBpdftex\fP(1) (with ---\fB--epspage\fP and -\fB--epstopdf\fP) -.PP -.SH "OPTIONS" -.PP -All switches are specified here in full, but can be abbreviated to the -shortest unique string\&. Thus, \fB--ver\fP works the same as -\fB--verbose\fP provided that there is no other flag beginning with -``\f(CWver\fP\'\'\&. -.PP -.SH "General Options" -.PP -.IP "\fB--help\fP" -Print a usage summary to stdout\&. -.IP "\fB--interface=\fP\fILANGUAGECODE\fP" -Specify the language for -messages\&. One of \fBen\fP (English), \fBde\fP (German), or -\fBnl\fP (Dutch)\&. The default language is English\&. -.IP "\fB--outputfile=\fP\fIFILENAME\fP" -Specify the name of the -output file\&. -.IP "\fB--purge\fP [ \fIBASENAME\fP ]" -Delete temporary files\&. -Specifying an optional \fIBASENAME\fP will only -affect the temporary files that begin with that -\fIBASENAME\fP\&. -.IP "\fB--silent\fP" -Redirects stdout to the \fIlog\fP file -(\fItexutil\&.log\fP, by default)\&. When used with -\fB--verbose\fP, a summary is printed to stdout, while -any other output is written to the \fIlog\fP file\&. -.IP -For example, -.IP -.EX -\f(CWtexutil --figures --silent --verbose somefile\&.png\fP -.EE -.IP -will output something like -.IP -.EX -\f(CWn=somefile\&.png t=png x=0bp y=0bp w=443bp h=591bp\fP -.EE -.IP -to stdout, placing other output into -\fItexutil\&.log\fP\&. This information can be piped -into another program for further processing\&. -.IP "\fB--type=\fP\fISUFFIX\fP" -Specify the \fISUFFIX\fP of the -file you want \fBtexutil\fP to process\&. -.IP "\fB--verbose\fP" -Print diagnostic messages to the screen\&. -.PP -.SH "Postprocessing References" -.PP -The \fB--references\fP flag instructs \fBtexutil\fP to process -information about cross-references, index entries, and other data -requiring more than one pass to process in the \fBConTeXt\fP utility -file\&. -.PP -Index and sorted list entries are sorted before being written out; -redundant index entries are removed\&. -.PP -\fBtexutil\fP is called automatically by \fBtexexec\fP(1) during its -processing runs unless you specify otherwise\&. \fBtexutil\fP can also -be run by hand, using the form -.PP -.EX -\f(CWtexutil --references\fP \fIFILENAME\fP -.EE -.PP -This command would cause \fBtexutil\fP to load the utility file -\fIFILENAME\fP\fI\&.tui\fP, sort and convert the contents of that -file, and write the results to \fIFILENAME\fP\fI\&.tuo\fP\&. -.PP -Options specific to this mode are: -.IP "\fB--ij\fP" -Sort ``\f(CWIJ\fP\'\' as ``\f(CWY\fP\'\'\&. Often used when -processing files written in Dutch\&. -.IP "\fB--high\fP" -Convert ``high\'\' ASCII values into equivalent TeX -commands\&. This switch is provided for backward -compatibility\&. -.IP "\fB--quotes\fP" -Take \fBtex\fP(1) accent commands into -consideration when sorting\&. (Otherwise, quotes are -considered to be boundary characters for strings\&.) -.IP "\fB--tcxpath=\fP\fIPATH\fP" -Specify path to \fItcx\fP -filter files for translating -between encodings\&. -.PP -.SH "Extracting Information from ConTeXt Source Files" -.PP -\fBConTeXt\fP source files often contain documentation (see -USAGE for more information about the format) or other -information that can be extracted by \fBtexutil\fP when called with the -\fB--documents\fP flag: -.PP -.EX -\f(CWtexutil --documents\fP \fIFILENAME\fP -.EE -.PP -This command produces a file called \fIFILENAME\fP\fI\&.ted\fP -from a ConTeXt file called \fIFILENAME\fP\fI\&.tex\fP\&. -.PP -The \fB--sources\fP flag does the opposite: Documentation lines are -stripped out of the output, which is written to a file called -\fIFILENAME\fP\fI\&.tes\fP\&. -.PP -Historically, \fBConTeXt\fP source files included other forms of -information -- such as syntax definitions, macro definitions, and -editor templates -- that can be extracted with the following flags: -.PP -.IP "\fB--infos\fP" -Extract TeXEdit macro information -(\fItex\fP->\fItud\fP -- see -USAGE) -.IP "\fB--setups\fP" -Extract \fBConTeXt\fP syntax definitions -(\fItex\fP->\fItexutil\&.tus\fP) -.IP "\fB--templates\fP" -Extract TeXEdit editor templates -(\fItex\fP->\fItud\fP) -.PP -.SH "Analyzing Log Files" -.PP -Calling \fBtexutil\fP with the \fB--logfile\fP option allows you to -extract information about problems with your \fBConTeXt\fP source file -from the log file produced during a \fBtexexec\fP(1) run\&. -.PP -You can specify what information \fBtexutil\fP should report with the -following options: -.IP "\fB--box\fP" -Extract information about overfull boxes\&. By -default, this flag will cause \fBtexedit\fP to report both -horizontal and vertical overfull boxes\&. If you\'re only -interested in one kind, you can specify \fB--hbox\fP or -\fB--vbox\fP instead\&. -.IP "\fB--criterium=\fP\fISIZE\fP" -Exclude reports about boxes that -are less than \fISIZE\fP points too large\&. -.IP "\fB--unknown\fP" -Extract messages about missing references or -figures\&. -.PP -.SH "Gathering Information about Figures" -.PP -The \fB--figures\fP flag tells \fBtexutil\fP to generate information -about one or more (non-EPS) graphics files for use in typesetting\&. -Called as, for example, -.PP -.EX -\f(CWtexutil --figures *\&.png *\&.tif\fP -.EE -.PP -\fBtexutil\fP 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 -\fItexutil\&.tuf\fP, which is consulted by \fBConTeXt\fP when -typesetting a page with a non-EPS image file -- see the example given -for the \fB--silent\fP flag for an alternative\&. -.PP -This flag is especially useful when you plan to typeset a file of -previews of graphic files -- see the discussion of the -\fB--figures\fP flag in the \fBtexexec\fP(1) manpage\&. -.PP -.SH "Converting EPS Files for PDF Inclusion" -.PP -\fBtexutil\fP can also convert EPS files to PDF format for inclusion in -PDF files generated with \fBpdftex\fP(1) or \fBpdfetex\fP(1)\&. -.PP -.IP "\fB--epspage\fP" -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\&. -.IP "\fB--epstopdf\fP" -Calls \fBgs\fP(1) to convert the specified -EPS graphic files into PDF format\&. -.PP -.SH "USAGE" -.PP -.SH "Embedded Documentation Format" -.PP -Documentation lines included in \fBConTeXt\fP source files can be -specified by beginning lines with the following strings: -.IP "\f(CW%C\fP" -Copyright information -.IP "\f(CW%D\fP" -Documentation lines -.IP "\f(CW%I\fP" -TeXEdit information lines (mostly in Dutch) -.IP "\f(CW%M\fP" -Macro code needed to processs the documentation -.IP "\f(CW%S\fP" -``Suppressed\'\' lines -.PP -The same forms can be used for Perl scripts, except that the -``\f(CW%\fP\'\' characters are replaced by ``\f(CW#\fP\'\' characters\&. See -the source for \fBtexutil\fP for an example\&. -.PP -.SH "SEE ALSO" -.PP -\fBgs\fP(1), \fBpdfetex\fP(1), \fBpdftex\fP(1), -\fBtexexec\fP(1), \fBtexshow\fP(1)\&. -.PP -Web page: <http://www\&.pragma-ade\&.com/> -.PP -.SH "AUTHOR" -.PP -This manpage was written by C\&.M\&. Connelly -<c@eskimo\&.com> and Tobias Burnus -<burnus@gmx\&.de>\&. It is based on -the \fBtexutil\fP manual written by Hans Hagen -<pragma@wxs\&.nl>\&. -.PP -The PDF manual and \fBtexutil\fP itself can be obtained at -<http://www\&.pragma-ade\&.com/pragma-ade/texutil\&.htm>\&. |