diff --git a/doc/builders/fetchers.xml b/doc/builders/fetchers.xml index 6f8990e8d16c..ff3988334916 100644 --- a/doc/builders/fetchers.xml +++ b/doc/builders/fetchers.xml @@ -3,15 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="chap-pkgs-fetchers"> Fetchers - When using Nix, you will frequently need to download source code and other files from the internet. Nixpkgs comes with a few helper functions that allow you to fetch fixed-output derivations in a structured way. - The two fetcher primitives are fetchurl and fetchzip. Both of these have two required arguments, a URL and a hash. The hash is typically sha256, although many more hash algorithms are supported. Nixpkgs contributors are currently recommended to use sha256. This hash will be used by Nix to identify your source. A typical usage of fetchurl is provided below. - - The main difference between fetchurl and fetchzip is in how they store the contents. fetchurl will store the unaltered contents of the URL within the Nix store. fetchzip on the other hand will decompress the archive for you, making files and directories directly accessible in the future. fetchzip can only be used with archives. Despite the name, fetchzip is not limited to .zip files and can also be used with any tarball. - fetchpatch works very similarly to fetchurl with the same arguments expected. It expects patch files as a source and and performs normalization on them before computing the checksum. For example it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time. - Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward names based on the name of the command used with the VCS system. Because they give you a working repository, they act most like fetchzip. - @@ -88,11 +81,9 @@ stdenv.mkDerivation { - A number of fetcher functions wrap part of fetchurl and fetchzip. They are mainly convenience functions intended for commonly used destinations of source code in Nixpkgs. These wrapper fetchers are listed below. - diff --git a/doc/builders/packages/citrix.xml b/doc/builders/packages/citrix.xml index bc685f97932d..c629dc9ee503 100644 --- a/doc/builders/packages/citrix.xml +++ b/doc/builders/packages/citrix.xml @@ -1,37 +1,37 @@
- Citrix Workspace + Citrix Workspace + + + + + Please note that the citrix_receiver package has been deprecated since its development was discontinued by upstream and has been replaced by the citrix workspace app. + + + Citrix Receiver and Citrix Workspace App are a remote desktop viewers which provide access to XenDesktop installations. + + +
+ Basic usage - - - Please note that the citrix_receiver package has been deprecated since its development was discontinued by upstream and has been replaced by the citrix workspace app. - - - Citrix Receiver and Citrix Workspace App are a remote desktop viewers which provide access to XenDesktop installations. + The tarball archive needs to be downloaded manually as the license agreements of the vendor for Citrix Receiver or Citrix Workspace need to be accepted first. Then run nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz. With the archive available in the store the package can be built and installed with Nix. -
- Basic usage - + + Caution with <command>nix-shell</command> installs - The tarball archive needs to be downloaded manually as the license agreements of the vendor for Citrix Receiver or Citrix Workspace need to be accepted first. Then run nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz. With the archive available in the store the package can be built and installed with Nix. + It's recommended to install Citrix Receiver and/or Citrix Workspace using nix-env -i or globally to ensure that the .desktop files are installed properly into $XDG_CONFIG_DIRS. Otherwise it won't be possible to open .ica files automatically from the browser to start a Citrix connection. + +
- - Caution with <command>nix-shell</command> installs - - It's recommended to install Citrix Receiver and/or Citrix Workspace using nix-env -i or globally to ensure that the .desktop files are installed properly into $XDG_CONFIG_DIRS. Otherwise it won't be possible to open .ica files automatically from the browser to start a Citrix connection. - - -
+
+ Custom certificates -
- Custom certificates - - - The Citrix Workspace App in nixpkgs trust several certificates from the Mozilla database by default. However several companies using Citrix might require their own corporate certificate. On distros with imperative packaging these certs can be stored easily in $ICAROOT, however this directory is a store path in nixpkgs. In order to work around this issue the package provides a simple mechanism to add custom certificates without rebuilding the entire package using symlinkJoin: + + The Citrix Workspace App in nixpkgs trust several certificates from the Mozilla database by default. However several companies using Citrix might require their own corporate certificate. On distros with imperative packaging these certs can be stored easily in $ICAROOT, however this directory is a store path in nixpkgs. In order to work around this issue the package provides a simple mechanism to add custom certificates without rebuilding the entire package using symlinkJoin: { config.allowUnfree = true; }; let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in @@ -39,6 +39,6 @@ citrix_workspace.override { inherit extraCerts; }]]> - -
-
\ No newline at end of file + +
+ diff --git a/doc/builders/packages/dlib.xml b/doc/builders/packages/dlib.xml index 98c211cf9df7..5f768dd51b62 100644 --- a/doc/builders/packages/dlib.xml +++ b/doc/builders/packages/dlib.xml @@ -1,24 +1,24 @@
- DLib + DLib + + + DLib is a modern, C++-based toolkit which provides several machine learning algorithms. + + +
+ Compiling without AVX support - DLib is a modern, C++-based toolkit which provides several machine learning algorithms. + Especially older CPUs don't support AVX (Advanced Vector Extensions) instructions that are used by DLib to optimize their algorithms. -
- Compiling without AVX support - - - Especially older CPUs don't support AVX (Advanced Vector Extensions) instructions that are used by DLib to optimize their algorithms. - - - - On the affected hardware errors like Illegal instruction will occur. In those cases AVX support needs to be disabled: + + On the affected hardware errors like Illegal instruction will occur. In those cases AVX support needs to be disabled: self: super: { dlib = super.dlib.override { avxSupport = false; }; } - -
-
\ No newline at end of file + +
+ diff --git a/doc/builders/packages/eclipse.xml b/doc/builders/packages/eclipse.xml index 968c58d3b5bb..fc5094ed8f36 100644 --- a/doc/builders/packages/eclipse.xml +++ b/doc/builders/packages/eclipse.xml @@ -1,22 +1,22 @@
- Eclipse + Eclipse - - The Nix expressions related to the Eclipse platform and IDE are in pkgs/applications/editors/eclipse. - + + The Nix expressions related to the Eclipse platform and IDE are in pkgs/applications/editors/eclipse. + - - Nixpkgs provides a number of packages that will install Eclipse in its various forms. These range from the bare-bones Eclipse Platform to the more fully featured Eclipse SDK or Scala-IDE packages and multiple version are often available. It is possible to list available Eclipse packages by issuing the command: + + Nixpkgs provides a number of packages that will install Eclipse in its various forms. These range from the bare-bones Eclipse Platform to the more fully featured Eclipse SDK or Scala-IDE packages and multiple version are often available. It is possible to list available Eclipse packages by issuing the command: $ nix-env -f '<nixpkgs>' -qaP -A eclipses --description - Once an Eclipse variant is installed it can be run using the eclipse command, as expected. From within Eclipse it is then possible to install plugins in the usual manner by either manually specifying an Eclipse update site or by installing the Marketplace Client plugin and using it to discover and install other plugins. This installation method provides an Eclipse installation that closely resemble a manually installed Eclipse. - + Once an Eclipse variant is installed it can be run using the eclipse command, as expected. From within Eclipse it is then possible to install plugins in the usual manner by either manually specifying an Eclipse update site or by installing the Marketplace Client plugin and using it to discover and install other plugins. This installation method provides an Eclipse installation that closely resemble a manually installed Eclipse. + - - If you prefer to install plugins in a more declarative manner then Nixpkgs also offer a number of Eclipse plugins that can be installed in an Eclipse environment. This type of environment is created using the function eclipseWithPlugins found inside the nixpkgs.eclipses attribute set. This function takes as argument { eclipse, plugins ? [], jvmArgs ? [] } where eclipse is a one of the Eclipse packages described above, plugins is a list of plugin derivations, and jvmArgs is a list of arguments given to the JVM running the Eclipse. For example, say you wish to install the latest Eclipse Platform with the popular Eclipse Color Theme plugin and also allow Eclipse to use more RAM. You could then add + + If you prefer to install plugins in a more declarative manner then Nixpkgs also offer a number of Eclipse plugins that can be installed in an Eclipse environment. This type of environment is created using the function eclipseWithPlugins found inside the nixpkgs.eclipses attribute set. This function takes as argument { eclipse, plugins ? [], jvmArgs ? [] } where eclipse is a one of the Eclipse packages described above, plugins is a list of plugin derivations, and jvmArgs is a list of arguments given to the JVM running the Eclipse. For example, say you wish to install the latest Eclipse Platform with the popular Eclipse Color Theme plugin and also allow Eclipse to use more RAM. You could then add packageOverrides = pkgs: { myEclipse = with pkgs.eclipses; eclipseWithPlugins { @@ -26,18 +26,18 @@ packageOverrides = pkgs: { }; } - to your Nixpkgs configuration (~/.config/nixpkgs/config.nix) and install it by running nix-env -f '<nixpkgs>' -iA myEclipse and afterward run Eclipse as usual. It is possible to find out which plugins are available for installation using eclipseWithPlugins by running + to your Nixpkgs configuration (~/.config/nixpkgs/config.nix) and install it by running nix-env -f '<nixpkgs>' -iA myEclipse and afterward run Eclipse as usual. It is possible to find out which plugins are available for installation using eclipseWithPlugins by running $ nix-env -f '<nixpkgs>' -qaP -A eclipses.plugins --description - + - - If there is a need to install plugins that are not available in Nixpkgs then it may be possible to define these plugins outside Nixpkgs using the buildEclipseUpdateSite and buildEclipsePlugin functions found in the nixpkgs.eclipses.plugins attribute set. Use the buildEclipseUpdateSite function to install a plugin distributed as an Eclipse update site. This function takes { name, src } as argument where src indicates the Eclipse update site archive. All Eclipse features and plugins within the downloaded update site will be installed. When an update site archive is not available then the buildEclipsePlugin function can be used to install a plugin that consists of a pair of feature and plugin JARs. This function takes an argument { name, srcFeature, srcPlugin } where srcFeature and srcPlugin are the feature and plugin JARs, respectively. - + + If there is a need to install plugins that are not available in Nixpkgs then it may be possible to define these plugins outside Nixpkgs using the buildEclipseUpdateSite and buildEclipsePlugin functions found in the nixpkgs.eclipses.plugins attribute set. Use the buildEclipseUpdateSite function to install a plugin distributed as an Eclipse update site. This function takes { name, src } as argument where src indicates the Eclipse update site archive. All Eclipse features and plugins within the downloaded update site will be installed. When an update site archive is not available then the buildEclipsePlugin function can be used to install a plugin that consists of a pair of feature and plugin JARs. This function takes an argument { name, srcFeature, srcPlugin } where srcFeature and srcPlugin are the feature and plugin JARs, respectively. + - - Expanding the previous example with two plugins using the above functions we have + + Expanding the previous example with two plugins using the above functions we have packageOverrides = pkgs: { myEclipse = with pkgs.eclipses; eclipseWithPlugins { @@ -68,5 +68,5 @@ packageOverrides = pkgs: { }; } - -
\ No newline at end of file + + diff --git a/doc/builders/packages/elm.xml b/doc/builders/packages/elm.xml index 8ee052852654..a067f6c7c70e 100644 --- a/doc/builders/packages/elm.xml +++ b/doc/builders/packages/elm.xml @@ -4,14 +4,14 @@ Elm - To start a development environment do nix-shell -p elmPackages.elm elmPackages.elm-format + To start a development environment do nix-shell -p elmPackages.elm elmPackages.elm-format - To update Elm compiler, see nixpkgs/pkgs/development/compilers/elm/README.md. + To update Elm compiler, see nixpkgs/pkgs/development/compilers/elm/README.md. - To package Elm applications, read about elm2nix. + To package Elm applications, read about elm2nix. - \ No newline at end of file + diff --git a/doc/builders/packages/emacs.xml b/doc/builders/packages/emacs.xml index a9a26882c9cd..9cce7c40863a 100644 --- a/doc/builders/packages/emacs.xml +++ b/doc/builders/packages/emacs.xml @@ -1,14 +1,14 @@
- Emacs + Emacs -
- Configuring Emacs +
+ Configuring Emacs - - The Emacs package comes with some extra helpers to make it easier to configure. emacsWithPackages allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use company, counsel, flycheck, ivy, magit, projectile, and use-package you could use this as a ~/.config/nixpkgs/config.nix override: - + + The Emacs package comes with some extra helpers to make it easier to configure. emacsWithPackages allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use company, counsel, flycheck, ivy, magit, projectile, and use-package you could use this as a ~/.config/nixpkgs/config.nix override: + { @@ -26,9 +26,9 @@ } - - You can install it like any other packages via nix-env -iA myEmacs. However, this will only install those packages. It will not configure them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provide a default.el file in /share/emacs/site-start/. Emacs knows to load this file automatically when it starts. - + + You can install it like any other packages via nix-env -iA myEmacs. However, this will only install those packages. It will not configure them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provide a default.el file in /share/emacs/site-start/. Emacs knows to load this file automatically when it starts. + { @@ -108,13 +108,13 @@ cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el } - - This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing -q to the Emacs command. - + + This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing -q to the Emacs command. + - - Sometimes emacsWithPackages is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in pkgs/top-level/emacs-packages.nix). But you can't control this priorities when some package is installed as a dependency. You can override it on per-package-basis, providing all the required dependencies manually - but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package you can use overrideScope'. - + + Sometimes emacsWithPackages is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in pkgs/top-level/emacs-packages.nix). But you can't control this priorities when some package is installed as a dependency. You can override it on per-package-basis, providing all the required dependencies manually - but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package you can use overrideScope'. + overrides = self: super: rec { @@ -127,5 +127,5 @@ overrides = self: super: rec { dante ]) -
-
\ No newline at end of file +
+ diff --git a/doc/builders/packages/ibus.xml b/doc/builders/packages/ibus.xml index 561d4d2eabdc..2ed37903a273 100644 --- a/doc/builders/packages/ibus.xml +++ b/doc/builders/packages/ibus.xml @@ -1,57 +1,57 @@
- ibus-engines.typing-booster + ibus-engines.typing-booster + + + This package is an ibus-based completion method to speed up typing. + + +
+ Activating the engine - This package is an ibus-based completion method to speed up typing. + IBus needs to be configured accordingly to activate typing-booster. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the upstream docs. -
- Activating the engine - - - IBus needs to be configured accordingly to activate typing-booster. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the upstream docs. - - - - On NixOS you need to explicitly enable ibus with given engines before customizing your desktop to use typing-booster. This can be achieved using the ibus module: + + On NixOS you need to explicitly enable ibus with given engines before customizing your desktop to use typing-booster. This can be achieved using the ibus module: { pkgs, ... }: { i18n.inputMethod = { enabled = "ibus"; ibus.engines = with pkgs.ibus-engines; [ typing-booster ]; }; } - -
+ +
-
- Using custom hunspell dictionaries +
+ Using custom hunspell dictionaries - - The IBus engine is based on hunspell to support completion in many languages. By default the dictionaries de-de, en-us, fr-moderne es-es, it-it, sv-se and sv-fi are in use. To add another dictionary, the package can be overridden like this: + + The IBus engine is based on hunspell to support completion in many languages. By default the dictionaries de-de, en-us, fr-moderne es-es, it-it, sv-se and sv-fi are in use. To add another dictionary, the package can be overridden like this: ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; } - + - - Note: each language passed to langs must be an attribute name in pkgs.hunspellDicts. - -
+ + Note: each language passed to langs must be an attribute name in pkgs.hunspellDicts. + +
-
- Built-in emoji picker +
+ Built-in emoji picker - - The ibus-engines.typing-booster package contains a program named emoji-picker. To display all emojis correctly, a special font such as noto-fonts-emoji is needed: - + + The ibus-engines.typing-booster package contains a program named emoji-picker. To display all emojis correctly, a special font such as noto-fonts-emoji is needed: + - - On NixOS it can be installed using the following expression: + + On NixOS it can be installed using the following expression: { pkgs, ... }: { fonts.fonts = with pkgs; [ noto-fonts-emoji ]; } - -
-
\ No newline at end of file + +
+ diff --git a/doc/builders/packages/kakoune.xml b/doc/builders/packages/kakoune.xml index fd40dad7ca87..728d40dacc92 100644 --- a/doc/builders/packages/kakoune.xml +++ b/doc/builders/packages/kakoune.xml @@ -1,14 +1,14 @@
- Kakoune + Kakoune - - Kakoune can be built to autoload plugins: + + Kakoune can be built to autoload plugins: (kakoune.override { configure = { plugins = with pkgs.kakounePlugins; [ parinfer-rust ]; }; }) - -
\ No newline at end of file + + diff --git a/doc/builders/packages/linux.xml b/doc/builders/packages/linux.xml index 3adfacb6e457..72d0e21493b3 100644 --- a/doc/builders/packages/linux.xml +++ b/doc/builders/packages/linux.xml @@ -1,85 +1,85 @@
- Linux kernel + Linux kernel - - The Nix expressions to build the Linux kernel are in + The Nix expressions to build the Linux kernel are in pkgs/os-specific/linux/kernel. - + - - The function that builds the kernel has an argument kernelPatches which should be a list of {name, patch, extraConfig} attribute sets, where name is the name of the patch (which is included in the kernel’s meta.description attribute), patch is the patch itself (possibly compressed), and extraConfig (optional) is a string specifying extra options to be concatenated to the kernel configuration file (.config). - + + The function that builds the kernel has an argument kernelPatches which should be a list of {name, patch, extraConfig} attribute sets, where name is the name of the patch (which is included in the kernel’s meta.description attribute), patch is the patch itself (possibly compressed), and extraConfig (optional) is a string specifying extra options to be concatenated to the kernel configuration file (.config). + - - The kernel derivation exports an attribute features specifying whether optional functionality is or isn’t enabled. This is used in NixOS to implement kernel-specific behaviour. For instance, if the kernel has the iwlwifi feature (i.e. has built-in support for Intel wireless chipsets), then NixOS doesn’t have to build the external iwlwifi package: + + The kernel derivation exports an attribute features specifying whether optional functionality is or isn’t enabled. This is used in NixOS to implement kernel-specific behaviour. For instance, if the kernel has the iwlwifi feature (i.e. has built-in support for Intel wireless chipsets), then NixOS doesn’t have to build the external iwlwifi package: modulesTree = [kernel] ++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi ++ ...; - + - - How to add a new (major) version of the Linux kernel to Nixpkgs: - - - - Copy the old Nix expression (e.g. linux-2.6.21.nix) to the new one (e.g. linux-2.6.22.nix) and update it. - - - - - Add the new kernel to all-packages.nix (e.g., create an attribute kernel_2_6_22). - - - - - Now we’re going to update the kernel configuration. First unpack the kernel. Then for each supported platform (i686, x86_64, uml) do the following: - - - - Make an copy from the old config (e.g. config-2.6.21-i686-smp) to the new one (e.g. config-2.6.22-i686-smp). - - - - - Copy the config file for this platform (e.g. config-2.6.22-i686-smp) to .config in the kernel source tree. - - - - - Run make oldconfig ARCH={i386,x86_64,um} and answer all questions. (For the uml configuration, also add SHELL=bash.) Make sure to keep the configuration consistent between platforms (i.e. don’t enable some feature on i686 and disable it on x86_64). - - - - - If needed you can also run make menuconfig: + + How to add a new (major) version of the Linux kernel to Nixpkgs: + + + + Copy the old Nix expression (e.g. linux-2.6.21.nix) to the new one (e.g. linux-2.6.22.nix) and update it. + + + + + Add the new kernel to all-packages.nix (e.g., create an attribute kernel_2_6_22). + + + + + Now we’re going to update the kernel configuration. First unpack the kernel. Then for each supported platform (i686, x86_64, uml) do the following: + + + + Make an copy from the old config (e.g. config-2.6.21-i686-smp) to the new one (e.g. config-2.6.22-i686-smp). + + + + + Copy the config file for this platform (e.g. config-2.6.22-i686-smp) to .config in the kernel source tree. + + + + + Run make oldconfig ARCH={i386,x86_64,um} and answer all questions. (For the uml configuration, also add SHELL=bash.) Make sure to keep the configuration consistent between platforms (i.e. don’t enable some feature on i686 and disable it on x86_64). + + + + + If needed you can also run make menuconfig: $ nix-env -i ncurses $ export NIX_CFLAGS_LINK=-lncurses $ make menuconfig ARCH=arch - - - - - Copy .config over the new config file (e.g. config-2.6.22-i686-smp). - - - - - - - - Test building the kernel: nix-build -A kernel_2_6_22. If it compiles, ship it! For extra credit, try booting NixOS with it. - - - - - It may be that the new kernel requires updating the external kernel modules and kernel-dependent packages listed in the linuxPackagesFor function in all-packages.nix (such as the NVIDIA drivers, AUFS, etc.). If the updated packages aren’t backwards compatible with older kernels, you may need to keep the older versions around. - - - - -
\ No newline at end of file + + + + + Copy .config over the new config file (e.g. config-2.6.22-i686-smp). + + + + + + + + Test building the kernel: nix-build -A kernel_2_6_22. If it compiles, ship it! For extra credit, try booting NixOS with it. + + + + + It may be that the new kernel requires updating the external kernel modules and kernel-dependent packages listed in the linuxPackagesFor function in all-packages.nix (such as the NVIDIA drivers, AUFS, etc.). If the updated packages aren’t backwards compatible with older kernels, you may need to keep the older versions around. + + + + + diff --git a/doc/builders/packages/locales.xml b/doc/builders/packages/locales.xml index 15954495e217..44fdef034e77 100644 --- a/doc/builders/packages/locales.xml +++ b/doc/builders/packages/locales.xml @@ -10,4 +10,4 @@ On non-NixOS distributions this variable is obviously not set. This can cause regressions in language support or even crashes in some Nixpkgs-provided programs. The simplest way to mitigate this problem is exporting the LOCALE_ARCHIVE variable pointing to ${glibcLocales}/lib/locale/locale-archive. The drawback (and the reason this is not the default) is the relatively large (a hundred MiB) size of the full set of locales. It is possible to build a custom set of locales by overriding parameters allLocales and locales of the package. - \ No newline at end of file + diff --git a/doc/builders/packages/nginx.xml b/doc/builders/packages/nginx.xml index 921a6add2a0a..65854ba02366 100644 --- a/doc/builders/packages/nginx.xml +++ b/doc/builders/packages/nginx.xml @@ -1,25 +1,25 @@
- Nginx + Nginx + + + Nginx is a reverse proxy and lightweight webserver. + + +
+ ETags on static files served from the Nix store - Nginx is a reverse proxy and lightweight webserver. + HTTP has a couple different mechanisms for caching to prevent clients from having to download the same content repeatedly if a resource has not changed since the last time it was requested. When nginx is used as a server for static files, it implements the caching mechanism based on the Last-Modified response header automatically; unfortunately, it works by using filesystem timestamps to determine the value of the Last-Modified header. This doesn't give the desired behavior when the file is in the Nix store, because all file timestamps are set to 0 (for reasons related to build reproducibility). -
- ETags on static files served from the Nix store + + Fortunately, HTTP supports an alternative (and more effective) caching mechanism: the ETag response header. The value of the ETag header specifies some identifier for the particular content that the server is sending (e.g. a hash). When a client makes a second request for the same resource, it sends that value back in an If-None-Match header. If the ETag value is unchanged, then the server does not need to resend the content. + - - HTTP has a couple different mechanisms for caching to prevent clients from having to download the same content repeatedly if a resource has not changed since the last time it was requested. When nginx is used as a server for static files, it implements the caching mechanism based on the Last-Modified response header automatically; unfortunately, it works by using filesystem timestamps to determine the value of the Last-Modified header. This doesn't give the desired behavior when the file is in the Nix store, because all file timestamps are set to 0 (for reasons related to build reproducibility). - - - - Fortunately, HTTP supports an alternative (and more effective) caching mechanism: the ETag response header. The value of the ETag header specifies some identifier for the particular content that the server is sending (e.g. a hash). When a client makes a second request for the same resource, it sends that value back in an If-None-Match header. If the ETag value is unchanged, then the server does not need to resend the content. - - - - As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when nginx serves a file out of /nix/store, the hash in the store path is used as the ETag header in the HTTP response, thus providing proper caching functionality. This happens automatically; you do not need to do modify any configuration to get this behavior. - -
-
\ No newline at end of file + + As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when nginx serves a file out of /nix/store, the hash in the store path is used as the ETag header in the HTTP response, thus providing proper caching functionality. This happens automatically; you do not need to do modify any configuration to get this behavior. + +
+ diff --git a/doc/builders/packages/opengl.xml b/doc/builders/packages/opengl.xml index fcb624736b09..5f4433a28844 100644 --- a/doc/builders/packages/opengl.xml +++ b/doc/builders/packages/opengl.xml @@ -4,6 +4,6 @@ OpenGL - Packages that use OpenGL have NixOS desktop as their primary target. The current solution for loading the GPU-specific drivers is based on libglvnd and looks for the driver implementation in LD_LIBRARY_PATH. If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of libglvnd and mesa_drivers in LD_LIBRARY_PATH. For proprietary video drivers you might have luck with also adding the corresponding video driver package. + Packages that use OpenGL have NixOS desktop as their primary target. The current solution for loading the GPU-specific drivers is based on libglvnd and looks for the driver implementation in LD_LIBRARY_PATH. If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of libglvnd and mesa_drivers in LD_LIBRARY_PATH. For proprietary video drivers you might have luck with also adding the corresponding video driver package. - \ No newline at end of file + diff --git a/doc/builders/packages/shell-helpers.xml b/doc/builders/packages/shell-helpers.xml index 53416ce7e171..cb70d527d67b 100644 --- a/doc/builders/packages/shell-helpers.xml +++ b/doc/builders/packages/shell-helpers.xml @@ -1,25 +1,25 @@
- Interactive shell helpers + Interactive shell helpers - - Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard share directory location. This is why a bunch PACKAGE-share scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following: - - - - autojump: autojump-share - - - - - fzf: fzf-share - - - - E.g. autojump can then used in the .bashrc like this: + + Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard share directory location. This is why a bunch PACKAGE-share scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following: + + + + autojump: autojump-share + + + + + fzf: fzf-share + + + + E.g. autojump can then used in the .bashrc like this: source "$(autojump-share)/autojump.bash" - -
\ No newline at end of file + + diff --git a/doc/builders/packages/steam.xml b/doc/builders/packages/steam.xml index 413247ee4685..8dfede59ac1b 100644 --- a/doc/builders/packages/steam.xml +++ b/doc/builders/packages/steam.xml @@ -1,131 +1,131 @@
- Steam + Steam -
- Steam in Nix +
+ Steam in Nix - - Steam is distributed as a .deb file, for now only as an i686 package (the amd64 package only has documentation). When unpacked, it has a script called steam that in Ubuntu (their target distro) would go to /usr/bin . When run for the first time, this script copies some files to the user's home, which include another script that is the ultimate responsible for launching the steam binary, which is also in $HOME. - + + Steam is distributed as a .deb file, for now only as an i686 package (the amd64 package only has documentation). When unpacked, it has a script called steam that in Ubuntu (their target distro) would go to /usr/bin . When run for the first time, this script copies some files to the user's home, which include another script that is the ultimate responsible for launching the steam binary, which is also in $HOME. + - - Nix problems and constraints: - - - - We don't have /bin/bash and many scripts point there. Similarly for /usr/bin/python . - - - - - We don't have the dynamic loader in /lib . - - - - - The steam.sh script in $HOME can not be patched, as it is checked and rewritten by steam. - - - - - The steam binary cannot be patched, it's also checked. - - - - + + Nix problems and constraints: + + + + We don't have /bin/bash and many scripts point there. Similarly for /usr/bin/python . + + + + + We don't have the dynamic loader in /lib . + + + + + The steam.sh script in $HOME can not be patched, as it is checked and rewritten by steam. + + + + + The steam binary cannot be patched, it's also checked. + + + + - - The current approach to deploy Steam in NixOS is composing a FHS-compatible chroot environment, as documented here. This allows us to have binaries in the expected paths without disrupting the system, and to avoid patching them to work in a non FHS environment. - -
+ + The current approach to deploy Steam in NixOS is composing a FHS-compatible chroot environment, as documented here. This allows us to have binaries in the expected paths without disrupting the system, and to avoid patching them to work in a non FHS environment. + +
-
- How to play +
+ How to play - - For 64-bit systems it's important to have + + For 64-bit systems it's important to have hardware.opengl.driSupport32Bit = true; - in your /etc/nixos/configuration.nix. You'll also need + in your /etc/nixos/configuration.nix. You'll also need hardware.pulseaudio.support32Bit = true; - if you are using PulseAudio - this will enable 32bit ALSA apps integration. To use the Steam controller or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pro, you need to add + if you are using PulseAudio - this will enable 32bit ALSA apps integration. To use the Steam controller or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pro, you need to add hardware.steam-hardware.enable = true; - to your configuration. - -
+ to your configuration. + +
-
- Troubleshooting +
+ Troubleshooting - - - - - Steam fails to start. What do I do? - - - - Try to run + + + + + Steam fails to start. What do I do? + + + + Try to run strace steam - to see what is causing steam to fail. - - - - - - Using the FOSS Radeon or nouveau (nvidia) drivers - - - - - - The newStdcpp parameter was removed since NixOS 17.09 and should not be needed anymore. - - - - - Steam ships statically linked with a version of libcrypto that conflics with the one dynamically loaded by radeonsi_dri.so. If you get the error + to see what is causing steam to fail. + + + + + + Using the FOSS Radeon or nouveau (nvidia) drivers + + + + + + The newStdcpp parameter was removed since NixOS 17.09 and should not be needed anymore. + + + + + Steam ships statically linked with a version of libcrypto that conflics with the one dynamically loaded by radeonsi_dri.so. If you get the error steam.sh: line 713: 7842 Segmentation fault (core dumped) - have a look at this pull request. - - - - - - - - Java - - - - - - There is no java in steam chrootenv by default. If you get a message like + have a look at this pull request. + + + + + + + + Java + + + + + + There is no java in steam chrootenv by default. If you get a message like /home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found - You need to add + You need to add steam.override { withJava = true; }; - to your configuration. - - - - - - - -
+ to your configuration. + + + + + + + +
-
- steam-run +
+ steam-run - - The FHS-compatible chroot used for steam can also be used to run other linux games that expect a FHS environment. To do it, add + + The FHS-compatible chroot used for steam can also be used to run other linux games that expect a FHS environment. To do it, add pkgs.(steam.override { nativeOnly = true; newStdcpp = true; }).run - to your configuration, rebuild, and run the game with + to your configuration, rebuild, and run the game with steam-run ./foo - -
-
\ No newline at end of file + +
+ diff --git a/doc/builders/packages/unfree.xml b/doc/builders/packages/unfree.xml index b2d8402005e9..3d4f199f8fb0 100644 --- a/doc/builders/packages/unfree.xml +++ b/doc/builders/packages/unfree.xml @@ -10,4 +10,4 @@ Fine-grained control is possible by defining allowUnfreePredicate function in config; it takes the mkDerivation parameter attrset and returns true for unfree packages that should be allowed. - \ No newline at end of file + diff --git a/doc/builders/packages/weechat.xml b/doc/builders/packages/weechat.xml index aeb240d904b5..a110d3f491c7 100644 --- a/doc/builders/packages/weechat.xml +++ b/doc/builders/packages/weechat.xml @@ -1,23 +1,23 @@
- Weechat + Weechat - - Weechat can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, install an expression that overrides its configuration such as + + Weechat can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, install an expression that overrides its configuration such as weechat.override {configure = {availablePlugins, ...}: { plugins = with availablePlugins; [ python perl ]; } } - If the configure function returns an attrset without the plugins attribute, availablePlugins will be used automatically. - + If the configure function returns an attrset without the plugins attribute, availablePlugins will be used automatically. + - - The plugins currently available are python, perl, ruby, guile, tcl and lua. - + + The plugins currently available are python, perl, ruby, guile, tcl and lua. + - - The python and perl plugins allows the addition of extra libraries. For instance, the inotify.py script in weechat-scripts requires D-Bus or libnotify, and the fish.py script requires pycrypto. To use these scripts, use the plugin's withPackages attribute: + + The python and perl plugins allows the addition of extra libraries. For instance, the inotify.py script in weechat-scripts requires D-Bus or libnotify, and the fish.py script requires pycrypto. To use these scripts, use the plugin's withPackages attribute: weechat.override { configure = {availablePlugins, ...}: { plugins = with availablePlugins; [ (python.withPackages (ps: with ps; [ pycrypto python-dbus ])) @@ -25,20 +25,20 @@ }; } - + - - In order to also keep all default plugins installed, it is possible to use the following method: + + In order to also keep all default plugins installed, it is possible to use the following method: weechat.override { configure = { availablePlugins, ... }: { plugins = builtins.attrValues (availablePlugins // { python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]); }); }; } - + - - WeeChat allows to set defaults on startup using the --run-command. The configure method can be used to pass commands to the program: + + WeeChat allows to set defaults on startup using the --run-command. The configure method can be used to pass commands to the program: weechat.override { configure = { availablePlugins, ... }: { init = '' @@ -47,11 +47,11 @@ ''; }; } - Further values can be added to the list of commands when running weechat --run-command "your-commands". - + Further values can be added to the list of commands when running weechat --run-command "your-commands". + - - Additionally it's possible to specify scripts to be loaded when starting weechat. These will be loaded before the commands from init: + + Additionally it's possible to specify scripts to be loaded when starting weechat. These will be loaded before the commands from init: weechat.override { configure = { availablePlugins, ... }: { scripts = with pkgs.weechatScripts; [ @@ -62,10 +62,10 @@ '': }; } - + - - In nixpkgs there's a subpackage which contains derivations for WeeChat scripts. Such derivations expect a passthru.scripts attribute which contains a list of all scripts inside the store path. Furthermore all scripts have to live in $out/share. An exemplary derivation looks like this: + + In nixpkgs there's a subpackage which contains derivations for WeeChat scripts. Such derivations expect a passthru.scripts attribute which contains a list of all scripts inside the store path. Furthermore all scripts have to live in $out/share. An exemplary derivation looks like this: { stdenv, fetchurl }: stdenv.mkDerivation { @@ -81,5 +81,5 @@ stdenv.mkDerivation { cp bar.lua $out/share ''; } - -
\ No newline at end of file + + diff --git a/doc/builders/packages/xorg.xml b/doc/builders/packages/xorg.xml index 4526121687fc..ebf4930cc097 100644 --- a/doc/builders/packages/xorg.xml +++ b/doc/builders/packages/xorg.xml @@ -1,34 +1,34 @@
- X.org + X.org - - The Nix expressions for the X.org packages reside in pkgs/servers/x11/xorg/default.nix. This file is automatically generated from lists of tarballs in an X.org release. As such it should not be modified directly; rather, you should modify the lists, the generator script or the file pkgs/servers/x11/xorg/overrides.nix, in which you can override or add to the derivations produced by the generator. - + + The Nix expressions for the X.org packages reside in pkgs/servers/x11/xorg/default.nix. This file is automatically generated from lists of tarballs in an X.org release. As such it should not be modified directly; rather, you should modify the lists, the generator script or the file pkgs/servers/x11/xorg/overrides.nix, in which you can override or add to the derivations produced by the generator. + - - The generator is invoked as follows: + + The generator is invoked as follows: $ cd pkgs/servers/x11/xorg $ cat tarballs-7.5.list extra.list old.list \ | perl ./generate-expr-from-tarballs.pl - For each of the tarballs in the .list files, the script downloads it, unpacks it, and searches its configure.ac and *.pc.in files for dependencies. This information is used to generate default.nix. The generator caches downloaded tarballs between runs. Pay close attention to the NOT FOUND: name messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.) - + For each of the tarballs in the .list files, the script downloads it, unpacks it, and searches its configure.ac and *.pc.in files for dependencies. This information is used to generate default.nix. The generator caches downloaded tarballs between runs. Pay close attention to the NOT FOUND: name messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.) + - - A file like tarballs-7.5.list contains all tarballs in a X.org release. It can be generated like this: + + A file like tarballs-7.5.list contains all tarballs in a X.org release. It can be generated like this: $ export i="mirror://xorg/X11R7.4/src/everything/" $ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \ | sort > tarballs-7.4.list - extra.list contains libraries that aren’t part of X.org proper, but are closely related to it, such as libxcb. old.list contains some packages that were removed from X.org, but are still needed by some people or by other packages (such as imake). - + extra.list contains libraries that aren’t part of X.org proper, but are closely related to it, such as libxcb. old.list contains some packages that were removed from X.org, but are still needed by some people or by other packages (such as imake). + - - If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, patches or a postInstall hook), you should modify pkgs/servers/x11/xorg/overrides.nix. - -
\ No newline at end of file + + If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, patches or a postInstall hook), you should modify pkgs/servers/x11/xorg/overrides.nix. + + diff --git a/doc/builders/special.xml b/doc/builders/special.xml index 56d98f025278..15fdba9a0419 100644 --- a/doc/builders/special.xml +++ b/doc/builders/special.xml @@ -8,5 +8,3 @@ - - diff --git a/doc/builders/trivial-builders.xml b/doc/builders/trivial-builders.xml index c99425620b16..df0e38da1aa2 100644 --- a/doc/builders/trivial-builders.xml +++ b/doc/builders/trivial-builders.xml @@ -3,11 +3,9 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="chap-trivial-builders"> Trivial builders - Nixpkgs provides a couple of functions that help with building derivations. The most important one, stdenv.mkDerivation, has already been documented above. The following functions wrap stdenv.mkDerivation, making it easier to use in certain cases. - diff --git a/doc/using/overrides.xml b/doc/using/overrides.xml index 991e13a1b828..c9d36ddb2d7b 100644 --- a/doc/using/overrides.xml +++ b/doc/using/overrides.xml @@ -3,15 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="chap-overrides"> Overriding - Sometimes one wants to override parts of nixpkgs, e.g. derivation attributes, the results of derivations. - These functions are used to make changes to packages, returning only single packages. Overlays, on the other hand, can be used to combine the overridden packages across the entire package set of Nixpkgs. -
<pkg>.override @@ -45,7 +42,6 @@ mypkg = pkgs.callPackage ./mypkg.nix { In the first example, pkgs.foo is the result of a function call with some default arguments, usually a derivation. Using pkgs.foo.override will call the same function with the given new arguments.
-
<pkg>.overrideAttrs @@ -76,7 +72,6 @@ helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
-
<pkg>.overrideDerivation @@ -124,7 +119,6 @@ mySed = pkgs.gnused.overrideDerivation (oldAttrs: {
-
lib.makeOverridable