nixpkgs/nixos/doc/manual
Andreas Rammhold c55427ca43
nixos/doc: add types prefix to addCheck example
The function `addCheck` resides within the attrset `types`. We should be
explicit about this since otherwise people might be confused where it
does come from / why it doesn't work for them.
2019-03-11 22:56:56 +01:00
..
administration nixos/manual: add dummy ids to silence warnings 2019-02-08 10:23:57 +01:00
configuration Merge pull request #55436 from layus/warn-manual-ids 2019-03-09 08:21:07 -05:00
development nixos/doc: add types prefix to addCheck example 2019-03-11 22:56:56 +01:00
installation Merge pull request #55436 from layus/warn-manual-ids 2019-03-09 08:21:07 -05:00
release-notes module system: revert "remove types.optionSet", just deprecate (#56857) 2019-03-07 21:28:09 +02:00
.gitignore nixos docs: ignore generated files 2018-05-01 19:50:02 -04:00
default.nix Merge pull request #55436 from layus/warn-manual-ids 2019-03-09 08:21:07 -05:00
Makefile nixos/doc: Adds sub-folder to input files. 2018-10-03 22:34:57 -04:00
man-configuration.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-build-vms.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-enter.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-generate-config.xml nixos: doc typo and ws 2018-11-16 22:44:55 +01:00
man-nixos-install.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-option.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-rebuild.xml nixos/manual: fix build 2019-03-02 10:32:24 +00:00
man-nixos-version.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-pages.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
manual.xml docs: format 2018-09-29 20:51:11 -04:00
options-to-docbook.xsl nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
postprocess-option-descriptions.xsl nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
README
shell.nix doc: Adds xml fixing script. (see previous and next commits) 2018-05-31 21:02:15 -04: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.