cafkafk/lix
cafkafk/lix
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Install a nix.conf manpage

Browse source
This commit is contained in:
Eelco Dolstra 2012-07-09 11:33:38 -04:00
parent 1aba0bf0fa
commit 5755a5c354
3 changed files with 28 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/manual/Makefile.am
View file

@ -21,6 +21,8 @@ man1_MANS = nix-env.1 nix-build.1 nix-store.1 nix-instantiate.1 \
nix-prefetch-url.1 nix-channel.1 \ nix-prefetch-url.1 nix-channel.1 \
nix-install-package.1 nix-hash.1 nix-copy-closure.1 nix-install-package.1 nix-hash.1 nix-copy-closure.1
man5_MANS = nix.conf.5
man8_MANS = nix-worker.8 man8_MANS = nix-worker.8
FIGURES = figures/user-environments.png FIGURES = figures/user-environments.png

28
doc/manual/conf-file.xml
View file

@ -1,27 +1,36 @@
<section xmlns="http://docbook.org/ns/docbook" <refentry xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="sec-conf-file"> xml:id="sec-conf-file">
<title>Nix configuration file</title> <refmeta>
<refentrytitle>nix.conf</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="source">Nix</refmiscinfo>
<refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo>
</refmeta>
<refnamediv>
<refname>nix.conf</refname>
<refpurpose>Nix configuration file</refpurpose>
</refnamediv>
<refsection><title>Description</title>
<para>A number of persistent settings of Nix are stored in the file <para>A number of persistent settings of Nix are stored in the file
<filename><replaceable>sysconfdir</replaceable>/nix/nix.conf</filename>. <filename><replaceable>sysconfdir</replaceable>/nix/nix.conf</filename>.
This file is a list of <literal><replaceable>name</replaceable> = This file is a list of <literal><replaceable>name</replaceable> =
<replaceable>value</replaceable></literal> pairs, one per line. <replaceable>value</replaceable></literal> pairs, one per line.
Comments start with a <literal>#</literal> character. An example Comments start with a <literal>#</literal> character. Here is an example
configuration file is shown in <xref linkend="ex-nix-conf" />.</para> configuration file:</para>
<example xml:id='ex-nix-conf'><title>Nix configuration file</title>
<programlisting> <programlisting>
gc-keep-outputs = true # Nice for developers gc-keep-outputs = true # Nice for developers
gc-keep-derivations = true # Idem gc-keep-derivations = true # Idem
env-keep-derivations = false env-keep-derivations = false
</programlisting> </programlisting>
</example>
<para>The following variables are currently available: <para>The following settings are currently available:
<variablelist> <variablelist>
@ -323,5 +332,6 @@ build-use-chroot = /dev /proc /bin</programlisting>
</para> </para>
</refsection>
</section> </refentry>

6
doc/manual/manual.xml
View file

@ -40,7 +40,6 @@
<title>Command Reference</title> <title>Command Reference</title>
<xi:include href="opt-common.xml" /> <xi:include href="opt-common.xml" />
<xi:include href="env-common.xml" /> <xi:include href="env-common.xml" />
<xi:include href="conf-file.xml" />
<section> <section>
<title>Main commands</title> <title>Main commands</title>
@ -63,6 +62,11 @@
<xi:include href="nix-worker.xml" /> <xi:include href="nix-worker.xml" />
</section> </section>
<section>
<title>Files</title>
<xi:include href="conf-file.xml" />
</section>
</appendix> </appendix>
<xi:include href="troubleshooting.xml" /> <xi:include href="troubleshooting.xml" />