File: INSTALL

package info (click to toggle)
camlimages 2.00-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,536 kB
  • ctags: 2,325
  • sloc: ml: 10,848; ansic: 2,396; makefile: 599; sh: 30
file content (143 lines) | stat: -rw-r--r-- 3,693 bytes parent folder | download
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
CamlImages - Objective Caml image processing library

This library is currently under development.

*** Requirements

 To install CamlImages library, you need the following softwares:

	* ocaml 3.03alpha or higher
	* GNU make

and that is all. But note that this is the minimum requirement: you
can read/write BMP or PXM (PPM, PGM, PBM) image formats but no other
formats. If you want to deal with other image formats, you need to
install the corresponding external libraries:

	* libpng for PNG format
			ftp://ftp.uu.net/graphics/png/src/

	* libjpeg for JPEG format
		The Independent JPEG Group's software
			ftp://ftp.uu.net/graphics/jpeg/jpegsrc.v6b.tar.gz

	* libtiff for TIFF format
		Sam Leffler's TIFF software
			ftp://ftp.sgi.com/graphics/tiff/tiff-v3.4-tar.gz

	* libxpm for XPM format
		INRIA Koala project FTP site
			ftp://koala.inria.fr/pub/xpm/

	* freetype for drawing texts using truetype fonts
		The FREETYPE Project
			http://www.freetype.org/
				or
			http://freetype.sourceforge.net/

		Note:
			You need either version 1.3.1 or Version 2.0.x.

	* libungif for GIF format
		Because of the GIF patent problem of Unisys, we do not
		recommend to use GIF file format. If you really want to
		use GIF, do it in your own risk.

		Libungif, a library for using GIFs without compression. 
                  http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml

        * ghostscript for PS format
                See http://www.ghostscript.com/

Even though you do not have one of these libraries, all the functions of
CamlImages are still available, but they may raise an exception
Failure "??? is not supported"

*** Installation procedure

 Configuration
 -------------
  To compile and install the CamlImages library, first configure the
the library using make configure or

	% ./configure

This script searches whether external libraries exist or not and where
they are, and configure automatically your Makefile, config.h, 
camlimages.ml and so on. 
  If you have installed the lablgtk library (version 1.2.3):

   http://wwwfun.kurims.kyoto-u.ac.jp/soft/olabl/lablgtk.html

and it is in the standard place, $CAMLDIR/lablgtk, then configure script 
automatically finds it and configure your Makefile. If you installed
lablgtk in another place, you have to specify an option 
--with-lablgtk=LABLGTKDIR to enable to compile some examples using 
the lablgtk GUI library. (LABLGTKDIR standing for the absolute path of 
the directory where lablgtk resides.) 

 Compilation
 -----------
 type 

	% make

and wait. 

 Test
 ----
  Before you actually install the library, you can check that it
really works, by running examples in the test directory. For the test
programs,

	% cd test
	% make
	% ./test

we hope it works for you.

 Installation
 ------------ 

  If there is no compilation error and the test works fine, 
install the library,

	% make install

This installs all the required files into $(LIBDIR) in Makefile.config,
usually /usr/local/lib/ocaml/camlimages, or /usr/lib/ocaml/camlimages.   

 Native code version
 -------------------
  To compile and install the native code version of the library, type

	% make opt

  (Optionnally you can test the native code version using
	% cd test
	% make opt
	% ./test.opt
        % cd ..
  )

and then install the native version

	% make installopt

  If you want to create a toplevel with camlimages, 

	% make top

that creates a toplevel named "customtop". Then,

	% toplevel

executes customtop with the appropriate options.

 Example applications
 --------------------

  In the examples directory you can find several example applications
using Camlimages. 

  Some of the programs use the lablgtk GUI.