eh, make ’em volatile, this is not time-critical code anyway
[alioth/magicpoint.git] / README
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
3                MagicPoint - an X11 based presentation tool
4
5                             September 9, 2003
6                              26th July 2019
7
8 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9
10 MagicPoint is an X11 based presentation tool.  It is designed to make
11 simple presentations easy while to make complicated presentations
12 possible.  Its presentation file (whose suffix is typically .mgp) is
13 just text so that you can create presentation files quickly with your
14 favorite editor (e.g. Emacs).
15
16 MagicPoint is completely free but absolutely no warranty. For more
17 information, please refer to LICENCE.
18
19 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20
21                               INSTALLATION
22
23 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
24
25 You’ll need the following prerequisites to build MagicPoint:
26
27 • a POSIX or Korn shell, GNU bash, zsh in “emulate sh” mode;
28   some somewhat decent Bourne shell will also do if needed
29 • a lexical analyser generator (flex)
30 • a parser generator, usually yacc, but GNU bison will do
31 • a C compiler, linker, standard c and m library
32 • make (BSD, GNU or other)
33 • a way to create static .a archives (ar+ranlib)
34 • pkg-config
35 • X11 development headers and libraries (libX11 libXmu libXt libXtst)
36 • Imlib2
37 • Xft2
38 • libbsd, if building on GNU
39 • optionally, libiconv, libutil
40
41 Follow the steps below to make MagicPoint:
42
43         % mkdir obj                             # out-of-tree build recommended
44         % cd obj
45         % sh ../Build.sh                        # should be POSIX/Korn shell
46         % make -j4                              # parallel make supported
47         % sudo make install                     # DESTDIR supported
48
49 By default, this will use the pkg-config files for imlib2, libbsd-overlay,
50 xft; use the -P flag if you wish to change this.
51
52 Note: if you have to use a non-standard compiler, you must declare
53       your compiler by using "env" command, like:
54
55         % env CC=gcc sh ../Build.sh             # force gcc
56         % env CC=shlicc2 sh ../Build.sh         # force shlicc2 (bsdi3)
57
58 Note 2: the configuring process is loud, but as long as Build.sh ends
59         with “You can now use make(1) to compile MagicPoint.” it’s ok.
60         If your OS was not yet known please report to the developer to
61         get it added.
62
63 Note 3: if you need to change CC, CPPFLAGS, CFLAGS, LDFLAGS, LIBS, …
64         pass them to Build.sh in the environment, do *not* override
65         them at the make stage; you *can* override SH (sh), AR (ar),
66         AR_CREATE (${AR} cq), RANLIB (ranlib), LEX (flex), YACC (yacc)
67         if needed for your system and/or cross-compiling.
68
69 Note 4: for paths, you can override SYSCONFDIR, PREFIX, BINDIR, … in
70         the make run, but keep them consistent between make all and
71         make install; also, PERL is used during build for shebang;
72         for installing, check INSTALL_STRIP and modes in Makefile.
73
74 Note 5: packagers can override mgpversion during build if desired.
75
76 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77
78 It's a good idea to preview sample files before installation. For more
79 information, see "sample/README" or "sample/README.jp", which
80 describes how to install TrueType fonts.
81
82 To visualise the sample{,-jp}.mgp file, type:
83
84         % ./mgp ../sample/sample.mgp
85         % ./mgp ../sample/sample-jp.mgp
86
87 To visualise the tutorial{,-jp}.mgp file, type:
88
89         % ./mgp ../sample/tutorial.mgp
90         % ./mgp ../sample/tutorial-jp.mgp
91
92 WE STRONGLY RECOMMEND TO BUY TRUETYPE FONTS IF YOU WANT TO GIVE YOUR
93 PRESENTATION WITH BEAUTIFUL FONTS.
94
95 If you want to paste EPS figures into your presentation, you will need
96 to install "ghostscript" or "alike".
97
98 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
99
100                               FOR MORE INFO
101
102 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
103
104 Homepage for this MagicPoint fork/continuation, with downloads, is:
105         http://www.mirbsd.org/mgp.htm
106
107 Official home page of the original MagicPoint is:
108         http://member.wide.ad.jp/wg/mgp/
109
110 Stable release packages of that are available from:
111         ftp://sh.wide.ad.jp/WIDE/free-ware/mgp/
112
113 To join the mailing-list for the original MagicPoint, See:
114         http://member.wide.ad.jp/wg/mgp/ml.html
115         http://member.wide.ad.jp/wg/mgp/ml-jp.html (in Japanese)
116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%