···871871# adds `FOOBAR=baz` to `$out/bin/foo`’s environment
872872makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz
873873874874-# prefixes the binary paths of `hello` and `git`
874874+# Prefixes the binary paths of `hello` and `git`
875875+# and suffixes the binary path of `xdg-utils`.
875876# Be advised that paths often should be patched in directly
876877# (via string replacements or in `configurePhase`).
877877-makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello git ]}
878878+makeWrapper $out/bin/foo $wrapperfile \
879879+ --prefix PATH : ${lib.makeBinPath [ hello git ]} \
880880+ --suffix PATH : ${lib.makeBinPath [ xdg-utils ]}
878881```
882882+883883+Packages may expect or require other utilities to be available at runtime.
884884+`makeWrapper` can be used to add packages to a `PATH` environment variable local to a wrapper.
885885+886886+Use `--prefix` to explicitly set dependencies in `PATH`.
887887+888888+:::{note}
889889+`--prefix` essentially hard-codes dependencies into the wrapper.
890890+They cannot be overridden without rebuilding the package.
891891+:::
892892+893893+If dependencies should be resolved at runtime, use `--suffix` to append fallback values to `PATH`.
879894880895There’s many more kinds of arguments, they are documented in `nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh` for the `makeWrapper` implementation and in `nixpkgs/pkgs/build-support/setup-hooks/make-binary-wrapper/make-binary-wrapper.sh` for the `makeBinaryWrapper` implementation.
881896
+5-5
nixos/modules/config/krb5/default.nix
···204204 admin_server = SYSLOG:NOTICE
205205 default = SYSLOG:NOTICE
206206 '';
207207- description = ''
208208- These lines go to the end of <literal>krb5.conf</literal> verbatim.
209209- <literal>krb5.conf</literal> may include any of the relations that are
210210- valid for <literal>kdc.conf</literal> (see <literal>man
211211- kdc.conf</literal>), but it is not a recommended practice.
207207+ description = lib.mdDoc ''
208208+ These lines go to the end of `krb5.conf` verbatim.
209209+ `krb5.conf` may include any of the relations that are
210210+ valid for `kdc.conf` (see `man kdc.conf`),
211211+ but it is not a recommended practice.
212212 '';
213213 };
214214
+5-5
nixos/modules/config/ldap.nix
···186186 policy = mkOption {
187187 default = "hard_open";
188188 type = types.enum [ "hard_open" "hard_init" "soft" ];
189189- description = ''
189189+ description = lib.mdDoc ''
190190 Specifies the policy to use for reconnecting to an unavailable
191191- LDAP server. The default is <literal>hard_open</literal>, which
191191+ LDAP server. The default is `hard_open`, which
192192 reconnects if opening the connection to the directory server
193193- failed. By contrast, <literal>hard_init</literal> reconnects if
193193+ failed. By contrast, `hard_init` reconnects if
194194 initializing the connection failed. Initializing may not
195195 actually contact the directory server, and it is possible that
196196 a malformed configuration file will trigger reconnection. If
197197- <literal>soft</literal> is specified, then
198198- <package>nss_ldap</package> will return immediately on server
197197+ `soft` is specified, then
198198+ `nss_ldap` will return immediately on server
199199 failure. All hard reconnect policies block with exponential
200200 backoff before retrying.
201201 '';
+5-5
nixos/modules/config/system-path.nix
···8484 <programlisting>${defaultPackagesText}</programlisting>
8585 '';
8686 example = [];
8787- description = ''
8787+ description = lib.mdDoc ''
8888 Set of default packages that aren't strictly necessary
8989 for a running system, entries can be removed for a more
9090 minimal NixOS installation.
91919292- Note: If <package>pkgs.nano</package> is removed from this list,
9292+ Note: If `pkgs.nano` is removed from this list,
9393 make sure another editor is installed and the
9494- <literal>EDITOR</literal> environment variable is set to it.
9494+ `EDITOR` environment variable is set to it.
9595 Environment variables can be set using
9696- <option>environment.variables</option>.
9696+ {option}`environment.variables`.
97979898 Like with systemPackages, packages are installed to
9999- <filename>/run/current-system/sw</filename>. They are
9999+ {file}`/run/current-system/sw`. They are
100100 automatically available to all users, and are
101101 automatically updated every time you rebuild the system
102102 configuration.
+3-3
nixos/modules/config/xdg/portal.nix
···4040 extraPortals = mkOption {
4141 type = types.listOf types.package;
4242 default = [ ];
4343- description = ''
4343+ description = lib.mdDoc ''
4444 List of additional portals to add to path. Portals allow interaction
4545 with system, like choosing files or taking screenshots. At minimum,
4646 a desktop portal implementation should be listed. GNOME and KDE already
4747- adds <package>xdg-desktop-portal-gtk</package>; and
4848- <package>xdg-desktop-portal-kde</package> respectively. On other desktop
4747+ adds `xdg-desktop-portal-gtk`; and
4848+ `xdg-desktop-portal-kde` respectively. On other desktop
4949 environments you probably want to add them yourself.
5050 '';
5151 };
+3-3
nixos/modules/config/xdg/portals/lxqt.nix
···1515 enable = mkEnableOption ''
1616 the desktop portal for the LXQt desktop environment.
17171818- This will add the <package>lxqt.xdg-desktop-portal-lxqt</package>
1818+ This will add the <literal>lxqt.xdg-desktop-portal-lxqt</literal>
1919 package (with the extra Qt styles) into the
2020 <option>xdg.portal.extraPortals</option> option
2121 '';
···2929 pkgs.qtcurve
3030 ];
3131 '';
3232- description = ''
3232+ description = lib.mdDoc ''
3333 Extra Qt styles that will be available to the
3434- <package>lxqt.xdg-desktop-portal-lxqt</package>.
3434+ `lxqt.xdg-desktop-portal-lxqt`.
3535 '';
3636 };
3737 };
+4-4
nixos/modules/config/xdg/portals/wlr.nix
···1717 enable = mkEnableOption ''
1818 desktop portal for wlroots-based desktops
19192020- This will add the <package>xdg-desktop-portal-wlr</package> package into
2020+ This will add the <literal>xdg-desktop-portal-wlr</literal> package into
2121 the <option>xdg.portal.extraPortals</option> option, and provide the
2222 configuration file
2323 '';
24242525 settings = mkOption {
2626- description = ''
2727- Configuration for <package>xdg-desktop-portal-wlr</package>.
2626+ description = lib.mdDoc ''
2727+ Configuration for `xdg-desktop-portal-wlr`.
28282929- See <literal>xdg-desktop-portal-wlr(5)</literal> for supported
2929+ See `xdg-desktop-portal-wlr(5)` for supported
3030 values.
3131 '';
3232
+5-5
nixos/modules/config/zram.nix
···103103 default = "zstd";
104104 example = "lz4";
105105 type = with types; either (enum [ "lzo" "lz4" "zstd" ]) str;
106106- description = ''
107107- Compression algorithm. <literal>lzo</literal> has good compression,
108108- but is slow. <literal>lz4</literal> has bad compression, but is fast.
109109- <literal>zstd</literal> is both good compression and fast, but requires newer kernel.
106106+ description = lib.mdDoc ''
107107+ Compression algorithm. `lzo` has good compression,
108108+ but is slow. `lz4` has bad compression, but is fast.
109109+ `zstd` is both good compression and fast, but requires newer kernel.
110110 You can check what other algorithms are supported by your zram device with
111111- <programlisting>cat /sys/class/block/zram*/comp_algorithm</programlisting>
111111+ {command}`cat /sys/class/block/zram*/comp_algorithm`
112112 '';
113113 };
114114 };
+1-1
nixos/modules/hardware/corectrl.nix
···2020 type = types.str;
2121 default = "0xfffd7fff";
2222 example = "0xffffffff";
2323- description = ''
2323+ description = lib.mdDoc ''
2424 Sets the `amdgpu.ppfeaturemask` kernel option.
2525 In particular, it is used here to set the overdrive bit.
2626 Default is `0xfffd7fff` as it is less likely to cause flicker issues.
+3-3
nixos/modules/hardware/cpu/amd-sev.nix
···88 options.hardware.cpu.amd.sev = {
99 enable = mkEnableOption "access to the AMD SEV device";
1010 user = mkOption {
1111- description = "Owner to assign to the SEV device.";
1111+ description = lib.mdDoc "Owner to assign to the SEV device.";
1212 type = types.str;
1313 default = "root";
1414 };
1515 group = mkOption {
1616- description = "Group to assign to the SEV device.";
1616+ description = lib.mdDoc "Group to assign to the SEV device.";
1717 type = types.str;
1818 default = defaultGroup;
1919 };
2020 mode = mkOption {
2121- description = "Mode to set for the SEV device.";
2121+ description = lib.mdDoc "Mode to set for the SEV device.";
2222 type = types.str;
2323 default = "0660";
2424 };
+13-13
nixos/modules/installer/sd-card/sd-image.nix
···3535 options.sdImage = {
3636 imageName = mkOption {
3737 default = "${config.sdImage.imageBaseName}-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.img";
3838- description = ''
3838+ description = lib.mdDoc ''
3939 Name of the generated image file.
4040 '';
4141 };
42424343 imageBaseName = mkOption {
4444 default = "nixos-sd-image";
4545- description = ''
4545+ description = lib.mdDoc ''
4646 Prefix of the name of the generated image file.
4747 '';
4848 };
···5050 storePaths = mkOption {
5151 type = with types; listOf package;
5252 example = literalExpression "[ pkgs.stdenv ]";
5353- description = ''
5353+ description = lib.mdDoc ''
5454 Derivations to be included in the Nix store in the generated SD image.
5555 '';
5656 };
···7474 firmwarePartitionID = mkOption {
7575 type = types.str;
7676 default = "0x2178694e";
7777- description = ''
7777+ description = lib.mdDoc ''
7878 Volume ID for the /boot/firmware partition on the SD card. This value
7979 must be a 32-bit hexadecimal number.
8080 '';
···8383 firmwarePartitionName = mkOption {
8484 type = types.str;
8585 default = "FIRMWARE";
8686- description = ''
8686+ description = lib.mdDoc ''
8787 Name of the filesystem which holds the boot firmware.
8888 '';
8989 };
···9292 type = types.nullOr types.str;
9393 default = null;
9494 example = "14e19a7b-0ae0-484d-9d54-43bd6fdc20c7";
9595- description = ''
9595+ description = lib.mdDoc ''
9696 UUID for the filesystem on the main NixOS partition on the SD card.
9797 '';
9898 };
···101101 type = types.int;
102102 # As of 2019-08-18 the Raspberry pi firmware + u-boot takes ~18MiB
103103 default = 30;
104104- description = ''
104104+ description = lib.mdDoc ''
105105 Size of the /boot/firmware partition, in megabytes.
106106 '';
107107 };
108108109109 populateFirmwareCommands = mkOption {
110110 example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''";
111111- description = ''
111111+ description = lib.mdDoc ''
112112 Shell commands to populate the ./firmware directory.
113113 All files in that directory are copied to the
114114 /boot/firmware partition on the SD image.
···117117118118 populateRootCommands = mkOption {
119119 example = literalExpression "''\${config.boot.loader.generic-extlinux-compatible.populateCmd} -c \${config.system.build.toplevel} -d ./files/boot''";
120120- description = ''
120120+ description = lib.mdDoc ''
121121 Shell commands to populate the ./files directory.
122122 All files in that directory are copied to the
123123 root (/) partition on the SD image. Use this to
···128128 postBuildCommands = mkOption {
129129 example = literalExpression "'' dd if=\${pkgs.myBootLoader}/SPL of=$img bs=1024 seek=1 conv=notrunc ''";
130130 default = "";
131131- description = ''
131131+ description = lib.mdDoc ''
132132 Shell commands to run after the image is built.
133133 Can be used for boards requiring to dd u-boot SPL before actual partitions.
134134 '';
···137137 compressImage = mkOption {
138138 type = types.bool;
139139 default = true;
140140- description = ''
140140+ description = lib.mdDoc ''
141141 Whether the SD image should be compressed using
142142- <command>zstd</command>.
142142+ {command}`zstd`.
143143 '';
144144 };
145145146146 expandOnBoot = mkOption {
147147 type = types.bool;
148148 default = true;
149149- description = ''
149149+ description = lib.mdDoc ''
150150 Whether to configure the sd image to expand it's partition on boot.
151151 '';
152152 };
+1-1
nixos/modules/misc/documentation.nix
···241241 nixos.extraModules = mkOption {
242242 type = types.listOf types.raw;
243243 default = [];
244244- description = ''
244244+ description = lib.mdDoc ''
245245 Modules for which to show options even when not imported.
246246 '';
247247 };
+10-10
nixos/modules/misc/nixpkgs.nix
···117117 '';
118118 type = pkgsType;
119119 example = literalExpression "import <nixpkgs> {}";
120120- description = ''
120120+ description = lib.mdDoc ''
121121 If set, the pkgs argument to all NixOS modules is the value of
122122- this option, extended with <literal>nixpkgs.overlays</literal>, if
123123- that is also set. Either <literal>nixpkgs.crossSystem</literal> or
124124- <literal>nixpkgs.localSystem</literal> will be used in an assertion
122122+ this option, extended with `nixpkgs.overlays`, if
123123+ that is also set. Either `nixpkgs.crossSystem` or
124124+ `nixpkgs.localSystem` will be used in an assertion
125125 to check that the NixOS and Nixpkgs architectures match. Any
126126- other options in <literal>nixpkgs.*</literal>, notably <literal>config</literal>,
126126+ other options in `nixpkgs.*`, notably `config`,
127127 will be ignored.
128128129129 If unset, the pkgs argument to all NixOS modules is determined
···132132 The default value imports the Nixpkgs source files
133133 relative to the location of this NixOS module, because
134134 NixOS and Nixpkgs are distributed together for consistency,
135135- so the <literal>nixos</literal> in the default value is in fact a
136136- relative path. The <literal>config</literal>, <literal>overlays</literal>,
137137- <literal>localSystem</literal>, and <literal>crossSystem</literal> come
135135+ so the `nixos` in the default value is in fact a
136136+ relative path. The `config`, `overlays`,
137137+ `localSystem`, and `crossSystem` come
138138 from this option's siblings.
139139140140 This option can be used by applications like NixOps to increase
141141 the performance of evaluation, or to create packages that depend
142142 on a container that should be built with the exact same evaluation
143143 of Nixpkgs, for example. Applications like this should set
144144- their default value using <literal>lib.mkDefault</literal>, so
144144+ their default value using `lib.mkDefault`, so
145145 user-provided configuration can override it without using
146146- <literal>lib</literal>.
146146+ `lib`.
147147148148 Note that using a distinct version of Nixpkgs with NixOS may
149149 be an unexpected source of problems. Use this option with care.
+1-1
nixos/modules/misc/wordlist.nix
···2323 }
2424 '';
25252626- description = ''
2626+ description = lib.mdDoc ''
2727 A set with the key names being the environment variable you'd like to
2828 set and the values being a list of paths to text documents containing
2929 lists of words. The various files will be merged, sorted, duplicates
+3-3
nixos/modules/programs/captive-browser.nix
···8585 bindInterface = mkOption {
8686 default = true;
8787 type = types.bool;
8888- description = ''
8989- Binds <package>captive-browser</package> to the network interface declared in
9090- <literal>cfg.interface</literal>. This can be used to avoid collisions
8888+ description = lib.mdDoc ''
8989+ Binds `captive-browser` to the network interface declared in
9090+ `cfg.interface`. This can be used to avoid collisions
9191 with private subnets.
9292 '';
9393 };
+2-2
nixos/modules/programs/chromium.nix
···76767777 extraOpts = mkOption {
7878 type = types.attrs;
7979- description = ''
7979+ description = lib.mdDoc ''
8080 Extra chromium policy options. A list of available policies
8181 can be found in the Chrome Enterprise documentation:
8282- <link xlink:href="https://cloud.google.com/docs/chrome-enterprise/policies/">https://cloud.google.com/docs/chrome-enterprise/policies/</link>
8282+ <https://cloud.google.com/docs/chrome-enterprise/policies/>
8383 Make sure the selected policy is supported on Linux and your browser version.
8484 '';
8585 default = {};
+7-7
nixos/modules/programs/k3b.nix
···88 enable = mkOption {
99 type = types.bool;
1010 default = false;
1111- description = ''
1111+ description = lib.mdDoc ''
1212 Whether to enable k3b, the KDE disk burning application.
13131414- Additionally to installing <package>k3b</package> enabling this will
1515- add <literal>setuid</literal> wrappers in <literal>/run/wrappers/bin</literal>
1616- for both <package>cdrdao</package> and <package>cdrecord</package>. On first
1717- run you must manually configure the path of <package>cdrdae</package> and
1818- <package>cdrecord</package> to correspond to the appropriate paths under
1919- <literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu.
1414+ Additionally to installing `k3b` enabling this will
1515+ add `setuid` wrappers in `/run/wrappers/bin`
1616+ for both `cdrdao` and `cdrecord`. On first
1717+ run you must manually configure the path of `cdrdae` and
1818+ `cdrecord` to correspond to the appropriate paths under
1919+ `/run/wrappers/bin` in the "Setup External Programs" menu.
2020 '';
2121 };
2222 };
+1-1
nixos/modules/programs/mosh.nix
···1717 type = lib.types.bool;
1818 };
1919 withUtempter = mkOption {
2020- description = ''
2020+ description = lib.mdDoc ''
2121 Whether to enable libutempter for mosh.
2222 This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).
2323 Note, this will add a guid wrapper for the group utmp!
+1-1
nixos/modules/programs/msmtp.nix
···4545 passwordeval = "cat /secrets/password.txt";
4646 };
4747 };
4848- description = ''
4848+ description = lib.mdDoc ''
4949 Named accounts and their respective configurations.
5050 The special name "default" allows a default account to be defined.
5151 See msmtp(1) for the available options.
+4-4
nixos/modules/programs/ssh.nix
···9393 extraConfig = mkOption {
9494 type = types.lines;
9595 default = "";
9696- description = ''
9797- Extra configuration text prepended to <filename>ssh_config</filename>. Other generated
9898- options will be added after a <literal>Host *</literal> pattern.
9999- See <citerefentry><refentrytitle>ssh_config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
9696+ description = lib.mdDoc ''
9797+ Extra configuration text prepended to {file}`ssh_config`. Other generated
9898+ options will be added after a `Host *` pattern.
9999+ See {manpage}`ssh_config(5)`
100100 for help.
101101 '';
102102 };
+1-1
nixos/modules/programs/thefuck.nix
···2222 default = "fuck";
2323 type = types.str;
24242525- description = ''
2525+ description = lib.mdDoc ''
2626 `thefuck` needs an alias to be configured.
2727 The default value is `fuck`, but you can use anything else as well.
2828 '';
+5-5
nixos/modules/programs/tsm-client.nix
···9595 exclude.dir /nix/store
9696 include.encrypt /home/.../*
9797 '';
9898- description = ''
9999- <literal>include.*</literal> and
100100- <literal>exclude.*</literal> directives to be
9898+ description = lib.mdDoc ''
9999+ `include.*` and
100100+ `exclude.*` directives to be
101101 used when sending files to the IBM TSM server.
102102 The lines will be written into a file that the
103103- <literal>inclexcl</literal>
104104- directive in <filename>dsm.sys</filename> points to.
103103+ `inclexcl`
104104+ directive in {file}`dsm.sys` points to.
105105 '';
106106 };
107107 options.extraConfig = mkOption {
+1-1
nixos/modules/programs/yabar.nix
···6262 to use `yabar-unstable'.
6363 '';
64646565- description = ''
6565+ description = lib.mdDoc ''
6666 The package which contains the `yabar` binary.
67676868 Nixpkgs provides the `yabar` and `yabar-unstable`
+4-4
nixos/modules/programs/zsh/oh-my-zsh.nix
···4949 package = mkOption {
5050 default = pkgs.oh-my-zsh;
5151 defaultText = literalExpression "pkgs.oh-my-zsh";
5252- description = ''
5252+ description = lib.mdDoc ''
5353 Package to install for `oh-my-zsh` usage.
5454 '';
5555···6767 custom = mkOption {
6868 default = null;
6969 type = with types; nullOr str;
7070- description = ''
7070+ description = lib.mdDoc ''
7171 Path to a custom oh-my-zsh package to override config of oh-my-zsh.
7272 (Can't be used along with `customPkgs`).
7373 '';
···7676 customPkgs = mkOption {
7777 default = [];
7878 type = types.listOf types.package;
7979- description = ''
7979+ description = lib.mdDoc ''
8080 List of custom packages that should be loaded into `oh-my-zsh`.
8181 '';
8282 };
···9292 cacheDir = mkOption {
9393 default = "$HOME/.cache/oh-my-zsh";
9494 type = types.str;
9595- description = ''
9595+ description = lib.mdDoc ''
9696 Cache directory to be used by `oh-my-zsh`.
9797 Without this option it would default to the read-only nix store.
9898 '';
···2424 strategy = mkOption {
2525 type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]);
2626 default = [ "history" ];
2727- description = ''
2727+ description = lib.mdDoc ''
2828 `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated.
2929 The strategies in the array are tried successively until a suggestion is found.
3030 There are currently three built-in strategies to choose from:
+1-1
nixos/modules/security/acme/default.nix
···676676 inheritDefaults = mkOption {
677677 default = true;
678678 example = true;
679679- description = "Whether to inherit values set in `security.acme.defaults` or not.";
679679+ description = lib.mdDoc "Whether to inherit values set in `security.acme.defaults` or not.";
680680 type = lib.types.bool;
681681 };
682682 };
+1-1
nixos/modules/security/dhparams.nix
···94949595 <note><para>If this is <literal>false</literal> the resulting store
9696 path will be non-deterministic and will be rebuilt every time the
9797- <package>openssl</package> package changes.</para></note>
9797+ <literal>openssl</literal> package changes.</para></note>
9898 '';
9999 };
100100
+14-15
nixos/modules/security/pam.nix
···320320 limits = mkOption {
321321 default = [];
322322 type = limitsType;
323323- description = ''
323323+ description = lib.mdDoc ''
324324 Attribute set describing resource limits. Defaults to the
325325- value of <option>security.pam.loginLimits</option>.
326326- The meaning of the values is explained in <citerefentry>
327327- <refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
325325+ value of {option}`security.pam.loginLimits`.
326326+ The meaning of the values is explained in {manpage}`limits.conf(5)`.
328327 '';
329328 };
330329···774773 }
775774 ];
776775777777- description =
778778- '' Define resource limits that should apply to users or groups.
779779- Each item in the list should be an attribute set with a
780780- <varname>domain</varname>, <varname>type</varname>,
781781- <varname>item</varname>, and <varname>value</varname>
782782- attribute. The syntax and semantics of these attributes
783783- must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
776776+ description = ''
777777+ Define resource limits that should apply to users or groups.
778778+ Each item in the list should be an attribute set with a
779779+ <varname>domain</varname>, <varname>type</varname>,
780780+ <varname>item</varname>, and <varname>value</varname>
781781+ attribute. The syntax and semantics of these attributes
782782+ must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
784783785785- Note that these limits do not apply to systemd services,
786786- whose limits can be changed via <option>systemd.extraConfig</option>
787787- instead.
788788- '';
784784+ Note that these limits do not apply to systemd services,
785785+ whose limits can be changed via <option>systemd.extraConfig</option>
786786+ instead.
787787+ '';
789788 };
790789791790 security.pam.services = mkOption {
+1-1
nixos/modules/security/sudo.nix
···4646 type = types.package;
4747 default = pkgs.sudo;
4848 defaultText = literalExpression "pkgs.sudo";
4949- description = ''
4949+ description = lib.mdDoc ''
5050 Which package to use for `sudo`.
5151 '';
5252 };
+9-9
nixos/modules/services/cluster/hadoop/hbase.nix
···2121 "hbase.cluster.distributed" = "true";
2222 };
2323 type = types.attrsOf types.anything;
2424- description = ''
2424+ description = lib.mdDoc ''
2525 Default options for hbase-site.xml
2626 '';
2727 };
···3030 type = with types; attrsOf anything;
3131 example = literalExpression ''
3232 '';
3333- description = ''
3333+ description = lib.mdDoc ''
3434 Additional options and overrides for hbase-site.xml
3535- <link xlink:href="https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml"/>
3535+ <https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml>
3636 '';
3737 };
3838 hbaseSiteInternal = mkOption {
···5050 type = types.package;
5151 default = pkgs.hbase;
5252 defaultText = literalExpression "pkgs.hbase";
5353- description = "HBase package";
5353+ description = lib.mdDoc "HBase package";
5454 };
55555656 rootdir = mkOption {
5757- description = ''
5757+ description = lib.mdDoc ''
5858 This option will set "hbase.rootdir" in hbase-site.xml and determine
5959 the directory shared by region servers and into which HBase persists.
6060 The URL should be 'fully-qualified' to include the filesystem scheme.
···6868 default = "/hbase";
6969 };
7070 zookeeperQuorum = mkOption {
7171- description = ''
7171+ description = lib.mdDoc ''
7272 This option will set "hbase.zookeeper.quorum" in hbase-site.xml.
7373 Comma separated list of servers in the ZooKeeper ensemble.
7474 '';
···8383 openFirewall = mkOption {
8484 type = types.bool;
8585 default = false;
8686- description = ''
8686+ description = lib.mdDoc ''
8787 Open firewall ports for HBase master.
8888 '';
8989 };
···9494 overrideHosts = mkOption {
9595 type = types.bool;
9696 default = true;
9797- description = ''
9797+ description = lib.mdDoc ''
9898 Remove /etc/hosts entries for "127.0.0.2" and "::1" defined in nixos/modules/config/networking.nix
9999 Regionservers must be able to resolve their hostnames to their IP addresses, through PTR records
100100 or /etc/hosts entries.
···105105 openFirewall = mkOption {
106106 type = types.bool;
107107 default = false;
108108- description = ''
108108+ description = lib.mdDoc ''
109109 Open firewall ports for HBase master.
110110 '';
111111 };
···121121 keepalive = mkOption {
122122 default = 600;
123123 type = types.int;
124124- description = "
124124+ description = lib.mdDoc ''
125125 This is a number that indicates how frequently keepalive messages should be sent
126126 from the worker to the buildmaster, expressed in seconds.
127127- ";
127127+ '';
128128 };
129129130130 package = mkOption {
···193193 options.services.buildkite-agents = mkOption {
194194 type = types.attrsOf (types.submodule buildkiteOptions);
195195 default = {};
196196- description = ''
196196+ description = lib.mdDoc ''
197197 Attribute set of buildkite agents.
198198 The attribute key is combined with the hostname and a unique integer to
199199 create the final agent name. This can be overridden by setting the `name`
···103103 defaultText = literalExpression ''baseDirectory + "/secrets"'';
104104 };
105105 clusterJoinTokenPath = mkOption {
106106- description = ''
106106+ description = lib.mdDoc ''
107107 Location of the cluster-join-token.key file.
108108109109 You can retrieve the contents of the file when creating a new agent via
110110- <link xlink:href="https://hercules-ci.com/dashboard">https://hercules-ci.com/dashboard</link>.
110110+ <https://hercules-ci.com/dashboard>.
111111112112 As this value is confidential, it should not be in the store, but
113113 installed using other means, such as agenix, NixOps
114114- <literal>deployment.keys</literal>, or manual installation.
114114+ `deployment.keys`, or manual installation.
115115116116 The contents of the file are used for authentication between the agent and the API.
117117 '';
···120120 defaultText = literalExpression ''staticSecretsDirectory + "/cluster-join-token.key"'';
121121 };
122122 binaryCachesPath = mkOption {
123123- description = ''
123123+ description = lib.mdDoc ''
124124 Path to a JSON file containing binary cache secret keys.
125125126126 As these values are confidential, they should not be in the store, but
127127 copied over using other means, such as agenix, NixOps
128128- <literal>deployment.keys</literal>, or manual installation.
128128+ `deployment.keys`, or manual installation.
129129130130- The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/">https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/</link>.
130130+ The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/>.
131131 '';
132132 type = types.path;
133133 default = config.staticSecretsDirectory + "/binary-caches.json";
134134 defaultText = literalExpression ''staticSecretsDirectory + "/binary-caches.json"'';
135135 };
136136 secretsJsonPath = mkOption {
137137- description = ''
137137+ description = lib.mdDoc ''
138138 Path to a JSON file containing secrets for effects.
139139140140 As these values are confidential, they should not be in the store, but
141141 copied over using other means, such as agenix, NixOps
142142- <literal>deployment.keys</literal>, or manual installation.
142142+ `deployment.keys`, or manual installation.
143143144144- The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/">https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/</link>.
145145-144144+ The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/>.
146145 '';
147146 type = types.path;
148147 default = config.staticSecretsDirectory + "/secrets.json";
···8787 type = types.str;
8888 default = localDB;
8989 example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;";
9090- description = ''
9090+ description = lib.mdDoc ''
9191 The DBI string for Hydra database connection.
92929393 NOTE: Attempts to set `application_name` will be overridden by
···115115 type = types.str;
116116 default = "*";
117117 example = "localhost";
118118- description = ''
119119- The hostname or address to listen on or <literal>*</literal> to listen
118118+ description = lib.mdDoc ''
119119+ The hostname or address to listen on or `*` to listen
120120 on all interfaces.
121121 '';
122122 };
+2-2
nixos/modules/services/databases/foundationdb.nix
···9797 openFirewall = mkOption {
9898 type = types.bool;
9999 default = false;
100100- description = ''
100100+ description = lib.mdDoc ''
101101 Open the firewall ports corresponding to FoundationDB processes and coordinators
102102- using <option>config.networking.firewall.*</option>.
102102+ using {option}`config.networking.firewall.*`.
103103 '';
104104 };
105105
+2-2
nixos/modules/services/databases/mongodb.nix
···3535 default = pkgs.mongodb;
3636 defaultText = literalExpression "pkgs.mongodb";
3737 type = types.package;
3838- description = "
3838+ description = lib.mdDoc ''
3939 Which MongoDB derivation to use.
4040- ";
4040+ '';
4141 };
42424343 user = mkOption {
+2-2
nixos/modules/services/databases/mysql.nix
···3636 package = mkOption {
3737 type = types.package;
3838 example = literalExpression "pkgs.mariadb";
3939- description = "
3939+ description = lib.mdDoc ''
4040 Which MySQL derivation to use. MariaDB packages are supported too.
4141- ";
4141+ '';
4242 };
43434444 user = mkOption {
+3-3
nixos/modules/services/databases/postgresql.nix
···7979 authentication = mkOption {
8080 type = types.lines;
8181 default = "";
8282- description = ''
8282+ description = lib.mdDoc ''
8383 Defines how users authenticate themselves to the server. See the
8484- <link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html">PostgreSQL documentation for pg_hba.conf</link>
8484+ [PostgreSQL documentation for pg_hba.conf](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html)
8585 for details on the expected format of this option. By default,
8686 peer based authentication will be used for users connecting
8787 via the Unix socket, and md5 password authentication will be
8888 used for users connecting via TCP. Any added rules will be
8989 inserted above the default rules. If you'd like to replace the
9090- default rules entirely, you can use <function>lib.mkForce</function> in your
9090+ default rules entirely, you can use `lib.mkForce` in your
9191 module.
9292 '';
9393 };
···149149 };
150150 }
151151 '';
152152- description = "Declarative kernel config
152152+ description = lib.mdDoc ''
153153+ Declarative kernel config.
153154154154- Kernels can be declared in any language that supports and has the required
155155- dependencies to communicate with a jupyter server.
156156- In python's case, it means that ipykernel package must always be included in
157157- the list of packages of the targeted environment.
158158- ";
155155+ Kernels can be declared in any language that supports and has the required
156156+ dependencies to communicate with a jupyter server.
157157+ In python's case, it means that ipykernel package must always be included in
158158+ the list of packages of the targeted environment.
159159+ '';
159160 };
160161 };
161162
+1-1
nixos/modules/services/development/lorri.nix
···99 enable = lib.mkOption {
1010 default = false;
1111 type = lib.types.bool;
1212- description = ''
1212+ description = lib.mdDoc ''
1313 Enables the daemon for `lorri`, a nix-shell replacement for project
1414 development. The socket-activated daemon starts on the first request
1515 issued by the `lorri` command.
+1-1
nixos/modules/services/editors/infinoted.nix
···3636 certificateChain = mkOption {
3737 type = types.nullOr types.path;
3838 default = null;
3939- description = ''
3939+ description = lib.mdDoc ''
4040 Chain of CA-certificates to which our `certificateFile` is relative.
4141 Optional for TLS.
4242 '';
+3-3
nixos/modules/services/games/asf.nix
···81818282 settings = mkOption {
8383 type = format.type;
8484- description = ''
8585- The ASF.json file, all the options are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config">here</link>.
8484+ description = lib.mdDoc ''
8585+ The ASF.json file, all the options are documented [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config).
8686 Do note that `AutoRestart` and `UpdateChannel` is always to `false` respectively `0` because NixOS takes care of updating everything.
8787 `Headless` is also always set to `true` because there is no way to provide inputs via a systemd service.
8888- You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod">here</link>.
8888+ You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod).
8989 '';
9090 example = {
9191 Statistics = false;
+2-2
nixos/modules/services/games/crossfire-server.nix
···4141 stateDir = mkOption {
4242 type = types.str;
4343 default = "/var/lib/crossfire";
4444- description = ''
4444+ description = lib.mdDoc ''
4545 Where to store runtime data (save files, persistent items, etc).
46464747 If left at the default, this will be automatically created on server
···61616262 configFiles = mkOption {
6363 type = types.attrsOf types.str;
6464- description = ''
6464+ description = lib.mdDoc ''
6565 Text to append to the corresponding configuration files. Note that the
6666 files given in the example are *not* the complete set of files available
6767 to customize; look in /etc/crossfire after enabling the server to see
+1-1
nixos/modules/services/games/deliantra-server.nix
···4141 stateDir = mkOption {
4242 type = types.str;
4343 default = "/var/lib/deliantra";
4444- description = ''
4444+ description = lib.mdDoc ''
4545 Where to store runtime data (save files, persistent items, etc).
46464747 If left at the default, this will be automatically created on server
+3-3
nixos/modules/services/games/minetest-server.nix
···2525 gameId = mkOption {
2626 type = types.nullOr types.str;
2727 default = null;
2828- description = ''
2828+ description = lib.mdDoc ''
2929 Id of the game to use. To list available games run
3030 `minetestserver --gameid list`.
3131···3636 world = mkOption {
3737 type = types.nullOr types.path;
3838 default = null;
3939- description = ''
3939+ description = lib.mdDoc ''
4040 Name of the world to use. To list available worlds run
4141 `minetestserver --world list`.
4242···4747 configPath = mkOption {
4848 type = types.nullOr types.path;
4949 default = null;
5050- description = ''
5050+ description = lib.mdDoc ''
5151 Path to the config to use.
52525353 If set to null, the config of the running user will be used:
···126126 psycopg2
127127 ];
128128 '';
129129- description = ''
129129+ description = lib.mdDoc ''
130130 List of packages to add to propagatedBuildInputs.
131131132132- A popular example is <package>python3Packages.psycopg2</package>
132132+ A popular example is `python3Packages.psycopg2`
133133 for PostgreSQL support in the recorder component.
134134 '';
135135 };
+2-2
nixos/modules/services/logging/logrotate.nix
···7979 priority = mkOption {
8080 type = types.int;
8181 default = 1000;
8282- description = ''
8282+ description = lib.mdDoc ''
8383 Order of this logrotate block in relation to the others. The semantics are
8484 the same as with `lib.mkOrder`. Smaller values have a greater priority.
8585 '';
···260260 priority = mkOption {
261261 type = types.int;
262262 default = 1000;
263263- description = ''
263263+ description = lib.mdDoc ''
264264 Order of this logrotate block in relation to the others. The semantics are
265265 the same as with `lib.mkOrder`. Smaller values are inserted first.
266266 '';
+36-36
nixos/modules/services/mail/postfix.nix
···355355 setgidGroup = mkOption {
356356 type = types.str;
357357 default = "postdrop";
358358- description = "
358358+ description = lib.mdDoc ''
359359 How to call postfix setgid group (for postdrop). Should
360360 be uniquely used group.
361361- ";
361361+ '';
362362 };
363363364364 networks = mkOption {
365365 type = types.nullOr (types.listOf types.str);
366366 default = null;
367367 example = ["192.168.0.1/24"];
368368- description = "
368368+ description = lib.mdDoc ''
369369 Net masks for trusted - allowed to relay mail to third parties -
370370 hosts. Leave empty to use mynetworks_style configuration or use
371371 default (localhost-only).
372372- ";
372372+ '';
373373 };
374374375375 networksStyle = mkOption {
376376 type = types.str;
377377 default = "";
378378- description = "
378378+ description = lib.mdDoc ''
379379 Name of standard way of trusted network specification to use,
380380 leave blank if you specify it explicitly or if you want to use
381381 default (localhost-only).
382382- ";
382382+ '';
383383 };
384384385385 hostname = mkOption {
386386 type = types.str;
387387 default = "";
388388- description ="
388388+ description = lib.mdDoc ''
389389 Hostname to use. Leave blank to use just the hostname of machine.
390390 It should be FQDN.
391391- ";
391391+ '';
392392 };
393393394394 domain = mkOption {
395395 type = types.str;
396396 default = "";
397397- description ="
397397+ description = lib.mdDoc ''
398398 Domain to use. Leave blank to use hostname minus first component.
399399- ";
399399+ '';
400400 };
401401402402 origin = mkOption {
403403 type = types.str;
404404 default = "";
405405- description ="
405405+ description = lib.mdDoc ''
406406 Origin to use in outgoing e-mail. Leave blank to use hostname.
407407- ";
407407+ '';
408408 };
409409410410 destination = mkOption {
411411 type = types.nullOr (types.listOf types.str);
412412 default = null;
413413 example = ["localhost"];
414414- description = "
414414+ description = lib.mdDoc ''
415415 Full (!) list of domains we deliver locally. Leave blank for
416416 acceptable Postfix default.
417417- ";
417417+ '';
418418 };
419419420420 relayDomains = mkOption {
421421 type = types.nullOr (types.listOf types.str);
422422 default = null;
423423 example = ["localdomain"];
424424- description = "
424424+ description = lib.mdDoc ''
425425 List of domains we agree to relay to. Default is empty.
426426- ";
426426+ '';
427427 };
428428429429 relayHost = mkOption {
430430 type = types.str;
431431 default = "";
432432- description = "
432432+ description = lib.mdDoc ''
433433 Mail relay for outbound mail.
434434- ";
434434+ '';
435435 };
436436437437 relayPort = mkOption {
438438 type = types.int;
439439 default = 25;
440440- description = "
440440+ description = lib.mdDoc ''
441441 SMTP port for relay mail relay.
442442- ";
442442+ '';
443443 };
444444445445 lookupMX = mkOption {
446446 type = types.bool;
447447 default = false;
448448- description = "
448448+ description = lib.mdDoc ''
449449 Whether relay specified is just domain whose MX must be used.
450450- ";
450450+ '';
451451 };
452452453453 postmasterAlias = mkOption {
454454 type = types.str;
455455 default = "root";
456456- description = "
456456+ description = lib.mdDoc ''
457457 Who should receive postmaster e-mail. Multiple values can be added by
458458 separating values with comma.
459459- ";
459459+ '';
460460 };
461461462462 rootAlias = mkOption {
463463 type = types.str;
464464 default = "";
465465- description = "
465465+ description = lib.mdDoc ''
466466 Who should receive root e-mail. Blank for no redirection.
467467 Multiple values can be added by separating values with comma.
468468- ";
468468+ '';
469469 };
470470471471 extraAliases = mkOption {
472472 type = types.lines;
473473 default = "";
474474- description = "
474474+ description = lib.mdDoc ''
475475 Additional entries to put verbatim into aliases file, cf. man-page aliases(8).
476476- ";
476476+ '';
477477 };
478478479479 aliasMapType = mkOption {
···497497 extraConfig = mkOption {
498498 type = types.lines;
499499 default = "";
500500- description = "
500500+ description = lib.mdDoc ''
501501 Extra lines to be added verbatim to the main.cf configuration file.
502502- ";
502502+ '';
503503 };
504504505505 tlsTrustedAuthorities = mkOption {
···527527 type = types.str;
528528 default = "";
529529 example = "+";
530530- description = "
530530+ description = lib.mdDoc ''
531531 Delimiter for address extension: so mail to user+test can be handled by ~user/.forward+test
532532- ";
532532+ '';
533533 };
534534535535 canonical = mkOption {
···543543 virtual = mkOption {
544544 type = types.lines;
545545 default = "";
546546- description = "
546546+ description = lib.mdDoc ''
547547 Entries for the virtual alias map, cf. man-page virtual(5).
548548- ";
548548+ '';
549549 };
550550551551 virtualMapType = mkOption {
···572572 transport = mkOption {
573573 default = "";
574574 type = types.lines;
575575- description = "
575575+ description = lib.mdDoc ''
576576 Entries for the transport map, cf. man-page transport(8).
577577- ";
577577+ '';
578578 };
579579580580 dnsBlacklists = mkOption {
+10-11
nixos/modules/services/matrix/dendrite.nix
···2626 type = lib.types.nullOr lib.types.path;
2727 example = "/var/lib/dendrite/server.cert";
2828 default = null;
2929- description = ''
2929+ description = lib.mdDoc ''
3030 The path to the TLS certificate.
31313232- <programlisting>
3232+ ```
3333 nix-shell -p dendrite --command "generate-keys --tls-cert server.crt --tls-key server.key"
3434- </programlisting>
3434+ ```
3535 '';
3636 };
3737 tlsKey = lib.mkOption {
3838 type = lib.types.nullOr lib.types.path;
3939 example = "/var/lib/dendrite/server.key";
4040 default = null;
4141- description = ''
4141+ description = lib.mdDoc ''
4242 The path to the TLS key.
43434444- <programlisting>
4444+ ```
4545 nix-shell -p dendrite --command "generate-keys --tls-cert server.crt --tls-key server.key"
4646- </programlisting>
4646+ ```
4747 '';
4848 };
4949 environmentFile = lib.mkOption {
···5151 example = "/var/lib/dendrite/registration_secret";
5252 default = null;
5353 description = ''
5454- Environment file as defined in <citerefentry>
5555- <refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
5454+ Environment file as defined in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
5655 Secrets may be passed to the service without adding them to the world-readable
5756 Nix store, by specifying placeholder variables as the option value in Nix and
5857 setting these variables accordingly in the environment file. Currently only used
···103102 lib.types.path
104103 (lib.types.strMatching "^\\$CREDENTIALS_DIRECTORY/.+");
105104 example = "$CREDENTIALS_DIRECTORY/private_key";
106106- description = ''
105105+ description = lib.mdDoc ''
107106 The path to the signing private key file, used to sign
108107 requests and events.
109108110110- <programlisting>
109109+ ```
111110 nix-shell -p dendrite --command "generate-keys --private-key matrix_key.pem"
112112- </programlisting>
111111+ ```
113112 '';
114113 };
115114 trusted_third_party_id_servers = lib.mkOption {
+1-1
nixos/modules/services/matrix/synapse.nix
···516516 type = types.bool;
517517 default = true;
518518 example = false;
519519- description = ''
519519+ description = lib.mdDoc ''
520520 Is the preview URL API enabled? If enabled, you *must* specify an
521521 explicit url_preview_ip_range_blacklist of IPs that the spider is
522522 denied from accessing.
+4-4
nixos/modules/services/misc/etebase-server.nix
···133133 };
134134 };
135135 default = {};
136136- description = ''
137137- Configuration for <package>etebase-server</package>. Refer to
138138- <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/>
139139- and <link xlink:href="https://github.com/etesync/server/wiki"/>
136136+ description = lib.mdDoc ''
137137+ Configuration for `etebase-server`. Refer to
138138+ <https://github.com/etesync/server/blob/master/etebase-server.ini.example>
139139+ and <https://github.com/etesync/server/wiki>
140140 for details on supported values.
141141 '';
142142 example = {
+2-2
nixos/modules/services/misc/exhibitor.nix
···7171 enable = mkOption {
7272 type = types.bool;
7373 default = false;
7474- description = "
7474+ description = lib.mdDoc ''
7575 Whether to enable the exhibitor server.
7676- ";
7676+ '';
7777 };
7878 # See https://github.com/soabase/exhibitor/wiki/Running-Exhibitor for what these mean
7979 # General options for any type of config
+5-5
nixos/modules/services/misc/freeswitch.nix
···2222 enableReload = mkOption {
2323 default = false;
2424 type = types.bool;
2525- description = ''
2626- Issue the <literal>reloadxml</literal> command to FreeSWITCH when configuration directory changes (instead of restart).
2727- See <link xlink:href="https://freeswitch.org/confluence/display/FREESWITCH/Reloading">FreeSWITCH documentation</link> for more info.
2828- The configuration directory is exposed at <filename>/etc/freeswitch</filename>.
2929- See also <literal>systemd.services.*.restartIfChanged</literal>.
2525+ description = lib.mdDoc ''
2626+ Issue the `reloadxml` command to FreeSWITCH when configuration directory changes (instead of restart).
2727+ See [FreeSWITCH documentation](https://freeswitch.org/confluence/display/FREESWITCH/Reloading) for more info.
2828+ The configuration directory is exposed at {file}`/etc/freeswitch`.
2929+ See also `systemd.services.*.restartIfChanged`.
3030 '';
3131 };
3232 configTemplate = mkOption {
+12-15
nixos/modules/services/misc/geoipupdate.nix
···1212 options = {
1313 services.geoipupdate = {
1414 enable = lib.mkEnableOption ''
1515- periodic downloading of GeoIP databases using
1616- <productname>geoipupdate</productname>.
1515+ periodic downloading of GeoIP databases using geoipupdate.
1716 '';
18171918 interval = lib.mkOption {
···3635 ProxyUserPassword = { _secret = "/run/keys/proxy_pass"; };
3736 }
3837 '';
3939- description = ''
4040- <productname>geoipupdate</productname> configuration
4141- options. See
4242- <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md"/>
3838+ description = lib.mdDoc ''
3939+ geoipupdate configuration options. See
4040+ <https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md>
4341 for a full list of available options.
44424543 Settings containing secret data should be set to an
4644 attribute set containing the attribute
4747- <literal>_secret</literal> - a string pointing to a file
4545+ `_secret` - a string pointing to a file
4846 containing the value the option should be set to. See the
4947 example to get a better picture of this: in the resulting
5050- <filename>GeoIP.conf</filename> file, the
5151- <literal>ProxyUserPassword</literal> key will be set to the
4848+ {file}`GeoIP.conf` file, the
4949+ `ProxyUserPassword` key will be set to the
5250 contents of the
5353- <filename>/run/keys/proxy_pass</filename> file.
5151+ {file}`/run/keys/proxy_pass` file.
5452 '';
5553 type = lib.types.submodule {
5654 freeformType =
···85838684 LicenseKey = lib.mkOption {
8785 type = with lib.types; either path (attrsOf path);
8888- description = ''
8989- A file containing the
9090- <productname>MaxMind</productname> license key.
8686+ description = lib.mdDoc ''
8787+ A file containing the MaxMind license key.
91889289 Always handled as a secret whether the value is
9393- wrapped in a <literal>{ _secret = ...; }</literal>
9494- attrset or not (refer to <xref linkend="opt-services.geoipupdate.settings"/> for
9090+ wrapped in a `{ _secret = ...; }`
9191+ attrset or not (refer to [](#opt-services.geoipupdate.settings) for
9592 details).
9693 '';
9794 apply = x: if isAttrs x then x else { _secret = x; };
+6-6
nixos/modules/services/misc/gitea.nix
···183183 file = mkOption {
184184 type = types.nullOr types.str;
185185 default = null;
186186- description = "Filename to be used for the dump. If `null` a default name is choosen by gitea.";
186186+ description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is choosen by gitea.";
187187 example = "gitea-dump";
188188 };
189189 };
···293293 default = "${cfg.stateDir}/log";
294294 defaultText = literalExpression ''"''${config.${opt.stateDir}}/log"'';
295295 type = types.str;
296296- description = "Root path for log files.";
296296+ description = lib.mdDoc "Root path for log files.";
297297 };
298298 LEVEL = mkOption {
299299 default = "Info";
300300 type = types.enum [ "Trace" "Debug" "Info" "Warn" "Error" "Critical" ];
301301- description = "General log level.";
301301+ description = lib.mdDoc "General log level.";
302302 };
303303 };
304304···306306 DISABLE_SSH = mkOption {
307307 type = types.bool;
308308 default = false;
309309- description = "Disable external SSH feature.";
309309+ description = lib.mdDoc "Disable external SSH feature.";
310310 };
311311312312 SSH_PORT = mkOption {
313313 type = types.int;
314314 default = 22;
315315 example = 2222;
316316- description = ''
316316+ description = lib.mdDoc ''
317317 SSH port displayed in clone URL.
318318 The option is required to configure a service when the external visible port
319319 differs from the local listening port i.e. if port forwarding is used.
···339339 COOKIE_SECURE = mkOption {
340340 type = types.bool;
341341 default = false;
342342- description = ''
342342+ description = lib.mdDoc ''
343343 Marks session cookies as "secure" as a hint for browsers to only send
344344 them via HTTPS. This option is recommend, if gitea is being served over HTTPS.
345345 '';
+6-8
nixos/modules/services/misc/gitlab.nix
···338338 default = 0;
339339 example = 48;
340340 apply = x: x * 60 * 60;
341341- description = ''
341341+ description = lib.mdDoc ''
342342 How long to keep the backups around, in
343343- hours. <literal>0</literal> means <quote>keep
344344- forever</quote>.
343343+ hours. `0` means “keep forever”.
345344 '';
346345 };
347346···415414 databaseHost = mkOption {
416415 type = types.str;
417416 default = "";
418418- description = ''
419419- GitLab database hostname. An empty string means <quote>use
420420- local unix socket connection</quote>.
417417+ description = lib.mdDoc ''
418418+ GitLab database hostname. An empty string means
419419+ “use local unix socket connection”.
421420 '';
422421 };
423422···752751 description = ''
753752 The number of worker processes Puma should spawn. This
754753 controls the amount of parallel Ruby code can be
755755- executed. GitLab recommends <quote>Number of CPU cores -
756756- 1</quote>, but at least two.
754754+ executed. GitLab recommends <literal>Number of CPU cores - 1</literal>, but at least two.
757755758756 <note>
759757 <para>
+12-13
nixos/modules/services/misc/gitolite.nix
···1414 enable = mkOption {
1515 type = types.bool;
1616 default = false;
1717- description = ''
1717+ description = lib.mdDoc ''
1818 Enable gitolite management under the
1919- <literal>gitolite</literal> user. After
1919+ `gitolite` user. After
2020 switching to a configuration with Gitolite enabled, you can
2121- then run <literal>git clone
2222- gitolite@host:gitolite-admin.git</literal> to manage it further.
2121+ then run `git clone gitolite@host:gitolite-admin.git` to manage it further.
2322 '';
2423 };
2524···7271 @{$RC{ENABLE}} = grep { $_ ne 'desc' } @{$RC{ENABLE}}; # disable the command/feature
7372 '''
7473 '';
7575- description = ''
7676- Extra configuration to append to the default <literal>~/.gitolite.rc</literal>.
7474+ description = lib.mdDoc ''
7575+ Extra configuration to append to the default `~/.gitolite.rc`.
77767878- This should be Perl code that modifies the <literal>%RC</literal>
7979- configuration variable. The default <literal>~/.gitolite.rc</literal>
8080- content is generated by invoking <literal>gitolite print-default-rc</literal>,
7777+ This should be Perl code that modifies the `%RC`
7878+ configuration variable. The default `~/.gitolite.rc`
7979+ content is generated by invoking `gitolite print-default-rc`,
8180 and extra configuration from this option is appended to it. The result
8282- is placed to Nix store, and the <literal>~/.gitolite.rc</literal> file
8181+ is placed to Nix store, and the `~/.gitolite.rc` file
8382 becomes a symlink to it.
84838584 If you already have a customized (or otherwise changed)
8686- <literal>~/.gitolite.rc</literal> file, NixOS will refuse to replace
8585+ `~/.gitolite.rc` file, NixOS will refuse to replace
8786 it with a symlink, and the `gitolite-init` initialization service
8887 will fail. In this situation, in order to use this option, you
8988 will need to take any customizations you may have in
9090- <literal>~/.gitolite.rc</literal>, convert them to appropriate Perl
8989+ `~/.gitolite.rc`, convert them to appropriate Perl
9190 statements, add them to this option, and remove the file.
92919393- See also the <literal>enableGitAnnex</literal> option.
9292+ See also the `enableGitAnnex` option.
9493 '';
9594 };
9695
+1-1
nixos/modules/services/misc/klipper.nix
···8282 '';
8383 configFile = mkOption {
8484 type = path;
8585- description = "Path to firmware config which is generated using `klipper-genconf`";
8585+ description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`";
8686 };
8787 };
8888 });
+10-10
nixos/modules/services/misc/nix-daemon.nix
···264264 type = types.nullOr types.str;
265265 default = null;
266266 example = "/root/.ssh/id_buildhost_builduser";
267267- description = ''
267267+ description = lib.mdDoc ''
268268 The path to the SSH private key with which to authenticate on
269269 the build machine. The private key must not have a passphrase.
270270 If null, the building user (root on NixOS machines) must have an
···562562 trusted-public-keys = mkOption {
563563 type = types.listOf types.str;
564564 example = [ "hydra.nixos.org-1:CNHJZBh9K4tP3EKF6FkkgeVYsS3ohTl+oS0Qa8bezVs=" ];
565565- description = ''
565565+ description = lib.mdDoc ''
566566 List of public keys used to sign binary caches. If
567567- <option>nix.settings.trusted-public-keys</option> is enabled,
567567+ {option}`nix.settings.trusted-public-keys` is enabled,
568568 then Nix will use a binary from a binary cache if and only
569569- if it is signed by <emphasis>any</emphasis> of the keys
569569+ if it is signed by *any* of the keys
570570 listed here. By default, only the key for
571571- <uri>cache.nixos.org</uri> is included.
571571+ `cache.nixos.org` is included.
572572 '';
573573 };
574574···605605 type = types.listOf types.str;
606606 default = [ "*" ];
607607 example = [ "@wheel" "@builders" "alice" "bob" ];
608608- description = ''
608608+ description = lib.mdDoc ''
609609 A list of names of users (separated by whitespace) that are
610610 allowed to connect to the Nix daemon. As with
611611- <option>nix.settings.trusted-users</option>, you can specify groups by
612612- prefixing them with <literal>@</literal>. Also, you can
613613- allow all users by specifying <literal>*</literal>. The
614614- default is <literal>*</literal>. Note that trusted users are
611611+ {option}`nix.settings.trusted-users`, you can specify groups by
612612+ prefixing them with `@`. Also, you can
613613+ allow all users by specifying `*`. The
614614+ default is `*`. Note that trusted users are
615615 always allowed to connect.
616616 '';
617617 };
+1-1
nixos/modules/services/misc/rmfakecloud.nix
···5050 type = with types; attrsOf str;
5151 default = { };
5252 example = { DATADIR = "/custom/path/for/rmfakecloud/data"; };
5353- description = ''
5353+ description = lib.mdDoc ''
5454 Extra settings in the form of a set of key-value pairs.
5555 For tokens and secrets, use `environmentFile` instead.
5656
+1-1
nixos/modules/services/misc/zoneminder.nix
···8080 webserver = mkOption {
8181 type = types.enum [ "nginx" "none" ];
8282 default = "nginx";
8383- description = ''
8383+ description = lib.mdDoc ''
8484 The webserver to configure for the PHP frontend.
85858686 Set it to `none` if you want to configure it yourself. PRs are welcome
+1-1
nixos/modules/services/monitoring/collectd.nix
···52525353 buildMinimalPackage = mkOption {
5454 default = false;
5555- description = ''
5555+ description = lib.mdDoc ''
5656 Build a minimal collectd package with only the configured `services.collectd.plugins`
5757 '';
5858 type = bool;
···6060 package = mkOption {
6161 default = pkgs.datadog-agent;
6262 defaultText = literalExpression "pkgs.datadog-agent";
6363- description = ''
6363+ description = lib.mdDoc ''
6464 Which DataDog v7 agent package to use. Note that the provided
6565 package is expected to have an overridable `pythonPackages`-attribute
6666 which configures the Python environment with the Datadog
···168168 };
169169170170 checks = mkOption {
171171- description = ''
171171+ description = lib.mdDoc ''
172172 Configuration for all Datadog checks. Keys of this attribute
173173 set will be used as the name of the check to create the
174174 appropriate configuration in `conf.d/$check.d/conf.yaml`.
···2020 apiKeyFile = mkOption {
2121 type = types.path;
2222 example = "/run/keys/mackerel-api-key";
2323- description = ''
2323+ description = lib.mdDoc ''
2424 Path to file containing the Mackerel API key. The file should contain a
2525 single line of the following form:
26262727- <literallayout>apikey = "EXAMPLE_API_KEY"</literallayout>
2727+ `apikey = "EXAMPLE_API_KEY"`
2828 '';
2929 };
3030
+11-11
nixos/modules/services/monitoring/nagios.nix
···9191 enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.'';
92929393 objectDefs = mkOption {
9494- description = "
9494+ description = lib.mdDoc ''
9595 A list of Nagios object configuration files that must define
9696 the hosts, host groups, services and contacts for the
9797 network that you want Nagios to monitor.
9898- ";
9898+ '';
9999 type = types.listOf types.path;
100100 example = literalExpression "[ ./objects.cfg ]";
101101 };
···104104 type = types.listOf types.package;
105105 default = with pkgs; [ monitoring-plugins msmtp mailutils ];
106106 defaultText = literalExpression "[pkgs.monitoring-plugins pkgs.msmtp pkgs.mailutils]";
107107- description = "
107107+ description = ''
108108 Packages to be added to the Nagios <envar>PATH</envar>.
109109 Typically used to add plugins, but can be anything.
110110- ";
110110+ '';
111111 };
112112113113 mainConfigFile = mkOption {
114114 type = types.nullOr types.package;
115115 default = null;
116116- description = "
116116+ description = lib.mdDoc ''
117117 If non-null, overrides the main configuration file of Nagios.
118118- ";
118118+ '';
119119 };
120120121121 extraConfig = mkOption {
···139139 type = types.package;
140140 default = nagiosCGICfgFile;
141141 defaultText = literalExpression "nagiosCGICfgFile";
142142- description = "
142142+ description = lib.mdDoc ''
143143 Derivation for the configuration file of Nagios CGI scripts
144144 that can be used in web servers for running the Nagios web interface.
145145- ";
145145+ '';
146146 };
147147148148 enableWebInterface = mkOption {
149149 type = types.bool;
150150 default = false;
151151- description = "
151151+ description = lib.mdDoc ''
152152 Whether to enable the Nagios web interface. You should also
153153- enable Apache (<option>services.httpd.enable</option>).
154154- ";
153153+ enable Apache ({option}`services.httpd.enable`).
154154+ '';
155155 };
156156157157 virtualHost = mkOption {
···251251 authorization = mkOption {
252252 type = types.nullOr types.attrs;
253253 default = null;
254254- description = ''
254254+ description = lib.mdDoc ''
255255 Sets the `Authorization` header on every scrape request with the configured credentials.
256256 '';
257257 };
···664664 promTypes.dockerswarm_sd_config = mkDockerSdConfigModule {
665665 role = mkOption {
666666 type = types.enum [ "services" "tasks" "nodes" ];
667667- description = ''
667667+ description = lib.mdDoc ''
668668 Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`.
669669 '';
670670 };
···1222122212231223 role = mkOption {
12241224 type = types.enum [ "instance" "baremetal" ];
12251225- description = ''
12251225+ description = lib.mdDoc ''
12261226 Role of the targets to retrieve. Must be `instance` or `baremetal`.
12271227 '';
12281228 };
···17291729 type = with types; either bool (enum [ "syntax-only" ]);
17301730 default = true;
17311731 example = "syntax-only";
17321732- description = ''
17331733- Check configuration with <literal>promtool
17341734- check</literal>. The call to <literal>promtool</literal> is
17321732+ description = lib.mdDoc ''
17331733+ Check configuration with `promtool check`. The call to `promtool` is
17351734 subject to sandboxing by Nix.
1736173517371736 If you use credentials stored in external files
17381738- (<literal>password_file</literal>, <literal>bearer_token_file</literal>, etc),
17391739- they will not be visible to <literal>promtool</literal>
17371737+ (`password_file`, `bearer_token_file`, etc),
17381738+ they will not be visible to `promtool`
17401739 and it will report errors, despite a correct configuration.
17411741- To resolve this, you may set this option to <literal>"syntax-only"</literal>
17401740+ To resolve this, you may set this option to `"syntax-only"`
17421741 in order to only syntax check the Prometheus configuration.
17431742 '';
17441743 };
···121121 It's possible to work around the issue with a config like this:
122122 <programlisting>
123123 {
124124- <link linkend="opt-services.rspamd.locals._name_.text">services.rspamd.locals."multimap.conf".text</link> = '''
124124+ services.rspamd.locals."multimap.conf".text = '''
125125 ALLOWLIST_PROMETHEUS {
126126 filter = "email:domain:tld";
127127 type = "from";
···1010 settings = mkOption {
1111 type = types.attrs;
1212 default = {};
1313- description = ''
1313+ description = lib.mdDoc ''
1414 All settings of nginxlog expressed as an Nix attrset.
15151616 Check the official documentation for the corresponding YAML
···1212 example = "/run/keys/ldap_pass";
1313 description = ''
1414 Environment file to contain the credentials to authenticate against
1515- <package>openldap</package>.
1515+ <literal>openldap</literal>.
16161717 The file should look like this:
1818 <programlisting>
···2626 default = "tcp";
2727 example = "udp";
2828 type = types.str;
2929- description = ''
3030- Which protocol to use to connect against <package>openldap</package>.
2929+ description = lib.mdDoc ''
3030+ Which protocol to use to connect against `openldap`.
3131 '';
3232 };
3333 ldapAddr = mkOption {
3434 default = "localhost:389";
3535 type = types.str;
3636- description = ''
3737- Address of the <package>openldap</package>-instance.
3636+ description = lib.mdDoc ''
3737+ Address of the `openldap`-instance.
3838 '';
3939 };
4040 metricsPath = mkOption {
···3737 extraArgs = mkOption {
3838 type = types.listOf types.str;
3939 default = [];
4040- description = ''
4040+ description = lib.mdDoc ''
4141 A list of commandline-switches forwarded to a riemann-tool.
4242 See for example `riemann-health --help` for available options.
4343 '';
···111111 uuid = mkOption {
112112 example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40";
113113 type = types.str;
114114- description = ''
114114+ description = lib.mdDoc ''
115115 Must be set to a unique identifier, preferably a UUID according to
116116 RFC 4122. UUIDs can be generated with `uuidgen` command, found in
117117 the `util-linux` package.
···236236 uuid = mkOption {
237237 example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41";
238238 type = types.str;
239239- description = ''
239239+ description = lib.mdDoc ''
240240 Must be set to a unique identifier, preferably a UUID according to
241241 RFC 4122. UUIDs can be generated with `uuidgen` command, found in
242242 the `util-linux` package.
···379379 uuid = mkOption {
380380 example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42";
381381 type = types.str;
382382- description = ''
382382+ description = lib.mdDoc ''
383383 Must be set to a unique identifier, preferably a UUID according to
384384 RFC 4122. UUIDs can be generated with `uuidgen` command, found in
385385 the `util-linux` package.
···1313 apiTokenFile = mkOption {
1414 type = types.nullOr types.str;
1515 default = null;
1616- description = ''
1616+ description = lib.mdDoc ''
1717 The path to a file containing the CloudFlare API token.
18181919 The file must have the form `CLOUDFLARE_API_TOKEN=...`
+3-3
nixos/modules/services/networking/create_ap.nix
···1212 settings = mkOption {
1313 type = with types; attrsOf (oneOf [ int bool str ]);
1414 default = {};
1515- description = ''
1616- Configuration for <package>create_ap</package>.
1717- See <link xlink:href="https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf">upstream example configuration</link>
1515+ description = lib.mdDoc ''
1616+ Configuration for `create_ap`.
1717+ See [upstream example configuration](https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf)
1818 for supported values.
1919 '';
2020 example = {
+1-1
nixos/modules/services/networking/dhcpcd.nix
···155155 type = types.lines;
156156 default = "";
157157 example = "if [[ $reason =~ BOUND ]]; then echo $interface: Routers are $new_routers - were $old_routers; fi";
158158- description = ''
158158+ description = lib.mdDoc ''
159159 Shell code that will be run after all other hooks. See
160160 `man dhcpcd-run-hooks` for details on what is possible.
161161 '';
+1-1
nixos/modules/services/networking/ferm.nix
···2020 enable = mkOption {
2121 default = false;
2222 type = types.bool;
2323- description = ''
2323+ description = lib.mdDoc ''
2424 Whether to enable Ferm Firewall.
2525 *Warning*: Enabling this service WILL disable the existing NixOS
2626 firewall! Default firewall rules provided by packages are not
···5555 type = lib.types.package;
5656 default = pkgs.syncstorage-rs;
5757 defaultText = lib.literalExpression "pkgs.syncstorage-rs";
5858- description = ''
5858+ description = lib.mdDoc ''
5959 Package to use.
6060 '';
6161 };
···6666 # behavior ever change.
6767 type = lib.types.strMatching "[a-z_][a-z0-9_]*";
6868 default = defaultDatabase;
6969- description = ''
6969+ description = lib.mdDoc ''
7070 Database to use for storage. Will be created automatically if it does not exist
7171- and <literal>config.${opt.database.createLocally}</literal> is set.
7171+ and `config.${opt.database.createLocally}` is set.
7272 '';
7373 };
74747575 database.user = lib.mkOption {
7676 type = lib.types.str;
7777 default = defaultUser;
7878- description = ''
7878+ description = lib.mdDoc ''
7979 Username for database connections.
8080 '';
8181 };
···8383 database.host = lib.mkOption {
8484 type = lib.types.str;
8585 default = "localhost";
8686- description = ''
8787- Database host name. <literal>localhost</literal> is treated specially and inserts
8686+ description = lib.mdDoc ''
8787+ Database host name. `localhost` is treated specially and inserts
8888 systemd dependencies, other hostnames or IP addresses of the local machine do not.
8989 '';
9090 };
···9292 database.createLocally = lib.mkOption {
9393 type = lib.types.bool;
9494 default = true;
9595- description = ''
9595+ description = lib.mdDoc ''
9696 Whether to create database and user on the local machine if they do not exist.
9797 This includes enabling unix domain socket authentication for the configured user.
9898 '';
···101101 logLevel = lib.mkOption {
102102 type = lib.types.str;
103103 default = "error";
104104- description = ''
105105- Log level to run with. This can be a simple log level like <literal>error</literal>
106106- or <literal>trace</literal>, or a more complicated logging expression.
104104+ description = lib.mdDoc ''
105105+ Log level to run with. This can be a simple log level like `error`
106106+ or `trace`, or a more complicated logging expression.
107107 '';
108108 };
109109110110 secrets = lib.mkOption {
111111 type = lib.types.path;
112112- description = ''
112112+ description = lib.mdDoc ''
113113 A file containing the various secrets. Should be in the format expected by systemd's
114114- <literal>EnvironmentFile</literal> directory. Two secrets are currently available:
115115- <literal>SYNC_MASTER_SECRET</literal> and
116116- <literal>SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET</literal>.
114114+ `EnvironmentFile` directory. Two secrets are currently available:
115115+ `SYNC_MASTER_SECRET` and
116116+ `SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET`.
117117 '';
118118 };
119119···126126127127 hostname = lib.mkOption {
128128 type = lib.types.str;
129129- description = ''
129129+ description = lib.mdDoc ''
130130 Host name to use for this service.
131131 '';
132132 };
···134134 capacity = lib.mkOption {
135135 type = lib.types.ints.unsigned;
136136 default = 10;
137137- description = ''
137137+ description = lib.mdDoc ''
138138 How many sync accounts are allowed on this server. Setting this value
139139 equal to or less than the number of currently active accounts will
140140 effectively deny service to accounts not yet registered here.
···147147 defaultText = lib.literalExpression ''
148148 ''${if cfg.singleNode.enableTLS then "https" else "http"}://''${config.${opt.singleNode.hostname}}
149149 '';
150150- description = ''
150150+ description = lib.mdDoc ''
151151 URL of the host. If you are not using the automatic webserver proxy setup you will have
152152 to change this setting or your sync server may not be functional.
153153 '';
···162162 port = lib.mkOption {
163163 type = lib.types.port;
164164 default = 5000;
165165- description = ''
165165+ description = lib.mdDoc ''
166166 Port to bind to.
167167 '';
168168 };
···170170 tokenserver.enabled = lib.mkOption {
171171 type = lib.types.bool;
172172 default = true;
173173- description = ''
173173+ description = lib.mdDoc ''
174174 Whether to enable the token service as well.
175175 '';
176176 };
177177 };
178178 };
179179 default = { };
180180- description = ''
180180+ description = lib.mdDoc ''
181181 Settings for the sync server. These take priority over values computed
182182 from NixOS options.
183183184184- See the doc comments on the <literal>Settings</literal> structs in
185185- <link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs" />
184184+ See the doc comments on the `Settings` structs in
185185+ <https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs>
186186 and
187187- <link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs" />
187187+ <https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs>
188188 for available options.
189189 '';
190190 };
+1-1
nixos/modules/services/networking/fireqos.nix
···1010 enable = mkOption {
1111 type = types.bool;
1212 default = false;
1313- description = ''
1313+ description = lib.mdDoc ''
1414 If enabled, FireQOS will be launched with the specified
1515 configuration given in `config`.
1616 '';
+3-3
nixos/modules/services/networking/ghostunnel.nix
···3737 };
38383939 keystore = mkOption {
4040- description = ''
4040+ description = lib.mdDoc ''
4141 Path to keystore (combined PEM with cert/key, or PKCS12 keystore).
42424343- NB: storepass is not supported because it would expose credentials via <literal>/proc/*/cmdline</literal>.
4343+ NB: storepass is not supported because it would expose credentials via `/proc/*/cmdline`.
44444545- Specify this or <literal>cert</literal> and <literal>key</literal>.
4545+ Specify this or `cert` and `key`.
4646 '';
4747 type = types.nullOr types.str;
4848 default = null;
+1-1
nixos/modules/services/networking/gnunet.nix
···123123 extraOptions = mkOption {
124124 type = types.lines;
125125 default = "";
126126- description = ''
126126+ description = lib.mdDoc ''
127127 Additional options that will be copied verbatim in `gnunet.conf'.
128128 See `gnunet.conf(5)' for details.
129129 '';
+1-1
nixos/modules/services/networking/headscale.nix
···216216 magicDns = mkOption {
217217 type = types.bool;
218218 default = true;
219219- description = ''
219219+ description = lib.mdDoc ''
220220 Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/).
221221 Only works if there is at least a nameserver defined.
222222 '';
···7777 };
78787979 extraConfigFile = mkOption {
8080- description = ''
8080+ description = lib.mdDoc ''
8181 Append an additional file's contents to `/etc/iscsid.conf`. Use a non-store path
8282 and store passwords in this file. Note: the file specified here must be available
8383 in the initrd, see: `boot.initrd.secrets`.
···9595 network.exit-node = [ "example.loki" "example2.loki" ];
9696 }
9797 '';
9898- description = ''
9898+ description = lib.mdDoc ''
9999 Configuration for Lokinet.
100100 Currently, the best way to view the available settings is by
101101 generating a config file using `lokinet -g`.
+1-1
nixos/modules/services/networking/monero.nix
···181181 exclusiveNodes = mkOption {
182182 type = types.listOf types.str;
183183 default = [ ];
184184- description = ''
184184+ description = lib.mdDoc ''
185185 List of peer IP addresses to connect to *only*.
186186 If given the other peer options will be ignored.
187187 '';
+1-1
nixos/modules/services/networking/murmur.nix
···219219 registerHostname = mkOption {
220220 type = types.str;
221221 default = "";
222222- description = ''
222222+ description = lib.mdDoc ''
223223 DNS hostname where your server can be reached. This is only
224224 needed if you want your server to be accessed by its
225225 hostname and not IP - but the name *must* resolve on the
+2-2
nixos/modules/services/networking/mxisd.nix
···4949 environmentFile = mkOption {
5050 type = types.nullOr types.str;
5151 default = null;
5252- description = ''
5252+ description = lib.mdDoc ''
5353 Path to an environment-file which may contain secrets to be
5454- substituted via <package>envsubst</package>.
5454+ substituted via `envsubst`.
5555 '';
5656 };
5757
+1-1
nixos/modules/services/networking/nar-serve.nix
···2323 cacheURL = mkOption {
2424 type = types.str;
2525 default = "https://cache.nixos.org/";
2626- description = ''
2626+ description = lib.mdDoc ''
2727 Binary cache URL to connect to.
28282929 The URL format is compatible with the nix remote url style, such as:
+2-2
nixos/modules/services/networking/ncdns.nix
···126126 description = ''
127127 Path to the file containing the KSK public key.
128128 The key can be generated using the <literal>dnssec-keygen</literal>
129129- command, provided by the package <package>bind</package> as follows:
129129+ command, provided by the package <literal>bind</literal> as follows:
130130 <programlisting>
131131 $ dnssec-keygen -a RSASHA256 -3 -b 2048 -f KSK bit
132132 </programlisting>
···147147 description = ''
148148 Path to the file containing the ZSK public key.
149149 The key can be generated using the <literal>dnssec-keygen</literal>
150150- command, provided by the package <package>bind</package> as follows:
150150+ command, provided by the package <literal>bind</literal> as follows:
151151 <programlisting>
152152 $ dnssec-keygen -a RSASHA256 -3 -b 2048 bit
153153 </programlisting>
+2-2
nixos/modules/services/networking/nix-serve.nix
···3939 The path to the file used for signing derivation data.
4040 Generate with:
41414242- ```
4242+ <programlisting>
4343 nix-store --generate-binary-cache-key key-name secret-key-file public-key-file
4444- ```
4444+ </programlisting>
45454646 For more details see <citerefentry><refentrytitle>nix-store</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
4747 '';
+1-1
nixos/modules/services/networking/nixops-dns.nix
···4040 dnsmasq = mkOption {
4141 type = types.bool;
4242 default = true;
4343- description = ''
4343+ description = lib.mdDoc ''
4444 Enable dnsmasq forwarding to nixops-dns. This allows to use
4545 nixops-dns for `services.nixops-dns.domain` resolution
4646 while forwarding the rest of the queries to original resolvers.
+1-1
nixos/modules/services/networking/ocserv.nix
···1515 config = mkOption {
1616 type = types.lines;
17171818- description = ''
1818+ description = lib.mdDoc ''
1919 Configuration content to start an OCServ server.
20202121 For a full configuration reference,please refer to the online documentation
+2-2
nixos/modules/services/networking/redsocks.nix
···3030 type = types.str;
3131 default = "stderr";
3232 description =
3333- ''
3333+ lib.mdDoc ''
3434 Where to send logs.
35353636 Possible values are:
···122122 "Forwarded_ipport" ];
123123 default = "false";
124124 description =
125125- ''
125125+ lib.mdDoc ''
126126 Way to disclose client IP to the proxy.
127127 - "false": do not disclose
128128 http-connect supports the following ways:
+9-9
nixos/modules/services/networking/resilio.nix
···199199 ];
200200 }
201201 ];
202202- description = ''
202202+ description = lib.mdDoc ''
203203 Shared folder list. If enabled, web UI must be
204204- disabled. Secrets can be generated using <literal>rslsync
205205- --generate-secret</literal>. Note that this secret will be
204204+ disabled. Secrets can be generated using `rslsync --generate-secret`.
205205+ Note that this secret will be
206206 put inside the Nix store, so it is realistically not very
207207 secret.
208208209209 If you would like to be able to modify the contents of this
210210 directories, it is recommended that you make your user a
211211- member of the <literal>rslsync</literal> group.
211211+ member of the `rslsync` group.
212212213213 Directories in this list should be in the
214214- <literal>rslsync</literal> group, and that group must have
214214+ `rslsync` group, and that group must have
215215 write access to the directory. It is also recommended that
216216- <literal>chmod g+s</literal> is applied to the directory
216216+ `chmod g+s` is applied to the directory
217217 so that any sub directories created will also belong to
218218- the <literal>rslsync</literal> group. Also,
219219- <literal>setfacl -d -m group:rslsync:rwx</literal> and
220220- <literal>setfacl -m group:rslsync:rwx</literal> should also
218218+ the `rslsync` group. Also,
219219+ `setfacl -d -m group:rslsync:rwx` and
220220+ `setfacl -m group:rslsync:rwx` should also
221221 be applied so that the sub directories are writable by
222222 the group.
223223 '';
+1-1
nixos/modules/services/networking/rpcbind.nix
···1313 enable = mkOption {
1414 type = types.bool;
1515 default = false;
1616- description = ''
1616+ description = lib.mdDoc ''
1717 Whether to enable `rpcbind', an ONC RPC directory service
1818 notably used by NFS and NIS, and which can be queried
1919 using the rpcinfo(1) command. `rpcbind` is a replacement for
+2-2
nixos/modules/services/networking/v2ray.nix
···5151 protocol = "freedom";
5252 }];
5353 };
5454- description = ''
5454+ description = lib.mdDoc ''
5555 The configuration object.
56565757 Either `configFile` or `config` must be specified.
58585959- See <link xlink:href="https://www.v2fly.org/en_US/config/overview.html"/>.
5959+ See <https://www.v2fly.org/en_US/config/overview.html>.
6060 '';
6161 };
6262 };
···189189 allowAuxiliaryImperativeNetworks = mkEnableOption "support for imperative & declarative networks" // {
190190 description = ''
191191 Whether to allow configuring networks "imperatively" (e.g. via
192192- <package>wpa_supplicant_gui</package>) and declaratively via
192192+ <literal>wpa_supplicant_gui</literal>) and declaratively via
193193 <xref linkend="opt-networking.wireless.networks"/>.
194194195195- Please note that this adds a custom patch to <package>wpa_supplicant</package>.
195195+ Please note that this adds a custom patch to <literal>wpa_supplicant</literal>.
196196 '';
197197 };
198198
+1-1
nixos/modules/services/networking/x2goserver.nix
···5050 settings = mkOption {
5151 type = types.attrsOf types.attrs;
5252 default = {};
5353- description = ''
5353+ description = lib.mdDoc ''
5454 x2goserver.conf ini configuration as nix attributes. See
5555 `x2goserver.conf(5)` for details
5656 '';
+9-10
nixos/modules/services/networking/yggdrasil.nix
···3131 "tcp://0.0.0.0:xxxxx"
3232 ];
3333 };
3434- description = ''
3434+ description = lib.mdDoc ''
3535 Configuration for yggdrasil, as a Nix attribute set.
36363737 Warning: this is stored in the WORLD-READABLE Nix store!
3838 Therefore, it is not appropriate for private keys. If you
3939- wish to specify the keys, use <option>configFile</option>.
3939+ wish to specify the keys, use {option}`configFile`.
40404141- If the <option>persistentKeys</option> is enabled then the
4141+ If the {option}`persistentKeys` is enabled then the
4242 keys that are generated during activation will override
4343- those in <option>config</option> or
4444- <option>configFile</option>.
4343+ those in {option}`config` or
4444+ {option}`configFile`.
45454646 If no keys are specified then ephemeral keys are generated
4747 and the Yggdrasil interface will have a random IPv6 address
4848 each time the service is started, this is the default.
49495050- If both <option>configFile</option> and <option>config</option>
5050+ If both {option}`configFile` and {option}`config`
5151 are supplied, they will be combined, with values from
5252- <option>configFile</option> taking precedence.
5252+ {option}`configFile` taking precedence.
53535454- You can use the command <literal>nix-shell -p yggdrasil --run
5555- "yggdrasil -genconf"</literal> to generate default
5656- configuration values with documentation.
5454+ You can use the command `nix-shell -p yggdrasil --run "yggdrasil -genconf"`
5555+ to generate default configuration values with documentation.
5756 '';
5857 };
5958
+4-4
nixos/modules/services/networking/znc/options.nix
···118118 type = types.listOf types.str;
119119 default = [ "webadmin" "adminlog" ];
120120 example = [ "partyline" "webadmin" "adminlog" "log" ];
121121- description = ''
121121+ description = lib.mdDoc ''
122122 A list of modules to include in the `znc.conf` file.
123123 '';
124124 };
···127127 type = types.listOf types.str;
128128 default = [ "chansaver" "controlpanel" ];
129129 example = [ "chansaver" "controlpanel" "fish" "push" ];
130130- description = ''
130130+ description = lib.mdDoc ''
131131 A list of user modules to include in the `znc.conf` file.
132132 '';
133133 };
···178178 '';
179179 type = types.str;
180180 description = ''
181181- Generate with `nix-shell -p znc --command "znc --makepass"`.
181181+ Generate with <command>nix-shell -p znc --command "znc --makepass"</command>.
182182 This is the password used to log in to the ZNC web admin interface.
183183 You can also set this through
184184 <option>services.znc.config.User.<username>.Pass.Method</option>
···216216 extraZncConf = mkOption {
217217 default = "";
218218 type = types.lines;
219219- description = ''
219219+ description = lib.mdDoc ''
220220 Extra config to `znc.conf` file.
221221 '';
222222 };
+1-1
nixos/modules/services/search/meilisearch.nix
···6868 };
69697070 logLevel = mkOption {
7171- description = ''
7171+ description = lib.mdDoc ''
7272 Defines how much detail should be present in MeiliSearch's logs.
7373 MeiliSearch currently supports four log levels, listed in order of increasing verbosity:
7474 - 'ERROR': only log unexpected events indicating MeiliSearch is not functioning as expected
+1-1
nixos/modules/services/security/fail2ban.nix
···7373 default = [];
7474 type = types.listOf types.package;
7575 example = lib.literalExpression "[ pkgs.ipset ]";
7676- description = ''
7676+ description = lib.mdDoc ''
7777 Extra packages to be made available to the fail2ban service. The example contains
7878 the packages needed by the `iptables-ipset-proto6` action.
7979 '';
···1010 enable = mkEnableOption "the Infinite Noise TRNG driver";
11111212 fillDevRandom = mkOption {
1313- description = ''
1313+ description = lib.mdDoc ''
1414 Whether to run the infnoise driver as a daemon to refill /dev/random.
15151616 If disabled, you can use the `infnoise` command-line tool to
+3-3
nixos/modules/services/security/oauth2_proxy.nix
···160160 domains = mkOption {
161161 type = types.listOf types.str;
162162 default = [];
163163- description = ''
163163+ description = lib.mdDoc ''
164164 Authenticate emails with the specified domains. Use
165165- <literal>*</literal> to authenticate any email.
165165+ `*` to authenticate any email.
166166 '';
167167 };
168168···347347 domain = mkOption {
348348 type = types.nullOr types.str;
349349 default = null;
350350- description = ''
350350+ description = lib.mdDoc ''
351351 Optional cookie domains to force cookies to (ie: `.yourcompany.com`).
352352 The longest domain matching the request's host will be used (or the shortest
353353 cookie domain if there is no match).
+5-5
nixos/modules/services/security/privacyidea.nix
···7575 description = ''
7676 File to load as environment file. Environment variables
7777 from this file will be interpolated into the config file
7878- using <package>envsubst</package> which is helpful for specifying
7878+ using <literal>envsubst</literal> which is helpful for specifying
7979 secrets:
8080 <programlisting>
8181 { <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; }
···204204 settings = mkOption {
205205 type = with types; attrsOf (attrsOf (oneOf [ str bool int (listOf str) ]));
206206 default = {};
207207- description = ''
208208- Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>.
207207+ description = lib.mdDoc ''
208208+ Attribute-set containing the settings for `privacyidea-ldap-proxy`.
209209 It's possible to pass secrets using env-vars as substitutes and
210210- use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile"/>
211211- to inject them via <package>envsubst</package>.
210210+ use the option [](#opt-services.privacyidea.ldap-proxy.environmentFile)
211211+ to inject them via `envsubst`.
212212 '';
213213 };
214214
+2-2
nixos/modules/services/system/cloud-init.nix
···3939 btrfs.enable = mkOption {
4040 type = types.bool;
4141 default = false;
4242- description = ''
4242+ description = lib.mdDoc ''
4343 Allow the cloud-init service to operate `btrfs` filesystem.
4444 '';
4545 };
···4747 ext4.enable = mkOption {
4848 type = types.bool;
4949 default = true;
5050- description = ''
5050+ description = lib.mdDoc ''
5151 Allow the cloud-init service to operate `ext4` filesystem.
5252 '';
5353 };
+6-6
nixos/modules/services/system/self-deploy.nix
···41414242 default = null;
43434444- description = ''
4444+ description = lib.mdDoc ''
4545 Attribute of `nixFile` that builds the current system.
4646 '';
4747 };
···51515252 default = { };
53535454- description = ''
5454+ description = lib.mdDoc ''
5555 Arguments to `nix-build` passed as `--argstr` or `--arg` depending on
5656 the type.
5757 '';
···62626363 default = "switch";
64646565- description = ''
6565+ description = lib.mdDoc ''
6666 The `switch-to-configuration` subcommand used.
6767 '';
6868 };
···7070 repository = lib.mkOption {
7171 type = with lib.types; oneOf [ path str ];
72727373- description = ''
7373+ description = lib.mdDoc ''
7474 The repository to fetch from. Must be properly formatted for git.
75757676 If this value is set to a path (must begin with `/`) then it's
···9999100100 default = "master";
101101102102- description = ''
102102+ description = lib.mdDoc ''
103103 Branch to track
104104105105 Technically speaking any ref can be specified here, as this is
···113113114114 default = "hourly";
115115116116- description = ''
116116+ description = lib.mdDoc ''
117117 The schedule on which to run the `self-deploy` service. Format
118118 specified by `systemd.time 7`.
119119
+5-5
nixos/modules/services/torrent/magnetico.nix
···124124 Usernames must start with a lowercase ([a-z]) ASCII character, might
125125 contain non-consecutive underscores except at the end, and consists of
126126 small-case a-z characters and digits 0-9. The
127127- <command>htpasswd</command> tool from the <package>apacheHttpd
128128- </package> package may be used to generate the hash: <command>htpasswd
129129- -bnBC 12 username password</command>
127127+ <command>htpasswd</command> tool from the <literal>apacheHttpd</literal>
128128+ package may be used to generate the hash:
129129+ <command>htpasswd -bnBC 12 username password</command>
130130131131 <warning>
132132 <para>
···150150 start with a lowecase ([a-z]) ASCII character, might contain
151151 non-consecutive underscores except at the end, and consists of
152152 small-case a-z characters and digits 0-9.
153153- The <command>htpasswd</command> tool from the <package>apacheHttpd
154154- </package> package may be used to generate the hash:
153153+ The <command>htpasswd</command> tool from the <literal>apacheHttpd</literal>
154154+ package may be used to generate the hash:
155155 <command>htpasswd -bnBC 12 username password</command>
156156 '';
157157 };
+10-13
nixos/modules/services/web-apps/discourse.nix
···121121 max_reqs_per_ip_mode = "warn+block";
122122 };
123123 '';
124124- description = ''
124124+ description = lib.mdDoc ''
125125 Additional settings to put in the
126126- <filename>discourse.conf</filename> file.
126126+ {file}`discourse.conf` file.
127127128128 Look in the
129129- <link xlink:href="https://github.com/discourse/discourse/blob/master/config/discourse_defaults.conf">discourse_defaults.conf</link>
129129+ [discourse_defaults.conf](https://github.com/discourse/discourse/blob/master/config/discourse_defaults.conf)
130130 file in the upstream distribution to find available options.
131131132132- Setting an option to <literal>null</literal> means
133133- <quote>define variable, but leave right-hand side
134134- empty</quote>.
132132+ Setting an option to `null` means
133133+ “define variable, but leave right-hand side empty”.
135134 '';
136135 };
137136···241240 host = lib.mkOption {
242241 type = with lib.types; nullOr str;
243242 default = null;
244244- description = ''
245245- Discourse database hostname. <literal>null</literal> means <quote>prefer
246246- local unix socket connection</quote>.
243243+ description = lib.mdDoc ''
244244+ Discourse database hostname. `null` means
245245+ “prefer local unix socket connection”.
247246 '';
248247 };
249248···494493 discourse-github
495494 ];
496495 '';
497497- description = ''
498498- Plugins to install as part of
499499- <productname>Discourse</productname>, expressed as a list of
500500- derivations.
496496+ description = lib.mdDoc ''
497497+ Plugins to install as part of Discourse, expressed as a list of derivations.
501498 '';
502499 };
503500
+9-9
nixos/modules/services/web-apps/hedgedoc.nix
···189189 allowAnonymousEdits = mkOption {
190190 type = types.bool;
191191 default = false;
192192- description = ''
193193- Whether to allow guests to edit existing notes with the `freely' permission,
194194- when <option>allowAnonymous</option> is enabled.
192192+ description = lib.mdDoc ''
193193+ Whether to allow guests to edit existing notes with the `freely` permission,
194194+ when {option}`allowAnonymous` is enabled.
195195 '';
196196 };
197197 allowFreeURL = mkOption {
···937937 id = mkOption {
938938 type = types.str;
939939 default = "";
940940- description = ''
940940+ description = lib.mdDoc ''
941941 Attribute map for `id'.
942942 Defaults to `NameID' of SAML response.
943943 '';
···945945 username = mkOption {
946946 type = types.str;
947947 default = "";
948948- description = ''
948948+ description = lib.mdDoc ''
949949 Attribute map for `username'.
950950 Defaults to `NameID' of SAML response.
951951 '';
···953953 email = mkOption {
954954 type = types.str;
955955 default = "";
956956- description = ''
957957- Attribute map for `email'.
958958- Defaults to `NameID' of SAML response if
959959- <option>identifierFormat</option> has
956956+ description = lib.mdDoc ''
957957+ Attribute map for `email`.
958958+ Defaults to `NameID` of SAML response if
959959+ {option}`identifierFormat` has
960960 the default value.
961961 '';
962962 };
+3-3
nixos/modules/services/web-apps/invidious.nix
···246246 nginx.enable = lib.mkOption {
247247 type = types.bool;
248248 default = false;
249249- description = ''
249249+ description = lib.mdDoc ''
250250 Whether to configure nginx as a reverse proxy for Invidious.
251251252252- It serves it under the domain specified in <option>services.invidious.settings.domain</option> with enabled TLS and ACME.
253253- Further configuration can be done through <option>services.nginx.virtualHosts.''${config.services.invidious.settings.domain}.*</option>,
252252+ It serves it under the domain specified in {option}`services.invidious.settings.domain` with enabled TLS and ACME.
253253+ Further configuration can be done through {option}`services.nginx.virtualHosts.''${config.services.invidious.settings.domain}.*`,
254254 which can also be used to disable AMCE and TLS.
255255 '';
256256 };
+3-3
nixos/modules/services/web-apps/isso.nix
···2020 '';
21212222 settings = mkOption {
2323- description = ''
2424- Configuration for <package>isso</package>.
2323+ description = lib.mdDoc ''
2424+ Configuration for `isso`.
25252626- See <link xlink:href="https://posativ.org/isso/docs/configuration/server/">Isso Server Configuration</link>
2626+ See [Isso Server Configuration](https://posativ.org/isso/docs/configuration/server/)
2727 for supported values.
2828 '';
2929
+6-6
nixos/modules/services/web-apps/mastodon.nix
···130130 };
131131132132 user = lib.mkOption {
133133- description = ''
133133+ description = lib.mdDoc ''
134134 User under which mastodon runs. If it is set to "mastodon",
135135 that user will be created, otherwise it should be set to the
136136 name of a user created elsewhere. In both cases,
137137- <package>mastodon</package> and a package containing only
138138- the shell script <literal>mastodon-env</literal> will be added to
137137+ `mastodon` and a package containing only
138138+ the shell script `mastodon-env` will be added to
139139 the user's package set. To run a command from
140140- <package>mastodon</package> such as <literal>tootctl</literal>
140140+ `mastodon` such as `tootctl`
141141 with the environment configured by this module use
142142- <literal>mastodon-env</literal>, as in:
142142+ `mastodon-env`, as in:
143143144144- <literal>mastodon-env tootctl accounts create newuser --email newuser@example.com</literal>
144144+ `mastodon-env tootctl accounts create newuser --email newuser@example.com`
145145 '';
146146 type = lib.types.str;
147147 default = "mastodon";
+1-1
nixos/modules/services/web-apps/matomo.nix
···5757 Name of the web server user that forwards requests to <option>services.phpfpm.pools.<name>.socket</option> the fastcgi socket for Matomo if the nginx
5858 option is not used. Either this option or the nginx option is mandatory.
5959 If you want to use another webserver than nginx, you need to set this to that server's user
6060- and pass fastcgi requests to `index.php`, `matomo.php` and `piwik.php` (legacy name) to this socket.
6060+ and pass fastcgi requests to <literal>index.php</literal>, <literal>matomo.php</literal> and <literal>piwik.php</literal> (legacy name) to this socket.
6161 '';
6262 };
6363
+1-1
nixos/modules/services/web-apps/moodle.nix
···138138 createLocally = mkOption {
139139 type = types.bool;
140140 default = true;
141141- description = "Create the database and database user locally.";
141141+ description = lib.mdDoc "Create the database and database user locally.";
142142 };
143143 };
144144
+4-4
nixos/modules/services/web-apps/nextcloud.nix
···532532 here because it has the side-effect that personal information is even accessible to
533533 unauthenticated users by default.
534534535535- By default, the following properties are set to <quote>Show to everyone</quote>
535535+ By default, the following properties are set to “Show to everyone”
536536 if this flag is enabled:
537537 <itemizedlist>
538538 <listitem><para>About</para></listitem>
···569569 secretFile = mkOption {
570570 type = types.nullOr types.str;
571571 default = null;
572572- description = ''
572572+ description = lib.mdDoc ''
573573 Secret options which will be appended to nextcloud's config.php file (written as JSON, in the same
574574- form as the <xref linkend="opt-services.nextcloud.extraOptions"/> option), for example
575575- <programlisting>{"redis":{"password":"secret"}}</programlisting>.
574574+ form as the [](#opt-services.nextcloud.extraOptions) option), for example
575575+ `{"redis":{"password":"secret"}}`.
576576 '';
577577 };
578578
+1-1
nixos/modules/services/web-apps/nexus.nix
···9393 '''
9494 '';
95959696- description = ''
9696+ description = lib.mdDoc ''
9797 Options for the JVM written to `nexus.jvmopts`.
9898 Please refer to the docs (https://help.sonatype.com/repomanager3/installation/configuring-the-runtime-environment)
9999 for further information.
···2424 default = pkgs.pgpkeyserver-lite;
2525 defaultText = literalExpression "pkgs.pgpkeyserver-lite";
2626 type = types.package;
2727- description = "
2727+ description = lib.mdDoc ''
2828 Which webgui derivation to use.
2929- ";
2929+ '';
3030 };
31313232 hostname = mkOption {
3333 type = types.str;
3434- description = "
3434+ description = lib.mdDoc ''
3535 Which hostname to set the vHost to that is proxying to sks.
3636- ";
3636+ '';
3737 };
38383939 hkpAddress = mkOption {
4040 default = builtins.head sksCfg.hkpAddress;
4141 defaultText = literalExpression "head config.${sksOpt.hkpAddress}";
4242 type = types.str;
4343- description = "
4343+ description = lib.mdDoc ''
4444 Wich ip address the sks-keyserver is listening on.
4545- ";
4545+ '';
4646 };
47474848 hkpPort = mkOption {
4949 default = sksCfg.hkpPort;
5050 defaultText = literalExpression "config.${sksOpt.hkpPort}";
5151 type = types.int;
5252- description = "
5252+ description = lib.mdDoc ''
5353 Which port the sks-keyserver is listening on.
5454- ";
5454+ '';
5555 };
5656 };
5757 };
+4-4
nixos/modules/services/web-apps/plausible.nix
···4949 url = mkOption {
5050 default = "http://localhost:8123/default";
5151 type = types.str;
5252- description = ''
5353- The URL to be used to connect to <package>clickhouse</package>.
5252+ description = lib.mdDoc ''
5353+ The URL to be used to connect to `clickhouse`.
5454 '';
5555 };
5656 };
···6666 socket = mkOption {
6767 default = "/run/postgresql";
6868 type = types.str;
6969- description = ''
7070- Path to the UNIX domain-socket to communicate with <package>postgres</package>.
6969+ description = lib.mdDoc ''
7070+ Path to the UNIX domain-socket to communicate with `postgres`.
7171 '';
7272 };
7373 };
+2-2
nixos/modules/services/web-apps/rss-bridge.nix
···6666 "Twitter"
6767 ]
6868 '';
6969- description = ''
6969+ description = lib.mdDoc ''
7070 List of bridges to be whitelisted.
7171 If the list is empty, rss-bridge will use whitelist.default.txt.
7272- Use <literal>[ "*" ]</literal> to whitelist all.
7272+ Use `[ "*" ]` to whitelist all.
7373 '';
7474 };
7575 };
+4-4
nixos/modules/services/web-apps/wiki-js.nix
···5454 type = mkOption {
5555 default = "postgres";
5656 type = types.enum [ "postgres" "mysql" "mariadb" "mssql" ];
5757- description = ''
5858- Database driver to use for persistence. Please note that <literal>sqlite</literal>
5757+ description = lib.mdDoc ''
5858+ Database driver to use for persistence. Please note that `sqlite`
5959 is currently not supported as the build process for it is currently not implemented
6060- in <package>pkgs.wiki-js</package> and it's not recommended by upstream for
6060+ in `pkgs.wiki-js` and it's not recommended by upstream for
6161 production use.
6262 '';
6363 };
···9494 };
9595 };
9696 description = ''
9797- Settings to configure <package>wiki-js</package>. This directly
9797+ Settings to configure <literal>wiki-js</literal>. This directly
9898 corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream configuration options</link>.
9999100100 Secrets can be injected via the environment by
···4343 priority = mkOption {
4444 type = types.int;
4545 default = 1000;
4646- description = ''
4646+ description = lib.mdDoc ''
4747 Order of this location block in relation to the others in the vhost.
4848 The semantics are the same as with `lib.mkOrder`. Smaller values have
4949 a greater priority.
+1-1
nixos/modules/services/web-servers/darkhttpd.nix
···2929 address = mkOption {
3030 default = "127.0.0.1";
3131 type = str;
3232- description = ''
3232+ description = lib.mdDoc ''
3333 Address to listen on.
3434 Pass `all` to listen on all interfaces.
3535 '';
···122122 priority = mkOption {
123123 type = types.int;
124124 default = 1000;
125125- description = ''
125125+ description = lib.mdDoc ''
126126 Order of this location block in relation to the others in the vhost.
127127 The semantics are the same as with `lib.mkOrder`. Smaller values have
128128 a greater priority.
···197197 http3 = mkOption {
198198 type = types.bool;
199199 default = false;
200200- description = ''
200200+ description = lib.mdDoc ''
201201 Whether to enable HTTP 3.
202202- This requires using <literal>pkgs.nginxQuic</literal> package
203203- which can be achieved by setting <literal>services.nginx.package = pkgs.nginxQuic;</literal>.
202202+ This requires using `pkgs.nginxQuic` package
203203+ which can be achieved by setting `services.nginx.package = pkgs.nginxQuic;`.
204204 Note that HTTP 3 support is experimental and
205205 *not* yet recommended for production.
206206 Read more at https://quic.nginx.org/
+4-4
nixos/modules/services/web-servers/tomcat.nix
···3434 purifyOnStart = mkOption {
3535 type = types.bool;
3636 default = false;
3737- description = ''
3737+ description = lib.mdDoc ''
3838 On startup, the `baseDir` directory is populated with various files,
3939 subdirectories and symlinks. If this option is enabled, these items
4040 (except for the `logs` and `work` subdirectories) are first removed.
···4646 baseDir = mkOption {
4747 type = lib.types.path;
4848 default = "/var/tomcat";
4949- description = ''
4949+ description = lib.mdDoc ''
5050 Location where Tomcat stores configuration files, web applications
5151 and logfiles. Note that it is partially cleared on each service startup
5252 if `purifyOnStart` is enabled.
···112112 serverXml = mkOption {
113113 type = types.lines;
114114 default = "";
115115- description = "
115115+ description = lib.mdDoc ''
116116 Verbatim server.xml configuration.
117117 This is mutually exclusive with the virtualHosts options.
118118- ";
118118+ '';
119119 };
120120121121 commonLibs = mkOption {
···88 services.xserver.desktopManager.runXdgAutostartIfNone = mkOption {
99 type = types.bool;
1010 default = false;
1111- description = ''
1111+ description = lib.mdDoc ''
1212 Whether to run XDG autostart files for sessions without a desktop manager
1313 (with only a window manager), these sessions usually don't handle XDG
1414 autostart files by default.
15151616- Some services like <option>i18n.inputMethod</option> and
1717- <option>service.earlyoom</option> use XDG autostart files to start.
1818- If this option is not set to <literal>true</literal> and you are using
1616+ Some services like {option}`i18n.inputMethod` and
1717+ {option}`service.earlyoom` use XDG autostart files to start.
1818+ If this option is not set to `true` and you are using
1919 a window manager without a desktop manager, you need to manually start
2020- them or running <package>dex</package> somewhere.
2020+ them or running `dex` somewhere.
2121 '';
2222 };
2323 };
···9292 Whether this activation script supports being dry-activated.
9393 These activation scripts will also be executed on dry-activate
9494 activations with the environment variable
9595- <literal>NIXOS_ACTION</literal> being set to <literal>dry-activate
9696- </literal>. it's important that these activation scripts don't
9595+ <literal>NIXOS_ACTION</literal> being set to <literal>dry-activate</literal>.
9696+ it's important that these activation scripts don't
9797 modify anything about the system when the variable is set.
9898 '';
9999 };
+1-1
nixos/modules/system/boot/kernel_config.nix
···9191 USB? y
9292 DEBUG n
9393 '';
9494- description = ''
9494+ description = lib.mdDoc ''
9595 The result of converting the structured kernel configuration in settings
9696 to an intermediate string that can be parsed by generate-config.pl to
9797 answer the kernel `make defconfig`.
+3-3
nixos/modules/system/boot/luksroot.nix
···532532 boot.initrd.luks.reusePassphrases = mkOption {
533533 type = types.bool;
534534 default = true;
535535- description = ''
535535+ description = lib.mdDoc ''
536536 When opening a new LUKS device try reusing last successful
537537 passphrase.
538538539539 Useful for mounting a number of devices that use the same
540540 passphrase without retyping it several times.
541541542542- Such setup can be useful if you use <command>cryptsetup
543543- luksSuspend</command>. Different LUKS devices will still have
542542+ Such setup can be useful if you use {command}`cryptsetup luksSuspend`.
543543+ Different LUKS devices will still have
544544 different master keys even when using the same passphrase.
545545 '';
546546 };
+3-3
nixos/modules/tasks/auto-upgrade.nix
···4646 type = types.nullOr types.str;
4747 default = null;
4848 example = "https://nixos.org/channels/nixos-14.12-small";
4949- description = ''
4949+ description = lib.mdDoc ''
5050 The URI of the NixOS channel to use for automatic
5151 upgrades. By default, this is the channel set using
5252- <command>nix-channel</command> (run <literal>nix-channel
5353- --list</literal> to see the current value).
5252+ {command}`nix-channel` (run `nix-channel --list`
5353+ to see the current value).
5454 '';
5555 };
5656
+11-12
nixos/modules/tasks/filesystems.nix
···175175 }
176176 '';
177177 type = types.attrsOf (types.submodule [coreFileSystemOpts fileSystemOpts]);
178178- description = ''
178178+ description = lib.mdDoc ''
179179 The file systems to be mounted. It must include an entry for
180180- the root directory (<literal>mountPoint = "/"</literal>). Each
180180+ the root directory (`mountPoint = "/"`). Each
181181 entry in the list is an attribute set with the following fields:
182182- <literal>mountPoint</literal>, <literal>device</literal>,
183183- <literal>fsType</literal> (a file system type recognised by
184184- <command>mount</command>; defaults to
185185- <literal>"auto"</literal>), and <literal>options</literal>
186186- (the mount options passed to <command>mount</command> using the
187187- <option>-o</option> flag; defaults to <literal>[ "defaults" ]</literal>).
182182+ `mountPoint`, `device`,
183183+ `fsType` (a file system type recognised by
184184+ {command}`mount`; defaults to
185185+ `"auto"`), and `options`
186186+ (the mount options passed to {command}`mount` using the
187187+ {option}`-o` flag; defaults to `[ "defaults" ]`).
188188189189- Instead of specifying <literal>device</literal>, you can also
190190- specify a volume label (<literal>label</literal>) for file
191191- systems that support it, such as ext2/ext3 (see <command>mke2fs
192192- -L</command>).
189189+ Instead of specifying `device`, you can also
190190+ specify a volume label (`label`) for file
191191+ systems that support it, such as ext2/ext3 (see {command}`mke2fs -L`).
193192 '';
194193 };
195194
+1-1
nixos/modules/tasks/filesystems/zfs.nix
···426426 type = types.either (types.enum [ "disabled" "all" ]) (types.listOf types.str);
427427 default = "disabled";
428428 example = [ "tank" "dozer" ];
429429- description = ''
429429+ description = lib.mdDoc ''
430430 After importing, expand each device in the specified pools.
431431432432 Set the value to the plain string "all" to expand all pools on boot:
+4-4
nixos/modules/tasks/network-interfaces.nix
···785785 default = null;
786786 example = "fast";
787787 type = types.nullOr types.str;
788788- description = ''
788788+ description = lib.mdDoc ''
789789 DEPRECATED, use `driverOptions`.
790790 Option specifying the rate in which we'll ask our link partner
791791 to transmit LACPDU packets in 802.3ad mode.
···796796 default = null;
797797 example = 100;
798798 type = types.nullOr types.int;
799799- description = ''
799799+ description = lib.mdDoc ''
800800 DEPRECATED, use `driverOptions`.
801801 Miimon is the number of millisecond in between each round of polling
802802 by the device driver for failed links. By default polling is not
···809809 default = null;
810810 example = "active-backup";
811811 type = types.nullOr types.str;
812812- description = ''
812812+ description = lib.mdDoc ''
813813 DEPRECATED, use `driverOptions`.
814814 The mode which the bond will be running. The default mode for
815815 the bonding driver is balance-rr, optimizing for throughput.
···822822 default = null;
823823 example = "layer2+3";
824824 type = types.nullOr types.str;
825825- description = ''
825825+ description = lib.mdDoc ''
826826 DEPRECATED, use `driverOptions`.
827827 Selects the transmit hash policy to use for slave selection in
828828 balance-xor, 802.3ad, and tlb modes.
+1-1
nixos/modules/virtualisation/amazon-options.nix
···1414 };
15151616 datasets = lib.mkOption {
1717- description = ''
1717+ description = lib.mdDoc ''
1818 Datasets to create under the `tank` and `boot` zpools.
19192020 **NOTE:** This option is used only at image creation time, and
+1-1
nixos/modules/virtualisation/azure-image.nix
···1212 type = with types; either (enum [ "auto" ]) int;
1313 default = "auto";
1414 example = 2048;
1515- description = ''
1515+ description = lib.mdDoc ''
1616 Size of disk image. Unit is MB.
1717 '';
1818 };
···2121 type = with types; either (enum [ "auto" ]) int;
2222 default = "auto";
2323 example = 1536;
2424- description = ''
2424+ description = lib.mdDoc ''
2525 Size of disk image. Unit is MB.
2626 '';
2727 };
···2929 virtualisation.googleComputeImage.configFile = mkOption {
3030 type = with types; nullOr str;
3131 default = null;
3232- description = ''
3232+ description = lib.mdDoc ''
3333 A path to a configuration file which will be placed at `/etc/nixos/configuration.nix`
3434 and be used when switching to a new configuration.
3535 If set to `null`, a default configuration is used, where the only import is
···4040 virtualisation.googleComputeImage.compressionLevel = mkOption {
4141 type = types.int;
4242 default = 6;
4343- description = ''
4343+ description = lib.mdDoc ''
4444 GZIP compression level of the resulting disk image (1-9).
4545 '';
4646 };
+3-3
nixos/modules/virtualisation/hyperv-image.nix
···1212 type = with types; either (enum [ "auto" ]) int;
1313 default = "auto";
1414 example = 2048;
1515- description = ''
1515+ description = lib.mdDoc ''
1616 The size of the hyper-v base image in MiB.
1717 '';
1818 };
1919 vmDerivationName = mkOption {
2020 type = types.str;
2121 default = "nixos-hyperv-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
2222- description = ''
2222+ description = lib.mdDoc ''
2323 The name of the derivation for the hyper-v appliance.
2424 '';
2525 };
2626 vmFileName = mkOption {
2727 type = types.str;
2828 default = "nixos-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.vhdx";
2929- description = ''
2929+ description = lib.mdDoc ''
3030 The file name of the hyper-v appliance.
3131 '';
3232 };
+4-4
nixos/modules/virtualisation/kvmgt.nix
···1010 vgpuOptions = {
1111 uuid = mkOption {
1212 type = with types; listOf str;
1313- description = "UUID(s) of VGPU device. You can generate one with <package>libossp_uuid</package>.";
1313+ description = lib.mdDoc "UUID(s) of VGPU device. You can generate one with `libossp_uuid`.";
1414 };
1515 };
1616···3131 vgpus = mkOption {
3232 default = {};
3333 type = with types; attrsOf (submodule [ { options = vgpuOptions; } ]);
3434- description = ''
3535- Virtual GPUs to be used in Qemu. You can find devices via <command>ls /sys/bus/pci/devices/*/mdev_supported_types</command>
3636- and find info about device via <command>cat /sys/bus/pci/devices/*/mdev_supported_types/i915-GVTg_V5_4/description</command>
3434+ description = lib.mdDoc ''
3535+ Virtual GPUs to be used in Qemu. You can find devices via {command}`ls /sys/bus/pci/devices/*/mdev_supported_types`
3636+ and find info about device via {command}`cat /sys/bus/pci/devices/*/mdev_supported_types/i915-GVTg_V5_4/description`
3737 '';
3838 example = {
3939 i915-GVTg_V5_8.uuid = [ "a297db4a-f4c2-11e6-90f6-d3b88d6c9525" ];
+1-1
nixos/modules/virtualisation/libvirtd.nix
···8181 type = types.package;
8282 default = pkgs.qemu;
8383 defaultText = literalExpression "pkgs.qemu";
8484- description = ''
8484+ description = lib.mdDoc ''
8585 Qemu package to use with libvirt.
8686 `pkgs.qemu` can emulate alien architectures (e.g. aarch64 on x86)
8787 `pkgs.qemu_kvm` saves disk space allowing to emulate only host architectures.
+2-3
nixos/modules/virtualisation/lxc.nix
···5353 type = types.lines;
5454 default = "";
5555 description =
5656- ''
5656+ lib.mdDoc ''
5757 This is the config file for managing unprivileged user network
5858- administration access in LXC. See <citerefentry><refentrytitle>lxc-usernet</refentrytitle><manvolnum>5</manvolnum>
5959- </citerefentry>.
5858+ administration access in LXC. See {manpage}`lxc-usernet(5)`.
6059 '';
6160 };
6261 };
+5-5
nixos/modules/virtualisation/nixos-containers.nix
···536536 type = types.path;
537537 default = pkgs.path;
538538 defaultText = literalExpression "pkgs.path";
539539- description = ''
539539+ description = lib.mdDoc ''
540540 A path to the nixpkgs that provide the modules, pkgs and lib for evaluating the container.
541541542542- To only change the <literal>pkgs</literal> argument used inside the container modules,
543543- set the <literal>nixpkgs.*</literal> options in the container <option>config</option>.
544544- Setting <literal>config.nixpkgs.pkgs = pkgs</literal> speeds up the container evaluation
545545- by reusing the system pkgs, but the <literal>nixpkgs.config</literal> option in the
542542+ To only change the `pkgs` argument used inside the container modules,
543543+ set the `nixpkgs.*` options in the container {option}`config`.
544544+ Setting `config.nixpkgs.pkgs = pkgs` speeds up the container evaluation
545545+ by reusing the system pkgs, but the `nixpkgs.config` option in the
546546 container config is ignored in this case.
547547 '';
548548 };
···1515 };
16161717 datasets = lib.mkOption {
1818- description = ''
1818+ description = lib.mdDoc ''
1919 Datasets to create under the `tank` and `boot` zpools.
20202121 **NOTE:** This option is used only at image creation time, and
+1-1
nixos/modules/virtualisation/parallels-guest.nix
···2323 autoMountShares = mkOption {
2424 type = types.bool;
2525 default = true;
2626- description = ''
2626+ description = lib.mdDoc ''
2727 Control prlfsmountd service. When this service is running, shares can not be manually
2828 mounted through `mount -t prl_fs ...` as this service will remount and trample any set options.
2929 Recommended to enable for simple file sharing, but extended share use such as for code should
···1717 enable = mkOption {
1818 type = types.bool;
1919 default = false;
2020- description = ''
2020+ description = lib.mdDoc ''
2121 Make the Podman and Docker compatibility API available over the network
2222 with TLS client certificate authentication.
23232424 This allows Docker clients to connect with the equivalents of the Docker
2525- CLI <literal>-H</literal> and <literal>--tls*</literal> family of options.
2525+ CLI `-H` and `--tls*` family of options.
26262727 For certificate setup, see https://docs.docker.com/engine/security/protect-access/
28282929- This option is independent of <xref linkend="opt-virtualisation.podman.dockerSocket.enable"/>.
2929+ This option is independent of [](#opt-virtualisation.podman.dockerSocket.enable).
3030 '';
3131 };
3232
+13-13
nixos/modules/virtualisation/proxmox-image.nix
···1010 type = types.str;
1111 default = "";
1212 example = "order=scsi0;net0";
1313- description = ''
1313+ description = lib.mdDoc ''
1414 Default boot device. PVE will try all devices in its default order if this value is empty.
1515 '';
1616 };
···1818 type = types.str;
1919 default = "virtio-scsi-pci";
2020 example = "lsi";
2121- description = ''
2121+ description = lib.mdDoc ''
2222 SCSI controller type. Must be one of the supported values given in
2323- <link xlink:href="https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines"/>
2323+ <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
2424 '';
2525 };
2626 virtio0 = mkOption {
2727 type = types.str;
2828 default = "local-lvm:vm-9999-disk-0";
2929 example = "ceph:vm-123-disk-0";
3030- description = ''
3030+ description = lib.mdDoc ''
3131 Configuration for the default virtio disk. It can be used as a cue for PVE to autodetect the target sotrage.
3232 This parameter is required by PVE even if it isn't used.
3333 '';
···3535 ostype = mkOption {
3636 type = types.str;
3737 default = "l26";
3838- description = ''
3838+ description = lib.mdDoc ''
3939 Guest OS type
4040 '';
4141 };
4242 cores = mkOption {
4343 type = types.ints.positive;
4444 default = 1;
4545- description = ''
4545+ description = lib.mdDoc ''
4646 Guest core count
4747 '';
4848 };
4949 memory = mkOption {
5050 type = types.ints.positive;
5151 default = 1024;
5252- description = ''
5252+ description = lib.mdDoc ''
5353 Guest memory in MB
5454 '';
5555 };
···5858 name = mkOption {
5959 type = types.str;
6060 default = "nixos-${config.system.nixos.label}";
6161- description = ''
6161+ description = lib.mdDoc ''
6262 VM name
6363 '';
6464 };
6565 net0 = mkOption {
6666 type = types.commas;
6767 default = "virtio=00:00:00:00:00:00,bridge=vmbr0,firewall=1";
6868- description = ''
6868+ description = lib.mdDoc ''
6969 Configuration for the default interface. When restoring from VMA, check the
7070 "unique" box to ensure device mac is randomized.
7171 '';
···7474 type = types.str;
7575 default = "socket";
7676 example = "/dev/ttyS0";
7777- description = ''
7777+ description = lib.mdDoc ''
7878 Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0),
7979 or create a unix socket on the host side (use qm terminal to open a terminal connection).
8080 '';
···8383 type = types.bool;
8484 apply = x: if x then "1" else "0";
8585 default = true;
8686- description = ''
8686+ description = lib.mdDoc ''
8787 Expect guest to have qemu agent running
8888 '';
8989 };
···9595 cpu = "host";
9696 onboot = 1;
9797 }'';
9898- description = ''
9898+ description = lib.mdDoc ''
9999 Additional options appended to qemu-server.conf
100100 '';
101101 };
···103103 type = types.str;
104104 default = config.proxmox.qemuConf.name;
105105 example = "999-nixos_template";
106106- description = ''
106106+ description = lib.mdDoc ''
107107 Filename of the image will be vzdump-qemu-''${filenameSuffix}.vma.zstd.
108108 This will also determine the default name of the VM on restoring the VMA.
109109 Start this value with a number if you want the VMA to be detected as a backup of
+4-4
nixos/modules/virtualisation/qemu-vm.nix
···739739 type = types.nullOr types.package;
740740 default = null;
741741 description =
742742- ''
743743- An alternate BIOS (such as <package>qboot</package>) with which to start the VM.
744744- Should contain a file named <literal>bios.bin</literal>.
745745- If <literal>null</literal>, QEMU's builtin SeaBIOS will be used.
742742+ lib.mdDoc ''
743743+ An alternate BIOS (such as `qboot`) with which to start the VM.
744744+ Should contain a file named `bios.bin`.
745745+ If `null`, QEMU's builtin SeaBIOS will be used.
746746 '';
747747 };
748748
+5-5
nixos/modules/virtualisation/vmware-image.nix
···2121 type = with types; either (enum [ "auto" ]) int;
2222 default = "auto";
2323 example = 2048;
2424- description = ''
2424+ description = lib.mdDoc ''
2525 The size of the VMWare base image in MiB.
2626 '';
2727 };
2828 vmDerivationName = mkOption {
2929 type = types.str;
3030 default = "nixos-vmware-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
3131- description = ''
3131+ description = lib.mdDoc ''
3232 The name of the derivation for the VMWare appliance.
3333 '';
3434 };
3535 vmFileName = mkOption {
3636 type = types.str;
3737 default = "nixos-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.vmdk";
3838- description = ''
3838+ description = lib.mdDoc ''
3939 The file name of the VMWare appliance.
4040 '';
4141 };
4242 vmSubformat = mkOption {
4343 type = types.enum subformats;
4444 default = "monolithicSparse";
4545- description = "Specifies which VMDK subformat to use.";
4545+ description = lib.mdDoc "Specifies which VMDK subformat to use.";
4646 };
4747 vmCompat6 = mkOption {
4848 type = types.bool;
4949 default = false;
5050 example = true;
5151- description = "Create a VMDK version 6 image (instead of version 4).";
5151+ description = lib.mdDoc "Create a VMDK version 6 image (instead of version 4).";
5252 };
5353 };
5454 };
···126126 # Electron is trying to open udev via dlopen()
127127 # and for some reason that doesn't seem to be impacted from the rpath.
128128 # Adding udev to LD_LIBRARY_PATH fixes that.
129129+ # Make xdg-open overrideable at runtime.
129130 makeWrapper $out/share/1password/1password $out/bin/1password \
130130- --prefix PATH : ${lib.makeBinPath [ xdg-utils ]} \
131131+ --suffix PATH : ${lib.makeBinPath [ xdg-utils ]} \
131132 --prefix LD_LIBRARY_PATH : ${lib.makeLibraryPath [ udev ]}
132133133134 runHook postInstall
+2-1
pkgs/applications/misc/1password-gui/default.nix
···126126 # Electron is trying to open udev via dlopen()
127127 # and for some reason that doesn't seem to be impacted from the rpath.
128128 # Adding udev to LD_LIBRARY_PATH fixes that.
129129+ # Make xdg-open overrideable at runtime.
129130 makeWrapper $out/share/1password/1password $out/bin/1password \
130130- --prefix PATH : ${lib.makeBinPath [ xdg-utils ]} \
131131+ --suffix PATH : ${lib.makeBinPath [ xdg-utils ]} \
131132 --prefix LD_LIBRARY_PATH : ${lib.makeLibraryPath [ udev ]}
132133133134 runHook postInstall
+1-1
pkgs/applications/misc/avrdudess/default.nix
···2525 export LD_LIBRARY_PATH="${lib.makeLibraryPath [gtk2 mono]}"
2626 # We need PATH from user env for xdg-open to find its tools, which
2727 # typically depend on the currently running desktop environment.
2828- export PATH="${lib.makeBinPath [ avrdude xdg-utils ]}:\$PATH"
2828+ export PATH="\$PATH:${lib.makeBinPath [ avrdude xdg-utils ]}"
29293030 # avrdudess must have its resource files in its current working directory
3131 cd $out/avrdudess && exec ${mono}/bin/mono "$out/avrdudess/avrdudess.exe" "\$@"