lix/doc/manual/quick-start.xml

145 lines
4.4 KiB
XML
Raw Normal View History

<chapter xmlns="http://docbook.org/ns/docbook"
2009-09-25 12:36:03 +00:00
xmlns:xlink="http://www.w3.org/1999/xlink"
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 the following chapters.</para>
<orderedlist>
2012-05-11 21:39:06 +00:00
<listitem><para>Download a source tarball or RPM or Debian/Ubuntu
package from <link xlink:href='http://nixos.org/'/>. Build source
distributions using the regular sequence:
2004-01-20 15:37:55 +00:00
<screen>
2004-01-20 15:37:55 +00:00
$ tar xvfj nix-<replaceable>version</replaceable>.tar.bz2
$ ./configure
$ make
$ make install <lineannotation>(as root)</lineannotation></screen>
2009-11-05 09:07:43 +00:00
This will install the Nix binaries in <filename>/usr/local</filename>
and keep the Nix store and other state in <filename>/nix</filename>.
You can change the former by specifying
<option>--prefix=<replaceable>path</replaceable></option>. The
location of the store can be changed using
<option>--with-store-dir=<replaceable>path</replaceable></option>.
However, you shouldn't change the store location, if at all possible,
since that will make it impossible to use pre-built binaries from the
Nixpkgs channel and other channels. The location of the state can be
changed using
<option>--localstatedir=<replaceable>path</replaceable>.</option></para></listitem>
<listitem><para>You should add
<filename><replaceable>prefix</replaceable>/etc/profile.d/nix.sh</filename>
to your <filename>~/.bashrc</filename> (or some other login
file).</para></listitem>
2004-01-20 15:37:55 +00:00
<listitem><para>Subscribe to the Nix Packages channel.
<screen>
2012-05-11 21:39:06 +00:00
$ nix-channel --add http://nixos.org/releases/nixpkgs/channels/nixpkgs-unstable</screen>
</para></listitem>
<listitem><para>Download the latest Nix expressions available in the channel.
<screen>
$ nix-channel --update</screen>
2007-12-04 11:42:58 +00:00
Note that this in itself doesn't download any packages, it just
downloads the Nix expressions that build them and stores them
somewhere (under <filename>~/.nix-defexpr</filename>, in case you're
curious). Also, it registers the fact that pre-built binaries are
available remotely.</para></listitem>
2007-12-04 11:42:58 +00:00
<listitem><para>See what installable packages are currently available
in the channel:
<screen>
$ nix-env -qa \*
2004-01-20 15:37:55 +00:00
docbook-xml-4.2
firefox-1.0pre-PR-0.10.1
hello-2.1.1
2004-01-20 15:37:55 +00:00
libxslt-1.1.0
<replaceable>...</replaceable></screen>
</para></listitem>
2004-01-20 15:37:55 +00:00
2007-12-04 11:42:58 +00:00
<listitem><para>Install some packages from the channel:
2004-01-20 15:37:55 +00:00
<screen>
$ nix-env -i hello firefox <replaceable>...</replaceable> </screen>
2004-01-20 15:37:55 +00:00
2007-12-04 11:42:58 +00:00
This should download pre-built packages; it should not build them
locally (if it does, something went wrong).</para></listitem>
2004-01-20 15:37:55 +00:00
<listitem><para>Test that they work:
2004-01-20 15:37:55 +00:00
<screen>
2004-01-20 15:37:55 +00:00
$ which hello
/home/eelco/.nix-profile/bin/hello
2004-01-20 15:37:55 +00:00
$ hello
Hello, world!
$ firefox
2004-01-20 15:37:55 +00:00
<lineannotation>(read Slashdot or something)</lineannotation></screen>
</para></listitem>
2004-01-20 15:37:55 +00:00
<listitem><para>Uninstall a package:
2004-01-20 15:37:55 +00:00
<screen>
2004-01-20 15:37:55 +00:00
$ nix-env -e hello</screen>
</para></listitem>
<listitem><para>To keep up-to-date with the channel, do:
<screen>
$ nix-channel --update
$ nix-env -u '*'</screen>
2007-12-04 11:42:58 +00:00
The latter command will upgrade each installed package for which there
is a “newer” version (as determined by comparing the version
numbers).</para></listitem>
2004-01-20 15:37:55 +00:00
2006-09-29 11:03:16 +00:00
<listitem><para>You can also install specific packages directly from
your web browser. For instance, you can go to <link
2012-05-11 21:39:06 +00: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 11:03:16 +00:00
appear asking you whether its okay to install the package. Say
<literal>Y</literal>. The package and all its dependencies will be
installed.</para></listitem>
<listitem><para>If you're unhappy with the result of a
2007-12-04 11:42:58 +00:00
<command>nix-env</command> action (e.g., an upgraded package turned
out not to work properly), you can go back:
2004-01-20 15:37:55 +00:00
<screen>
$ nix-env --rollback</screen>
2004-01-20 15:37:55 +00:00
</para></listitem>
2004-01-20 15:37:55 +00:00
<listitem><para>You should periodically run the Nix garbage collector
to get rid of unused packages, since uninstalls or upgrades don't
2004-11-14 00:24:57 +00:00
actually delete them:
2004-01-20 15:37:55 +00:00
<screen>
$ nix-collect-garbage -d</screen>
2004-01-20 15:37:55 +00:00
<!--
The first command deletes old “generations” of your profile (making
2007-12-04 11:42:58 +00:00
rollbacks impossible, but also making the packages in those old
generations available for garbage collection), while the second
command actually deletes them.-->
</para></listitem>
2004-01-20 15:37:55 +00:00
</orderedlist>
2004-01-20 15:37:55 +00:00
2004-11-14 00:24:57 +00:00
</chapter>