about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSpencer Baugh <sbaugh@catern.com>2018-01-31T22·47+0000
committerSpencer Baugh <sbaugh@catern.com>2018-01-31T22·47+0000
commite5432574e2d54388eb52292da540f2d4de07e9dc (patch)
tree3f8f75c342a7cc9b268586ed40d32459ee42a17c
parentc129fc6ee8a8bf6de633dc1b91869a0c428ca75c (diff)
document ability to set NIX_REMOTE=unix://path/to/socket
-rw-r--r--doc/manual/command-ref/env-common.xml2
-rw-r--r--src/libstore/store-api.hh3
2 files changed, 5 insertions, 0 deletions
diff --git a/doc/manual/command-ref/env-common.xml b/doc/manual/command-ref/env-common.xml
index a83aeaf2e575..361d3e2b0330 100644
--- a/doc/manual/command-ref/env-common.xml
+++ b/doc/manual/command-ref/env-common.xml
@@ -154,6 +154,8 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
   <literal>daemon</literal> if you want to use the Nix daemon to
   execute Nix operations. This is necessary in <link
   linkend="ssec-multi-user">multi-user Nix installations</link>.
+  If the Nix daemon's Unix socket is at some non-standard path,
+  this variable should be set to <literal>unix://path/to/socket</literal>.
   Otherwise, it should be left unset.</para></listitem>
 
 </varlistentry>
diff --git a/src/libstore/store-api.hh b/src/libstore/store-api.hh
index c0e735cd314c..b21d3dd8a93b 100644
--- a/src/libstore/store-api.hh
+++ b/src/libstore/store-api.hh
@@ -705,6 +705,9 @@ void removeTempRoots();
    * ‘daemon’: The Nix store accessed via a Unix domain socket
      connection to nix-daemon.
 
+   * ‘unix://<path>’: The Nix store accessed via a Unix domain socket
+     connection to nix-daemon, with the socket located at <path>.
+
    * ‘auto’ or ‘’: Equivalent to ‘local’ or ‘daemon’ depending on
      whether the user has write access to the local Nix
      store/database.