···

       
483
       
 
       
  };

     

       
484
       
 
       


     

       
485
       
 
       
  # can execute on 32bit chip

     

       
486
       
-
       
  gcc_mips32r2_o32 = { gcc = { arch = "mips32r2"; abi = "o32"; }; };

     

       
487
       
-
       
  gcc_mips32r6_o32 = { gcc = { arch = "mips32r6"; abi = "o32"; }; };

     

       
488
       
 
       
  gcc_mips64r2_n32 = { gcc = { arch = "mips64r2"; abi = "n32"; }; };

     

       
489
       
 
       
  gcc_mips64r6_n32 = { gcc = { arch = "mips64r6"; abi = "n32"; }; };

     

       
490
       
 
       
  gcc_mips64r2_64  = { gcc = { arch = "mips64r2"; abi =  "64"; }; };

     

···

       
483
       
 
       
  };

     

       
484
       
 
       


     

       
485
       
 
       
  # can execute on 32bit chip

     

       
486
       
+
       
  gcc_mips32r2_o32 = { gcc = { arch = "mips32r2"; abi =  "32"; }; };

     

       
487
       
+
       
  gcc_mips32r6_o32 = { gcc = { arch = "mips32r6"; abi =  "32"; }; };

     

       
488
       
 
       
  gcc_mips64r2_n32 = { gcc = { arch = "mips64r2"; abi = "n32"; }; };

     

       
489
       
 
       
  gcc_mips64r6_n32 = { gcc = { arch = "mips64r6"; abi = "n32"; }; };

     

       
490
       
 
       
  gcc_mips64r2_64  = { gcc = { arch = "mips64r2"; abi =  "64"; }; };

     

···

       
9890
       
 
       
      fingerprint = "196A BFEC 6A1D D1EC 7594  F8D1 F625 47D0 75E0 9767";

     

       
9891
       
 
       
    }];

     

       
9892
       
 
       
  };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
9893
       
 
       
  patternspandemic = {

     

       
9894
       
 
       
    email = "patternspandemic@live.com";

     

       
9895
       
 
       
    github = "patternspandemic";

     
···

       
12713
       
 
       
    github = "teto";

     

       
12714
       
 
       
    githubId = 886074;

     

       
12715
       
 
       
    name = "Matthieu Coudron";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
12716
       
 
       
  };

     

       
12717
       
 
       
  tex = {

     

       
12718
       
 
       
    email = "milan.svoboda@centrum.cz";

     

···

       
9890
       
 
       
      fingerprint = "196A BFEC 6A1D D1EC 7594  F8D1 F625 47D0 75E0 9767";

     

       
9891
       
 
       
    }];

     

       
9892
       
 
       
  };

     

       
9893
       
+
       
  patryk4815 = {

     

       
9894
       
+
       
    email = "patryk.sondej@gmail.com";

     

       
9895
       
+
       
    github = "patryk4815";

     

       
9896
       
+
       
    githubId = 3074260;

     

       
9897
       
+
       
    name = "Patryk Sondej";

     

       
9898
       
+
       
  };

     

       
9899
       
 
       
  patternspandemic = {

     

       
9900
       
 
       
    email = "patternspandemic@live.com";

     

       
9901
       
 
       
    github = "patternspandemic";

     
···

       
12719
       
 
       
    github = "teto";

     

       
12720
       
 
       
    githubId = 886074;

     

       
12721
       
 
       
    name = "Matthieu Coudron";

     

       
12722
       
+
       
  };

     

       
12723
       
+
       
  teutat3s = {

     

       
12724
       
+
       
    email = "teutates@mailbox.org";

     

       
12725
       
+
       
    matrix = "@teutat3s:pub.solar";

     

       
12726
       
+
       
    github = "teutat3s";

     

       
12727
       
+
       
    githubId = 10206665;

     

       
12728
       
+
       
    name = "teutat3s";

     

       
12729
       
+
       
    keys = [{

     

       
12730
       
+
       
      fingerprint = "81A1 1C61 F413 8C84 9139  A4FA 18DA E600 A6BB E705";

     

       
12731
       
+
       
    }];

     

       
12732
       
 
       
  };

     

       
12733
       
 
       
  tex = {

     

       
12734
       
 
       
    email = "milan.svoboda@centrum.cz";

     

···

       
6
       
 
       
    appstream.enable = mkOption {

     

       
7
       
 
       
      type = types.bool;

     

       
8
       
 
       
      default = true;

     

       
9
       
-
       
      description = ''

     

       
10
       
 
       
        Whether to install files to support the

     

       
11
       
-
       
        <link xlink:href="https://www.freedesktop.org/software/appstream/docs/index.html">AppStream metadata specification</link>.

     

       
12
       
 
       
      '';

     

       
13
       
 
       
    };

     

       
14
       
 
       
  };

     

···

       
6
       
 
       
    appstream.enable = mkOption {

     

       
7
       
 
       
      type = types.bool;

     

       
8
       
 
       
      default = true;

     

       
9
       
+
       
      description = lib.mdDoc ''

     

       
10
       
 
       
        Whether to install files to support the

     

       
11
       
+
       
        [AppStream metadata specification](https://www.freedesktop.org/software/appstream/docs/index.html).

     

       
12
       
 
       
      '';

     

       
13
       
 
       
    };

     

       
14
       
 
       
  };

     

···

       
30
       
 
       
      enable = mkOption {

     

       
31
       
 
       
        type = types.bool;

     

       
32
       
 
       
        default = false;

     

       
33
       
-
       
        description = ''

     

       
34
       
 
       
          Whether to create a directory with links to all fonts in

     

       
35
       
-
       
          <filename>/run/current-system/sw/share/X11/fonts</filename>.

     

       
36
       
 
       
        '';

     

       
37
       
 
       
      };

     

       
38
       
 
       


     
···

       
40
       
 
       
        type = types.bool;

     

       
41
       
 
       
        default = config.programs.xwayland.enable;

     

       
42
       
 
       
        defaultText = literalExpression "config.programs.xwayland.enable";

     

       
43
       
-
       
        description = ''

     

       
44
       
 
       
          Whether to decompress fonts in

     

       
45
       
-
       
          <filename>/run/current-system/sw/share/X11/fonts</filename>.

     

       
46
       
 
       
        '';

     

       
47
       
 
       
      };

     

       
48
       
 
       


     

···

       
30
       
 
       
      enable = mkOption {

     

       
31
       
 
       
        type = types.bool;

     

       
32
       
 
       
        default = false;

     

       
33
       
+
       
        description = lib.mdDoc ''

     

       
34
       
 
       
          Whether to create a directory with links to all fonts in

     

       
35
       
+
       
          {file}`/run/current-system/sw/share/X11/fonts`.

     

       
36
       
 
       
        '';

     

       
37
       
 
       
      };

     

       
38
       
 
       


     
···

       
40
       
 
       
        type = types.bool;

     

       
41
       
 
       
        default = config.programs.xwayland.enable;

     

       
42
       
 
       
        defaultText = literalExpression "config.programs.xwayland.enable";

     

       
43
       
+
       
        description = lib.mdDoc ''

     

       
44
       
 
       
          Whether to decompress fonts in

     

       
45
       
+
       
          {file}`/run/current-system/sw/share/X11/fonts`.

     

       
46
       
 
       
        '';

     

       
47
       
 
       
      };

     

       
48
       
 
       


     

···

       
22
       
 
       
        default = null;

     

       
23
       
 
       
        type = timezone;

     

       
24
       
 
       
        example = "America/New_York";

     

       
25
       
-
       
        description = ''

     

       
26
       
-
       
          The time zone used when displaying times and dates. See <link

     

       
27
       
-
       
          xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>

     

       
28
       
 
       
          for a comprehensive list of possible values for this setting.

     

       
29
       
 
       


     

       
30
       
 
       
          If null, the timezone will default to UTC and can be set imperatively

     
···

       
35
       
 
       
      hardwareClockInLocalTime = mkOption {

     

       
36
       
 
       
        default = false;

     

       
37
       
 
       
        type = types.bool;

     

       
38
       
-
       
        description = "If set, keep the hardware clock in local time instead of UTC.";

     

       
39
       
 
       
      };

     

       
40
       
 
       


     

       
41
       
 
       
    };

     
···

       
44
       
 
       


     

       
45
       
 
       
      latitude = mkOption {

     

       
46
       
 
       
        type = types.float;

     

       
47
       
-
       
        description = ''

     

       
48
       
 
       
          Your current latitude, between

     

       
49
       
-
       
          <literal>-90.0</literal> and <literal>90.0</literal>. Must be provided

     

       
50
       
 
       
          along with longitude.

     

       
51
       
 
       
        '';

     

       
52
       
 
       
      };

     

       
53
       
 
       


     

       
54
       
 
       
      longitude = mkOption {

     

       
55
       
 
       
        type = types.float;

     

       
56
       
-
       
        description = ''

     

       
57
       
 
       
          Your current longitude, between

     

       
58
       
-
       
          between <literal>-180.0</literal> and <literal>180.0</literal>. Must be

     

       
59
       
 
       
          provided along with latitude.

     

       
60
       
 
       
        '';

     

       
61
       
 
       
      };

     
···

       
63
       
 
       
      provider = mkOption {

     

       
64
       
 
       
        type = types.enum [ "manual" "geoclue2" ];

     

       
65
       
 
       
        default = "manual";

     

       
66
       
-
       
        description = ''

     

       
67
       
 
       
          The location provider to use for determining your location. If set to

     

       
68
       
-
       
          <literal>manual</literal> you must also provide latitude/longitude.

     

       
69
       
 
       
        '';

     

       
70
       
 
       
      };

     

       
71
       
 
       


     

···

       
22
       
 
       
        default = null;

     

       
23
       
 
       
        type = timezone;

     

       
24
       
 
       
        example = "America/New_York";

     

       
25
       
+
       
        description = lib.mdDoc ''

     

       
26
       
+
       
          The time zone used when displaying times and dates. See <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>

     

       
0
       
 
       

     

       
27
       
 
       
          for a comprehensive list of possible values for this setting.

     

       
28
       
 
       


     

       
29
       
 
       
          If null, the timezone will default to UTC and can be set imperatively

     
···

       
34
       
 
       
      hardwareClockInLocalTime = mkOption {

     

       
35
       
 
       
        default = false;

     

       
36
       
 
       
        type = types.bool;

     

       
37
       
+
       
        description = lib.mdDoc "If set, keep the hardware clock in local time instead of UTC.";

     

       
38
       
 
       
      };

     

       
