colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/*: normalize <package> to <literal>

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/modules/config/ldap.nix
View File

@ -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.
'';

2
nixos/modules/config/system-path.nix
View File

@ -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

4
nixos/modules/config/xdg/portal.nix
View File

@ -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.
'';
};

4
nixos/modules/config/xdg/portals/lxqt.nix
View File

@ -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>.
'';
};
};

4
nixos/modules/config/xdg/portals/wlr.nix
View File

@ -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.

2
nixos/modules/programs/captive-browser.nix
View File

@ -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.
'';

8
nixos/modules/programs/k3b.nix
View File

@ -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.
'';
};

2
nixos/modules/security/dhparams.nix
View File

@ -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>
'';
};

2
nixos/modules/services/home-automation/home-assistant.nix
View File

@ -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.
'';
};

2
nixos/modules/services/misc/etebase-server.nix
View File

@ -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.

2
nixos/modules/services/monitoring/grafana-agent.nix
View File

@ -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/
'';

6
nixos/modules/services/monitoring/grafana-image-renderer.nix
View File

@ -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.

2
nixos/modules/services/monitoring/prometheus/exporters/knot.nix
View File

@ -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>.
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/openldap.nix
View File

@ -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 {

2
nixos/modules/services/networking/create_ap.nix
View File

@ -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.
'';

2
nixos/modules/services/networking/mxisd.nix
View File

@ -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>.
'';
};

4
nixos/modules/services/networking/ncdns.nix
View File

@ -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>

4
nixos/modules/services/networking/wpa_supplicant.nix
View File

@ -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>.
'';
};

6
nixos/modules/services/security/privacyidea.nix
View File

@ -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>.
'';
};

8
nixos/modules/services/torrent/magnetico.nix
View File

@ -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>
'';
};

2
nixos/modules/services/web-apps/isso.nix
View File

@ -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.

4
nixos/modules/services/web-apps/mastodon.nix
View File

@ -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:

4
nixos/modules/services/web-apps/plausible.nix
View File

@ -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>.
'';
};
};

4
nixos/modules/services/web-apps/wiki-js.nix
View File

@ -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

2
nixos/modules/services/x11/desktop-managers/none.nix
View File

@ -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.
'';
};
};

2
nixos/modules/virtualisation/kvmgt.nix
View File

@ -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>.";
};
};

2
nixos/modules/virtualisation/qemu-vm.nix
View File

@ -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.
'';