commit 8ce611b9fb664b6860b55f003d0b42a1dd0ab8e9 · pyrox.dev/nixpkgs

+46

nixos/doc/manual/configuration/declarative-packages.section.md

···

       1
       1
       +
       # Declarative Package Management {#sec-declarative-package-mgmt}

     

       2
       2
       +
       

     

       3
       3
       +
       With declarative package management, you specify which packages you want

     

       4
       4
       +
       on your system by setting the option

     

       5
       5
       +
       [](#opt-environment.systemPackages). For instance, adding the

     

       6
       6
       +
       following line to `configuration.nix` enables the Mozilla Thunderbird

     

       7
       7
       +
       email application:

     

       8
       8
       +
       

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       environment.systemPackages = [ pkgs.thunderbird ];

     

       11
       11
       +
       ```

     

       12
       12
       +
       

     

       13
       13
       +
       The effect of this specification is that the Thunderbird package from

     

       14
       14
       +
       Nixpkgs will be built or downloaded as part of the system when you run

     

       15
       15
       +
       `nixos-rebuild switch`.

     

       16
       16
       +
       

     

       17
       17
       +
       ::: {.note}

     

       18
       18
       +
       Some packages require additional global configuration such as D-Bus or

     

       19
       19
       +
       systemd service registration so adding them to

     

       20
       20
       +
       [](#opt-environment.systemPackages) might not be sufficient. You are

     

       21
       21
       +
       advised to check the [list of options](#ch-options) whether a NixOS

     

       22
       22
       +
       module for the package does not exist.

     

       23
       23
       +
       :::

     

       24
       24
       +
       

     

       25
       25
       +
       You can get a list of the available packages as follows:

     

       26
       26
       +
       

     

       27
       27
       +
       ```ShellSession

     

       28
       28
       +
       $ nix-env -qaP '*' --description

     

       29
       29
       +
       nixos.firefox   firefox-23.0   Mozilla Firefox - the browser, reloaded

     

       30
       30
       +
       ...

     

       31
       31
       +
       ```

     

       32
       32
       +
       

     

       33
       33
       +
       The first column in the output is the *attribute name*, such as

     

       34
       34
       +
       `nixos.thunderbird`.

     

       35
       35
       +
       

     

       36
       36
       +
       Note: the `nixos` prefix tells us that we want to get the package from

     

       37
       37
       +
       the `nixos` channel and works only in CLI tools. In declarative

     

       38
       38
       +
       configuration use `pkgs` prefix (variable).

     

       39
       39
       +
       

     

       40
       40
       +
       To "uninstall" a package, simply remove it from

     

       41
       41
       +
       [](#opt-environment.systemPackages) and run `nixos-rebuild switch`.

     

       42
       42
       +
       

     

       43
       43
       +
       ```{=docbook}

     

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

     

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

     

       46
       46
       +
       ```

-54

nixos/doc/manual/configuration/declarative-packages.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
                version="5.0"

     

       5
       5
       -
                xml:id="sec-declarative-package-mgmt">

     

       6
       6
       -
        <title>Declarative Package Management</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         With declarative package management, you specify which packages you want on

     

       10
       10
       -
         your system by setting the option

     

       11
       11
       -
         <xref linkend="opt-environment.systemPackages"/>. For instance, adding the

     

       12
       12
       -
         following line to <filename>configuration.nix</filename> enables the Mozilla

     

       13
       13
       -
         Thunderbird email application:

     

       14
       14
       -
       <programlisting>

     

       15
       15
       -
       <xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird ];

     

       16
       16
       -
       </programlisting>

     

       17
       17
       -
         The effect of this specification is that the Thunderbird package from Nixpkgs

     

       18
       18
       -
         will be built or downloaded as part of the system when you run

     

       19
       19
       -
         <command>nixos-rebuild switch</command>.

     

       20
       20
       -
        </para>

     

       21
       21
       -
       

     

       22
       22
       -
        <note>

     

       23
       23
       -
         <para>

     

       24
       24
       -
          Some packages require additional global configuration such as D-Bus or systemd service registration so adding them to <xref linkend="opt-environment.systemPackages"/> might not be sufficient. You are advised to check the <link xlink:href="#ch-options">list of options</link> whether a NixOS module for the package does not exist.

     

       25
       25
       -
         </para>

     

       26
       26
       -
        </note>

     

       27
       27
       -
       

     

       28
       28
       -
        <para>

     

       29
       29
       -
         You can get a list of the available packages as follows:

     

       30
       30
       -
       <screen>

     

       31
       31
       -
       <prompt>$ </prompt>nix-env -qaP '*' --description

     

       32
       32
       -
       nixos.firefox   firefox-23.0   Mozilla Firefox - the browser, reloaded

     

       33
       33
       -
       <replaceable>...</replaceable>

     

       34
       34
       -
       </screen>

     

       35
       35
       -
         The first column in the output is the <emphasis>attribute name</emphasis>,

     

       36
       36
       -
         such as <literal>nixos.thunderbird</literal>.

     

       37
       37
       -
        </para>

     

       38
       38
       -
        <para>

     

       39
       39
       -
         Note: the <literal>nixos</literal> prefix tells us that we want to get the

     

       40
       40
       -
         package from the <literal>nixos</literal> channel and works only in CLI tools.

     

       41
       41
       -
       

     

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

     

       43
       43
       -
        </para>

     

       44
       44
       -
       

     

       45
       45
       -
        <para>

     

       46
       46
       -
         To “uninstall” a package, simply remove it from

     

       47
       47
       -
         <xref linkend="opt-environment.systemPackages"/> and run

     

       48
       48
       -
         <command>nixos-rebuild switch</command>.

     

       49
       49
       -
        </para>

     

       50
       50
       -
       

     

       51
       51
       -
        <xi:include href="../from_md/configuration/customizing-packages.section.xml" />

     

       52
       52
       -
       

     

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

     

       54
       54
       -
       </section>

+1 -1

nixos/doc/manual/configuration/package-mgmt.xml

···

       26
       26
        
          </listitem>

     

       27
       27
        
         </itemizedlist>

     

       28
       28
        
        </para>

     

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

     

       29
       29
       +
        <xi:include href="../from_md/configuration/declarative-packages.section.xml" />

     

       30
       30
        
        <xi:include href="../from_md/configuration/ad-hoc-packages.section.xml" />

     

       31
       31
        
       </chapter>

+53

nixos/doc/manual/from_md/configuration/declarative-packages.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook"  xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="sec-declarative-package-mgmt">

     

       2
       2
       +
         <title>Declarative Package Management</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           With declarative package management, you specify which packages you

     

       5
       5
       +
           want on your system by setting the option

     

       6
       6
       +
           <xref linkend="opt-environment.systemPackages" />. For instance,

     

       7
       7
       +
           adding the following line to <literal>configuration.nix</literal>

     

       8
       8
       +
           enables the Mozilla Thunderbird email application:

     

       9
       9
       +
         </para>

     

       10
       10
       +
         <programlisting language="bash">

     

       11
       11
       +
       environment.systemPackages = [ pkgs.thunderbird ];

     

       12
       12
       +
       </programlisting>

     

       13
       13
       +
         <para>

     

       14
       14
       +
           The effect of this specification is that the Thunderbird package

     

       15
       15
       +
           from Nixpkgs will be built or downloaded as part of the system when

     

       16
       16
       +
           you run <literal>nixos-rebuild switch</literal>.

     

       17
       17
       +
         </para>

     

       18
       18
       +
         <note>

     

       19
       19
       +
           <para>

     

       20
       20
       +
             Some packages require additional global configuration such as

     

       21
       21
       +
             D-Bus or systemd service registration so adding them to

     

       22
       22
       +
             <xref linkend="opt-environment.systemPackages" /> might not be

     

       23
       23
       +
             sufficient. You are advised to check the

     

       24
       24
       +
             <link linkend="ch-options">list of options</link> whether a NixOS

     

       25
       25
       +
             module for the package does not exist.

     

       26
       26
       +
           </para>

     

       27
       27
       +
         </note>

     

       28
       28
       +
         <para>

     

       29
       29
       +
           You can get a list of the available packages as follows:

     

       30
       30
       +
         </para>

     

       31
       31
       +
         <programlisting>

     

       32
       32
       +
       $ nix-env -qaP '*' --description

     

       33
       33
       +
       nixos.firefox   firefox-23.0   Mozilla Firefox - the browser, reloaded

     

       34
       34
       +
       ...

     

       35
       35
       +
       </programlisting>

     

       36
       36
       +
         <para>

     

       37
       37
       +
           The first column in the output is the <emphasis>attribute

     

       38
       38
       +
           name</emphasis>, such as <literal>nixos.thunderbird</literal>.

     

       39
       39
       +
         </para>

     

       40
       40
       +
         <para>

     

       41
       41
       +
           Note: the <literal>nixos</literal> prefix tells us that we want to

     

       42
       42
       +
           get the package from the <literal>nixos</literal> channel and works

     

       43
       43
       +
           only in CLI tools. In declarative configuration use

     

       44
       44
       +
           <literal>pkgs</literal> prefix (variable).

     

       45
       45
       +
         </para>

     

       46
       46
       +
         <para>

     

       47
       47
       +
           To <quote>uninstall</quote> a package, simply remove it from

     

       48
       48
       +
           <xref linkend="opt-environment.systemPackages" /> and run

     

       49
       49
       +
           <literal>nixos-rebuild switch</literal>.

     

       50
       50
       +
         </para>

     

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

     

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

     

       53
       53
       +
       </section>