39
       
 
       


     

       
40
       
 
       
    };

     
···

       
43
       
 
       


     

       
44
       
 
       
      latitude = mkOption {

     

       
45
       
 
       
        type = types.float;

     

       
46
       
+
       
        description = lib.mdDoc ''

     

       
47
       
 
       
          Your current latitude, between

     

       
48
       
+
       
          `-90.0` and `90.0`. Must be provided

     

       
49
       
 
       
          along with longitude.

     

       
50
       
 
       
        '';

     

       
51
       
 
       
      };

     

       
52
       
 
       


     

       
53
       
 
       
      longitude = mkOption {

     

       
54
       
 
       
        type = types.float;

     

       
55
       
+
       
        description = lib.mdDoc ''

     

       
56
       
 
       
          Your current longitude, between

     

       
57
       
+
       
          between `-180.0` and `180.0`. Must be

     

       
58
       
 
       
          provided along with latitude.

     

       
59
       
 
       
        '';

     

       
60
       
 
       
      };

     
···

       
62
       
 
       
      provider = mkOption {

     

       
63
       
 
       
        type = types.enum [ "manual" "geoclue2" ];

     

       
64
       
 
       
        default = "manual";

     

       
65
       
+
       
        description = lib.mdDoc ''

     

       
66
       
 
       
          The location provider to use for determining your location. If set to

     

       
67
       
+
       
          `manual` you must also provide latitude/longitude.

     

       
68
       
 
       
        '';

     

       
69
       
 
       
      };

     

       
70
       
 
       


     

···

       
13
       
 
       
      type = types.listOf types.path;

     

       
14
       
 
       
      internal = true;

     

       
15
       
 
       
      default = [];

     

       
16
       
-
       
      description = ''

     

       
17
       
 
       
        Search path for NSS (Name Service Switch) modules.  This allows

     

       
18
       
 
       
        several DNS resolution methods to be specified via

     

       
19
       
-
       
        <filename>/etc/nsswitch.conf</filename>.

     

       
20
       
 
       
      '';

     

       
21
       
 
       
      apply = list:

     

       
