forked from osmocom/wireshark
* Installation documentation updates
svn path=/trunk/; revision=141
This commit is contained in:
Gerald Combs
parent
369f3fdad5
commit
2301bf5e10
207
INSTALL
207
INSTALL
|
|
@ -1,182 +1,47 @@
|
|||
Basic Installation
|
||||
==================
|
||||
Installation Checklist
|
||||
======================
|
||||
|
||||
These are generic installation instructions.
|
||||
[ ] 0. This is alpha software. Beware.
|
||||
|
||||
[ ] 1. Make sure you have GTK+ installed. Try running 'gtk-config
|
||||
--version'. If you need to install/reinstall GTK, you can find
|
||||
it at
|
||||
|
||||
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').
|
||||
http://www.gtk.org .
|
||||
|
||||
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.
|
||||
Ethereal should work with the latest stable (1.0.x) version, as
|
||||
well as the development (1.1.x) versions.
|
||||
|
||||
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'.
|
||||
[ ] 2. Make sure you have libpcap installed. The latest version can be
|
||||
found at
|
||||
|
||||
ftp://ftp.ee.lbl.gov .
|
||||
|
||||
The simplest way to compile this package is:
|
||||
Make sure you install the headers ('make install-incl') when you
|
||||
install the library.
|
||||
|
||||
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.
|
||||
If you installed libpcap from a binary package, you may have to
|
||||
install a "development" package; for example, there's
|
||||
apparently a "libpcap0" Debian package, but it just includes a
|
||||
shared library, a copyright notice, changelog files, and a
|
||||
README file - you also need to install a "libpcap-dev" package
|
||||
to get header files, a non-shared library, and the man page.
|
||||
Similarly, Red Hat users will need to install a "libpcap-devel"
|
||||
.rpm to go along with the "libpcap" .rpm.
|
||||
|
||||
Running `configure' takes awhile. While running, it prints some
|
||||
messages telling which features it is checking for.
|
||||
[ ] 3. Run './configure' in the Ethereal distribution directory.
|
||||
Running './configure --help' displays a list of options.
|
||||
The file 'INSTALL.configure' contains general instructions for
|
||||
using 'configure' and 'make'.
|
||||
|
||||
2. Type `make' to compile the package.
|
||||
Ethereal installs a support file (manuf) in /usr/local/etc by
|
||||
default. You can change this location with the --sysconfdir
|
||||
option.
|
||||
|
||||
3. Optionally, type `make check' to run any self-tests that come with
|
||||
the package.
|
||||
[ ] 4. Run 'make'. Hopefully, you won't run into any problems.
|
||||
|
||||
4. Type `make install' to install the programs and any data files and
|
||||
documentation.
|
||||
[ ] 5. Run './ethereal', and make sure things are working. You must
|
||||
have root privileges in order to capture live data.
|
||||
|
||||
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:
|
||||
CC=c89 CFLAGS=-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
|
||||
=================
|
||||
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
`configure', where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
|
||||
is something like `gnu-as' or `x' (for the X Window System). The
|
||||
`README' should mention any `--enable-' and `--with-' options that the
|
||||
package recognizes.
|
||||
|
||||
For packages that use the X Window System, `configure' can usually
|
||||
find the X include and library files automatically, but if it doesn't,
|
||||
you can use the `configure' options `--x-includes=DIR' and
|
||||
`--x-libraries=DIR' to specify their locations.
|
||||
|
||||
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.
|
||||
[ ] 6. Run 'make install'. If you wish to install the man page, run
|
||||
'make install-man'. You're done.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,182 @@
|
|||
Basic Installation
|
||||
==================
|
||||
|
||||
These are generic installation instructions.
|
||||
|
||||
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:
|
||||
CC=c89 CFLAGS=-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
|
||||
=================
|
||||
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
`configure', where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
|
||||
is something like `gnu-as' or `x' (for the X Window System). The
|
||||
`README' should mention any `--enable-' and `--with-' options that the
|
||||
package recognizes.
|
||||
|
||||
For packages that use the X Window System, `configure' can usually
|
||||
find the X include and library files automatically, but if it doesn't,
|
||||
you can use the `configure' options `--x-includes=DIR' and
|
||||
`--x-libraries=DIR' to specify their locations.
|
||||
|
||||
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.
|
||||
104
README
104
README
|
|
@ -1,9 +1,9 @@
|
|||
General Information
|
||||
------- -----------
|
||||
|
||||
Ethereal is a network traffic analyzer for Unix-ish operating systems.
|
||||
It is based on GTK+, a graphical user interface library, and libpcap,
|
||||
a packet capture and filtering library.
|
||||
Ethereal is a network traffic analyzer for Unix and Unix-like operating
|
||||
systems. It is based on GTK+, a graphical user interface library,
|
||||
and libpcap, a packet capture and filtering library.
|
||||
|
||||
The official home of Ethereal is
|
||||
|
||||
|
|
@ -17,96 +17,30 @@ The latest distribution can be found in the subdirectory
|
|||
Installation
|
||||
------------
|
||||
|
||||
Ethereal is known to compile and run under Linux (2.0.35) and Solaris
|
||||
(2.6). It should run on other systems without too much trouble.
|
||||
Ethereal is known to compile and run on the following systems:
|
||||
|
||||
- Linux (2.0.x)
|
||||
- Solaris (2.5.1, 2.6)
|
||||
- FreeBSD (2.2.5, 2.2.6)
|
||||
|
||||
It should run on other systems without too much trouble.
|
||||
|
||||
|
||||
Installation Checklist (Short):
|
||||
|
||||
[ ] 1. Unpack the archive.
|
||||
|
||||
[ ] 2. Run './configure; make; make install; make install-man'.
|
||||
If there are any problems, read on:
|
||||
|
||||
|
||||
Installation Checklist (Long):
|
||||
|
||||
[ ] 0. This is alpha software. Beware.
|
||||
|
||||
[ ] 1. Make sure you have GTK+ installed. Try running 'gtk-config
|
||||
--version'. If you need to install/reinstall GTK, you can find
|
||||
it at
|
||||
|
||||
http://www.gtk.org .
|
||||
|
||||
Ethereal should work with the latest stable (1.0.x) version, but
|
||||
I've had reports that it doesn't compile with the development
|
||||
(1.1.x) tree.
|
||||
|
||||
[ ] 2. Make sure you have libpcap installed. The latest version can be
|
||||
found at
|
||||
|
||||
ftp://ftp.ee.lbl.gov .
|
||||
|
||||
Make sure you install the headers ('make install-incl') when you
|
||||
install the library.
|
||||
|
||||
[ ] 3. Run './configure' in the Ethereal distribution directory.
|
||||
Running './configure --help' displays a list of options.
|
||||
The file 'INSTALL' contains general instructions for running
|
||||
'configure'.
|
||||
|
||||
Ethereal installs a support file (manuf) in /usr/local/etc by
|
||||
default. You can change this location with the --sysconfdir
|
||||
option.
|
||||
|
||||
[ ] 4. Run 'make'. Hopefully, you won't run into any problems.
|
||||
|
||||
[ ] 5. Run './ethereal', and make sure things are working. You must
|
||||
have root privileges in order to capture live data.
|
||||
|
||||
[ ] 6. Run 'make install'. If you wish to install the man page, run
|
||||
'make install-man'. You're done.
|
||||
|
||||
Full installation instructions can be found in the INSTALL file.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
In order to capture packets from the network, you need to be running
|
||||
as root. Although it might be tempting to make the Ethereal executable
|
||||
setuid root, please don't - alpha code is by nature not very robust, and
|
||||
liable to contain security holes.
|
||||
as root, or have access to the appropriate entry under /dev if your
|
||||
system is so inclined (BSD-derived systems and Solaris typically fall
|
||||
into this category. Although it might be tempting to make the
|
||||
Ethereal executable setuid root, please don't - alpha code is by nature
|
||||
not very robust, and liable to contain security holes.
|
||||
|
||||
The filtering mechanism is far from complete. Until the interface
|
||||
solidifies, here's a description of what each component of the filter
|
||||
dialog:
|
||||
|
||||
- 'Filter name' entry: Gives a name to the filter you are about to create
|
||||
or modify, e.g. 'Web and DNS traffic'
|
||||
|
||||
- 'Filter string' entry: The text describing the filtering action to
|
||||
take. It must have the same format as tcpdump filter strings (both
|
||||
programs use the same underlying library), e.g.
|
||||
|
||||
'tcp port 80 or tcp port 443 or port 53'
|
||||
|
||||
- 'New' button: If there is text in the two entry boxes, adds it to the
|
||||
list.
|
||||
|
||||
- 'Change' button: Modifies the currently selected list item to match
|
||||
what's in the two entry boxes.
|
||||
|
||||
- 'Copy' button: Makes a copy of the currently-selected list item.
|
||||
|
||||
- 'Delete' button: Deletes the currently-selected list item.
|
||||
|
||||
- 'OK' button: Sets the selected list item as the active filter. If
|
||||
nothing is selected, turns filtering off.
|
||||
|
||||
- 'Save' button: Saves the current filter list in
|
||||
$HOME/.ethereal/filters.
|
||||
|
||||
- 'Cancel' button: Closes the window without making changes.
|
||||
Please consult the man page for a description of each command-line
|
||||
option and interface feature.
|
||||
|
||||
|
||||
Multiple File Types
|
||||
|
|
|
|||
Loading…
Reference in New Issue