summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew G. Morgan <morgan@kernel.org>2021-06-22 20:08:35 -0700
committerAndrew G. Morgan <morgan@kernel.org>2021-06-22 20:08:35 -0700
commit8c6c3628061dadc58bc6a3ec66b627f8412797ce (patch)
tree992d48691a2577f6a4ce2d6d4566f47f4773037d
parent5fabea8cc501b548df400d3d694ce71870237c07 (diff)
downloadlibcap2-8c6c3628061dadc58bc6a3ec66b627f8412797ce.tar.gz
Minor edits of README.
Mostly be clear that the upstream git repository is in the libs subdirectory tree on kernel.org. (I keep coming across folk referring to the the morgan one and I mostly forget to update that one these days.) Signed-off-by: Andrew G. Morgan <morgan@kernel.org>
-rw-r--r--README46
1 files changed, 27 insertions, 19 deletions
diff --git a/README b/README
index 6ba482c..a3f5123 100644
--- a/README
+++ b/README
@@ -5,45 +5,53 @@ Natively supported languages are C/C++ and Go.
This library would not have been possible without the help of
- Aleph1, Roland Buresund and Andrew Main, Alexander Kjeldaas.
+ Aleph1, Roland Buresund and Andrew Main, Alexander Kjeldaas.
More information on capabilities in the Linux kernel, links to the
official git repostitory for libcap, release notes and how to report
bugs can be found at:
- http://sites.google.com/site/fullycapable/
+ http://sites.google.com/site/fullycapable/
+
+The primary upstream git repostitory is this one:
+
+ https://git.kernel.org/pub/scm/libs/libcap/libcap.git/
# BUILDING AND INSTALLATION
- $ make
+ $ make
- builds the library and the programs that are expected
- to work on your system. For example, if you have
- Linux-PAM installed, pam_cap is built. A golang
- installation is required to build the Go packages.
+ builds the library and the programs that are expected to work
+ on your system. For example, if you have Linux-PAM installed,
+ pam_cap is built. A golang installation is required to build
+ the Go packages.
- $ make test
+ $ make test
- runs all of the tests not requiring privilege
+ runs all of the tests not requiring privilege
- $ make sudotest
+ $ make sudotest
- runs all of the tests including those that require privilege.
+ runs all of the tests including those that require privilege.
- $ sudo make install
+ $ sudo make install
- default installs the library libcap.XX.Y in /lib[64]/
- the binaries in /sbin/
- the header files in /usr/include
- the {libcap,libpsx}.pc files in /usr/lib[64]/pkgconfig
- the Go packages (if built) under /usr/share/gocode/src
+ default installs the library libcap.XX.Y in /lib[64]/
+ the binaries in /sbin/
+ the header files in /usr/include
+ the {libcap,libpsx}.pc files in /usr/lib[64]/pkgconfig
+ the Go packages (if built) under /usr/share/gocode/src
-For some example C programs look in the progs/ directory. Specifically,
-capsh, getpcaps, setcap and getcap.
+For some example C programs look in the progs/ directory.
+Specifically, capsh, getpcaps, setcap and getcap. There are some C
+tests in the tests/ directory.
Go example programs are to be found in the goapps/ directory. There
are also some more complicated integration tests in the go/ directory.
+There are also some oddball experimental things in the contrib/
+directory, but they are mostly curiosities.
+
Cheers
Andrew G. Morgan <morgan@kernel.org>