File: README

package info (click to toggle)
cipe 1.5.4free-9
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 908 kB
  • ctags: 730
  • sloc: ansic: 5,976; sh: 358; makefile: 315; asm: 200; perl: 45
file content (112 lines) | stat: -rw-r--r-- 5,265 bytes parent folder | download | duplicates (2)
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
                                Debian CIPE
                                README File


This is the Debian GNU/Linux prepackaged version of the CIPE package.
This readme handles two subjects: building your own CIPE modules and
the differences between Debian CIPE and the upstream CIPE configuration.

1. For building your own CIPE modules

By default, debian/rules will set the kernel-specific options from the
kernel source tree in /usr/src/linux.  

You need to have a complete linux source tree for your kernel, not
just an up-to-date kernel image, to compile CIPE.  The CIPE module
contains some references to kernel source files.  While you may want to
build a new kernel to remove unnecessary drivers, installing CIPE does
not require you to do so.

To recompile CIPE:

     The process of recompiling a kernel and the CIPE module has been
     greatly simplified by Debian's kernel-package package (available in
     Debian's main distribution).  This package contains the make-kpkg
     utility, which is used to create the kernel related Debian packages.
     It is highly recommended that you use this utility.

     If you are using make-kpkg:

     1)   Ensure that the cipe source tree is in a subdirectory of the
          /usr/src/modules directory.  Use a symbolic link to the actual
          source tree if you must.  Note that the cipe-source package
          places the cipe sources in /usr/src/cipe.tar.gz - just untar
          this to /usr/src and you'll be allright.  The existing modules/cipe
          directory is not overwritten upon installation in case you did
          local changes to the tree.

     2)   As root, go to the the base of the kernel source tree (usually
          the /usr/src/linux directory).  If you are building a kernel that
          is custom configured to your specifications, go ahead and
          configure the kernel with `make config,' `make menuconfig,' or
          `make xconfig.'

     3)   To build a new kernel-image package, execute:
               make-kpkg --revision number kernel_image
          This will generate a kernel-image-<kernel version> deb file in
          the parent directory.  Here number (the argument supplied after
          the --revision flag) is a version number for your custom built
          kernel.  You may also do this on the fly by setting the
          DEBIAN_REVISION environmental variable.  It is important that you
          choose the revision number in such a way that a generic kernel-
          image package will not override the custom package while using
          dselect (or `dpkg -BOGiE').  I recommend a two-level scheme where
          the major level starts with a letter.  One such scheme is your
          (short) host name followed by a dot (.) and a number.  For
          example, if your machine is named myhost, you would use
          --revision myhost.1 in the command line.  If you had to rebuild
          your custom kernel, you would use --revision myhost.2 and so on.
          See /usr/share/doc/kernel-package/README.gz for more information
          on revision numbers.

     3)   To build CIPE, execute:
               make-kpkg --revision number modules_image
          where number is the same revision number used to build the
          kernel-image package in the previous step. This will generate a
          cipe-<kernel version> deb file in the parent directory.

     4)   Install the two newly created deb files (you can use `dpkg -i
          file').

     If you are not using make-kpkg:

     If your kernel is compiled with CONFIG_MODVERSIONS enabled, for kernel
     symbol version checking, the configure script will check for the
     existence of /usr/include/linux/modversions.h, the symbol version
     database.  This is created by running `make dep' (in addition to `make
     config) in the kernel source tree.

     1)   Ensure that the kernel source tree is in the /usr/src/linux
          directory and ensure that it is configured (execute `make config
          dep' in the /usr/src/linux directory).

     2)   Go to the cipe root directory (/usr/src/modules/cipe in
          the cipe-source package).

     3)   Execute as root `debian/rules binary-modules.'  This will
          generate a cipe-<kernel version> deb file in the parent
          directory.

     Note: The location of the kernel source tree may be specified by
     supplying the KSRC variable as a command line option. In this case
     you should also specify the kernel version with KVERS.  For example,
     if the kernel source is located in /usr/local/src/kernel-2.0.0, the
     proper command would be
          debian/rules KSRC=/usr/local/src/kernel-2.0.0 KVERS=2.0.0


2. Debian CIPE configuration

Instead of /etc/cipe/options, use /etc/cipe/peers/foo (replace foo
with e.g. the short hostname of the machine at the other end of the
encrypted link). The init.d script will take care of starting/stopping
all the tunnels.


3. Credit where credit is due.

First part of this document is almost an exact copy of the
documentation for the alsadriver package made by Wichert Akkerman
<wakkerma@debian.org>, which is almost an exact copy of the
documentation for the pcmcia packages made by Brian Mays
<brian@debian.org>.