File: INSTALL

package info (click to toggle)
vdk2 2.4.0-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,524 kB
  • ctags: 4,975
  • sloc: cpp: 26,944; sh: 10,580; ansic: 9,220; makefile: 602; perl: 113
file content (161 lines) | stat: -rw-r--r-- 4,709 bytes parent folder | download | duplicates (8)
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
=================================
VDK 2.0 INSTALLING INSTRUCTIONS
=================================
please report any comment or bug to:
mmotta@users.sourceforge.net

=====================
PREPARING THE PACKAGE
=====================
If you haven't yet untarred the file, do

$ tar xvzf vdk-2.0.x.tar.gz

$ cd vdk-2.0.x/

=======================
CONFIGURING THE PACKAGE
=======================

$ ./configure

Configure will accept several options 
(to see all of them do ./configure --help)

Here the most used:

    --prefix=[DIR] where to install it [default=/usr/local]
	*** Note ***
	For RedHat,mandrake and  Redhat-like distributions i suggest to
	use --prefix=/usr to make things simpler.
 	*** Note for users that upgrade from VDK 1.2.x ***
	VDK 1.2.x and VDK-2.0.x can cohabitate provided that are installed on
	different prefixes, we suggest to mantaing 1.2.x series on /usr and
	/usr/local for VDK 2.0.x

    --enable-debug=[no/minimum/yes] it enable the debug system [default=no]
	    no = it will compile with -s flag
	    minimum = with -s -DVDKDEBUG (defined in config.h)
	    yes = with -g -DVDKDEBUG
	*** Note ***
	We suggest to mantain default value, VDK libs with debug info are huge.

    --enable-shared/static=[yes/no]
	build shared/static library [default=yes]
	*** Note ***
	We suggest to use --enable-static=no mainly for two reasons:
	1. VDK applications linked against a VDK static library remained untested
	2. Recall that distributing VDK applications linked against VDK static lib
	reduces LGPL license since you have to distribute your applications
	at least under GPL license terms.

    --enable-opt=[OPTIMIZATION/no]
	build with -O$(OPTIMIZATION) compiler lever [default=2]
	it can be disabled with no

    --enable-testvdk=[yes/no]
        build or not testvdk program [default=yes]

    --enable-sigc=[yes/no]
	build or not vdk signal system extension [default=no]
	This options requires libsigc++-0.8.5 or greater
	already installed.
	You can download above library at:
	http://libsigc.sourceforge.net/stable.html

    --enable-testsigc=[yes/no]
	build or vdk signal system extension test program [default=no]	
	This options requires libsigc++-0.8.5 or greater
	installed.
	You can download above library at:
	http://libsigc.sourceforge.net/stable.html

    --enable-gnome=[yes/no]
	build or not vdk gnome support library [default=no].
	You need Gnome libs installed in order to have gnome
	support. Running gnome is not required however.

    --enable-doc-html=[yes/no] (default=yes)
    --enable-doc-latex=[yes/no] (default=no)
    --enable-doc-man=[yes/no] (default=no)	
	Enables doc building in html, latex or man format.
	You need doxigen tool and Qt installed in order to
	build docs.
	You can download doxygen at:
	http://www.doxygen.org/download.html

==================
MAKING THE PACKAGE
==================
When configure finish do

$ make

This will produce:
- 	core library libvdk.so.2.0.x and links
- 	a configure script vdk-config-2 to use when compiling your
	vdk programs.

option depending:
- 	gnome support library libvdkgnome.so.2.0.x and links
- 	test program in ./testvdk/testvdk
- 	extended signal system test program in ./sigcvdktest/testsigcvdk
-	classes references in ./doc/doxy/html/index.html

======================
INSTALLING THE PACKAGE
======================
To install just do
# make install
(you may need root privilege)

This will install:
-	core and component libraries in $(prefix)/lib
-	include headers in $(prefix)/include
-	configure script vdk-config in $(prefix)/bin

======================
BUILDING DOCUMENTATION
======================
Do:
$ make docs
This will produce a ./vdk-2.0.x/doc/doxy/html dir
plenty of html and gif files.
Just run:
$ netscape ./vdk-2.0.x/doc/doxy/html/index.html&
or open ./vdk-2.0.x/doc/doxy/html/index.html
in your preferred browser to read VDK class reference.
To make a postscript printable version you need to
./configure with ..enable-doc-latex=yes and
$ cd ./vdk-2.0.x/doc/doxy/latex
$ make ps
this will produce a refman.ps
**************************************************
* Note for Red Hat users (and most likely others)*
**************************************************
If you have used the default prefix for installation
- check if /etc/ld.so.conf contains this line:
/usr/local/lib
(if not add it to the file)

- check if your PATH points to /usr/local/bin
otherwise update your bash rc.

Run: # /sbin/ldconfig

after have modified /etc/ld.so.conf


=========
CLEANING
=========

$ make clean
This will remove all obj's and libs from source tree

$ make distclean
This will remove all file created by configure
(You will need autoconf/automake to rebuild all the package)

Enjoy.
VDKTeam