summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/m-tx/mtx-install.tex
blob: 7142b49a131571d1fbd80c8481dc7bb53812e329 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
\documentclass[11pt]{article}
\usepackage[textwidth=6.5in,textheight=8.5in]{geometry}
\usepackage[osf]{mathpazo}
\PassOptionsToPackage{urlcolor=black,colorlinks}{hyperref}
\RequirePackage{hyperref}
\usepackage{xcolor}
\newcommand{\myurl}[1]{\textcolor{blue}{\underline{\textcolor{black}{\url{#1}}}}}
\newcommand{\mtxVersion}{0.62}
\begin{document}
\title{Installation of the CTAN M-Tx Distribution}
\author{Bob Tennent\\
\small\url{rdt@cs.queensu.ca}}
\date{\today}
\maketitle 
\thispagestyle{empty}

\section{Introduction}
We assume that you have already installed MusiXTeX and PMX.
Before trying to install M-Tx from CTAN, check whether your TeX distribution
provides packages for M-Tx; this will be easier than doing it yourself.
But if your TeX distribution
doesn't have M-Tx (or doesn't have the most recent version), this distribution
of M-Tx is very easy to install, though
you may need to read the material on 
installation of (La)TeX files in the 
TeX FAQ\footnote{%
\myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html}},
particularly
the pages on 
which tree to use\footnote{%
\myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=what-TDS}}
and installing files\footnote{%
\myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf}}.

\section{Installing \texttt{m-tx.tds.zip}}

In this distribution of M-Tx, many of the files to be installed 
(including macros and documentation are in 
\myurl{http://mirror.ctan.org/install/m-tx.tds.zip}. The file
\verb|mt-x.tds.zip| is a zipped TEXMF
hierarchy; simply download it and unzip in the root folder/directory of whichever TEXMF tree
you decide is most appropriate, likely a ``local'' or ``personal'' one.
This should work with any TDS\footnote{%
\myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds}}
compliant TeX distribution, including MikTeX, TeXlive and teTeX,
but you must use an unzipping program that 
converts text files to the text-file format of your
platform, such as \verb\unzip -a ...\ on Linux.


After unzipping the archive, update the filename database as necessary,
for example, by executing \verb\texhash ~/texmf\ or 
clicking the button labelled ``Refresh FNDB" in the MikTeX settings program.

Documentation for M-Tx is installed under \verb\doc/generic/m-tx\
in the TEXMF tree.  

\section{Installing \texttt{prepmx}}

The next step in the installation is to install
the one essential file that can't be installed in a TEXMF tree: the \texttt{prepmx} preprocessor. 


\subsection{Pre-Compiled Executables}

On Windows
systems, one can install \texttt{prepmx.exe} 
in the \texttt{Windows/32bit} or \texttt{Windows/64bit} sub-directory; these are pre-compiled
executables and should be copied to any
folder on the PATH of executables. 
This might entail creating a suitable folder and adding that folder
to the PATH as follows: 
right click on the ``My Computer'' desktop icon,
left click on 
\begin{center}
Properties$\rightarrow$Advanced$\rightarrow$Environment Variables
\end{center}
in the ``System Variables'' section, scroll
down to ``path'', select it, click edit, and append the full path name you have selected for the new 
folder.  Also install the batch script \verb|m-tx.bat| in a folder on the PATH.

On the MAC OS-X/Intel platform, one can install the \texttt{prepmx} binary
that is in the 
\texttt{OSX} sub-directory.  Ensure that the file has the execute permission set:
\begin{list}{}{}\item
\verb\chmod +x prepmx\
\end{list}

\subsection{Compilation from Source}

On any platform with basic GNU tools (\texttt{gcc}, \texttt{tar}, \texttt{gunzip}, \texttt{make}),
you should be able to build the \texttt{prepmx} executable as follows:

\begin{enumerate}
\item Unpack the \texttt{mtx-\mtxVersion.tar.gz} archive:
\begin{list}{}{}
\item \texttt{tar zxvf mtx-\mtxVersion.tar.gz}
\end{list}
and move to the resulting \texttt{mtx-\mtxVersion} directory.
\item Configure:
\begin{list}{}{}
\item \verb\./configure --prefix=$HOME\
\end{list}
or just
\begin{list}{}{}
\item\verb\./configure \
\end{list}
if you have super-user privileges.
\item Build:
\begin{list}{}{}
\item \verb\make\
\end{list}
If this fails, you might want to install \texttt{fpc} (the Free Pascal Compiler\footnote{%
\myurl{http://www.freepascal.org/}}) and
try
\begin{list}{}{}
\item \verb\make -f Makefile.orig\
\end{list}

\item Install:
\begin{list}{}{}
\item \verb\make install\
\end{list}
This step should be executed as root if you need super-user privileges.
\end{enumerate}
You should now have an executable \verb\prepmx\ 
in your PATH.

\section{Usage}

To process an M-Tx source file, use the \verb|musixtex| script
which is included in the \verb|musixtex| package.
If applied to a file with \verb|.mtx| extension, it will by default execute \verb|prepmx| followed by
\verb|pmxab|, followed 
by \verb|etex|, \verb|musixflx|, and \verb|etex| again, followed by
conversion to PDF using \verb|dvips| and \verb|ps2pdf|.
There are many options to vary the default behaviour.

\section{Discussion}

Other pre-processor packages, additional documentation, additional
add-on packages, and many examples of M-Tx and MusiXTeX typesetting may be found
at the Werner Icking Music Archive\footnote{%
\myurl{http://icking-music-archive.org}}.
Support for users of MusiXTeX and related software may be obtained via
the MusiXTeX mail list\footnote{%
\myurl{http://tug.org/mailman/listinfo/tex-music}}.
M-Tx may be freely copied, duplicated and used in conformance to the
GNU General Public License (Version 2, 1991, see included file \verb\gpl.txt\).

\end{document}