22
       
 
       
        {

     
···

       
28
       
 
       
    system.nssDatabases = {

     

       
29
       
 
       
      passwd = mkOption {

     

       
30
       
 
       
        type = types.listOf types.str;

     

       
31
       
-
       
        description = ''

     

       
32
       
-
       
          List of passwd entries to configure in <filename>/etc/nsswitch.conf</filename>.

     

       
33
       
 
       


     

       
34
       
 
       
          Note that "files" is always prepended while "systemd" is appended if nscd is enabled.

     

       
35
       
 
       


     
···

       
40
       
 
       


     

       
41
       
 
       
      group = mkOption {

     

       
42
       
 
       
        type = types.listOf types.str;

     

       
43
       
-
       
        description = ''

     

       
44
       
-
       
          List of group entries to configure in <filename>/etc/nsswitch.conf</filename>.

     

       
45
       
 
       


     

       
46
       
 
       
          Note that "files" is always prepended while "systemd" is appended if nscd is enabled.

     

       
47
       
 
       


     
···

       
52
       
 
       


     

       
53
       
 
       
      shadow = mkOption {

     

       
54
       
 
       
        type = types.listOf types.str;

     

       
55
       
-
       
        description = ''

     

       
56
       
-
       
          List of shadow entries to configure in <filename>/etc/nsswitch.conf</filename>.

     

       
57
       
 
       


     

       
58
       
 
       
          Note that "files" is always prepended.

     

       
59
       
 
       


     
···

       
64
       
 
       


     

       
65
       
 
       
      hosts = mkOption {

     

       
66
       
 
       
        type = types.listOf types.str;

     

       
67
       
-
       
        description = ''

     

       
68
       
-
       
          List of hosts entries to configure in <filename>/etc/nsswitch.conf</filename>.

     

       
69
       
 
       


     

       
70
       
 
       
          Note that "files" is always prepended, and "dns" and "myhostname" are always appended.

     

       
71
       
 
       


     
···

       
76
       
 
       


     

       
77
       
 
       
      services = mkOption {

     

       
78
       
 
       
        type = types.listOf types.str;

     

       
79
       
-
       
        description = ''

     

       
80
       
-
       
          List of services entries to configure in <filename>/etc/nsswitch.conf</filename>.

     

       
81
       
 
       


     

       
82
       
 
       
          Note that "files" is always prepended.

     

       
83
       
 
       


     

···

       
13
       
 
       
      type = types.listOf types.path;

     

       
14
       
 
       
      internal = true;

     

       
15
       
 
       
      default = [];

     

       
16
       
+
       
      description = lib.mdDoc ''

     

       
17
       
 
       
        Search path for NSS (Name Service Switch) modules.  This allows

     

       
18
       
 
       
        several DNS resolution methods to be specified via

     

       
19
       
+
       
        {file}`/etc/nsswitch.conf`.

     

       
20
       
 
       
      '';

     

       
21
       
 
       
      apply = list:

     

       
22
       
 
       
        {

     
···

       
28
       
 
       
    system.nssDatabases = {

     

       
29
       
 
       
      passwd = mkOption {

     

       
30
       
 
       
        type = types.listOf types.str;

     

       
31
       
+
       
        description = lib.mdDoc ''

     

       
32
       
+
       
          List of passwd entries to configure in {file}`/etc/nsswitch.conf`.

     

       
33
       
 
       


     

       
34
       
 
       
          Note that "files" is always prepended while "systemd" is appended if nscd is enabled.

     

       
35
       
 
       


     
···

       
40
       
 
       


     

       
41
       
 
       
      group = mkOption {

     

       
42
       
 
       
        type = types.listOf types.str;

     

       
43
       
+
       
        description = lib.mdDoc ''

     

       
44
       
+
       
          List of group entries to configure in {file}`/etc/nsswitch.conf`.

     

       
45
       
 
       


     

       
46
       
 
       
          Note that "files" is always prepended while "systemd" is appended if nscd is enabled.

     

       
47
       
 
       


     
···

       
52
       
 
       


     

       
53
       
 
       
      shadow = mkOption {

     

       
54
       
 
       
        type = types.listOf types.str;

     

       
55
       
+
       
        description = lib.mdDoc ''

     

       
56
       
+
       
          List of shadow entries to configure in {file}`/etc/nsswitch.conf`.

     

       
57
       
 
       


     

       
58
       
 
       
          Note that "files" is always prepended.

     

       
59
       
 
       


     
···

       
64
       
 
       


     

       
65
       
 
       
      hosts = mkOption {

     

       
66
       
 
       
        type = types.listOf types.str;

     

       
67
       
+
       
        description = lib.mdDoc ''

     

       
68
       
+
       
          List of hosts entries to configure in {file}`/etc/nsswitch.conf`.

     

       
69
       
 
       


     

       
70
       
 
       
          Note that "files" is always prepended, and "dns" and "myhostname" are always appended.

     

       
71
       
 
       


     
···

       
76
       
 
       


     

       
77
       
 
       
      services = mkOption {

     

       
78
       
 
       
        type = types.listOf types.str;

     

       
79
       
+
       
        description = lib.mdDoc ''

     

       
80
       
+
       
          List of services entries to configure in {file}`/etc/nsswitch.conf`.

     

       
81
       
 
       


     

       
82
       
 
       
          Note that "files" is always prepended.

     

       
83
       
 
       


     

···

       
89
       
 
       
      enable = mkOption {

     

       
90
       
 
       
        type = types.bool;

     

       
91
       
 
       
        default = false;

     

       
92
       
-
       
        description = ''

     

       
93
       
 
       
          Whether to enable the PulseAudio sound server.

     

       
94
       
 
       
        '';

     

       
95
       
 
       
      };

     
···

       
97
       
 
       
      systemWide = mkOption {

     

       
98
       
 
       
        type = types.bool;

     

       
99
       
 
       
        default = false;

     

       
100
       
-
       
        description = ''

     

       
101
       
 
       
          If false, a PulseAudio server is launched automatically for

     

       
102
       
 
       
          each user that tries to use the sound system. The server runs

     

       
103
       
 
       
          with user privileges. If true, one system-wide PulseAudio

     
···

       
112
       
 
       
      support32Bit = mkOption {

     

       
113
       
 
       
        type = types.bool;

     

       
114
       
 
       
        default = false;

     

       
115
       
-
       
        description = ''

     

       
116
       
 
       
          Whether to include the 32-bit pulseaudio libraries in the system or not.

     

       
117
       
 
       
          This is only useful on 64-bit systems and currently limited to x86_64-linux.

     

       
118
       
 
       
        '';

     
···

       
120
       
 
       


     

       
121
       
 
       
      configFile = mkOption {

     

       
122
       
 
       
        type = types.nullOr types.path;

     

       
123
       
-
       
        description = ''

     

       
124
       
 
       
          The path to the default configuration options the PulseAudio server

     

       
125
       
 
       
          should use. By default, the "default.pa" configuration

     

       
126
       
 
       
          from the PulseAudio distribution is used.

     
···

       
130
       
 
       
      extraConfig = mkOption {

     

       
131
       
 
       
        type = types.lines;

     

       
132
       
 
       
        default = "";

     

       
133
       
-
       
        description = ''

     

       
134
       
-
       
          Literal string to append to <literal>configFile</literal>

     

       
135
       
 
       
          and the config file generated by the pulseaudio module.

     

       
136
       
 
       
        '';

     

       
137
       
 
       
      };

     
···

       
139
       
 
       
      extraClientConf = mkOption {

     

       
140
       
 
       
        type = types.lines;

     

       
141
       
 
       
        default = "";

     

       
142
       
-
       
        description = ''

     

       
143
       
 
       
          Extra configuration appended to pulse/client.conf file.

     

       
144
       
 
       
        '';

     

       
145
       
 
       
      };

     
···

       
151
       
 
       
                  else pkgs.pulseaudio;

     

       
152
       
 
       
        defaultText = literalExpression "pkgs.pulseaudio";

     

       
153
       
 
       
        example = literalExpression "pkgs.pulseaudioFull";

     

       
154
       
-
       
        description = ''

     

       
155
       
 
       
          The PulseAudio derivation to use.  This can be used to enable

     

       
156
       
 
       
          features (such as JACK support, Bluetooth) via the

     

       
157
       
-
       
          <literal>pulseaudioFull</literal> package.

     

       
158
       
 
       
        '';

     

       
159
       
 
       
      };

     

       
160
       
 
       


     
···

       
162
       
 
       
        type = types.listOf types.package;

     

       
163
       
 
       
        default = [];

     

       
164
       
 
       
        example = literalExpression "[ pkgs.pulseaudio-modules-bt ]";

     

       
165
       
-
       
        description = ''

     

       
166
       
 
       
          Extra pulseaudio modules to use. This is intended for out-of-tree

     

       
167
       
 
       
          pulseaudio modules like extra bluetooth codecs.

     

       
168
       
 
       


     
···

       
174
       
 
       
        logLevel = mkOption {

     

       
175
       
 
       
          type = types.str;

     

       
176
       
 
       
          default = "notice";

     

       
177
       
-
       
          description = ''

     

       
178
       
 
       
            The log level that the system-wide pulseaudio daemon should use,

     

       
179
       
 
       
            if activated.

     

       
180
       
 
       
          '';

     
···

       
183
       
 
       
        config = mkOption {

     

       
184
       
 
       
          type = types.attrsOf types.unspecified;

     

       
185
       
 
       
          default = {};

     

       
186
       
-
       
          description = "Config of the pulse daemon. See <literal>man pulse-daemon.conf</literal>.";

     

       
187
       
 
       
          example = literalExpression ''{ realtime-scheduling = "yes"; }'';

     

       
188
       
 
       
        };

     

       
189
       
 
       
      };

     
···

       
205
       
 
       
            type = types.listOf types.str;

     

       
206
       
 
       
            default = [];

     

       
207
       
 
       
            example = literalExpression ''[ "127.0.0.1" "192.168.1.0/24" ]'';

     

       
208
       
-
       
            description = ''

     

       
209
       
 
       
              A list of IP subnets that are allowed to stream to the server.

     

       
210
       
 
       
            '';

     

       
211
       
 
       
          };

     

···

       
89
       
 
       
      enable = mkOption {

     

       
90
       
 
       
        type = types.bool;

     

       
91
       
 
       
        default = false;

     

       
92
       
+
       
        description = lib.mdDoc ''

     

       
93
       
 
       
          Whether to enable the PulseAudio sound server.

     

       
94
       
 
       
        '';

     

       
95
       
 
       
      };

     
···

       
97
       
 
       
      systemWide = mkOption {

     

       
98
       
 
       
        type = types.bool;

     

       
99
       
 
       
        default = false;

     

       
100
       
+
       
        description = lib.mdDoc ''

     

       
101
       
 
       
          If false, a PulseAudio server is launched automatically for

     

       
102
       
 
       
          each user that tries to use the sound system. The server runs

     

       
103
       
 
       
          with user privileges. If true, one system-wide PulseAudio

     
···

       
112
       
 
       
      support32Bit = mkOption {

     

       
113
       
 
       
        type = types.bool;

     

       
114
       
 
       
        default = false;

     

       
115
       
+
       
        description = lib.mdDoc ''

     

       
116
       
 
       
          Whether to include the 32-bit pulseaudio libraries in the system or not.

     

       
117
       
 
       
          This is only useful on 64-bit systems and currently limited to x86_64-linux.

     

       
118
       
 
       
        '';

     
···

       
120
       
 
       


     

       
121
       
 
       
      configFile = mkOption {

     

       
122
       
 
       
        type = types.nullOr types.path;

     

       
123
       
+
       
        description = lib.mdDoc ''

     

       
124
       
 
       
          The path to the default configuration options the PulseAudio server

     

       
125
       
 
       
          should use. By default, the "default.pa" configuration

     

       
126
       
 
       
          from the PulseAudio distribution is used.

     
···

       
130
       
 
       
      extraConfig = mkOption {

     

       
131
       
 
       
        type = types.lines;

     

       
132
       
 
       
        default = "";

     

       
133
       
+
       
        description = lib.mdDoc ''

     

       
134
       
+
       
          Literal string to append to `configFile`

     

       
135
       
 
       
          and the config file generated by the pulseaudio module.

     

       
136
       
 
       
        '';

     

       
137
       
 
       
      };

     
···

       
139
       
 
       
      extraClientConf = mkOption {

     

       
140
       
 
       
        type = types.lines;

     

       
141
       
 
       
        default = "";

     

       
142
       
+
       
        description = lib.mdDoc ''

     

       
143
       
 
       
          Extra configuration appended to pulse/client.conf file.

     

       
144
       
 
       
        '';

     

       
145
       
 
       
      };

     
···

       
151
       
 
       
                  else pkgs.pulseaudio;

     

       
152
       
 
       
        defaultText = literalExpression "pkgs.pulseaudio";

     

       
153
       
 
       
        example = literalExpression "pkgs.pulseaudioFull";

     

       
154
       
+
       
        description = lib.mdDoc ''

     

       
155
       
 
       
          The PulseAudio derivation to use.  This can be used to enable

     

       
156
       
 
       
          features (such as JACK support, Bluetooth) via the

     

       
157
       
+
       
          `pulseaudioFull` package.

     

       
158
       
 
       
        '';

     

       
159
       
 
       
      };

     

       
160
       
 
       


     
···

       
162
       
 
       
        type = types.listOf types.package;

     

       
163
       
 
       
        default = [];

     

       
164
       
 
       
        example = literalExpression "[ pkgs.pulseaudio-modules-bt ]";

     

       
165
       
+
       
        description = lib.mdDoc ''

     

       
166
       
 
       
          Extra pulseaudio modules to use. This is intended for out-of-tree

     

       
167
       
 
       
          pulseaudio modules like extra bluetooth codecs.

     

       
168
       
 
       


     
···

       
174
       
 
       
        logLevel = mkOption {

     

       
175
       
 
       
          type = types.str;

     

       
176
       
 
       
          default = "notice";

     

       
177
       
+
       
          description = lib.mdDoc ''

     

       
178
       
 
       
            The log level that the system-wide pulseaudio daemon should use,

     

       
179
       
 
       
            if activated.

     

       
180
       
 
       
          '';

     
···

       
183
       
 
       
        config = mkOption {

     

       
184
       
 
       
          type = types.attrsOf types.unspecified;

     

       
185
       
 
       
          default = {};

     

       
186
       
+
       
          description = lib.mdDoc "Config of the pulse daemon. See `man pulse-daemon.conf`.";

     

       
187
       
 
       
          example = literalExpression ''{ realtime-scheduling = "yes"; }'';

     

       
188
       
 
       
        };

     

       
189
       
 
       
      };

     
···

       
205
       
 
       
            type = types.listOf types.str;

     

       
206
       
 
       
            default = [];

     

       
207
       
 
       
            example = literalExpression ''[ "127.0.0.1" "192.168.1.0/24" ]'';

     

       
208
       
+
       
            description = lib.mdDoc ''

     

       
209
       
 
       
              A list of IP subnets that are allowed to stream to the server.

     

       
210
       
 
       
            '';

     

       
211
       
 
       
          };

     

···

       
20
       
 
       
      type = types.listOf types.package;

     

       
21
       
 
       
      default = [];

     

       
22
       
 
       
      example = literalExpression "with pkgs.unixODBCDrivers; [ sqlite psql ]";

     

       
23
       
-
       
      description = ''

     

       
24
       
 
       
        Specifies Unix ODBC drivers to be registered in

     

       
25
       
-
       
        <filename>/etc/odbcinst.ini</filename>.  You may also want to

     

       
26
       
-
       
        add <literal>pkgs.unixODBC</literal> to the system path to get

     

       
27
       
 
       
        a command line client to connect to ODBC databases.

     

       
28
       
 
       
      '';

     

       
29
       
 
       
    };

     

···

       
20
       
 
       
      type = types.listOf types.package;

     

       
21
       
 
       
      default = [];

     

       
22
       
 
       
      example = literalExpression "with pkgs.unixODBCDrivers; [ sqlite psql ]";

     

       
23
       
+
       
      description = lib.mdDoc ''

     

       
24
       
 
       
        Specifies Unix ODBC drivers to be registered in

     

       
25
       
+
       
        {file}`/etc/odbcinst.ini`.  You may also want to

     

       
26
       
+
       
        add `pkgs.unixODBC` to the system path to get

     

       
27
       
 
       
        a command line client to connect to ODBC databases.

     

       
28
       
 
       
      '';

     

       
29
       
 
       
    };

     

···

       
10
       
 
       
    xdg.autostart.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
-
       
      description = ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
-
       
        <link xlink:href="https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html">XDG Autostart specification</link>.

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.autostart.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
+
       
      description = lib.mdDoc ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
+
       
        [XDG Autostart specification](https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html).

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.icons.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
-
       
      description = ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
-
       
        <link xlink:href="https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html">XDG Icon Theme specification</link>.

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.icons.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
+
       
      description = lib.mdDoc ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
+
       
        [XDG Icon Theme specification](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html).

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.menus.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
-
       
      description = ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
-
       
        <link xlink:href="https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html">XDG Desktop Menu specification</link>.

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.menus.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
+
       
      description = lib.mdDoc ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
+
       
        [XDG Desktop Menu specification](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html).

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.sounds.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
-
       
      description = ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
-
       
        <link xlink:href="https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/">XDG Sound Theme specification</link>.

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
10
       
 
       
    xdg.sounds.enable = mkOption {

     

       
11
       
 
       
      type = types.bool;

     

       
12
       
 
       
      default = true;

     

       
13
       
+
       
      description = lib.mdDoc ''

     

       
14
       
 
       
        Whether to install files to support the

     

       
15
       
+
       
        [XDG Sound Theme specification](https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/).

     

       
16
       
 
       
      '';

     

       
17
       
 
       
    };

     

       
18
       
 
       
  };

     

···

       
6
       
 
       
in

     

       
7
       
 
       
{

     

       
8
       
 
       
  options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption {

     

       
9
       
-
       
    description = ''

     

       
10
       
 
       
      Whether to enable backward compatibility for SGX software build for the

     

       
11
       
 
       
      out-of-tree Intel SGX DCAP driver.

     

       
12
       
 
       


     

       
13
       
-
       
      Creates symbolic links for the SGX devices <literal>/dev/sgx_enclave</literal>

     

       
14
       
-
       
      and <literal>/dev/sgx_provision</literal> to make them available as

     

       
15
       
-
       
      <literal>/dev/sgx/enclave</literal>  and <literal>/dev/sgx/provision</literal>,

     

       
16
       
 
       
      respectively.

     

       
17
       
 
       
    '';

     

       
18
       
 
       
    type = types.bool;

     
···

       
22
       
 
       
  options.hardware.cpu.intel.sgx.provision = {

     

       
23
       
 
       
    enable = mkEnableOption "access to the Intel SGX provisioning device";

     

       
24
       
 
       
    user = mkOption {

     

       
25
       
-
       
      description = "Owner to assign to the SGX provisioning device.";

     

       
26
       
 
       
      type = types.str;

     

       
27
       
 
       
      default = "root";

     

       
28
       
 
       
    };

     

       
29
       
 
       
    group = mkOption {

     

       
30
       
-
       
      description = "Group to assign to the SGX provisioning device.";

     

       
31
       
 
       
      type = types.str;

     

       
32
       
 
       
      default = defaultPrvGroup;

     

       
33
       
 
       
    };

     

       
34
       
 
       
    mode = mkOption {

     

       
35
       
-
       
      description = "Mode to set for the SGX provisioning device.";

     

       
36
       
 
       
      type = types.str;

     

       
37
       
 
       
      default = "0660";

     

       
38
       
 
       
    };

     

···

       
6
       
 
       
in

     

       
7
       
 
       
{

     

       
8
       
 
       
  options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption {

     

       
9
       
+
       
    description = lib.mdDoc ''

     

       
10
       
 
       
      Whether to enable backward compatibility for SGX software build for the

     

       
11
       
 
       
      out-of-tree Intel SGX DCAP driver.

     

       
12
       
 
       


     

       
13
       
+
       
      Creates symbolic links for the SGX devices `/dev/sgx_enclave`

     

       
14
       
+
       
      and `/dev/sgx_provision` to make them available as

     

       
15
       
+
       
      `/dev/sgx/enclave`  and `/dev/sgx/provision`,

     

       
16
       
 
       
      respectively.

     

       
17
       
 
       
    '';

     

       
18
       
 
       
    type = types.bool;

     
···

       
22
       
 
       
  options.hardware.cpu.intel.sgx.provision = {

     

       
23
       
 
       
    enable = mkEnableOption "access to the Intel SGX provisioning device";

     

       
24
       
 
       
    user = mkOption {

     

       
25
       
+
       
      description = lib.mdDoc "Owner to assign to the SGX provisioning device.";

     

       
26
       
 
       
      type = types.str;

     

       
27
       
 
       
      default = "root";

     

       
28
       
 
       
    };

     

       
29
       
 
       
    group = mkOption {

     

       
30
       
+
       
      description = lib.mdDoc "Group to assign to the SGX provisioning device.";

     

       
31
       
 
       
      type = types.str;

     

       
32
       
 
       
      default = defaultPrvGroup;

     

       
33
       
 
       
    };

     

       
34
       
 
       
    mode = mkOption {

     

       
35
       
+
       
      description = lib.mdDoc "Mode to set for the SGX provisioning device.";

     

       
36
       
 
       
      type = types.str;

     

       
37
       
 
       
      default = "0660";

     

       
38
       
 
       
    };

     

···

       
15
       
 
       
    sleep = mkOption {

     

       
16
       
 
       
      type = types.nullOr types.int;

     

       
17
       
 
       
      default = null;

     

       
18
       
-
       
      description = ''

     

       
19
       
 
       
        How many milliseconds ksmd should sleep between scans.

     

       
20
       
-
       
        Setting it to <literal>null</literal> uses the kernel's default time.

     

       
21
       
 
       
      '';

     

       
22
       
 
       
    };

     

       
23
       
 
       
  };

     

···

       
15
       
 
       
    sleep = mkOption {

     

       
16
       
 
       
      type = types.nullOr types.int;

     

       
17
       
 
       
      default = null;

     

       
18
       
+
       
      description = lib.mdDoc ''

     

       
19
       
 
       
        How many milliseconds ksmd should sleep between scans.

     

       
20
       
+
       
        Setting it to `null` uses the kernel's default time.

     

       
21
       
 
       
      '';

     

       
22
       
 
       
    };

     

       
23
       
 
       
  };

     

···

       
22
       
 
       
          let

     

       
23
       
 
       
            enginesDrv = filterAttrs (const isDerivation) pkgs.fcitx-engines;

     

       
24
       
 
       
            engines = concatStringsSep ", "

     

       
25
       
-
       
              (map (name: "<literal>${name}</literal>") (attrNames enginesDrv));

     

       
26
       
 
       
          in

     

       
27
       
-
       
            "Enabled Fcitx engines. Available engines are: ${engines}.";

     

       
28
       
 
       
      };

     

       
29
       
 
       
    };

     

       
30
       
 
       


     

···

       
22
       
 
       
          let

     

       
23
       
 
       
            enginesDrv = filterAttrs (const isDerivation) pkgs.fcitx-engines;

     

       
24
       
 
       
            engines = concatStringsSep ", "

     

       
25
       
+
       
              (map (name: "`${name}`") (attrNames enginesDrv));

     

       
26
       
 
       
          in

     

       
27
       
+
       
            lib.mdDoc "Enabled Fcitx engines. Available engines are: ${engines}.";

     

       
28
       
 
       
      };

     

       
29
       
 
       
    };

     

       
30
       
 
       


     

···

       
43
       
 
       
          let

     

       
44
       
 
       
            enginesDrv = filterAttrs (const isDerivation) pkgs.ibus-engines;

     

       
45
       
 
       
            engines = concatStringsSep ", "

     

       
46
       
-
       
              (map (name: "<literal>${name}</literal>") (attrNames enginesDrv));

     

       
47
       
 
       
          in

     

       
48
       
-
       
            "Enabled IBus engines. Available engines are: ${engines}.";

     

       
49
       
 
       
      };

     

       
50
       
 
       
      panel = mkOption {

     

       
51
       
 
       
        type = with types; nullOr path;

     

       
52
       
 
       
        default = null;

     

       
53
       
 
       
        example = literalExpression ''"''${pkgs.plasma5Packages.plasma-desktop}/lib/libexec/kimpanel-ibus-panel"'';

     

       
54
       
-
       
        description = "Replace the IBus panel with another panel.";

     

       
55
       
 
       
      };

     

       
56
       
 
       
    };

     

       
57
       
 
       
  };

     

···

       
43
       
 
       
          let

     

       
44
       
 
       
            enginesDrv = filterAttrs (const isDerivation) pkgs.ibus-engines;

     

       
45
       
 
       
            engines = concatStringsSep ", "

     

       
46
       
+
       
              (map (name: "`${name}`") (attrNames enginesDrv));

     

       
47
       
 
       
          in

     

       
48
       
+
       
            lib.mdDoc "Enabled IBus engines. Available engines are: ${engines}.";

     

       
49
       
 
       
      };

     

       
50
       
 
       
      panel = mkOption {

     

       
51
       
 
       
        type = with types; nullOr path;

     

       
52
       
 
       
        default = null;

     

       
53
       
 
       
        example = literalExpression ''"''${pkgs.plasma5Packages.plasma-desktop}/lib/libexec/kimpanel-ibus-panel"'';

     

       
54
       
+
       
        description = lib.mdDoc "Replace the IBus panel with another panel.";

     

       
55
       
 
       
      };

     

       
56
       
 
       
    };

     

       
57
       
 
       
  };

     

···

       
75
       
 
       
    configuration = mkOption {

     

       
76
       
 
       
      internal = true;

     

       
77
       
 
       
      type = types.str;

     

       
78
       
-
       
      description = ''

     

       
79
       
-
       
        The NixOS module that <literal>nixos-generate-config</literal>

     

       
80
       
-
       
        saves to <literal>/etc/nixos/configuration.nix</literal>.

     

       
81
       
 
       


     

       
82
       
 
       
        This is an internal option. No backward compatibility is guaranteed.

     

       
83
       
 
       
        Use at your own risk!

     

       
84
       
 
       


     

       
85
       
 
       
        Note that this string gets spliced into a Perl script. The perl

     

       
86
       
-
       
        variable <literal>$bootLoaderConfig</literal> can be used to

     

       
87
       
 
       
        splice in the boot loader configuration.

     

       
88
       
 
       
      '';

     

       
89
       
 
       
    };

     
···

       
92
       
 
       
      internal = true;

     

       
93
       
 
       
      type = types.listOf types.lines;

     

       
94
       
 
       
      default = [];

     

       
95
       
-
       
      description = ''

     

       
96
       
-
       
        Text to preseed the desktop configuration that <literal>nixos-generate-config</literal>

     

       
97
       
-
       
        saves to <literal>/etc/nixos/configuration.nix</literal>.

     

       
98
       
 
       


     

       
99
       
 
       
        This is an internal option. No backward compatibility is guaranteed.

     

       
100
       
 
       
        Use at your own risk!

     

       
101
       
 
       


     

       
102
       
 
       
        Note that this string gets spliced into a Perl script. The perl

     

       
103
       
-
       
        variable <literal>$bootLoaderConfig</literal> can be used to

     

       
104
       
 
       
        splice in the boot loader configuration.

     

       
105
       
 
       
      '';

     

       
106
       
 
       
    };

     
···

       
110
       
 
       
    internal = true;

     

       
111
       
 
       
    type = types.bool;

     

       
112
       
 
       
    default = false;

     

       
113
       
-
       
    description = ''

     

       
114
       
 
       
      Disable nixos-rebuild, nixos-generate-config, nixos-installer

     

       
115
       
 
       
      and other NixOS tools. This is useful to shrink embedded,

     

       
116
       
 
       
      read-only systems which are not expected to be rebuild or

     

···

       
75
       
 
       
    configuration = mkOption {

     

       
76
       
 
       
      internal = true;

     

       
77
       
 
       
      type = types.str;

     

       
78
       
+
       
      description = lib.mdDoc ''

     

       
79
       
+
       
        The NixOS module that `nixos-generate-config`

     

       
80
       
+
       
        saves to `/etc/nixos/configuration.nix`.

     

       
81
       
 
       


     

       
82
       
 
       
        This is an internal option. No backward compatibility is guaranteed.

     

       
83
       
 
       
        Use at your own risk!

     

       
84
       
 
       


     

       
85
       
 
       
        Note that this string gets spliced into a Perl script. The perl

     

       
86
       
+
       
        variable `$bootLoaderConfig` can be used to

     

       
87
       
 
       
        splice in the boot loader configuration.

     

       
88
       
 
       
      '';

     

       
89
       
 
       
    };

     
···

       
92
       
 
       
      internal = true;

     

       
93
       
 
       
      type = types.listOf types.lines;

     

       
94
       
 
       
      default = [];

     

       
95
       
+
       
      description = lib.mdDoc ''

     

       
96
       
+
       
        Text to preseed the desktop configuration that `nixos-generate-config`

     

       
97
       
+
       
        saves to `/etc/nixos/configuration.nix`.

     

       
98
       
 
       


     

       
99
       
 
       
        This is an internal option. No backward compatibility is guaranteed.

     

       
100
       
 
       
        Use at your own risk!

     

       
101
       
 
       


     

       
102
       
 
       
        Note that this string gets spliced into a Perl script. The perl

     

       
103
       
+
       
        variable `$bootLoaderConfig` can be used to

     

       
104
       
 
       
        splice in the boot loader configuration.

     

       
105
       
 
       
      '';

     

       
106
       
 
       
    };

     
···

       
110
       
 
       
    internal = true;

     

       
111
       
 
       
    type = types.bool;

     

       
112
       
 
       
    default = false;

     

       
113
       
+
       
    description = lib.mdDoc ''

     

       
114
       
 
       
      Disable nixos-rebuild, nixos-generate-config, nixos-installer

     

       
115
       
 
       
      and other NixOS tools. This is useful to shrink embedded,

     

       
116
       
 
       
      read-only systems which are not expected to be rebuild or

     

···

       
36
       
 
       
        type = lib.types.package;

     

       
37
       
 
       
        default = pkgs.man-db;

     

       
38
       
 
       
        defaultText = lib.literalExpression "pkgs.man-db";

     

       
39
       
-
       
        description = ''

     

       
40
       
-
       
          The <literal>man-db</literal> derivation to use. Useful to override

     

       
41
       
 
       
          configuration options used for the package.

     

       
42
       
 
       
        '';

     

       
43
       
 
       
      };

     

···

       
36
       
 
       
        type = lib.types.package;

     

       
37
       
 
       
        default = pkgs.man-db;

     

       
38
       
 
       
        defaultText = lib.literalExpression "pkgs.man-db";

     

       
39
       
+
       
        description = lib.mdDoc ''

     

       
40
       
+
       
          The `man-db` derivation to use. Useful to override

     

       
41
       
 
       
          configuration options used for the package.

     

       
42
       
 
       
        '';

     

       
43
       
 
       
      };

     

···

       
16
       
 
       
        type = with lib.types; listOf str;

     

       
17
       
 
       
        default = [ "share/man" ];

     

       
18
       
 
       
        example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]";

     

       
19
       
-
       
        description = ''

     

       
20
       
 
       
          Change the manpath, i. e. the directories where

     

       
21
       
-
       
          <citerefentry><refentrytitle>man</refentrytitle><manvolnum>1</manvolnum></citerefentry>

     

       
22
       
 
       
          looks for section-specific directories of man pages.

     

       
23
       
 
       
          You only need to change this setting if you want extra man pages

     

       
24
       
 
       
          (e. g. in non-english languages). All values must be strings that

     
···

       
31
       
 
       
        type = lib.types.package;

     

       
32
       
 
       
        default = pkgs.mandoc;

     

       
33
       
 
       
        defaultText = lib.literalExpression "pkgs.mandoc";

     

       
34
       
-
       
        description = ''

     

       
35
       
-
       
          The <literal>mandoc</literal> derivation to use. Useful to override

     

       
36
       
 
       
          configuration options used for the package.

     

       
37
       
 
       
        '';

     

       
38
       
 
       
      };

     

···

       
16
       
 
       
        type = with lib.types; listOf str;

     

       
17
       
 
       
        default = [ "share/man" ];

     

       
18
       
 
       
        example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]";

     

       
