← Back to branch summary

~ubuntu-branches/ubuntu/natty/ntop/natty

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Ludovico Cavedon, Jordan Metzmeier, Ludovico Cavedon
  • Date: 2010-12-15 20:06:19 UTC
  • mfrom: (5.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20101215200619-0ojz3iak95ihibun
Tags: 3:4.0.3+dfsg1-1
http://bugs.debian.org/522042
http://bugs.debian.org/595450
https://launchpad.net/bugs/257466
[ Jordan Metzmeier ]
* New upstream release (Closes: #522042)
* Move data files to /usr/share/ntop (Closes: #595450).
* Package architecture independent data in a separate ntop-data package.
* Use debhelper 7.
* Update Standards-Version to 3.9.1.
* Depend on python-mako.
* Do not include ntop.txt in binary packages as it is a copy of the man
  page.
* Do not include NEWS, as it is outdated.
* Switch to package source version 3.0 (quilt).
* Add password creation to debconf
* Changed init script to fix localization problems (thanks to Alejandro
  Varas <alej0varas@gmail.com>, LP: #257466)
* Remove manual update-rc.d calls from postrm and postinst. debhelper adds
  this for us.
* Add pre-depends on adduser for postinst script.
* Fix errors in the manpages: fix-manpage-errors.patch.
* Added fixes for matching active interfaces.
* Added a watch file.

[ Ludovico Cavedon ]
* Remove direct changes to upstream tree, and move them into specific patch
  files:
  - fix-manpage-errors.patch: fix typos in ntop.8.
  - dot-path.patch: fix path of /usr/bin/dot executable
* Add patches:
  - reduce-autogen-purged-files.patch: prevent agutogen.sh from reamoving
  too many files during cleanup.
  - Add build-without-ntop-darwin.patch, to fix compilation without
  ntop_darwin.c.
* No longer add faq.html, as it is not distributed in the upstream tarball.
* Use ${source:Version} in control file. Have ntop-data recommend
  ntop.
* Rename dirs to ntop.dirs and keep only empty directories that need
  to be created.
* Remove var/lib from ntop.install file, as it is empty (keeping it in
  ntop.dirs).
* Update po files.
* Breaks and Replaces instead of Conflitcs for ntop-data.
* Use a longer package description.
* Remove useless configure options from debian/rules.
* Move private shared libraries libraries in /usr/lib/ntop.
* Add change-plugin-dir.patch for adjusting plugin directory.
* Remove development files.
* Use system library for MochiKit.js.
* Rewrite DEP5 copyright file.
* Repackage upstream tarball in order to remove non-DFSG-compliant code. Add
  get-orig-source.sh script and get-orig-source target in debian/rules.
* Add explanation to README.Debian why geolocation is no longer working.
* Add avoid-copy-maxmind-db.patch to prevent copying of Geo*.dat
  files.
* Remove old unused patches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
1
1
Installation Instructions
2
2
*************************
3
3
 
4
 
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
5
 
Software Foundation, Inc.
 
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
 
5
2006, 2007, 2008 Free Software Foundation, Inc.
6
6
 
7
 
This file is free documentation; the Free Software Foundation gives
 
7
   This file is free documentation; the Free Software Foundation gives
8
8
unlimited permission to copy, distribute and modify it.
9
9
 
10
10
Basic Installation
11
11
==================
12
12
 
13
 
These are generic installation instructions.
 
13
   Briefly, the shell commands `./configure; make; make install' should
 
14
configure, build, and install this package.  The following
 
15
more-detailed instructions are generic; see the `README' file for
 
16
instructions specific to this package.
14
17
 
15
18
   The `configure' shell script attempts to guess correct values for
16
19
various system-dependent variables used during compilation.  It uses
23
26
 
24
27
   It can also use an optional file (typically called `config.cache'
25
28
and enabled with `--cache-file=config.cache' or simply `-C') that saves
26
 
the results of its tests to speed up reconfiguring.  (Caching is
 
29
the results of its tests to speed up reconfiguring.  Caching is
27
30
disabled by default to prevent problems with accidental use of stale
28
 
cache files.)
 
31
cache files.
29
32
 
30
33
   If you need to do unusual things to compile the package, please try
31
34
to figure out how `configure' could check whether to do them, and mail
35
38
may remove or edit it.
36
39
 
37
40
   The file `configure.ac' (or `configure.in') is used to create
38
 
`configure' by a program called `autoconf'.  You only need
39
 
`configure.ac' if you want to change it or regenerate `configure' using
40
 
a newer version of `autoconf'.
 
41
`configure' by a program called `autoconf'.  You need `configure.ac' if
 
42
you want to change it or regenerate `configure' using a newer version
 
43
of `autoconf'.
41
44
 
42
45
The simplest way to compile this package is:
43
46
 
44
47
  1. `cd' to the directory containing the package's source code and type
45
 
     `./configure' to configure the package for your system.  If you're
46
 
     using `csh' on an old version of System V, you might need to type
47
 
     `sh ./configure' instead to prevent `csh' from trying to execute
48
 
     `configure' itself.
 
48
     `./configure' to configure the package for your system.
49
49
 
50
 
     Running `configure' takes awhile.  While running, it prints some
51
 
     messages telling which features it is checking for.
 
50
     Running `configure' might take a while.  While running, it prints
 
51
     some messages telling which features it is checking for.
52
52
 
53
53
  2. Type `make' to compile the package.
54
54
 
67
67
     all sorts of other programs in order to regenerate files that came
68
68
     with the distribution.
69
69
 
 
70
  6. Often, you can also type `make uninstall' to remove the installed
 
71
     files again.
 
72
 
70
73
Compilers and Options
71
74
=====================
72
75
 
73
 
Some systems require unusual options for compilation or linking that the
74
 
`configure' script does not know about.  Run `./configure --help' for
75
 
details on some of the pertinent environment variables.
 
76
   Some systems require unusual options for compilation or linking that
 
77
the `configure' script does not know about.  Run `./configure --help'
 
78
for details on some of the pertinent environment variables.
76
79
 
77
80
   You can give `configure' initial values for configuration parameters
78
81
by setting variables in the command line or in the environment.  Here
79
82
is an example:
80
83
 
81
 
     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 
84
     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
82
85
 
83
86
   *Note Defining Variables::, for more details.
84
87
 
85
88
Compiling For Multiple Architectures
86
89
====================================
87
90
 
88
 
You can compile the package for more than one kind of computer at the
 
91
   You can compile the package for more than one kind of computer at the
89
92
same time, by placing the object files for each architecture in their
90
 
own directory.  To do this, you must use a version of `make' that
91
 
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 
93
own directory.  To do this, you can use GNU `make'.  `cd' to the
92
94
directory where you want the object files and executables to go and run
93
95
the `configure' script.  `configure' automatically checks for the
94
96
source code in the directory that `configure' is in and in `..'.
95
97
 
96
 
   If you have to use a `make' that does not support the `VPATH'
97
 
variable, you have to compile the package for one architecture at a
98
 
time in the source code directory.  After you have installed the
99
 
package for one architecture, use `make distclean' before reconfiguring
100
 
for another architecture.
 
98
   With a non-GNU `make', it is safer to compile the package for one
 
99
architecture at a time in the source code directory.  After you have
 
100
installed the package for one architecture, use `make distclean' before
 
101
reconfiguring for another architecture.
 
102
 
 
103
   On MacOS X 10.5 and later systems, you can create libraries and
 
104
executables that work on multiple system types--known as "fat" or
 
105
"universal" binaries--by specifying multiple `-arch' options to the
 
106
compiler but only a single `-arch' option to the preprocessor.  Like
 
107
this:
 
108
 
 
109
     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 
110
                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 
111
                 CPP="gcc -E" CXXCPP="g++ -E"
 
112
 
 
113
   This is not guaranteed to produce working output in all cases, you
 
114
may have to build one architecture at a time and combine the results
 
115
using the `lipo' tool if you have problems.
101
116
 
102
117
Installation Names
103
118
==================
104
119
 
105
 
By default, `make install' installs the package's commands under
 
120
   By default, `make install' installs the package's commands under
106
121
`/usr/local/bin', include files under `/usr/local/include', etc.  You
107
122
can specify an installation prefix other than `/usr/local' by giving
108
123
`configure' the option `--prefix=PREFIX'.
125
140
Optional Features
126
141
=================
127
142
 
128
 
Some packages pay attention to `--enable-FEATURE' options to
 
143
   Some packages pay attention to `--enable-FEATURE' options to
129
144
`configure', where FEATURE indicates an optional part of the package.
130
145
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
131
146
is something like `gnu-as' or `x' (for the X Window System).  The
137
152
you can use the `configure' options `--x-includes=DIR' and
138
153
`--x-libraries=DIR' to specify their locations.
139
154
 
 
155
Particular systems
 
156
==================
 
157
 
 
158
   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
 
159
CC is not installed, it is recommended to use the following options in
 
160
order to use an ANSI C compiler:
 
161
 
 
162
     ./configure CC="cc -Ae"
 
163
 
 
164
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
 
165
 
 
166
   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
 
167
parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
 
168
a workaround.  If GNU CC is not installed, it is therefore recommended
 
169
to try
 
170
 
 
171
     ./configure CC="cc"
 
172
 
 
173
and if that doesn't work, try
 
174
 
 
175
     ./configure CC="cc -nodtk"
 
176
 
140
177
Specifying the System Type
141
178
==========================
142
179
 
143
 
There may be some features `configure' cannot figure out automatically,
144
 
but needs to determine by the type of machine the package will run on.
145
 
Usually, assuming the package is built to be run on the _same_
146
 
architectures, `configure' can figure that out, but if it prints a
147
 
message saying it cannot guess the machine type, give it the
 
180
   There may be some features `configure' cannot figure out
 
181
automatically, but needs to determine by the type of machine the package
 
182
will run on.  Usually, assuming the package is built to be run on the
 
183
_same_ architectures, `configure' can figure that out, but if it prints
 
184
a message saying it cannot guess the machine type, give it the
148
185
`--build=TYPE' option.  TYPE can either be a short name for the system
149
186
type, such as `sun4', or a canonical name which has the form:
150
187
 
170
207
Sharing Defaults
171
208
================
172
209
 
173
 
If you want to set default values for `configure' scripts to share, you
174
 
can create a site shell script called `config.site' that gives default
175
 
values for variables like `CC', `cache_file', and `prefix'.
 
210
   If you want to set default values for `configure' scripts to share,
 
211
you can create a site shell script called `config.site' that gives
 
212
default values for variables like `CC', `cache_file', and `prefix'.
176
213
`configure' looks for `PREFIX/share/config.site' if it exists, then
177
214
`PREFIX/etc/config.site' if it exists.  Or, you can set the
178
215
`CONFIG_SITE' environment variable to the location of the site script.
181
218
Defining Variables
182
219
==================
183
220
 
184
 
Variables not defined in a site shell script can be set in the
 
221
   Variables not defined in a site shell script can be set in the
185
222
environment passed to `configure'.  However, some packages may run
186
223
configure again during the build, and the customized values of these
187
224
variables may be lost.  In order to avoid this problem, you should set
190
227
     ./configure CC=/usr/local2/bin/gcc
191
228
 
192
229
causes the specified `gcc' to be used as the C compiler (unless it is
193
 
overridden in the site shell script).  Here is a another example:
194
 
 
195
 
     /bin/bash ./configure CONFIG_SHELL=/bin/bash
196
 
 
197
 
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
198
 
configuration-related scripts to be executed by `/bin/bash'.
 
230
overridden in the site shell script).
 
231
 
 
232
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 
233
an Autoconf bug.  Until the bug is fixed you can use this workaround:
 
234
 
 
235
     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
199
236
 
200
237
`configure' Invocation
201
238
======================
202
239
 
203
 
`configure' recognizes the following options to control how it operates.
 
240
   `configure' recognizes the following options to control how it
 
241
operates.
204
242
 
205
243
`--help'
206
244
`-h'
207
 
     Print a summary of the options to `configure', and exit.
 
245
     Print a summary of all of the options to `configure', and exit.
 
246
 
 
247
`--help=short'
 
248
`--help=recursive'
 
249
     Print a summary of the options unique to this package's
 
250
     `configure', and exit.  The `short' variant lists options used
 
251
     only in the top level, while the `recursive' variant lists options
 
252
     also present in any nested packages.
208
253
 
209
254
`--version'
210
255
`-V'
231
276
     Look for the package's source code in directory DIR.  Usually
232
277
     `configure' can determine that directory automatically.
233
278
 
 
279
`--prefix=DIR'
 
280
     Use DIR as the installation prefix.  *Note Installation Names::
 
281
     for more details, including other options available for fine-tuning
 
282
     the installation locations.
 
283
 
 
284
`--no-create'
 
285
`-n'
 
286
     Run the configure checks, but stop before creating any output
 
287
     files.
 
288
 
234
289
`configure' also accepts some other, not widely useful, options.  Run
235
290
`configure --help' for more details.
236
291