204 lines
4.5 KiB
Groff
204 lines
4.5 KiB
Groff
.\" This manpage is licensed under the GNU Public License
|
|
.TH MUSIXTEX 1 2020-05-21 "musixtex version 0.23" ""
|
|
|
|
.SH NAME
|
|
musixtex \- processes MusiXTeX files, using pre-processors prepmx, xml2pmx, pmxab and autosp
|
|
as necessary, and then deletes intermediate and log files (unless
|
|
.B -i
|
|
is used)
|
|
.SH SYNOPSIS
|
|
[ texlua ]
|
|
.B musixtex[.lua]
|
|
{
|
|
.I option
|
|
|
|
|
.I jobname
|
|
[ .xml | .mtx | .pmx | .aspc | .tex | .ltx ] } ...
|
|
.SH DESCRIPTION
|
|
.TP
|
|
If a jobname argument has a .tex extension, the default effect is to process the file using
|
|
.TP 12
|
|
.BR etex (1)
|
|
(first pass)
|
|
.TP
|
|
.BR musixflx (1)
|
|
(second pass)
|
|
.TP
|
|
.BR etex (1)
|
|
(third pass)
|
|
.TP
|
|
.BR dvips (1)
|
|
(dvi to Postscript)
|
|
.TP
|
|
.BR ps2pdf (1)
|
|
(Postscript to Portable Document Format)
|
|
.TP
|
|
normally followed by removal of intermediate and log files. A log musixtex.log is generated, even if other log files are removed.
|
|
.P
|
|
If a jobname argument has a .pmx extension, the file is first preprocessed using
|
|
.BR pmxab (1)
|
|
and the resulting .tex file is processed as above.
|
|
.P
|
|
If a jobname argument has a .xml extension, the file is first preprocessed using
|
|
.BR xml2pmx (1)
|
|
and the resulting .pmx file is processed as above.
|
|
.P
|
|
If a jobname argument has a .mtx extension, the file is first preprocessed using
|
|
.BR prepmx (1)
|
|
and the resulting .pmx file is processed as above.
|
|
.P
|
|
If a jobname argument has a .ltx extension, the file is processed using
|
|
.BR latex (1)
|
|
(or
|
|
.BR pdflatex (1))
|
|
in place of
|
|
.BR etex .
|
|
.P
|
|
If a jobname argument has a .aspc extension, the file is first preprocessed using
|
|
.BR autosp (1)
|
|
and the resulting .tex or .ltx file is processed as above.
|
|
.P
|
|
If a jobname argument has none of these extensions, the script will look for a file
|
|
.IR jobname .xml
|
|
or
|
|
.IR jobname .mtx
|
|
or
|
|
.IR jobname .pmx
|
|
or
|
|
.IR jobname .aspc
|
|
or
|
|
.IR jobname .tex
|
|
or
|
|
.IR jobname .ltx ,
|
|
in that order, and process it as above.
|
|
.SH OPTIONS
|
|
.TP 10
|
|
.B -v, -version, --version
|
|
output program name and version number, and quit
|
|
.TP
|
|
.B -h, -help, --help
|
|
output usage summary and quit
|
|
.TP
|
|
.B -l
|
|
assume LaTeX source;
|
|
implied if the file has .ltx extension
|
|
.TP
|
|
.B -p
|
|
change the TeX processor to
|
|
.BR pdfetex (1)
|
|
or
|
|
.BR pdflatex (1)
|
|
(and doesn't run a dvi processor)
|
|
.TP
|
|
.B -c
|
|
preprocess pmx file using
|
|
.BR pmxchords (1)
|
|
.TP
|
|
.B -d
|
|
don't generate a .ps file and change the dvi processor to
|
|
.BR dvipdfm (1)
|
|
.TP
|
|
.B -D dvix
|
|
use
|
|
.B dvix
|
|
as the dvi processor; e.g., -D "dvipdfm -m 0.9".
|
|
Use -d
|
|
.I before
|
|
-D to suppress .ps generation.
|
|
.TP
|
|
.B -P ps2pdf
|
|
use
|
|
.B ps2pdf
|
|
as the Postscript processor; e.g., -P "ps2pdf -sPAPERSIZE=a4"
|
|
.TP
|
|
.B -F fmt
|
|
use
|
|
.B fmt
|
|
as the TeX processor; e.g., -F "luatex --output-format=dvi"
|
|
.TP
|
|
.B -m
|
|
stop processing at the pmx file
|
|
.TP
|
|
.B -M mtxx
|
|
use
|
|
.B mtxx
|
|
as the mtx preprocessor; e.g., -M "prepmx -i".
|
|
.TP
|
|
.B -X pmxx
|
|
use
|
|
.B pmxx
|
|
as the pmx preprocessor; e.g., -X "./pmxab",
|
|
.TP
|
|
.B -A aspcx
|
|
use
|
|
.B aspcx
|
|
as the aspc preprocessor; e.g., -A "autosp -l".
|
|
.TP
|
|
.B -L xmlx
|
|
use
|
|
.B xmlx
|
|
as the xml preprocessor; e.g., -L "./XML2PMX".
|
|
.TP
|
|
.B -t
|
|
stop processing at the tex/mid files
|
|
.TP
|
|
.B -s
|
|
stop processing at the dvi file
|
|
.TP
|
|
.B -g
|
|
stop processing at the ps file
|
|
.TP
|
|
.B -i
|
|
retain intermediate and log files
|
|
.TP
|
|
.B -1
|
|
one-pass [pdf][la]tex processing; i.e., without calling
|
|
.B musixflx
|
|
.TP
|
|
.B -x
|
|
call
|
|
.BR makeindex (1)
|
|
to update index database
|
|
.TP
|
|
.B -f
|
|
restore default processing
|
|
.TP
|
|
.B -q
|
|
quiet mode (only musixtex's own messages); other messages are diverted to a temporary file.
|
|
If an error occurs at the TeX stage, processing halts immediately and the tail of the log file is sent to stderr.
|
|
Version information is copied from the temporary file to the log file.
|
|
|
|
.TP 0
|
|
Options affect processing of all succeeding MusiXTeX files unless changed by another option. Option flags cannot be combined; e.g., use \fB -l -x \fP rather than \fB -lx\fP.
|
|
|
|
Note that four TeX engines are available via the -l and -p options:
|
|
.TP
|
|
etex default
|
|
latex -l
|
|
pdfetex -p
|
|
pdflatex -l -p
|
|
.TP 0
|
|
If the -F option is used, options -l and -p need to be set if the engine name does not contain "latex" and "pdf" respectively. For example, the above four engines can be replaced by:
|
|
-F "luatex --output-format=dvi"
|
|
-F "lualatex --output-format=dvi"
|
|
-F "luatex" -p
|
|
-F "lualatex" -p
|
|
|
|
.SH SEE ALSO
|
|
.BR autosp (1),
|
|
.BR etex (1),
|
|
.BR latex (1),
|
|
.BR pdfetex (1),
|
|
.BR pdflatex (1),
|
|
.BR makeindex (1),
|
|
.BR musixflx (1),
|
|
.BR dvipdfm (1),
|
|
.BR dvips (1),
|
|
.BR pmxab (1),
|
|
.BR pmxchords (1),
|
|
.BR prepmx (1),
|
|
.BR ps2pdf (1),
|
|
.BR xml2pmx (1)
|
|
and musixdoc.pdf.
|
|
.SH AUTHOR
|
|
This manual page was written by Bob Tennent <rdt@cs.queensu.ca>.
|