···123124- [Fider](https://fider.io/), an open platform to collect and prioritize feedback. Available as [services.fider](#opt-services.fider.enable).
12500126- [mqtt-exporter](https://github.com/kpetremann/mqtt-exporter/), a Prometheus exporter for exposing messages from MQTT. Available as [services.prometheus.exporters.mqtt](#opt-services.prometheus.exporters.mqtt.enable).
127128- [nvidia-gpu](https://github.com/utkuozdemir/nvidia_gpu_exporter), a Prometheus exporter that scrapes `nvidia-smi` for GPU metrics. Available as [services.prometheus.exporters.nvidia-gpu](#opt-services.prometheus.exporters.nvidia-gpu.enable).
···123124- [Fider](https://fider.io/), an open platform to collect and prioritize feedback. Available as [services.fider](#opt-services.fider.enable).
125126+- [PDS](https://github.com/bluesky-social/pds), Personal Data Server for [bsky](https://bsky.social/). Available as [services.pds](option.html#opt-services.pds).
127+128- [mqtt-exporter](https://github.com/kpetremann/mqtt-exporter/), a Prometheus exporter for exposing messages from MQTT. Available as [services.prometheus.exporters.mqtt](#opt-services.prometheus.exporters.mqtt.enable).
129130- [nvidia-gpu](https://github.com/utkuozdemir/nvidia_gpu_exporter), a Prometheus exporter that scrapes `nvidia-smi` for GPU metrics. Available as [services.prometheus.exporters.nvidia-gpu](#opt-services.prometheus.exporters.nvidia-gpu.enable).
+2-2
nixos/modules/config/ldap.nix
···135 type = types.lines;
136 description = ''
137 Extra configuration options that will be added verbatim at
138- the end of the nslcd configuration file (`nslcd.conf(5)`).
139 '';
140 };
141···219 type = types.lines;
220 description = ''
221 Extra configuration options that will be added verbatim at
222- the end of the ldap configuration file (`ldap.conf(5)`).
223 If {option}`users.ldap.daemon` is enabled, this
224 configuration will not be used. In that case, use
225 {option}`users.ldap.daemon.extraConfig` instead.
···135 type = types.lines;
136 description = ''
137 Extra configuration options that will be added verbatim at
138+ the end of the nslcd configuration file ({manpage}`nslcd.conf(5)`).
139 '';
140 };
141···219 type = types.lines;
220 description = ''
221 Extra configuration options that will be added verbatim at
222+ the end of the ldap configuration file ({manpage}`ldap.conf(5)`).
223 If {option}`users.ldap.daemon` is enabled, this
224 configuration will not be used. In that case, use
225 {option}`users.ldap.daemon.extraConfig` instead.
+1-1
nixos/modules/config/mysql.nix
···111 - `0` (or `"plain"`):
112 No encryption. Passwords are stored in plaintext. HIGHLY DISCOURAGED.
113 - `1` (or `"Y"`):
114- Use crypt(3) function.
115 - `2` (or `"mysql"`):
116 Use the MySQL PASSWORD() function. It is possible that the encryption function used
117 by `pam_mysql` is different from that of the MySQL server, as
···111 - `0` (or `"plain"`):
112 No encryption. Passwords are stored in plaintext. HIGHLY DISCOURAGED.
113 - `1` (or `"Y"`):
114+ Use {manpage}`crypt(3)` function.
115 - `2` (or `"mysql"`):
116 Use the MySQL PASSWORD() function. It is possible that the encryption function used
117 by `pam_mysql` is different from that of the MySQL server, as
+3-3
nixos/modules/config/swap.nix
···46 If not specified, the amount of data to read from `source` will be
47 determined by cryptsetup.
4849- See `cryptsetup-open(8)` for details.
50 '';
51 };
52···60 If not specified, the default sector size is determined from the
61 underlying block device.
6263- See `cryptsetup-open(8)` for details.
64 '';
65 };
66···158 whole swap space is discarded at swapon invocation. If "pages",
159 asynchronous discard on freed pages is performed, before returning to
160 the available pages pool. With "both", both policies are activated.
161- See swapon(8) for more information.
162 '';
163 };
164
···46 If not specified, the amount of data to read from `source` will be
47 determined by cryptsetup.
4849+ See `{manpage}`cryptsetup-open(8)`` for details.
50 '';
51 };
52···60 If not specified, the default sector size is determined from the
61 underlying block device.
6263+ See `{manpage}`cryptsetup-open(8)`` for details.
64 '';
65 };
66···158 whole swap space is discarded at swapon invocation. If "pages",
159 asynchronous discard on freed pages is performed, before returning to
160 the available pages pool. With "both", both policies are activated.
161+ See {manpage}`swapon(8)` for more information.
162 '';
163 };
164
+1-1
nixos/modules/config/users-groups.nix
···204 homeMode = mkOption {
205 type = types.strMatching "[0-7]{1,5}";
206 default = "700";
207- description = "The user's home directory mode in numeric format. See chmod(1). The mode is only applied if {option}`users.users.<name>.createHome` is true.";
208 };
209210 cryptHomeLuks = mkOption {
···204 homeMode = mkOption {
205 type = types.strMatching "[0-7]{1,5}";
206 default = "700";
207+ description = "The user's home directory mode in numeric format. See {manpage}`chmod(1)`. The mode is only applied if {option}`users.users.<name>.createHome` is true.";
208 };
209210 cryptHomeLuks = mkOption {
+1-1
nixos/modules/config/xdg/portals/wlr.nix
···28 description = ''
29 Configuration for `xdg-desktop-portal-wlr`.
3031- See `xdg-desktop-portal-wlr(5)` for supported
32 values.
33 '';
34
···28 description = ''
29 Configuration for `xdg-desktop-portal-wlr`.
3031+ See {manpage}`xdg-desktop-portal-wlr(5)` for supported
32 values.
33 '';
34
···26 default = { };
27 description = ''
28 System-wide configuration for GameMode (/etc/gamemode.ini).
29- See gamemoded(8) man page for available settings.
30 '';
31 example = lib.literalExpression ''
32 {
···26 default = { };
27 description = ''
28 System-wide configuration for GameMode (/etc/gamemode.ini).
29+ See {manpage}`gamemoded(8)` man page for available settings.
30 '';
31 example = lib.literalExpression ''
32 {
+1-1
nixos/modules/programs/git.nix
···47 `config` to `[ { foo.x = 42; } { bar.y = 42; }]` will put the `foo`
48 section before the `bar` section unlike the default alphabetical
49 order, which can be helpful for sections such as `include` and
50- `includeIf`. See the CONFIGURATION FILE section of git-config(1) for
51 more information.
52 '';
53 };
···47 `config` to `[ { foo.x = 42; } { bar.y = 42; }]` will put the `foo`
48 section before the `bar` section unlike the default alphabetical
49 order, which can be helpful for sections such as `include` and
50+ `includeIf`. See the CONFIGURATION FILE section of {manpage}`git-config(1)` for
51 more information.
52 '';
53 };
+3-3
nixos/modules/programs/msmtp.nix
···34 };
35 description = ''
36 Default values applied to all accounts.
37- See msmtp(1) for the available options.
38 '';
39 };
40···52 description = ''
53 Named accounts and their respective configurations.
54 The special name "default" allows a default account to be defined.
55- See msmtp(1) for the available options.
5657 Use `programs.msmtp.extraConfig` instead of this attribute set-based
58 option if ordered account inheritance is needed.
···68 default = "";
69 description = ''
70 Extra lines to add to the msmtp configuration verbatim.
71- See msmtp(1) for the syntax and available options.
72 '';
73 };
74 };
···34 };
35 description = ''
36 Default values applied to all accounts.
37+ See {manpage}`msmtp(1)` for the available options.
38 '';
39 };
40···52 description = ''
53 Named accounts and their respective configurations.
54 The special name "default" allows a default account to be defined.
55+ See {manpage}`msmtp(1)` for the available options.
5657 Use `programs.msmtp.extraConfig` instead of this attribute set-based
58 option if ordered account inheritance is needed.
···68 default = "";
69 description = ''
70 Extra lines to add to the msmtp configuration verbatim.
71+ See {manpage}`msmtp(1)` for the syntax and available options.
72 '';
73 };
74 };
+1-1
nixos/modules/programs/shadow.nix
···31 description = ''
32 Config options for the /etc/login.defs file, that defines
33 the site-specific configuration for the shadow password suite.
34- See login.defs(5) man page for available options.
35 '';
36 type = lib.types.submodule {
37 freeformType = (pkgs.formats.keyValue { }).type;
···31 description = ''
32 Config options for the /etc/login.defs file, that defines
33 the site-specific configuration for the shadow password suite.
34+ See {manpage}`login.defs(5)` man page for available options.
35 '';
36 type = lib.types.submodule {
37 freeformType = (pkgs.formats.keyValue { }).type;
+1-1
nixos/modules/security/pam.nix
···1483 the YubiCloud.
14841485 Use "challenge-response" for offline validation using YubiKeys with HMAC-SHA-1
1486- Challenge-Response configurations. See the man-page ykpamcfg(1) for further
1487 details on how to configure offline Challenge-Response validation.
14881489 More information can be found [here](https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html).
···1483 the YubiCloud.
14841485 Use "challenge-response" for offline validation using YubiKeys with HMAC-SHA-1
1486+ Challenge-Response configurations. See the man-page {manpage}`ykpamcfg(1)` for further
1487 details on how to configure offline Challenge-Response validation.
14881489 More information can be found [here](https://developers.yubico.com/yubico-pam/Authentication_Using_Challenge-Response.html).
+1-1
nixos/modules/security/wrappers/default.nix
···214 example = "10G";
215 type = lib.types.str;
216 description = ''
217- Size limit for the /run/wrappers tmpfs. Look at mount(8), tmpfs size option,
218 for the accepted syntax. WARNING: don't set to less than 64MB.
219 '';
220 };
···214 example = "10G";
215 type = lib.types.str;
216 description = ''
217+ Size limit for the /run/wrappers tmpfs. Look at {manpage}`mount(8)`, tmpfs size option,
218 for the accepted syntax. WARNING: don't set to less than 64MB.
219 '';
220 };
+2-2
nixos/modules/services/backup/btrbk.nix
···163 default = 10;
164 };
165 ioSchedulingClass = mkOption {
166- description = "IO scheduling class for btrbk (see ionice(1) for a quick description). Applies to local instances, and remote ones connecting by ssh if set to idle.";
167 type = types.enum [
168 "idle"
169 "best-effort"
···181 type = types.nullOr types.str;
182 default = "daily";
183 description = ''
184- How often this btrbk instance is started. See systemd.time(7) for more information about the format.
185 Setting it to null disables the timer, thus this instance can only be started manually.
186 '';
187 };
···163 default = 10;
164 };
165 ioSchedulingClass = mkOption {
166+ description = "IO scheduling class for btrbk (see {manpage}`ionice(1)` for a quick description). Applies to local instances, and remote ones connecting by ssh if set to idle.";
167 type = types.enum [
168 "idle"
169 "best-effort"
···181 type = types.nullOr types.str;
182 default = "daily";
183 description = ''
184+ How often this btrbk instance is started. See {manpage}`systemd.time(7)` for more information about the format.
185 Setting it to null disables the timer, thus this instance can only be started manually.
186 '';
187 };
+1-1
nixos/modules/services/backup/restic.nix
···23 default = null;
24 description = ''
25 file containing the credentials to access the repository, in the
26- format of an EnvironmentFile as described by systemd.exec(5)
27 '';
28 };
29
···23 default = null;
24 description = ''
25 file containing the credentials to access the repository, in the
26+ format of an EnvironmentFile as described by {manpage}`systemd.exec(5)`
27 '';
28 };
29
+4-4
nixos/modules/services/backup/tarsnap.nix
···60 `"/root/tarsnap.key"`.
6162 It's recommended for backups that you generate a key for every archive
63- using `tarsnap-keygen(1)`, and then generate a
64- write-only tarsnap key using `tarsnap-keymgmt(1)`,
65 and keep your master key(s) for a particular machine off-site.
6667 The keyfile name should be given as a string and not a path, to
···86 Use this option if you want to run multiple backups
87 concurrently - each archive must have a unique key. You can
88 generate a write-only key derived from your master key (which
89- is recommended) using `tarsnap-keymgmt(1)`.
9091 Note: every archive must have an individual master key. You
92 must generate multiple keys with
93- `tarsnap-keygen(1)`, and then generate write
94 only keys from those.
9596 The keyfile name should be given as a string and not a path, to
···60 `"/root/tarsnap.key"`.
6162 It's recommended for backups that you generate a key for every archive
63+ using {manpage}`tarsnap-keygen(1)`, and then generate a
64+ write-only tarsnap key using {manpage}`tarsnap-keymgmt(1)`,
65 and keep your master key(s) for a particular machine off-site.
6667 The keyfile name should be given as a string and not a path, to
···86 Use this option if you want to run multiple backups
87 concurrently - each archive must have a unique key. You can
88 generate a write-only key derived from your master key (which
89+ is recommended) using {manpage}`tarsnap-keymgmt(1)`.
9091 Note: every archive must have an individual master key. You
92 must generate multiple keys with
93+ {manpage}`tarsnap-keygen(1)`, and then generate write
94 only keys from those.
9596 The keyfile name should be given as a string and not a path, to
+1-1
nixos/modules/services/cluster/k3s/default.nix
···227 environmentFile = lib.mkOption {
228 type = lib.types.nullOr lib.types.path;
229 description = ''
230- File path containing environment variables for configuring the k3s service in the format of an EnvironmentFile. See systemd.exec(5).
231 '';
232 default = null;
233 };
···227 environmentFile = lib.mkOption {
228 type = lib.types.nullOr lib.types.path;
229 description = ''
230+ File path containing environment variables for configuring the k3s service in the format of an EnvironmentFile. See {manpage}`systemd.exec(5)`.
231 '';
232 default = null;
233 };
+1-1
nixos/modules/services/hardware/libinput.nix
···136 default = null;
137 example = "1 6 3 4 5 0 7";
138 description = ''
139- Sets the logical button mapping for this device, see XSetPointerMapping(3). The string must
140 be a space-separated list of button mappings in the order of the logical buttons on the
141 device, starting with button 1. The default mapping is "1 2 3 ... 32". A mapping of 0 deac‐
142 tivates the button. Multiple buttons can have the same mapping. Invalid mapping strings are
···136 default = null;
137 example = "1 6 3 4 5 0 7";
138 description = ''
139+ Sets the logical button mapping for this device, see {manpage}`XSetPointerMapping(3)`. The string must
140 be a space-separated list of button mappings in the order of the logical buttons on the
141 device, starting with button 1. The default mapping is "1 2 3 ... 32". A mapping of 0 deac‐
142 tivates the button. Multiple buttons can have the same mapping. Invalid mapping strings are
+2-2
nixos/modules/services/hardware/thinkfan.nix
···249 ];
250 description = ''
251 A list of extra command line arguments to pass to thinkfan.
252- Check the thinkfan(1) manpage for available arguments.
253 '';
254 };
255···259 description = ''
260 Thinkfan settings. Use this option to configure thinkfan
261 settings not exposed in a NixOS option or to bypass one.
262- Before changing this, read the `thinkfan.conf(5)`
263 manpage and take a look at the example config file at
264 <https://github.com/vmatare/thinkfan/blob/master/examples/thinkfan.yaml>
265 '';
···249 ];
250 description = ''
251 A list of extra command line arguments to pass to thinkfan.
252+ Check the {manpage}`thinkfan(1)` manpage for available arguments.
253 '';
254 };
255···259 description = ''
260 Thinkfan settings. Use this option to configure thinkfan
261 settings not exposed in a NixOS option or to bypass one.
262+ Before changing this, read the `{manpage}`thinkfan.conf(5)``
263 manpage and take a look at the example config file at
264 <https://github.com/vmatare/thinkfan/blob/master/examples/thinkfan.yaml>
265 '';
+1-1
nixos/modules/services/hardware/upower.nix
···65 on or off. We can't do much to fix these problems, but this is a way
66 for users to make the laptop panel vanish, a state that might be used
67 by a couple of user-space daemons. On Linux systems, see also
68- logind.conf(5).
69 '';
70 };
71
···65 on or off. We can't do much to fix these problems, but this is a way
66 for users to make the laptop panel vanish, a state that might be used
67 by a couple of user-space daemons. On Linux systems, see also
68+ {manpage}`logind.conf(5)`.
69 '';
70 };
71
···67 ];
68 description = ''
69 A list of device nodes to which {command}`esphome` has access to.
70- Refer to DeviceAllow in systemd.resource-control(5) for more information.
71 Beware that if a device is referred to by an absolute path instead of a device category,
72 it will only allow devices that already are plugged in when the service is started.
73 '';
···67 ];
68 description = ''
69 A list of device nodes to which {command}`esphome` has access to.
70+ Refer to DeviceAllow in {manpage}`systemd.resource-control(5)` for more information.
71 Beware that if a device is referred to by an absolute path instead of a device category,
72 it will only allow devices that already are plugged in when the service is started.
73 '';
+3-3
nixos/modules/services/logging/journalwatch.nix
···135 this patternBlock's {option}`filters` are applied.
136 If `value` starts and ends with a slash, it is interpreted as
137 an extended python regular expression, if not, it's an exact match.
138- The journal fields are explained in systemd.journal-fields(7).
139 '';
140 };
141···210 description = ''
211 How often to run journalwatch.
212213- The format is described in systemd.time(7).
214 '';
215 };
216 accuracy = lib.mkOption {
···219 description = ''
220 The time window around the interval in which the journalwatch run will be scheduled.
221222- The format is described in systemd.time(7).
223 '';
224 };
225 };
···135 this patternBlock's {option}`filters` are applied.
136 If `value` starts and ends with a slash, it is interpreted as
137 an extended python regular expression, if not, it's an exact match.
138+ The journal fields are explained in {manpage}`systemd.journal-fields(7)`.
139 '';
140 };
141···210 description = ''
211 How often to run journalwatch.
212213+ The format is described in {manpage}`systemd.time(7)`.
214 '';
215 };
216 accuracy = lib.mkOption {
···219 description = ''
220 The time window around the interval in which the journalwatch run will be scheduled.
221222+ The format is described in {manpage}`systemd.time(7)`.
223 '';
224 };
225 };
+1-1
nixos/modules/services/logging/syslogd.nix
···70 type = lib.types.bool;
71 default = false;
72 description = ''
73- Accept logging through UDP. Option -r of syslogd(8).
74 '';
75 };
76
···70 type = lib.types.bool;
71 default = false;
72 description = ''
73+ Accept logging through UDP. Option -r of {manpage}`syslogd(8)`.
74 '';
75 };
76
+3-3
nixos/modules/services/mail/clamsmtp.nix
···43 default = "";
44 example = "X-Virus-Scanned: ClamAV using ClamSMTP";
45 description = ''
46- A header to add to scanned messages. See clamsmtpd.conf(5) for
47 more details. Empty means no header.
48 '';
49 };
···65 example = "127.0.0.1:10025";
66 description = ''
67 Address to wait for incoming SMTP connections on. See
68- clamsmtpd.conf(5) for more details.
69 '';
70 };
71···118 default = null;
119 description = ''
120 Command to run when a virus is found. Please see VIRUS ACTION in
121- clamsmtpd(8) for a discussion of this option and its safe use.
122 '';
123 };
124
···43 default = "";
44 example = "X-Virus-Scanned: ClamAV using ClamSMTP";
45 description = ''
46+ A header to add to scanned messages. See {manpage}`clamsmtpd.conf(5)` for
47 more details. Empty means no header.
48 '';
49 };
···65 example = "127.0.0.1:10025";
66 description = ''
67 Address to wait for incoming SMTP connections on. See
68+ {manpage}`clamsmtpd.conf(5)` for more details.
69 '';
70 };
71···118 default = null;
119 description = ''
120 Command to run when a virus is found. Please see VIRUS ACTION in
121+ {manpage}`clamsmtpd(8)` for a discussion of this option and its safe use.
122 '';
123 };
124
+3-3
nixos/modules/services/mail/cyrus-imap.nix
···80 type = int;
81 default = 32;
82 description = ''
83- Socket listen queue backlog size. See listen(2) for more information about a backlog.
84 Default is 32, which may be increased if you have a very high connection rate.
85 '';
86 };
···194 DAEMON = mkOption {
195 default = { };
196 description = ''
197- This section lists long running daemons to start before any SERVICES are spawned. master(8) will ensure that these processes are running, restarting any process which dies or forks. All listed processes will be shutdown when master(8) is exiting.
198 '';
199 };
200 };
···221 type = path;
222 default = "/run/cyrus/lmtp";
223 description = ''
224- Unix socket that lmtpd listens on, used by deliver(8). This should match the path specified in cyrus.conf(5).
225 '';
226 };
227 idlesocket = mkOption {
···80 type = int;
81 default = 32;
82 description = ''
83+ Socket listen queue backlog size. See {manpage}`listen(2)` for more information about a backlog.
84 Default is 32, which may be increased if you have a very high connection rate.
85 '';
86 };
···194 DAEMON = mkOption {
195 default = { };
196 description = ''
197+ This section lists long running daemons to start before any SERVICES are spawned. {manpage}`master(8)` will ensure that these processes are running, restarting any process which dies or forks. All listed processes will be shutdown when {manpage}`master(8)` is exiting.
198 '';
199 };
200 };
···221 type = path;
222 default = "/run/cyrus/lmtp";
223 description = ''
224+ Unix socket that lmtpd listens on, used by {manpage}`deliver(8)`. This should match the path specified in {manpage}`cyrus.conf(5)`.
225 '';
226 };
227 idlesocket = mkOption {
+2-2
nixos/modules/services/mail/offlineimap.nix
···37 onCalendar = lib.mkOption {
38 type = lib.types.str;
39 default = "*:0/3"; # every 3 minutes
40- description = "How often is offlineimap started. Default is '*:0/3' meaning every 3 minutes. See systemd.time(7) for more information about the format.";
41 };
4243 timeoutStartSec = lib.mkOption {
44 type = lib.types.str;
45 default = "120sec"; # Kill if still alive after 2 minutes
46- description = "How long waiting for offlineimap before killing it. Default is '120sec' meaning every 2 minutes. See systemd.time(7) for more information about the format.";
47 };
48 };
49 config = lib.mkIf (cfg.enable || cfg.install) {
···37 onCalendar = lib.mkOption {
38 type = lib.types.str;
39 default = "*:0/3"; # every 3 minutes
40+ description = "How often is offlineimap started. Default is '*:0/3' meaning every 3 minutes. See {manpage}`systemd.time(7)` for more information about the format.";
41 };
4243 timeoutStartSec = lib.mkOption {
44 type = lib.types.str;
45 default = "120sec"; # Kill if still alive after 2 minutes
46+ description = "How long waiting for offlineimap before killing it. Default is '120sec' meaning every 2 minutes. See {manpage}`systemd.time(7)` for more information about the format.";
47 };
48 };
49 config = lib.mkIf (cfg.enable || cfg.install) {
+1-1
nixos/modules/services/mail/opendkim.nix
···65 defaultText = lib.literalExpression ''"csl:''${config.networking.hostName}"'';
66 example = "csl:example.com,mydomain.net";
67 description = ''
68- Local domains set (see `opendkim(8)` for more information on datasets).
69 Messages from them are signed, not verified.
70 '';
71 };
···65 defaultText = lib.literalExpression ''"csl:''${config.networking.hostName}"'';
66 example = "csl:example.com,mydomain.net";
67 description = ''
68+ Local domains set (see {manpage}`opendkim(8)` for more information on datasets).
69 Messages from them are signed, not verified.
70 '';
71 };
+4-4
nixos/modules/services/mail/postfix.nix
···546 type = lib.types.lines;
547 default = "";
548 description = ''
549- Additional entries to put verbatim into aliases file, cf. man-page aliases(8).
550 '';
551 };
552···631 type = lib.types.lines;
632 default = "";
633 description = ''
634- Entries for the virtual alias map, cf. man-page virtual(5).
635 '';
636 };
637···654 List of accepted local users. Specify a bare username, an
655 `"@domain.tld"` wild-card, or a complete
656 `"user@domain.tld"` address. If set, these names end
657- up in the local recipient map -- see the local(8) man-page -- and
658 effectively replace the system user database lookup that's otherwise
659 used by default.
660 '';
···664 default = "";
665 type = lib.types.lines;
666 description = ''
667- Entries for the transport map, cf. man-page transport(8).
668 '';
669 };
670
···546 type = lib.types.lines;
547 default = "";
548 description = ''
549+ Additional entries to put verbatim into aliases file, cf. man-page {manpage}`aliases(8)`.
550 '';
551 };
552···631 type = lib.types.lines;
632 default = "";
633 description = ''
634+ Entries for the virtual alias map, cf. man-page {manpage}`virtual(5)`.
635 '';
636 };
637···654 List of accepted local users. Specify a bare username, an
655 `"@domain.tld"` wild-card, or a complete
656 `"user@domain.tld"` address. If set, these names end
657+ up in the local recipient map -- see the {manpage}`local(8)` man-page -- and
658 effectively replace the system user database lookup that's otherwise
659 used by default.
660 '';
···664 default = "";
665 type = lib.types.lines;
666 description = ''
667+ Entries for the transport map, cf. man-page {manpage}`transport(8)`.
668 '';
669 };
670
+3-3
nixos/modules/services/mail/postgrey.nix
···119 greylistAction = mkOption {
120 type = str;
121 default = "DEFER_IF_PERMIT";
122- description = "Response status for greylisted messages (see access(5))";
123 };
124 greylistHeader = mkOption {
125 type = str;
···170 whitelistClients = mkOption {
171 type = listOf path;
172 default = [ ];
173- description = "Client address whitelist files (see postgrey(8))";
174 };
175 whitelistRecipients = mkOption {
176 type = listOf path;
177 default = [ ];
178- description = "Recipient address whitelist files (see postgrey(8))";
179 };
180 };
181 };
···119 greylistAction = mkOption {
120 type = str;
121 default = "DEFER_IF_PERMIT";
122+ description = "Response status for greylisted messages (see {manpage}`access(5)`)";
123 };
124 greylistHeader = mkOption {
125 type = str;
···170 whitelistClients = mkOption {
171 type = listOf path;
172 default = [ ];
173+ description = "Client address whitelist files (see {manpage}`postgrey(8)`)";
174 };
175 whitelistRecipients = mkOption {
176 type = listOf path;
177 default = [ ];
178+ description = "Recipient address whitelist files (see {manpage}`postgrey(8)`)";
179 };
180 };
181 };
+1-1
nixos/modules/services/misc/autofs.nix
···49 '''
50 '';
51 description = ''
52- Contents of `/etc/auto.master` file. See {command}`auto.master(5)` and {command}`autofs(5)`.
53 '';
54 };
55
···49 '''
50 '';
51 description = ''
52+ Contents of `/etc/auto.master` file. See {manpage}`auto.master(5)` and {manpage}`autofs(5)`.
53 '';
54 };
55
+1-1
nixos/modules/services/misc/gpsd.nix
···105 ];
106 description = ''
107 A list of extra command line arguments to pass to gpsd.
108- Check gpsd(8) mangpage for possible arguments.
109 '';
110 };
111
···105 ];
106 description = ''
107 A list of extra command line arguments to pass to gpsd.
108+ Check {manpage}`gpsd(8)` mangpage for possible arguments.
109 '';
110 };
111
···54 default = null;
55 description = ''
56 File containing the credentials to access the repository, in the
57- format of an EnvironmentFile as described by systemd.exec(5)
58 '';
59 };
60
···54 default = null;
55 description = ''
56 File containing the credentials to access the repository, in the
57+ format of an EnvironmentFile as described by {manpage}`systemd.exec(5)`
58 '';
59 };
60
···73 });
74 description = ''
75 This cell's database server records, added to the global
76- CellServDB. See CellServDB(5) man page for syntax. Ignored when
77 `afsdb` is set to `true`.
78 '';
79 example = [
···73 });
74 description = ''
75 This cell's database server records, added to the global
76+ CellServDB. See {manpage}`CellServDB(5)` man page for syntax. Ignored when
77 `afsdb` is set to `true`.
78 '';
79 example = [
···194 will be symlinked to the location given here.
195 This file must exist and be
196 readable only by the `uucp` user.
197- See hosts.hfaxd(5) for details.
198 This configuration permits access for all users:
199 ```
200 environment.etc."hosts.hfaxd" = {
···299 description = ''
300 purging old files from the spooling area with
301 {file}`faxcron` with the given frequency
302- (see systemd.time(7))
303 '';
304 };
305 faxcron.infoDays = mkOption {
···339 description = ''
340 Purge old files from the spooling area with
341 {file}`faxcron` with the given frequency
342- (see systemd.time(7)).
343 '';
344 };
345 faxqclean.archiving = mkOption {
···356 `as-flagged` archives jobs that
357 have been flagged for archiving by sendfax,
358 `always` forces archiving of all jobs.
359- See also sendfax(1) and faxqclean(8).
360 '';
361 };
362 faxqclean.doneqMinutes = mkOption {
···194 will be symlinked to the location given here.
195 This file must exist and be
196 readable only by the `uucp` user.
197+ See {manpage}`hosts.hfaxd(5)` for details.
198 This configuration permits access for all users:
199 ```
200 environment.etc."hosts.hfaxd" = {
···299 description = ''
300 purging old files from the spooling area with
301 {file}`faxcron` with the given frequency
302+ (see {manpage}`systemd.time(7)`)
303 '';
304 };
305 faxcron.infoDays = mkOption {
···339 description = ''
340 Purge old files from the spooling area with
341 {file}`faxcron` with the given frequency
342+ (see {manpage}`systemd.time(7)`).
343 '';
344 };
345 faxqclean.archiving = mkOption {
···356 `as-flagged` archives jobs that
357 have been flagged for archiving by sendfax,
358 `always` forces archiving of all jobs.
359+ See also {manpage}`sendfax(1)` and {manpage}`faxqclean(8)`.
360 '';
361 };
362 faxqclean.doneqMinutes = mkOption {
···29 enable = mkEnableOption "the ngircd IRC server";
3031 config = mkOption {
32- description = "The ngircd configuration (see ngircd.conf(5)).";
3334 type = types.lines;
35 };
···29 enable = mkEnableOption "the ngircd IRC server";
3031 config = mkOption {
32+ description = "The ngircd configuration (see {manpage}`ngircd.conf(5)`).";
3334 type = types.lines;
35 };
+1-1
nixos/modules/services/networking/ntopng.nix
···58 interfaces and displays its findings at http://localhost:''${toString
59 config.${opt.http-port}}. Default username and password is admin/admin.
6061- See the ntopng(8) manual page and http://www.ntop.org/products/ntop/
62 for more info.
6364 Note that enabling ntopng will also enable redis (key-value
···58 interfaces and displays its findings at http://localhost:''${toString
59 config.${opt.http-port}}. Default username and password is admin/admin.
6061+ See the {manpage}`ntopng(8)` manual page and http://www.ntop.org/products/ntop/
62 for more info.
6364 Note that enabling ntopng will also enable redis (key-value
+1-1
nixos/modules/services/networking/pppd.nix
···53 config = mkOption {
54 type = types.lines;
55 default = "";
56- description = "pppd configuration for this peer, see the pppd(8) man page.";
57 };
58 };
59 }
···53 config = mkOption {
54 type = types.lines;
55 default = "";
56+ description = "pppd configuration for this peer, see the {manpage}`pppd(8)` man page.";
57 };
58 };
59 }
+1-1
nixos/modules/services/networking/privoxy.nix
···114 the disk usage, since Privoxy itself never deletes the certificates.
115116 ::: {.note}
117- The format is that of the `tmpfiles.d(5)`
118 Age parameter.
119 :::
120 '';
···114 the disk usage, since Privoxy itself never deletes the certificates.
115116 ::: {.note}
117+ The format is that of the {manpage}`tmpfiles.d(5)`
118 Age parameter.
119 :::
120 '';
+1-1
nixos/modules/services/networking/r53-ddns.nix
···45 type = types.str;
46 description = ''
47 File containing the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
48- in the format of an EnvironmentFile as described by systemd.exec(5)
49 '';
50 };
51
···45 type = types.str;
46 description = ''
47 File containing the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
48+ in the format of an EnvironmentFile as described by {manpage}`systemd.exec(5)`
49 '';
50 };
51
···13 extraFlags = mkOption {
14 type = types.listOf types.str;
15 default = [];
16- description = ''Extra flags passed to the {command}`robustirc-bridge` command. See [RobustIRC Documentation](https://robustirc.net/docs/adminguide.html#_bridge) or robustirc-bridge(1) for details.'';
17 example = [
18 "-network robustirc.net"
19 ];
···13 extraFlags = mkOption {
14 type = types.listOf types.str;
15 default = [];
16+ description = ''Extra flags passed to the {command}`robustirc-bridge` command. See [RobustIRC Documentation](https://robustirc.net/docs/adminguide.html#_bridge) or {manpage}`robustirc-bridge(1)` for details.'';
17 example = [
18 "-network robustirc.net"
19 ];
+1-1
nixos/modules/services/networking/rpcbind.nix
···16 description = ''
17 Whether to enable `rpcbind`, an ONC RPC directory service
18 notably used by NFS and NIS, and which can be queried
19- using the rpcinfo(1) command. `rpcbind` is a replacement for
20 `portmap`.
21 '';
22 };
···16 description = ''
17 Whether to enable `rpcbind`, an ONC RPC directory service
18 notably used by NFS and NIS, and which can be queried
19+ using the {manpage}`rpcinfo(1)` command. `rpcbind` is a replacement for
20 `portmap`.
21 '';
22 };
+1-1
nixos/modules/services/networking/searx.nix
···56 type = types.nullOr types.path;
57 default = null;
58 description = ''
59- Environment file (see `systemd.exec(5)`
60 "EnvironmentFile=" section for the syntax) to define variables for
61 Searx. This option can be used to safely include secret keys into the
62 Searx configuration.
···56 type = types.nullOr types.path;
57 default = null;
58 description = ''
59+ Environment file (see {manpage}`systemd.exec(5)`
60 "EnvironmentFile=" section for the syntax) to define variables for
61 Searx. This option can be used to safely include secret keys into the
62 Searx configuration.
+1-1
nixos/modules/services/networking/spacecookie.nix
···53 description = ''
54 Address to listen on. Must be in the
55 `ListenStream=` syntax of
56- [systemd.socket(5)](https://www.freedesktop.org/software/systemd/man/systemd.socket.html).
57 '';
58 };
59
···53 description = ''
54 Address to listen on. Must be in the
55 `ListenStream=` syntax of
56+ {manpage}`systemd.socket(5)`.
57 '';
58 };
59
+2-2
nixos/modules/services/networking/ssh/sshd.nix
···357 type = lib.types.nullOr (lib.types.enum [ "QUIET" "FATAL" "ERROR" "INFO" "VERBOSE" "DEBUG" "DEBUG1" "DEBUG2" "DEBUG3" ]);
358 default = "INFO"; # upstream default
359 description = ''
360- Gives the verbosity level that is used when logging messages from sshd(8). Logging with a DEBUG level
361 violates the privacy of users and is not recommended.
362 '';
363 };
···369 # apply if cfg.useDns then "yes" else "no"
370 default = false;
371 description = ''
372- Specifies whether sshd(8) should look up the remote host name, and to check that the resolved host name for
373 the remote IP address maps back to the very same IP address.
374 If this option is set to no (the default) then only addresses and not host names may be used in
375 ~/.ssh/authorized_keys from and sshd_config Match Host directives.
···357 type = lib.types.nullOr (lib.types.enum [ "QUIET" "FATAL" "ERROR" "INFO" "VERBOSE" "DEBUG" "DEBUG1" "DEBUG2" "DEBUG3" ]);
358 default = "INFO"; # upstream default
359 description = ''
360+ Gives the verbosity level that is used when logging messages from {manpage}`sshd(8)`. Logging with a DEBUG level
361 violates the privacy of users and is not recommended.
362 '';
363 };
···369 # apply if cfg.useDns then "yes" else "no"
370 default = false;
371 description = ''
372+ Specifies whether {manpage}`sshd(8)` should look up the remote host name, and to check that the resolved host name for
373 the remote IP address maps back to the very same IP address.
374 If this option is set to no (the default) then only addresses and not host names may be used in
375 ~/.ssh/authorized_keys from and sshd_config Match Host directives.
+1-1
nixos/modules/services/networking/tinydns.nix
···16 data = mkOption {
17 type = types.lines;
18 default = "";
19- description = "The DNS data to serve, in the format described by tinydns-data(8)";
20 };
2122 ip = mkOption {
···16 data = mkOption {
17 type = types.lines;
18 default = "";
19+ description = "The DNS data to serve, in the format described by {manpage}`tinydns-data(8)`";
20 };
2122 ip = mkOption {
+3-3
nixos/modules/services/security/clamav.nix
···53 type = lib.types.str;
54 default = "hourly";
55 description = ''
56- How often freshclam is invoked. See systemd.time(7) for more
57 information about the format.
58 '';
59 };
···74 type = lib.types.str;
75 default = "hourly";
76 description = ''
77- How often freshclam is invoked. See systemd.time(7) for more
78 information about the format.
79 '';
80 };
···105 type = lib.types.str;
106 default = "*-*-* 04:00:00";
107 description = ''
108- How often clamdscan is invoked. See systemd.time(7) for more
109 information about the format.
110 By default this runs using 10 cores at most, be sure to run it at a time of low traffic.
111 '';
···53 type = lib.types.str;
54 default = "hourly";
55 description = ''
56+ How often freshclam is invoked. See {manpage}`systemd.time(7)` for more
57 information about the format.
58 '';
59 };
···74 type = lib.types.str;
75 default = "hourly";
76 description = ''
77+ How often freshclam is invoked. See {manpage}`systemd.time(7)` for more
78 information about the format.
79 '';
80 };
···105 type = lib.types.str;
106 default = "*-*-* 04:00:00";
107 description = ''
108+ How often clamdscan is invoked. See {manpage}`systemd.time(7)` for more
109 information about the format.
110 By default this runs using 10 cores at most, be sure to run it at a time of low traffic.
111 '';
+1-1
nixos/modules/services/torrent/transmission.nix
···181 defaultText = literalExpression "if cfg.package == pkgs.transmission_3 then 18 else \"022\"";
182 description = ''
183 Sets transmission's file mode creation mask.
184- See the umask(2) manpage for more information.
185 Users who want their saved torrents to be world-writable
186 may want to set this value to 0/`"000"`.
187
···181 defaultText = literalExpression "if cfg.package == pkgs.transmission_3 then 18 else \"022\"";
182 description = ''
183 Sets transmission's file mode creation mask.
184+ See the {manpage}`umask(2)` manpage for more information.
185 Users who want their saved torrents to be world-writable
186 may want to set this value to 0/`"000"`.
187
+8-8
nixos/modules/services/web-apps/cloudlog.nix
···173 type = str;
174 default = "daily";
175 description = ''
176- Specification (in the format described by systemd.time(7)) of the
177 time at which the LoTW upload will occur.
178 '';
179 };
···191 type = str;
192 default = "daily";
193 description = ''
194- Specification (in the format described by systemd.time(7)) of the time
195 at which the Clublog upload will occur.
196 '';
197 };
···210 type = str;
211 default = "weekly";
212 description = ''
213- Specification (in the format described by systemd.time(7)) of the
214 time at which the LoTW user update will occur.
215 '';
216 };
···228 type = str;
229 default = "monthly";
230 description = ''
231- Specification (in the format described by systemd.time(7)) of the
232 time at which the DOK update will occur.
233 '';
234 };
···247 type = str;
248 default = "monthly";
249 description = ''
250- Specification (in the format described by systemd.time(7)) of the time
251 at which the Clublog SCP update will occur.
252 '';
253 };
···266 type = str;
267 default = "monthly";
268 description = ''
269- Specification (in the format described by systemd.time(7)) of the time
270 at which the WWFF update will occur.
271 '';
272 };
···284 type = str;
285 default = "daily";
286 description = ''
287- Specification (in the format described by systemd.time(7)) of the
288 time at which the QRZ upload will occur.
289 '';
290 };
···302 type = str;
303 default = "monthly";
304 description = ''
305- Specification (in the format described by systemd.time(7)) of the time
306 at which the SOTA update will occur.
307 '';
308 };
···173 type = str;
174 default = "daily";
175 description = ''
176+ Specification (in the format described by {manpage}`systemd.time(7)`) of the
177 time at which the LoTW upload will occur.
178 '';
179 };
···191 type = str;
192 default = "daily";
193 description = ''
194+ Specification (in the format described by {manpage}`systemd.time(7)`) of the time
195 at which the Clublog upload will occur.
196 '';
197 };
···210 type = str;
211 default = "weekly";
212 description = ''
213+ Specification (in the format described by {manpage}`systemd.time(7)`) of the
214 time at which the LoTW user update will occur.
215 '';
216 };
···228 type = str;
229 default = "monthly";
230 description = ''
231+ Specification (in the format described by {manpage}`systemd.time(7)`) of the
232 time at which the DOK update will occur.
233 '';
234 };
···247 type = str;
248 default = "monthly";
249 description = ''
250+ Specification (in the format described by {manpage}`systemd.time(7)`) of the time
251 at which the Clublog SCP update will occur.
252 '';
253 };
···266 type = str;
267 default = "monthly";
268 description = ''
269+ Specification (in the format described by {manpage}`systemd.time(7)`) of the time
270 at which the WWFF update will occur.
271 '';
272 };
···284 type = str;
285 default = "daily";
286 description = ''
287+ Specification (in the format described by {manpage}`systemd.time(7)`) of the
288 time at which the QRZ upload will occur.
289 '';
290 };
···302 type = str;
303 default = "monthly";
304 description = ''
305+ Specification (in the format described by {manpage}`systemd.time(7)`) of the time
306 at which the SOTA update will occur.
307 '';
308 };
+1-1
nixos/modules/services/web-apps/dex.nix
···51 type = types.nullOr types.path;
52 default = null;
53 description = ''
54- Environment file (see `systemd.exec(5)`
55 "EnvironmentFile=" section for the syntax) to define variables for dex.
56 This option can be used to safely include secret keys into the dex configuration.
57 '';
···51 type = types.nullOr types.path;
52 default = null;
53 description = ''
54+ Environment file (see {manpage}`systemd.exec(5)`
55 "EnvironmentFile=" section for the syntax) to define variables for dex.
56 This option can be used to safely include secret keys into the dex configuration.
57 '';
+1-1
nixos/modules/services/web-apps/gotosocial.nix
···80 type = lib.types.nullOr lib.types.path;
81 description = ''
82 File path containing environment variables for configuring the GoToSocial service
83- in the format of an EnvironmentFile as described by systemd.exec(5).
8485 This option could be used to pass sensitive configuration to the GoToSocial daemon.
86
···80 type = lib.types.nullOr lib.types.path;
81 description = ''
82 File path containing environment variables for configuring the GoToSocial service
83+ in the format of an EnvironmentFile as described by {manpage}`systemd.exec(5)`.
8485 This option could be used to pass sensitive configuration to the GoToSocial daemon.
86
+1-1
nixos/modules/services/web-apps/miniflux.nix
···72 description = ''
73 File containing the ADMIN_USERNAME and
74 ADMIN_PASSWORD (length >= 6) in the format of
75- an EnvironmentFile=, as described by systemd.exec(5).
76 '';
77 example = "/etc/nixos/miniflux-admin-credentials";
78 };
···72 description = ''
73 File containing the ADMIN_USERNAME and
74 ADMIN_PASSWORD (length >= 6) in the format of
75+ an EnvironmentFile=, as described by {manpage}`systemd.exec(5)`.
76 '';
77 example = "/etc/nixos/miniflux-admin-credentials";
78 };
···30 inherit (format) type;
31 default = { };
32 description = ''
33- Merecat configuration. Refer to merecat(8) for details on supported values.
34 '';
35 example = {
36 hostname = "localhost";
···30 inherit (format) type;
31 default = { };
32 description = ''
33+ Merecat configuration. Refer to {manpage}`merecat(8)` for details on supported values.
34 '';
35 example = {
36 hostname = "localhost";
+1-1
nixos/modules/services/web-servers/minio.nix
···72 description = ''
73 File containing the MINIO_ROOT_USER, default is "minioadmin", and
74 MINIO_ROOT_PASSWORD (length >= 8), default is "minioadmin"; in the format of
75- an EnvironmentFile=, as described by systemd.exec(5).
76 '';
77 example = "/etc/nixos/minio-root-credentials";
78 };
···72 description = ''
73 File containing the MINIO_ROOT_USER, default is "minioadmin", and
74 MINIO_ROOT_PASSWORD (length >= 8), default is "minioadmin"; in the format of
75+ an EnvironmentFile=, as described by {manpage}`systemd.exec(5)`.
76 '';
77 example = "/etc/nixos/minio-root-credentials";
78 };
+1-1
nixos/modules/services/web-servers/pomerium.nix
···50 default = null;
51 description = ''
52 Path to file containing secrets for Pomerium, in systemd
53- EnvironmentFile format. See the systemd.exec(5) man page.
54 '';
55 };
56 };
···50 default = null;
51 description = ''
52 Path to file containing secrets for Pomerium, in systemd
53+ EnvironmentFile format. See the {manpage}`systemd.exec(5)` man page.
54 '';
55 };
56 };
+1-1
nixos/modules/services/web-servers/uwsgi.nix
···200 '';
201 description = ''
202 Grant capabilities to the uWSGI instance. See the
203- `capabilities(7)` for available values.
204205 ::: {.note}
206 uWSGI runs as an unprivileged user (even as Emperor) with the minimal
···200 '';
201 description = ''
202 Grant capabilities to the uWSGI instance. See the
203+ {manpage}`capabilities(7)` for available values.
204205 ::: {.note}
206 uWSGI runs as an unprivileged user (even as Emperor) with the minimal
···27 which allows users to start X manually via the "startx" command
28 from a vt shell. The X server runs under the user's id, not as root.
29 The user must provide a ~/.xinitrc file containing session startup
30- commands, see startx(1). This is not automatically generated
31 from the desktopManager and windowManager settings.
32 '';
33 };
···27 which allows users to start X manually via the "startx" command
28 from a vt shell. The X server runs under the user's id, not as root.
29 The user must provide a ~/.xinitrc file containing session startup
30+ commands, see {manpage}`startx(1)`. This is not automatically generated
31 from the desktopManager and windowManager settings.
32 '';
33 };
···18 to start manually via the "sx" command from a vt shell. The X server
19 runs under the user's id, not as root. The user must provide a
20 ~/.config/sx/sxrc file containing session startup commands, see
21- sx(1). This is not automatically generated from the desktopManager
22 and windowManager settings. sx doesn't have a way to directly set
23 X server flags, but it can be done by overriding its xorgserver
24 dependency.
···18 to start manually via the "sx" command from a vt shell. The X server
19 runs under the user's id, not as root. The user must provide a
20 ~/.config/sx/sxrc file containing session startup commands, see
21+ {manpage}`sx(1)`. This is not automatically generated from the desktopManager
22 and windowManager settings. sx doesn't have a way to directly set
23 X server flags, but it can be done by overriding its xorgserver
24 dependency.
+3-3
nixos/modules/services/x11/picom.nix
···126 ];
127 description = ''
128 List of conditions of windows that should not be faded.
129- See `picom(1)` man page for more examples.
130 '';
131 };
132···172 ];
173 description = ''
174 List of conditions of windows that should have no shadow.
175- See `picom(1)` man page for more examples.
176 '';
177 };
178···326 description = ''
327 Picom settings. Use this option to configure Picom settings not exposed
328 in a NixOS option or to bypass one. For the available options see the
329- CONFIGURATION FILES section at `picom(1)`.
330 '';
331 };
332 };
···126 ];
127 description = ''
128 List of conditions of windows that should not be faded.
129+ See {manpage}`picom(1)` man page for more examples.
130 '';
131 };
132···172 ];
173 description = ''
174 List of conditions of windows that should have no shadow.
175+ See {manpage}`picom(1)` man page for more examples.
176 '';
177 };
178···326 description = ''
327 Picom settings. Use this option to configure Picom settings not exposed
328 in a NixOS option or to bypass one. For the available options see the
329+ CONFIGURATION FILES section at {manpage}`picom(1)`.
330 '';
331 };
332 };
···203 type = types.nullOr types.path;
204 visible = false;
205 description = ''
206- The env(1) executable that is linked system-wide to
207 `/usr/bin/env`.
208 '';
209 };
···203 type = types.nullOr types.path;
204 visible = false;
205 description = ''
206+ The {manpage}`env(1)` executable that is linked system-wide to
207 `/usr/bin/env`.
208 '';
209 };
+1-1
nixos/modules/system/boot/systemd/coredump.nix
···29 type = types.lines;
30 example = "Storage=journal";
31 description = ''
32- Extra config options for systemd-coredump. See coredump.conf(5) man page
33 for available options.
34 '';
35 };
···29 type = types.lines;
30 example = "Storage=journal";
31 description = ''
32+ Extra config options for systemd-coredump. See {manpage}`coredump.conf(5)` man page
33 for available options.
34 '';
35 };
+1-1
nixos/modules/system/boot/systemd/initrd.nix
···163 type = types.lines;
164 example = "DefaultLimitCORE=infinity";
165 description = ''
166- Extra config options for systemd. See systemd-system.conf(5) man page
167 for available options.
168 '';
169 };
···163 type = types.lines;
164 example = "DefaultLimitCORE=infinity";
165 description = ''
166+ Extra config options for systemd. See {manpage}`systemd-system.conf(5)` man page
167 for available options.
168 '';
169 };
+1-1
nixos/modules/system/boot/systemd/logind.nix
···29 example = "IdleAction=lock";
30 description = ''
31 Extra config options for systemd-logind.
32- See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html)
33 for available options.
34 '';
35 };
···29 example = "IdleAction=lock";
30 description = ''
31 Extra config options for systemd-logind.
32+ See {manpage}`logind.conf(5)`
33 for available options.
34 '';
35 };
+2-2
nixos/modules/system/boot/timesyncd.nix
···28 `timesyncd.conf` file as opposed to setting this option to null which
29 will remove `NTP=` entirely.
3031- See man:timesyncd.conf(5) for details.
32 '';
33 };
34 fallbackServers = mkOption {
···42 `timesyncd.conf` file as opposed to setting this option to null which
43 will remove `FallbackNTP=` entirely.
4445- See man:timesyncd.conf(5) for details.
46 '';
47 };
48 extraConfig = mkOption {
···28 `timesyncd.conf` file as opposed to setting this option to null which
29 will remove `NTP=` entirely.
3031+ See {manpage}`timesyncd.conf(5)` for details.
32 '';
33 };
34 fallbackServers = mkOption {
···42 `timesyncd.conf` file as opposed to setting this option to null which
43 will remove `FallbackNTP=` entirely.
4445+ See {manpage}`timesyncd.conf(5)` for details.
46 '';
47 };
48 extraConfig = mkOption {
+1-1
nixos/modules/tasks/filesystems/nfs.nix
···99 default = { };
100 description = ''
101 General configuration for NFS daemons and tools.
102- See nfs.conf(5) and related man pages for details.
103 '';
104 example = lib.literalExpression ''
105 {
···99 default = { };
100 description = ''
101 General configuration for NFS daemons and tools.
102+ See {manpage}`nfs.conf(5)` and related man pages for details.
103 '';
104 example = lib.literalExpression ''
105 {
+2-2
nixos/modules/tasks/network-interfaces.nix
···97 default = null;
98 description = ''
99 Type of the route. See the `Route types` section
100- in the `ip-route(8)` manual page for the details.
101102 Note that `prohibit`, `blackhole`,
103 `unreachable`, and `throw` cannot
···118 example = { mtu = "1492"; window = "524288"; };
119 description = ''
120 Other route options. See the symbol `OPTIONS`
121- in the `ip-route(8)` manual page for the details.
122 You may also specify `metric`,
123 `src`, `protocol`,
124 `scope`, `from`
···97 default = null;
98 description = ''
99 Type of the route. See the `Route types` section
100+ in the {manpage}`ip-route(8)` manual page for the details.
101102 Note that `prohibit`, `blackhole`,
103 `unreachable`, and `throw` cannot
···118 example = { mtu = "1492"; window = "524288"; };
119 description = ''
120 Other route options. See the symbol `OPTIONS`
121+ in the {manpage}`ip-route(8)` manual page for the details.
122 You may also specify `metric`,
123 `src`, `protocol`,
124 `scope`, `from`
+1-1
nixos/modules/virtualisation/docker.nix
···34 default = ["/run/docker.sock"];
35 description = ''
36 A list of unix and tcp docker should listen to. The format follows
37- ListenStream as described in systemd.socket(5).
38 '';
39 };
40
···34 default = ["/run/docker.sock"];
35 description = ''
36 A list of unix and tcp docker should listen to. The format follows
37+ ListenStream as described in {manpage}`systemd.socket(5)`.
38 '';
39 };
40
+5-5
nixos/modules/virtualisation/nixos-containers.nix
···349 Device node access modifier. Takes a combination
350 `r` (read), `w` (write), and
351 `m` (mknod). See the
352- `systemd.resource-control(5)` man page for more
353 information.'';
354 };
355 };
···563 example = [ "CAP_NET_ADMIN" "CAP_MKNOD" ];
564 description = ''
565 Grant additional capabilities to the container. See the
566- capabilities(7) and systemd-nspawn(1) man pages for more
567 information.
568 '';
569 };
···644 shall run in. The specified path should refer to a (possibly bind-mounted) network
645 namespace file, as exposed by the kernel below /proc/<PID>/ns/net. This makes the
646 container enter the given network namespace. One of the typical use cases is to give
647- a network namespace under /run/netns created by ip-netns(8).
648 Note that this option cannot be used together with other network-related options,
649 such as --private-network or --network-interface=.
650 '';
···737 Mounts a set of tmpfs file systems into the container.
738 Multiple paths can be specified.
739 Valid items must conform to the --tmpfs argument
740- of systemd-nspawn. See systemd-nspawn(1) for details.
741 '';
742 };
743···747 example = [ "--drop-capability=CAP_SYS_CHROOT" ];
748 description = ''
749 Extra flags passed to the systemd-nspawn command.
750- See systemd-nspawn(1) for details.
751 '';
752 };
753
···349 Device node access modifier. Takes a combination
350 `r` (read), `w` (write), and
351 `m` (mknod). See the
352+ {manpage}`systemd.resource-control(5)` man page for more
353 information.'';
354 };
355 };
···563 example = [ "CAP_NET_ADMIN" "CAP_MKNOD" ];
564 description = ''
565 Grant additional capabilities to the container. See the
566+ {manpage}`capabilities(7)` and {manpage}`systemd-nspawn(1)` man pages for more
567 information.
568 '';
569 };
···644 shall run in. The specified path should refer to a (possibly bind-mounted) network
645 namespace file, as exposed by the kernel below /proc/<PID>/ns/net. This makes the
646 container enter the given network namespace. One of the typical use cases is to give
647+ a network namespace under /run/netns created by {manpage}`ip-netns(8)`.
648 Note that this option cannot be used together with other network-related options,
649 such as --private-network or --network-interface=.
650 '';
···737 Mounts a set of tmpfs file systems into the container.
738 Multiple paths can be specified.
739 Valid items must conform to the --tmpfs argument
740+ of systemd-nspawn. See {manpage}`systemd-nspawn(1)` for details.
741 '';
742 };
743···747 example = [ "--drop-capability=CAP_SYS_CHROOT" ];
748 description = ''
749 Extra flags passed to the systemd-nspawn command.
750+ See {manpage}`systemd-nspawn(1)` for details.
751 '';
752 };
753
+1-1
nixos/modules/virtualisation/oci-containers.nix
···155 [Docker engine documentation](https://docs.docker.com/engine/logging/configure/)
156157 For Podman:
158- Refer to the docker-run(1) man page.
159 '';
160 };
161
···155 [Docker engine documentation](https://docs.docker.com/engine/logging/configure/)
156157 For Podman:
158+ Refer to the {manpage}`docker-run(1)` man page.
159 '';
160 };
161
+1-1
nixos/modules/virtualisation/waagent.nix
···151 ];
152 description = ''
153 This option specifies disk mount options to be passed to the `mount -o` command.
154- For more information, see the `mount(8)` manual page.
155 '';
156 };
157
···151 ];
152 description = ''
153 This option specifies disk mount options to be passed to the `mount -o` command.
154+ For more information, see the {manpage}`mount(8)` manual page.
155 '';
156 };
157
···78buildNpmPackage rec {
9 pname = "asf-ui";
10- version = "c316254ddaf7837e7d43145268b53f91f23027dc";
1112 src = fetchFromGitHub {
13 owner = "JustArchiNET";
···15 # updated by the update script
16 # this is always the commit that should be used with asf-ui from the latest asf version
17 rev = version;
18- hash = "sha256-teM8x1/O5QFO7bMGc474Dp9ssOLfdmYkDt7PIuvJ4Ss=";
19 };
2021- npmDepsHash = "sha256-8KqIUSWaeu5Tk8lw8F1O6KkXUfNqvjgxRNCePEMeLDo=";
2223 installPhase = ''
24 runHook preInstall
···78buildNpmPackage rec {
9 pname = "asf-ui";
10+ version = "6be24065cd4904389d94140f4ed1f6738b1f7fbb";
1112 src = fetchFromGitHub {
13 owner = "JustArchiNET";
···15 # updated by the update script
16 # this is always the commit that should be used with asf-ui from the latest asf version
17 rev = version;
18+ hash = "sha256-DFl+DCNj4JFKZG1awX5rlsHzj+67OFyBj9d16zDiKRA=";
19 };
2021+ npmDepsHash = "sha256-jZSiWZDckfGfgrBMHTX/sm7Pcl5ap3lfmwGi8SHXqu8=";
2223 installPhase = ''
24 runHook preInstall
···15 version = "1.3.2";
1617 configureFlags = [
18+ # This is to add "#include" directives for stdlib.h, stdio.h and string.h.
19+ "ac_cv_header_stdc=yes"
20+21 "--with-checksum=${checksumType}"
22 ];
23
···3435 # Kernel dependencies
36 kernel ? null,
037 enablePython ? true,
38 ...
39 }@outerArgs:
···191 "--with-linux=${kernel.dev}/lib/modules/${kernel.modDirVersion}/source"
192 "--with-linux-obj=${kernel.dev}/lib/modules/${kernel.modDirVersion}/build"
193 ]
194- ++ kernel.moduleMakeFlags
195 );
196197- makeFlags = optionals buildKernel kernel.moduleMakeFlags;
198199 enableParallelBuilding = true;
200···264 outputs = [ "out" ] ++ optionals buildUser [ "dev" ];
265266 passthru = {
0267 inherit enableMail kernelModuleAttribute;
268 latestCompatibleLinuxPackages = lib.warn "zfs.latestCompatibleLinuxPackages is deprecated and is now pointing at the default kernel. If using the stable LTS kernel (default `linuxPackages` is not possible then you must explicitly pin a specific kernel release. For example, `boot.kernelPackages = pkgs.linuxPackages_6_6`. Please be aware that non-LTS kernels are likely to go EOL before ZFS supports the latest supported non-LTS release, requiring manual intervention." linuxPackages;
269
···3435 # Kernel dependencies
36 kernel ? null,
37+ kernelModuleMakeFlags ? [ ],
38 enablePython ? true,
39 ...
40 }@outerArgs:
···192 "--with-linux=${kernel.dev}/lib/modules/${kernel.modDirVersion}/source"
193 "--with-linux-obj=${kernel.dev}/lib/modules/${kernel.modDirVersion}/build"
194 ]
195+ ++ kernelModuleMakeFlags
196 );
197198+ makeFlags = optionals buildKernel kernelModuleMakeFlags;
199200 enableParallelBuilding = true;
201···265 outputs = [ "out" ] ++ optionals buildUser [ "dev" ];
266267 passthru = {
268+ inherit kernel;
269 inherit enableMail kernelModuleAttribute;
270 latestCompatibleLinuxPackages = lib.warn "zfs.latestCompatibleLinuxPackages is deprecated and is now pointing at the default kernel. If using the stable LTS kernel (default `linuxPackages` is not possible then you must explicitly pin a specific kernel release. For example, `boot.kernelPackages = pkgs.linuxPackages_6_6`. Please be aware that non-LTS kernels are likely to go EOL before ZFS supports the latest supported non-LTS release, requiring manual intervention." linuxPackages;
271