* Document the --include-outputs option.

This commit is contained in:
Eelco Dolstra 2011-11-23 15:39:02 +00:00
parent d5ac78e0d6
commit 10e2b2b79e
1 changed files with 18 additions and 9 deletions

View File

@ -26,6 +26,7 @@
<arg><option>--gzip</option></arg> <arg><option>--gzip</option></arg>
<arg><option>--bzip2</option></arg> <arg><option>--bzip2</option></arg>
<arg><option>--xz</option></arg> <arg><option>--xz</option></arg>
<arg><option>--include-outputs</option></arg>
<arg choice='plain'> <arg choice='plain'>
<arg><replaceable>user@</replaceable></arg><replaceable>machine</replaceable> <arg><replaceable>user@</replaceable></arg><replaceable>machine</replaceable>
</arg> </arg>
@ -86,15 +87,16 @@ those paths. If this bothers you, use
<listitem><para>Let the sending machine cryptographically sign the <listitem><para>Let the sending machine cryptographically sign the
dump of each path with the key in dump of each path with the key in
<filename>/nix/etc/nix/signing-key.sec</filename>. If the user on <filename><replaceable>sysconfdir</replaceable>/nix/signing-key.sec</filename>.
the target machine does not have direct access to the Nix store If the user on the target machine does not have direct access to
(i.e., if the target machine has a multi-user Nix installation), the Nix store (i.e., if the target machine has a multi-user Nix
then the target machine will check the dump against installation), then the target machine will check the dump against
<filename>/nix/etc/nix/signing-key.pub</filename> before unpacking <filename><replaceable>sysconfdir</replaceable>/nix/signing-key.pub</filename>
it in its Nix store. This allows secure sharing of store paths before unpacking it in its Nix store. This allows secure sharing
between untrusted users on two machines, provided that there is a of store paths between untrusted users on two machines, provided
trust relation between the Nix installations on both machines that there is a trust relation between the Nix installations on
(namely, they have matching public/secret keys).</para></listitem> both machines (namely, they have matching public/secret
keys).</para></listitem>
</varlistentry> </varlistentry>
@ -108,6 +110,13 @@ those paths. If this bothers you, use
</varlistentry> </varlistentry>
<varlistentry><term><option>--include-outputs</option></term>
<listitem><para>Also copy the outputs of store derivations included
in the closure.</para></listitem>
</varlistentry>
</variablelist> </variablelist>
</refsection> </refsection>