From fb45b0f5482546b98c984fb9fa753332ba84f72d Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Sat, 9 Apr 2005 17:16:00 +0000 Subject: [PATCH] * Document nix-channel. --- doc/manual/Makefile.am | 4 +- doc/manual/conf-file.xml | 2 +- doc/manual/env-common.xml | 9 ++-- doc/manual/manual.xml | 4 ++ doc/manual/nix-channel.xml | 83 +++++++++++++++++++++++++++++++ doc/manual/nix-store.xml | 14 ++++-- doc/manual/package-management.xml | 9 ++-- 7 files changed, 108 insertions(+), 17 deletions(-) create mode 100644 doc/manual/nix-channel.xml diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am index f5a93cf30..81367fd14 100644 --- a/doc/manual/Makefile.am +++ b/doc/manual/Makefile.am @@ -5,12 +5,12 @@ XSLTPROC = $(ENV) $(xsltproc) $(xmlflags) --catalogs \ --param section.autolabel 1 \ --param section.label.includes.component.label 1 \ --param html.stylesheet \'style.css\' \ - --param xref.with.number.and.title 0 \ + --param xref.with.number.and.title 1 \ --param toc.section.depth 3 man1_MANS = nix-env.1 nix-build.1 nix-store.1 nix-instantiate.1 \ nix-collect-garbage.1 nix-push.1 nix-pull.1 \ - nix-prefetch-url.1 + nix-prefetch-url.1 nix-channel.1 FIGURES = figures/user-environments.png diff --git a/doc/manual/conf-file.xml b/doc/manual/conf-file.xml index 13fac5335..629dd3bac 100644 --- a/doc/manual/conf-file.xml +++ b/doc/manual/conf-file.xml @@ -7,7 +7,7 @@ This file is a list of name = Comments start with a # character. An example configuration file is shown in . -Nix expression for GNU Hello +Nix configuration file gc-keep-outputs = true # Nice for developers diff --git a/doc/manual/env-common.xml b/doc/manual/env-common.xml index ec468eba1..2d25d3b28 100644 --- a/doc/manual/env-common.xml +++ b/doc/manual/env-common.xml @@ -246,11 +246,10 @@ $ mount -o bind /mnt/otherdisk/nix /nix references The reference graph of the inputs, in the format - accepted by the command nix-store - --register-validity. It is necessary to run - this command on the remote machine after copying the inputs to - inform Nix on the remote machine that the inputs are valid + accepted by the command nix-store + --register-validity. It is necessary to run this + command on the remote machine after copying the inputs to inform + Nix on the remote machine that the inputs are valid paths. diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml index f1dd0430a..a9e4473e0 100644 --- a/doc/manual/manual.xml +++ b/doc/manual/manual.xml @@ -56,6 +56,10 @@ nix-collect-garbage + + nix-channel + + nix-push diff --git a/doc/manual/nix-channel.xml b/doc/manual/nix-channel.xml new file mode 100644 index 000000000..059832a86 --- /dev/null +++ b/doc/manual/nix-channel.xml @@ -0,0 +1,83 @@ + + + + nix-channel + manage Nix channels + + + + + nix-channel + + url + url + + + + + + +Description + +A Nix channel is mechanism that allows you to automatically stay +up-to-date with a set of pre-built Nix expressions. A Nix channel is +just a URL that points to a place that contains a set of Nix +expressions, as well as a nix-push manifest. See +also . + +This command has the following operations: + + + + url + + Adds url to the list of + subscribed channels. + + + + url + + Removes url from the + list of subscribed channels. + + + + + + Prints the URLs of all subscribed channels on + standard output. + + + + + + Downloads the Nix expressions of all subscribed + channels, makes the conjunction of these the default for + nix-env operations (by calling nix-env + -I), and performs a nix-pull on the + manifests of all channels to make pre-built binaries + available. + + + + + + + +Note that and +do not automatically perform an update. + +The list of subscribed channels is stored in +~/.nix-channels. + +A channel consists of two elements: a bzipped Tar archive +containing the Nix expressions, and a manifest created by +nix-push. These must be stored under +url/nixexprs.tar.bz2 and +url/MANIFEST, +respectively. + + + + diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml index 614d30b6a..eead48397 100644 --- a/doc/manual/nix-store.xml +++ b/doc/manual/nix-store.xml @@ -571,13 +571,14 @@ $ gv graph.ps -Operation <option>--register-validity</option> + -Operation <option>--substitute</option> + diff --git a/doc/manual/package-management.xml b/doc/manual/package-management.xml index b827ae75b..450353337 100644 --- a/doc/manual/package-management.xml +++ b/doc/manual/package-management.xml @@ -408,7 +408,7 @@ followed to prevent infinite recursion. -Channels +Channels If you want to stay up to date with a set of packages, it’s not very convenient to manually download the latest set of Nix expressions @@ -418,9 +418,10 @@ pre-built binaries (if available), and upgrade using Nix channels. A Nix channel is just a URL that points to a place that contains -a set of Nix expressions and a manifest. Using the command -nix-channel you can automatically stay up to date -with whatever is available at that URL. +a set of Nix expressions and a manifest. Using the command nix-channel you +can automatically stay up to date with whatever is available at that +URL. You can subscribe to a channel using nix-channel --add, e.g.,