diff options
Diffstat (limited to 'nixos/modules/services/networking')
17 files changed, 114 insertions, 114 deletions
diff --git a/nixos/modules/services/networking/avahi-daemon.nix b/nixos/modules/services/networking/avahi-daemon.nix index 0be77fa3d0d8..56113bd34594 100644 --- a/nixos/modules/services/networking/avahi-daemon.nix +++ b/nixos/modules/services/networking/avahi-daemon.nix @@ -150,9 +150,9 @@ in '''; } ''; - description = '' + description = lib.mdDoc '' Specify custom service definitions which are placed in the avahi service directory. - See the <citerefentry><refentrytitle>avahi.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> manpage for detailed information. + See the {manpage}`avahi.service(5)` manpage for detailed information. ''; }; diff --git a/nixos/modules/services/networking/keepalived/default.nix b/nixos/modules/services/networking/keepalived/default.nix index c9ac2ee25990..768c8e4b13c7 100644 --- a/nixos/modules/services/networking/keepalived/default.nix +++ b/nixos/modules/services/networking/keepalived/default.nix @@ -147,7 +147,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable Keepalived. ''; }; @@ -155,7 +155,7 @@ in enableScriptSecurity = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Don't run scripts configured to be run as root if any part of the path is writable by a non-root user. ''; }; @@ -165,7 +165,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the builtin AgentX subagent. ''; }; @@ -173,7 +173,7 @@ in socket = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Socket to use for connecting to SNMP master agent. If this value is set to null, keepalived's default will be used, which is unix:/var/agentx/master, unless using a network namespace, when the @@ -184,7 +184,7 @@ in enableKeepalived = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SNMP handling of vrrp element of KEEPALIVED MIB. ''; }; @@ -192,7 +192,7 @@ in enableChecker = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SNMP handling of checker element of KEEPALIVED MIB. ''; }; @@ -200,7 +200,7 @@ in enableRfc = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SNMP handling of RFC2787 and RFC6527 VRRP MIBs. ''; }; @@ -208,7 +208,7 @@ in enableRfcV2 = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SNMP handling of RFC2787 VRRP MIB. ''; }; @@ -216,7 +216,7 @@ in enableRfcV3 = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SNMP handling of RFC6527 VRRP MIB. ''; }; @@ -224,7 +224,7 @@ in enableTraps = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable SNMP traps. ''; }; @@ -236,7 +236,7 @@ in inherit lib; })); default = {}; - description = "Declarative vrrp script config"; + description = lib.mdDoc "Declarative vrrp script config"; }; vrrpInstances = mkOption { @@ -244,13 +244,13 @@ in inherit lib; })); default = {}; - description = "Declarative vhost config"; + description = lib.mdDoc "Declarative vhost config"; }; extraGlobalDefs = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the 'global_defs' block of the configuration file ''; @@ -259,7 +259,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the configuration file. ''; }; diff --git a/nixos/modules/services/networking/keepalived/virtual-ip-options.nix b/nixos/modules/services/networking/keepalived/virtual-ip-options.nix index 1b8889b1b472..1fa6a0ee3bf4 100644 --- a/nixos/modules/services/networking/keepalived/virtual-ip-options.nix +++ b/nixos/modules/services/networking/keepalived/virtual-ip-options.nix @@ -6,7 +6,7 @@ with lib; addr = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' IP address, optionally with a netmask: IPADDR[/MASK] ''; }; @@ -14,7 +14,7 @@ with lib; brd = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The broadcast address on the interface. ''; }; @@ -22,7 +22,7 @@ with lib; dev = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The name of the device to add the address to. ''; }; @@ -30,7 +30,7 @@ with lib; scope = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The scope of the area where this address is valid. ''; }; @@ -38,7 +38,7 @@ with lib; label = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Each address may be tagged with a label string. In order to preserve compatibility with Linux-2.0 net aliases, this string must coincide with the name of the device or must be prefixed with the device name followed diff --git a/nixos/modules/services/networking/keepalived/vrrp-instance-options.nix b/nixos/modules/services/networking/keepalived/vrrp-instance-options.nix index e96dde5fa89f..20e5558d7829 100644 --- a/nixos/modules/services/networking/keepalived/vrrp-instance-options.nix +++ b/nixos/modules/services/networking/keepalived/vrrp-instance-options.nix @@ -6,7 +6,7 @@ with lib; interface = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Interface for inside_network, bound by vrrp. ''; }; @@ -14,7 +14,7 @@ with lib; state = mkOption { type = types.enum [ "MASTER" "BACKUP" ]; default = "BACKUP"; - description = '' + description = lib.mdDoc '' Initial state. As soon as the other machine(s) come up, an election will be held and the machine with the highest "priority" will become MASTER. So the entry here doesn't matter a whole lot. @@ -23,7 +23,7 @@ with lib; virtualRouterId = mkOption { type = types.int; - description = '' + description = lib.mdDoc '' Arbitrary unique number 0..255. Used to differentiate multiple instances of vrrpd running on the same NIC (and hence same socket). ''; @@ -32,7 +32,7 @@ with lib; priority = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' For electing MASTER, highest priority wins. To be MASTER, make 50 more than other machines. ''; @@ -41,7 +41,7 @@ with lib; noPreempt = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' VRRP will normally preempt a lower priority machine when a higher priority machine comes online. "nopreempt" allows the lower priority machine to maintain the master role, even when a higher priority machine @@ -53,7 +53,7 @@ with lib; useVmac = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Use VRRP Virtual MAC. ''; }; @@ -61,7 +61,7 @@ with lib; vmacInterface = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Name of the vmac interface to use. keepalived will come up with a name if you don't specify one. ''; @@ -70,7 +70,7 @@ with lib; vmacXmitBase = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Send/Recv VRRP messages from base interface instead of VMAC interface. ''; }; @@ -78,7 +78,7 @@ with lib; unicastSrcIp = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Default IP for binding vrrpd is the primary IP on interface. If you want to hide location of vrrpd, use this IP as src_addr for unicast vrrp packets. @@ -88,7 +88,7 @@ with lib; unicastPeers = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Do not send VRRP adverts over VRRP multicast group. Instead it sends adverts to the following list of ip addresses using unicast design fashion. It can be cool to use VRRP FSM and features in a networking @@ -103,27 +103,27 @@ with lib; })); default = []; # TODO: example - description = "Declarative vhost config"; + description = lib.mdDoc "Declarative vhost config"; }; trackScripts = mkOption { type = types.listOf types.str; default = []; example = [ "chk_cmd1" "chk_cmd2" ]; - description = "List of script names to invoke for health tracking."; + description = lib.mdDoc "List of script names to invoke for health tracking."; }; trackInterfaces = mkOption { type = types.listOf types.str; default = []; example = [ "eth0" "eth1" ]; - description = "List of network interfaces to monitor for health tracking."; + description = lib.mdDoc "List of network interfaces to monitor for health tracking."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the vrrp_instance section. ''; }; diff --git a/nixos/modules/services/networking/keepalived/vrrp-script-options.nix b/nixos/modules/services/networking/keepalived/vrrp-script-options.nix index df7a89cff8cd..852d6b0ec26f 100644 --- a/nixos/modules/services/networking/keepalived/vrrp-script-options.nix +++ b/nixos/modules/services/networking/keepalived/vrrp-script-options.nix @@ -8,55 +8,55 @@ with lib.types; script = mkOption { type = str; example = literalExpression ''"''${pkgs.curl} -f http://localhost:80"''; - description = "(Path of) Script command to execute followed by args, i.e. cmd [args]..."; + description = lib.mdDoc "(Path of) Script command to execute followed by args, i.e. cmd [args]..."; }; interval = mkOption { type = int; default = 1; - description = "Seconds between script invocations."; + description = lib.mdDoc "Seconds between script invocations."; }; timeout = mkOption { type = int; default = 5; - description = "Seconds after which script is considered to have failed."; + description = lib.mdDoc "Seconds after which script is considered to have failed."; }; weight = mkOption { type = int; default = 0; - description = "Following a failure, adjust the priority by this weight."; + description = lib.mdDoc "Following a failure, adjust the priority by this weight."; }; rise = mkOption { type = int; default = 5; - description = "Required number of successes for OK transition."; + description = lib.mdDoc "Required number of successes for OK transition."; }; fall = mkOption { type = int; default = 3; - description = "Required number of failures for KO transition."; + description = lib.mdDoc "Required number of failures for KO transition."; }; user = mkOption { type = str; default = "keepalived_script"; - description = "Name of user to run the script under."; + description = lib.mdDoc "Name of user to run the script under."; }; group = mkOption { type = nullOr str; default = null; - description = "Name of group to run the script under. Defaults to user group."; + description = lib.mdDoc "Name of group to run the script under. Defaults to user group."; }; extraConfig = mkOption { type = lines; default = ""; - description = "Extra lines to be added verbatim to the vrrp_script section."; + description = lib.mdDoc "Extra lines to be added verbatim to the vrrp_script section."; }; }; diff --git a/nixos/modules/services/networking/nbd.nix b/nixos/modules/services/networking/nbd.nix index bd52c6244263..76ca11dfea76 100644 --- a/nixos/modules/services/networking/nbd.nix +++ b/nixos/modules/services/networking/nbd.nix @@ -56,9 +56,9 @@ in default = { allowlist = false; }; - description = '' + description = lib.mdDoc '' Extra options for the server. See - <citerefentry><refentrytitle>nbd-server</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + {manpage}`nbd-server(5)`. ''; }; @@ -87,9 +87,9 @@ in flush = true; fua = true; }; - description = '' + description = lib.mdDoc '' Extra options for this export. See - <citerefentry><refentrytitle>nbd-server</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + {manpage}`nbd-server(5)`. ''; }; }; diff --git a/nixos/modules/services/networking/networkmanager.nix b/nixos/modules/services/networking/networkmanager.nix index f2ca3cf30f19..d5d562e7ba5f 100644 --- a/nixos/modules/services/networking/networkmanager.nix +++ b/nixos/modules/services/networking/networkmanager.nix @@ -173,14 +173,14 @@ in { str ])); default = {}; - description = '' + description = lib.mdDoc '' Configuration for the [connection] section of NetworkManager.conf. Refer to - <link xlink:href="https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html"> + [ https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html#id-1.2.3.11 - </link> + ](https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html) or - <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`NetworkManager.conf(5)` for more information. ''; }; @@ -188,14 +188,14 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Configuration appended to the generated NetworkManager.conf. Refer to - <link xlink:href="https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html"> + [ https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html - </link> + ](https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html) or - <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`NetworkManager.conf(5)` for more information. ''; }; @@ -203,15 +203,15 @@ in { unmanaged = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of interfaces that will not be managed by NetworkManager. Interface name can be specified here, but if you need more fidelity, refer to - <link xlink:href="https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html#device-spec"> + [ https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html#device-spec - </link> + ](https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html#device-spec) or the "Device List Format" Appendix of - <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + {manpage}`NetworkManager.conf(5)`. ''; }; @@ -318,15 +318,15 @@ in { dns = mkOption { type = types.enum [ "default" "dnsmasq" "unbound" "systemd-resolved" "none" ]; default = "default"; - description = '' - Set the DNS (<literal>resolv.conf</literal>) processing mode. + description = lib.mdDoc '' + Set the DNS (`resolv.conf`) processing mode. A description of these modes can be found in the main section of - <link xlink:href="https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html"> + [ https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html - </link> + ](https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html) or in - <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + {manpage}`NetworkManager.conf(5)`. ''; }; diff --git a/nixos/modules/services/networking/nghttpx/backend-submodule.nix b/nixos/modules/services/networking/nghttpx/backend-submodule.nix index eb559e926e76..af99b21c9ab3 100644 --- a/nixos/modules/services/networking/nghttpx/backend-submodule.nix +++ b/nixos/modules/services/networking/nghttpx/backend-submodule.nix @@ -13,7 +13,7 @@ host = "127.0.0.1"; port = 80; }; - description = '' + description = lib.mdDoc '' Backend server location specified as either a host:port pair or a unix domain docket. ''; @@ -27,7 +27,7 @@ "/somepath" ]; default = []; - description = '' + description = lib.mdDoc '' List of nghttpx backend patterns. Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx-b @@ -42,7 +42,7 @@ tls = true; }; default = null; - description = '' + description = lib.mdDoc '' Parameters to configure a backend. ''; }; diff --git a/nixos/modules/services/networking/nghttpx/frontend-submodule.nix b/nixos/modules/services/networking/nghttpx/frontend-submodule.nix index 887ef4502131..3175df20eec5 100644 --- a/nixos/modules/services/networking/nghttpx/frontend-submodule.nix +++ b/nixos/modules/services/networking/nghttpx/frontend-submodule.nix @@ -13,7 +13,7 @@ host = "127.0.0.1"; port = 80; }; - description = '' + description = lib.mdDoc '' Frontend server interface binding specification as either a host:port pair or a unix domain docket. @@ -28,7 +28,7 @@ tls = "tls"; }; default = null; - description = '' + description = lib.mdDoc '' Parameters to configure a backend. ''; }; diff --git a/nixos/modules/services/networking/nghttpx/nghttpx-options.nix b/nixos/modules/services/networking/nghttpx/nghttpx-options.nix index 51f1d081b971..13c328b4180a 100644 --- a/nixos/modules/services/networking/nghttpx/nghttpx-options.nix +++ b/nixos/modules/services/networking/nghttpx/nghttpx-options.nix @@ -4,7 +4,7 @@ frontends = lib.mkOption { type = lib.types.listOf (lib.types.submodule (import ./frontend-submodule.nix)); - description = '' + description = lib.mdDoc '' A list of frontend listener specifications. ''; example = [ @@ -22,7 +22,7 @@ backends = lib.mkOption { type = lib.types.listOf (lib.types.submodule (import ./backend-submodule.nix)); - description = '' + description = lib.mdDoc '' A list of backend specifications. ''; example = [ @@ -42,10 +42,10 @@ tls = lib.mkOption { type = lib.types.nullOr (lib.types.submodule (import ./tls-submodule.nix)); default = null; - description = '' + description = lib.mdDoc '' TLS certificate and key paths. Note that this does not enable TLS for a frontend listener, to do so, a frontend - specification must set <literal>params.tls</literal> to true. + specification must set `params.tls` to true. ''; example = { key = "/etc/ssl/keys/server.key"; @@ -56,7 +56,7 @@ extraConfig = lib.mkOption { type = lib.types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options to be appended to the generated configuration file. ''; @@ -65,7 +65,7 @@ single-process = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Run this program in a single process mode for debugging purpose. Without this option, nghttpx creates at least 2 processes: master and worker processes. If this option is @@ -81,7 +81,7 @@ backlog = lib.mkOption { type = lib.types.int; default = 65536; - description = '' + description = lib.mdDoc '' Listen backlog size. Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx--backlog @@ -95,7 +95,7 @@ "IPv6" ]; default = "auto"; - description = '' + description = lib.mdDoc '' Specify address family of backend connections. If "auto" is given, both IPv4 and IPv6 are considered. If "IPv4" is given, only IPv4 address is considered. If "IPv6" is given, only IPv6 @@ -108,7 +108,7 @@ workers = lib.mkOption { type = lib.types.int; default = 1; - description = '' + description = lib.mdDoc '' Set the number of worker threads. Please see https://nghttp2.org/documentation/nghttpx.1.html#cmdoption-nghttpx-n @@ -118,7 +118,7 @@ single-thread = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Run everything in one thread inside the worker process. This feature is provided for better debugging experience, or for the platforms which lack thread support. If threading is diff --git a/nixos/modules/services/networking/soju.nix b/nixos/modules/services/networking/soju.nix index 887a4c137d84..dddacea20044 100644 --- a/nixos/modules/services/networking/soju.nix +++ b/nixos/modules/services/networking/soju.nix @@ -32,10 +32,10 @@ in listen = mkOption { type = types.listOf types.str; default = [ ":6697" ]; - description = '' + description = lib.mdDoc '' Where soju should listen for incoming connections. See the - <literal>listen</literal> directive in - <citerefentry><refentrytitle>soju</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + `listen` directive in + {manpage}`soju(1)`. ''; }; @@ -69,10 +69,10 @@ in httpOrigins = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of allowed HTTP origins for WebSocket listeners. The parameters are interpreted as shell patterns, see - <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>. + {manpage}`glob(7)`. ''; }; diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix index 6beafb8c7c8f..beb411f204b5 100644 --- a/nixos/modules/services/networking/ssh/sshd.nix +++ b/nixos/modules/services/networking/ssh/sshd.nix @@ -156,10 +156,10 @@ in gatewayPorts = mkOption { type = types.str; default = "no"; - description = '' + description = lib.mdDoc '' Specifies whether remote hosts are allowed to connect to ports forwarded for the client. See - <citerefentry><refentrytitle>sshd_config</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + {manpage}`sshd_config(5)`. ''; }; @@ -236,10 +236,10 @@ in [ { type = "rsa"; bits = 4096; path = "/etc/ssh/ssh_host_rsa_key"; rounds = 100; openSSHFormat = true; } { type = "ed25519"; path = "/etc/ssh/ssh_host_ed25519_key"; rounds = 100; comment = "key comment"; } ]; - description = '' + description = lib.mdDoc '' NixOS can automatically generate SSH host keys. This option specifies the path, type and size of each key. See - <citerefentry><refentrytitle>ssh-keygen</refentrytitle><manvolnum>1</manvolnum></citerefentry> for supported types + {manpage}`ssh-keygen(1)` for supported types and sizes. ''; }; diff --git a/nixos/modules/services/networking/strongswan-swanctl/module.nix b/nixos/modules/services/networking/strongswan-swanctl/module.nix index 9287943fcde3..a92834f0ecff 100644 --- a/nixos/modules/services/networking/strongswan-swanctl/module.nix +++ b/nixos/modules/services/networking/strongswan-swanctl/module.nix @@ -14,7 +14,7 @@ in { type = types.package; default = pkgs.strongswan; defaultText = literalExpression "pkgs.strongswan"; - description = '' + description = lib.mdDoc '' The strongswan derivation to use. ''; }; @@ -22,8 +22,8 @@ in { strongswan.extraConfig = mkOption { type = types.str; default = ""; - description = '' - Contents of the <literal>strongswan.conf</literal> file. + description = lib.mdDoc '' + Contents of the `strongswan.conf` file. ''; }; diff --git a/nixos/modules/services/networking/stunnel.nix b/nixos/modules/services/networking/stunnel.nix index af0f53567ba6..3bd0367a0bb1 100644 --- a/nixos/modules/services/networking/stunnel.nix +++ b/nixos/modules/services/networking/stunnel.nix @@ -77,10 +77,10 @@ in servers = mkOption { - description = '' + description = lib.mdDoc '' Define the server configuations. - See "SERVICE-LEVEL OPTIONS" in <citerefentry><refentrytitle>stunnel</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + See "SERVICE-LEVEL OPTIONS" in {manpage}`stunnel(8)`. ''; type = with types; attrsOf (attrsOf (nullOr (oneOf [bool int str]))); example = { @@ -94,12 +94,12 @@ in }; clients = mkOption { - description = '' + description = lib.mdDoc '' Define the client configurations. By default, verifyChain and OCSPaia are enabled and a CAFile is provided from pkgs.cacert. - See "SERVICE-LEVEL OPTIONS" in <citerefentry><refentrytitle>stunnel</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + See "SERVICE-LEVEL OPTIONS" in {manpage}`stunnel(8)`. ''; type = with types; attrsOf (attrsOf (nullOr (oneOf [bool int str]))); diff --git a/nixos/modules/services/networking/unbound.nix b/nixos/modules/services/networking/unbound.nix index 4f755f2af2a2..5bbb0f79d57c 100644 --- a/nixos/modules/services/networking/unbound.nix +++ b/nixos/modules/services/networking/unbound.nix @@ -150,9 +150,9 @@ in { remote-control.control-enable = true; }; ''; - description = '' + description = lib.mdDoc '' Declarative Unbound configuration - See the <citerefentry><refentrytitle>unbound.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> manpage for a list of + See the {manpage}`unbound.conf(5)` manpage for a list of available options. ''; }; diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix index 4a163b5e0228..59e408f63199 100644 --- a/nixos/modules/services/networking/wpa_supplicant.nix +++ b/nixos/modules/services/networking/wpa_supplicant.nix @@ -396,10 +396,10 @@ in { example = '' bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66 ''; - description = '' + description = lib.mdDoc '' Extra configuration lines appended to the network block. See - <citerefentry><refentrytitle>wpa_supplicant.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`wpa_supplicant.conf(5)` for available options. ''; }; @@ -470,10 +470,10 @@ in { example = '' p2p_disabled=1 ''; - description = '' + description = lib.mdDoc '' Extra lines appended to the configuration file. See - <citerefentry><refentrytitle>wpa_supplicant.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`wpa_supplicant.conf(5)` for available options. ''; }; diff --git a/nixos/modules/services/networking/znc/default.nix b/nixos/modules/services/networking/znc/default.nix index 42a332d6bf03..7ca28700daec 100644 --- a/nixos/modules/services/networking/znc/default.nix +++ b/nixos/modules/services/networking/znc/default.nix @@ -87,7 +87,7 @@ in default = "znc"; example = "john"; type = types.str; - description = '' + description = lib.mdDoc '' The name of an existing user account to use to own the ZNC server process. If not specified, a default user will be created. ''; @@ -97,7 +97,7 @@ in default = defaultUser; example = "users"; type = types.str; - description = '' + description = lib.mdDoc '' Group to own the ZNC process. ''; }; @@ -106,7 +106,7 @@ in default = "/var/lib/znc"; example = "/home/john/.znc"; type = types.path; - description = '' + description = lib.mdDoc '' The state directory for ZNC. The config and the modules will be linked to from this directory as well. ''; @@ -115,10 +115,10 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for ZNC. Does work with ports for listeners specified in - <option>services.znc.config.Listener</option>. + {option}`services.znc.config.Listener`. ''; }; @@ -177,12 +177,12 @@ in configFile = mkOption { type = types.path; example = literalExpression "~/.znc/configs/znc.conf"; - description = '' + description = lib.mdDoc '' Configuration file for ZNC. It is recommended to use the - <option>config</option> option instead. + {option}`config` option instead. Setting this option will override any auto-generated config file - through the <option>confOptions</option> or <option>config</option> + through the {option}`confOptions` or {option}`config` options. ''; }; @@ -191,7 +191,7 @@ in type = types.listOf types.package; default = [ ]; example = literalExpression "[ pkgs.zncModules.fish pkgs.zncModules.push ]"; - description = '' + description = lib.mdDoc '' A list of global znc module packages to add to znc. ''; }; @@ -199,9 +199,9 @@ in mutable = mkOption { default = true; # TODO: Default to true when config is set, make sure to not delete the old config if present type = types.bool; - description = '' + description = lib.mdDoc '' Indicates whether to allow the contents of the - <literal>dataDir</literal> directory to be changed by the user at + `dataDir` directory to be changed by the user at run-time. If enabled, modifications to the ZNC configuration after its initial @@ -217,7 +217,7 @@ in default = [ ]; example = [ "--debug" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Extra arguments to use for executing znc. ''; }; |