| 1 |
.TH prepmx 1 "08 January 2018" "M-Tx Version 0.63" "prepmx Manual Page" |
| 2 |
.SH NAME |
| 3 |
prepmx \- preprocessor for PMX, easy music typesetting program |
| 4 |
.SH SYNOPSIS |
| 5 |
.B prepmx |
| 6 |
.RI [ options ] |
| 7 |
.I jobname |
| 8 |
.RI [ outdir/ ] |
| 9 |
.RI [ stylefile ] |
| 10 |
.SH DESCRIPTION |
| 11 |
.B M-Tx |
| 12 |
is an easy to use preprocessor language for the |
| 13 |
.B PMX |
| 14 |
music typesetting program, aimed at people who are not experts. For an |
| 15 |
easy example, have a look at the following example: |
| 16 |
|
| 17 |
c2+ e4 g | b4d- c1 d c2 | |
| 18 |
c8 g+ e g c- g+ e g | d g f g c- g+ e g | |
| 19 |
|
| 20 |
For syntax reference, please look at the M-Tx manual written by Dirk |
| 21 |
Laurie, the creator of the M-Tx language and the author of |
| 22 |
.BR prepmx (1), |
| 23 |
its command-line utility. |
| 24 |
|
| 25 |
.B prepmx |
| 26 |
processes the file |
| 27 |
.IR jobname .mtx |
| 28 |
to generate |
| 29 |
.IR jobname .pmx. |
| 30 |
You can then process this file using the |
| 31 |
.BR pmxab (1) |
| 32 |
command, which is a preprocessor for MusiXTeX. |
| 33 |
|
| 34 |
.I outdir/ |
| 35 |
is the directory where `pmx' will put the final .tex file. Note that the |
| 36 |
trailing slash is mandatory. You can provide a |
| 37 |
.I stylefile |
| 38 |
for M-Tx. If omitted, the file `mtxstyle.txt' in the current |
| 39 |
directory is used, if there is one. |
| 40 |
.SH OPTIONS |
| 41 |
Options can also be specified in a `Options:' line in the preamble, |
| 42 |
which takes precedence over the command line. |
| 43 |
.TP |
| 44 |
.B \-b |
| 45 |
disable unbeamVocal |
| 46 |
.TP |
| 47 |
.B \-c |
| 48 |
disable doChords |
| 49 |
.TP |
| 50 |
.B \-D |
| 51 |
enable debugMode |
| 52 |
.TP |
| 53 |
.B \-f |
| 54 |
enable solfaNoteNames |
| 55 |
.TP |
| 56 |
.B \-i |
| 57 |
enable ignoreErrors |
| 58 |
.TP |
| 59 |
.B \-m |
| 60 |
disable doLyrics |
| 61 |
.TP |
| 62 |
.B \-n |
| 63 |
enable instrumentNames |
| 64 |
.TP |
| 65 |
.B \-t |
| 66 |
disable doUptext |
| 67 |
.TP |
| 68 |
.B \-u |
| 69 |
disable uptextOnRests |
| 70 |
.TP |
| 71 |
.B \-v |
| 72 |
enable beVerbose |
| 73 |
.TP |
| 74 |
.B \-w |
| 75 |
enable pedanticWarnings |
| 76 |
.TP |
| 77 |
.BI \- n |
| 78 |
select Special Case |
| 79 |
.I n |
| 80 |
.TP |
| 81 |
.B \-H |
| 82 |
print enabled status of all options |
| 83 |
.SH EXIT STATUS |
| 84 |
If no error was found, |
| 85 |
.B prepmx |
| 86 |
exits with return code 0. In case of an error, the line number of the |
| 87 |
processed line is returned. This may not always be the line containing |
| 88 |
the actual error. A return status of 10000 means that the input file was |
| 89 |
empty or could not be opened. |
| 90 |
.SH SEE ALSO |
| 91 |
.B M-Tx |
| 92 |
User's Guide (mtxdoc.pdf) |
| 93 |
.br |
| 94 |
pmxab(1), musixtex(1) |
| 95 |
.SH AUTHORS |
| 96 |
prepmx was written by Dirk Laurie <[email protected]>. This |
| 97 |
manual page was written by Roland Stigge <[email protected]> |
| 98 |
for the Debian project. It was revised and extended by |
| 99 |
Nis Martensen <[email protected]> and Bob Tennent |
| 100 |
<[email protected]>. |