summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/texmfstart.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-04-08 00:43:40 +0000
committerKarl Berry <karl@freefriends.org>2013-04-08 00:43:40 +0000
commit824f7b0903de8ad7f6ee3d7656005e4c59155e06 (patch)
treeabfc8673ef9916f3ab7074e811207384c301492b /Master/texmf-dist/doc/man/man1/texmfstart.1
parent689aefb0727676ed3cddf331337b4be226495e72 (diff)
context import for TL13, from www.pragma-ade.com/context/beta/cont-tmf.zip
git-svn-id: svn://tug.org/texlive/trunk@29731 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/texmfstart.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/texmfstart.1443
1 files changed, 114 insertions, 329 deletions
diff --git a/Master/texmf-dist/doc/man/man1/texmfstart.1 b/Master/texmf-dist/doc/man/man1/texmfstart.1
index e99ab230bd1..212097ff153 100644
--- a/Master/texmf-dist/doc/man/man1/texmfstart.1
+++ b/Master/texmf-dist/doc/man/man1/texmfstart.1
@@ -1,362 +1,147 @@
-.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.
-
+.TH "mtxrun" "1" "01-01-2013" "version 1.31" "ConTeXt TDS Runner Tool"
+.SH NAME
+.B mtxrun
+.SH SYNOPSIS
+.B mtxrun [
+.I OPTIONS ...
+.B ] [
+.I FILENAMES
+.B ]
+.SH DESCRIPTION
+.B ConTeXt TDS Runner Tool
.SH OPTIONS
-
-.SS General:
.TP
-.B --help, --version
-print version information, usage, and examples.
+.B --script
+run an mtx script (lua prefered method) (--noquotes), no script gives list
.TP
-.B --verbose
-print status and progress information, for example what commands are
-being executed.
+.B --execute
+run a script or program (texmfstart method) (--noquotes)
.TP
-.B --clear
-don't pass info about locations to child processes.
-
-.SS Running a program:
+.B --resolve
+resolve prefixed arguments
.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 .
+.B --ctxlua
+run internally (using preloaded libs)
.TP
-.B --report
-dry run: report what command would be run, but do not run it
+.B --internal
+run script using built in libraries (same as --ctxlua)
.TP
.B --locate
-dry run: like \f(CW--report\fP but doesn't print the trailing newline.
+locate given filename in database (default) or system (--first --all --detail)
.TP
-.B --browser
-view the document in a web browser (for Windows).
+.B --autotree
+use texmf tree cf. env texmfstart_tree or texmfstarttree
.TP
-.B --file=\fIfilename\fP
-an alternative way to specify the file (the program to run or document
-to open).
+.B --tree=pathtotree
+use given texmf tree (default file: setuptex.tmf)
.TP
-.B --direct
-run a program without searching for its location (assumes that the
-program is on the PATH).
+.B --environment=name
+use given (tmf) environment file
.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).
+.B --path=runpath
+go to given path before execution
.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:
+.B --ifchanged=filename
+only execute when given file has changed (md checksum)
.TP
-.B --page=\fInumber\fP
-open the document at this page.
-
-.SS Environments and paths:
+.B --iftouched=old,new
+only execute when given file has changed (time stamp)
.TP
-.B --path=\fIstr\fP
-change to the specified path.
+.B --makestubs
+create stubs for (context related) scripts
.TP
-.B --tree=\fIstr\fP
-use the given TEXMF tree.
+.B --removestubs
+remove stubs (context related) scripts
.TP
-.B --autotree
-automatically determine the TEXMF tree to use (the default).
+.B --stubpath=binpath
+paths where stubs wil be written
.TP
-.B --environment=\fIstr\fP
-use the given environment file. Its syntax is given in the
-.I mtexmfstart.pdf
-manual.
+.B --windows
+create windows (mswin) stubs
.TP
-.B --showenv
-print the environment variables known at runtime
-
-.SS Conditional execution:
+.B --unix
+create unix (linux) stubs
.TP
-.B --iftouched=\fIfile1,file2\fP
-run only when the given files have different timestamps.
+.B --verbose
+give a bit more info
.TP
-.B --ifchanged=\fIstr\fP
-run only when the given file has changed (based on its last-computed MD5
-checksum).
-
-.SS Special features:
+.B --trackers=list
+enable given trackers
+.TP
+.B --progname=str
+format or backend
.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:
+launch editor with found file
.TP
-.I bin:filename
-expanded name based on the PATH environment variable
+.B --launch
+launch files like manuals, assumes os support (--all)
.TP
-.I kpse:filename
-expanded name based on
-.BR kpsewhich (1)
-result
+.B --timedrun
+run a script and time its run
.TP
-.I rel:filename
-expanded name relative to the current directory
+.B --autogenerate
+regenerate databases if needed (handy when used to run context in an editor)
.TP
-.I env:name
-expanded pathname based on environment variable
-.I name
+.B --usekpse
+use kpse as fallback (when no mkiv and cache installed, often slower)
.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
+.B --forcekpse
+force using kpse (handy when no mkiv and cache installed but less functionality)
.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.
+.B --prefixes
+show supported prefixes
+.TP
+.B --generate
+generate file database
+.TP
+.B --variables
+show configuration variables
+.TP
+.B --configurations
+show configuration order
+.TP
+.B --directives
+show (known) directives
+.TP
+.B --trackers
+show (known) trackers
+.TP
+.B --experiments
+show (known) experiments
+.TP
+.B --expand-braces
+expand complex variable
+.TP
+.B --expand-path
+expand variable (resolve paths)
+.TP
+.B --expand-var
+expand variable (resolve references)
+.TP
+.B --show-path
+show path expansion of ...
+.TP
+.B --var-value
+report value of variable
+.TP
+.B --find-file
+report file location
+.TP
+.B --find-path
+report path of file
+.TP
+.B --pattern=string
+filter variables
+.SH AUTHOR
+More information about ConTeXt and the tools that come with it can be found at:
-.SH "SEE ALSO"
-.PP
-.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).
-.PP
-.URL "http://www.contextgarden.net" "ConTeXt wiki" .
-.PP
-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.
+.B "maillist:"
+ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
-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).
+.B "webpage:"
+http://www.pragma-ade.nl / http://tex.aanhet.net
-.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 <sanjoy@mit.edu> based on the
-.I mtexmfstart.pdf
-manual.
+.B "wiki:"
+http://contextgarden.net