summary refs log tree commit diff
path: root/doc/configuration.xml
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2015-12-07 20:41:18 +0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2015-12-10 16:06:12 +0100
commit6bd0519918df90d5c9449f5ca7d70eb09424ee31 (patch)
tree2f5d315b8a4e7f09c2c71dca577711cfa69b57f1 /doc/configuration.xml
parente115e3fd761ac9b087f7d609a870f08165b8edc5 (diff)
downloadnixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.tar
nixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.tar.gz
nixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.tar.bz2
nixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.tar.lz
nixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.tar.xz
nixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.tar.zst
nixlib-6bd0519918df90d5c9449f5ca7d70eb09424ee31.zip
Manual: Fix indent of config section
Diffstat (limited to 'doc/configuration.xml')
-rw-r--r--doc/configuration.xml153
1 files changed, 87 insertions, 66 deletions
diff --git a/doc/configuration.xml b/doc/configuration.xml
index 4e0fcc3b6a49..ce25bbfce77b 100644
--- a/doc/configuration.xml
+++ b/doc/configuration.xml
@@ -1,88 +1,109 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
-	 xmlns:xlink="http://www.w3.org/1999/xlink"
-	 xml:id="chap-packageconfig">
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xml:id="chap-packageconfig">
 
 <title><filename>~/.nixpkgs/config.nix</filename>: global configuration</title>
 
-    <para>
-      Nix packages can be configured to allow or deny certain options.
-    </para>
+<para>Nix packages can be configured to allow or deny certain options.</para>
+
+<para>To apply the configuration edit
+<filename>~/.nixpkgs/config.nix</filename> and set it like
 
-    <para>
-	To apply the configuration edit <filename>~/.nixpkgs/config.nix</filename>
-	and set it like
-<programlisting>{
+<programlisting>
+{
   allowUnfree = true;
-}</programlisting>
-	and will allow the Nix package manager to install unfree licensed packages.
+}
+</programlisting>
+
+and will allow the Nix package manager to install unfree licensed packages.</para>
+
+<para>The configuration as listed also applies to NixOS under
+<option>nixpkgs.config</option> set.</para>
+
+<itemizedlist>
+
+  <listitem>
+    <para>Allow installing of packages that are distributed under
+    unfree license by setting <programlisting>allowUnfree =
+    true;</programlisting> or deny them by setting it to
+    <literal>false</literal>.</para>
+
+    <para>Same can be achieved by setting the environment variable:
+
+<programlisting>
+$ export NIXPKGS_ALLOW_UNFREE=1
+</programlisting>
+
+    </para>
+  </listitem>
+
+  <listitem>
+    <para>Whenever unfree packages are not allowed, single packages
+    can still be allowed by a predicate function that accepts package
+    as an argument and should return a boolean:
+
+<programlisting>
+allowUnfreePredicate = (pkg: ...);
+</programlisting>
+
+    Example to allow flash player only:
+
+<programlisting>
+allowUnfreePredicate = (pkg: pkgs.lib.hasPrefix "flashplayer-" pkg.name);
+</programlisting>
 
-	The configuration as listed also applies to NixOS under <option>nixpkgs.config</option> set.
     </para>
+  </listitem>
+
+  <listitem>
+    <para>Whenever unfree packages are not allowed, packages can still
+    be whitelisted by their license:
 
-    <itemizedlist>
-	<listitem>
-	    <para>
-		Allow installing of packages that are distributed under unfree license by setting
-		<programlisting>allowUnfree = true;</programlisting>
-		or deny them by setting it to <literal>false</literal>.
-	    </para>
-	    <para>
-		Same can be achieved by setting the environment variable:
-		<programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting>
-	    </para>
-	</listitem>
-
-	<listitem>
-	    <para>
-		Whenever unfree packages are not allowed, single packages can
-		still be allowed by a predicate function that accepts package
-		as an argument and should return a boolean:
-		<programlisting>allowUnfreePredicate = (pkg: ...);</programlisting>
-
-		Example to allow flash player only:
-		<programlisting>allowUnfreePredicate = (pkg: pkgs.lib.hasPrefix "flashplayer-" pkg.name);</programlisting>
-	    </para>
-	</listitem>
-
-	<listitem>
-	    <para>
-		Whenever unfree packages are not allowed, packages can still be
-		whitelisted by their license:
-		<programlisting>whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ];</programlisting>
-	    </para>
-	</listitem>
-
-	<listitem>
-	    <para>
-		In addition to whitelisting licenses which are denied by the
-		<literal>allowUnfree</literal> setting, you can also explicitely
-		deny installation of packages which have a certain license:
-		<programlisting>blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ];</programlisting>
-	    </para>
-	</listitem>
-    </itemizedlist>
-
-    <para>
-	A complete list of licenses can be found in the file
-	<filename>lib/licenses.nix</filename> of the nix package tree.
+<programlisting>
+whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ];
+</programlisting>
     </para>
+  </listitem>
+
+  <listitem>
+    <para>In addition to whitelisting licenses which are denied by the
+    <literal>allowUnfree</literal> setting, you can also explicitely
+    deny installation of packages which have a certain license:
+
+<programlisting>
+blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ];
+</programlisting>
+    </para>
+  </listitem>
+
+</itemizedlist>
+
+<para>A complete list of licenses can be found in the file
+<filename>lib/licenses.nix</filename> of the nix package tree.</para>
+
+
+<!--============================================================-->
 
 <section xml:id="sec-modify-via-packageOverrides"><title>Modify
 packages via <literal>packageOverrides</literal></title>
 
-<para>
-
-  You can define a function called <varname>packageOverrides</varname>
-  in your local <filename>~/.nixpkgs/config</filename> to overide nix
-  packages.  It must be a function that takes pkgs as an argument and
-  return modified set of packages.
+<para>You can define a function called
+<varname>packageOverrides</varname> in your local
+<filename>~/.nixpkgs/config</filename> to overide nix packages.  It
+must be a function that takes pkgs as an argument and return modified
+set of packages.
 
-  <programlisting>{
+<programlisting>
+{
   packageOverrides = pkgs: rec {
     foo = pkgs.foo.override { ... };
   };
-}</programlisting>
+}
+</programlisting>
+
 </para>
+
 </section>
 
+
 </chapter>