| 1 |
Building Mscgen |
| 2 |
=============== |
| 3 |
|
| 4 |
Building is done with the GNU autotools and should be largely automatic. |
| 5 |
|
| 6 |
Preparation |
| 7 |
----------- |
| 8 |
|
| 9 |
If you obtained the sources directly from the SVN repository, you will first |
| 10 |
need to run autogen.sh to generate the configure script. |
| 11 |
|
| 12 |
Note: This is not required for the downloadable source tarballs as they are |
| 13 |
already contain a configure script. |
| 14 |
|
| 15 |
|
| 16 |
Win32 - Native |
| 17 |
-------------- |
| 18 |
|
| 19 |
A native build has no runtime dependency on Cygwin and can be ran on any |
| 20 |
Windows machine. It does however use Cygwin to configure and build. |
| 21 |
|
| 22 |
You can get Cygwin from http://www.cygwin.com. The following packages |
| 23 |
need to be installed via the Cygwin setup.exe: |
| 24 |
|
| 25 |
- gcc |
| 26 |
- gcc-mingw |
| 27 |
- make |
| 28 |
- flex |
| 29 |
- bison |
| 30 |
- binutils |
| 31 |
|
| 32 |
A copy of the Win32 libgd library is also needed. If you checked out the |
| 33 |
mscgen sources from Google Code, you will already have this in the gdwin32 |
| 34 |
directory. Otherwise you can obtain a copy from the GD site, or from Google |
| 35 |
Code: |
| 36 |
|
| 37 |
http://www.libgd.org/releases/oldreleases/gd-2.0.34-win32.zip |
| 38 |
|
| 39 |
svn checkout http://mscgen.googlecode.com/svn/trunk/gdwin32 /tmp/gdwin32 |
| 40 |
|
| 41 |
You will have to unpack the zip file, and ensure the file bgd.dll is on your |
| 42 |
path. |
| 43 |
|
| 44 |
From the top level directory, run the configure script with options to |
| 45 |
build natively and use the Win32 binary gdwin32 you downloaded (an unpacked): |
| 46 |
|
| 47 |
$ ./configure CFLAGS=-mno-cygwin \ |
| 48 |
GDLIB_CFLAGS="-I/tmp/gdwin32/include" \ |
| 49 |
GDLIB_LIBS="-L/tmp/gdwin32/lib -lbgd" |
| 50 |
$ make |
| 51 |
$ make check |
| 52 |
$ make install |
| 53 |
|
| 54 |
This will install a native version of mscgen and the accompanying bgd.dll file |
| 55 |
into the cygwin directories. If you wish to install elsewhere, either use the |
| 56 |
--prefix option to 'configure', or manually copy mscgen.exe and the DLL. |
| 57 |
|
| 58 |
The DLL dependencies of the mscgen.exe can be checked using cygcheck: |
| 59 |
|
| 60 |
$ cygcheck.exe mscgen.exe |
| 61 |
Found: C:\cygwin\bin\mscgen.exe |
| 62 |
C:\cygwin\bin\mscgen.exe |
| 63 |
C:\cygwin\bin\bgd.dll |
| 64 |
C:\WINDOWS\system32\KERNEL32.dll |
| 65 |
C:\WINDOWS\system32\ntdll.dll |
| 66 |
C:\WINDOWS\system32\MSVCRT.dll |
| 67 |
|
| 68 |
|
| 69 |
Win32 - Cygwin |
| 70 |
-------------- |
| 71 |
|
| 72 |
You will need Cygwin (from http://www.cygwin.com) and the following packages |
| 73 |
installed via the Cygwin setup program: |
| 74 |
|
| 75 |
- gcc |
| 76 |
- make |
| 77 |
- flex |
| 78 |
- bison |
| 79 |
- binutils |
| 80 |
- libgd2 |
| 81 |
- libgd-devel |
| 82 |
- pkg-config |
| 83 |
|
| 84 |
From the top level directory, run the configure script and then make: |
| 85 |
|
| 86 |
$ ./configure |
| 87 |
$ make |
| 88 |
$ make check |
| 89 |
$ make install |
| 90 |
|
| 91 |
|
| 92 |
Other Unix-like Platforms |
| 93 |
------------------------- |
| 94 |
|
| 95 |
You will need: |
| 96 |
|
| 97 |
- flex, bison, gcc and pkg-config installed |
| 98 |
- GD >= 2.0.22 libs installed (libgd-devel) |
| 99 |
- GD's dependencies, which are dependent on how it was configured, but |
| 100 |
will typically be a subset of the following: |
| 101 |
libpng libz libfreetype libm |
| 102 |
- GNU make |
| 103 |
|
| 104 |
GD can be obtained from http://www.libgd.org/ and will need to be downloaded |
| 105 |
and installed, or a package, such as an RPM maybe used instead. |
| 106 |
For RedHat and SuSE, the package gd-devel should be installed, which will |
| 107 |
normally cause any dependent libraries to also be installed. |
| 108 |
|
| 109 |
From the top level directory, run the configure script and then make: |
| 110 |
|
| 111 |
$ ./configure |
| 112 |
$ make |
| 113 |
$ make check |
| 114 |
$ sudo make install |
| 115 |
|
| 116 |
|
| 117 |
Syntax Highlighting |
| 118 |
=================== |
| 119 |
|
| 120 |
A lang file for GtkSourceView based editors is included with mscgen. |
| 121 |
The mscgen.lang file, normally installed with mscgen to /usr/share/doc/mscgen |
| 122 |
but needs copying to one of two locations for GtkSourceView: |
| 123 |
|
| 124 |
/usr/share/gtksourceview-2.0/language-specs |
| 125 |
- System wide installation |
| 126 |
|
| 127 |
~/.local/share/gtksourceview-2.0/language-specs |
| 128 |
- User specific installation |
| 129 |
|
| 130 |
This then allows mscgen input files to be displayed with syntax highlighting |
| 131 |
in applications such a gedit and Anjuta. The language spec associates itself |
| 132 |
with .msc files. |
| 133 |
|
| 134 |
|
| 135 |
Bugs |
| 136 |
==== |
| 137 |
|
| 138 |
An issue tracker is available at the following location: |
| 139 |
|
| 140 |
http://code.google.com/p/mscgen/issues/list |
| 141 |
|
| 142 |
You may also email me directly at [email protected]. |
| 143 |
|
| 144 |
|
| 145 |
Updates |
| 146 |
======= |
| 147 |
|
| 148 |
A release announcement mailing list for new releases is available at the |
| 149 |
following location: |
| 150 |
|
| 151 |
http://groups.google.com/group/mscgen-announce |
| 152 |
|
| 153 |
LICENCE |
| 154 |
======= |
| 155 |
|
| 156 |
Mscgen, Copyright (C) 2010 Michael C McTernan, |
| 157 |
[email protected] |
| 158 |
Mscgen comes with ABSOLUTELY NO WARRANTY. Mscgen is free software, and you |
| 159 |
are welcome to redistribute it under certain conditions; see the COPYING |
| 160 |
file for details. |
| 161 |
|
| 162 |
PNG rendering support is provided by libgd, www.libgd.org; see the COPYING.gd |
| 163 |
file for full credits. |
| 164 |
|
| 165 |
END OF FILE |