0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-12 05:16:25 +03:00

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).
This commit is contained in:
pennae 2022-08-13 05:15:06 +02:00 committed by pennae
parent 1ab9224ebe
commit 8f8e101527
27 changed files with 47 additions and 47 deletions

View file

@ -195,7 +195,7 @@ in
actually contact the directory server, and it is possible that actually contact the directory server, and it is possible that
a malformed configuration file will trigger reconnection. If a malformed configuration file will trigger reconnection. If
<literal>soft</literal> is specified, then <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 failure. All hard reconnect policies block with exponential
backoff before retrying. backoff before retrying.
''; '';

View file

@ -89,7 +89,7 @@ in
for a running system, entries can be removed for a more for a running system, entries can be removed for a more
minimal NixOS installation. 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 make sure another editor is installed and the
<literal>EDITOR</literal> environment variable is set to it. <literal>EDITOR</literal> environment variable is set to it.
Environment variables can be set using Environment variables can be set using

View file

@ -44,8 +44,8 @@ in
List of additional portals to add to path. Portals allow interaction List of additional portals to add to path. Portals allow interaction
with system, like choosing files or taking screenshots. At minimum, with system, like choosing files or taking screenshots. At minimum,
a desktop portal implementation should be listed. GNOME and KDE already a desktop portal implementation should be listed. GNOME and KDE already
adds <package>xdg-desktop-portal-gtk</package>; and adds <literal>xdg-desktop-portal-gtk</literal>; and
<package>xdg-desktop-portal-kde</package> respectively. On other desktop <literal>xdg-desktop-portal-kde</literal> respectively. On other desktop
environments you probably want to add them yourself. environments you probably want to add them yourself.
''; '';
}; };

View file

@ -15,7 +15,7 @@ in
enable = mkEnableOption '' enable = mkEnableOption ''
the desktop portal for the LXQt desktop environment. 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 package (with the extra Qt styles) into the
<option>xdg.portal.extraPortals</option> option <option>xdg.portal.extraPortals</option> option
''; '';
@ -31,7 +31,7 @@ in
''; '';
description = '' description = ''
Extra Qt styles that will be available to the Extra Qt styles that will be available to the
<package>lxqt.xdg-desktop-portal-lxqt</package>. <literal>lxqt.xdg-desktop-portal-lxqt</literal>.
''; '';
}; };
}; };

View file

@ -17,14 +17,14 @@ in
enable = mkEnableOption '' enable = mkEnableOption ''
desktop portal for wlroots-based desktops 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 the <option>xdg.portal.extraPortals</option> option, and provide the
configuration file configuration file
''; '';
settings = mkOption { settings = mkOption {
description = '' 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 See <literal>xdg-desktop-portal-wlr(5)</literal> for supported
values. values.

View file

@ -86,7 +86,7 @@ in
default = true; default = true;
type = types.bool; type = types.bool;
description = '' 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 <literal>cfg.interface</literal>. This can be used to avoid collisions
with private subnets. with private subnets.
''; '';

View file

@ -11,11 +11,11 @@ with lib;
description = '' description = ''
Whether to enable k3b, the KDE disk burning application. 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> add <literal>setuid</literal> wrappers in <literal>/run/wrappers/bin</literal>
for both <package>cdrdao</package> and <package>cdrecord</package>. On first for both <literal>cdrdao</literal> and <literal>cdrecord</literal>. On first
run you must manually configure the path of <package>cdrdae</package> and run you must manually configure the path of <literal>cdrdae</literal> and
<package>cdrecord</package> to correspond to the appropriate paths under <literal>cdrecord</literal> to correspond to the appropriate paths under
<literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu. <literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu.
''; '';
}; };

View file

@ -94,7 +94,7 @@ in {
<note><para>If this is <literal>false</literal> the resulting store <note><para>If this is <literal>false</literal> the resulting store
path will be non-deterministic and will be rebuilt every time the 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>
''; '';
}; };

View file

@ -129,7 +129,7 @@ in {
description = '' description = ''
List of packages to add to propagatedBuildInputs. 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. for PostgreSQL support in the recorder component.
''; '';
}; };

View file

@ -134,7 +134,7 @@ in
}; };
default = {}; default = {};
description = '' 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"/> <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/>
and <link xlink:href="https://github.com/etesync/server/wiki"/> and <link xlink:href="https://github.com/etesync/server/wiki"/>
for details on supported values. for details on supported values.

View file

