]> iEval git - linux-seccomp.git/blame - libseccomp/README
Bundle libseccomp 2.3.1
[linux-seccomp.git] / libseccomp / README
CommitLineData
8befd5cc
MG
1libseccomp: An Enhanced Seccomp (mode 2) Helper Library
2===============================================================================
3https://github.com/seccomp/libseccomp
4
5The libseccomp library provides an easy to use, platform independent, interface
6to the Linux Kernel's syscall filtering mechanism. The libseccomp API is
7designed to abstract away the underlying BPF based syscall filter language and
8present a more conventional function-call based filtering interface that should
9be familiar to, and easily adopted by, application developers.
10
11* Online Resources
12
13The library source repository currently lives on GitHub at the following URL:
14
15 -> https://github.com/seccomp/libseccomp
16
17The project mailing list is currently hosted on Google Groups at the URL below,
18please note that a Google account is not required to subscribe to the mailing
19list.
20
21 -> https://groups.google.com/forum/#!forum/libseccomp
22 -> https://groups.google.com/forum/#!forum/libseccomp/join
23
24* Documentation
25
26The "doc/" directory contains all of the currently available documentation,
27mostly in the form of manpages. The top level directory also contains a README
28file (this file) as well as the LICENSE, CREDITS, SUBMITTING_PATCHES, and
29CHANGELOG files.
30
31Those who are interested in contributing to the the project are encouraged to
32read the SUBMITTING_PATCHES in the top level directory.
33
34* Building and Installing the Library
35
36If you are building the libseccomp library from an official release tarball,
37you should follow the familiar three step process used by most autotools based
38applications:
39
40 # ./configure
41 # make [V=0|1]
42 # make install
43
44However, if you are building the library from sources retrieved from the source
45repository you may need to run the autogen.sh script before running configure.
46In both cases, running "./configure -h" will display a list of build-time
47configuration options.
48
49* Testing the Library
50
51There are a number of tests located in the "tests/" directory and a make target
52which can be used to help automate their execution. If you want to run the
53standard regression tests you can execute the following after building the
54library:
55
56 # make check
57
58Be warned that the test run can take a while to run and produces a lot of
59output.
60
61* Other Useful Tools
62
63The "tools/" directory includes a number of tools which may be helpful in the
64development of the library, or applications using the library. Not all of
65these tools are installed by default.
This page took 0.021714 seconds and 4 git commands to generate.