Nixpkgs/Manuals: Difference between revisions
Phanirithvij (talk | contribs) m fix |
Phanirithvij (talk | contribs) m Phanirithvij moved page Nixpkgs/Manual to Nixpkgs/Manuals: Misspelled title |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 31: | Line 31: | ||
=== home-manager === | === home-manager === | ||
The manual for [[ | The manual for [[Home Manager]] | ||
https://nix-community.github.io/home-manager | https://nix-community.github.io/home-manager | ||
=== nix-darwin === | |||
The manual for [[Nix-darwin]] | |||
https://daiderd.com/nix-darwin/manual/index.html | |||
== Building the manuals yourself == | == Building the manuals yourself == | ||
| Line 58: | Line 64: | ||
==== older versions of the manual ==== | ==== older versions of the manual ==== | ||
If you want to build the manual for older versions of nixpkgs for e.g. nixos-24. | If you want to build the manual for older versions of nixpkgs for e.g. nixos-24.05 | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
nix build github:nixos/nixpkgs/nixos-24. | nix build github:nixos/nixpkgs/nixos-24.05#nixpkgs-manual --print-out-paths --no-link | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 84: | Line 90: | ||
# after 2.25.x | # after 2.25.x | ||
nix build github:nixos/nix/2.25.0# | nix build github:nixos/nix/2.25.0#nix-manual --print-out-paths --no-link | ||
# master | # master | ||
nix build github:nixos/nix#packages. | nix build github:nixos/nix#nix-manual --print-out-paths --no-link | ||
# for other system | |||
nix build github:nixos/nix/2.25.0#packages.aarch64-darwin.nix-manual --print-out-paths --no-link | |||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 98: | Line 107: | ||
# stable version, e.g. 24.11 | # stable version, e.g. 24.11 | ||
nix build github:nix-community/home-manager/release-24.11#docs-html --print-out-paths --no-link | nix build github:nix-community/home-manager/release-24.11#docs-html --print-out-paths --no-link | ||
</syntaxhighlight> | |||
=== nix-darwin manual === | |||
<syntaxhighlight lang="bash"> | |||
# unstable | |||
nix build github:LnL7/nix-darwin#manualHTML --print-out-paths --no-link | |||
# stable version, e.g. 24.11 | |||
nix build github:LnL7/nix-darwin/nix-darwin-24.11#manualHTML --print-out-paths --no-link | |||
# in local clone with nix-build | |||
nix-build release.nix -A docs.manualHTML | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 03:55, 16 March 2025
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
nix-darwin
The manual for Nix-darwin
https://daiderd.com/nix-darwin/manual/index.html
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
# 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#nix-manual --print-out-paths --no-link
# master
nix build github:nixos/nix#nix-manual --print-out-paths --no-link
# for other system
nix build github:nixos/nix/2.25.0#packages.aarch64-darwin.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
nix-darwin manual
# unstable
nix build github:LnL7/nix-darwin#manualHTML --print-out-paths --no-link
# stable version, e.g. 24.11
nix build github:LnL7/nix-darwin/nix-darwin-24.11#manualHTML --print-out-paths --no-link
# in local clone with nix-build
nix-build release.nix -A docs.manualHTML