summary refs log tree commit diff
path: root/nixos/doc/manual/configuration/declarative-packages.xml
blob: 5fb3bcb9f8f568528f60ce620f82b1bbb05aff2f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<section xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         version="5.0"
         xml:id="sec-declarative-package-mgmt">
 <title>Declarative Package Management</title>

 <para>
  With declarative package management, you specify which packages you want on
  your system by setting the option
  <xref linkend="opt-environment.systemPackages"/>. For instance, adding the
  following line to <filename>configuration.nix</filename> enables the Mozilla
  Thunderbird email application:
<programlisting>
<xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird ];
</programlisting>
  The effect of this specification is that the Thunderbird package from Nixpkgs
  will be built or downloaded as part of the system when you run
  <command>nixos-rebuild switch</command>.
 </para>

 <para>
  You can get a list of the available packages as follows:
<screen>
<prompt>$ </prompt>nix-env -qaP '*' --description
nixos.firefox   firefox-23.0   Mozilla Firefox - the browser, reloaded
<replaceable>...</replaceable>
</screen>
  The first column in the output is the <emphasis>attribute name</emphasis>,
  such as <literal>nixos.thunderbird</literal>.
 </para>
 <para>
  Note: the <literal>nixos</literal> prefix tells us that we want to get the
  package from the <literal>nixos</literal> channel and works only in CLI tools.

  In declarative configuration use <literal>pkgs</literal> prefix (variable).
 </para>

 <para>
  To “uninstall” a package, simply remove it from
  <xref linkend="opt-environment.systemPackages"/> and run
  <command>nixos-rebuild switch</command>.
 </para>

 <xi:include href="customizing-packages.xml" />

 <xi:include href="adding-custom-packages.xml" />
</section>