3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/nixos/doc/manual
Emmanuel Rosa 4bee34dcc5
doc: clarify building-nixos CD/DVD instructions
This change updates the instructions for building a NixOS ISO so that it's clear how to do it.

Previously, the instructions stated to set NIXOS_CONFIG prior to running `nix-build`, yet the example provided by-passed NIXOS_CONFIG anyway. But the *really* important missing piece is the need for nixos/default.nix. See #21840.

This change removes the NIXOS_CONFIG verbiage, and adds steps to clone nixpkgs and (most importantly) cd'ing into nixpkgs/nixos. That way, the reader may think: *Oh, so I need a default.nix and a configuration.nix. Ahhh, OK.*

I purposely added the redundant default.nix argument.
2017-06-02 21:13:19 -04:00
..
administration Fix imperative container code examples 2017-04-24 22:31:02 +02:00
configuration nixos manual: add a note about "nofail" FS option 2017-04-30 14:10:30 +02:00
development doc: clarify building-nixos CD/DVD instructions 2017-06-02 21:13:19 -04:00
installation removing the advise to add virtualbox's guest additions in configuration.nix 2017-05-15 14:23:50 +02:00
release-notes Cleanup PostgreSQL for state version 17.09 (#25753) 2017-05-30 21:05:39 +01:00
default.nix NixOS: Use runCommand instead of mkDerivation in a few places 2016-09-29 13:05:28 +02:00
man-configuration.xml Manual: Explicitly mark commands that require to be run as root (#15589) 2016-06-01 15:23:32 +01:00
man-nixos-build-vms.xml Manual: Explicitly mark commands that require to be run as root (#15589) 2016-06-01 15:23:32 +01:00
man-nixos-generate-config.xml nixos-generate-config: Emit LUKS configuration for boot device 2016-05-25 18:04:41 +02:00
man-nixos-install.xml nixos-install: add options --closure, --no-channel-copy, --no-root-passwd, and --no-bootloader 2016-08-04 16:22:25 +01:00
man-nixos-option.xml Manual: Explicitly mark commands that require to be run as root (#15589) 2016-06-01 15:23:32 +01:00
man-nixos-rebuild.xml doc: correct typo (#21176) 2016-12-15 17:13:44 +01:00
man-nixos-version.xml Add some more info to the nixos-version manpage 2016-07-15 12:02:39 +02:00
man-pages.xml doc: add man page for nixos-version (#16869) 2016-07-12 16:29:13 +02:00
manual.xml fix manual 2016-06-01 21:55:31 +01:00
options-to-docbook.xsl fix https://github.com/NixOS/nixops/issues/331 2016-06-03 15:55:17 +01:00
README nixos/doc/manual: Fix typos in README. 2014-07-23 15:00:25 +02:00
style.css Manual: Chunk into separate pages 2014-08-25 19:08:31 +02:00

To build the manual, you need Nix installed on your system (no need
for NixOS). To install Nix, follow the instructions at

    https://nixos.org/nix/download.html

When you have Nix on your system, in the root directory of the project
(i.e., `nixpkgs`), run:

    nix-build nixos/release.nix -A manual.x86_64-linux

When this command successfully finishes, it will tell you where the
manual got generated.