From 3778586b2aaf2b5c905866d91d6f67e617ceb203 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Tue, 20 Jan 2004 15:37:55 +0000 Subject: [PATCH] * Nix Quick Start guide. --- doc/manual/Makefile.am | 2 +- doc/manual/installation.xml | 2 +- doc/manual/manual.xml | 4 +- doc/manual/overview.xml | 2 +- doc/manual/quick-start.xml | 136 ++++++++++++++++++++++++++++++++++++ 5 files changed, 142 insertions(+), 4 deletions(-) create mode 100644 doc/manual/quick-start.xml diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am index f0344ef649..b1f5c3f465 100644 --- a/doc/manual/Makefile.am +++ b/doc/manual/Makefile.am @@ -9,7 +9,7 @@ XSLTPROC = $(ENV) $(xsltproc) $(xmlflags) --catalogs \ SOURCES = manual.xml introduction.xml installation.xml overview.xml \ nix-env.xml nix-store.xml nix-instantiate.xml \ troubleshooting.xml bugs.xml opt-verbose.xml \ - style.css images + quick-start.xml style.css images manual.is-valid: $(SOURCES) version.xml $(XMLLINT) --noout --valid manual.xml diff --git a/doc/manual/installation.xml b/doc/manual/installation.xml index ebc4f168a7..39f6654ef8 100644 --- a/doc/manual/installation.xml +++ b/doc/manual/installation.xml @@ -1,4 +1,4 @@ - + Installation diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml index e95b0fc91d..d47e571238 100644 --- a/doc/manual/manual.xml +++ b/doc/manual/manual.xml @@ -4,6 +4,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + @@ -26,12 +27,13 @@ Dolstra - 2003 + 2004 Eelco Dolstra &introduction; + &quick-start; &installation; &overview; diff --git a/doc/manual/overview.xml b/doc/manual/overview.xml index 9925be9943..191f7a6fe0 100644 --- a/doc/manual/overview.xml +++ b/doc/manual/overview.xml @@ -1,4 +1,4 @@ - + Overview diff --git a/doc/manual/quick-start.xml b/doc/manual/quick-start.xml new file mode 100644 index 0000000000..62dc64939f --- /dev/null +++ b/doc/manual/quick-start.xml @@ -0,0 +1,136 @@ + + Quick Start + + + This chapter is for impatient people who don't like reading + documentation. For more in-depth information you are kindly + referred to and . + + + + + + + Download a source tarball or RPM from . + Build source distributions using the regular sequence: + + +$ tar xvfj nix-version.tar.bz2 +$ ./configure +$ make +$ make install (as root) + + This will install Nix in /nix. + + + + + + Get some Nix expressions for pre-built packages by downloading + the latest nixpkgs distribution (from the + same location), and unpack them. + + +$ wget http://.../nix/nixpkgs-version/nixpkgs-version.tar.bz2 +$ tar xfj nixpkgs-version.tar.bz2 + + + + + + + Pull the Nix cache. This ensures that when you install + packages they are downloaded in pre-built form from the + network, rather than built from source. + + +$ nix-pull http://.../nix/nixpkgs-version/ + + + + + Note that currently we only pre-build for Linux on x86 + platforms. + + + + + + + See what's available: + + +$ nix-env -qaf nixpkgs-version +MozillaFirebird-0.7 +hello-2.1.1 +docbook-xml-4.2 +libxslt-1.1.0 +... + + + + + + + Install some packages: + + +$ nix-env -iBf nixpkgs-version hello MozillaFirebird ... + + + + + + + Test that they work: + + +$ which hello +/home/eelco/.nix-userenv/bin/hello +$ hello +Hello, world! +$ MozillaFirebird +(read Slashdot or something) + + + + + + + Uninstall a package: + + +$ nix-env -e hello + + + + + + + If a new release of nixpkgs comes along, + you can upgrade all installed packages to the latest versions + by downloading and unpacking the new release and doing: + + +$ nix-env -uBf nixpkgs-version '*' + + + + + + + You should periodically run the Nix garbage collector to get + rid of unused packages, since uninstalls or upgrades don't + actual delete them: + + +$ nix-collect-garbage | xargs nix-store --delete + + + + + + + \ No newline at end of file