19
       
+
       
        description = lib.mdDoc ''

     

       
20
       
 
       
          Change the manpath, i. e. the directories where

     

       
21
       
+
       
          {manpage}`man(1)`

     

       
22
       
 
       
          looks for section-specific directories of man pages.

     

       
23
       
 
       
          You only need to change this setting if you want extra man pages

     

       
24
       
 
       
          (e. g. in non-english languages). All values must be strings that

     
···

       
31
       
 
       
        type = lib.types.package;

     

       
32
       
 
       
        default = pkgs.mandoc;

     

       
33
       
 
       
        defaultText = lib.literalExpression "pkgs.mandoc";

     

       
34
       
+
       
        description = lib.mdDoc ''

     

       
35
       
+
       
          The `mandoc` derivation to use. Useful to override

     

       
36
       
 
       
          configuration options used for the package.

     

       
37
       
 
       
        '';

     

       
38
       
 
       
      };

     

···

       
49
       
 
       
    nixos.version = mkOption {

     

       
50
       
 
       
      internal = true;

     

       
51
       
 
       
      type = types.str;

     

       
52
       
-
       
      description = "The full NixOS version (e.g. <literal>16.03.1160.f2d4ee1</literal>).";

     

       
53
       
 
       
    };

     

       
54
       
 
       


     

       
55
       
 
       
    nixos.release = mkOption {

     

       
56
       
 
       
      readOnly = true;

     

       
57
       
 
       
      type = types.str;

     

       
58
       
 
       
      default = trivial.release;

     

       
59
       
-
       
      description = "The NixOS release (e.g. <literal>16.03</literal>).";

     

       
60
       
 
       
    };

     

       
