chiark / gitweb /
Merge branch 'arkkra' into shiny
[mup] / mup / docs / README0
1
2                           Compiling Mup for UNIX
3
4        1.  Compiling Mup for UNIX
5
6        Mup has been compiled successfully on a wide variety of
7        UNIX-type systems, including Linux, UNIX SV_R4, and Solaris.
8        We cannot guarantee that it will work on your system, but it
9        generally ports with no more than minimal changes.
10
11        Download the mup53src.tar.gz Mup source package file and
12        unpack it:
13           gunzip mup53src.tar.gz
14           tar xf mup53src.tar
15
16        Alternately, you can download the RPM format Mup source
17        package and install it as you would any RPM package:
18           rpm -i mup-5.3-0.src.rpm
19
20        Installing the source package will create a mup-5.3
21        directory.  Go to that directory.
22           cd mup-5.3
23        There is a simple makefile provided, which should work on
24        most systems, so all you need to do is:
25           make install
26        You can edit the makefile if necessary for your environment.
27        Comments at the top of the makefile describe suggested
28        modifications if it doesn't work for you as is.  Note that
29        if you want to install in a system directory (like the
30        default location /usr/bin) you will need to be root for the
31        installation step. Otherwise building Mup requires no
32        special privileges.
33
34        If for some reason the makefile doesn't work, you can
35        compile Mup and any of the optional utility programs
36        (mupdisp, mkmupfnt, and mupmate) manually.  For compling Mup
37        itself, generally, something like the following will work:
38           cd mup
39           cc -o mup *.c -lm
40        For most UNIX-like compilers, the "-o mup" will cause the
41        program to be put into a file called "mup," and the "-lm"
42        will cause the math library to be included (That's a lower-
43        case letter "el" not a one).  You may also want to use other
44        options. For example, for many compilers "-O" (that's a
45        capital letter "oh" not a zero) will run the optimizer, and
46        "-s" will strip the resulting program to save disk space.
47
48        Copy mup into your $HOME/bin or a similar directory in your
49        $PATH.
50           cp mup $HOME/bin/mup
51
52        If you already have a means of displaying PostScript files,
53        such as gv, ghostview, or pageview, you can simply pipe the
54        output of Mup into your display program.  Or you can use the
55        mupdisp program in connection with Ghostscript, which is
56        free. You can download Ghostscript from
57        http://www.cs.wisc.edu/~ghost, or
58        http://www.ghostscript.com/.  We've found that on some
59        systems, Ghostscript compiles with lots of warnings, but it
60        works okay anyway.
61
62        Once you have installed Ghostscript, compile the mupdisp
63        program for displaying Mup output on screen. See the comment
64        at the top of mupdisp.c for suggestions on compiler options
65        to try.
66
67        Copy mupdisp into your $HOME/bin or similar directory.
68           cp mupdisp $HOME/bin/mupdisp
69
70        The mupdisp program works on the AT386 $TERM type under UNIX
71        x86 or under X-windows. If you have a different display
72        type, you may need to write your own display functions. In
73        most cases, you'll only need to write 6 short functions, and
74        you can use the examples in at386.c, dos.c, or xterm.c for a
75        general template of the functions. You will also need to
76        update dispttyp.h and init.c appropriately.
77
78        If you want to supply your own fonts to override the
79        standard Mup fonts, you can compile the mkmupfnt program:
80           cd mkmupfnt cc -o mkmupfnt mkmupfnt.c
81
82        The Mupmate program provide a menu-driven interface on top
83        of Mup.  It is built on top of the FLTK library, so you will
84        need to have the FLTK development package. You can get this
85        from http://www.fltk.org Get the latest version in the 1.1.x
86        series (we built with 1.1.7); don't get from the 2.x series.
87        Mupmate is written in C++, so you will need a C++ compiler,
88        such as g++.  See the top level makefile for typical
89        compilation options. FLTK normally comes with its own copies
90        of libjpg, libpng, and libz (compression) libraries, but it
91        will usually work with the generic versions of those
92        libraries as well.  You will also need standard X-windows
93        libraries: libX11, libXext, and libXpm.
94
95        A shell script called "mupprnt" is included for printing Mup
96        files using Ghostscript.  Copy mupprnt to your $HOME/bin or
97        other appropriate directory.
98           cp mupprnt $HOME/bin/mupprnt
99        You will need to set the GS_DEVICE shell variable to the
100        proper value for your printer. If you don't know what to set
101        it to, the comment at the top of mupprnt may help, or check
102        your Ghostscript documentation.  You could also just use the
103        print option on your PostScript viewer such as gv.
104
105        Once you have everything installed, you can remove the .tar
106        file if you wish, to free up disk space.
107           rm mup53src.tar
108
109        Please let us know if you need any workarounds for compiling
110        on your system. We want to try to make Mup as portable as
111        possible.
112
113        2.  Getting Mup running for the first time
114
115        Once you get Mup to compile successfully, try running it.
116        The first time you run Mup, it should give you a message
117        indicating Mup is shareware, and asking you to read the Mup
118        license agreement. It will then tell you to create a
119        particular file.  By creating this file, you agree to abide
120        by the Mup license, and Mup will be turned on for normal
121        operation.
122
123        Try running Mup on the sample input files (sample.mup and
124        star.mup ).  Verify that the output you get matches the
125        corresponding sample output files (sample.ps and star.ps ).
126        You will find differences in some of the numbers, comments,
127        timestamp, filenames, etc, but otherwise, in general the
128        PostScript output you get should be similar to the sample
129        output files provided, and if you display them, the results
130        should look pretty much identical.
131
132        If Mup fails to run properly on the sample files, either
133        your system has uncovered a bug that we haven't seen yet or
134        your machine has some incompatibility. You can turn on
135        debugging, by running with the -dN option, where N is a
136        bitmap of debugging flags, to help pinpoint where bugs may
137        be. The Mup User's Guide explains the bits of the debugging
138        flags. If you get stuck, you may contact us at
139        support@arkkra.com and we will try to help.
140
141        If you need to make any changes in order to get Mup to
142        compile and run successfully, please let us know.  If you
143        find anything confusing, we'd like to know that too.  We
144        want Mup to be as solid, portable, useful, and easy to use
145        as possible.
146
147        Also, please let us know if there are ways we can improve
148        the Mup documentation.
149
150        If you receive messages beginning with "internal error" this
151        usually indicates a program bug, so we'd like to know about
152        them. An exception is when you get a message about being
153        unable to allocate memory when there really isn't any memory
154        left. If you get other internal errors, please send us a
155        copy of an input file and any other information that may
156        help us reproduce the problem, so we can try to fix it in
157        the next Mup release.
158
159        Mup is shareware. Once you get Mup up and running, you can
160        try it out for free to decide whether you want to use it or
161        not. If you like it, execute
162           mup -r
163        to get a copy of the shareware registration form.  The
164        registration fee is $29.  See the license file for license
165        details.
166
167        Provide feedback (bugs reports, comments, suggestions,
168        questions) to:  support@arkkra.com
169
170        --------------------------------------------------
171
172        Arkkra Enterprises