nixpkgs/nixos/doc/manual
Nicolas B. Pierron c231506b5a Merge pull request #5362 from nbp/update-channels
Add a script to add git branches for each channel.

To create / update references to remote / local channels, you have to run `./maintainers/scripts/update-channel-branches.sh` while you are at the top-level of nixpkgs work directory.  To make this convenient for Nixpkgs / NixOS developer, one can run the following command:

```
$ git config --add alias.fetch-channels '!sh -c "$(git rev-parse --show-cdup)maintainers/scripts/update-channel-branches.sh"'
```

Which will register the alias fetch-channels such that the script can used from sub-directory of nixpkgs by running `git fetch-channels`.
2014-12-20 16:49:18 -08:00
..
administration Use https://cache.nixos.org 2014-12-09 13:38:46 +01:00
configuration NetworkManager.service -> network-manager.service 2014-11-27 12:10:20 +01:00
development update-channel-branches.sh: Add verbosity to improve the user experience, and update NixOS documentation. 2014-12-18 22:25:21 +01:00
installation typo 2014-12-14 11:29:09 +01:00
release-notes nixos: Add VBox hardening to 14.12 release notes. 2014-12-18 22:58:37 +01:00
default.nix options.json: Filter out "visible" and "internal" attributes 2014-11-17 15:17:40 +01:00
man-configuration.xml
man-nixos-build-vms.xml
man-nixos-generate-config.xml
man-nixos-install.xml
man-nixos-option.xml nixos-option: fixes as suggested by @nbp 2014-09-06 20:59:14 +02:00
man-nixos-rebuild.xml
man-pages.xml
manual.xml Chunk NixOS manual 2014-08-26 19:03:49 +02:00
options-to-docbook.xsl
README
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.