61
       
 
       


     

       
62
       
 
       
    nixos.versionSuffix = mkOption {

     

       
63
       
 
       
      internal = true;

     

       
64
       
 
       
      type = types.str;

     

       
65
       
 
       
      default = trivial.versionSuffix;

     

       
66
       
-
       
      description = "The NixOS version suffix (e.g. <literal>1160.f2d4ee1</literal>).";

     

       
67
       
 
       
    };

     

       
68
       
 
       


     

       
69
       
 
       
    nixos.revision = mkOption {

     

       
70
       
 
       
      internal = true;

     

       
71
       
 
       
      type = types.nullOr types.str;

     

       
72
       
 
       
      default = trivial.revisionWithDefault null;

     

       
73
       
-
       
      description = "The Git revision from which this NixOS configuration was built.";

     

       
74
       
 
       
    };

     

       
75
       
 
       


     

       
76
       
 
       
    nixos.codeName = mkOption {

     

       
77
       
 
       
      readOnly = true;

     

       
78
       
 
       
      type = types.str;

     

       
79
       
 
       
      default = trivial.codeName;

     

       
80
       
-
       
      description = "The NixOS release code name (e.g. <literal>Emu</literal>).";

     

       
81
       
 
       
    };

     

       
82
       
 
       


     

       
83
       
 
       
    stateVersion = mkOption {

     

       
84
       
 
       
      type = types.str;

     

       
85
       
 
       
      default = cfg.release;

     

       
86
       
 
       
      defaultText = literalExpression "config.${opt.release}";

     

       
87
       
-
       
      description = ''

     

       
88
       
 
       
        Every once in a while, a new NixOS release may change

     

       
89
       
 
       
        configuration defaults in a way incompatible with stateful

     

       
90
       
 
       
        data. For instance, if the default version of PostgreSQL

     
···

       
108
       
 
       
      internal = true;

     

       
109
       
 
       
      type = types.str;

     

       
110
       
 
       
      default = "https://nixos.org/channels/nixos-unstable";

     

       
111
       
-
       
      description = "Default NixOS channel to which the root user is subscribed.";

     

       
112
       
 
       
    };

     

       
113
       
 
       


     

       
114
       
 
       
    configurationRevision = mkOption {

     

       
115
       
 
       
      type = types.nullOr types.str;

     

       
116
       
 
       
      default = null;

     

       
117
       
-
       
      description = "The Git revision of the top-level flake from which this configuration was built.";

     

       
118
       
 
       
    };

     

       
119
       
 
       


     

       
120
       
 
       
  };

     

···

       
49
       
 
       
    nixos.version = mkOption {

     

       
50
       
 
       
      internal = true;

     

       
51
       
 
       
      type = types.str;

     

       
52
       
+
       
      description = lib.mdDoc "The full NixOS version (e.g. `16.03.1160.f2d4ee1`).";

     

       
53
       
 
       
    };

     

       
54
       
 
       


     

       
55
       
 
       
    nixos.release = mkOption {

     

       
56
       
 
       
      readOnly = true;

     

       
57
       
 
       
      type = types.str;

     

       
58
       
 
       
      default = trivial.release;

     

       
59
       
+
       
      description = lib.mdDoc "The NixOS release (e.g. `16.03`).";

     

       
60
       
 
       
    };

     

       
61
       
 
       


     

       
62
       
 
       
    nixos.versionSuffix = mkOption {

     

       
63
       
 
       
      internal = true;

     

       
64
       
 
       
      type = types.str;

     

       
65
       
 
       
      default = trivial.versionSuffix;

     

       
66
       
+
       
      description = lib.mdDoc "The NixOS version suffix (e.g. `1160.f2d4ee1`).";

     

       
67
       
 
       
    };

     

       
68
       
 
       


     

       
69
       
 
       
    nixos.revision = mkOption {

     

       
70
       
 
       
      internal = true;

     

       
71
       
 
       
      type = types.nullOr types.str;

     

       
72
       
 
       
      default = trivial.revisionWithDefault null;

     

       
73
       
+
       
      description = lib.mdDoc "The Git revision from which this NixOS configuration was built.";

     

       
74
       
 
       
    };

     

       
75
       
 
       


     

       
76
       
 
       
    nixos.codeName = mkOption {

     

       
77
       
 
       
      readOnly = true;

     

       
78
       
 
       
      type = types.str;

     

       
79
       
 
       
      default = trivial.codeName;

     

       
80
       
+
       
      description = lib.mdDoc "The NixOS release code name (e.g. `Emu`).";

     

       
81
       
 
       
    };

     

       
