about summary refs log tree commit diff
path: root/src/nix-worker/help.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/nix-worker/help.txt')
-rw-r--r--src/nix-worker/help.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/nix-worker/help.txt b/src/nix-worker/help.txt
new file mode 100644
index 000000000000..b4583cb7e495
--- /dev/null
+++ b/src/nix-worker/help.txt
@@ -0,0 +1,10 @@
+Usage: nix-worker [OPTIONS...] [--daemon | --slave]
+
+`nix-worker' is a helper program used to implement secure, multi-user
+Nix stores.  In `--daemon' mode, it goes into the background and waits
+for incoming connections on a Unix domain socket, and forks a process
+for each connection to perform the Nix store operations requested by
+the caller.  In `--slave' mode, `nix-worker' is called directly, and
+the caller and the worker communicate with each other over
+stdin/stdout.  In this mode, the `nix-worker' program should have
+appropriate setuid privileges.