diff options
Diffstat (limited to 'doc/manual')
| -rw-r--r-- | doc/manual/command-ref/conf-file.xml | 72 | ||||
| -rw-r--r-- | doc/manual/command-ref/nix-env.xml | 2 | ||||
| -rw-r--r-- | doc/manual/introduction/quick-start.xml | 2 |
3 files changed, 44 insertions, 32 deletions
diff --git a/doc/manual/command-ref/conf-file.xml b/doc/manual/command-ref/conf-file.xml index 3de9647aa4eb..616983bc7f0e 100644 --- a/doc/manual/command-ref/conf-file.xml +++ b/doc/manual/command-ref/conf-file.xml @@ -17,13 +17,32 @@ <refsection><title>Description</title> -<para>A number of persistent settings of Nix are stored in the file -<filename><replaceable>sysconfdir</replaceable>/nix/nix.conf</filename> or -<filename>$NIX_CONF_DIR/nix.conf</filename> if <envar>NIX_CONF_DIR</envar> is set. -This file is a list of <literal><replaceable>name</replaceable> = +<para>Nix reads settings from two configuration files:</para> + +<itemizedlist> + + <listitem> + <para>The system-wide configuration file + <filename><replaceable>sysconfdir</replaceable>/nix/nix.conf</filename> + (i.e. <filename>/etc/nix/nix.conf</filename> on most systems), or + <filename>$NIX_CONF_DIR/nix.conf</filename> if + <envar>NIX_CONF_DIR</envar> is set.</para> + </listitem> + + <listitem> + <para>The user configuration file + <filename>$XDG_CONFIG_HOME/nix/nix.conf</filename>, or + <filename>~/.config/nix/nix.conf</filename> if + <envar>XDG_CONFIG_HOME</envar> is not set.</para> + </listitem> + +</itemizedlist> + +<para>The configuration files consist of +<literal><replaceable>name</replaceable> = <replaceable>value</replaceable></literal> pairs, one per line. -Comments start with a <literal>#</literal> character. Here is an example -configuration file:</para> +Comments start with a <literal>#</literal> character. Here is an +example configuration file:</para> <programlisting> gc-keep-outputs = true # Nice for developers @@ -31,8 +50,9 @@ gc-keep-derivations = true # Idem env-keep-derivations = false </programlisting> -<para>You can override settings using the <option>--option</option> -flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para> +<para>You can override settings on the command line using the +<option>--option</option> flag, e.g. <literal>--option gc-keep-outputs +false</literal>.</para> <para>The following settings are currently available: @@ -334,15 +354,16 @@ flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para> </varlistentry> - <varlistentry><term><literal>binary-caches</literal></term> + <varlistentry><term><literal>substituters</literal></term> - <listitem><para>A list of URLs of binary caches, separated by + <listitem><para>A list of URLs of substituters, separated by whitespace. The default is <literal>https://cache.nixos.org</literal>.</para></listitem> </varlistentry> + <!-- <varlistentry><term><literal>binary-caches-files</literal></term> <listitem><para>A list of names of files that will be read to @@ -355,28 +376,28 @@ flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para> option to read files created by untrusted users!</para></listitem> </varlistentry> + --> - <varlistentry><term><literal>trusted-binary-caches</literal></term> + <varlistentry><term><literal>trusted-substituters</literal></term> - <listitem><para>A list of URLs of binary caches, separated by + <listitem><para>A list of URLs of substituters, separated by whitespace. These are not used by default, but can be enabled by users of the Nix daemon by specifying <literal>--option - binary-caches <replaceable>urls</replaceable></literal> on the + substituters <replaceable>urls</replaceable></literal> on the command line. Unprivileged users are only allowed to pass a - subset of the URLs listed in <literal>binary-caches</literal> and - <literal>trusted-binary-caches</literal>.</para></listitem> + subset of the URLs listed in <literal>substituters</literal> and + <literal>trusted-substituters</literal>.</para></listitem> </varlistentry> - <varlistentry><term><literal>extra-binary-caches</literal></term> + <varlistentry><term><literal>extra-substituters</literal></term> <listitem><para>Additional binary caches appended to those - specified in <option>binary-caches</option> and - <option>binary-caches-files</option>. When used by unprivileged - users, untrusted binary caches (i.e. those not listed in - <option>trusted-binary-caches</option>) are silently + specified in <option>substituters</option>. When used by + unprivileged users, untrusted substituters (i.e. those not listed + in <option>trusted-substituters</option>) are silently ignored.</para></listitem> </varlistentry> @@ -403,7 +424,7 @@ flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para> </varlistentry> - <varlistentry><term><literal>binary-caches-parallel-connections</literal></term> + <varlistentry><term><literal>http-connections</literal></term> <listitem><para>The maximum number of parallel TCP connections used to fetch files from binary caches and by other downloads. It @@ -412,15 +433,6 @@ flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para> </varlistentry> - <varlistentry><term><literal>verify-https-binary-caches</literal></term> - - <listitem><para>Whether HTTPS binary caches are required to have a - certificate that can be verified. Defaults to - <literal>true</literal>.</para></listitem> - - </varlistentry> - - <varlistentry><term><literal>netrc-file</literal></term> <listitem><para>If set to an absolute path to a <filename>netrc</filename> diff --git a/doc/manual/command-ref/nix-env.xml b/doc/manual/command-ref/nix-env.xml index 85f10e0760bc..8462cf8a0270 100644 --- a/doc/manual/command-ref/nix-env.xml +++ b/doc/manual/command-ref/nix-env.xml @@ -1136,7 +1136,7 @@ user environment elements, etc. --> <listitem><para>Print all of the meta-attributes of the derivation. This option is only available with - <option>--xml</option>.</para></listitem> + <option>--xml</option> or <option>--json</option>.</para></listitem> </varlistentry> diff --git a/doc/manual/introduction/quick-start.xml b/doc/manual/introduction/quick-start.xml index 5ae9f6ad543b..aa239b7538b4 100644 --- a/doc/manual/introduction/quick-start.xml +++ b/doc/manual/introduction/quick-start.xml @@ -40,7 +40,7 @@ libxslt-1.1.28 <step><para>Install some packages from the channel: <screen> -$ nix-env -i hello <replaceable>...</replaceable> </screen> +$ nix-env -i hello</screen> This should download pre-built packages; it should not build them locally (if it does, something went wrong).</para></step> |