diff options
author | pennae <github@quasiparticle.net> | 2022-08-13 05:15:06 +0200 |
---|---|---|
committer | pennae <82953136+pennae@users.noreply.github.com> | 2022-08-19 22:40:58 +0200 |
commit | 8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd (patch) | |
tree | 8e0cdaade6441c345eb239614699dc145d0226c3 /nixos/modules | |
parent | 1ab9224ebe9bc8fd732ff305b7c6c0e07dd9acb0 (diff) | |
download | nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.tar nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.tar.gz nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.tar.bz2 nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.tar.lz nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.tar.xz nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.tar.zst nixpkgs-8f8e1015275bc1be12ffe3055ffe5e15f80dd1cd.zip |
nixos/*: normalize <package> to <literal>
this renders the same in the manpage and a little more clearly in the html manual. in the manpage there continues to be no distinction from regular text, the html manual gets code-type markup (which was probably the intention for most of these uses anyway).
Diffstat (limited to 'nixos/modules')
27 files changed, 47 insertions, 47 deletions
diff --git a/nixos/modules/config/ldap.nix b/nixos/modules/config/ldap.nix index 0f54e4a8cf0..b0d12b2f819 100644 --- a/nixos/modules/config/ldap.nix +++ b/nixos/modules/config/ldap.nix @@ -195,7 +195,7 @@ in actually contact the directory server, and it is possible that a malformed configuration file will trigger reconnection. If <literal>soft</literal> is specified, then - <package>nss_ldap</package> will return immediately on server + <literal>nss_ldap</literal> will return immediately on server failure. All hard reconnect policies block with exponential backoff before retrying. ''; diff --git a/nixos/modules/config/system-path.nix b/nixos/modules/config/system-path.nix index de980e7383b..6bc0f6e353e 100644 --- a/nixos/modules/config/system-path.nix +++ b/nixos/modules/config/system-path.nix @@ -89,7 +89,7 @@ in for a running system, entries can be removed for a more minimal NixOS installation. - Note: If <package>pkgs.nano</package> is removed from this list, + Note: If <literal>pkgs.nano</literal> is removed from this list, make sure another editor is installed and the <literal>EDITOR</literal> environment variable is set to it. Environment variables can be set using diff --git a/nixos/modules/config/xdg/portal.nix b/nixos/modules/config/xdg/portal.nix index 689abf267f0..132700747c3 100644 --- a/nixos/modules/config/xdg/portal.nix +++ b/nixos/modules/config/xdg/portal.nix @@ -44,8 +44,8 @@ in List of additional portals to add to path. Portals allow interaction with system, like choosing files or taking screenshots. At minimum, a desktop portal implementation should be listed. GNOME and KDE already - adds <package>xdg-desktop-portal-gtk</package>; and - <package>xdg-desktop-portal-kde</package> respectively. On other desktop + adds <literal>xdg-desktop-portal-gtk</literal>; and + <literal>xdg-desktop-portal-kde</literal> respectively. On other desktop environments you probably want to add them yourself. ''; }; diff --git a/nixos/modules/config/xdg/portals/lxqt.nix b/nixos/modules/config/xdg/portals/lxqt.nix index e85e2cc3269..21b2440d3d3 100644 --- a/nixos/modules/config/xdg/portals/lxqt.nix +++ b/nixos/modules/config/xdg/portals/lxqt.nix @@ -15,7 +15,7 @@ in enable = mkEnableOption '' the desktop portal for the LXQt desktop environment. - This will add the <package>lxqt.xdg-desktop-portal-lxqt</package> + This will add the <literal>lxqt.xdg-desktop-portal-lxqt</literal> package (with the extra Qt styles) into the <option>xdg.portal.extraPortals</option> option ''; @@ -31,7 +31,7 @@ in ''; description = '' Extra Qt styles that will be available to the - <package>lxqt.xdg-desktop-portal-lxqt</package>. + <literal>lxqt.xdg-desktop-portal-lxqt</literal>. ''; }; }; diff --git a/nixos/modules/config/xdg/portals/wlr.nix b/nixos/modules/config/xdg/portals/wlr.nix index aba1d8dbc00..2369a1aeceb 100644 --- a/nixos/modules/config/xdg/portals/wlr.nix +++ b/nixos/modules/config/xdg/portals/wlr.nix @@ -17,14 +17,14 @@ in enable = mkEnableOption '' desktop portal for wlroots-based desktops - This will add the <package>xdg-desktop-portal-wlr</package> package into + This will add the <literal>xdg-desktop-portal-wlr</literal> package into the <option>xdg.portal.extraPortals</option> option, and provide the configuration file ''; settings = mkOption { description = '' - Configuration for <package>xdg-desktop-portal-wlr</package>. + Configuration for <literal>xdg-desktop-portal-wlr</literal>. See <literal>xdg-desktop-portal-wlr(5)</literal> for supported values. diff --git a/nixos/modules/programs/captive-browser.nix b/nixos/modules/programs/captive-browser.nix index 7ebce17bebf..40eb7f5d66f 100644 --- a/nixos/modules/programs/captive-browser.nix +++ b/nixos/modules/programs/captive-browser.nix @@ -86,7 +86,7 @@ in default = true; type = types.bool; description = '' - Binds <package>captive-browser</package> to the network interface declared in + Binds <literal>captive-browser</literal> to the network interface declared in <literal>cfg.interface</literal>. This can be used to avoid collisions with private subnets. ''; diff --git a/nixos/modules/programs/k3b.nix b/nixos/modules/programs/k3b.nix index 68a4d08f349..1ea4204a3eb 100644 --- a/nixos/modules/programs/k3b.nix +++ b/nixos/modules/programs/k3b.nix @@ -11,11 +11,11 @@ with lib; description = '' Whether to enable k3b, the KDE disk burning application. - Additionally to installing <package>k3b</package> enabling this will + Additionally to installing <literal>k3b</literal> enabling this will add <literal>setuid</literal> wrappers in <literal>/run/wrappers/bin</literal> - for both <package>cdrdao</package> and <package>cdrecord</package>. On first - run you must manually configure the path of <package>cdrdae</package> and - <package>cdrecord</package> to correspond to the appropriate paths under + for both <literal>cdrdao</literal> and <literal>cdrecord</literal>. On first + run you must manually configure the path of <literal>cdrdae</literal> and + <literal>cdrecord</literal> to correspond to the appropriate paths under <literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu. ''; }; diff --git a/nixos/modules/security/dhparams.nix b/nixos/modules/security/dhparams.nix index b3fce7e83af..93c9066dc95 100644 --- a/nixos/modules/security/dhparams.nix +++ b/nixos/modules/security/dhparams.nix @@ -94,7 +94,7 @@ in { <note><para>If this is <literal>false</literal> the resulting store path will be non-deterministic and will be rebuilt every time the - <package>openssl</package> package changes.</para></note> + <literal>openssl</literal> package changes.</para></note> ''; }; diff --git a/nixos/modules/services/home-automation/home-assistant.nix b/nixos/modules/services/home-automation/home-assistant.nix index 2b812838363..07c2a26df2c 100644 --- a/nixos/modules/services/home-automation/home-assistant.nix +++ b/nixos/modules/services/home-automation/home-assistant.nix @@ -129,7 +129,7 @@ in { description = '' List of packages to add to propagatedBuildInputs. - A popular example is <package>python3Packages.psycopg2</package> + A popular example is <literal>python3Packages.psycopg2</literal> for PostgreSQL support in the recorder component. ''; }; diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix index 1359c265c8f..15a5f126729 100644 --- a/nixos/modules/services/misc/etebase-server.nix +++ b/nixos/modules/services/misc/etebase-server.nix @@ -134,7 +134,7 @@ in }; default = {}; description = '' - Configuration for <package>etebase-server</package>. Refer to + Configuration for <literal>etebase-server</literal>. Refer to <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/> and <link xlink:href="https://github.com/etesync/server/wiki"/> for details on supported values. diff --git a/nixos/modules/services/monitoring/grafana-agent.nix b/nixos/modules/services/monitoring/grafana-agent.nix index 8190f44c72f..d71361b94ed 100644 --- a/nixos/modules/services/monitoring/grafana-agent.nix +++ b/nixos/modules/services/monitoring/grafana-agent.nix @@ -39,7 +39,7 @@ in settings = mkOption { description = '' - Configuration for <package>grafana-agent</package>. + Configuration for <literal>grafana-agent</literal>. See https://grafana.com/docs/agent/latest/configuration/ ''; diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix index 4820b194698..8ec5b689a24 100644 --- a/nixos/modules/services/monitoring/grafana-image-renderer.nix +++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix @@ -63,7 +63,7 @@ in { default = "default"; type = types.enum [ "default" "reusable" "clustered" ]; description = '' - Rendering mode of <package>grafana-image-renderer</package>: + Rendering mode of <literal>grafana-image-renderer</literal>: <itemizedlist> <listitem><para><literal>default:</literal> Creates on browser-instance per rendering request.</para></listitem> @@ -80,7 +80,7 @@ in { type = types.listOf types.str; default = [ "--no-sandbox" ]; description = '' - List of CLI flags passed to <package>chromium</package>. + List of CLI flags passed to <literal>chromium</literal>. ''; }; }; @@ -90,7 +90,7 @@ in { default = {}; description = '' - Configuration attributes for <package>grafana-image-renderer</package>. + Configuration attributes for <literal>grafana-image-renderer</literal>. See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/> for supported values. diff --git a/nixos/modules/services/monitoring/prometheus/exporters/knot.nix b/nixos/modules/services/monitoring/prometheus/exporters/knot.nix index 2df0ab93bde..44be9641c0a 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/knot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/knot.nix @@ -12,7 +12,7 @@ in { default = "${pkgs.knot-dns.out}/lib/libknot.so"; defaultText = literalExpression ''"''${pkgs.knot-dns.out}/lib/libknot.so"''; description = '' - Path to the library of <package>knot-dns</package>. + Path to the library of <literal>knot-dns</literal>. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix b/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix index 59fcedef9dd..b89ec99c68e 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix @@ -12,7 +12,7 @@ in { example = "/run/keys/ldap_pass"; description = '' Environment file to contain the credentials to authenticate against - <package>openldap</package>. + <literal>openldap</literal>. The file should look like this: <programlisting> @@ -27,14 +27,14 @@ in { example = "udp"; type = types.str; description = '' - Which protocol to use to connect against <package>openldap</package>. + Which protocol to use to connect against <literal>openldap</literal>. ''; }; ldapAddr = mkOption { default = "localhost:389"; type = types.str; description = '' - Address of the <package>openldap</package>-instance. + Address of the <literal>openldap</literal>-instance. ''; }; metricsPath = mkOption { diff --git a/nixos/modules/services/networking/create_ap.nix b/nixos/modules/services/networking/create_ap.nix index a3c330fab00..258ce9501a5 100644 --- a/nixos/modules/services/networking/create_ap.nix +++ b/nixos/modules/services/networking/create_ap.nix @@ -13,7 +13,7 @@ in { type = with types; attrsOf (oneOf [ int bool str ]); default = {}; description = '' - Configuration for <package>create_ap</package>. + Configuration for <literal>create_ap</literal>. See <link xlink:href="https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf">upstream example configuration</link> for supported values. ''; diff --git a/nixos/modules/services/networking/mxisd.nix b/nixos/modules/services/networking/mxisd.nix index 9ddc2094b6d..dc0196360c3 100644 --- a/nixos/modules/services/networking/mxisd.nix +++ b/nixos/modules/services/networking/mxisd.nix @@ -51,7 +51,7 @@ in { default = null; description = '' Path to an environment-file which may contain secrets to be - substituted via <package>envsubst</package>. + substituted via <literal>envsubst</literal>. ''; }; diff --git a/nixos/modules/services/networking/ncdns.nix b/nixos/modules/services/networking/ncdns.nix index 958231963c6..8af1b532cf2 100644 --- a/nixos/modules/services/networking/ncdns.nix +++ b/nixos/modules/services/networking/ncdns.nix @@ -126,7 +126,7 @@ in description = '' Path to the file containing the KSK public key. The key can be generated using the <literal>dnssec-keygen</literal> - command, provided by the package <package>bind</package> as follows: + command, provided by the package <literal>bind</literal> as follows: <programlisting> $ dnssec-keygen -a RSASHA256 -3 -b 2048 -f KSK bit </programlisting> @@ -147,7 +147,7 @@ in description = '' Path to the file containing the ZSK public key. The key can be generated using the <literal>dnssec-keygen</literal> - command, provided by the package <package>bind</package> as follows: + command, provided by the package <literal>bind</literal> as follows: <programlisting> $ dnssec-keygen -a RSASHA256 -3 -b 2048 bit </programlisting> diff --git a/nixos/modules/services/networking/wpa_supplicant.nix b/nixos/modules/services/networking/wpa_supplicant.nix index 59e408f6319..72b665f411f 100644 --- a/nixos/modules/services/networking/wpa_supplicant.nix +++ b/nixos/modules/services/networking/wpa_supplicant.nix @@ -189,10 +189,10 @@ in { allowAuxiliaryImperativeNetworks = mkEnableOption "support for imperative & declarative networks" // { description = '' Whether to allow configuring networks "imperatively" (e.g. via - <package>wpa_supplicant_gui</package>) and declaratively via + <literal>wpa_supplicant_gui</literal>) and declaratively via <xref linkend="opt-networking.wireless.networks"/>. - Please note that this adds a custom patch to <package>wpa_supplicant</package>. + Please note that this adds a custom patch to <literal>wpa_supplicant</literal>. ''; }; diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix index 29c499e33ab..3edec20515e 100644 --- a/nixos/modules/services/security/privacyidea.nix +++ b/nixos/modules/services/security/privacyidea.nix @@ -75,7 +75,7 @@ in description = '' File to load as environment file. Environment variables from this file will be interpolated into the config file - using <package>envsubst</package> which is helpful for specifying + using <literal>envsubst</literal> which is helpful for specifying secrets: <programlisting> { <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; } @@ -205,10 +205,10 @@ in type = with types; attrsOf (attrsOf (oneOf [ str bool int (listOf str) ])); default = {}; description = '' - Attribute-set containing the settings for <package>privacyidea-ldap-proxy</package>. + Attribute-set containing the settings for <literal>privacyidea-ldap-proxy</literal>. It's possible to pass secrets using env-vars as substitutes and use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile"/> - to inject them via <package>envsubst</package>. + to inject them via <literal>envsubst</literal>. ''; }; diff --git a/nixos/modules/services/torrent/magnetico.nix b/nixos/modules/services/torrent/magnetico.nix index 11f1c71e3f8..c7255eba056 100644 --- a/nixos/modules/services/torrent/magnetico.nix +++ b/nixos/modules/services/torrent/magnetico.nix @@ -124,8 +124,8 @@ in { Usernames must start with a lowercase ([a-z]) ASCII character, might contain non-consecutive underscores except at the end, and consists of small-case a-z characters and digits 0-9. The - <command>htpasswd</command> tool from the <package>apacheHttpd - </package> package may be used to generate the hash: <command>htpasswd + <command>htpasswd</command> tool from the <literal>apacheHttpd</literal> + package may be used to generate the hash: <command>htpasswd -bnBC 12 username password</command> <warning> @@ -150,8 +150,8 @@ in { start with a lowecase ([a-z]) ASCII character, might contain non-consecutive underscores except at the end, and consists of small-case a-z characters and digits 0-9. - The <command>htpasswd</command> tool from the <package>apacheHttpd - </package> package may be used to generate the hash: + The <command>htpasswd</command> tool from the <literal>apacheHttpd</literal> + package may be used to generate the hash: <command>htpasswd -bnBC 12 username password</command> ''; }; diff --git a/nixos/modules/services/web-apps/isso.nix b/nixos/modules/services/web-apps/isso.nix index 4c01781a6a2..37fa2f6a8b2 100644 --- a/nixos/modules/services/web-apps/isso.nix +++ b/nixos/modules/services/web-apps/isso.nix @@ -21,7 +21,7 @@ in { settings = mkOption { description = '' - Configuration for <package>isso</package>. + Configuration for <literal>isso</literal>. See <link xlink:href="https://posativ.org/isso/docs/configuration/server/">Isso Server Configuration</link> for supported values. diff --git a/nixos/modules/services/web-apps/mastodon.nix b/nixos/modules/services/web-apps/mastodon.nix index d0594ff7419..7fb904f77f4 100644 --- a/nixos/modules/services/web-apps/mastodon.nix +++ b/nixos/modules/services/web-apps/mastodon.nix @@ -134,10 +134,10 @@ in { User under which mastodon runs. If it is set to "mastodon", 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 + <literal>mastodon</literal> and a package containing only 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 <literal>tootctl</literal> + <literal>mastodon</literal> such as <literal>tootctl</literal> with the environment configured by this module use <literal>mastodon-env</literal>, as in: diff --git a/nixos/modules/services/web-apps/plausible.nix b/nixos/modules/services/web-apps/plausible.nix index 6f098134c92..00b1cf3ce3f 100644 --- a/nixos/modules/services/web-apps/plausible.nix +++ b/nixos/modules/services/web-apps/plausible.nix @@ -50,7 +50,7 @@ in { default = "http://localhost:8123/default"; type = types.str; description = '' - The URL to be used to connect to <package>clickhouse</package>. + The URL to be used to connect to <literal>clickhouse</literal>. ''; }; }; @@ -67,7 +67,7 @@ in { default = "/run/postgresql"; type = types.str; description = '' - Path to the UNIX domain-socket to communicate with <package>postgres</package>. + Path to the UNIX domain-socket to communicate with <literal>postgres</literal>. ''; }; }; diff --git a/nixos/modules/services/web-apps/wiki-js.nix b/nixos/modules/services/web-apps/wiki-js.nix index 5dc0bb73259..76fc37c88b5 100644 --- a/nixos/modules/services/web-apps/wiki-js.nix +++ b/nixos/modules/services/web-apps/wiki-js.nix @@ -57,7 +57,7 @@ in { description = '' Database driver to use for persistence. Please note that <literal>sqlite</literal> is currently not supported as the build process for it is currently not implemented - in <package>pkgs.wiki-js</package> and it's not recommended by upstream for + in <literal>pkgs.wiki-js</literal> and it's not recommended by upstream for production use. ''; }; @@ -94,7 +94,7 @@ in { }; }; description = '' - Settings to configure <package>wiki-js</package>. This directly + Settings to configure <literal>wiki-js</literal>. This directly corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream configuration options</link>. Secrets can be injected via the environment by diff --git a/nixos/modules/services/x11/desktop-managers/none.nix b/nixos/modules/services/x11/desktop-managers/none.nix index b5e498b67a0..f53a2d93a14 100644 --- a/nixos/modules/services/x11/desktop-managers/none.nix +++ b/nixos/modules/services/x11/desktop-managers/none.nix @@ -17,7 +17,7 @@ in <option>service.earlyoom</option> use XDG autostart files to start. If this option is not set to <literal>true</literal> and you are using a window manager without a desktop manager, you need to manually start - them or running <package>dex</package> somewhere. + them or running <literal>dex</literal> somewhere. ''; }; }; diff --git a/nixos/modules/virtualisation/kvmgt.nix b/nixos/modules/virtualisation/kvmgt.nix index 5ea71c3a914..0c4694c1330 100644 --- a/nixos/modules/virtualisation/kvmgt.nix +++ b/nixos/modules/virtualisation/kvmgt.nix @@ -10,7 +10,7 @@ let vgpuOptions = { uuid = mkOption { type = with types; listOf str; - description = "UUID(s) of VGPU device. You can generate one with <package>libossp_uuid</package>."; + description = "UUID(s) of VGPU device. You can generate one with <literal>libossp_uuid</literal>."; }; }; diff --git a/nixos/modules/virtualisation/qemu-vm.nix b/nixos/modules/virtualisation/qemu-vm.nix index 6bfae74f636..63061390915 100644 --- a/nixos/modules/virtualisation/qemu-vm.nix +++ b/nixos/modules/virtualisation/qemu-vm.nix @@ -740,7 +740,7 @@ in default = null; description = '' - An alternate BIOS (such as <package>qboot</package>) with which to start the VM. + An alternate BIOS (such as <literal>qboot</literal>) with which to start the VM. Should contain a file named <literal>bios.bin</literal>. If <literal>null</literal>, QEMU's builtin SeaBIOS will be used. ''; |