chiark / gitweb /
Import upstream version 5.3.
[mup] / mup / docs / mupmate.1
CommitLineData
69695f33
MW
1.TH mupmate 1 "November 4, 2006" "Arkkra Enterprises"
2.SH NAME
3.PP
4mupmate - user interface for Mup music publisher
5.SH SYNOPSIS
6.PP
7mupmate [\fIfile\fP]
8.SH DESCRIPTION
9.PP
10.P
11You can create a Mup file using any ordinary text editor.
12On Windows, Notepad is a typical choice; on Linux, editors like
13vim and emacs are commonly used. But if you prefer to be able to
14edit, display, and play from a single integrated and more graphical
15interface, a helper program called "mupmate" is provided. Mupmate is currently
16only supported on Windows and Linux. However, since the source code is
17available, and it is based on the cross-platform FLTK toolkit, it
18can probably be made to run on any system supported by FLTK fairly easily.
19If you prefer to use the Mup program directly rather than via mupmate,
20you can. The Mupmate program just helps lead you through some of the steps.
21.PP
22Once you have installed Mup and Mupmate on Windows, double clicking
23a .mup file in Windows explorer will run Mupmate on that file.
24Or, you can run Mupmate by going to the Start menu, and choosing
25Programs, then Arkkra, and then Mupmate. If you would like an icon
26on the desktop, you can create one by right clicking
27the Mupmate choice in the Arkkra menu,
28choosing "copy", right clicking somewhere on the desktop, and choosing "paste."
29.PP
30On Linux, you can just type the mupmate command,
31optionally followed by the name of a Mup input file.
32Or you can add mupmate to your favorite window manager's menus.
33.P
34Mupmate provides five top level menus: File, Edit, Run, Config, and Help.
35The File menu provides commands for opening new files and saving the
36file you are working on, as well as exit the program. The Edit menu
37provides the kinds of things you would expect in a editor: commands to find
38a pattern, or find and replace; to select text; to copy, cut, and paste;
39to go to a specific line; and to undo the previous operation, if you make
40a mistake or change you mind.
41The Run menu lets you set runtime options,
42and then run the Mup program on your input in various
43ways. You can either just generate a PostScript or MIDI file,
44or display the PostScript or play the MIDI.
45The Config menu lets you specify what application program you want
46to use to view PostScript files and which you want to use to play MIDI files,
47and well as specify locations for other Mup files. Mupmate will try to
48find reasonable default values, but you may want to check that they are
49what you want, and tweak them if they aren't.
50The Config menu also provides a way for you to fill in the Mup registration
51form if you wish to send in a paper form rather than registering online
52via credit card, as well as a place to entry the registration key you
53will receive once you have paid.
54The Help menu lets you browse the Mup User's Guide, view some startup hints,
55or see the current version number of Mup and Mupmate.
56.SH "SEE ALSO"
57.PP
58gs(1), mup(1).
59.br
60Mup \(em Music Publisher User's Guide
61.SH "CAVEATS"
62.PP
63Mupmate is currently only supported on Windows and Linux or similar.
64.PP
65Mupmate does not directly provide a print facility. Almost any PostScript
66viewer already provides this ability, so you can simply select "Display"
67from the Run menu and use the viewer's print capabilities.
68Alternately you can use the "Write PostScript File" from the Run menu
69and then print the resulting file.