Don't use 'release' macro.
[platform/upstream/ebtables.git] / INSTALL
1 FOLLOW THESE SIMPLE GUIDELINES:
2 -------------------------------
3
4 Compiling the source code:
5 %make
6 Put the files in the right directories:
7 %make install
8
9 If you are using the CVS code or need your own kernel includes, do this
10 instead (change the include directory to the appropriate one):
11 %make install KERNEL_INCLUDES=/usr/src/linux/include
12
13 If you want to make a static binary for ebtables, containing all the
14 extensions, without shared libraries, do this (this will make a
15 binary called 'static', which you can rename):
16 %make static
17
18 WHAT GETS INSTALLED AND WHAT OPTIONS ARE AVAILABLE?
19 ---------------------------------------------------
20
21 - The ebtables manual gets installed in /usr/local/man/man8
22   To put the manual somewhere else, include MANDIR=<<man-path/man>> as
23   option on the command line.
24   The Makefile will append /man8/ebtables.8.
25 - ethertypes is by default placed in /etc/, if you
26   want to change this, include ETHERTYPESPATH=<<path>>.
27 - The userspace programs ebtables ebtables-save and ebtables-restore are
28   are copied by default to /usr/local/sbin/ebtables. If you want to put
29   the executables somewhere else, include BINPATH=<<path>>.
30 - The ebtables initialisation file (enabling use of 'service ebtables') is
31   copied to /etc/rc.d/init.d (change with option INITDIR)
32 - The ebtables configuration file (ebtables-config) is copied to /etc/sysconfig
33 - ebtables can use a lock file to enable concurrent execution of the ebtables
34   tool. The standard location of the lock file is /var/lib/ebtables/lock.
35   Include LOCKFILE=<<path-to-file>> if you want to use another file.
36
37 That's all
38
39 You can also use a base directory different from the root directory (/),
40 using the DESTDIR option. See the Makefile for more details.
41
42 You might need to set LDFLAGS=-Wl,-no-as-needed to build ebtables correctly
43 on your system.
44
45 ADDITIONAL PROGRAMS:
46 ----------------------
47 -- examples/ulog/test_ulog.c --
48
49 Contains an example to receive and parse netlink messages containing
50 packets seen by the ebtables ulog watcher.
51
52 Compile with:
53 %make test_ulog KERNEL_INCLUDES=/usr/src/linux/include
54
55 Usage:
56 %examples/ulog/test_ulog NETLINK_GROUP
57 %ebtables -A chain --ulog-nlgroup NETLINK_GROUP
58
59 -- examples/perf_test/perf_test --
60
61 A test script to compare the performance for the different ways to
62 construct an ebtables table. This is deprecated and should probably
63 be ignored.