diff options
Diffstat (limited to 'vendor/github.com/seccomp/libseccomp-golang/README.md')
| -rw-r--r-- | vendor/github.com/seccomp/libseccomp-golang/README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/vendor/github.com/seccomp/libseccomp-golang/README.md b/vendor/github.com/seccomp/libseccomp-golang/README.md new file mode 100644 index 000000000..27423f2d9 --- /dev/null +++ b/vendor/github.com/seccomp/libseccomp-golang/README.md @@ -0,0 +1,51 @@ + +=============================================================================== +https://github.com/seccomp/libseccomp-golang + +[](https://travis-ci.org/seccomp/libseccomp-golang) + +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. + +The libseccomp-golang library provides a Go based interface to the libseccomp +library. + +## Online Resources + +The library source repository currently lives on GitHub at the following URLs: + +* https://github.com/seccomp/libseccomp-golang +* 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/d/forum/libseccomp + +Documentation is also available at: + +* https://godoc.org/github.com/seccomp/libseccomp-golang + +## Installing the package + +The libseccomp-golang bindings require at least Go v1.2.1 and GCC v4.8.4; +earlier versions may yield unpredictable results. If you meet these +requirements you can install this package using the command below: + + # go get github.com/seccomp/libseccomp-golang + +## Testing the Library + +A number of tests and lint related recipes are provided in the Makefile, if +you want to run the standard regression tests, you can excute the following: + + # make check + +In order to execute the 'make lint' recipe the 'golint' tool is needed, it +can be found at: + +* https://github.com/golang/lint |