doc/preface.chapter.md

   1 # Preface {#preface}
   2
   3 The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
   4 [Nix package manager](https://nixos.org/nix/), released under a
   5 [permissive MIT license](https://github.com/NixOS/nixpkgs/blob/master/COPYING).
   6 Packages are available for several platforms, and can be used with the Nix
   7 package manager on most GNU/Linux distributions as well as [NixOS](https://nixos.org/nixos).
   8
   9 This document is the user [_reference_](https://nix.dev/contributing/documentation/diataxis#reference) manual for Nixpkgs.
  10 It describes entire public interface of Nixpkgs in a concise and orderly manner, and all relevant behaviors, with examples and cross-references.
  11
  12 To discover other kinds of documentation:
  13 - [nix.dev](https://nix.dev/): Tutorials and guides for getting things done with Nix
  14 - [NixOS **Option Search**](https://search.nixos.org/options) and reference documentation
  15 - [Nixpkgs **Package Search**](https://search.nixos.org/packages)
  16 - [**NixOS** manual](https://nixos.org/manual/nixos/stable/): Reference documentation for the NixOS Linux distribution
  17 - [`CONTRIBUTING.md`](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md): Contributing to Nixpkgs, including this manual
  18
  19 ## Overview of Nixpkgs {#overview-of-nixpkgs}
  20
  21 Nix expressions describe how to build packages from source and are collected in
  22 the [nixpkgs repository](https://github.com/NixOS/nixpkgs). Also included in the
  23 collection are Nix expressions for
  24 [NixOS modules](https://nixos.org/nixos/manual/index.html#sec-writing-modules).
  25 With these expressions the Nix package manager can build binary packages.
  26
  27 Packages, including the Nix packages collection, are distributed through
  28 [channels](https://nixos.org/nix/manual/#sec-channels). The collection is
  29 distributed for users of Nix on non-NixOS distributions through the channel
  30 `nixpkgs-unstable`. Users of NixOS generally use one of the `nixos-*` channels,
  31 e.g. `nixos-22.11`, which includes all packages and modules for the stable NixOS
  32 22.11. Stable NixOS releases are generally only given
  33 security updates. More up to date packages and modules are available via the
  34 `nixos-unstable` channel.
  35
  36 Both `nixos-unstable` and `nixpkgs-unstable` follow the `master` branch of the
  37 nixpkgs repository, although both do lag the `master` branch by generally
  38 [a couple of days](https://status.nixos.org/). Updates to a channel are
  39 distributed as soon as all tests for that channel pass, e.g.
  40 [this table](https://hydra.nixos.org/job/nixpkgs/trunk/unstable#tabs-constituents)
  41 shows the status of tests for the `nixpkgs-unstable` channel.
  42
  43 The tests are conducted by a cluster called [Hydra](https://nixos.org/hydra/),
  44 which also builds binary packages from the Nix expressions in Nixpkgs for
  45 `x86_64-linux`, `i686-linux` and `x86_64-darwin`.
  46 The binaries are made available via a [binary cache](https://cache.nixos.org).
  47
  48 The current Nix expressions of the channels are available in the
  49 [nixpkgs repository](https://github.com/NixOS/nixpkgs) in branches
  50 that correspond to the channel names (e.g. `nixos-22.11-small`).