diff options
author | pennae <github@quasiparticle.net> | 2022-08-02 02:47:05 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-03 21:03:23 +0200 |
commit | 16102dce2fbad670bd47dd75c860a8daa5fe47ad (patch) | |
tree | 26fa9aed51c066b5145eae0d87f4ba387e3ecd48 /nixos/modules/services | |
parent | 694d5b19d30bf66687b42fb77f43ea7cd1002a62 (diff) |
nixos/*: replace <code> in option docs with <literal>
markdown can't represent the difference without another extension and both the html manual and the manpage render them the same, so keeping the distinction is not very useful on its own. with the distinction removed we can automatically convert many options that use <code> tags to markdown. the manpage remains unchanged, html manual does not render differently (but class names on code tags do change from "code" to "literal").
Diffstat (limited to 'nixos/modules/services')
18 files changed, 58 insertions, 58 deletions
diff --git a/nixos/modules/services/databases/firebird.nix b/nixos/modules/services/databases/firebird.nix index 3a7ebd6bbd096..a26f1ff8258fd 100644 --- a/nixos/modules/services/databases/firebird.nix +++ b/nixos/modules/services/databases/firebird.nix @@ -48,8 +48,8 @@ in type = types.package; example = literalExpression "pkgs.firebird_3"; description = '' - Which Firebird package to be installed: <code>pkgs.firebird_3</code> - For SuperServer use override: <code>pkgs.firebird_3.override { superServer = true; };</code> + Which Firebird package to be installed: <literal>pkgs.firebird_3</literal> + For SuperServer use override: <literal>pkgs.firebird_3.override { superServer = true; };</literal> ''; }; diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix index b7a55900c122f..1e6a6b844a37e 100644 --- a/nixos/modules/services/databases/mysql.nix +++ b/nixos/modules/services/databases/mysql.nix @@ -211,7 +211,7 @@ in For more information on how to specify the target and on which privileges exist, see the <link xlink:href="https://mariadb.com/kb/en/library/grant/">GRANT syntax</link>. - The attributes are used as <code>GRANT ''${attrName} ON ''${attrValue}</code>. + The attributes are used as <literal>GRANT ''${attrName} ON ''${attrValue}</literal>. ''; example = literalExpression '' { diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index e27f4518dfada..a054a6d7a12f0 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -159,7 +159,7 @@ in For more information on how to specify the target and on which privileges exist, see the <link xlink:href="https://www.postgresql.org/docs/current/sql-grant.html">GRANT syntax</link>. - The attributes are used as <code>GRANT ''${attrValue} ON ''${attrName}</code>. + The attributes are used as <literal>GRANT ''${attrValue} ON ''${attrName}</literal>. ''; example = literalExpression '' { diff --git a/nixos/modules/services/mail/nullmailer.nix b/nixos/modules/services/mail/nullmailer.nix index 59329667f7ad0..c37001e35bfa3 100644 --- a/nixos/modules/services/mail/nullmailer.nix +++ b/nixos/modules/services/mail/nullmailer.nix @@ -39,10 +39,10 @@ with lib; type = types.nullOr types.str; default = null; description = '' - Path to the <code>remotes</code> control file. This file contains a + Path to the <literal>remotes</literal> control file. This file contains a list of remote servers to which to send each message. - See <code>man 8 nullmailer-send</code> for syntax and available + See <literal>man 8 nullmailer-send</literal> for syntax and available options. ''; }; @@ -158,12 +158,12 @@ with lib; contains a remote host name or address followed by an optional protocol string, separated by white space. - See <code>man 8 nullmailer-send</code> for syntax and available + See <literal>man 8 nullmailer-send</literal> for syntax and available options. WARNING: This is stored world-readable in the nix store. If you need to specify any secret credentials here, consider using the - <code>remotesFile</code> option instead. + <literal>remotesFile</literal> option instead. ''; }; diff --git a/nixos/modules/services/mail/public-inbox.nix b/nixos/modules/services/mail/public-inbox.nix index bb835881ba0a0..6f33283b548b1 100644 --- a/nixos/modules/services/mail/public-inbox.nix +++ b/nixos/modules/services/mail/public-inbox.nix @@ -26,7 +26,7 @@ let description = '' Listening port. Beware that public-inbox uses well-known ports number to decide whether to enable TLS or not. - Set to null and use <code>systemd.sockets.public-inbox-${proto}d.listenStreams</code> + Set to null and use <literal>systemd.sockets.public-inbox-${proto}d.listenStreams</literal> if you need a more advanced listening. ''; }; @@ -242,8 +242,8 @@ in description = '' Listening port or systemd's ListenStream= entry to be used as a reverse proxy, eg. in nginx: - <code>locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox";</code> - Set to null and use <code>systemd.sockets.public-inbox-httpd.listenStreams</code> + <literal>locations."/inbox".proxyPass = "http://unix:''${config.services.public-inbox.http.port}:/inbox";</literal> + Set to null and use <literal>systemd.sockets.public-inbox-httpd.listenStreams</literal> if you need a more advanced listening. ''; }; diff --git a/nixos/modules/services/misc/autorandr.nix b/nixos/modules/services/misc/autorandr.nix index 9a0530866b580..a77535cca49e4 100644 --- a/nixos/modules/services/misc/autorandr.nix +++ b/nixos/modules/services/misc/autorandr.nix @@ -29,7 +29,7 @@ let type = types.attrsOf types.str; description = '' Output name to EDID mapping. - Use <code>autorandr --fingerprint</code> to get current setup values. + Use <literal>autorandr --fingerprint</literal> to get current setup values. ''; default = { }; }; diff --git a/nixos/modules/services/misc/sourcehut/default.nix b/nixos/modules/services/misc/sourcehut/default.nix index 3ff2837900eca..de04797a800c6 100644 --- a/nixos/modules/services/misc/sourcehut/default.nix +++ b/nixos/modules/services/misc/sourcehut/default.nix @@ -180,7 +180,7 @@ in network-key = mkOption { description = '' An absolute file path (which should be outside the Nix-store) - to a secret key to encrypt internal messages with. Use <code>srht-keygen network</code> to + to a secret key to encrypt internal messages with. Use <literal>srht-keygen network</literal> to generate this key. It must be consistent between all services and nodes. ''; type = types.path; @@ -209,7 +209,7 @@ in service-key = mkOption { description = '' An absolute file path (which should be outside the Nix-store) - to a key used for encrypting session cookies. Use <code>srht-keygen service</code> to + to a key used for encrypting session cookies. Use <literal>srht-keygen service</literal> to generate the service key. This must be shared between each node of the same service (e.g. git1.sr.ht and git2.sr.ht), but different services may use different keys. If you configure all of your services with the same @@ -252,8 +252,8 @@ in Your PGP key information (DO NOT mix up pub and priv here) You must remove the password from your secret key, if present. - You can do this with <code>gpg --edit-key [key-id]</code>, - then use the <code>passwd</code> command and do not enter a new password. + You can do this with <literal>gpg --edit-key [key-id]</literal>, + then use the <literal>passwd</literal> command and do not enter a new password. ''; }; pgp-pubkey = mkOption { @@ -294,7 +294,7 @@ in This should be consistent for all *.sr.ht sites, as this key will be used to verify signatures from other sites in your network. - Use the <code>srht-keygen webhook</code> command to generate a key. + Use the <literal>srht-keygen webhook</literal> command to generate a key. ''; type = types.path; apply = s: "<" + toString s; diff --git a/nixos/modules/services/networking/bird.nix b/nixos/modules/services/networking/bird.nix index d409f06022897..b166209fa9692 100644 --- a/nixos/modules/services/networking/bird.nix +++ b/nixos/modules/services/networking/bird.nix @@ -24,7 +24,7 @@ in description = '' Whether the config should be checked at build time. When the config can't be checked during build time, for example when it includes - other files, either disable this option or use <code>preCheckConfig</code> to create + other files, either disable this option or use <literal>preCheckConfig</literal> to create the included files before checking. ''; }; @@ -36,7 +36,7 @@ in ''; description = '' Commands to execute before the config file check. The file to be checked will be - available as <code>bird2.conf</code> in the current directory. + available as <literal>bird2.conf</literal> in the current directory. Files created with this option will not be available at service runtime, only during build time checking. diff --git a/nixos/modules/services/networking/ghostunnel.nix b/nixos/modules/services/networking/ghostunnel.nix index 6cac6a69b0679..ce5d386edc35e 100644 --- a/nixos/modules/services/networking/ghostunnel.nix +++ b/nixos/modules/services/networking/ghostunnel.nix @@ -40,9 +40,9 @@ let description = '' Path to keystore (combined PEM with cert/key, or PKCS12 keystore). - NB: storepass is not supported because it would expose credentials via <code>/proc/*/cmdline</code>. + NB: storepass is not supported because it would expose credentials via <literal>/proc/*/cmdline</literal>. - Specify this or <code>cert</code> and <code>key</code>. + Specify this or <literal>cert</literal> and <literal>key</literal>. ''; type = types.nullOr types.str; default = null; @@ -52,7 +52,7 @@ let description = '' Path to certificate (PEM with certificate chain). - Not required if <code>keystore</code> is set. + Not required if <literal>keystore</literal> is set. ''; type = types.nullOr types.str; default = null; @@ -62,7 +62,7 @@ let description = '' Path to certificate private key (PEM with private key). - Not required if <code>keystore</code> is set. + Not required if <literal>keystore</literal> is set. ''; type = types.nullOr types.str; default = null; @@ -70,7 +70,7 @@ let cacert = mkOption { description = '' - Path to CA bundle file (PEM/X509). Uses system trust store if <code>null</code>. + Path to CA bundle file (PEM/X509). Uses system trust store if <literal>null</literal>. ''; type = types.nullOr types.str; }; @@ -124,7 +124,7 @@ let }; extraArguments = mkOption { - description = "Extra arguments to pass to <code>ghostunnel server</code>"; + description = "Extra arguments to pass to <literal>ghostunnel server</literal>"; type = types.separatedString " "; default = ""; }; diff --git a/nixos/modules/services/networking/nntp-proxy.nix b/nixos/modules/services/networking/nntp-proxy.nix index 618ed0a93f1df..1a776aae617bd 100644 --- a/nixos/modules/services/networking/nntp-proxy.nix +++ b/nixos/modules/services/networking/nntp-proxy.nix @@ -169,7 +169,7 @@ in example = "$6$GtzE7FrpE$wwuVgFYU.TZH4Rz.Snjxk9XGua89IeVwPQ/fEUD8eujr40q5Y021yhn0aNcsQ2Ifw.BLclyzvzgegopgKcneL0"; description = '' SHA-512 password hash (can be generated by - <code>mkpasswd -m sha-512 <password></code>) + <literal>mkpasswd -m sha-512 <password></literal>) ''; }; diff --git a/nixos/modules/services/networking/nsd.nix b/nixos/modules/services/networking/nsd.nix index 1102fc85d40a9..a372d3b207c48 100644 --- a/nixos/modules/services/networking/nsd.nix +++ b/nixos/modules/services/networking/nsd.nix @@ -393,7 +393,7 @@ let type = types.listOf types.str; default = []; description = '' - Format: <code>[AXFR|UDP] <ip-address> <key-name | NOKEY></code> + Format: <literal>[AXFR|UDP] <ip-address> <key-name | NOKEY></literal> ''; }; diff --git a/nixos/modules/services/networking/openconnect.nix b/nixos/modules/services/networking/openconnect.nix index c5313bb305a2d..c729414597501 100644 --- a/nixos/modules/services/networking/openconnect.nix +++ b/nixos/modules/services/networking/openconnect.nix @@ -40,8 +40,8 @@ let passwordFile = mkOption { description = '' File containing the password to authenticate with. This - is passed to <code>openconnect</code> via the - <code>--passwd-on-stdin</code> option. + is passed to <literal>openconnect</literal> via the + <literal>--passwd-on-stdin</literal> option. ''; default = null; example = "/var/lib/secrets/openconnect-passwd"; @@ -66,10 +66,10 @@ let description = '' Extra config to be appended to the interface config. It should contain long-format options as would be accepted on the command - line by <code>openconnect</code> + line by <literal>openconnect</literal> (see https://www.infradead.org/openconnect/manual.html). - Non-key-value options like <code>deflate</code> can be used by - declaring them as booleans, i. e. <code>deflate = true;</code>. + Non-key-value options like <literal>deflate</literal> can be used by + declaring them as booleans, i. e. <literal>deflate = true;</literal>. ''; default = { }; example = { diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index 07b2e2a2daf2c..e99f31b0eaa41 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -44,8 +44,8 @@ in { are supplied, they will be combined, with values from <option>configFile</option> taking precedence. - You can use the command <code>nix-shell -p yggdrasil --run - "yggdrasil -genconf"</code> to generate default + You can use the command <literal>nix-shell -p yggdrasil --run + "yggdrasil -genconf"</literal> to generate default configuration values with documentation. ''; }; @@ -64,7 +64,7 @@ in { type = types.nullOr types.str; default = null; example = "wheel"; - description = "Group to grant access to the Yggdrasil control socket. If <code>null</code>, only root can access the socket."; + description = "Group to grant access to the Yggdrasil control socket. If <literal>null</literal>, only root can access the socket."; }; openMulticastPort = mkOption { @@ -74,7 +74,7 @@ in { Whether to open the UDP port used for multicast peer discovery. The NixOS firewall blocks link-local communication, so in order to make local peering work you - will also need to set <code>LinkLocalTCPPort</code> in your + will also need to set <literal>LinkLocalTCPPort</literal> in your yggdrasil configuration (<option>config</option> or <option>configFile</option>) to a port number other than 0, and then add that port to diff --git a/nixos/modules/services/torrent/transmission.nix b/nixos/modules/services/torrent/transmission.nix index 9777964386c96..1641f1ad184ed 100644 --- a/nixos/modules/services/torrent/transmission.nix +++ b/nixos/modules/services/torrent/transmission.nix @@ -175,7 +175,7 @@ in default = null; example = "770"; description = '' - If not <code>null</code>, is used as the permissions + If not <literal>null</literal>, is used as the permissions set by <literal>systemd.activationScripts.transmission-daemon</literal> on the directories <xref linkend="opt-services.transmission.settings.download-dir"/>, <xref linkend="opt-services.transmission.settings.incomplete-dir"/>. @@ -214,7 +214,7 @@ in description = '' Path to a JSON file to be merged with the settings. Useful to merge a file which is better kept out of the Nix store - to set secret config parameters like <code>rpc-password</code>. + to set secret config parameters like <literal>rpc-password</literal>. ''; default = "/dev/null"; example = "/var/lib/secrets/transmission/settings.json"; @@ -237,7 +237,7 @@ in to open many more connections at the same time. Note that you may also want to increase - <code>peer-limit-global"</code>. + <literal>peer-limit-global"</literal>. And be aware that these settings are quite aggressive and might not suite your regular desktop use. For instance, SSH sessions may time out more easily''; diff --git a/nixos/modules/services/web-apps/bookstack.nix b/nixos/modules/services/web-apps/bookstack.nix index 64a2767fab6e1..5d22a3b9a8d62 100644 --- a/nixos/modules/services/web-apps/bookstack.nix +++ b/nixos/modules/services/web-apps/bookstack.nix @@ -52,7 +52,7 @@ in { description = '' A file containing the Laravel APP_KEY - a 32 character long, base64 encoded key used for encryption where needed. Can be - generated with <code>head -c 32 /dev/urandom | base64</code>. + generated with <literal>head -c 32 /dev/urandom | base64</literal>. ''; example = "/run/keys/bookstack-appkey"; type = types.path; @@ -74,7 +74,7 @@ in { appURL = mkOption { description = '' The root URL that you want to host BookStack on. All URLs in BookStack will be generated using this value. - If you change this in the future you may need to run a command to update stored URLs in the database. Command example: <code>php artisan bookstack:update-url https://old.example.com https://new.example.com</code> + If you change this in the future you may need to run a command to update stored URLs in the database. Command example: <literal>php artisan bookstack:update-url https://old.example.com https://new.example.com</literal> ''; default = "http${lib.optionalString tlsEnabled "s"}://${cfg.hostname}"; defaultText = ''http''${lib.optionalString tlsEnabled "s"}://''${cfg.hostname}''; diff --git a/nixos/modules/services/web-apps/mastodon.nix b/nixos/modules/services/web-apps/mastodon.nix index f3f0fb7cb5342..00c30d73bb6f9 100644 --- a/nixos/modules/services/web-apps/mastodon.nix +++ b/nixos/modules/services/web-apps/mastodon.nix @@ -113,17 +113,17 @@ in { affect other virtualHosts running on your nginx instance, if any. Alternatively you can configure a reverse-proxy of your choice to serve these paths: - <code>/ -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public</code> + <literal>/ -> $(nix-instantiate --eval '<nixpkgs>' -A mastodon.outPath)/public</literal> - <code>/ -> 127.0.0.1:{{ webPort }} </code>(If there was no file in the directory above.) + <literal>/ -> 127.0.0.1:{{ webPort }} </literal>(If there was no file in the directory above.) - <code>/system/ -> /var/lib/mastodon/public-system/</code> + <literal>/system/ -> /var/lib/mastodon/public-system/</literal> - <code>/api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}</code> + <literal>/api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}</literal> Make sure that websockets are forwarded properly. You might want to set up caching of some requests. Take a look at mastodon's provided nginx configuration at - <code>https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf</code>. + <literal>https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf</literal>. ''; type = lib.types.bool; default = false; @@ -135,13 +135,13 @@ in { that user will be created, otherwise it should be set to the name of a user created elsewhere. In both cases, <package>mastodon</package> and a package containing only - the shell script <code>mastodon-env</code> will be added to + the shell script <literal>mastodon-env</literal> will be added to the user's package set. To run a command from - <package>mastodon</package> such as <code>tootctl</code> + <package>mastodon</package> such as <literal>tootctl</literal> with the environment configured by this module use - <code>mastodon-env</code>, as in: + <literal>mastodon-env</literal>, as in: - <code>mastodon-env tootctl accounts create newuser --email newuser@example.com</code> + <literal>mastodon-env tootctl accounts create newuser --email newuser@example.com</literal> ''; type = lib.types.str; default = "mastodon"; @@ -202,7 +202,7 @@ in { Voluntary Application Server Identification. A new keypair can be generated by running: - <code>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys</code> + <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys</literal> If <option>mastodon.vapidPrivateKeyFile</option>does not exist, it and this file will be created with a new keypair. @@ -222,7 +222,7 @@ in { Path to file containing the secret key base. A new secret key base can be generated by running: - <code>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret</code> + <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret</literal> If this file does not exist, it will be created with a new secret key base. ''; @@ -235,7 +235,7 @@ in { Path to file containing the OTP secret. A new OTP secret can be generated by running: - <code>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret</code> + <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake secret</literal> If this file does not exist, it will be created with a new OTP secret. ''; @@ -249,7 +249,7 @@ in { Voluntary Application Server Identification. A new keypair can be generated by running: - <code>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys</code> + <literal>nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys</literal> If this file does not exist, it will be created with a new private key. diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 618ad85b8605c..08083b7a443f8 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -586,8 +586,8 @@ in { type = types.ints.positive; default = 15552000; description = '' - Value for the <code>max-age</code> directive of the HTTP - <code>Strict-Transport-Security</code> header. + Value for the <literal>max-age</literal> directive of the HTTP + <literal>Strict-Transport-Security</literal> header. See section 6.1.1 of IETF RFC 6797 for detailed information on this directive and header. diff --git a/nixos/modules/services/web-apps/snipe-it.nix b/nixos/modules/services/web-apps/snipe-it.nix index 842e0715c0256..3059e67cb43b8 100644 --- a/nixos/modules/services/web-apps/snipe-it.nix +++ b/nixos/modules/services/web-apps/snipe-it.nix @@ -46,7 +46,7 @@ in { description = '' A file containing the Laravel APP_KEY - a 32 character long, base64 encoded key used for encryption where needed. Can be - generated with <code>head -c 32 /dev/urandom | base64</code>. + generated with <literal>head -c 32 /dev/urandom | base64</literal>. ''; example = "/run/keys/snipe-it/appkey"; type = types.path; @@ -69,7 +69,7 @@ in { description = '' The root URL that you want to host Snipe-IT on. All URLs in Snipe-IT will be generated using this value. If you change this in the future you may need to run a command to update stored URLs in the database. - Command example: <code>snipe-it snipe-it:update-url https://old.example.com https://new.example.com</code> + Command example: <literal>snipe-it snipe-it:update-url https://old.example.com https://new.example.com</literal> ''; default = "http${lib.optionalString tlsEnabled "s"}://${cfg.hostName}"; defaultText = '' |