| 1 |
.\" This manpage is licensed under the GNU Public License |
| 2 |
.TH MUSIXTEX 1 2024-04-18 "musixtex version 0.23" "" |
| 3 |
|
| 4 |
.SH NAME |
| 5 |
musixtex \- processes MusiXTeX files, using pre-processors prepmx, xml2pmx, pmxab and autosp |
| 6 |
as necessary, and then deletes intermediate and log files (unless |
| 7 |
.B -i |
| 8 |
is used) |
| 9 |
.SH SYNOPSIS |
| 10 |
[ texlua ] |
| 11 |
.B musixtex[.lua] |
| 12 |
{ |
| 13 |
.I option |
| 14 |
| |
| 15 |
.I jobname |
| 16 |
[ .xml | .mtx | .pmx | .aspc | .tex | .ltx ] } ... |
| 17 |
.SH DESCRIPTION |
| 18 |
.TP |
| 19 |
If a jobname argument has a .tex extension, the default effect is to process the file using |
| 20 |
.TP 12 |
| 21 |
.BR etex (1) |
| 22 |
(first pass) |
| 23 |
.TP |
| 24 |
.BR musixflx (1) |
| 25 |
(second pass) |
| 26 |
.TP |
| 27 |
.BR etex (1) |
| 28 |
(third pass) |
| 29 |
.TP |
| 30 |
.BR dvips (1) |
| 31 |
(dvi to Postscript) |
| 32 |
.TP |
| 33 |
.BR ps2pdf (1) |
| 34 |
(Postscript to Portable Document Format) |
| 35 |
.TP |
| 36 |
normally followed by removal of intermediate and log files. A log musixtex.log is generated, even if other log files are removed. |
| 37 |
.P |
| 38 |
If a jobname argument has a .pmx extension, the file is first preprocessed using |
| 39 |
.BR pmxab (1) |
| 40 |
and the resulting .tex file is processed as above. |
| 41 |
.P |
| 42 |
If a jobname argument has a .xml extension, the file is first preprocessed using |
| 43 |
.BR xml2pmx (1) |
| 44 |
and the resulting .pmx file is processed as above. |
| 45 |
.P |
| 46 |
If a jobname argument has a .mtx extension, the file is first preprocessed using |
| 47 |
.BR prepmx (1) |
| 48 |
and the resulting .pmx file is processed as above. |
| 49 |
.P |
| 50 |
If a jobname argument has a .ltx extension, the file is processed using |
| 51 |
.BR latex (1) |
| 52 |
(or |
| 53 |
.BR pdflatex (1)) |
| 54 |
in place of |
| 55 |
.BR etex . |
| 56 |
.P |
| 57 |
If a jobname argument has a .aspc extension, the file is first preprocessed using |
| 58 |
.BR autosp (1) |
| 59 |
and the resulting .tex or .ltx file is processed as above. |
| 60 |
.P |
| 61 |
If a jobname argument has none of these extensions, the script will look for a file |
| 62 |
.IR jobname .xml |
| 63 |
or |
| 64 |
.IR jobname .mtx |
| 65 |
or |
| 66 |
.IR jobname .pmx |
| 67 |
or |
| 68 |
.IR jobname .aspc |
| 69 |
or |
| 70 |
.IR jobname .tex |
| 71 |
or |
| 72 |
.IR jobname .ltx , |
| 73 |
in that order, and process it as above. |
| 74 |
.SH OPTIONS |
| 75 |
.TP 10 |
| 76 |
.B -v, -version, --version |
| 77 |
output program name and version number, and quit |
| 78 |
.TP |
| 79 |
.B -h, -help, --help |
| 80 |
output usage summary and quit |
| 81 |
.TP |
| 82 |
.B -l |
| 83 |
assume LaTeX source; |
| 84 |
implied if the file has .ltx extension |
| 85 |
.TP |
| 86 |
.B -p |
| 87 |
change the TeX processor to |
| 88 |
.BR pdfetex (1) |
| 89 |
or |
| 90 |
.BR pdflatex (1) |
| 91 |
(and doesn't run a dvi processor) |
| 92 |
.TP |
| 93 |
.B -c |
| 94 |
preprocess pmx file using |
| 95 |
.BR pmxchords (1) |
| 96 |
.TP |
| 97 |
.B -d |
| 98 |
don't generate a .ps file and change the dvi processor to |
| 99 |
.BR dvipdfm (1) |
| 100 |
.TP |
| 101 |
.B -D dvix |
| 102 |
use |
| 103 |
.B dvix |
| 104 |
as the dvi processor; e.g., -D "dvipdfm -m 0.9". |
| 105 |
Use -d |
| 106 |
.I before |
| 107 |
-D to suppress .ps generation. |
| 108 |
.TP |
| 109 |
.B -P ps2pdf |
| 110 |
use |
| 111 |
.B ps2pdf |
| 112 |
as the Postscript processor; e.g., -P "ps2pdf -sPAPERSIZE=a4" |
| 113 |
.TP |
| 114 |
.B -F fmt |
| 115 |
use |
| 116 |
.B fmt |
| 117 |
as the TeX processor; e.g., -F "luatex --output-format=dvi". Another example: it is possible to |
| 118 |
minimize TeX output by using -F "texfot etex". |
| 119 |
.TP |
| 120 |
.B -m |
| 121 |
stop processing at the pmx file |
| 122 |
.TP |
| 123 |
.B -M mtxx |
| 124 |
use |
| 125 |
.B mtxx |
| 126 |
as the mtx preprocessor; e.g., -M "prepmx -i". |
| 127 |
.TP |
| 128 |
.B -X pmxx |
| 129 |
use |
| 130 |
.B pmxx |
| 131 |
as the pmx preprocessor; e.g., -X "./pmxab", |
| 132 |
.TP |
| 133 |
.B -A aspcx |
| 134 |
use |
| 135 |
.B aspcx |
| 136 |
as the aspc preprocessor; e.g., -A "autosp -l". |
| 137 |
.TP |
| 138 |
.B -L xmlx |
| 139 |
use |
| 140 |
.B xmlx |
| 141 |
as the xml preprocessor; e.g., -L "./XML2PMX". |
| 142 |
.TP |
| 143 |
.B -t |
| 144 |
stop processing at the tex/mid files |
| 145 |
.TP |
| 146 |
.B -s |
| 147 |
stop processing at the dvi file |
| 148 |
.TP |
| 149 |
.B -g |
| 150 |
stop processing at the ps file |
| 151 |
.TP |
| 152 |
.B -i |
| 153 |
retain intermediate and log files |
| 154 |
.TP |
| 155 |
.B -1 |
| 156 |
one-pass [pdf][la]tex processing; i.e., without calling |
| 157 |
.B musixflx |
| 158 |
.TP |
| 159 |
.B -x |
| 160 |
call |
| 161 |
.BR makeindex (1) |
| 162 |
to update index database |
| 163 |
.TP |
| 164 |
.B -f |
| 165 |
restore default processing |
| 166 |
.TP |
| 167 |
.B -q |
| 168 |
quiet mode (only musixtex's own messages); other messages are diverted to a temporary file. |
| 169 |
If an error occurs at the TeX stage, processing halts immediately and the tail of the log file is sent to stderr. |
| 170 |
Version information is copied from the temporary file to the log file. |
| 171 |
|
| 172 |
.TP 0 |
| 173 |
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. |
| 174 |
|
| 175 |
Note that four TeX engines are available via the -l and -p options: |
| 176 |
.TP |
| 177 |
etex default |
| 178 |
latex -l |
| 179 |
pdfetex -p |
| 180 |
pdflatex -l -p |
| 181 |
.TP 0 |
| 182 |
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: |
| 183 |
-F "luatex --output-format=dvi" |
| 184 |
-F "lualatex --output-format=dvi" |
| 185 |
-F "luatex" -p |
| 186 |
-F "lualatex" -p |
| 187 |
|
| 188 |
.SH SEE ALSO |
| 189 |
.BR autosp (1), |
| 190 |
.BR etex (1), |
| 191 |
.BR latex (1), |
| 192 |
.BR pdfetex (1), |
| 193 |
.BR pdflatex (1), |
| 194 |
.BR makeindex (1), |
| 195 |
.BR musixflx (1), |
| 196 |
.BR dvipdfm (1), |
| 197 |
.BR dvips (1), |
| 198 |
.BR pmxab (1), |
| 199 |
.BR pmxchords (1), |
| 200 |
.BR prepmx (1), |
| 201 |
.BR ps2pdf (1), |
| 202 |
.BR xml2pmx (1) |
| 203 |
and musixdoc.pdf. |
| 204 |
.SH AUTHOR |
| 205 |
This manual page was written by Bob Tennent <[email protected]>. To generate PDF, use |
| 206 |
groff -man musixtex.1 -T pdf > musixtex.1.pdf. |