82
       
 
       


     

       
83
       
 
       
    stateVersion = mkOption {

     

       
84
       
 
       
      type = types.str;

     

       
85
       
 
       
      default = cfg.release;

     

       
86
       
 
       
      defaultText = literalExpression "config.${opt.release}";

     

       
87
       
+
       
      description = lib.mdDoc ''

     

       
88
       
 
       
        Every once in a while, a new NixOS release may change

     

       
89
       
 
       
        configuration defaults in a way incompatible with stateful

     

       
90
       
 
       
        data. For instance, if the default version of PostgreSQL

     
···

       
108
       
 
       
      internal = true;

     

       
109
       
 
       
      type = types.str;

     

       
110
       
 
       
      default = "https://nixos.org/channels/nixos-unstable";

     

       
111
       
+
       
      description = lib.mdDoc "Default NixOS channel to which the root user is subscribed.";

     

       
112
       
 
       
    };

     

       
113
       
 
       


     

       
114
       
 
       
    configurationRevision = mkOption {

     

       
115
       
 
       
      type = types.nullOr types.str;

     

       
116
       
 
       
      default = null;

     

       
117
       
+
       
      description = lib.mdDoc "The Git revision of the top-level flake from which this configuration was built.";

     

       
118
       
 
       
    };

     

       
119
       
 
       


     

       
120
       
 
       
  };

     

···

       
20
       
 
       
        type = types.package;

     

       
21
       
 
       
        default = pkgs.atop;

     

       
22
       
 
       
        defaultText = literalExpression "pkgs.atop";

     

       
23
       
-
       
        description = ''

     

       
24
       
 
       
          Which package to use for Atop.

     

       
25
       
 
       
        '';

     

       
26
       
 
       
      };

     
···

       
29
       
 
       
        enable = mkOption {

     

       
30
       
 
       
          type = types.bool;

     

       
31
       
 
       
          default = false;

     

       
32
       
-
       
          description = ''

     

       
33
       
 
       
            Whether to install and enable the netatop kernel module.

     

       
34
       
 
       
            Note: this sets the kernel taint flag "O" for loading out-of-tree modules.

     

       
35
       
 
       
          '';

     
···

       
38
       
 
       
          type = types.package;

     

       
39
       
 
       
          default = config.boot.kernelPackages.netatop;

     

       
40
       
 
       
          defaultText = literalExpression "config.boot.kernelPackages.netatop";

     

       
41
       
-
       
          description = ''

     

       
42
       
 
       
            Which package to use for netatop.

     

       
43
       
 
       
          '';

     

       
44
       
 
       
        };

     
