[go: up one dir, main page]

File: INSTALL

package info (click to toggle)
robotour 3.1.1-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 2,596 kB
  • ctags: 2,972
  • sloc: cpp: 17,705; sh: 3,060; ansic: 2,778; makefile: 144
file content (297 lines) | stat: -rwxr-xr-x 10,869 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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
Quick summary for building RoboTour
===================================
(more instructions, see below) 

   Use the following command sequence: 
   
     ./configure
     make
     make install
     
   You may want to install GTK and wxWidgets (GTK version; version 2.4 
or higher) before compiling RoboTour. This will result in a GUI version
of RoboTour, which is much easier to use and has more features than the
classic command-line version. 



Basic Installation With Configure, Make and friends
===================================================

   These are generic installation instructions. See the end of file 
for some special RoboTour options, which are however rarely needed 
in practice. 

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
     the package.

  4. Type `make install' to install the programs and any data files and
     documentation.

  5. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CXX=g++ CXXFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

   If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory.  After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names
==================

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

   In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files.  Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features
=================

   The following optional features are relevant for RoboTour: 

--enable-wxwin=VAL      VAL=yes: Build wxWidgets frontend (if present);
                        VAL=no: Don't build wxWidgets frontend; 
                        VAL=(other): Build wxWidgets and use (other) as 
                          wx-config command

--enable-opengl=VAL     VAL=yes: Use OpenGL in wxWidgets frontend (must be
                          enabled during wxWidgets compilation too!); 
                        VAL=no: Don't build the cool 3D visualization

Specifying the System Type
==========================

   There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

   If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

   If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

   `configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`configure' also accepts some other, not widely useful, options.




Detailed RoboTour build option reference
========================================

Changing these options should not be required when using configure, which
should set them correctly itself. 

REQUIREMENTS
BUILDING ROBOTOUR AND LIBRT
USED COMPILER DEFINES

* Requirements ***

- One of the supported systems (Windows 32-bit versions; Symbian EPOC ER5,ER6;
  or (hopefully) quite any kind of Unix).

- Quite a good C++ compiler. We have successfully used MSVC++, version 6 and 
  GCC, version 2.9 and up.


* Building LibRT ***

LibRT has to be built to a statically linked library. 
This is done by compiling all .cpp files in the "libRT" folder which
match the following criteria:
- Their names don't start with "test"
- They don't have two points in their filenames
- They're not called rttuiedit.cpp.

As of the time of this writing, the files to be compiled were:

rtchar.cpp      rtfile.cpp      rtini.cpp       rtmath.cpp	
rtstreams.cpp   rtstring.cpp    rtsystem.cpp    rtresource.cpp

Depending on your system, any program using LibRT (e.g. RoboTour) has to 
be linked against some system libraries. These are:

- For Windows: user32.lib winmm.lib advapi32.lib
- For EPOC:    euser.lib efsrv.lib
- For Unix:    (none)


* Building RoboTour ***

RoboTour becomes an executable, of course. This is done by compiling
all the .cpp files in the "robotour" folder and linking them against
the previously generated LibRT library file.

The .cpp file which includes the main function is robotour.cpp.


* Used Compiler Defines ***

For both projects, the following defines should be set on compilation:

- The System Define: 
  For Windows: __WIN32__
  For EPOC:    __SYMBIAN32__
  For Unix:    __UNIX__

- The Compiler Define:
  For MSVC++:  __MSVC__
  For others:  (none)

- The Performance Define:
  Unchecked Arrays:  __NOCHECK__

- The RoboComTeamPrivate Define:
  If you have RBI source: __RBI__

Warning! You should only enable __NOCHECK__ for release builds, after
you have extensively tested the program!


* System specific notes: ***

- The building process on EPOC:

As usually, an ebld.bat is provided with robotour. However, since robotour
requires some more compiler defines, they have to be set before building it.

To build a WINS version (not really useful for robotour, you'd better build
a __WIN32__ version, but here goes), use:

	SET USERDEFS=/D __MSVC__
	EBLD robotour wins rel

To build a MARM version, use:

	SET USERDEFS=-D__NOCHECK__
	EBLD robotour marm rel