From 2b74354e5226cda44aa23e8868aaecba6f6250d8 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Mon, 24 Nov 2014 14:53:50 +0100 Subject: Combine introduction / quick start parts --- doc/manual/introduction/introduction.xml | 1 + doc/manual/introduction/quick-start.xml | 111 +++++++++++++++++++++++++++++ doc/manual/manual.xml | 3 +- doc/manual/quick-start/getting-started.xml | 108 ---------------------------- doc/manual/quick-start/quick-start.xml | 17 ----- 5 files changed, 114 insertions(+), 126 deletions(-) create mode 100644 doc/manual/introduction/quick-start.xml delete mode 100644 doc/manual/quick-start/getting-started.xml delete mode 100644 doc/manual/quick-start/quick-start.xml diff --git a/doc/manual/introduction/introduction.xml b/doc/manual/introduction/introduction.xml index 665fef2fb990..12b2cc761063 100644 --- a/doc/manual/introduction/introduction.xml +++ b/doc/manual/introduction/introduction.xml @@ -7,5 +7,6 @@ Introduction + diff --git a/doc/manual/introduction/quick-start.xml b/doc/manual/introduction/quick-start.xml new file mode 100644 index 000000000000..396b7b167aff --- /dev/null +++ b/doc/manual/introduction/quick-start.xml @@ -0,0 +1,111 @@ + + +Quick Start + +This chapter is for impatient people who don't like reading +documentation. For more in-depth information you are kindly referred +to subsequent chapters. + + + +Install single-user Nix by running the following: + + +$ curl https://nixos.org/nix/install | sh + + +This will install Nix in /nix. The install script +will create /nix using sudo, +so make sure you have sufficient rights. (For other installation +methods, see .) + +See what installable packages are currently available +in the channel: + + +$ nix-env -qa +docbook-xml-4.2 +firefox-1.0pre-PR-0.10.1 +hello-2.1.1 +libxslt-1.1.0 +... + + + +Install some packages from the channel: + + +$ nix-env -i hello ... + +This should download pre-built packages; it should not build them +locally (if it does, something went wrong). + +Test that they work: + + +$ which hello +/home/eelco/.nix-profile/bin/hello +$ hello +Hello, world! + + + + +Uninstall a package: + + +$ nix-env -e hello + + + +To keep up-to-date with the channel, do: + + +$ nix-channel --update nixpkgs +$ nix-env -u '*' + +The latter command will upgrade each installed package for which there +is a “newer” version (as determined by comparing the version +numbers). + +You can also install specific packages directly from +your web browser. For instance, you can go to and click on any link for the individual packages for your +platform. Associate application/nix-package with +the program nix-install-package. A window should +appear asking you whether it’s okay to install the package. Say +Y. The package and all its dependencies will be +installed. + +If you're unhappy with the result of a +nix-env action (e.g., an upgraded package turned +out not to work properly), you can go back: + + +$ nix-env --rollback + + + +You should periodically run the Nix garbage collector +to get rid of unused packages, since uninstalls or upgrades don't +actually delete them: + + +$ nix-collect-garbage -d + + + + + + + + diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml index 4522f819034d..5c46f303a11c 100644 --- a/doc/manual/manual.xml +++ b/doc/manual/manual.xml @@ -29,14 +29,15 @@ + - diff --git a/doc/manual/quick-start/getting-started.xml b/doc/manual/quick-start/getting-started.xml deleted file mode 100644 index 3dc79b9b52d5..000000000000 --- a/doc/manual/quick-start/getting-started.xml +++ /dev/null @@ -1,108 +0,0 @@ - - -Getting Started with Nix - -This tutorial takes you through the basic tasks you might perform when you start using Nix. - - -Install single-user Nix by running the following: - - -$ curl https://nixos.org/nix/install | sh - - -This will install Nix in /nix. The install script -will create /nix using sudo, -so make sure you have sufficient rights. (For other installation -methods, see .) - -See what installable packages are currently available -in the channel: - - -$ nix-env -qa -docbook-xml-4.2 -firefox-1.0pre-PR-0.10.1 -hello-2.1.1 -libxslt-1.1.0 -... - - - -Install some packages from the channel: - - -$ nix-env -i hello ... - -This should download pre-built packages; it should not build them -locally (if it does, something went wrong). - -Test that they work: - - -$ which hello -/home/eelco/.nix-profile/bin/hello -$ hello -Hello, world! - - - - -Uninstall a package: - - -$ nix-env -e hello - - - -To keep up-to-date with the channel, do: - - -$ nix-channel --update nixpkgs -$ nix-env -u '*' - -The latter command will upgrade each installed package for which there -is a “newer” version (as determined by comparing the version -numbers). - -You can also install specific packages directly from -your web browser. For instance, you can go to and click on any link for the individual packages for your -platform. Associate application/nix-package with -the program nix-install-package. A window should -appear asking you whether it’s okay to install the package. Say -Y. The package and all its dependencies will be -installed. - -If you're unhappy with the result of a -nix-env action (e.g., an upgraded package turned -out not to work properly), you can go back: - - -$ nix-env --rollback - - - -You should periodically run the Nix garbage collector -to get rid of unused packages, since uninstalls or upgrades don't -actually delete them: - - -$ nix-collect-garbage -d - - - - - - - - diff --git a/doc/manual/quick-start/quick-start.xml b/doc/manual/quick-start/quick-start.xml deleted file mode 100644 index b4757cb22043..000000000000 --- a/doc/manual/quick-start/quick-start.xml +++ /dev/null @@ -1,17 +0,0 @@ - - -Quick-Start - - -This section is for impatient people who don't like reading -documentation. For more in-depth information you are kindly referred -to subsequent chapters. - - - - - -- cgit 1.4.1