From 6bd0519918df90d5c9449f5ca7d70eb09424ee31 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Mon, 7 Dec 2015 20:41:18 +0100 Subject: [PATCH] Manual: Fix indent of config section --- doc/configuration.xml | 145 ++++++++++++++++++++++----------------- doc/language-support.xml | 1 - 2 files changed, 83 insertions(+), 63 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 @@ + xmlns:xlink="http://www.w3.org/1999/xlink" + xml:id="chap-packageconfig"> <filename>~/.nixpkgs/config.nix</filename>: global configuration - - Nix packages can be configured to allow or deny certain options. - +Nix packages can be configured to allow or deny certain options. - - To apply the configuration edit ~/.nixpkgs/config.nix - and set it like -{ +To apply the configuration edit +~/.nixpkgs/config.nix and set it like + + +{ allowUnfree = true; -} - and will allow the Nix package manager to install unfree licensed packages. +} + + +and will allow the Nix package manager to install unfree licensed packages. + +The configuration as listed also applies to NixOS under + set. + + + + + Allow installing of packages that are distributed under + unfree license by setting allowUnfree = + true; or deny them by setting it to + false. + + Same can be achieved by setting the environment variable: + + +$ export NIXPKGS_ALLOW_UNFREE=1 + - The configuration as listed also applies to NixOS under set. + - - - - Allow installing of packages that are distributed under unfree license by setting - allowUnfree = true; - or deny them by setting it to false. - - - Same can be achieved by setting the environment variable: - $ export NIXPKGS_ALLOW_UNFREE=1 - - + + 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: - - - 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: - allowUnfreePredicate = (pkg: ...); + +allowUnfreePredicate = (pkg: ...); + - Example to allow flash player only: - allowUnfreePredicate = (pkg: pkgs.lib.hasPrefix "flashplayer-" pkg.name); - - + Example to allow flash player only: - - - Whenever unfree packages are not allowed, packages can still be - whitelisted by their license: - whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ]; - - + +allowUnfreePredicate = (pkg: pkgs.lib.hasPrefix "flashplayer-" pkg.name); + - - - In addition to whitelisting licenses which are denied by the - allowUnfree setting, you can also explicitely - deny installation of packages which have a certain license: - blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ]; - - - - - - A complete list of licenses can be found in the file - lib/licenses.nix of the nix package tree. + + + + Whenever unfree packages are not allowed, packages can still + be whitelisted by their license: + + +whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ]; + + + + + + In addition to whitelisting licenses which are denied by the + allowUnfree setting, you can also explicitely + deny installation of packages which have a certain license: + + +blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ]; + + + + + + +A complete list of licenses can be found in the file +lib/licenses.nix of the nix package tree. + + +
Modify packages via <literal>packageOverrides</literal> - +You can define a function called +packageOverrides in your local +~/.nixpkgs/config to overide nix packages. It +must be a function that takes pkgs as an argument and return modified +set of packages. - You can define a function called packageOverrides - in your local ~/.nixpkgs/config to overide nix - packages. It must be a function that takes pkgs as an argument and - return modified set of packages. - - { + +{ packageOverrides = pkgs: rec { foo = pkgs.foo.override { ... }; }; -} +} + + +
+ diff --git a/doc/language-support.xml b/doc/language-support.xml index 9a88ea4fa6f4..f0d5dbd3e64f 100644 --- a/doc/language-support.xml +++ b/doc/language-support.xml @@ -1,4 +1,3 @@ -