summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a4eab30
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+run_landlock - Execute a command in Landlock
+--------------------------------------------
+`run_landlock` executes a command inside a Landlock sandbox environment.
+
+The purpose of `run_landlock` is to transparently expose as much of the Landlock
+subsystem as possible to shells and other programs. `run_landlock` is a thinner
+wrapper than `landrun <https://github.com/Zouuup/landrun>`, and since it's
+written in C, it's also more portable and easier to distribute.
+
+Requirements
+------------
+Landlock must be supported and enabled on your system and must provide a
+recent-enough ABI depending on the required Landlock features.
+
+Installation
+------------
+Edit `config.mk` to match your local setup (`run_landlock` installs into the
+`/usr/local` namespace by default).
+
+Then enter the following command to build and install `run_landlock` (as root if
+necessary):
+
+ make clean install
+
+Running run_landlock
+--------------------
+Usage:
+
+ run_landlock [-h] [[-r type subject actions] ...] command [args ...]
+
+See the man page for additional details.
+
+Contact
+-------
+B. Bergeron <[email protected]>