commit 8a56a55bb442cbf2e2126d40df55e67b9aea0361 · pyrox.dev/nixpkgs

+1 -1

nixos/modules/config/fonts/fonts.nix

···

       11
        
             # TODO: find another name for it.

     

       12
        
             fonts = mkOption {

     

       13
        
               type = types.listOf types.path;

     

       14
       -
               example = [ pkgs.dejavu_fonts ];

     

       15
        
               description = "List of primary font paths.";

     

       16
        
               apply = list: list ++

     

       17
        
                 [ # - the user's current profile

···

       11
        
             # TODO: find another name for it.

     

       12
        
             fonts = mkOption {

     

       13
        
               type = types.listOf types.path;

     

       14
       +
               example = literalExample "[ pkgs.dejavu_fonts ]";

     

       15
        
               description = "List of primary font paths.";

     

       16
        
               apply = list: list ++

     

       17
        
                 [ # - the user's current profile

+6 -2

nixos/modules/config/power-management.nix

···

       35
        
             powerUpCommands = mkOption {

     

       36
        
               type = types.lines;

     

       37
        
               default = "";

     

       38
       -
               example = "${pkgs.hdparm}/sbin/hdparm -B 255 /dev/sda";

     

       0
        
       
     

       0
        
       
     

       39
        
               description =

     

       40
        
                 ''

     

       41
        
                   Commands executed when the machine powers up.  That is,

     
···

       47
        
             powerDownCommands = mkOption {

     

       48
        
               type = types.lines;

     

       49
        
               default = "";

     

       50
       -
               example = "${pkgs.hdparm}/sbin/hdparm -B 255 /dev/sda";

     

       0
        
       
     

       0
        
       
     

       51
        
               description =

     

       52
        
                 ''

     

       53
        
                   Commands executed when the machine powers down.  That is,

···

       35
        
             powerUpCommands = mkOption {

     

       36
        
               type = types.lines;

     

       37
        
               default = "";

     

       38
       +
               example = literalExample ''

     

       39
       +
                 "''${pkgs.hdparm}/sbin/hdparm -B 255 /dev/sda"

     

       40
       +
               '';

     

       41
        
               description =

     

       42
        
                 ''

     

       43
        
                   Commands executed when the machine powers up.  That is,

     
···

       49
        
             powerDownCommands = mkOption {

     

       50
        
               type = types.lines;

     

       51
        
               default = "";

     

       52
       +
               example = literalExample ''

     

       53
       +
                 "''${pkgs.hdparm}/sbin/hdparm -B 255 /dev/sda"

     

       54
       +
               '';

     

       55
        
               description =

     

       56
        
                 ''

     

       57
        
                   Commands executed when the machine powers down.  That is,

+1 -1

nixos/modules/config/pulseaudio.nix

···

       81
        
             package = mkOption {

     

       82
        
               type = types.package;

     

       83
        
               default = pulseaudioFull;

     

       84
       -
               example = literalExample "pulseaudioFull";

     

       85
        
               description = ''

     

       86
        
                 The PulseAudio derivation to use.  This can be used to disable

     

       87
        
                 features (such as JACK support, Bluetooth) that are enabled in the

···

       81
        
             package = mkOption {

     

       82
        
               type = types.package;

     

       83
        
               default = pulseaudioFull;

     

       84
       +
               example = literalExample "pkgs.pulseaudioFull";

     

       85
        
               description = ''

     

       86
        
                 The PulseAudio derivation to use.  This can be used to disable

     

       87
        
                 features (such as JACK support, Bluetooth) that are enabled in the

+3 -1

nixos/modules/config/shells-environment.nix

···

       122
        
       

     

       123
        
           environment.binsh = mkOption {

     

       124
        
             default = "${config.system.build.binsh}/bin/sh";

     

       125
       -
             example = "\${pkgs.dash}/bin/dash";

     

       0
        
       
     

       0
        
       
     

       126
        
             type = types.path;

     

       127
        
             description = ''

     

       128
        
               The shell executable that is linked system-wide to

···

       122
        
       

     

       123
        
           environment.binsh = mkOption {

     

       124
        
             default = "${config.system.build.binsh}/bin/sh";

     

       125
       +
             example = literalExample ''

     

       126
       +
               "''${pkgs.dash}/bin/dash"

     

       127
       +
             '';

     

       128
        
             type = types.path;

     

       129
        
             description = ''

     

       130
        
               The shell executable that is linked system-wide to

+4 -3

nixos/modules/installer/cd-dvd/iso-image.nix

···

       113
        
           };

     

       114
        
       

     

       115
        
           isoImage.contents = mkOption {

     

       116
       -
             example =

     

       117
        
               [ { source = pkgs.memtest86 + "/memtest.bin";

     

       118
        
                   target = "boot/memtest.bin";

     

       119
        
                 }

     

       120
       -
               ];

     

       0
        
       
     

       121
        
             description = ''

     

       122
        
               This option lists files to be copied to fixed locations in the

     

       123
        
               generated ISO image.

     
···

       125
        
           };

     

       126
        
       

     

       127
        
           isoImage.storeContents = mkOption {

     

       128
       -
             example = [pkgs.stdenv];

     

       129
        
             description = ''

     

       130
        
               This option lists additional derivations to be included in the

     

       131
        
               Nix store in the generated ISO image.

···

       113
        
           };

     

       114
        
       

     

       115
        
           isoImage.contents = mkOption {

     

       116
       +
             example = literalExample ''

     

       117
        
               [ { source = pkgs.memtest86 + "/memtest.bin";

     

       118
        
                   target = "boot/memtest.bin";

     

       119
        
                 }

     

       120
       +
               ]

     

       121
       +
             '';

     

       122
        
             description = ''

     

       123
        
               This option lists files to be copied to fixed locations in the

     

       124
        
               generated ISO image.

     
···

       126
        
           };

     

       127
        
       

     

       128
        
           isoImage.storeContents = mkOption {

     

       129
       +
             example = literalExample "[ pkgs.stdenv ]";

     

       130
        
             description = ''

     

       131
        
               This option lists additional derivations to be included in the

     

       132
        
               Nix store in the generated ISO image.

+4 -3

nixos/modules/installer/cd-dvd/system-tarball.nix

···

       15
        
       {

     

       16
        
         options = {

     

       17
        
           tarball.contents = mkOption {

     

       18
       -
             example =

     

       19
        
               [ { source = pkgs.memtest86 + "/memtest.bin";

     

       20
        
                   target = "boot/memtest.bin";

     

       21
        
                 }

     

       22
       -
               ];

     

       0
        
       
     

       23
        
             description = ''

     

       24
        
               This option lists files to be copied to fixed locations in the

     

       25
        
               generated ISO image.

     
···

       27
        
           };

     

       28
        
       

     

       29
        
           tarball.storeContents = mkOption {

     

       30
       -
             example = [pkgs.stdenv];

     

       31
        
             description = ''

     

       32
        
               This option lists additional derivations to be included in the

     

       33
        
               Nix store in the generated ISO image.

···

       15
        
       {

     

       16
        
         options = {

     

       17
        
           tarball.contents = mkOption {

     

       18
       +
             example = literalExample ''

     

       19
        
               [ { source = pkgs.memtest86 + "/memtest.bin";

     

       20
        
                   target = "boot/memtest.bin";

     

       21
        
                 }

     

       22
       +
               ]

     

       23
       +
             '';

     

       24
        
             description = ''

     

       25
        
               This option lists files to be copied to fixed locations in the

     

       26
        
               generated ISO image.

     
···

       28
        
           };

     

       29
        
       

     

       30
        
           tarball.storeContents = mkOption {

     

       31
       +
             example = literalExample "[ pkgs.stdenv ]";

     

       32
        
             description = ''

     

       33
        
               This option lists additional derivations to be included in the

     

       34
        
               Nix store in the generated ISO image.

+1 -1

nixos/modules/misc/crashdump.nix

···

       28
        
                 # We don't want to evaluate all of linuxPackages for the manual

     

       29
        
                 # - some of it might not even evaluate correctly.

     

       30
        
                 defaultText = "pkgs.linuxPackages";

     

       31
       -
                 example = "pkgs.linuxPackages_2_6_25";

     

       32
        
                 description = ''

     

       33
        
                   This will override the boot.kernelPackages, and will add some

     

       34
        
                   kernel configuration parameters for the crash dump to work.

···

       28
        
                 # We don't want to evaluate all of linuxPackages for the manual

     

       29
        
                 # - some of it might not even evaluate correctly.

     

       30
        
                 defaultText = "pkgs.linuxPackages";

     

       31
       +
                 example = literalExample "pkgs.linuxPackages_2_6_25";

     

       32
        
                 description = ''

     

       33
        
                   This will override the boot.kernelPackages, and will add some

     

       34
        
                   kernel configuration parameters for the crash dump to work.

+1 -1

nixos/modules/services/audio/mopidy.nix

···

       49
        
             extensionPackages = mkOption {

     

       50
        
               default = [];

     

       51
        
               type = types.listOf types.package;

     

       52
       -
               example = [ mopidy-spotify ];

     

       53
        
               description = ''

     

       54
        
                 Mopidy extensions that should be loaded by the service.

     

       55
        
               '';

···

       49
        
             extensionPackages = mkOption {

     

       50
        
               default = [];

     

       51
        
               type = types.listOf types.package;

     

       52
       +
               example = literalExample "[ pkgs.mopidy-spotify ]";

     

       53
        
               description = ''

     

       54
        
                 Mopidy extensions that should be loaded by the service.

     

       55
        
               '';

+1 -1

nixos/modules/services/backup/rsnapshot.nix

···

       31
        
       

     

       32
        
             cronIntervals = mkOption {

     

       33
        
               default = {};

     

       34
       -
               example = { "hourly" = "0 * * * *"; "daily" = "50 21 * * *"; };

     

       35
        
               type = types.attrsOf types.string;

     

       36
        
               description = ''

     

       37
        
                 Periodicity at which intervals should be run by cron.

···

       31
        
       

     

       32
        
             cronIntervals = mkOption {

     

       33
        
               default = {};

     

       34
       +
               example = { hourly = "0 * * * *"; daily = "50 21 * * *"; };

     

       35
        
               type = types.attrsOf types.string;

     

       36
        
               description = ''

     

       37
        
                 Periodicity at which intervals should be run by cron.

+3 -1

nixos/modules/services/logging/syslog-ng.nix

···

       49
        
             extraModulePaths = mkOption {

     

       50
        
               type = types.listOf types.str;

     

       51
        
               default = [];

     

       52
       -
               example = [ "${pkgs.syslogng_incubator}/lib/syslog-ng" ];

     

       0
        
       
     

       0
        
       
     

       53
        
               description = ''

     

       54
        
                 A list of paths that should be included in syslog-ng's

     

       55
        
                 <literal>--module-path</literal> option. They should usually

···

       49
        
             extraModulePaths = mkOption {

     

       50
        
               type = types.listOf types.str;

     

       51
        
               default = [];

     

       52
       +
               example = literalExample ''

     

       53
       +
                 [ "''${pkgs.syslogng_incubator}/lib/syslog-ng" ]

     

       54
       +
               '';

     

       55
        
               description = ''

     

       56
        
                 A list of paths that should be included in syslog-ng's

     

       57
        
                 <literal>--module-path</literal> option. They should usually

+1 -1

nixos/modules/services/monitoring/smartd.nix

···

       62
        
             enable = mkOption {

     

       63
        
               default = false;

     

       64
        
               type = types.bool;

     

       65
       -
               example = "true";

     

       66
        
               description = ''

     

       67
        
                 Run smartd from the smartmontools package. Note that e-mail

     

       68
        
                 notifications will not be enabled unless you configure the list of

···

       62
        
             enable = mkOption {

     

       63
        
               default = false;

     

       64
        
               type = types.bool;

     

       65
       +
               example = true;

     

       66
        
               description = ''

     

       67
        
                 Run smartd from the smartmontools package. Note that e-mail

     

       68
        
                 notifications will not be enabled unless you configure the list of

+2 -2

nixos/modules/services/networking/ircd-hybrid/default.nix

···

       66
        
       

     

       67
        
             rsaKey = mkOption {

     

       68
        
               default = null;

     

       69
       -
               example = /root/certificates/irc.key;

     

       70
        
               description = "

     

       71
        
                 IRCD server RSA key.

     

       72
        
               ";

     
···

       74
        
       

     

       75
        
             certificate = mkOption {

     

       76
        
               default = null;

     

       77
       -
               example = /root/certificates/irc.pem;

     

       78
        
               description = "

     

       79
        
                 IRCD server SSL certificate. There are some limitations - read manual.

     

       80
        
               ";

···

       66
        
       

     

       67
        
             rsaKey = mkOption {

     

       68
        
               default = null;

     

       69
       +
               example = literalExample "/root/certificates/irc.key";

     

       70
        
               description = "

     

       71
        
                 IRCD server RSA key.

     

       72
        
               ";

     
···

       74
        
       

     

       75
        
             certificate = mkOption {

     

       76
        
               default = null;

     

       77
       +
               example = literalExample "/root/certificates/irc.pem";

     

       78
        
               description = "

     

       79
        
                 IRCD server SSL certificate. There are some limitations - read manual.

     

       80
        
               ";

+1 -1

nixos/modules/services/networking/znc.nix

···

       228
        
             modulePackages = mkOption {

     

       229
        
               type = types.listOf types.package;

     

       230
        
               default = [ ];

     

       231
       -
               example = [ pkgs.zncModules.fish pkgs.zncModules.push ];

     

       232
        
               description = ''

     

       233
        
                 A list of global znc module packages to add to znc.

     

       234
        
               '';

···

       228
        
             modulePackages = mkOption {

     

       229
        
               type = types.listOf types.package;

     

       230
        
               default = [ ];

     

       231
       +
               example = literalExample "[ pkgs.zncModules.fish pkgs.zncModules.push ]";

     

       232
        
               description = ''

     

       233
        
                 A list of global znc module packages to add to znc.

     

       234
        
               '';

+1 -1

nixos/modules/services/web-servers/apache-httpd/default.nix

···

       423
        
             package = mkOption {

     

       424
        
               type = types.package;

     

       425
        
               default = pkgs.apacheHttpd.override { mpm = mainCfg.multiProcessingModule; };

     

       426
       -
               example = "pkgs.apacheHttpd_2_4";

     

       427
        
               description = ''

     

       428
        
                 Overridable attribute of the Apache HTTP Server package to use.

     

       429
        
               '';

···

       423
        
             package = mkOption {

     

       424
        
               type = types.package;

     

       425
        
               default = pkgs.apacheHttpd.override { mpm = mainCfg.multiProcessingModule; };

     

       426
       +
               example = literalExample "pkgs.apacheHttpd_2_4";

     

       427
        
               description = ''

     

       428
        
                 Overridable attribute of the Apache HTTP Server package to use.

     

       429
        
               '';

+2 -2

nixos/modules/services/x11/desktop-managers/gnome3.nix

···

       37
        
       

     

       38
        
           services.xserver.desktopManager.gnome3.sessionPath = mkOption {

     

       39
        
             default = [];

     

       40
       -
             example = "[ pkgs.gnome3.gpaste ]";

     

       41
        
             description = "Additional list of packages to be added to the session search path.

     

       42
        
                            Useful for gnome shell extensions or gsettings-conditionated autostart.";

     

       43
        
             apply = list: list ++ [ gnome3.gnome_shell ]; 

     
···

       51
        
           

     

       52
        
           environment.gnome3.excludePackages = mkOption {

     

       53
        
             default = [];

     

       54
       -
             example = "[ pkgs.gnome3.totem ]";

     

       55
        
             type = types.listOf types.package;

     

       56
        
             description = "Which packages gnome should exclude from the default environment";

     

       57
        
           };

···

       37
        
       

     

       38
        
           services.xserver.desktopManager.gnome3.sessionPath = mkOption {

     

       39
        
             default = [];

     

       40
       +
             example = literalExample "[ pkgs.gnome3.gpaste ]";

     

       41
        
             description = "Additional list of packages to be added to the session search path.

     

       42
        
                            Useful for gnome shell extensions or gsettings-conditionated autostart.";

     

       43
        
             apply = list: list ++ [ gnome3.gnome_shell ]; 

     
···

       51
        
           

     

       52
        
           environment.gnome3.excludePackages = mkOption {

     

       53
        
             default = [];

     

       54
       +
             example = literalExample "[ pkgs.gnome3.totem ]";

     

       55
        
             type = types.listOf types.package;

     

       56
        
             description = "Which packages gnome should exclude from the default environment";

     

       57
        
           };

+1 -1

nixos/modules/services/x11/desktop-managers/kde4.nix

···

       65
        
       

     

       66
        
           environment.kdePackages = mkOption {

     

       67
        
             default = [];

     

       68
       -
             example = "[ pkgs.kde4.kdesdk ]";

     

       69
        
             type = types.listOf types.package;

     

       70
        
             description = "This option is obsolete.  Please use <option>environment.systemPackages</option> instead.";

     

       71
        
           };

···

       65
        
       

     

       66
        
           environment.kdePackages = mkOption {

     

       67
        
             default = [];

     

       68
       +
             example = literalExample "[ pkgs.kde4.kdesdk ]";

     

       69
        
             type = types.listOf types.package;

     

       70
        
             description = "This option is obsolete.  Please use <option>environment.systemPackages</option> instead.";

     

       71
        
           };

+4 -2

nixos/modules/services/x11/display-managers/default.nix

···

       251
        
       

     

       252
        
               execCmd = mkOption {

     

       253
        
                 type = types.str;

     

       254
       -
                 example = "${pkgs.slim}/bin/slim";

     

       0
        
       
     

       0
        
       
     

       255
        
                 description = "Command to start the display manager.";

     

       256
        
               };

     

       257
        
       

     

       258
        
               environment = mkOption {

     

       259
        
                 type = types.attrsOf types.unspecified;

     

       260
        
                 default = {};

     

       261
       -
                 example = { SLIM_CFGFILE = /etc/slim.conf; };

     

       262
        
                 description = "Additional environment variables needed by the display manager.";

     

       263
        
               };

     

       264

···

       251
        
       

     

       252
        
               execCmd = mkOption {

     

       253
        
                 type = types.str;

     

       254
       +
                 example = literalExample ''

     

       255
       +
                   "''${pkgs.slim}/bin/slim"

     

       256
       +
                 '';

     

       257
        
                 description = "Command to start the display manager.";

     

       258
        
               };

     

       259
        
       

     

       260
        
               environment = mkOption {

     

       261
        
                 type = types.attrsOf types.unspecified;

     

       262
        
                 default = {};

     

       263
       +
                 example = { SLIM_CFGFILE = "/etc/slim.conf"; };

     

       264
        
                 description = "Additional environment variables needed by the display manager.";

     

       265
        
               };

     

       266

+2 -2

nixos/modules/services/x11/xserver.nix

···

       151
        
             modules = mkOption {

     

       152
        
               type = types.listOf types.path;

     

       153
        
               default = [];

     

       154
       -
               example = [ pkgs.xf86_input_wacom ];

     

       155
        
               description = "Packages to be added to the module search path of the X server.";

     

       156
        
             };

     

       157
        
       

     
···

       201
        
             vaapiDrivers = mkOption {

     

       202
        
               type = types.listOf types.path;

     

       203
        
               default = [ ];

     

       204
       -
               example = "[ pkgs.vaapiIntel pkgs.vaapiVdpau ]";

     

       205
        
               description = ''

     

       206
        
                 Packages providing libva acceleration drivers.

     

       207
        
               '';

···

       151
        
             modules = mkOption {

     

       152
        
               type = types.listOf types.path;

     

       153
        
               default = [];

     

       154
       +
               example = literalExample "[ pkgs.xf86_input_wacom ]";

     

       155
        
               description = "Packages to be added to the module search path of the X server.";

     

       156
        
             };

     

       157
        
       

     
···

       201
        
             vaapiDrivers = mkOption {

     

       202
        
               type = types.listOf types.path;

     

       203
        
               default = [ ];

     

       204
       +
               example = literalExample "[ pkgs.vaapiIntel pkgs.vaapiVdpau ]";

     

       205
        
               description = ''

     

       206
        
                 Packages providing libva acceleration drivers.

     

       207
        
               '';