tvl-depot/doc/manual/introduction/quick-start.xml

137 lines
3.4 KiB
XML
Raw Normal View History

<chapter xmlns="http://docbook.org/ns/docbook"
2014-08-27 18:41:09 +02:00
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="chap-quick-start">
<title>Quick Start</title>
<para>This chapter is for impatient people who don't like reading
documentation. For more in-depth information you are kindly referred
to subsequent chapters.</para>
2014-08-27 18:41:09 +02:00
<procedure>
<step><para>Install single-user Nix by running the following:
<screen>
$ curl https://nixos.org/nix/install | sh
2014-04-08 16:28:39 +02:00
</screen>
2014-04-08 16:28:39 +02:00
This will install Nix in <filename>/nix</filename>. The install script
will create <filename>/nix</filename> using <command>sudo</command>,
so make sure you have sufficient rights. (For other installation
2014-08-27 18:41:09 +02:00
methods, see <xref linkend="chap-installation"/>.)</para></step>
2014-08-27 18:41:09 +02:00
<step><para>See what installable packages are currently available
2007-12-04 12:42:58 +01:00
in the channel:
<screen>
2014-04-08 16:28:39 +02:00
$ nix-env -qa
2014-11-24 15:14:07 +01:00
docbook-xml-4.3
docbook-xml-4.5
firefox-33.0.2
hello-2.9
libxslt-1.1.28
2004-01-20 16:37:55 +01:00
<replaceable>...</replaceable></screen>
2014-08-27 18:41:09 +02:00
</para></step>
2004-01-20 16:37:55 +01:00
2014-08-27 18:41:09 +02:00
<step><para>Install some packages from the channel:
<screen>
2014-04-08 16:28:39 +02:00
$ nix-env -i hello <replaceable>...</replaceable> </screen>
2004-01-20 16:37:55 +01:00
2007-12-04 12:42:58 +01:00
This should download pre-built packages; it should not build them
2014-08-27 18:41:09 +02:00
locally (if it does, something went wrong).</para></step>
2004-01-20 16:37:55 +01:00
2014-08-27 18:41:09 +02:00
<step><para>Test that they work:
2004-01-20 16:37:55 +01:00
<screen>
2004-01-20 16:37:55 +01:00
$ which hello
/home/eelco/.nix-profile/bin/hello
2004-01-20 16:37:55 +01:00
$ hello
Hello, world!
2014-04-08 16:28:39 +02:00
</screen>
2004-01-20 16:37:55 +01:00
2014-08-27 18:41:09 +02:00
</para></step>
2014-08-27 18:41:09 +02:00
<step><para>Uninstall a package:
2004-01-20 16:37:55 +01:00
<screen>
2004-01-20 16:37:55 +01:00
$ nix-env -e hello</screen>
2014-08-27 18:41:09 +02:00
</para></step>
2014-11-24 15:14:07 +01:00
<step><para>You can also test a package without installing it:
<screen>
$ nix-shell -p hello
</screen>
This builds or downloads GNU Hello and its dependencies, then drops
you into a Bash shell where the <command>hello</command> command is
present, all without affecting your normal environment:
<screen>
[nix-shell:~]$ hello
Hello, world!
[nix-shell:~]$ exit
$ hello
hello: command not found
</screen>
</para></step>
2014-08-27 18:41:09 +02:00
<step><para>To keep up-to-date with the channel, do:
<screen>
2014-04-08 16:28:39 +02:00
$ nix-channel --update nixpkgs
$ nix-env -u '*'</screen>
2007-12-04 12:42:58 +01:00
The latter command will upgrade each installed package for which there
is a “newer” version (as determined by comparing the version
2014-08-27 18:41:09 +02:00
numbers).</para></step>
2004-01-20 16:37:55 +01:00
2014-11-24 15:14:07 +01:00
<!--
2014-08-27 18:41:09 +02:00
<step><para>You can also install specific packages directly from
2006-09-29 13:03:16 +02:00
your web browser. For instance, you can go to <link
2012-05-11 23:39:06 +02:00
xlink:href="http://hydra.nixos.org/jobset/nixpkgs/trunk/channel/latest"
/> and click on any link for the individual packages for your
platform. Associate <literal>application/nix-package</literal> with
the program <command>nix-install-package</command>. A window should
2006-09-29 13:03:16 +02:00
appear asking you whether its okay to install the package. Say
<literal>Y</literal>. The package and all its dependencies will be
2014-08-27 18:41:09 +02:00
installed.</para></step>
2014-11-24 15:14:07 +01:00
-->
2006-09-29 13:03:16 +02:00
2014-08-27 18:41:09 +02:00
<step><para>If you're unhappy with the result of a
2007-12-04 12:42:58 +01:00
<command>nix-env</command> action (e.g., an upgraded package turned
out not to work properly), you can go back:
2004-01-20 16:37:55 +01:00
<screen>
$ nix-env --rollback</screen>
2004-01-20 16:37:55 +01:00
2014-08-27 18:41:09 +02:00
</para></step>
2004-01-20 16:37:55 +01:00
2014-08-27 18:41:09 +02:00
<step><para>You should periodically run the Nix garbage collector
to get rid of unused packages, since uninstalls or upgrades don't
2004-11-14 01:24:57 +01:00
actually delete them:
2004-01-20 16:37:55 +01:00
<screen>
$ nix-collect-garbage -d</screen>
2004-01-20 16:37:55 +01:00
<!--
The first command deletes old “generations” of your profile (making
2007-12-04 12:42:58 +01:00
rollbacks impossible, but also making the packages in those old
generations available for garbage collection), while the second
command actually deletes them.-->
2014-08-27 18:41:09 +02:00
</para></step>
2004-01-20 16:37:55 +01:00
2014-08-27 18:41:09 +02:00
</procedure>
2004-01-20 16:37:55 +01:00
</chapter>