public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for nixpkgs.config settings (allowUnfree, allowUnfreePredicate, whitelistedLicenses, blacklistedLicenses)

This commit is contained in:
Matthias Beyer 2015-01-24 20:40:40 +01:00 committed by Domen Kožar
parent 2daba83828
commit 9bb80ffa2c
2 changed files with 64 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/manual.xml
View File

@ -12,6 +12,7 @@
<xi:include href="introduction.xml" /> <xi:include href="introduction.xml" />
<xi:include href="quick-start.xml" /> <xi:include href="quick-start.xml" />
<xi:include href="stdenv.xml" /> <xi:include href="stdenv.xml" />
<xi:include href="packageconfig.xml" />
<xi:include href="meta.xml" /> <xi:include href="meta.xml" />
<xi:include href="language-support.xml" /> <xi:include href="language-support.xml" />
<xi:include href="package-notes.xml" /> <xi:include href="package-notes.xml" />

63
doc/packageconfig.xml Normal file
View File

@ -0,0 +1,63 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-packageconfig">
<title>nixpkgs configuration</title>
<para>
The Nix package manager can be configured to allow or deny certain
package sets. At this moment, packages can either be allowed to be
installed or denied to be installed based on their license.
</para>
<itemizedlist>
<listitem>
<para>
Allow packages that do not have a free license by setting
<programlisting>
nixpkgs.config.allowUnfree = true;
</programlisting>
or deny them by setting it to <literal>false</literal>.
</para>
<para>
This can also be achieved for one call to the Nix package
manager 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:
<programlisting>
nixpkgs.config.allowUnfreePredicate = (x: ...);
</programlisting>
</para>
</listitem>
<listitem>
<para>
Whenever unfree packages are not allowed, packages can still be
whitelisted by their license:
<programlisting>
nixpkgs.config.whitelistedLicenses = [ licenseA licenseB ];
</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>
nixpkgs.config.blacklistedLicenses = [ licenseA licenseB ];
</programlisting>
</para>
</listitem>
</itemizedlist>
</chapter>