···

       
47
       
 
       
      atopgpu.enable = mkOption {

     

       
48
       
 
       
        type = types.bool;

     

       
49
       
 
       
        default = false;

     

       
50
       
-
       
        description = ''

     

       
51
       
 
       
          Whether to install and enable the atopgpud daemon to get information about

     

       
52
       
 
       
          NVIDIA gpus.

     

       
53
       
 
       
        '';

     
···

       
56
       
 
       
      setuidWrapper.enable = mkOption {

     

       
57
       
 
       
        type = types.bool;

     

       
58
       
 
       
        default = false;

     

       
59
       
-
       
        description = ''

     

       
60
       
 
       
          Whether to install a setuid wrapper for Atop. This is required to use some of

     

       
61
       
 
       
          the features as non-root user (e.g.: ipc information, netatop, atopgpu).

     

       
62
       
 
       
          Atop tries to drop the root privileges shortly after starting.

     
···

       
66
       
 
       
      atopService.enable = mkOption {

     

       
67
       
 
       
        type = types.bool;

     

       
68
       
 
       
        default = true;

     

       
69
       
-
       
        description = ''

     

       
70
       
 
       
          Whether to enable the atop service responsible for storing statistics for

     

       
71
       
 
       
          long-term analysis.

     

       
72
       
 
       
        '';

     
···

       
74
       
 
       
      atopRotateTimer.enable = mkOption {

     

       
75
       
 
       
        type = types.bool;

     

       
76
       
 
       
        default = true;

     

       
77
       
-
       
        description = ''

     

       
78
       
 
       
          Whether to enable the atop-rotate timer, which restarts the atop service

     

       
79
       
 
       
          daily to make sure the data files are rotate.

     

       
80
       
 
       
        '';

     
···

       
82
       
 
       
      atopacctService.enable = mkOption {

     

       
83
       
 
       
        type = types.bool;

     

       
84
       
 
       
        default = true;

     

       
85
       
-
       
        description = ''

     

       
86
       
 
       
          Whether to enable the atopacct service which manages process accounting.

     

       
87
       
 
       
          This allows Atop to gather data about processes that disappeared in between

     

       
88
       
 
       
          two refresh intervals.

     
···

       
95
       
 
       
          flags = "a1f";

     

       
96
       
 
       
          interval = 5;

     

       
97
       
 
       
        };

     

       
98
       
-
       
        description = ''

     

       
99
       
-
       
          Parameters to be written to <filename>/etc/atoprc</filename>.

     

       
100
       
 
       
        '';

     

       
101
       
 
       
      };

     

       
102
       
 
       
    };

     

···

       
20
       
 
       
        type = types.package;

     

       
21
       
 
       
        default = pkgs.atop;

     

       
22
       
 
       
        defaultText = literalExpression "pkgs.atop";

     

       
23
       
+
       
        description = lib.mdDoc ''

     

       
24
       
 
       
          Which package to use for Atop.

     

       
25
       
 
       
        '';

     

       
26
       
 
       
      };

     
···

       
29
       
 
       
        enable = mkOption {

     

       
30
       
 
       
          type = types.bool;

     

       
31
       
 
       
          default = false;

     

       
32
       
+
       
          description = lib.mdDoc ''

     

       
33
       
 
       
            Whether to install and enable the netatop kernel module.

     

       
34
       
 
       
            Note: this sets the kernel taint flag "O" for loading out-of-tree modules.

     

       
35
       
 
       
          '';

     
···

       
38
       
 
       
          type = types.package;

     

       
39
       
 
       
          default = config.boot.kernelPackages.netatop;

     

       
40
       
 
       
          defaultText = literalExpression "config.boot.kernelPackages.netatop";

     

       
41
       
+
       
          description = lib.mdDoc ''

     

       
42
       
 
       
            Which package to use for netatop.

     

       
43
       
 
       
          '';

     

       
44
       
 
       
        };

     
···

       
47
       
 
       
      atopgpu.enable = mkOption {

     

       
48
       
 
       
        type = types.bool;

     

       
49
       
 
       
        default = false;

     

       
50
       
+
       
        description = lib.mdDoc ''

     

       
51
       
 
       
          Whether to install and enable the atopgpud daemon to get information about

     

       
52
       
 
       
          NVIDIA gpus.

     

       
53
       
 
       
        '';

     
···

       
56
       
 
       
      setuidWrapper.enable = mkOption {

     

       
57
       
 
       
        type = types.bool;

     

       
58
       
 
       
        default = false;

     

       
59
       
+
       
        description = lib.mdDoc ''

     

       
60
       
 
       
          Whether to install a setuid wrapper for Atop. This is required to use some of

     

       
61
       
 
       
          the features as non-root user (e.g.: ipc information, netatop, atopgpu).

     

       
62
       
 
       
          Atop tries to drop the root privileges shortly after starting.

     
···

       
66
       
 
       
      atopService.enable = mkOption {

     

       
67
       
 
       
        type = types.bool;

     

       
68
       
 
       
        default = true;

     

       
69
       
+
       
        description = lib.mdDoc ''

     

       
70
       
 
       
          Whether to enable the atop service responsible for storing statistics for

     

       
71
       
 
       
          long-term analysis.

     

       
72
       
 
       
        '';

     
···

       
74
       
 
       
      atopRotateTimer.enable = mkOption {

     

       
75
       
 
       
        type = types.bool;

     

       
76
       
 
       
        default = true;

     

       
77
       
+
       
        description = lib.mdDoc ''

     

       
78
       
 
       
          Whether to enable the atop-rotate timer, which restarts the atop service

     

       
79
       
 
       
          daily to make sure the data files are rotate.

     

       
80
       
 
       
        '';

     
···

       
82
       
 
       
      atopacctService.enable = mkOption {

     

       
83
       
 
       
        type = types.bool;

     

       
84
       
 
       
        default = true;

     

       
85
       
+
       
        description = lib.mdDoc ''

     

       
86
       
 
       
          Whether to enable the atopacct service which manages process accounting.

     

       
87
       
 
       
          This allows Atop to gather data about processes that disappeared in between

     

       
88
       
 
       
          two refresh intervals.

     
···

       
95
       
 
       
          flags = "a1f";

     

       
96
       
 
       
          interval = 5;

     

       
97
       
 
       
        };

     

       
98
       
+
       
        description = lib.mdDoc ''

     

       
99
       
+
       
          Parameters to be written to {file}`/etc/atoprc`.

     

       
100
       
 
       
        '';

     

       
101
       
 
       
      };

     

       
102
       
 
       
    };

     

···

       
30
       
 
       
      /*

     

       
31
       
 
       
      enable = mkOption {

     

       
32
       
 
       
        default = true;

     

       
33
       
-
       
        description = ''

     

       
34
       
 
       
          Whenever to configure Bash as an interactive shell.

     

       
35
       
 
       
          Note that this tries to make Bash the default

     

       
36
       
-
       
          <option>users.defaultUserShell</option>,

     

       
37
       
 
       
          which in turn means that you might need to explicitly

     

       
38
       
 
       
          set this variable if you have another shell configured

     

       
39
       
 
       
          with NixOS.

     
···

       
44
       
 
       


     

       
45
       
 
       
      shellAliases = mkOption {

     

       
46
       
 
       
        default = {};

     

       
47
       
-
       
        description = ''

     

       
48
       
-
       
          Set of aliases for bash shell, which overrides <option>environment.shellAliases</option>.

     

       
49
       
-
       
          See <option>environment.shellAliases</option> for an option format description.

     

       
50
       
 
       
        '';

     

       
51
       
 
       
        type = with types; attrsOf (nullOr (either str path));

     

       
52
       
 
       
      };

     

       
53
       
 
       


     

       
54
       
 
       
      shellInit = mkOption {

     

       
55
       
 
       
        default = "";

     

       
56
       
-
       
        description = ''

     

       
57
       
 
       
          Shell script code called during bash shell initialisation.

     

       
58
       
 
       
        '';

     

       
59
       
 
       
        type = types.lines;

     
···

       
61
       
 
       


     

       
62
       
 
       
      loginShellInit = mkOption {

     

       
63
       
 
       
        default = "";

     

       
64
       
-
       
        description = ''

     

       
65
       
 
       
          Shell script code called during login bash shell initialisation.

     

       
66
       
 
       
        '';

     

       
67
       
 
       
        type = types.lines;

     
···

       
69
       
 
       


     

       
70
       
 
       
      interactiveShellInit = mkOption {

     

       
71
       
 
       
        default = "";

     

       
72
       
-
       
        description = ''

     

       
73
       
 
       
          Shell script code called during interactive bash shell initialisation.

     

       
74
       
 
       
        '';

     

       
75
       
 
       
        type = types.lines;

     
···

       
92
       
 
       
            fi

     

       
93
       
 
       
          fi

     

       
94
       
 
       
        '';

     

       
95
       
-
       
        description = ''

     

       
96
       
 
       
          Shell script code used to initialise the bash prompt.

     

       
97
       
 
       
        '';

     

       
98
       
 
       
        type = types.lines;

     
···

       
100
       
 
       


     

       
101
       
 
       
      promptPluginInit = mkOption {

     

       
102
       
 
       
        default = "";

     

       
103
       
-
       
        description = ''

     

       
104
       
 
       
          Shell script code used to initialise bash prompt plugins.

     

       
105
       
 
       
        '';

     

       
106
       
 
       
        type = types.lines;

     

···

       
30
       
 
       
      /*

     

       
31
       
 
       
      enable = mkOption {

     

       
32
       
 
       
        default = true;

     

       
33
       
+
       
        description = lib.mdDoc ''

     

       
34
       
 
       
          Whenever to configure Bash as an interactive shell.

     

       
35
       
 
       
          Note that this tries to make Bash the default

     

       
36
       
+
       
          {option}`users.defaultUserShell`,

     

       
37
       
 
       
          which in turn means that you might need to explicitly

     

       
38
       
 
       
          set this variable if you have another shell configured

     

       
39
       
 
       
          with NixOS.

     
···

       
44
       
 
       


     

       
45
       
 
       
      shellAliases = mkOption {

     

       
46
       
 
       
        default = {};

     

       
47
       
+
       
        description = lib.mdDoc ''

     

       
48
       
+
       
          Set of aliases for bash shell, which overrides {option}`environment.shellAliases`.

     

       
49
       
+
       
          See {option}`environment.shellAliases` for an option format description.

     

       
50
       
 
       
        '';

     

       
51
       
 
       
        type = with types; attrsOf (nullOr (either str path));

     

       
52
       
 
       
      };

     

       
53
       
 
       


     

       
54
       
 
       
      shellInit = mkOption {

     

       
55
       
 
       
        default = "";

     

       
56
       
+
       
        description = lib.mdDoc ''

     

       
57
       
 
       
          Shell script code called during bash shell initialisation.

     

       
58
       
 
       
        '';

     

       
59
       
 
       
        type = types.lines;

     
···

       
61
       
 
       


     

       
62
       
 
       
      loginShellInit = mkOption {

     

       
63
       
 
       
        default = "";

     

       
64
       
+
       
        description = lib.mdDoc ''

     

       
65
       
 
       
          Shell script code called during login bash shell initialisation.

     

       
66
       
 
       
        '';

     

       
67
       
 
       
        type = types.lines;

     
···

       
69
       
 
       


     

       
70
       
 
       
      interactiveShellInit = mkOption {

     

       
71
       
 
       
        default = "";

     

       
72
       
+
       
        description = lib.mdDoc ''

     

       
73
       
 
       
          Shell script code called during interactive bash shell initialisation.

     

       
74
       
 
       
        '';

     

       
75
       
 
       
        type = types.lines;

     
···

       
92
       
 
       
            fi

     

       
93
       
 
       
          fi

     

       
94
       
 
       
        '';

     

       
95
       
+
       
        description = lib.mdDoc ''

     

       
96
       
 
       
          Shell script code used to initialise the bash prompt.

     

       
97
       
 
       
        '';

     

       
98
       
 
       
        type = types.lines;

     
···

       
100
       
 
       


     

       
101
       
 
       
      promptPluginInit = mkOption {

     

       
102
       
 
       
        default = "";

     

       
103
       
+
       
        description = lib.mdDoc ''

     

       
104
       
 
       
          Shell script code used to initialise bash prompt plugins.

     

       
105
       
 
       
        '';

     

       
106
       
 
       
        type = types.lines;

     

···

       
33
       
 
       
      profiles = mkOption {

     

       
34
       
 
       
        type = types.attrsOf types.path;

     

       
35
       
 
       
        default = {};

     

       
36
       
-
       
        description = "Set of dconf profile files, installed at <filename>/etc/dconf/profiles/<replaceable>name</replaceable></filename>.";

     

       
37
       
 
       
        internal = true;

     

       
38
       
 
       
      };

     

       
39
       
 
       


     

       
40
       
 
       
      packages = mkOption {

     

       
41
       
 
       
        type = types.listOf types.package;

     

       
42
       
 
       
        default = [];

     

       
43
       
-
       
        description = "A list of packages which provide dconf profiles and databases in <filename>/etc/dconf</filename>.";

     

       
44
       
 
       
      };

     

       
45
       
 
       
    };

     

       
46
       
 
       
  };

     

···

       
33
       
 
       
      profiles = mkOption {

     

       
34
       
 
       
        type = types.attrsOf types.path;

     

       
35
       
 
       
        default = {};

     

       
36
       
+
       
        description = lib.mdDoc "Set of dconf profile files, installed at {file}`/etc/dconf/profiles/«name»`.";

     

       
37
       
 
       
        internal = true;

     

       
38
       
 
       
      };

     

       
39
       
 
       


     

       
40
       
 
       
      packages = mkOption {

     

       
41
       
 
       
        type = types.listOf types.package;

     

       
42
       
 
       
        default = [];

     

       
43
       
+
       
        description = lib.mdDoc "A list of packages which provide dconf profiles and databases in {file}`/etc/dconf`.";

     

       
44
       
 
       
      };

     

       
45
       
 
       
    };

     

       
46
       
 
       
  };

     

···

       
49
       
 
       


     

       
50
       
 
       
      enable = mkOption {

     

       
51
       
 
       
        default = false;

     

       
52
       
-
       
        description = ''

     

       
53
       
 
       
          Whether to configure fish as an interactive shell.

     

       
54
       
 
       
        '';

     

       
55
       
 
       
        type = types.bool;

     
···

       
58
       
 
       
      useBabelfish = mkOption {

     

       
59
       
 
       
        type = types.bool;

     

       
60
       
 
       
        default = false;

     

       
61
       
-
       
        description = ''

     

       
62
       
-
       
          If enabled, the configured environment will be translated to native fish using <link xlink:href="https://github.com/bouk/babelfish">babelfish</link>.

     

       
63
       
-
       
          Otherwise, <link xlink:href="https://github.com/oh-my-fish/plugin-foreign-env">foreign-env</link> will be used.

     

       
64
       
 
       
        '';

     

       
65
       
 
       
      };

     

       
66
       
 
       


     

       
67
       
 
       
      vendor.config.enable = mkOption {

     

       
68
       
 
       
        type = types.bool;

     

       
69
       
 
       
        default = true;

     

       
70
       
-
       
        description = ''

     

       
71
       
 
       
          Whether fish should source configuration snippets provided by other packages.

     

       
72
       
 
       
        '';

     

       
73
       
 
       
      };

     
···

       
75
       
 
       
      vendor.completions.enable = mkOption {

     

       
76
       
 
       
        type = types.bool;

     

       
77
       
 
       
        default = true;

     

       
78
       
-
       
        description = ''

     

       
79
       
 
       
          Whether fish should use completion files provided by other packages.

     

       
80
       
 
       
        '';

     

       
81
       
 
       
      };

     
···

       
83
       
 
       
      vendor.functions.enable = mkOption {

     

       
84
       
 
       
        type = types.bool;

     

       
85
       
 
       
        default = true;

     

       
86
       
-
       
        description = ''

     

       
87
       
 
       
          Whether fish should autoload fish functions provided by other packages.

     

       
88
       
 
       
        '';

     

       
89
       
 
       
      };

     
···

       
94
       
 
       
          gco = "git checkout";

     

       
95
       
 
       
          npu = "nix-prefetch-url";

     

       
96
       
 
       
        };

     

       
97
       
-
       
        description = ''

     

       
98
       
 
       
          Set of fish abbreviations.

     

       
99
       
 
       
        '';

     

       
100
       
 
       
        type = with types; attrsOf str;

     
···

       
102
       
 
       


     

       
103
       
 
       
      shellAliases = mkOption {

     

       
104
       
 
       
        default = {};

     

       
105
       
-
       
        description = ''

     

       
106
       
-
       
          Set of aliases for fish shell, which overrides <option>environment.shellAliases</option>.

     

       
107
       
-
       
          See <option>environment.shellAliases</option> for an option format description.

     

       
108
       
 
       
        '';

     

       
109
       
 
       
        type = with types; attrsOf (nullOr (either str path));

     

       
110
       
 
       
      };

     

       
111
       
 
       


     

       
112
       
 
       
      shellInit = mkOption {

     

       
113
       
 
       
        default = "";

     

       
114
       
-
       
        description = ''

     

       
115
       
 
       
          Shell script code called during fish shell initialisation.

     

       
116
       
 
       
        '';

     

       
117
       
 
       
        type = types.lines;

     
···

       
119
       
 
       


     

       
120
       
 
       
      loginShellInit = mkOption {

     

       
121
       
 
       
        default = "";

     

       
122
       
-
       
        description = ''

     

       
123
       
 
       
          Shell script code called during fish login shell initialisation.

     

       
124
       
 
       
        '';

     

       
125
       
 
       
        type = types.lines;

     
···

       
127
       
 
       


     

       
128
       
 
       
      interactiveShellInit = mkOption {

     

       
129
       
 
       
        default = "";

     

       
130
       
-
       
        description = ''

     

       
131
       
 
       
          Shell script code called during interactive fish shell initialisation.

     

       
132
       
 
       
        '';

     

       
133
       
 
       
        type = types.lines;

     
···

       
135
       
 
       


     

       
136
       
 
       
      promptInit = mkOption {

     

       
137
       
 
       
        default = "";

     

       
138
       
-
       
        description = ''

     

       
139
       
 
       
          Shell script code used to initialise fish prompt.

     

       
140
       
 
       
        '';

     

       
141
       
 
       
        type = types.lines;

     

···

       
49
       
 
       


     

       
50
       
 
       
      enable = mkOption {

     

       
51
       
 
       
        default = false;

     

       
52
       
+
       
        description = lib.mdDoc ''

     

       
53
       
 
       
          Whether to configure fish as an interactive shell.

     

       
54
       
 
       
        '';

     

       
55
       
 
       
        type = types.bool;

     
···

       
58
       
 
       
      useBabelfish = mkOption {

     

       
59
       
 
       
        type = types.bool;

     

       
60
       
 
       
        default = false;

     

       
61
       
+
       
        description = lib.mdDoc ''

     

       
62
       
+
       
          If enabled, the configured environment will be translated to native fish using [babelfish](https://github.com/bouk/babelfish).

     

       
63
       
+
       
          Otherwise, [foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) will be used.

     

       
64
       
 
       
        '';

     

       
65
       
 
       
      };

     

       
66
       
 
       


     

       
67
       
 
       
      vendor.config.enable = mkOption {

     

       
68
       
 
       
        type = types.bool;

     

       
69
       
 
       
        default = true;

     

       
70
       
+
       
        description = lib.mdDoc ''

     

       
71
       
 
       
          Whether fish should source configuration snippets provided by other packages.

     

       
72
       
 
       
        '';

     

       
73
       
 
       
      };

     
···

       
75
       
 
       
      vendor.completions.enable = mkOption {

     

       
76
       
 
       
        type = types.bool;

     

       
77
       
 
       
        default = true;

     

       
78
       
+
       
        description = lib.mdDoc ''

     

       
79
       
 
       
          Whether fish should use completion files provided by other packages.

     

       
80
       
 
       
        '';

     

       
81
       
 
       
      };

     
···

       
83
       
 
       
      vendor.functions.enable = mkOption {

     

       
84
       
 
       
        type = types.bool;

     

       
85
       
 
       
        default = true;

     

       
86
       
+
       
        description = lib.mdDoc ''

     

       
87
       
 
       
          Whether fish should autoload fish functions provided by other packages.

     

       
88
       
 
       
        '';

     

       
89
       
 
       
      };

     
···

       
94
       
 
       
          gco = "git checkout";

     

       
95
       
 
       
          npu = "nix-prefetch-url";

     

       
96
       
 
       
        };

     

       
97
       
+
       
        description = lib.mdDoc ''

     

       
98
       
 
       
          Set of fish abbreviations.

     

       
99
       
 
       
        '';

     

       
100
       
 
       
        type = with types; attrsOf str;

     
···

       
102
       
 
       


     

       
103
       
 
       
      shellAliases = mkOption {

     

       
104
       
 
       
        default = {};

     

       
105
       
+
       
        description = lib.mdDoc ''

     

       
106
       
+
       
          Set of aliases for fish shell, which overrides {option}`environment.shellAliases`.

     

       
107
       
+
       
          See {option}`environment.shellAliases` for an option format description.

     

       
108
       
 
       
        '';

     

       
109
       
 
       
        type = with types; attrsOf (nullOr (either str path));

     

       
110
       
 
       
      };

     

       
111
       
 
       


     

       
112
       
 
       
      shellInit = mkOption {

     

       
113
       
 
       
        default = "";

     

       
114
       
+
       
        description = lib.mdDoc ''

     

       
115
       
 
       
          Shell script code called during fish shell initialisation.

     

       
116
       
 
       
        '';

     

       
117
       
 
       
        type = types.lines;

     
···

       
119
       
 
       


     

       
120
       
 
       
      loginShellInit = mkOption {

     

       
121
       
 
       
        default = "";

     

       
122
       
+
       
        description = lib.mdDoc ''

     

       
123
       
 
       
          Shell script code called during fish login shell initialisation.

     

       
124
       
 
       
        '';

     

       
125
       
 
       
        type = types.lines;

     
···

       
127
       
 
       


     

       
128
       
 
       
      interactiveShellInit = mkOption {

     

       
129
       
 
       
        default = "";

     

       
130
       
+
       
        description = lib.mdDoc ''

     

       
131
       
 
       
          Shell script code called during interactive fish shell initialisation.

     

       
132
       
 
       
        '';

     

       
133
       
 
       
        type = types.lines;

     
···

       
135
       
 
       


     

       
136
       
 
       
      promptInit = mkOption {

     

       
137
       
 
       
        default = "";

     

       
138
       
+
       
        description = lib.mdDoc ''

     

       
139
       
 
       
          Shell script code used to initialise fish prompt.

     

       
140
       
 
       
        '';

     

       
141
       
 
       
        type = types.lines;

     

···

       
41
       
 
       
        type = types.nullOr types.path;

     

       
42
       
 
       
        default = null;

     

       
43
       
 
       
        example = literalExpression ''"''${pkgs.my-configs}/lesskey"'';

     

       
44
       
-
       
        description = ''

     

       
45
       
 
       
          Path to lesskey configuration file.

     

       
46
       
 
       


     

       
47
       
-
       
          <option>configFile</option> takes precedence over <option>commands</option>,

     

       
48
       
-
       
          <option>clearDefaultCommands</option>, <option>lineEditingKeys</option>, and

     

       
49
       
-
       
          <option>envVariables</option>.

     

       
50
       
 
       
        '';

     

       
51
       
 
       
      };

     

       
52
       
 
       


     
···

       
57
       
 
       
          h = "noaction 5\\e(";

     

       
58
       
 
       
          l = "noaction 5\\e)";

     

       
59
       
 
       
        };

     

       
60
       
-
       
        description = "Defines new command keys.";

     

       
61
       
 
       
      };

     

       
62
       
 
       


     

       
63
       
 
       
      clearDefaultCommands = mkOption {

     

       
64
       
 
       
        type = types.bool;

     

       
65
       
 
       
        default = false;

     

       
66
       
-
       
        description = ''

     

       
67
       
 
       
          Clear all default commands.

     

       
68
       
 
       
          You should remember to set the quit key.

     

       
69
       
 
       
          Otherwise you will not be able to leave less without killing it.

     
···

       
76
       
 
       
        example = {

     

       
77
       
 
       
          e = "abort";

     

       
78
       
 
       
        };

     

       
79
       
-
       
        description = "Defines new line-editing keys.";

     

       
80
       
 
       
      };

     

       
81
       
 
       


     

       
82
       
 
       
      envVariables = mkOption {

     
···

       
87
       
 
       
        example = {

     

       
88
       
 
       
          LESS = "--quit-if-one-screen";

     

       
89
       
 
       
        };

     

       
90
       
-
       
        description = "Defines environment variables.";

     

       
91
       
 
       
      };

     

       
92
       
 
       


     

       
93
       
 
       
      lessopen = mkOption {

     

       
94
       
 
       
        type = types.nullOr types.str;

     

       
95
       
 
       
        default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s";

     

       
96
       
 
       
        defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"'';

     

       
97
       
-
       
        description = ''

     

       
98
       
 
       
          Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed.

     

       
99
       
 
       
        '';

     

       
100
       
 
       
      };

     
···

       
102
       
 
       
      lessclose = mkOption {

     

       
103
       
 
       
        type = types.nullOr types.str;

     

       
104
       
 
       
        default = null;

     

       
105
       
-
       
        description = ''

     

       
106
       
 
       
          When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may  perform  any  desired  clean-up  action (such  as deleting the replacement file created by LESSOPEN).

     

       
107
       
 
       
        '';

     

       
108
       
 
       
      };

     

···

       
41
       
 
       
        type = types.nullOr types.path;

     

       
42
       
 
       
        default = null;

     

       
43
       
 
       
        example = literalExpression ''"''${pkgs.my-configs}/lesskey"'';

     

       
44
       
+
       
        description = lib.mdDoc ''

     

       
45
       
 
       
          Path to lesskey configuration file.

     

       
46
       
 
       


     

       
47
       
+
       
          {option}`configFile` takes precedence over {option}`commands`,

     

       
48
       
+
       
          {option}`clearDefaultCommands`, {option}`lineEditingKeys`, and

     

       
49
       
+
       
          {option}`envVariables`.

     

       
50
       
 
       
        '';

     

       
51
       
 
       
      };

     

       
52
       
 
       


     
···

       
57
       
 
       
          h = "noaction 5\\e(";

     

       
58
       
 
       
          l = "noaction 5\\e)";

     

       
59
       
 
       
        };

     

       
60
       
+
       
        description = lib.mdDoc "Defines new command keys.";

     

       
61
       
 
       
      };

     

       
62
       
 
       


     

       
63
       
 
       
      clearDefaultCommands = mkOption {

     

       
64
       
 
       
        type = types.bool;

     

       
65
       
 
       
        default = false;

     

       
66
       
+
       
        description = lib.mdDoc ''

     

       
67
       
 
       
          Clear all default commands.

     

       
68
       
 
       
          You should remember to set the quit key.

     

       
69
       
 
       
          Otherwise you will not be able to leave less without killing it.

     
···

       
76
       
 
       
        example = {

     

       
77
       
 
       
          e = "abort";

     

       
78
       
 
       
        };

     

       
79
       
+
       
        description = lib.mdDoc "Defines new line-editing keys.";

     

       
80
       
 
       
      };

     

       
81
       
 
       


     

       
82
       
 
       
      envVariables = mkOption {

     
···

       
87
       
 
       
        example = {

     

       
88
       
 
       
          LESS = "--quit-if-one-screen";

     

       
89
       
 
       
        };

     

       
90
       
+
       
        description = lib.mdDoc "Defines environment variables.";

     

       
91
       
 
       
      };

     

       
92
       
 
       


     

       
93
       
 
       
      lessopen = mkOption {

     

       
94
       
 
       
        type = types.nullOr types.str;

     

       
95
       
 
       
        default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s";

     

       
96
       
 
       
        defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"'';

     

       
97
       
+
       
        description = lib.mdDoc ''

     

       
98
       
 
       
          Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed.

     

       
99
       
 
       
        '';

     

       
100
       
 
       
      };

     
···

       
102
       
 
       
      lessclose = mkOption {

     

       
103
       
 
       
        type = types.nullOr types.str;

     

       
104
       
 
       
        default = null;

     

       
105
       
+
       
        description = lib.mdDoc ''

     

       
106
       
 
       
          When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may  perform  any  desired  clean-up  action (such  as deleting the replacement file created by LESSOPEN).

     

       
107
       
 
       
        '';

     

       
108
       
 
       
      };