From e115e3fd761ac9b087f7d609a870f08165b8edc5 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Mon, 7 Dec 2015 20:35:25 +0100 Subject: Manual: Rename file --- doc/configuration.xml | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/packageconfig.xml | 88 --------------------------------------------------- 2 files changed, 88 insertions(+), 88 deletions(-) create mode 100644 doc/configuration.xml delete mode 100644 doc/packageconfig.xml (limited to 'doc') diff --git a/doc/configuration.xml b/doc/configuration.xml new file mode 100644 index 000000000000..4e0fcc3b6a49 --- /dev/null +++ b/doc/configuration.xml @@ -0,0 +1,88 @@ + + +<filename>~/.nixpkgs/config.nix</filename>: global configuration + + + Nix packages can be configured to allow or deny certain options. + + + + 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. + + 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: + allowUnfreePredicate = (pkg: ...); + + Example to allow flash player only: + allowUnfreePredicate = (pkg: pkgs.lib.hasPrefix "flashplayer-" pkg.name); + + + + + + 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. + + { + packageOverrides = pkgs: rec { + foo = pkgs.foo.override { ... }; + }; +} + +
+ +
diff --git a/doc/packageconfig.xml b/doc/packageconfig.xml deleted file mode 100644 index 4e0fcc3b6a49..000000000000 --- a/doc/packageconfig.xml +++ /dev/null @@ -1,88 +0,0 @@ - - -<filename>~/.nixpkgs/config.nix</filename>: global configuration - - - Nix packages can be configured to allow or deny certain options. - - - - 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. - - 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: - allowUnfreePredicate = (pkg: ...); - - Example to allow flash player only: - allowUnfreePredicate = (pkg: pkgs.lib.hasPrefix "flashplayer-" pkg.name); - - - - - - 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. - - { - packageOverrides = pkgs: rec { - foo = pkgs.foo.override { ... }; - }; -} - -
- -
-- cgit 1.4.1