@@ -5,24 +5,55 @@ sio2jail
55building
66--------
77
8- You need a CMake, a C/C++ compiler with multilib support, python2 and a
9- number of libraries (see below). To build sio2jail and install binary
10- files into ./bin/ directory run:
8+ You need a CMake, a C/C++ compiler with multilib support and python2. Any
9+ external libraries sio2jail use (see below) can be either installed
10+ system-wide, or downloaded and built during the process. To build sio2jail and
11+ install files to ~ /local directory run:
1112
1213 mkdir build && cd build
1314
14- cmake -DCMAKE_BUILD_TYPE=Release ..
15+ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$HOME/local ..
1516 make && make install
1617
17- Our sio2jail uses some external libraries:
18+ Our sio2jail uses some external libraries and programs :
1819 * libcap
1920 * libseccomp (>= 2.3.0)
2021 * libtclap
22+ * scdoc (for generating man pages)
2123
22- which you can install (e.g. on Debian) with:
24+ some of which you can install (e.g. on Debian) with:
2325
2426 apt-get install libcap-dev libtclap-dev libseccomp-dev
2527
28+ By default sio2jail searches for this libraries in system paths and in case they
29+ aren't found their sources are downloaded and libraries are built in working
30+ directory. You can tune this behaviour with cmake options:
31+
32+ -D<DEPENDENCY>_PREFIX=<PATH>
33+ -D<DEPENDENCY>_BUILD_OWN=YES|NO
34+
35+ where DEPENDENCY is one of
36+ * LIBCAP
37+ * LIBSECCOMP
38+ * LIBTCLAP
39+ * SCDOC
40+
41+ You can also control wheather to generate man pages with option (YES by default):
42+
43+ -DWITH_DOCS=YES|NO
44+
45+ and wheather to install boxes scripts (NO by default):
46+
47+ -DWITH_BOXES=YES|NO
48+
49+ For example, to skip man pages, use libtclap from /opt/tclap directory and
50+ ignore system libseccomp run:
51+
52+ cmake -DWITH_DOCS=NO -DLIBTCLAP_PREFIX=/opt/tclap -DLIBSECCOMP_BUILD_OWN=YES ..
53+
54+ running
55+ -------
56+
2657You may need to run
2758
2859 sysctl -w kernel.perf_event_paranoid=-1
@@ -34,9 +65,6 @@ to run sio2jail.
3465running tests
3566-------------
3667
37- To run test suit, firstly build project and install files into ./bin/
38- directory. Then then run ` main.py ` executable, e.g:
39-
40- ./test/testsuits/main.py
68+ To run test suit use 'check' target, e.g in build directory run:
4169
42- Remember that many tests will work only on 3. \* kernels versions.
70+ make check
0 commit comments