@ -39,7 +39,7 @@ in
settings = mkOption { settings = mkOption {
description = '' description = ''
Configuration for <package>grafana-agent</package>. Configuration for <literal>grafana-agent</literal>.
See https://grafana.com/docs/agent/latest/configuration/ See https://grafana.com/docs/agent/latest/configuration/
''; '';

View file

@ -63,7 +63,7 @@ in {
default = "default"; default = "default";
type = types.enum [ "default" "reusable" "clustered" ]; type = types.enum [ "default" "reusable" "clustered" ];
description = '' description = ''
Rendering mode of <package>grafana-image-renderer</package>: Rendering mode of <literal>grafana-image-renderer</literal>:
<itemizedlist> <itemizedlist>
<listitem><para><literal>default:</literal> Creates on browser-instance <listitem><para><literal>default:</literal> Creates on browser-instance
per rendering request.</para></listitem> per rendering request.</para></listitem>
@ -80,7 +80,7 @@ in {
type = types.listOf types.str; type = types.listOf types.str;
default = [ "--no-sandbox" ]; default = [ "--no-sandbox" ];
description = '' 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 = {}; default = {};
description = '' 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"/> See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/>
for supported values. for supported values.

View file

@ -12,7 +12,7 @@ in {
default = "${pkgs.knot-dns.out}/lib/libknot.so"; default = "${pkgs.knot-dns.out}/lib/libknot.so";
defaultText = literalExpression ''"''${pkgs.knot-dns.out}/lib/libknot.so"''; defaultText = literalExpression ''"''${pkgs.knot-dns.out}/lib/libknot.so"'';
description = '' description = ''
Path to the library of <package>knot-dns</package>. Path to the library of <literal>knot-dns</literal>.
''; '';
}; };

View file

@ -12,7 +12,7 @@ in {
example = "/run/keys/ldap_pass"; example = "/run/keys/ldap_pass";
description = '' description = ''
Environment file to contain the credentials to authenticate against Environment file to contain the credentials to authenticate against
<package>openldap</package>. <literal>openldap</literal>.
The file should look like this: The file should look like this:
<programlisting> <programlisting>
@ -27,14 +27,14 @@ in {
example = "udp"; example = "udp";
type = types.str; type = types.str;
description = '' description = ''
Which protocol to use to connect against <package>openldap</package>. Which protocol to use to connect against <literal>openldap</literal>.
''; '';
}; };
ldapAddr = mkOption { ldapAddr = mkOption {
default = "localhost:389"; default = "localhost:389";
type = types.str; type = types.str;
description = '' description = ''
Address of the <package>openldap</package>-instance. Address of the <literal>openldap</literal>-instance.
''; '';
}; };
metricsPath = mkOption { metricsPath = mkOption {

View file

@ -13,7 +13,7 @@ in {
type = with types; attrsOf (oneOf [ int bool str ]); type = with types; attrsOf (oneOf [ int bool str ]);
default = {}; default = {};
description = '' 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> 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. for supported values.
''; '';

View file

@ -51,7 +51,7 @@ in {
default = null; default = null;
description = '' description = ''
Path to an environment-file which may contain secrets to be Path to an environment-file which may contain secrets to be
substituted via <package>envsubst</package>. substituted via <literal>envsubst</literal>.
''; '';
}; };

View file

@ -126,7 +126,7 @@ in
description = '' description = ''
Path to the file containing the KSK public key. Path to the file containing the KSK public key.
The key can be generated using the <literal>dnssec-keygen</literal> 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> <programlisting>
$ dnssec-keygen -a RSASHA256 -3 -b 2048 -f KSK bit $ dnssec-keygen -a RSASHA256 -3 -b 2048 -f KSK bit
</programlisting> </programlisting>
@ -147,7 +147,7 @@ in
description = '' description = ''
Path to the file containing the ZSK public key. Path to the file containing the ZSK public key.
The key can be generated using the <literal>dnssec-keygen</literal> 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> <programlisting>
$ dnssec-keygen -a RSASHA256 -3 -b 2048 bit $ dnssec-keygen -a RSASHA256 -3 -b 2048 bit
</programlisting> </programlisting>

View file

@ -189,10 +189,10 @@ in {
allowAuxiliaryImperativeNetworks = mkEnableOption "support for imperative & declarative networks" // { allowAuxiliaryImperativeNetworks = mkEnableOption "support for imperative & declarative networks" // {
description = '' description = ''
Whether to allow configuring networks "imperatively" (e.g. via 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"/>. <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>.
''; '';
}; };

View file

@ -75,7 +75,7 @@ in
description = '' description = ''
File to load as environment file. Environment variables File to load as environment file. Environment variables
from this file will be interpolated into the config file 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: secrets:
<programlisting> <programlisting>
{ <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; } { <xref linkend="opt-services.privacyidea.secretKey"/> = "$SECRET"; }
@ -205,10 +205,10 @@ in
type = with types; attrsOf (attrsOf (oneOf [ str bool int (listOf str) ])); type = with types; attrsOf (attrsOf (oneOf [ str bool int (listOf str) ]));
default = {}; default = {};
description = '' 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 It's possible to pass secrets using env-vars as substitutes and
use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile"/> 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>.
''; '';
}; };

View file

@ -124,8 +124,8 @@ in {
Usernames must start with a lowercase ([a-z]) ASCII character, might Usernames must start with a lowercase ([a-z]) ASCII character, might
contain non-consecutive underscores except at the end, and consists of contain non-consecutive underscores except at the end, and consists of
small-case a-z characters and digits 0-9. The small-case a-z characters and digits 0-9. The
<command>htpasswd</command> tool from the <package>apacheHttpd <command>htpasswd</command> tool from the <literal>apacheHttpd</literal>
</package> package may be used to generate the hash: <command>htpasswd package may be used to generate the hash: <command>htpasswd
-bnBC 12 username password</command> -bnBC 12 username password</command>
<warning> <warning>
@ -150,8 +150,8 @@ in {
start with a lowecase ([a-z]) ASCII character, might contain start with a lowecase ([a-z]) ASCII character, might contain
non-consecutive underscores except at the end, and consists of non-consecutive underscores except at the end, and consists of
small-case a-z characters and digits 0-9. small-case a-z characters and digits 0-9.
The <command>htpasswd</command> tool from the <package>apacheHttpd The <command>htpasswd</command> tool from the <literal>apacheHttpd</literal>
</package> package may be used to generate the hash: package may be used to generate the hash:
<command>htpasswd -bnBC 12 username password</command> <command>htpasswd -bnBC 12 username password</command>
''; '';
}; };

View file

@ -21,7 +21,7 @@ in {
settings = mkOption { settings = mkOption {
description = '' 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> See <link xlink:href="https://posativ.org/isso/docs/configuration/server/">Isso Server Configuration</link>
for supported values. for supported values.

View file

@ -134,10 +134,10 @@ in {
User under which mastodon runs. If it is set to "mastodon", User under which mastodon runs. If it is set to "mastodon",
that user will be created, otherwise it should be set to the that user will be created, otherwise it should be set to the
name of a user created elsewhere. In both cases, 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 shell script <literal>mastodon-env</literal> will be added to
the user's package set. To run a command from 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 with the environment configured by this module use
<literal>mastodon-env</literal>, as in: <literal>mastodon-env</literal>, as in:

View file

@ -50,7 +50,7 @@ in {
default = "http://localhost:8123/default"; default = "http://localhost:8123/default";
type = types.str; type = types.str;
description = '' 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"; default = "/run/postgresql";
type = types.str; type = types.str;
description = '' 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>.
''; '';
}; };
}; };

View file

@ -57,7 +57,7 @@ in {
description = '' description = ''
Database driver to use for persistence. Please note that <literal>sqlite</literal> 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 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. production use.
''; '';
}; };
@ -94,7 +94,7 @@ in {
}; };
}; };
description = '' 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>. corresponds to <link xlink:href="https://docs.requarks.io/install/config">the upstream configuration options</link>.
Secrets can be injected via the environment by Secrets can be injected via the environment by

View file

@ -17,7 +17,7 @@ in
<option>service.earlyoom</option> use XDG autostart files to start. <option>service.earlyoom</option> use XDG autostart files to start.
If this option is not set to <literal>true</literal> and you are using 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 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.
''; '';
}; };
}; };

View file

@ -10,7 +10,7 @@ let
vgpuOptions = { vgpuOptions = {
uuid = mkOption { uuid = mkOption {
type = with types; listOf str; 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>.";
}; };
}; };

View file

@ -740,7 +740,7 @@ in
default = null; default = null;
description = 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>. Should contain a file named <literal>bios.bin</literal>.
If <literal>null</literal>, QEMU's builtin SeaBIOS will be used. If <literal>null</literal>, QEMU's builtin SeaBIOS will be used.
''; '';