Nixpkgs/Manual

From NixOS Wiki

Links

In the nix ecosystem these are important manuals

Nix

The manual for nix, the package manager

https://nix.dev/manual/nix/stable

https://nix.dev/manual/nix/unstable

https://nix.dev/manual/nix/2.24

Nixpkgs

The manual for nixpkgs, the package repository

https://nixos.org/manual/nixpkgs/unstable

https://nixos.org/manual/nixpkgs/stable

Nixos

The manual for nixos, the linux based operating system

https://nixos.org/manual/nixos/stable

https://nixos.org/manual/nixos/unstable

home-manager

The manual for Home_Manager

https://nix-community.github.io/home-manager

Building the manuals yourself

To build the manuals above

nixos manual

cd nixpkgs
nix-build nixos/release.nix --no-out-link -A manualHTML.x86_64-linux # or aarch64-linux

nixpkgs manual

# master
nix build github:nixos/nixpkgs#nixpkgs-manual --print-out-paths --no-link

# nixos-unstable
nix build github:nixos/nixpkgs/nixos-unstable#nixpkgs-manual --print-out-paths --no-link

older versions of the manual

If you want to build the manual for older versions of nixpkgs for e.g. nixos-24.05

nix build github:nixos/nixpkgs/nixos-24.05#nixpkgs-manual --print-out-paths --no-link

To build the manual for a specific revision of nixpkgs

clone nixpkgs locally and cd into nixpkgs

checkout the specific revision (branch or commit)

git checkout nixos-24.05
nix build .#nixpkgs-manual --print-out-paths --no-link

nix manual

Warning: Building the nix manual requires building nix, for master branch it will build from source and it will take quite a while.
# before nix version 2.25.0
nix build github:nixos/nix/2.24.11#nix^doc --print-out-paths --no-link

# after 2.25.x
nix build github:nixos/nix/2.25.0#packages.x84_64-linux.nix-manual --print-out-paths --no-link

# master
nix build github:nixos/nix#packages.x84_64-linux.nix-manual --print-out-paths --no-link

home-manager manual

# unstable
nix build github:nix-community/home-manager#docs-html --print-out-paths --no-link

# stable version, e.g. 24.11
nix build github:nix-community/home-manager/release-24.11#docs-html --print-out-paths --no-link