diff options
author | Paul Moore <paul@paul-moore.com> | 2017-01-13 15:56:35 -0500 |
---|---|---|
committer | Paul Moore <paul@paul-moore.com> | 2017-01-13 16:17:04 -0500 |
commit | 7de6957444be9f2fbe09fd15c7ba81ffa4eb0ad8 (patch) | |
tree | 813b5ed6534ab7326824d963566f6af97b021e0a /README.md | |
parent | 937e774d8ccfd063a601f49ef46769de3926b62d (diff) | |
download | libseccomp-7de6957444be9f2fbe09fd15c7ba81ffa4eb0ad8.tar.gz |
doc: convert the README to Markdown for better use on GitHub
Signed-off-by: Paul Moore <paul@paul-moore.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..abe0561 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +An Enhanced Seccomp (seccomp-bpf) Helper Library +=============================================================================== +https://github.com/seccomp/libseccomp + +The libseccomp library provides an easy to use, platform independent, interface +to the Linux Kernel's syscall filtering mechanism. The libseccomp API is +designed to abstract away the underlying BPF based syscall filter language and +present a more conventional function-call based filtering interface that should +be familiar to, and easily adopted by, application developers. + +## Online Resources + +The library source repository currently lives on GitHub at the following URL: + +* https://github.com/seccomp/libseccomp + +The project mailing list is currently hosted on Google Groups at the URL below, +please note that a Google account is not required to subscribe to the mailing +list. + +* https://groups.google.com/forum/#!forum/libseccomp +* https://groups.google.com/forum/#!forum/libseccomp/join + +## Documentation + +The "doc/" directory contains all of the currently available documentation, +mostly in the form of manpages. The top level directory also contains a README +file (this file) as well as the LICENSE, CREDITS, SUBMITTING_PATCHES, and +CHANGELOG files. + +Those who are interested in contributing to the the project are encouraged to +read the SUBMITTING_PATCHES in the top level directory. + +## Building and Installing the Library + +If you are building the libseccomp library from an official release tarball, +you should follow the familiar three step process used by most autotools based +applications: + + # ./configure + # make [V=0|1] + # make install + +However, if you are building the library from sources retrieved from the source +repository you may need to run the autogen.sh script before running configure. +In both cases, running "./configure -h" will display a list of build-time +configuration options. + +## Testing the Library + +There are a number of tests located in the "tests/" directory and a make target +which can be used to help automate their execution. If you want to run the +standard regression tests you can execute the following after building the +library: + + # make check + +Be warned that the test run can take a while to run and produces a lot of +output. + +## Other Useful Tools + +The "tools/" directory includes a number of tools which may be helpful in the +development of the library, or applications using the library. Not all of +these tools are installed by default. |