Mirrors/home-manager
2
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-10 07:04:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

treewide: convert all option docs to Markdown

Browse source 
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
Emily 2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
modules/accounts/calendar.nix
View file

@ -13,24 +13,24 @@ let
type = types.str;
default = "${cfg.basePath}/${name}";
defaultText = "‹accounts.calendar.basePath›/‹name›";
description = "The path of the storage.";
description = lib.mdDoc "The path of the storage.";
};
type = mkOption {
type = types.enum [ "filesystem" "singlefile" ];
description = "The type of the storage.";
description = lib.mdDoc "The type of the storage.";
};
fileExt = mkOption {
type = types.nullOr types.str;
default = null;
description = "The file extension to use.";
description = lib.mdDoc "The file extension to use.";
};
encoding = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
File encoding for items, both content and file name.
Defaults to UTF-8.
'';
@ -42,19 +42,19 @@ let
options = {
type = mkOption {
type = types.enum [ "caldav" "http" "google_calendar" ];
description = "The type of the storage.";
description = lib.mdDoc "The type of the storage.";
};
url = mkOption {
type = types.nullOr types.str;
default = null;
description = "The URL of the storage.";
description = lib.mdDoc "The URL of the storage.";
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = "User name for authentication.";
description = lib.mdDoc "User name for authentication.";
};
# userNameCommand = mkOption {
@ -70,7 +70,7 @@ let
type = types.nullOr (types.listOf types.str);
default = null;
example = [ "pass" "caldav" ];
description = ''
description = lib.mdDoc ''
A command that prints the password to standard output.
'';
};
@ -82,7 +82,7 @@ let
name = mkOption {
type = types.str;
readOnly = true;
description = ''
description = lib.mdDoc ''
Unique identifier of the calendar. This is set to the
attribute name of the calendar configuration.
'';
@ -91,7 +91,7 @@ let
primary = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether this is the primary account. Only one account may be
set as primary.
'';
@ -99,7 +99,7 @@ let
primaryCollection = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
The primary collection of the account. Required when an
account has multiple collections.
'';
@ -108,7 +108,7 @@ let
local = mkOption {
type = types.nullOr (localModule name);
default = null;
description = ''
description = lib.mdDoc ''
Local configuration for the calendar.
'';
};
@ -116,7 +116,7 @@ let
remote = mkOption {
type = types.nullOr remoteModule;
default = null;
description = ''
description = lib.mdDoc ''
Remote configuration for the calendar.
'';
};
@ -131,7 +131,7 @@ in {
type = types.str;
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = ''
description = lib.mdDoc ''
The base directory in which to save calendars. May be a
relative path, in which case it is relative the home
directory.
@ -146,7 +146,7 @@ in {
(import ../programs/khal-calendar-accounts.nix)
]);
default = { };
description = "List of calendars.";
description = lib.mdDoc "List of calendars.";
};
};
config = mkIf (cfg.accounts != { }) {

26
modules/accounts/contacts.nix
View file

@ -13,24 +13,24 @@ let
type = types.str;
default = "${cfg.basePath}/${name}";
defaultText = "‹accounts.contact.basePath›/‹name›";
description = "The path of the storage.";
description = lib.mdDoc "The path of the storage.";
};
type = mkOption {
type = types.enum [ "filesystem" "singlefile" ];
description = "The type of the storage.";
description = lib.mdDoc "The type of the storage.";
};
fileExt = mkOption {
type = types.nullOr types.str;
default = null;
description = "The file extension to use.";
description = lib.mdDoc "The file extension to use.";
};
encoding = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
File encoding for items, both content and file name.
Defaults to UTF-8.
'';
@ -42,19 +42,19 @@ let
options = {
type = mkOption {
type = types.enum [ "carddav" "http" "google_contacts" ];
description = "The type of the storage.";
description = lib.mdDoc "The type of the storage.";
};
url = mkOption {
type = types.nullOr types.str;
default = null;
description = "The URL of the storage.";
description = lib.mdDoc "The URL of the storage.";
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = "User name for authentication.";
description = lib.mdDoc "User name for authentication.";
};
# userNameCommand = mkOption {
@ -70,7 +70,7 @@ let
type = types.nullOr (types.listOf types.str);
default = null;
example = [ "pass" "caldav" ];
description = ''
description = lib.mdDoc ''
A command that prints the password to standard output.
'';
};
@ -82,7 +82,7 @@ let
name = mkOption {
type = types.str;
readOnly = true;
description = ''
description = lib.mdDoc ''
Unique identifier of the contact account. This is set to the
attribute name of the contact configuration.
'';
@ -91,7 +91,7 @@ let
local = mkOption {
type = types.nullOr (localModule name);
default = null;
description = ''
description = lib.mdDoc ''
Local configuration for the contacts.
'';
};
@ -99,7 +99,7 @@ let
remote = mkOption {
type = types.nullOr remoteModule;
default = null;
description = ''
description = lib.mdDoc ''
Remote configuration for the contacts.
'';
};
@ -114,7 +114,7 @@ in {
type = types.str;
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = ''
description = lib.mdDoc ''
The base directory in which to save contacts. May be a
relative path, in which case it is relative the home
directory.
@ -128,7 +128,7 @@ in {
(import ../programs/khal-accounts.nix)
]);
default = { };
description = "List of contacts.";
description = lib.mdDoc "List of contacts.";
};
};
}

108
modules/accounts/email.nix
View file

@ -10,21 +10,21 @@ let
options = {
key = mkOption {
type = types.str;
description = ''
The key to use as listed in <command>gpg --list-keys</command>.
description = lib.mdDoc ''
The key to use as listed in {command}`gpg --list-keys`.
'';
};
signByDefault = mkOption {
type = types.bool;
default = false;
description = "Sign messages by default.";
description = lib.mdDoc "Sign messages by default.";
};
encryptByDefault = mkOption {
type = types.bool;
default = false;
description = "Encrypt outgoing messages by default.";
description = lib.mdDoc "Encrypt outgoing messages by default.";
};
};
};
@ -39,7 +39,7 @@ let
Luke Skywalker
May the force be with you.
'';
description = ''
description = lib.mdDoc ''
Signature content.
'';
};
@ -52,7 +52,7 @@ let
example = literalExpression ''
~*~*~*~*~*~*~*~*~*~*~*~
'';
description = ''
description = lib.mdDoc ''
The delimiter used between the document and the signature.
'';
};
@ -63,13 +63,13 @@ let
example = literalExpression ''
pkgs.writeScript "signature" "echo This is my signature"
'';
description = "A command that generates a signature.";
description = lib.mdDoc "A command that generates a signature.";
};
showSignature = mkOption {
type = types.enum [ "append" "attach" "none" ];
default = "none";
description = "Method to communicate the signature.";
description = lib.mdDoc "Method to communicate the signature.";
};
};
};
@ -79,7 +79,7 @@ let
enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable TLS/SSL.
'';
};
@ -87,7 +87,7 @@ let
useStartTls = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to use STARTTLS.
'';
};
@ -96,10 +96,10 @@ let
type = types.nullOr types.path;
default = config.accounts.email.certificatesFile;
defaultText = "config.accounts.email.certificatesFile";
description = ''
description = lib.mdDoc ''
Path to file containing certificate authorities that should
be used to validate the connection authenticity. If
<literal>null</literal> then the system default is used.
`null` then the system default is used.
Note, if set then the system default may still be accepted.
'';
};
@ -111,7 +111,7 @@ let
host = mkOption {
type = types.str;
example = "imap.example.org";
description = ''
description = lib.mdDoc ''
Hostname of IMAP server.
'';
};
@ -120,16 +120,16 @@ let
type = types.nullOr types.port;
default = null;
example = 993;
description = ''
description = lib.mdDoc ''
The port on which the IMAP server listens. If
<literal>null</literal> then the default port is used.
`null` then the default port is used.
'';
};
tls = mkOption {
type = tlsModule;
default = { };
description = ''
description = lib.mdDoc ''
Configuration for secure connections.
'';
};
@ -142,12 +142,11 @@ let
type = types.nullOr types.str;
default = null;
example = "jmap.example.org";
description = ''
description = lib.mdDoc ''
Hostname of JMAP server.
</para><para>
If both this option and <xref
linkend="opt-accounts.email.accounts._name_.jmap.sessionUrl"/> are specified,
<literal>host</literal> is preferred by applications when establishing a
If both this option and [](#opt-accounts.email.accounts._name_.jmap.sessionUrl) are specified,
`host` is preferred by applications when establishing a
session.
'';
};
@ -156,12 +155,11 @@ let
type = types.nullOr types.str;
default = null;
example = "https://jmap.example.org:443/.well-known/jmap";
description = ''
description = lib.mdDoc ''
URL for the JMAP Session resource.
</para><para>
If both this option and <xref
linkend="opt-accounts.email.accounts._name_.jmap.host"/> are specified,
<literal>host</literal> is preferred by applications when establishing a
If both this option and [](#opt-accounts.email.accounts._name_.jmap.host) are specified,
`host` is preferred by applications when establishing a
session.
'';
};
@ -173,7 +171,7 @@ let
host = mkOption {
type = types.str;
example = "smtp.example.org";
description = ''
description = lib.mdDoc ''
Hostname of SMTP server.
'';
};
@ -182,16 +180,16 @@ let
type = types.nullOr types.port;
default = null;
example = 465;
description = ''
description = lib.mdDoc ''
The port on which the SMTP server listens. If
<literal>null</literal> then the default port is used.
`null` then the default port is used.
'';
};
tls = mkOption {
type = tlsModule;
default = { };
description = ''
description = lib.mdDoc ''
Configuration for secure connections.
'';
};
@ -202,7 +200,7 @@ let
options = {
path = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Path to maildir directory where mail for this account is
stored. This is relative to the base maildir path.
'';
@ -213,7 +211,7 @@ let
readOnly = true;
internal = true;
default = "${cfg.maildirBasePath}/${config.path}";
description = ''
description = lib.mdDoc ''
A convenience option whose value is the absolute path of
this maildir.
'';
@ -226,7 +224,7 @@ let
name = mkOption {
type = types.str;
readOnly = true;
description = ''
description = lib.mdDoc ''
Unique identifier of the account. This is set to the
attribute name of the account configuration.
'';
@ -235,7 +233,7 @@ let
primary = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether this is the primary account. Only one account may be
set as primary.
'';
@ -251,11 +249,11 @@ let
"outlook.office365.com"
];
default = "plain";
description = ''
description = lib.mdDoc ''
Some email providers have peculiar behavior that require
special treatment. This option is therefore intended to
indicate the nature of the provider.
</para><para>
When this indicates a specific provider then, for example,
the IMAP, SMTP, and JMAP server configuration may be set
automatically.
@ -265,26 +263,26 @@ let
address = mkOption {
type = types.strMatching ".*@.*";
example = "jane.doe@example.org";
description = "The email address of this account.";
description = lib.mdDoc "The email address of this account.";
};
aliases = mkOption {
type = types.listOf (types.strMatching ".*@.*");
default = [ ];
example = [ "webmaster@example.org" "admin@example.org" ];
description = "Alternative email addresses of this account.";
description = lib.mdDoc "Alternative email addresses of this account.";
};
realName = mkOption {
type = types.str;
example = "Jane Doe";
description = "Name displayed when sending mails.";
description = lib.mdDoc "Name displayed when sending mails.";
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
The server username of this account. This will be used as
the SMTP, IMAP, and JMAP user name.
'';
@ -295,7 +293,7 @@ let
default = null;
apply = p: if isString p then splitString " " p else p;
example = "secret-tool lookup email me@example.org";
description = ''
description = lib.mdDoc ''
A command, which when run writes the account password on
standard output.
'';
@ -307,7 +305,7 @@ let
inbox = mkOption {
type = types.str;
default = "Inbox";
description = ''
description = lib.mdDoc ''
Relative path of the inbox mail.
'';
};
@ -315,7 +313,7 @@ let
sent = mkOption {
type = types.nullOr types.str;
default = "Sent";
description = ''
description = lib.mdDoc ''
Relative path of the sent mail folder.
'';
};
@ -323,7 +321,7 @@ let
drafts = mkOption {
type = types.nullOr types.str;
default = "Drafts";
description = ''
description = lib.mdDoc ''
Relative path of the drafts mail folder.
'';
};
@ -331,14 +329,14 @@ let
trash = mkOption {
type = types.str;
default = "Trash";
description = ''
description = lib.mdDoc ''
Relative path of the deleted mail folder.
'';
};
};
};
default = { };
description = ''
description = lib.mdDoc ''
Standard email folders.
'';
};
@ -346,7 +344,7 @@ let
imap = mkOption {
type = types.nullOr imapModule;
default = null;
description = ''
description = lib.mdDoc ''
The IMAP configuration to use for this account.
'';
};
@ -354,7 +352,7 @@ let
jmap = mkOption {
type = types.nullOr jmapModule;
default = null;
description = ''
description = lib.mdDoc ''
The JMAP configuration to use for this account.
'';
};
@ -362,7 +360,7 @@ let
signature = mkOption {
type = signatureModule;
default = { };
description = ''
description = lib.mdDoc ''
Signature configuration.
'';
};
@ -370,7 +368,7 @@ let
gpg = mkOption {
type = types.nullOr gpgModule;
default = null;
description = ''
description = lib.mdDoc ''
GPG configuration.
'';
};
@ -378,7 +376,7 @@ let
smtp = mkOption {
type = types.nullOr smtpModule;
default = null;
description = ''
description = lib.mdDoc ''
The SMTP configuration to use for this account.
'';
};
@ -386,7 +384,7 @@ let
maildir = mkOption {
type = types.nullOr maildirModule;
defaultText = { path = "\${name}"; };
description = ''
description = lib.mdDoc ''
Maildir configuration for this account.
'';
};
@ -479,7 +477,7 @@ in {
certificatesFile = mkOption {
type = types.nullOr types.path;
default = "/etc/ssl/certs/ca-certificates.crt";
description = ''
description = lib.mdDoc ''
Path to default file containing certificate authorities that
should be used to validate the connection authenticity. This
path may be overridden on a per-account basis.
@ -492,7 +490,7 @@ in {
defaultText = "$HOME/Maildir";
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = ''
description = lib.mdDoc ''
The base directory for account maildir directories. May be a
relative path, in which case it is relative the home
directory.
@ -502,7 +500,7 @@ in {
accounts = mkOption {
type = types.attrsOf (types.submodule mailAccountOpts);
default = { };
description = "List of email accounts.";
description = lib.mdDoc "List of email accounts.";
};
};

37
modules/config/home-cursor.nix
View file

@ -11,39 +11,40 @@ let
package = mkOption {
type = types.package;
example = literalExpression "pkgs.vanilla-dmz";
description = "Package providing the cursor theme.";
description = lib.mdDoc "Package providing the cursor theme.";
};
name = mkOption {
type = types.str;
example = "Vanilla-DMZ";
description = "The cursor name within the package.";
description = lib.mdDoc "The cursor name within the package.";
};
size = mkOption {
type = types.int;
default = 32;
example = 64;
description = "The cursor size.";
description = lib.mdDoc "The cursor size.";
};
x11 = {
enable = mkEnableOption ''
x11 config generation for <option>home.pointerCursor</option>
'';
enable = mkEnableOption (lib.mdDoc ''
x11 config generation for {option}`home.pointerCursor`
'');
defaultCursor = mkOption {
type = types.str;
default = "left_ptr";
example = "X_cursor";
description = "The default cursor file to use within the package.";
description =
lib.mdDoc "The default cursor file to use within the package.";
};
};
gtk = {
enable = mkEnableOption ''
gtk config generation for <option>home.pointerCursor</option>
'';
enable = mkEnableOption (lib.mdDoc ''
gtk config generation for {option}`home.pointerCursor`
'');
};
};
};
@ -94,21 +95,21 @@ in {
home.pointerCursor = mkOption {
type = types.nullOr pointerCursorModule;
default = null;
description = ''
Cursor configuration. Set to <literal>null</literal> to disable.
</para><para>
description = lib.mdDoc ''
Cursor configuration. Set to `null` to disable.
Top-level options declared under this submodule are backend independent
options. Options declared under namespaces such as <literal>x11</literal>
options. Options declared under namespaces such as `x11`
are backend specific options. By default, only backend independent cursor
configurations are generated. If you need configurations for specific
backends, you can toggle them via the enable option. For example,
<xref linkend="opt-home.pointerCursor.x11.enable"/>
[](#opt-home.pointerCursor.x11.enable)
will enable x11 cursor configurations.
</para><para>
Note that this will merely generate the cursor configurations.
To apply the configurations, the relevant subsytems must also be configured.
For example, <xref linkend="opt-home.pointerCursor.gtk.enable"/> will generate
the gtk cursor configuration, but <xref linkend="opt-gtk.enable"/> needs
For example, [](#opt-home.pointerCursor.gtk.enable) will generate
the gtk cursor configuration, but [](#opt-gtk.enable) needs
to be set for it to be applied.
'';
};

12
modules/config/i18n.nix
View file

@ -40,14 +40,14 @@ in {
options = {
i18n.glibcLocales = mkOption {
type = types.path;
description = ''
Customized <literal>glibcLocales</literal> package providing
the <literal>LOCALE_ARCHIVE_*</literal> environment variable.
</para><para>
description = lib.mdDoc ''
Customized `glibcLocales` package providing
the `LOCALE_ARCHIVE_*` environment variable.
This option only applies to the Linux platform.
</para><para>
When Home Manager is configured with NixOS, the default value
will be set to <varname>i18n.glibcLocales</varname> from the
will be set to {var}`i18n.glibcLocales` from the
system configuration.
'';
example = literalExpression ''

4
modules/files.nix
View file

@ -26,7 +26,7 @@ in
{
options = {
home.file = mkOption {
description = "Attribute set of files to link into the user home.";
description = lib.mdDoc "Attribute set of files to link into the user home.";
default = {};
type = fileType "home.file" "{env}`HOME`" homeDirectory;
};
@ -34,7 +34,7 @@ in
home-files = mkOption {
type = types.package;
internal = true;
description = "Package to contain all home files";
description = lib.mdDoc "Package to contain all home files";
};
};

172
modules/home-environment.nix
View file

@ -13,7 +13,7 @@ let
base = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use unless overridden by a more specific option.
'';
};
@ -21,7 +21,7 @@ let
ctype = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
Character classification category.
'';
};
@ -29,7 +29,7 @@ let
numeric = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for numerical values.
'';
};
@ -37,7 +37,7 @@ let
time = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for formatting times.
'';
};
@ -45,7 +45,7 @@ let
collate = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for collation (alphabetical ordering).
'';
};
@ -53,7 +53,7 @@ let
monetary = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for formatting currencies and money amounts.
'';
};
@ -61,7 +61,7 @@ let
messages = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for messages, application UI languages, etc.
'';
};
@ -69,7 +69,7 @@ let
paper = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for paper sizes.
'';
};
@ -77,7 +77,7 @@ let
name = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for personal names.
'';
};
@ -85,7 +85,7 @@ let
address = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for addresses.
'';
};
@ -93,7 +93,7 @@ let
telephone = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for telephone numbers.
'';
};
@ -101,7 +101,7 @@ let
measurement = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The language to use for measurement values.
'';
};
@ -118,12 +118,12 @@ let
then null
else "us";
defaultText = literalExpression "null";
description = ''
Keyboard layout. If <literal>null</literal>, then the system
description = lib.mdDoc ''
Keyboard layout. If `null`, then the system
configuration will be used.
</para><para>
This defaults to <literal>null</literal> for state
version ≥ 19.09 and <literal>"us"</literal> otherwise.
This defaults to `null` for state
version ≥ 19.09 and `"us"` otherwise.
'';
};
@ -131,7 +131,7 @@ let
type = with types; nullOr str;
default = null;
example = "presario";
description = ''
description = lib.mdDoc ''
Keyboard model.
'';
};
@ -140,7 +140,7 @@ let
type = types.listOf types.str;
default = [];
example = ["grp:caps_toggle" "grp_led:scroll"];
description = ''
description = lib.mdDoc ''
X keyboard options; layout switching goes here.
'';
};
@ -153,12 +153,12 @@ let
else "";
defaultText = literalExpression "null";
example = "colemak";
description = ''
X keyboard variant. If <literal>null</literal>, then the
description = lib.mdDoc ''
X keyboard variant. If `null`, then the
system configuration will be used.
</para><para>
This defaults to <literal>null</literal> for state
version ≥ 19.09 and <literal>""</literal> otherwise.
This defaults to `null` for state
version ≥ 19.09 and `""` otherwise.
'';
};
};
@ -189,7 +189,7 @@ in
undefined for state version ≥ 20.09
'';
example = "jane.doe";
description = "The user's username.";
description = lib.mdDoc "The user's username.";
};
home.homeDirectory = mkOption {
@ -200,7 +200,7 @@ in
'';
apply = toString;
example = "/home/jane.doe";
description = "The user's home directory. Must be an absolute path.";
description = lib.mdDoc "The user's home directory. Must be an absolute path.";
};
home.profileDirectory = mkOption {
@ -210,7 +210,7 @@ in
"/etc/profiles/per-user/''${home.username}"
'';
readOnly = true;
description = ''
description = lib.mdDoc ''
The profile directory where Home Manager generations are installed.
'';
};
@ -218,7 +218,7 @@ in
home.language = mkOption {
type = languageSubModule;
default = {};
description = "Language configuration.";
description = lib.mdDoc "Language configuration.";
};
home.keyboard = mkOption {
@ -228,8 +228,8 @@ in
"{ }" for state version < 21.11,
"null" for state version ≥ 21.11
'';
description = ''
Keyboard configuration. Set to <literal>null</literal> to
description = lib.mdDoc ''
Keyboard configuration. Set to `null` to
disable Home Manager keyboard management.
'';
};
@ -243,14 +243,14 @@ in
"..." = "cd ../..";
}
'';
description = ''
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names
in this option) to command strings or directly to build outputs.
</para><para>
This option should only be used to manage simple aliases that are
compatible across all shells. If you need to use a shell specific
feature then make sure to use a shell specific option, for example
<xref linkend="opt-programs.bash.shellAliases"/> for Bash.
[](#opt-programs.bash.shellAliases) for Bash.
'';
};
@ -258,45 +258,45 @@ in
default = {};
type = with types; lazyAttrsOf (oneOf [ str path int float ]);
example = { EDITOR = "emacs"; GS_OPTIONS = "-sPAPERSIZE=a4"; };
description = ''
description = lib.mdDoc ''
Environment variables to always set at login.
</para><para>
The values may refer to other environment variables using
POSIX.2 style variable references. For example, a variable
<varname>parameter</varname> may be referenced as
<literal>$parameter</literal> or <literal>''${parameter}</literal>. A
default value <literal>foo</literal> may be given as per
<literal>''${parameter:-foo}</literal> and, similarly, an alternate
value <literal>bar</literal> can be given as per
<literal>''${parameter:+bar}</literal>.
</para><para>
{var}`parameter` may be referenced as
`$parameter` or `''${parameter}`. A
default value `foo` may be given as per
`''${parameter:-foo}` and, similarly, an alternate
value `bar` can be given as per
`''${parameter:+bar}`.
Note, these variables may be set in any order so no session
variable may have a runtime dependency on another session
variable. In particular code like
<programlisting language="nix">
```nix
home.sessionVariables = {
FOO = "Hello";
BAR = "$FOO World!";
};
</programlisting>
```
may not work as expected. If you need to reference another
session variable, then do so inside Nix instead. The above
example then becomes
<programlisting language="nix">
```nix
home.sessionVariables = {
FOO = "Hello";
BAR = "''${config.home.sessionVariables.FOO} World!";
};
</programlisting>
```
'';
};
home.sessionVariablesPackage = mkOption {
type = types.package;
internal = true;
description = ''
description = lib.mdDoc ''
The package containing the
<filename>hm-session-vars.sh</filename> file.
{file}`hm-session-vars.sh` file.
'';
};
@ -308,15 +308,13 @@ in
"\${xdg.configHome}/emacs/bin"
".git/safe/../../bin"
];
description = ''
Extra directories to add to <envar>PATH</envar>.
description = lib.mdDoc ''
Extra directories to add to {env}`PATH`.
</para><para>
These directories are added to the <envar>PATH</envar> variable in a
double-quoted context, so expressions like <literal>$HOME</literal> are
expanded by the shell. However, since expressions like <literal>~</literal> or
<literal>*</literal> are escaped, they will end up in the <envar>PATH</envar>
These directories are added to the {env}`PATH` variable in a
double-quoted context, so expressions like `$HOME` are
expanded by the shell. However, since expressions like `~` or
`*` are escaped, they will end up in the {env}`PATH`
verbatim.
'';
};
@ -325,32 +323,32 @@ in
type = types.lines;
default = "";
internal = true;
description = ''
description = lib.mdDoc ''
Extra configuration to add to the
<filename>hm-session-vars.sh</filename> file.
{file}`hm-session-vars.sh` file.
'';
};
home.packages = mkOption {
type = types.listOf types.package;
default = [];
description = "The set of packages to appear in the user environment.";
description = lib.mdDoc "The set of packages to appear in the user environment.";
};
home.extraOutputsToInstall = mkOption {
type = types.listOf types.str;
default = [];
example = [ "doc" "info" "devdoc" ];
description = ''
description = lib.mdDoc ''
List of additional package outputs of the packages
<varname>home.packages</varname> that should be installed into
{var}`home.packages` that should be installed into
the user environment.
'';
};
home.path = mkOption {
internal = true;
description = "The derivation installing the user packages.";
description = lib.mdDoc "The derivation installing the user packages.";
};
home.emptyActivationPath = mkOption {
@ -361,11 +359,11 @@ in
false for state version < 22.11,
true for state version ≥ 22.11
'';
description = ''
description = lib.mdDoc ''
Whether the activation script should start with an empty
<envar>PATH</envar> variable. When <literal>false</literal> then the
user's <envar>PATH</envar> will be accessible in the script. It is
recommended to keep this at <literal>true</literal> to avoid
{env}`PATH` variable. When `false` then the
user's {env}`PATH` will be accessible in the script. It is
recommended to keep this at `true` to avoid
uncontrolled use of tools found in PATH.
'';
};
@ -381,56 +379,50 @@ in
''';
}
'';
description = ''
description = lib.mdDoc ''
The activation scripts blocks to run when activating a Home
Manager generation. Any entry here should be idempotent,
meaning running twice or more times produces the same result
as running it once.
</para><para>
If the script block produces any observable side effect, such
as writing or deleting files, then it
<emphasis>must</emphasis> be placed after the special
<literal>writeBoundary</literal> script block. Prior to the
*must* be placed after the special
`writeBoundary` script block. Prior to the
write boundary one can place script blocks that verifies, but
does not modify, the state of the system and exits if an
unexpected state is found. For example, the
<literal>checkLinkTargets</literal> script block checks for
`checkLinkTargets` script block checks for
collisions between non-managed files and files defined in
<xref linkend="opt-home.file"/>.
[](#opt-home.file).
</para><para>
A script block should respect the <varname>DRY_RUN</varname>
A script block should respect the {var}`DRY_RUN`
variable, if it is set then the actions taken by the script
should be logged to standard out and not actually performed.
The variable <varname>DRY_RUN_CMD</varname> is set to
<command>echo</command> if dry run is enabled.
</para><para>
The variable {var}`DRY_RUN_CMD` is set to
{command}`echo` if dry run is enabled.
A script block should also respect the
<varname>VERBOSE</varname> variable, and if set print
{var}`VERBOSE` variable, and if set print
information on standard out that may be useful for debugging
any issue that may arise. The variable
<varname>VERBOSE_ARG</varname> is set to
<option>--verbose</option> if verbose output is enabled.
{var}`VERBOSE_ARG` is set to
{option}`--verbose` if verbose output is enabled.
'';
};
home.activationPackage = mkOption {
internal = true;
type = types.package;
description = "The package containing the complete activation script.";
description = lib.mdDoc "The package containing the complete activation script.";
};
home.extraActivationPath = mkOption {
internal = true;
type = types.listOf types.package;
default = [ ];
description = ''
Extra packages to add to <envar>PATH</envar> within the activation
description = lib.mdDoc ''
Extra packages to add to {env}`PATH` within the activation
script.
'';
};
@ -439,7 +431,7 @@ in
type = types.lines;
default = "";
internal = true;
description = ''
description = lib.mdDoc ''
Extra commands to run in the Home Manager generation builder.
'';
};
@ -448,7 +440,7 @@ in
type = types.lines;
default = "";
internal = true;
description = ''
description = lib.mdDoc ''
Extra commands to run in the Home Manager profile builder.
'';
};
@ -456,13 +448,13 @@ in
home.enableNixpkgsReleaseCheck = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Determines whether to check for release version mismatch between Home
Manager and Nixpkgs. Using mismatched versions is likely to cause errors
and unexpected behavior. It is therefore highly recommended to use a
release of Home Manager that corresponds with your chosen release of
Nixpkgs.
</para><para>
When this option is enabled and a mismatch is detected then a warning
will be printed when the user configuration is being built.
'';

2
modules/i18n/input-method/default.nix
View file

@ -65,7 +65,7 @@ in {
internal = true;
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
The input method method package.
'';
};

2
modules/i18n/input-method/fcitx5.nix
View file

@ -13,7 +13,7 @@ in {
type = with types; listOf package;
default = [ ];
example = literalExpression "with pkgs; [ fcitx5-rime ]";
description = ''
description = lib.mdDoc ''
Enabled Fcitx5 addons.
'';
};

4
modules/i18n/input-method/kime.nix
View file

@ -26,9 +26,9 @@ in {
};
}
'';
description = ''
description = lib.mdDoc ''
kime configuration. Refer to
<link xlink:href="https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md"/>
<https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md>
for details on supported values.
'';
};

2
modules/i18n/input-method/uim.nix
View file

@ -11,7 +11,7 @@ in {
type = types.enum [ "gtk" "gtk3" "gtk-systray" "gtk3-systray" "qt4" ];
default = "gtk";
example = "gtk-systray";
description = ''
description = lib.mdDoc ''
Selected UIM toolbar.
'';
};

12
modules/launchd/default.nix
View file

@ -12,7 +12,7 @@ let
launchdConfig = { config, name, ... }: {
options = {
enable = mkEnableOption name;
enable = mkEnableOption (lib.mdDoc name);
config = mkOption {
type = types.submodule (import ./launchd.nix);
default = { };
@ -27,10 +27,8 @@ let
];
}
'';
description = ''
Define a launchd job. See <citerefentry>
<refentrytitle>launchd.plist</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> for details.
description = lib.mdDoc ''
Define a launchd job. See {manpage}`launchd.plist(5)` for details.
'';
};
};
@ -66,7 +64,7 @@ in {
type = types.bool;
default = isDarwin;
defaultText = literalExpression "pkgs.stdenv.hostPlatform.isDarwin";
description = ''
description = lib.mdDoc ''
Whether to enable Home Manager to define per-user daemons by making use
of launchd's LaunchAgents.
'';
@ -75,7 +73,7 @@ in {
agents = mkOption {
type = with types; attrsOf (submodule launchdConfig);
default = { };
description = "Define LaunchAgents.";
description = lib.mdDoc "Define LaunchAgents.";
};
};

259
modules/launchd/launchd.nix
View file

@ -33,24 +33,25 @@ with lib;
options = {
Label = mkOption {
type = types.str;
description = "This required key uniquely identifies the job to launchd.";
description =
lib.mdDoc "This required key uniquely identifies the job to launchd.";
};
Disabled = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
This optional key is used as a hint to <literal>launchctl(1)</literal> that it should not submit this job to launchd when
description = lib.mdDoc ''
This optional key is used as a hint to `launchctl(1)` that it should not submit this job to launchd when
loading a job or jobs. The value of this key does NOT reflect the current state of the job on the running
system. If you wish to know whether a job is loaded in launchd, reading this key from a configuration
file yourself is not a sufficient test. You should query launchd for the presence of the job using
the <literal>launchctl(1)</literal> list subcommand or use the ServiceManagement framework's
<literal>SMJobCopyDictionary()</literal> method.
the `launchctl(1)` list subcommand or use the ServiceManagement framework's
`SMJobCopyDictionary()` method.
Note that as of Mac OS X v10.6, this key's value in a configuration file conveys a default value, which
is changed with the [-w] option of the <literal>launchctl(1)</literal> load and unload subcommands. These subcommands no
is changed with the [-w] option of the `launchctl(1)` load and unload subcommands. These subcommands no
longer modify the configuration file, so the value displayed in the configuration file is not necessarily
the value that <literal>launchctl(1)</literal> will apply. See <literal>launchctl(1)</literal> for more information.
the value that `launchctl(1)` will apply. See `launchctl(1)` for more information.
Please also be mindful that you should only use this key if the provided on-demand and KeepAlive criteria
are insufficient to describe the conditions under which your job needs to run. The cost to have a
@ -62,7 +63,7 @@ with lib;
UserName = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies the user to run the job as. This key is only applicable when launchd is
running as root.
'';
@ -71,7 +72,7 @@ with lib;
GroupName = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies the group to run the job as. This key is only applicable when launchd is
running as root. If UserName is set and GroupName is not, the the group will be set to the default
group of the user.
@ -81,7 +82,7 @@ with lib;
inetdCompatibility = mkOption {
default = null;
example = { Wait = true; };
description = ''
description = lib.mdDoc ''
The presence of this key specifies that the daemon expects to be run as if it were launched from inetd.
'';
type = types.nullOr (types.submodule {
@ -89,9 +90,9 @@ with lib;
Wait = mkOption {
type = types.nullOr (types.either types.bool types.str);
default = null;
description = ''
description = lib.mdDoc ''
This flag corresponds to the "wait" or "nowait" option of inetd. If true, then the listening
socket is passed via the standard in/out/error file descriptors. If false, then <literal>accept(2)</literal> is
socket is passed via the standard in/out/error file descriptors. If false, then `accept(2)` is
called on behalf of the job, and the result is passed via the standard in/out/error descriptors.
'';
};
@ -102,35 +103,35 @@ with lib;
LimitLoadToHosts = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
description = ''
description = lib.mdDoc ''
This configuration file only applies to the hosts listed with this key. Note: One should set kern.hostname
in <literal>sysctl.conf(5)</literal> for this feature to work reliably.
in `sysctl.conf(5)` for this feature to work reliably.
'';
};
LimitLoadFromHosts = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
description = ''
description = lib.mdDoc ''
This configuration file only applies to hosts NOT listed with this key. Note: One should set kern.hostname
in <literal>sysctl.conf(5)</literal> for this feature to work reliably.
in `sysctl.conf(5)` for this feature to work reliably.
'';
};
LimitLoadToSessionType = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
This configuration file only applies to sessions of the type specified. This key is used in concert
with the -S flag to <command>launchctl</command>.
with the -S flag to {command}`launchctl`.
'';
};
Program = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
This key maps to the first argument of <literal>execvp(3)</literal>. If this key is missing, then the first element of
description = lib.mdDoc ''
This key maps to the first argument of `execvp(3)`. If this key is missing, then the first element of
the array of strings provided to the ProgramArguments will be used instead. This key is required in
the absence of the ProgramArguments key.
'';
@ -139,26 +140,26 @@ with lib;
ProgramArguments = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
description = ''
This key maps to the second argument of <literal>execvp(3)</literal>. This key is required in the absence of the Program
key. Please note: many people are confused by this key. Please read <literal>execvp(3)</literal> very carefully!
description = lib.mdDoc ''
This key maps to the second argument of `execvp(3)`. This key is required in the absence of the Program
key. Please note: many people are confused by this key. Please read `execvp(3)` very carefully!
'';
};
EnableGlobbing = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
This flag causes launchd to use the <literal>glob(3)</literal> mechanism to update the program arguments before invocation.
description = lib.mdDoc ''
This flag causes launchd to use the `glob(3)` mechanism to update the program arguments before invocation.
'';
};
EnableTransactions = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
This flag instructs launchd that the job promises to use <literal>vproc_transaction_begin(3)</literal> and
<literal>vproc_transaction_end(3)</literal> to track outstanding transactions that need to be reconciled before the
description = lib.mdDoc ''
This flag instructs launchd that the job promises to use `vproc_transaction_begin(3)` and
`vproc_transaction_end(3)` to track outstanding transactions that need to be reconciled before the
process can safely terminate. If no outstanding transactions are in progress, then launchd is free to
send the SIGKILL signal.
'';
@ -167,7 +168,7 @@ with lib;
OnDemand = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This key was used in Mac OS X 10.4 to control whether a job was kept alive or not. The default was
true. This key has been deprecated and replaced in Mac OS X 10.5 and later with the more powerful
KeepAlive option.
@ -181,7 +182,7 @@ with lib;
SuccessfulExit = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
If true, the job will be restarted as long as the program exits and with an exit status of zero.
If false, the job will be restarted in the inverse condition. This key implies that "RunAtLoad"
is set to true, since the job needs to run at least once before we can get an exit status.
@ -191,7 +192,7 @@ with lib;
NetworkState = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
If true, the job will be kept alive as long as the network is up, where up is defined as at least
one non-loopback interface being up and having IPv4 or IPv6 addresses assigned to them. If
false, the job will be kept alive in the inverse condition.
@ -201,7 +202,7 @@ with lib;
PathState = mkOption {
type = types.nullOr (types.attrsOf types.bool);
default = null;
description = ''
description = lib.mdDoc ''
Each key in this dictionary is a file-system path. If the value of the key is true, then the job
will be kept alive as long as the path exists. If false, the job will be kept alive in the
inverse condition. The intent of this feature is that two or more jobs may create semaphores in
@ -212,7 +213,7 @@ with lib;
OtherJobEnabled = mkOption {
type = types.nullOr (types.attrsOf types.bool);
default = null;
description = ''
description = lib.mdDoc ''
Each key in this dictionary is the label of another job. If the value of the key is true, then
this job is kept alive as long as that other job is enabled. Otherwise, if the value is false,
then this job is kept alive as long as the other job is disabled. This feature should not be
@ -223,7 +224,7 @@ with lib;
Crashed = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
If true, the the job will be restarted as long as it exited due to a signal which is typically
associated with a crash (SIGILL, SIGSEGV, etc.). If false, the job will be restarted in the
inverse condition.
@ -238,7 +239,7 @@ with lib;
};
}));
default = null;
description = ''
description = lib.mdDoc ''
This optional key is used to control whether your job is to be kept continuously running or to let
demand and conditions control the invocation. The default is false and therefore only demand will start
the job. The value may be set to true to unconditionally keep the job alive. Alternatively, a dictionary
@ -253,7 +254,7 @@ with lib;
RunAtLoad = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This optional key is used to control whether your job is launched once at the time the job is loaded.
The default is false.
'';
@ -262,23 +263,23 @@ with lib;
RootDirectory = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
This optional key is used to specify a directory to <literal>chroot(2)</literal> to before running the job.
description = lib.mdDoc ''
This optional key is used to specify a directory to `chroot(2)` to before running the job.
'';
};
WorkingDirectory = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
This optional key is used to specify a directory to <literal>chdir(2)</literal> to before running the job.
description = lib.mdDoc ''
This optional key is used to specify a directory to `chdir(2)` to before running the job.
'';
};
EnvironmentVariables = mkOption {
type = types.nullOr (types.attrsOf types.str);
default = null;
description = ''
description = lib.mdDoc ''
This optional key is used to specify additional environment variables to be set before running the
job.
'';
@ -287,8 +288,8 @@ with lib;
Umask = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
This optional key specifies what value should be passed to <literal>umask(2)</literal> before running the job. Known bug:
description = lib.mdDoc ''
This optional key specifies what value should be passed to `umask(2)` before running the job. Known bug:
Property lists don't support octal, so please convert the value to decimal.
'';
};
@ -296,7 +297,7 @@ with lib;
TimeOut = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The recommended idle time out (in seconds) to pass to the job. If no value is specified, a default time
out will be supplied by launchd for use by the job at check in time.
'';
@ -305,7 +306,7 @@ with lib;
ExitTimeOut = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The amount of time launchd waits before sending a SIGKILL signal. The default value is 20 seconds. The
value zero is interpreted as infinity.
'';
@ -314,7 +315,7 @@ with lib;
ThrottleInterval = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
This key lets one override the default throttling policy imposed on jobs by launchd. The value is in
seconds, and by default, jobs will not be spawned more than once every 10 seconds. The principle
behind this is that jobs should linger around just in case they are needed again in the near future.
@ -326,8 +327,8 @@ with lib;
InitGroups = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
This optional key specifies whether <literal>initgroups(3)</literal> should be called before running the job. The default
description = lib.mdDoc ''
This optional key specifies whether `initgroups(3)` should be called before running the job. The default
is true in 10.5 and false in 10.4. This key will be ignored if the UserName key is not set.
'';
};
@ -335,7 +336,7 @@ with lib;
WatchPaths = mkOption {
type = types.nullOr (types.listOf types.path);
default = null;
description = ''
description = lib.mdDoc ''
This optional key causes the job to be started if any one of the listed paths are modified.
'';
};
@ -343,7 +344,7 @@ with lib;
QueueDirectories = mkOption {
type = types.nullOr (types.listOf types.str);
default = null;
description = ''
description = lib.mdDoc ''
Much like the WatchPaths option, this key will watch the paths for modifications. The difference being
that the job will only be started if the path is a directory and the directory is not empty.
'';
@ -352,7 +353,7 @@ with lib;
StartOnMount = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This optional key causes the job to be started every time a filesystem is mounted.
'';
};
@ -360,7 +361,7 @@ with lib;
StartInterval = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
This optional key causes the job to be started every N seconds. If the system is asleep, the job will
be started the next time the computer wakes up. If multiple intervals transpire before the computer is
woken, those events will be coalesced into one event upon wake from sleep.
@ -373,9 +374,9 @@ with lib;
Hour = 2;
Minute = 30;
};
description = ''
description = lib.mdDoc ''
This optional key causes the job to be started every calendar interval as specified. Missing arguments
are considered to be wildcard. The semantics are much like <literal>crontab(5)</literal>. Unlike cron which skips job
are considered to be wildcard. The semantics are much like `crontab(5)`. Unlike cron which skips job
invocations when the computer is asleep, launchd will start the job the next time the computer wakes
up. If multiple intervals transpire before the computer is woken, those events will be coalesced into
one event upon wake from sleep.
@ -385,7 +386,7 @@ with lib;
Minute = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The minute on which this job will be run.
'';
};
@ -393,7 +394,7 @@ with lib;
Hour = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The hour on which this job will be run.
'';
};
@ -401,7 +402,7 @@ with lib;
Day = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The day on which this job will be run.
'';
};
@ -409,7 +410,7 @@ with lib;
Weekday = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The weekday on which this job will be run (0 and 7 are Sunday).
'';
};
@ -417,7 +418,7 @@ with lib;
Month = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The month on which this job will be run.
'';
};
@ -428,32 +429,32 @@ with lib;
StandardInPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies what file should be used for data being supplied to stdin when using
<literal>stdio(3)</literal>.
`stdio(3)`.
'';
};
StandardOutPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
This optional key specifies what file should be used for data being sent to stdout when using <literal>stdio(3)</literal>.
description = lib.mdDoc ''
This optional key specifies what file should be used for data being sent to stdout when using `stdio(3)`.
'';
};
StandardErrorPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
This optional key specifies what file should be used for data being sent to stderr when using <literal>stdio(3)</literal>.
description = lib.mdDoc ''
This optional key specifies what file should be used for data being sent to stderr when using `stdio(3)`.
'';
};
Debug = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while
dealing with this job.
'';
@ -462,7 +463,7 @@ with lib;
WaitForDebugger = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies that launchd should instruct the kernel to have the job wait for a debugger
to attach before any code in the job is executed.
'';
@ -470,8 +471,8 @@ with lib;
SoftResourceLimits = mkOption {
default = null;
description = ''
Resource limits to be imposed on the job. These adjust variables set with <literal>setrlimit(2)</literal>. The following
description = lib.mdDoc ''
Resource limits to be imposed on the job. These adjust variables set with `setrlimit(2)`. The following
keys apply:
'';
type = types.nullOr (types.submodule {
@ -479,7 +480,7 @@ with lib;
Core = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The largest size (in bytes) core file that may be created.
'';
};
@ -487,7 +488,7 @@ with lib;
CPU = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum amount of cpu time (in seconds) to be used by each process.
'';
};
@ -495,16 +496,16 @@ with lib;
Data = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) of the data segment for a process; this defines how far a program may
extend its break with the <literal>sbrk(2)</literal> system call.
extend its break with the `sbrk(2)` system call.
'';
};
FileSize = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The largest size (in bytes) file that may be created.
'';
};
@ -512,7 +513,7 @@ with lib;
MemoryLock = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.
'';
};
@ -520,27 +521,27 @@ with lib;
NumberOfFiles = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum number of open files for this process. Setting this value in a system wide daemon
will set the <literal>sysctl(3)</literal> kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits)
value in addition to the <literal>setrlimit(2)</literal> values.
will set the `sysctl(3)` kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits)
value in addition to the `setrlimit(2)` values.
'';
};
NumberOfProcesses = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum number of simultaneous processes for this user id. Setting this value in a system
wide daemon will set the <literal>sysctl(3)</literal> kern.maxproc (SoftResourceLimits) or kern.maxprocperuid
(HardResourceLimits) value in addition to the <literal>setrlimit(2)</literal> values.
wide daemon will set the `sysctl(3)` kern.maxproc (SoftResourceLimits) or kern.maxprocperuid
(HardResourceLimits) value in addition to the `setrlimit(2)` values.
'';
};
ResidentSetSize = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) to which a process's resident set size may grow. This imposes a
limit on the amount of physical memory to be given to a process; if memory is tight, the system
will prefer to take memory from processes that are exceeding their declared resident set size.
@ -550,7 +551,7 @@ with lib;
Stack = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) of the stack segment for a process; this defines how far a program's
stack segment may be extended. Stack extension is performed automatically by the system.
'';
@ -562,8 +563,8 @@ with lib;
HardResourceLimits = mkOption {
default = null;
example = { NumberOfFiles = 4096; };
description = ''
Resource limits to be imposed on the job. These adjust variables set with <literal>setrlimit(2)</literal>. The following
description = lib.mdDoc ''
Resource limits to be imposed on the job. These adjust variables set with `setrlimit(2)`. The following
keys apply:
'';
type = types.nullOr (types.submodule {
@ -571,7 +572,7 @@ with lib;
Core = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The largest size (in bytes) core file that may be created.
'';
};
@ -579,7 +580,7 @@ with lib;
CPU = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum amount of cpu time (in seconds) to be used by each process.
'';
};
@ -587,16 +588,16 @@ with lib;
Data = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) of the data segment for a process; this defines how far a program may
extend its break with the <literal>sbrk(2)</literal> system call.
extend its break with the `sbrk(2)` system call.
'';
};
FileSize = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The largest size (in bytes) file that may be created.
'';
};
@ -604,35 +605,35 @@ with lib;
MemoryLock = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
The maximum size (in bytes) which a process may lock into memory using the <literal>mlock(2)</literal> function.
description = lib.mdDoc ''
The maximum size (in bytes) which a process may lock into memory using the `mlock(2)` function.
'';
};
NumberOfFiles = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum number of open files for this process. Setting this value in a system wide daemon
will set the <literal>sysctl(3)</literal> kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits)
value in addition to the <literal>setrlimit(2)</literal> values.
will set the `sysctl(3)` kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits)
value in addition to the `setrlimit(2)` values.
'';
};
NumberOfProcesses = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum number of simultaneous processes for this user id. Setting this value in a system
wide daemon will set the <literal>sysctl(3)</literal> kern.maxproc (SoftResourceLimits) or kern.maxprocperuid
(HardResourceLimits) value in addition to the <literal>setrlimit(2)</literal> values.
wide daemon will set the `sysctl(3)` kern.maxproc (SoftResourceLimits) or kern.maxprocperuid
(HardResourceLimits) value in addition to the `setrlimit(2)` values.
'';
};
ResidentSetSize = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) to which a process's resident set size may grow. This imposes a
limit on the amount of physical memory to be given to a process; if memory is tight, the system
will prefer to take memory from processes that are exceeding their declared resident set size.
@ -642,7 +643,7 @@ with lib;
Stack = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
The maximum size (in bytes) of the stack segment for a process; this defines how far a program's
stack segment may be extended. Stack extension is performed automatically by the system.
'';
@ -654,7 +655,7 @@ with lib;
Nice = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies what nice(3) value should be applied to the daemon.
'';
};
@ -691,7 +692,7 @@ with lib;
AbandonProcessGroup = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
When a job dies, launchd kills any remaining processes with the same process group ID as the job. Setting
this key to true disables that behavior.
'';
@ -700,7 +701,7 @@ with lib;
LowPriorityIO = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies whether the kernel should consider this daemon to be low priority when
doing file system I/O.
'';
@ -709,7 +710,7 @@ with lib;
LaunchOnlyOnce = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies whether the job can only be run once and only once. In other words, if the
job cannot be safely respawned without a full machine reboot, then set this key to be true.
'';
@ -718,7 +719,7 @@ with lib;
MachServices = mkOption {
default = null;
example = { ResetAtClose = true; };
description = ''
description = lib.mdDoc ''
This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system.
Each key in this dictionary should be the name of service to be advertised. The value of the key must
be a boolean and set to true. Alternatively, a dictionary can be used instead of a simple true value.
@ -731,7 +732,7 @@ with lib;
ResetAtClose = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
If this boolean is false, the port is recycled, thus leaving clients to remain oblivious to the
demand nature of job. If the value is set to true, clients receive port death notifications when
the job lets go of the receive right. The port will be recreated atomically with respect to bootstrap_look_up()
@ -744,7 +745,7 @@ with lib;
HideUntilCheckIn = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
description = lib.mdDoc ''
Reserve the name in the namespace, but cause bootstrap_look_up() to fail until the job has
checked in with launchd.
'';
@ -756,7 +757,7 @@ with lib;
LaunchEvents = mkOption {
type = types.nullOr (types.attrs);
default = null;
description = ''
description = lib.mdDoc ''
Specifies higher-level event types to be used as launch-on-demand event
sources. Each sub-dictionary defines events for a particular event
subsystem, such as "com.apple.iokit.matching", which can be used to
@ -780,7 +781,7 @@ with lib;
Sockets = mkOption {
default = null;
description = ''
description = lib.mdDoc ''
This optional key is used to specify launch on demand sockets that can be used to let launchd know when
to run the job. The job must check-in to get a copy of the file descriptors using APIs outlined in
launch(3). The keys of the top level Sockets dictionary can be anything. They are meant for the application
@ -790,14 +791,14 @@ with lib;
to be effectively equivalent, even though each file descriptor likely represents a different networking
protocol which conforms to the criteria specified in the job configuration file.
The parameters below are used as inputs to call <literal>getaddrinfo(3)</literal>.
The parameters below are used as inputs to call `getaddrinfo(3)`.
'';
type = types.nullOr (types.attrsOf (types.submodule {
options = {
SockType = mkOption {
type = types.nullOr (types.enum [ "stream" "dgram" "seqpacket" ]);
default = null;
description = ''
description = lib.mdDoc ''
This optional key tells launchctl what type of socket to create. The default is "stream" and
other valid values for this key are "dgram" and "seqpacket" respectively.
'';
@ -806,8 +807,8 @@ with lib;
SockPassive = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
This optional key specifies whether <literal>listen(2)</literal> or <literal>connect(2)</literal> should be called on the created file
description = lib.mdDoc ''
This optional key specifies whether `listen(2)` or `connect(2)` should be called on the created file
descriptor. The default is true ("to listen").
'';
};
@ -815,23 +816,23 @@ with lib;
SockNodeName = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
This optional key specifies the node to <literal>connect(2)</literal> or <literal>bind(2)</literal> to.
description = lib.mdDoc ''
This optional key specifies the node to `connect(2)` or `bind(2)` to.
'';
};
SockServiceName = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
This optional key specifies the service on the node to <literal>connect(2)</literal> or <literal>bind(2)</literal> to.
description = lib.mdDoc ''
This optional key specifies the service on the node to `connect(2)` or `bind(2)` to.
'';
};
SockFamily = mkOption {
type = types.nullOr (types.enum [ "IPv4" "IPv6" ]);
default = null;
description = ''
description = lib.mdDoc ''
This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created.
'';
};
@ -839,8 +840,8 @@ with lib;
SockProtocol = mkOption {
type = types.nullOr (types.enum [ "TCP" ]);
default = null;
description = ''
This optional key specifies the protocol to be passed to <literal>socket(2)</literal>. The only value understood by
description = lib.mdDoc ''
This optional key specifies the protocol to be passed to `socket(2)`. The only value understood by
this key at the moment is "TCP".
'';
};
@ -848,16 +849,16 @@ with lib;
SockPathName = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
This optional key implies SockFamily is set to "Unix". It specifies the path to <literal>connect(2)</literal> or
<literal>bind(2)</literal> to.
description = lib.mdDoc ''
This optional key implies SockFamily is set to "Unix". It specifies the path to `connect(2)` or
`bind(2)` to.
'';
};
SecureSocketWithKey = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
This optional key is a variant of SockPathName. Instead of binding to a known path, a securely
generated socket is created and the path is assigned to the environment variable that is inherited
by all jobs spawned by launchd.
@ -867,7 +868,7 @@ with lib;
SockPathMode = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
This optional key specifies the mode of the socket. Known bug: Property lists don't support
octal, so please convert the value to decimal.
'';
@ -877,18 +878,18 @@ with lib;
type =
types.nullOr (types.either types.bool (types.listOf types.str));
default = null;
description = ''
description = lib.mdDoc ''
This optional key can be used to request that the service be registered with the
<literal>mDNSResponder(8)</literal>. If the value is boolean, the service name is inferred from the SockServiceName.
`mDNSResponder(8)`. If the value is boolean, the service name is inferred from the SockServiceName.
'';
};
MulticastGroup = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
This optional key can be used to request that the datagram socket join a multicast group. If the
value is a hostname, then <literal>getaddrinfo(3)</literal> will be used to join the correct multicast address for a
value is a hostname, then `getaddrinfo(3)` will be used to join the correct multicast address for a
given socket family. If an explicit IPv4 or IPv6 address is given, it is required that the SockFamily
family also be set, otherwise the results are undefined.
'';

36
modules/lib/file-type.nix
View file

@ -19,7 +19,7 @@ in
enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether this file should be generated. This option allows specific
files to be disabled.
'';
@ -40,18 +40,18 @@ in
text = mkOption {
default = null;
type = types.nullOr types.lines;
description = ''
description = lib.mdDoc ''
Text of the file. If this option is null then
<xref linkend="opt-${opt}._name_.source"/>
[](#opt-${opt}._name_.source)
must be set.
'';
};
source = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path of the source file or directory. If
<xref linkend="opt-${opt}._name_.text"/>
[](#opt-${opt}._name_.text)
is non-null then this option will automatically point to a file
containing that text.
'';
@ -60,25 +60,25 @@ in
executable = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Set the execute bit. If <literal>null</literal>, defaults to the mode
of the <varname>source</varname> file or to <literal>false</literal>
for files created through the <varname>text</varname> option.
description = lib.mdDoc ''
Set the execute bit. If `null`, defaults to the mode
of the {var}`source` file or to `false`
for files created through the {var}`text` option.
'';
};
recursive = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If the file source is a directory, then this option
determines whether the directory should be recursively
linked to the target location. This option has no effect
if the source is a file.
</para><para>
If <literal>false</literal> (the default) then the target
If `false` (the default) then the target
will be a symbolic link to the source directory. If
<literal>true</literal> then the target will be a
`true` then the target will be a
directory structure matching the source's but whose leafs
are symbolic links to the files of the source directory.
'';
@ -87,13 +87,13 @@ in
onChange = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell commands to run when file has changed between
generations. The script will be run
<emphasis>after</emphasis> the new files have been linked
*after* the new files have been linked
into place.
</para><para>
Note, this code is always run when <literal>recursive</literal> is
Note, this code is always run when `recursive` is
enabled.
'';
};
@ -102,7 +102,7 @@ in
type = types.bool;
default = false;
visible = false;
description = ''
description = lib.mdDoc ''
Whether the target path should be unconditionally replaced
by the managed file source. Warning, this will silently
delete the target regardless of whether it is a file or

8
modules/lib/types.nix
View file

@ -39,9 +39,9 @@ in rec {
type = types.nullOr types.package;
default = null;
example = literalExpression "pkgs.dejavu_fonts";
description = ''
description = lib.mdDoc ''
Package providing the font. This package will be installed
to your profile. If <literal>null</literal> then the font
to your profile. If `null` then the font
is assumed to already be available in your profile.
'';
};
@ -49,7 +49,7 @@ in rec {
name = mkOption {
type = types.str;
example = "DejaVu Sans";
description = ''
description = lib.mdDoc ''
The family name of the font within the package.
'';
};
@ -58,7 +58,7 @@ in rec {
type = types.nullOr types.number;
default = null;
example = "8";
description = ''
description = lib.mdDoc ''
The size of the font.
'';
};

14
modules/manual.nix
View file

@ -16,9 +16,9 @@ in {
manual.html.enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to install the HTML manual. This also installs the
<command>home-manager-help</command> tool, which opens a local
{command}`home-manager-help` tool, which opens a local
copy of the Home Manager manual in the system web browser.
'';
};
@ -27,10 +27,10 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
description = lib.mdDoc ''
Whether to install the configuration manual page. The manual can
be reached by <command>man home-configuration.nix</command>.
</para><para>
be reached by {command}`man home-configuration.nix`.
When looking at the manual page pretend that all references to
NixOS stuff are actually references to Home Manager stuff.
Thanks!
@ -41,10 +41,10 @@ in {
type = types.bool;
default = false;
example = true;
description = ''
description = lib.mdDoc ''
Whether to install a JSON formatted list of all Home Manager
options. This can be located at
<filename>&lt;profile directory&gt;/share/doc/home-manager/options.json</filename>,
{file}`<profile directory>/share/doc/home-manager/options.json`,
and may be used for navigating definitions, auto-completing,
and other miscellaneous tasks.
'';

22
modules/misc/dconf.nix
View file

@ -33,11 +33,11 @@ in {
# re-enabled, unclear whether there's actual value in it though.
default = !pkgs.stdenv.hostPlatform.isDarwin;
visible = false;
description = ''
description = lib.mdDoc ''
Whether to enable dconf settings.
</para><para>
Note, if you use NixOS then you must add
<literal>programs.dconf.enable = true</literal>
`programs.dconf.enable = true`
to your system configuration. Otherwise you will see a systemd error
message when your configuration is activated.
'';
@ -57,18 +57,18 @@ in {
};
}
'';
description = ''
description = lib.mdDoc ''
Settings to write to the dconf configuration system.
</para><para>
Note that the database is strongly-typed so you need to use the same types
as described in the GSettings schema. For example, if an option is of type
<literal>uint32</literal> (<literal>u</literal>), you need to wrap the number
using the <literal>lib.hm.gvariant.mkUint32</literal> constructor.
Otherwise, since Nix integers are implicitly coerced to <literal>int32</literal>
(<literal>i</literal>), it would get stored in the database as such, and GSettings
`uint32` (`u`), you need to wrap the number
using the `lib.hm.gvariant.mkUint32` constructor.
Otherwise, since Nix integers are implicitly coerced to `int32`
(`i`), it would get stored in the database as such, and GSettings
might be confused when loading the setting.
</para><para>
You might want to use <link xlink:href="https://github.com/gvolpe/dconf2nix">dconf2nix</link>
You might want to use [dconf2nix](https://github.com/gvolpe/dconf2nix)
to convert dconf database dumps into compatible Nix expression.
'';
};

10
modules/misc/editorconfig.nix
View file

@ -12,16 +12,16 @@ in {
meta.maintainers = with maintainers; [ loicreynier ];
options.editorconfig = {
enable = mkEnableOption "EditorConfig home configuration file";
enable = mkEnableOption (lib.mdDoc "EditorConfig home configuration file");
settings = mkOption {
type = iniFormat.type;
default = { };
description = ''
Configuration written to <filename>$HOME/.editorconfig</filename>.
<literal>root = true</literal> is automatically added to the file,
description = lib.mdDoc ''
Configuration written to {file}`$HOME/.editorconfig`.
`root = true` is automatically added to the file,
it must not be added here.
See <link xlink:href="https://editorconfig.org"/> for documentation.
See <https://editorconfig.org> for documentation.
'';
example = literalExpression ''
{

6
modules/misc/fontconfig.nix
View file

@ -24,12 +24,12 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable fontconfig configuration. This will, for
example, allow fontconfig to discover fonts and
configurations installed through
<varname>home.packages</varname> and
<command>nix-env</command>.
{var}`home.packages` and
{command}`nix-env`.
'';
};
};

57
modules/misc/gtk.nix
View file

@ -31,9 +31,9 @@ let
type = types.nullOr types.package;
default = null;
example = literalExpression "pkgs.gnome.gnome-themes-extra";
description = ''
description = lib.mdDoc ''
Package providing the theme. This package will be installed
to your profile. If <literal>null</literal> then the theme
to your profile. If `null` then the theme
is assumed to already be available in your profile.
'';
};
@ -41,7 +41,7 @@ let
name = mkOption {
type = types.str;
example = "Adwaita";
description = "The name of the theme within the package.";
description = lib.mdDoc "The name of the theme within the package.";
};
};
};
@ -52,9 +52,9 @@ let
type = types.nullOr types.package;
default = null;
example = literalExpression "pkgs.gnome.adwaita-icon-theme";
description = ''
description = lib.mdDoc ''
Package providing the icon theme. This package will be installed
to your profile. If <literal>null</literal> then the theme
to your profile. If `null` then the theme
is assumed to already be available in your profile.
'';
};
@ -62,7 +62,8 @@ let
name = mkOption {
type = types.str;
example = "Adwaita";
description = "The name of the icon theme within the package.";
description =
lib.mdDoc "The name of the icon theme within the package.";
};
};
};
@ -73,9 +74,9 @@ let
type = types.nullOr types.package;
default = null;
example = literalExpression "pkgs.vanilla-dmz";
description = ''
description = lib.mdDoc ''
Package providing the cursor theme. This package will be installed
to your profile. If <literal>null</literal> then the theme
to your profile. If `null` then the theme
is assumed to already be available in your profile.
'';
};
@ -83,14 +84,15 @@ let
name = mkOption {
type = types.str;
example = "Vanilla-DMZ";
description = "The name of the cursor theme within the package.";
description =
lib.mdDoc "The name of the cursor theme within the package.";
};
size = mkOption {
type = types.nullOr types.int;
default = null;
example = 16;
description = ''
description = lib.mdDoc ''
The size of the cursor.
'';
};
@ -108,12 +110,12 @@ in {
options = {
gtk = {
enable = mkEnableOption "GTK 2/3 configuration";
enable = mkEnableOption (lib.mdDoc "GTK 2/3 configuration");
font = mkOption {
type = types.nullOr hm.types.fontType;
default = null;
description = ''
description = lib.mdDoc ''
The font to use in GTK+ 2/3 applications.
'';
};
@ -121,19 +123,19 @@ in {
cursorTheme = mkOption {
type = types.nullOr cursorThemeType;
default = null;
description = "The cursor theme to use.";
description = lib.mdDoc "The cursor theme to use.";
};
iconTheme = mkOption {
type = types.nullOr iconThemeType;
default = null;
description = "The icon theme to use.";
description = lib.mdDoc "The icon theme to use.";
};
theme = mkOption {
type = types.nullOr themeType;
default = null;
description = "The GTK+2/3 theme to use.";
description = lib.mdDoc "The GTK+2/3 theme to use.";
};
gtk2 = {
@ -141,9 +143,9 @@ in {
type = types.lines;
default = "";
example = "gtk-can-change-accels = 1";
description = ''
description = lib.mdDoc ''
Extra configuration lines to add verbatim to
<filename>~/.gtkrc-2.0</filename>.
{file}`~/.gtkrc-2.0`.
'';
};
@ -154,7 +156,7 @@ in {
literalExpression ''"''${config.home.homeDirectory}/.gtkrc-2.0"'';
example =
literalExpression ''"''${config.xdg.configHome}/gtk-2.0/gtkrc"'';
description = ''
description = lib.mdDoc ''
The location to put the GTK configuration file.
'';
};
@ -165,7 +167,8 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "file:///home/jane/Documents" ];
description = "Bookmarks in the sidebar of the GTK file browser";
description =
lib.mdDoc "Bookmarks in the sidebar of the GTK file browser";
};
extraConfig = mkOption {
@ -175,18 +178,18 @@ in {
gtk-cursor-blink = false;
gtk-recent-files-limit = 20;
};
description = ''
description = lib.mdDoc ''
Extra configuration options to add to
<filename>$XDG_CONFIG_HOME/gtk-3.0/settings.ini</filename>.
{file}`$XDG_CONFIG_HOME/gtk-3.0/settings.ini`.
'';
};
extraCss = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra configuration lines to add verbatim to
<filename>$XDG_CONFIG_HOME/gtk-3.0/gtk.css</filename>.
{file}`$XDG_CONFIG_HOME/gtk-3.0/gtk.css`.
'';
};
};
@ -199,18 +202,18 @@ in {
gtk-cursor-blink = false;
gtk-recent-files-limit = 20;
};
description = ''
description = lib.mdDoc ''
Extra configuration options to add to
<filename>$XDG_CONFIG_HOME/gtk-4.0/settings.ini</filename>.
{file}`$XDG_CONFIG_HOME/gtk-4.0/settings.ini`.
'';
};
extraCss = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra configuration lines to add verbatim to
<filename>$XDG_CONFIG_HOME/gtk-4.0/gtk.css</filename>.
{file}`$XDG_CONFIG_HOME/gtk-4.0/gtk.css`.
'';
};
};

2
modules/misc/lib.nix
View file

@ -5,7 +5,7 @@
lib = lib.mkOption {
type = lib.types.attrsOf lib.types.attrs;
default = { };
description = ''
description = lib.mdDoc ''
This option allows modules to define helper functions,
constants, etc.
'';

10
modules/misc/news.nix
View file

@ -13,7 +13,7 @@ let
id = mkOption {
internal = true;
type = types.str;
description = ''
description = lib.mdDoc ''
A unique entry identifier. By default it is a base16
formatted hash of the entry message.
'';
@ -23,7 +23,7 @@ let
internal = true;
type = types.str;
example = "2017-07-10T21:55:04+00:00";
description = ''
description = lib.mdDoc ''
News entry time stamp in ISO-8601 format. Must be in UTC
(ending in '+00:00').
'';
@ -32,13 +32,13 @@ let
condition = mkOption {
internal = true;
default = true;
description = "Whether the news entry should be active.";
description = lib.mdDoc "Whether the news entry should be active.";
};
message = mkOption {
internal = true;
type = types.str;
description = "The news entry content.";
description = lib.mdDoc "The news entry content.";
};
};
@ -83,7 +83,7 @@ in
internal = true;
type = types.listOf entryModule;
default = [ ];
description = "News entries.";
description = lib.mdDoc "News entries.";
};
};
};

33
modules/misc/nix.nix
View file

@ -82,9 +82,9 @@ let
in {
options.nix = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
the Nix configuration module
'' // {
'') // {
default = true;
visible = false;
};
@ -93,7 +93,7 @@ in {
type = types.nullOr types.package;
default = null;
example = literalExpression "pkgs.nix";
description = ''
description = lib.mdDoc ''
The Nix package that the configuration should be generated for.
'';
};
@ -110,7 +110,7 @@ in {
type = "indirect";
id = "nixpkgs";
};
description = "The flake reference to be rewritten.";
description = lib.mdDoc "The flake reference to be rewritten.";
};
to = mkOption {
type = inputAttrs;
@ -119,24 +119,24 @@ in {
owner = "my-org";
repo = "my-nixpkgs";
};
description =
"The flake reference to which <option>from></option> is to be rewritten.";
description = lib.mdDoc
"The flake reference to which {option}`from>` is to be rewritten.";
};
flake = mkOption {
type = types.nullOr types.attrs;
default = null;
example = literalExpression "nixpkgs";
description = ''
The flake input to which <option>from></option> is to be rewritten.
description = lib.mdDoc ''
The flake input to which {option}`from>` is to be rewritten.
'';
};
exact = mkOption {
type = types.bool;
default = true;
description = ''
Whether the <option>from</option> reference needs to match exactly. If set,
a <option>from</option> reference like <literal>nixpkgs</literal> does not
match with a reference like <literal>nixpkgs/nixos-20.03</literal>.
description = lib.mdDoc ''
Whether the {option}`from` reference needs to match exactly. If set,
a {option}`from` reference like `nixpkgs` does not
match with a reference like `nixpkgs/nixos-20.03`.
'';
};
};
@ -154,7 +154,7 @@ in {
};
}));
default = { };
description = ''
description = lib.mdDoc ''
User level flake registry.
'';
};
@ -163,13 +163,13 @@ in {
type = types.int;
default = 2;
internal = true;
description = "The flake registry format version.";
description = lib.mdDoc "The flake registry format version.";
};
checkConfig = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
If enabled (the default), checks for data type mismatches and that Nix
can parse the generated nix.conf.
'';
@ -182,8 +182,7 @@ in {
keep-outputs = true
keep-derivations = true
'';
description =
"Additional text appended to <filename>nix.conf</filename>.";
description = lib.mdDoc "Additional text appended to {file}`nix.conf`.";
};
settings = mkOption {

34
modules/misc/nixpkgs.nix
View file

@ -48,29 +48,25 @@ in {
default = null;
example = { allowBroken = true; };
type = types.nullOr configType;
description = ''
description = lib.mdDoc ''
The configuration of the Nix Packages collection. (For
details, see the Nixpkgs documentation.) It allows you to set
package configuration options.
</para><para>
If <literal>null</literal>, then configuration is taken from
If `null`, then configuration is taken from
the fallback location, for example,
<filename>~/.config/nixpkgs/config.nix</filename>.
</para><para>
{file}`~/.config/nixpkgs/config.nix`.
Note, this option will not apply outside your Home Manager
configuration like when installing manually through
<command>nix-env</command>. If you want to apply it both
{command}`nix-env`. If you want to apply it both
inside and outside Home Manager you can put it in a separate
file and include something like
<programlisting language="nix">
```nix
nixpkgs.config = import ./nixpkgs-config.nix;
xdg.configFile."nixpkgs/config.nix".source = ./nixpkgs-config.nix;
</programlisting>
```
in your Home Manager configuration.
'';
@ -90,25 +86,21 @@ in {
]
'';
type = types.nullOr (types.listOf overlayType);
description = ''
description = lib.mdDoc ''
List of overlays to use with the Nix Packages collection. (For
details, see the Nixpkgs documentation.) It allows you to
override packages globally. This is a function that takes as
an argument the <emphasis>original</emphasis> Nixpkgs. The
an argument the *original* Nixpkgs. The
first argument should be used for finding dependencies, and
the second should be used for overriding recipes.
</para><para>
If <literal>null</literal>, then the overlays are taken from
If `null`, then the overlays are taken from
the fallback location, for example,
<filename>~/.config/nixpkgs/overlays</filename>.
{file}`~/.config/nixpkgs/overlays`.
</para><para>
Like <varname>nixpkgs.config</varname> this option only
Like {var}`nixpkgs.config` this option only
applies within the Home Manager configuration. See
<varname>nixpkgs.config</varname> for a suggested setup that
{var}`nixpkgs.config` for a suggested setup that
works both internally and externally.
'';
};
@ -117,7 +109,7 @@ in {
type = types.str;
example = "i686-linux";
internal = true;
description = ''
description = lib.mdDoc ''
Specifies the Nix platform type for which the user environment
should be built. If unset, it defaults to the platform type of
your host system. Specifying this option is useful when doing

4
modules/misc/numlock.nix
View file

@ -9,7 +9,9 @@ let
in {
meta.maintainers = [ maintainers.evanjs ];
options = { xsession.numlock.enable = mkEnableOption "Num Lock"; };
options = {
xsession.numlock.enable = mkEnableOption (lib.mdDoc "Num Lock");
};
config = mkIf cfg.enable {
assertions = [

17
modules/misc/pam.nix
View file

@ -14,14 +14,11 @@ in {
default = { };
type = types.attrs;
example = { EDITOR = "vim"; };
description = ''
description = lib.mdDoc ''
Environment variables that will be set for the PAM session.
The variable values must be as described in
<citerefentry>
<refentrytitle>pam_env.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
</para><para>
{manpage}`pam_env.conf(5)`.
Note, this option will become deprecated in the future and its use is
therefore discouraged.
'';
@ -37,9 +34,9 @@ in {
};
in listOf yubiKeyId;
default = [ ];
description = ''
description = lib.mdDoc ''
List of authorized YubiKey token IDs. Refer to
<link xlink:href="https://developers.yubico.com/yubico-pam"/>
<https://developers.yubico.com/yubico-pam>
for details on how to obtain the token ID of a YubiKey.
'';
};
@ -47,9 +44,9 @@ in {
path = mkOption {
type = types.str;
default = ".yubico/authorized_yubikeys";
description = ''
description = lib.mdDoc ''
File path to write the authorized YubiKeys,
relative to <envar>HOME</envar>.
relative to {env}`HOME`.
'';
};
};

6
modules/misc/qt.nix
View file

@ -41,7 +41,7 @@ in {
options = {
qt = {
enable = mkEnableOption "Qt 4, 5 and 6 configuration";
enable = mkEnableOption (lib.mdDoc "Qt 4, 5 and 6 configuration");
platformTheme = mkOption {
type = types.nullOr (types.enum [ "gtk" "gnome" "qtct" "kde" ]);
@ -119,9 +119,9 @@ in {
type = with types; nullOr (either package (listOf package));
default = null;
example = literalExpression "pkgs.adwaita-qt";
description = ''
description = lib.mdDoc ''
Theme package to be used in Qt5/Qt6 applications.
Auto-detected from <option>qt.style.name</option> if possible.
Auto-detected from {option}`qt.style.name` if possible.
'';
};
};

2
modules/misc/specialisation.nix
View file

@ -27,7 +27,7 @@ with lib;
in extended.type;
default = { };
visible = "shallow";
description = ''
description = lib.mdDoc ''
Arbitrary Home Manager configuration settings.
'';
};

8
modules/misc/submodule-support.nix
View file

@ -10,7 +10,7 @@ with lib;
type = types.bool;
default = false;
internal = true;
description = ''
description = lib.mdDoc ''
Whether the Home Manager module system is used as a submodule
in, for example, NixOS or nix-darwin.
'';
@ -20,12 +20,12 @@ with lib;
type = types.bool;
default = false;
internal = true;
description = ''
Whether the packages of <option>home.packages</option> are
description = lib.mdDoc ''
Whether the packages of {option}`home.packages` are
installed separately from the Home Manager activation script.
In NixOS, for example, this may be accomplished by installing
the packages through
<option>users.users.‹name?›.packages</option>.
{option}`users.users.‹name?›.packages`.
'';
};
};

7
modules/misc/tmpfiles.nix
View file

@ -13,13 +13,10 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "L /home/user/Documents - - - - /mnt/data/Documents" ];
description = ''
description = lib.mdDoc ''
Rules for creating and cleaning up temporary files
automatically. See
<citerefentry>
<refentrytitle>tmpfiles.d</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
{manpage}`tmpfiles.d(5)`
for the exact format.
'';
};

14
modules/misc/version.nix
View file

@ -21,13 +21,13 @@ in {
"23.05"
"23.11"
];
description = ''
description = lib.mdDoc ''
It is occasionally necessary for Home Manager to change
configuration defaults in a way that is incompatible with
stateful data. This could, for example, include switching the
default data format or location of a file.
</para><para>
The <emphasis>state version</emphasis> indicates which default
The *state version* indicates which default
settings are in effect and will therefore help avoid breaking
program configurations. Switching to a higher state version
typically requires performing some manual steps, such as data
@ -46,7 +46,7 @@ in {
optionalString (revision != null) "+${substring 0 8 revision}";
in "${release}${suffix}";
example = "22.11+213a0629";
description = "The full Home Manager version.";
description = lib.mdDoc "The full Home Manager version.";
};
release = mkOption {
@ -55,7 +55,7 @@ in {
type = types.str;
default = releaseInfo.release;
example = "22.11";
description = "The Home Manager release.";
description = lib.mdDoc "The Home Manager release.";
};
isReleaseBranch = mkOption {
@ -63,7 +63,7 @@ in {
readOnly = true;
type = types.bool;
default = releaseInfo.isReleaseBranch;
description = ''
description = lib.mdDoc ''
Whether the Home Manager version is from a versioned
release branch.
'';
@ -74,7 +74,7 @@ in {
type = types.nullOr types.str;
default = let gitRepo = "${toString ./../..}/.git";
in if pathIsGitRepo gitRepo then commitIdFromGitRepo gitRepo else null;
description = ''
description = lib.mdDoc ''
The Git revision from which this Home Manager configuration was built.
'';
};

46
modules/misc/xdg-desktop-entries.nix
View file

@ -26,63 +26,65 @@ let
# https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys
type = mkOption {
description = "The type of the desktop entry.";
description = lib.mdDoc "The type of the desktop entry.";
default = "Application";
type = types.enum [ "Application" "Link" "Directory" ];
};
exec = mkOption {
description = "Program to execute, possibly with arguments.";
description = lib.mdDoc "Program to execute, possibly with arguments.";
type = types.nullOr types.str;
default = null;
};
icon = mkOption {
description = "Icon to display in file manager, menus, etc.";
description = lib.mdDoc "Icon to display in file manager, menus, etc.";
type = with types; nullOr (either str path);
default = null;
};
comment = mkOption {
description = "Tooltip for the entry.";
description = lib.mdDoc "Tooltip for the entry.";
type = types.nullOr types.str;
default = null;
};
terminal = mkOption {
description = "Whether the program runs in a terminal window.";
description =
lib.mdDoc "Whether the program runs in a terminal window.";
type = types.bool;
default = false;
};
name = mkOption {
description = "Specific name of the application.";
description = lib.mdDoc "Specific name of the application.";
type = types.str;
};
genericName = mkOption {
description = "Generic name of the application.";
description = lib.mdDoc "Generic name of the application.";
type = types.nullOr types.str;
default = null;
};
mimeType = mkOption {
description = "The MIME type(s) supported by this application.";
description =
lib.mdDoc "The MIME type(s) supported by this application.";
type = types.nullOr (types.listOf types.str);
default = null;
};
categories = mkOption {
description =
"Categories in which the entry should be shown in a menu.";
lib.mdDoc "Categories in which the entry should be shown in a menu.";
type = types.nullOr (types.listOf types.str);
default = null;
};
startupNotify = mkOption {
description = ''
description = lib.mdDoc ''
If true, it is KNOWN that the application will send a "remove"
message when started with the <literal>DESKTOP_STARTUP_ID</literal>
message when started with the `DESKTOP_STARTUP_ID`
environment variable set. If false, it is KNOWN that the application
does not work with startup notification at all.'';
type = types.nullOr types.bool;
@ -90,7 +92,7 @@ let
};
noDisplay = mkOption {
description = ''
description = lib.mdDoc ''
Means "this application exists, but don't display it in the menus".
This can be useful to e.g. associate this application with MIME types.
'';
@ -99,7 +101,7 @@ let
};
prefersNonDefaultGPU = mkOption {
description = ''
description = lib.mdDoc ''
If true, the application prefers to be run on a more powerful discrete GPU if available.
'';
type = types.nullOr types.bool;
@ -108,8 +110,8 @@ let
settings = mkOption {
type = types.attrsOf types.string;
description = ''
Extra key-value pairs to add to the <literal>[Desktop Entry]</literal> section.
description = lib.mdDoc ''
Extra key-value pairs to add to the `[Desktop Entry]` section.
This may override other values.
'';
default = { };
@ -127,17 +129,19 @@ let
type = types.str;
default = name;
defaultText = literalExpression "<name>";
description = "Name of the action.";
description = lib.mdDoc "Name of the action.";
};
options.exec = mkOption {
type = types.nullOr types.str;
description = "Program to execute, possibly with arguments.";
description =
lib.mdDoc "Program to execute, possibly with arguments.";
default = null;
};
options.icon = mkOption {
type = with types; nullOr (either str path);
default = null;
description = "Icon to display in file manager, menus, etc.";
description =
lib.mdDoc "Icon to display in file manager, menus, etc.";
};
}));
default = { };
@ -149,7 +153,7 @@ let
};
}
'';
description =
description = lib.mdDoc
"The set of actions made available to application launchers.";
};
@ -180,12 +184,12 @@ in {
meta.maintainers = [ hm.maintainers.cwyc ];
options.xdg.desktopEntries = mkOption {
description = ''
description = lib.mdDoc ''
Desktop Entries allow applications to be shown in your desktop environment's app launcher.
You can define entries for programs without entries or override existing entries.
See <link xlink:href="https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys" /> for more information on options.
See <https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys> for more information on options.
'';
default = { };
type = types.attrsOf (types.submodule desktopEntry);

15
modules/misc/xdg-mime-apps.nix
View file

@ -16,10 +16,9 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
Whether to manage <filename>$XDG_CONFIG_HOME/mimeapps.list</filename>.
</para>
<para>
description = lib.mdDoc ''
Whether to manage {file}`$XDG_CONFIG_HOME/mimeapps.list`.
The generated file is read-only.
'';
};
@ -36,7 +35,7 @@ in {
"mimetype2" = "foo4.desktop";
}
'';
description = ''
description = lib.mdDoc ''
Defines additional associations of applications with
mimetypes, as if the .desktop file was listing this mimetype
in the first place.
@ -47,9 +46,9 @@ in {
type = types.attrsOf strListOrSingleton;
default = { };
example = { "mimetype1" = "foo5.desktop"; };
description = ''
description = lib.mdDoc ''
Removes associations of applications with mimetypes, as if the
.desktop file was <emphasis>not</emphasis> listing this
.desktop file was *not* listing this
mimetype in the first place.
'';
};
@ -62,7 +61,7 @@ in {
"mimetype1" = [ "default1.desktop" "default2.desktop" ];
}
'';
description = ''
description = lib.mdDoc ''
The default application to be used for a given mimetype. This
is, for instance, the one that will be started when
double-clicking on a file in a file manager. If the

6
modules/misc/xdg-mime.nix
View file

@ -13,13 +13,13 @@ in {
default = pkgs.stdenv.hostPlatform.isLinux;
defaultText =
literalExpression "true if host platform is Linux, false otherwise";
description = ''
description = lib.mdDoc ''
Whether to install programs and files to support the
XDG Shared MIME-info specification and XDG MIME Applications
specification at
<link xlink:href="https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html"/>
<https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html>
and
<link xlink:href="https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html"/>,
<https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html>,
respectively.
'';
};

8
modules/misc/xdg-system-dirs.nix
View file

@ -18,8 +18,8 @@ in {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''[ "/etc/xdg" ]'';
description = ''
Directory names to add to <envar>XDG_CONFIG_DIRS</envar>
description = lib.mdDoc ''
Directory names to add to {env}`XDG_CONFIG_DIRS`
in the user session.
'';
};
@ -28,8 +28,8 @@ in {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''[ "/usr/share" "/usr/local/share" ]'';
description = ''
Directory names to add to <envar>XDG_DATA_DIRS</envar>
description = lib.mdDoc ''
Directory names to add to {env}`XDG_DATA_DIRS`
in the user session.
'';
};

29
modules/misc/xdg-user-dirs.nix
View file

@ -21,10 +21,9 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
Whether to manage <filename>$XDG_CONFIG_HOME/user-dirs.dirs</filename>.
</para>
<para>
description = lib.mdDoc ''
Whether to manage {file}`$XDG_CONFIG_HOME/user-dirs.dirs`.
The generated file is read-only.
'';
};
@ -37,7 +36,7 @@ in {
default = "${config.home.homeDirectory}/Desktop";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Desktop"'';
description = "The Desktop directory.";
description = lib.mdDoc "The Desktop directory.";
};
documents = mkOption {
@ -45,7 +44,7 @@ in {
default = "${config.home.homeDirectory}/Documents";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Documents"'';
description = "The Documents directory.";
description = lib.mdDoc "The Documents directory.";
};
download = mkOption {
@ -53,7 +52,7 @@ in {
default = "${config.home.homeDirectory}/Downloads";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Downloads"'';
description = "The Downloads directory.";
description = lib.mdDoc "The Downloads directory.";
};
music = mkOption {
@ -61,7 +60,7 @@ in {
default = "${config.home.homeDirectory}/Music";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Music"'';
description = "The Music directory.";
description = lib.mdDoc "The Music directory.";
};
pictures = mkOption {
@ -69,7 +68,7 @@ in {
default = "${config.home.homeDirectory}/Pictures";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Pictures"'';
description = "The Pictures directory.";
description = lib.mdDoc "The Pictures directory.";
};
publicShare = mkOption {
@ -77,7 +76,7 @@ in {
default = "${config.home.homeDirectory}/Public";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Public"'';
description = "The Public share directory.";
description = lib.mdDoc "The Public share directory.";
};
templates = mkOption {
@ -85,7 +84,7 @@ in {
default = "${config.home.homeDirectory}/Templates";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Templates"'';
description = "The Templates directory.";
description = lib.mdDoc "The Templates directory.";
};
videos = mkOption {
@ -93,7 +92,7 @@ in {
default = "${config.home.homeDirectory}/Videos";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/Videos"'';
description = "The Videos directory.";
description = lib.mdDoc "The Videos directory.";
};
extraConfig = mkOption {
@ -105,11 +104,11 @@ in {
XDG_MISC_DIR = "''${config.home.homeDirectory}/Misc";
}
'';
description = "Other user directories.";
description = lib.mdDoc "Other user directories.";
};
createDirectories =
mkEnableOption "automatic creation of the XDG user directories";
createDirectories = mkEnableOption
(lib.mdDoc "automatic creation of the XDG user directories");
};
config = let

14
modules/misc/xdg.nix
View file

@ -22,13 +22,13 @@ let
in {
options.xdg = {
enable = mkEnableOption "management of XDG base directories";
enable = mkEnableOption (lib.mdDoc "management of XDG base directories");
cacheHome = mkOption {
type = types.path;
defaultText = "~/.cache";
apply = toString;
description = ''
description = lib.mdDoc ''
Absolute path to directory holding application caches.
'';
};
@ -36,7 +36,7 @@ in {
configFile = mkOption {
type = fileType "xdg.configFile" "{var}`xdg.configHome`" cfg.configHome;
default = { };
description = ''
description = lib.mdDoc ''
Attribute set of files to link into the user's XDG
configuration home.
'';
@ -46,7 +46,7 @@ in {
type = types.path;
defaultText = "~/.config";
apply = toString;
description = ''
description = lib.mdDoc ''
Absolute path to directory holding application configurations.
'';
};
@ -55,7 +55,7 @@ in {
type =
fileType "xdg.dataFile" "<varname>xdg.dataHome</varname>" cfg.dataHome;
default = { };
description = ''
description = lib.mdDoc ''
Attribute set of files to link into the user's XDG
data home.
'';
@ -65,7 +65,7 @@ in {
type = types.path;
defaultText = "~/.local/share";
apply = toString;
description = ''
description = lib.mdDoc ''
Absolute path to directory holding application data.
'';
};
@ -74,7 +74,7 @@ in {
type = types.path;
defaultText = "~/.local/state";
apply = toString;
description = ''
description = lib.mdDoc ''
Absolute path to directory holding application states.
'';
};

12
modules/misc/xfconf.nix
View file

@ -10,7 +10,7 @@ let
options = {
type = mkOption {
type = types.enum [ "int" "uint" "uint64" ];
description = ''
description = lib.mdDoc ''
To distinguish between int, uint and uint64 in xfconf,
you can specify the type in xfconf with this submodule.
For other types, you don't need to use this submodule,
@ -19,7 +19,7 @@ let
};
value = mkOption {
type = types.int;
description = "The value in xfconf.";
description = lib.mdDoc "The value in xfconf.";
};
};
};
@ -63,11 +63,11 @@ in {
type = types.bool;
default = true;
visible = false;
description = ''
description = lib.mdDoc ''
Whether to enable Xfconf settings.
</para><para>
Note, if you use NixOS then you must add
<literal>programs.xfconf.enable = true</literal>
`programs.xfconf.enable = true`
to your system configuration. Otherwise you will see a systemd error
message when your configuration is activated.
'';
@ -93,7 +93,7 @@ in {
};
}
'';
description = ''
description = lib.mdDoc ''
Settings to write to the Xfconf configuration system.
'';
};

8
modules/programs/abook.nix
View file

@ -8,7 +8,7 @@ let
in {
options.programs.abook = {
enable = mkEnableOption "Abook";
enable = mkEnableOption (lib.mdDoc "Abook");
extraConfig = mkOption {
type = types.lines;
@ -18,10 +18,10 @@ in {
view CONTACT = name, email
set autosave=true
'';
description = ''
Extra lines added to <filename>$HOME/.config/abook/abookrc</filename>.
description = lib.mdDoc ''
Extra lines added to {file}`$HOME/.config/abook/abookrc`.
Available configuration options are described in the abook repository:
<link xlink:href="https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc" />.
<https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc>.
'';
};
};

36
modules/programs/aerc-accounts.nix
View file

@ -39,10 +39,10 @@ let
});
default = null;
example = { token_endpoint = "<token_endpoint>"; };
description = ''
description = lib.mdDoc ''
Sets the oauth2 params if authentication mechanism oauthbearer or
xoauth2 is used.
See <citerefentry><refentrytitle>aerc-imap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
See {manpage}`aerc-imap(5)`.
'';
};
@ -50,16 +50,16 @@ in {
type = mkOption {
type = types.attrsOf (types.submodule {
options.aerc = {
enable = mkEnableOption "aerc";
enable = mkEnableOption (lib.mdDoc "aerc");
extraAccounts = mkOption {
type = confSection;
default = { };
example =
literalExpression ''{ source = "maildir://~/Maildir/example"; }'';
description = ''
description = lib.mdDoc ''
Extra config added to the configuration section for this account in
<filename>$HOME/.config/aerc/accounts.conf</filename>.
See <citerefentry><refentrytitle>aerc-accounts</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
{file}`$HOME/.config/aerc/accounts.conf`.
See {manpage}`aerc-accounts(5)`.
'';
};
@ -68,10 +68,10 @@ in {
default = { };
example = literalExpression
''{ messages = { d = ":move ''${folder.trash}<Enter>"; }; }'';
description = ''
description = lib.mdDoc ''
Extra bindings specific to this account, added to
<filename>$HOME/.config/aerc/binds.conf</filename>.
See <citerefentry><refentrytitle>aerc-binds</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
{file}`$HOME/.config/aerc/binds.conf`.
See {manpage}`aerc-binds(5)`.
'';
};
@ -79,12 +79,12 @@ in {
type = confSections;
default = { };
example = literalExpression "{ ui = { sidebar-width = 25; }; }";
description = ''
Config specific to this account, added to <filename>$HOME/.config/aerc/aerc.conf</filename>.
description = lib.mdDoc ''
Config specific to this account, added to {file}`$HOME/.config/aerc/aerc.conf`.
Aerc only supports per-account UI configuration.
For other sections of <filename>$HOME/.config/aerc/aerc.conf</filename>,
use <literal>programs.aerc.extraConfig</literal>.
See <citerefentry><refentrytitle>aerc-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For other sections of {file}`$HOME/.config/aerc/aerc.conf`,
use `programs.aerc.extraConfig`.
See {manpage}`aerc-config(5)`.
'';
};
@ -92,10 +92,10 @@ in {
type = with types; nullOr (enum [ "oauthbearer" "xoauth2" ]);
default = null;
example = "auth";
description = ''
description = lib.mdDoc ''
Sets the authentication mechanism if imap is used as the incoming
method.
See <citerefentry><refentrytitle>aerc-imap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
See {manpage}`aerc-imap(5)`.
'';
};
@ -106,10 +106,10 @@ in {
nullOr (enum [ "none" "plain" "login" "oauthbearer" "xoauth2" ]);
default = "plain";
example = "auth";
description = ''
description = lib.mdDoc ''
Sets the authentication mechanism if smtp is used as the outgoing
method.
See <citerefentry><refentrytitle>aerc-smtp</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
See {manpage}`aerc-smtp(5)`.
'';
};

2
modules/programs/aerc.nix
View file

@ -31,7 +31,7 @@ in {
options.programs.aerc = {
enable = mkEnableOption "aerc";
enable = mkEnableOption (lib.mdDoc "aerc");
package = mkPackageOptionMD pkgs "aerc" { };

7
modules/programs/afew.nix
View file

@ -8,7 +8,8 @@ let
in {
options.programs.afew = {
enable = mkEnableOption "the afew initial tagging script for Notmuch";
enable =
mkEnableOption (lib.mdDoc "the afew initial tagging script for Notmuch");
extraConfig = mkOption {
type = types.lines;
@ -29,10 +30,10 @@ in {
[InboxFilter]
'';
description = ''
description = lib.mdDoc ''
Extra lines added to afew configuration file. Available
configuration options are described in the afew manual:
<link xlink:href="https://afew.readthedocs.io/en/latest/configuration.html" />.
<https://afew.readthedocs.io/en/latest/configuration.html>.
'';
};
};

10
modules/programs/alacritty.nix
View file

@ -8,13 +8,13 @@ let
in {
options = {
programs.alacritty = {
enable = mkEnableOption "Alacritty";
enable = mkEnableOption (lib.mdDoc "Alacritty");
package = mkOption {
type = types.package;
default = pkgs.alacritty;
defaultText = literalExpression "pkgs.alacritty";
description = "The Alacritty package to install.";
description = lib.mdDoc "The Alacritty package to install.";
};
settings = mkOption {
@ -35,10 +35,10 @@ in {
];
}
'';
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/alacritty/alacritty.yml</filename>. See
<link xlink:href="https://github.com/alacritty/alacritty/blob/master/alacritty.yml"/>
{file}`$XDG_CONFIG_HOME/alacritty/alacritty.yml`. See
<https://github.com/alacritty/alacritty/blob/master/alacritty.yml>
for the default configuration.
'';
};

10
modules/programs/alot-accounts.nix
View file

@ -7,10 +7,10 @@ with lib;
options.alot = {
sendMailCommand = mkOption {
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
Command to send a mail. If msmtp is enabled for the account,
then this is set to
<command>msmtpq --read-envelope-from --read-recipients</command>.
{command}`msmtpq --read-envelope-from --read-recipients`.
'';
};
@ -33,9 +33,9 @@ with lib;
ignorecase = "True";
}
'';
description = ''
description = lib.mdDoc ''
Contact completion configuration as expected per alot.
See <link xlink:href="http://alot.readthedocs.io/en/latest/configuration/contacts_completion.html">alot's wiki</link> for
See [alot's wiki](http://alot.readthedocs.io/en/latest/configuration/contacts_completion.html) for
explanation about possible values.
'';
};
@ -43,7 +43,7 @@ with lib;
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra settings to add to this Alot account configuration.
'';
};

38
modules/programs/alot.nix
View file

@ -25,20 +25,20 @@ let
options = {
translated = mkOption {
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
Fixed string representation for this tag. The tag can be
hidden from view, if the key translated is set to
<literal>""</literal>, the empty string.
`""`, the empty string.
'';
};
translation = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
A pair of strings that define a regular substitution to
compute the string representation on the fly using
<literal>re.sub</literal>.
`re.sub`.
'';
};
@ -46,16 +46,16 @@ let
type = types.nullOr types.str;
default = null;
example = "'','', 'white','light red', 'white','#d66'";
description = ''
description = lib.mdDoc ''
How to display the tag when unfocused.
See <link xlink:href="https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting"/>.
See <https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting>.
'';
};
focus = mkOption {
type = types.nullOr types.str;
default = null;
description = "How to display the tag when focused.";
description = lib.mdDoc "How to display the tag when focused.";
};
};
};
@ -125,7 +125,7 @@ in {
type = types.bool;
default = false;
example = true;
description = ''
description = lib.mdDoc ''
Whether to enable the Alot mail user agent. Alot uses the
Notmuch email system and will therefore be automatically
enabled for each email account that is managed by Notmuch.
@ -135,7 +135,7 @@ in {
hooks = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Content of the hooks file.
'';
};
@ -146,42 +146,42 @@ in {
global = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Global keybindings.";
description = lib.mdDoc "Global keybindings.";
};
bufferlist = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Bufferlist mode keybindings.";
description = lib.mdDoc "Bufferlist mode keybindings.";
};
search = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Search mode keybindings.";
description = lib.mdDoc "Search mode keybindings.";
};
envelope = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Envelope mode keybindings.";
description = lib.mdDoc "Envelope mode keybindings.";
};
taglist = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Taglist mode keybindings.";
description = lib.mdDoc "Taglist mode keybindings.";
};
thread = mkOption {
type = types.attrsOf types.str;
default = { };
description = "Thread mode keybindings.";
description = lib.mdDoc "Thread mode keybindings.";
};
};
};
default = { };
description = ''
description = lib.mdDoc ''
Keybindings.
'';
};
@ -189,7 +189,7 @@ in {
tags = mkOption {
type = types.attrsOf tagSubmodule;
default = { };
description = "How to display the tags.";
description = lib.mdDoc "How to display the tags.";
};
settings = mkOption {
@ -209,7 +209,7 @@ in {
thread_indent_replies = 2;
}
'';
description = ''
description = lib.mdDoc ''
Configuration options added to alot configuration file.
'';
};
@ -217,7 +217,7 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra lines added to alot configuration file.
'';
};

6
modules/programs/antidote.nix
View file

@ -19,16 +19,16 @@ in {
meta.maintainers = [ maintainers.hitsmaxft ];
options.programs.zsh.antidote = {
enable = mkEnableOption "antidote - a zsh plugin manager";
enable = mkEnableOption (lib.mdDoc "antidote - a zsh plugin manager");
plugins = mkOption {
type = types.listOf types.str;
default = [ ];
example = [ "zsh-users/zsh-autosuggestions" ];
description = "List of antidote plugins.";
description = lib.mdDoc "List of antidote plugins.";
};
useFriendlyNames = mkEnableOption "friendly names";
useFriendlyNames = mkEnableOption (lib.mdDoc "friendly names");
package = mkPackageOptionMD pkgs "antidote" { };
};

15
modules/programs/aria2.nix
View file

@ -17,18 +17,15 @@ in {
meta.maintainers = [ hm.maintainers.justinlovinger ];
options.programs.aria2 = {
enable = mkEnableOption "aria2";
enable = mkEnableOption (lib.mdDoc "aria2");
settings = mkOption {
type = with types; attrsOf (oneOf [ bool float int str ]);
default = { };
description = ''
Options to add to <filename>aria2.conf</filename> file.
description = lib.mdDoc ''
Options to add to {file}`aria2.conf` file.
See
<citerefentry>
<refentrytitle>aria2c</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`aria2c(1)`
for options.
'';
example = literalExpression ''
@ -45,8 +42,8 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Extra lines added to <filename>aria2.conf</filename> file.
description = lib.mdDoc ''
Extra lines added to {file}`aria2.conf` file.
'';
};
};

8
modules/programs/astroid-accounts.nix
View file

@ -4,14 +4,14 @@ with lib;
{
options.astroid = {
enable = mkEnableOption "Astroid";
enable = mkEnableOption (lib.mdDoc "Astroid");
sendMailCommand = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Command to send a mail. If msmtp is enabled for the account,
then this is set to
<command>msmtpq --read-envelope-from --read-recipients</command>.
{command}`msmtpq --read-envelope-from --read-recipients`.
'';
};
@ -19,7 +19,7 @@ with lib;
type = types.attrsOf types.anything;
default = { };
example = { select_query = ""; };
description = ''
description = lib.mdDoc ''
Extra settings to add to this astroid account configuration.
'';
};

6
modules/programs/astroid.nix
View file

@ -55,13 +55,13 @@ let
in {
options = {
programs.astroid = {
enable = mkEnableOption "Astroid";
enable = mkEnableOption (lib.mdDoc "Astroid");
pollScript = mkOption {
type = types.str;
default = "";
example = "mbsync gmail";
description = ''
description = lib.mdDoc ''
Script to run to fetch/update mails.
'';
};
@ -104,7 +104,7 @@ in {
poll.interval = 0;
}
'';
description = ''
description = lib.mdDoc ''
JSON config that will override the default Astroid configuration.
'';
};

30
modules/programs/atuin.nix
View file

@ -12,31 +12,31 @@ in {
meta.maintainers = [ maintainers.hawkw ];
options.programs.atuin = {
enable = mkEnableOption "atuin";
enable = mkEnableOption (lib.mdDoc "atuin");
package = mkOption {
type = types.package;
default = pkgs.atuin;
defaultText = literalExpression "pkgs.atuin";
description = "The package to use for atuin.";
description = lib.mdDoc "The package to use for atuin.";
};
enableBashIntegration = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Atuin's Bash integration. This will bind
<literal>ctrl-r</literal> to open the Atuin history.
`ctrl-r` to open the Atuin history.
'';
};
enableZshIntegration = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Atuin's Zsh integration.
</para><para>
If enabled, this will bind <literal>ctrl-r</literal> and the up-arrow
If enabled, this will bind `ctrl-r` and the up-arrow
key to open the Atuin history.
'';
};
@ -44,9 +44,9 @@ in {
enableFishIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Atuin's Fish integration.
</para><para>
If enabled, this will bind the up-arrow key to open the Atuin history.
'';
};
@ -55,7 +55,7 @@ in {
default = [ ];
type = types.listOf types.str;
example = [ "--disable-up-arrow" "--disable-ctrl-r" ];
description = ''
description = lib.mdDoc ''
Flags to append to the shell hook.
'';
};
@ -78,11 +78,11 @@ in {
search_mode = "prefix";
}
'';
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/atuin/config.toml</filename>.
</para><para>
See <link xlink:href="https://atuin.sh/docs/config/" /> for the full list
{file}`$XDG_CONFIG_HOME/atuin/config.toml`.
See <https://atuin.sh/docs/config/> for the full list
of options.
'';
};
@ -90,7 +90,7 @@ in {
enableNushellIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Nushell integration.
'';
};

8
modules/programs/autojump.nix
View file

@ -11,12 +11,12 @@ in {
meta.maintainers = [ maintainers.evanjs ];
options.programs.autojump = {
enable = mkEnableOption "autojump";
enable = mkEnableOption (lib.mdDoc "autojump");
enableBashIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Bash integration.
'';
};
@ -24,7 +24,7 @@ in {
enableZshIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Zsh integration.
'';
};
@ -32,7 +32,7 @@ in {
enableFishIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Fish integration.
'';
};

75
modules/programs/autorandr.nix
View file

@ -26,22 +26,22 @@ let
options = {
fingerprint = mkOption {
type = types.attrsOf types.str;
description = ''
description = lib.mdDoc ''
Output name to EDID mapping.
Use <literal>autorandr --fingerprint</literal> to get current setup values.
Use `autorandr --fingerprint` to get current setup values.
'';
default = { };
};
config = mkOption {
type = types.attrsOf configModule;
description = "Per output profile configuration.";
description = lib.mdDoc "Per output profile configuration.";
default = { };
};
hooks = mkOption {
type = profileHooksModule;
description = "Profile hook scripts.";
description = lib.mdDoc "Profile hook scripts.";
default = { };
};
};
@ -51,54 +51,54 @@ let
options = {
enable = mkOption {
type = types.bool;
description = "Whether to enable the output.";
description = lib.mdDoc "Whether to enable the output.";
default = true;
};
crtc = mkOption {
type = types.nullOr types.ints.unsigned;
description = "Output video display controller.";
description = lib.mdDoc "Output video display controller.";
default = null;
example = 0;
};
primary = mkOption {
type = types.bool;
description = "Whether output should be marked as primary";
description = lib.mdDoc "Whether output should be marked as primary";
default = false;
};
position = mkOption {
type = types.str;
description = "Output position";
description = lib.mdDoc "Output position";
default = "";
example = "5760x0";
};
mode = mkOption {
type = types.str;
description = "Output resolution.";
description = lib.mdDoc "Output resolution.";
default = "";
example = "3840x2160";
};
rate = mkOption {
type = types.str;
description = "Output framerate.";
description = lib.mdDoc "Output framerate.";
default = "";
example = "60.00";
};
gamma = mkOption {
type = types.str;
description = "Output gamma configuration.";
description = lib.mdDoc "Output gamma configuration.";
default = "";
example = "1.0:0.909:0.833";
};
rotate = mkOption {
type = types.nullOr (types.enum [ "normal" "left" "right" "inverted" ]);
description = "Output rotate configuration.";
description = lib.mdDoc "Output rotate configuration.";
default = null;
example = "left";
};
@ -113,19 +113,16 @@ let
[ 0.0 0.0 1.0 ]
]
'';
description = ''
description = lib.mdDoc ''
Refer to
<citerefentry>
<refentrytitle>xrandr</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`xrandr(1)`
for the documentation of the transform matrix.
'';
};
dpi = mkOption {
type = types.nullOr types.ints.positive;
description = "Output DPI configuration.";
description = lib.mdDoc "Output DPI configuration.";
default = null;
example = 96;
};
@ -135,36 +132,33 @@ let
options = {
method = mkOption {
type = types.enum [ "factor" "pixel" ];
description = "Output scaling method.";
description = lib.mdDoc "Output scaling method.";
default = "factor";
example = "pixel";
};
x = mkOption {
type = types.either types.float types.ints.positive;
description = "Horizontal scaling factor/pixels.";
description = lib.mdDoc "Horizontal scaling factor/pixels.";
};
y = mkOption {
type = types.either types.float types.ints.positive;
description = "Vertical scaling factor/pixels.";
description = lib.mdDoc "Vertical scaling factor/pixels.";
};
};
});
description = ''
description = lib.mdDoc ''
Output scale configuration.
</para><para>
Either configure by pixels or a scaling factor. When using pixel method the
<citerefentry>
<refentrytitle>xrandr</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`xrandr(1)`
option
<literal>--scale-from</literal>
`--scale-from`
will be used; when using factor method the option
<literal>--scale</literal>
`--scale`
will be used.
</para><para>
This option is a shortcut version of the transform option and they are mutually
exclusive.
'';
@ -179,7 +173,8 @@ let
filter = mkOption {
type = types.nullOr (types.enum [ "bilinear" "nearest" ]);
description = "Interpolation method to be used for scaling the output.";
description =
lib.mdDoc "Interpolation method to be used for scaling the output.";
default = null;
example = "nearest";
};
@ -192,19 +187,19 @@ let
options = {
postswitch = mkOption {
type = types.attrsOf hookType;
description = "Postswitch hook executed after mode switch.";
description = lib.mdDoc "Postswitch hook executed after mode switch.";
default = { };
};
preswitch = mkOption {
type = types.attrsOf hookType;
description = "Preswitch hook executed before mode switch.";
description = lib.mdDoc "Preswitch hook executed before mode switch.";
default = { };
};
predetect = mkOption {
type = types.attrsOf hookType;
description = ''
description = lib.mdDoc ''
Predetect hook executed before autorandr attempts to run xrandr.
'';
default = { };
@ -216,19 +211,19 @@ let
options = {
postswitch = mkOption {
type = hookType;
description = "Postswitch hook executed after mode switch.";
description = lib.mdDoc "Postswitch hook executed after mode switch.";
default = "";
};
preswitch = mkOption {
type = hookType;
description = "Preswitch hook executed before mode switch.";
description = lib.mdDoc "Preswitch hook executed before mode switch.";
default = "";
};
predetect = mkOption {
type = hookType;
description = ''
description = lib.mdDoc ''
Predetect hook executed before autorandr attempts to run xrandr.
'';
default = "";
@ -282,11 +277,11 @@ let
in {
options = {
programs.autorandr = {
enable = mkEnableOption "Autorandr";
enable = mkEnableOption (lib.mdDoc "Autorandr");
hooks = mkOption {
type = globalHooksModule;
description = "Global hook scripts";
description = lib.mdDoc "Global hook scripts";
default = { };
example = literalExpression ''
{
@ -318,7 +313,7 @@ in {
profiles = mkOption {
type = types.attrsOf profileModule;
description = "Autorandr profiles specification.";
description = lib.mdDoc "Autorandr profiles specification.";
default = { };
example = literalExpression ''
{

41
modules/programs/bash.nix
View file

@ -27,25 +27,23 @@ in {
options = {
programs.bash = {
enable = mkEnableOption "GNU Bourne-Again SHell";
enable = mkEnableOption (lib.mdDoc "GNU Bourne-Again SHell");
enableCompletion = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Bash completion for all interactive Bash shells.
</para><para>
Note, if you use NixOS or nix-darwin and do not have Bash completion
enabled in the system configuration, then make sure to add
<programlisting language="nix">
```nix
environment.pathsToLink = [ "/share/bash-completion" ];
</programlisting>
```
to your system configuration to get completion for system packages.
Note, the legacy <filename>/etc/bash_completion.d</filename> path is
Note, the legacy {file}`/etc/bash_completion.d` path is
not supported by Home Manager.
'';
};
@ -53,33 +51,34 @@ in {
historySize = mkOption {
type = types.int;
default = 10000;
description = "Number of history lines to keep in memory.";
description = lib.mdDoc "Number of history lines to keep in memory.";
};
historyFile = mkOption {
type = types.nullOr types.str;
default = null;
description = "Location of the bash history file.";
description = lib.mdDoc "Location of the bash history file.";
};
historyFileSize = mkOption {
type = types.int;
default = 100000;
description = "Number of history lines to keep on file.";
description = lib.mdDoc "Number of history lines to keep on file.";
};
historyControl = mkOption {
type =
types.listOf (types.enum [ "erasedups" "ignoredups" "ignorespace" ]);
default = [ ];
description = "Controlling how commands are saved on the history list.";
description =
lib.mdDoc "Controlling how commands are saved on the history list.";
};
historyIgnore = mkOption {
type = types.listOf types.str;
default = [ ];
example = [ "ls" "cd" "exit" ];
description =
description = lib.mdDoc
"List of commands that should not be saved to the history list.";
};
@ -101,9 +100,9 @@ in {
"checkjobs"
];
example = [ "extglob" "-cdspell" ];
description = ''
description = lib.mdDoc ''
Shell options to set. Prefix an option with
"<literal>-</literal>" to unset.
"`-`" to unset.
'';
};
@ -111,7 +110,7 @@ in {
default = { };
type = types.attrs;
example = { MAILCHECK = 30; };
description = ''
description = lib.mdDoc ''
Environment variables that will be set for the Bash session.
'';
};
@ -125,7 +124,7 @@ in {
".." = "cd ..";
}
'';
description = ''
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs.
'';
@ -134,7 +133,7 @@ in {
profileExtra = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra commands that should be run when initializing a login
shell.
'';
@ -143,7 +142,7 @@ in {
initExtra = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra commands that should be run when initializing an
interactive shell.
'';
@ -152,8 +151,8 @@ in {
bashrcExtra = mkOption {
default = "";
type = types.lines;
description = ''
Extra commands that should be placed in <filename>~/.bashrc</filename>.
description = lib.mdDoc ''
Extra commands that should be placed in {file}`~/.bashrc`.
Note that these commands will be run even in non-interactive shells.
'';
};
@ -161,7 +160,7 @@ in {
logoutExtra = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra commands that should be run when logging out of an
interactive shell.
'';

8
modules/programs/bashmount.nix
View file

@ -10,15 +10,15 @@ in {
meta.maintainers = [ maintainers.AndersonTorres ];
options.programs.bashmount = {
enable = mkEnableOption "bashmount";
enable = mkEnableOption (lib.mdDoc "bashmount");
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/bashmount/config</filename>. Look at
<link xlink:href="https://github.com/jamielinux/bashmount/blob/master/bashmount.conf" />
{file}`$XDG_CONFIG_HOME/bashmount/config`. Look at
<https://github.com/jamielinux/bashmount/blob/master/bashmount.conf>
for explanation about possible values.
'';
};

8
modules/programs/bat.nix
View file

@ -17,7 +17,7 @@ in {
meta.maintainers = [ ];
options.programs.bat = {
enable = mkEnableOption "bat, a cat clone with wings";
enable = mkEnableOption (lib.mdDoc "bat, a cat clone with wings");
config = mkOption {
type = with types; attrsOf (either str (listOf str));
@ -27,7 +27,7 @@ in {
pager = "less -FR";
map-syntax = [ "*.jenkinsfile:Groovy" "*.props:Java Properties" ];
};
description = ''
description = lib.mdDoc ''
Bat configuration.
'';
};
@ -37,7 +37,7 @@ in {
default = [ ];
example = literalExpression
"with pkgs.bat-extras; [ batdiff batman batgrep batwatch ];";
description = ''
description = lib.mdDoc ''
Additional bat packages to install.
'';
};
@ -55,7 +55,7 @@ in {
} + "/Dracula.tmTheme");
}
'';
description = ''
description = lib.mdDoc ''
Additional themes to provide.
'';
};

22
modules/programs/beets.nix
View file

@ -20,11 +20,11 @@ in {
else
cfg.settings != { };
defaultText = "false";
description = ''
description = lib.mdDoc ''
Whether to enable the beets music library manager. This
defaults to <literal>false</literal> for state
defaults to `false` for state
version ≥ 19.03. For earlier versions beets is enabled if
<option>programs.beets.settings</option> is non-empty.
{option}`programs.beets.settings` is non-empty.
'';
};
@ -34,8 +34,8 @@ in {
defaultText = literalExpression "pkgs.beets";
example =
literalExpression "(pkgs.beets.override { enableCheck = true; })";
description = ''
The <literal>beets</literal> package to use.
description = lib.mdDoc ''
The `beets` package to use.
Can be used to specify extensions.
'';
};
@ -43,22 +43,22 @@ in {
settings = mkOption {
type = yamlFormat.type;
default = { };
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/beets/config.yaml</filename>
{file}`$XDG_CONFIG_HOME/beets/config.yaml`
'';
};
mpdIntegration = {
enableStats = mkEnableOption "mpdstats plugin and service";
enableStats = mkEnableOption (lib.mdDoc "mpdstats plugin and service");
enableUpdate = mkEnableOption "mpdupdate plugin";
enableUpdate = mkEnableOption (lib.mdDoc "mpdupdate plugin");
host = mkOption {
type = types.str;
default = "localhost";
example = "10.0.0.42";
description = "The host that mpdstats will connect to.";
description = lib.mdDoc "The host that mpdstats will connect to.";
};
port = mkOption {
@ -66,7 +66,7 @@ in {
default = config.services.mpd.network.port;
defaultText = literalExpression "config.services.mpd.network.port";
example = 6601;
description = "The port that mpdstats will connect to.";
description = lib.mdDoc "The port that mpdstats will connect to.";
};
};
};

26
modules/programs/borgmatic.nix
View file

@ -16,7 +16,7 @@ let
mkRetentionOption = frequency:
mkNullableOption {
type = types.int;
description =
description = lib.mdDoc
"Number of ${frequency} archives to keep. Use -1 for no limit.";
example = 3;
};
@ -24,20 +24,20 @@ let
extraConfigOption = mkOption {
type = yamlFormat.type;
default = { };
description = "Extra settings.";
description = lib.mdDoc "Extra settings.";
};
consistencyCheckModule = types.submodule {
options = {
name = mkOption {
type = types.enum [ "repository" "archives" "data" "extract" ];
description = "Name of consistency check to run.";
description = lib.mdDoc "Name of consistency check to run.";
example = "repository";
};
frequency = mkNullableOption {
type = types.strMatching "([[:digit:]]+ .*)|always";
description = "Frequency of this type of check";
description = lib.mdDoc "Frequency of this type of check";
example = "2 weeks";
};
};
@ -51,20 +51,20 @@ let
location = {
sourceDirectories = mkOption {
type = types.listOf types.str;
description = "Directories to backup.";
description = lib.mdDoc "Directories to backup.";
example = literalExpression "[config.home.homeDirectory]";
};
repositories = mkOption {
type = types.listOf types.str;
description = "Paths to repositories.";
description = lib.mdDoc "Paths to repositories.";
example =
literalExpression ''["ssh://myuser@myrepo.myserver.com/./repo"]'';
};
excludeHomeManagerSymlinks = mkOption {
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to exclude Home Manager generated symbolic links from
the backups. This facilitates restoring the whole home
directory when the Nix store doesn't contain the latest
@ -80,7 +80,8 @@ let
storage = {
encryptionPasscommand = mkNullableOption {
type = types.str;
description = "Command writing the passphrase to standard output.";
description =
lib.mdDoc "Command writing the passphrase to standard output.";
example =
literalExpression ''"''${pkgs.password-store}/bin/pass borg-repo"'';
};
@ -90,7 +91,8 @@ let
retention = {
keepWithin = mkNullableOption {
type = types.strMatching "[[:digit:]]+[Hdwmy]";
description = "Keep all archives within this time interval.";
description =
lib.mdDoc "Keep all archives within this time interval.";
example = "2d";
};
@ -109,7 +111,7 @@ let
checks = mkOption {
type = types.listOf consistencyCheckModule;
default = [ ];
description = "Consistency checks to run";
description = lib.mdDoc "Consistency checks to run";
example = literalExpression ''
[
{
@ -180,13 +182,13 @@ in {
options = {
programs.borgmatic = {
enable = mkEnableOption "Borgmatic";
enable = mkEnableOption (lib.mdDoc "Borgmatic");
package = mkPackageOptionMD pkgs "borgmatic" { };
backups = mkOption {
type = types.attrsOf configModule;
description = ''
description = lib.mdDoc ''
Borgmatic allows for several named backup configurations,
each with its own source directories and repositories.
'';

14
modules/programs/bottom.nix
View file

@ -11,25 +11,25 @@ let
in {
options = {
programs.bottom = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
bottom, a cross-platform graphical process/system monitor with a
customizable interface'';
customizable interface'');
package = mkOption {
type = types.package;
default = pkgs.bottom;
defaultText = literalExpression "pkgs.bottom";
description = "Package providing <command>bottom</command>.";
description = lib.mdDoc "Package providing {command}`bottom`.";
};
settings = mkOption {
type = tomlFormat.type;
default = { };
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/bottom/bottom.toml</filename>.
</para><para>
See <link xlink:href="https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml"/>
{file}`$XDG_CONFIG_HOME/bottom/bottom.toml`.
See <https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml>
for the default configuration.
'';
example = literalExpression ''

19
modules/programs/boxxy.nix
View file

@ -12,7 +12,7 @@ let
options = {
name = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Unique identifier of the boxxy rule. This can be any single-line string.
'';
};
@ -21,7 +21,7 @@ let
type = types.str;
default = "";
example = "~/.ssh";
description = ''
description = lib.mdDoc ''
What directory/file to redirect.
'';
};
@ -30,7 +30,7 @@ let
type = types.str;
default = "";
example = literalExpression ''"''${config.xdg.configHome}/ssh"'';
description = ''
description = lib.mdDoc ''
Where that file/directory should be rewritten to.
'';
};
@ -38,7 +38,7 @@ let
mode = mkOption {
type = types.enum [ "file" "directory" ];
default = "directory";
description = ''
description = lib.mdDoc ''
Does the current path redirect a file or a directory?
'';
};
@ -52,7 +52,7 @@ let
"/usr/bin/sh"
]
'';
description = ''
description = lib.mdDoc ''
Apply redirection ONLY to specified executable names.
'';
};
@ -61,7 +61,7 @@ let
type = types.listOf types.str;
default = [ ];
example = [ "/home/example/Projects/my-project" ];
description = ''
description = lib.mdDoc ''
Apply redirection ONLY when in a certain directory.
'';
};
@ -74,7 +74,7 @@ let
MY_ENV_VAR = "my_env_var_value";
}
'';
description = ''
description = lib.mdDoc ''
Give certain environment variables for said match.
'';
};
@ -82,14 +82,15 @@ let
};
in {
options.programs.boxxy = {
enable = mkEnableOption "boxxy: Boxes in badly behaving applications";
enable =
mkEnableOption (lib.mdDoc "boxxy: Boxes in badly behaving applications");
package = mkPackageOptionMD pkgs "boxxy" { };
rules = mkOption {
type = types.listOf boxxyRulesOpts;
default = [ ];
description = "List of boxxy rules";
description = lib.mdDoc "List of boxxy rules";
};
};

15
modules/programs/broot.nix
View file

@ -12,7 +12,7 @@ let
freeformType = tomlFormat.type;
options = {
modal = mkEnableOption "modal (vim) mode";
modal = mkEnableOption (lib.mdDoc "modal (vim) mode");
verbs = mkOption {
type = with types; listOf (attrsOf (either bool str));
@ -149,12 +149,13 @@ in {
];
options.programs.broot = {
enable = mkEnableOption "Broot, a better way to navigate directories";
enable =
mkEnableOption (lib.mdDoc "Broot, a better way to navigate directories");
enableBashIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Bash integration.
'';
};
@ -162,7 +163,7 @@ in {
enableZshIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Zsh integration.
'';
};
@ -170,7 +171,7 @@ in {
enableFishIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Fish integration.
'';
};
@ -179,13 +180,13 @@ in {
type = types.package;
default = pkgs.broot;
defaultText = literalExpression "pkgs.broot";
description = "Package providing broot";
description = lib.mdDoc "Package providing broot";
};
settings = mkOption {
type = types.submodule settingsModule;
default = { };
description = "Verbatim config entries";
description = lib.mdDoc "Verbatim config entries";
};
};

5
modules/programs/browserpass.nix
View file

@ -8,13 +8,14 @@ let
in {
options = {
programs.browserpass = {
enable = mkEnableOption "the browserpass extension host application";
enable =
mkEnableOption (lib.mdDoc "the browserpass extension host application");
browsers = mkOption {
type = types.listOf (types.enum browsers);
default = browsers;
example = [ "firefox" ];
description = "Which browsers to install browserpass for";
description = lib.mdDoc "Which browsers to install browserpass for";
};
};
};

12
modules/programs/btop.nix
View file

@ -28,7 +28,7 @@ in {
meta.maintainers = [ hm.maintainers.GaetanLepage ];
options.programs.btop = {
enable = mkEnableOption "btop";
enable = mkEnableOption (lib.mdDoc "btop");
package = mkPackageOptionMD pkgs "btop" { };
@ -39,9 +39,9 @@ in {
color_theme = "Default";
theme_background = false;
};
description = ''
Options to add to <filename>btop.conf</filename> file.
See <link xlink:href="https://github.com/aristocratos/btop#configurability"/>
description = lib.mdDoc ''
Options to add to {file}`btop.conf` file.
See <https://github.com/aristocratos/btop#configurability>
for options.
'';
};
@ -49,8 +49,8 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Extra lines added to the <filename>btop.conf</filename> file.
description = lib.mdDoc ''
Extra lines added to the {file}`btop.conf` file.
'';
};
};

36
modules/programs/chromium.nix
View file

@ -23,7 +23,7 @@ let
type = types.bool;
default = false;
example = true;
description = "Whether to enable ${name}.";
description = lib.mdDoc "Whether to enable ${name}.";
};
package = mkOption {
@ -31,7 +31,7 @@ let
type = types.package;
default = defaultPkg;
defaultText = literalExpression "pkgs.${browser}";
description = "The ${name} package to use.";
description = lib.mdDoc "The ${name} package to use.";
};
commandLineArgs = mkOption {
@ -39,14 +39,14 @@ let
type = types.listOf types.str;
default = [ ];
example = [ "--enable-logging=stderr" "--ignore-gpu-blocklist" ];
description = ''
description = lib.mdDoc ''
List of command-line arguments to be passed to ${name}.
</para><para>
For a list of common switches, see
<link xlink:href="https://chromium.googlesource.com/chromium/src/+/refs/heads/main/chrome/common/chrome_switches.cc">Chrome switches</link>.
</para><para>
[Chrome switches](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/chrome/common/chrome_switches.cc).
To search switches for other components, see
<link xlink:href="https://source.chromium.org/search?q=file:switches.cc&amp;ss=chromium%2Fchromium%2Fsrc">Chromium codesearch</link>.
[Chromium codesearch](https://source.chromium.org/search?q=file:switches.cc&ss=chromium%2Fchromium%2Fsrc).
'';
};
} // optionalAttrs (!isProprietaryChrome) {
@ -60,7 +60,7 @@ let
options = {
id = mkOption {
type = strMatching "[a-zA-Z]{32}";
description = ''
description = lib.mdDoc ''
The extension's ID from the Chrome Web Store url or the unpacked crx.
'';
default = "";
@ -68,7 +68,7 @@ let
updateUrl = mkOption {
type = str;
description = ''
description = lib.mdDoc ''
URL of the extension's update manifest XML file. Linux only.
'';
default = "https://clients2.google.com/service/update2/crx";
@ -78,7 +78,7 @@ let
crxPath = mkOption {
type = nullOr path;
description = ''
description = lib.mdDoc ''
Path to the extension's crx file. Linux only.
'';
default = null;
@ -87,7 +87,7 @@ let
version = mkOption {
type = nullOr str;
description = ''
description = lib.mdDoc ''
The extension's version, required for local installation. Linux only.
'';
default = null;
@ -111,16 +111,16 @@ let
}
]
'';
description = ''
description = lib.mdDoc ''
List of ${name} extensions to install.
To find the extension ID, check its URL on the
<link xlink:href="https://chrome.google.com/webstore/category/extensions">Chrome Web Store</link>.
</para><para>
[Chrome Web Store](https://chrome.google.com/webstore/category/extensions).
To install extensions outside of the Chrome Web Store set
<literal>updateUrl</literal> or <literal>crxPath</literal> and
<literal>version</literal> as explained in the
<link xlink:href="https://developer.chrome.com/docs/extensions/mv2/external_extensions">Chrome
documentation</link>.
`updateUrl` or `crxPath` and
`version` as explained in the
[Chrome
documentation](https://developer.chrome.com/docs/extensions/mv2/external_extensions).
'';
};
};

7
modules/programs/command-not-found/command-not-found.nix
View file

@ -31,13 +31,14 @@ let
in {
options.programs.command-not-found = {
enable = mkEnableOption "command-not-found hook for interactive shell";
enable =
mkEnableOption (lib.mdDoc "command-not-found hook for interactive shell");
dbPath = mkOption {
default =
"/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite";
description = ''
Absolute path to <filename>programs.sqlite</filename>. By
description = lib.mdDoc ''
Absolute path to {file}`programs.sqlite`. By
default this file will be provided by your channel
(nixexprs.tar.xz).
'';

7
modules/programs/comodoro.nix
View file

@ -8,16 +8,17 @@ in {
meta.maintainers = with lib.hm.maintainers; [ soywod ];
options.programs.comodoro = {
enable = lib.mkEnableOption "Comodoro, a CLI to manage your time";
enable =
lib.mkEnableOption (lib.mdDoc "Comodoro, a CLI to manage your time");
package = lib.mkPackageOptionMD pkgs "comodoro" { };
settings = lib.mkOption {
type = lib.types.submodule { freeformType = tomlFormat.type; };
default = { };
description = ''
description = lib.mdDoc ''
Comodoro configuration.
See <link xlink:href="https://pimalaya.org/comodoro/cli/configuration/"/> for supported values.
See <https://pimalaya.org/comodoro/cli/configuration/> for supported values.
'';
};
};

6
modules/programs/darcs.nix
View file

@ -11,7 +11,7 @@ in {
options = {
programs.darcs = {
enable = mkEnableOption "darcs";
enable = mkEnableOption (lib.mdDoc "darcs");
package = mkPackageOption pkgs "darcs" { };
@ -19,7 +19,7 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "Fred Bloggs <fred@example.net>" ];
description = ''
description = lib.mdDoc ''
If this list has a single entry, it will be used as the author
when you record a patch. If there are multiple entries, Darcs
will prompt you to choose one of them.
@ -30,7 +30,7 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "^.idea$" ".iml$" "^.stack-work$" ];
description = "File patterns to ignore";
description = lib.mdDoc "File patterns to ignore";
};
};
};

22
modules/programs/dircolors.nix
View file

@ -13,16 +13,16 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
Whether to manage <filename>.dir_colors</filename>
and set <literal>LS_COLORS</literal>.
description = lib.mdDoc ''
Whether to manage {file}`.dir_colors`
and set `LS_COLORS`.
'';
};
enableBashIntegration = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Bash integration.
'';
};
@ -30,7 +30,7 @@ in {
enableFishIntegration = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Fish integration.
'';
};
@ -38,7 +38,7 @@ in {
enableZshIntegration = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Zsh integration.
'';
};
@ -46,9 +46,9 @@ in {
settings = mkOption {
type = with types; attrsOf str;
default = { };
description = ''
Options to add to <filename>.dir_colors</filename> file.
See <command>dircolors --print-database</command>
description = lib.mdDoc ''
Options to add to {file}`.dir_colors` file.
See {command}`dircolors --print-database`
for options.
'';
example = literalExpression ''
@ -63,8 +63,8 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Extra lines added to <filename>.dir_colors</filename> file.
description = lib.mdDoc ''
Extra lines added to {file}`.dir_colors` file.
'';
};
};

29
modules/programs/direnv.nix
View file

@ -22,20 +22,17 @@ in {
meta.maintainers = [ maintainers.rycee ];
options.programs.direnv = {
enable = mkEnableOption "direnv, the environment switcher";
enable = mkEnableOption (lib.mdDoc "direnv, the environment switcher");
config = mkOption {
type = tomlFormat.type;
default = { };
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/direnv/direnv.toml</filename>.
</para><para>
{file}`$XDG_CONFIG_HOME/direnv/direnv.toml`.
See
<citerefentry>
<refentrytitle>direnv.toml</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
{manpage}`direnv.toml(1)`.
for the full list of options.
'';
};
@ -43,16 +40,16 @@ in {
stdlib = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Custom stdlib written to
<filename>$XDG_CONFIG_HOME/direnv/direnvrc</filename>.
{file}`$XDG_CONFIG_HOME/direnv/direnvrc`.
'';
};
enableBashIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Bash integration.
'';
};
@ -60,7 +57,7 @@ in {
enableZshIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Zsh integration.
'';
};
@ -69,13 +66,13 @@ in {
default = true;
type = types.bool;
readOnly = true;
description = ''
description = lib.mdDoc ''
Whether to enable Fish integration. Note, enabling the direnv module
will always active its functionality for Fish since the direnv package
automatically gets loaded in Fish. If this is not the case try adding
<programlisting language="nix">
```nix
environment.pathsToLink = [ "/share/fish" ];
</programlisting>
```
to the system configuration.
'';
};
@ -83,7 +80,7 @@ in {
enableNushellIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Nushell integration.
'';
};

6
modules/programs/discocss.nix
View file

@ -9,7 +9,7 @@ in {
options = {
programs.discocss = {
enable = mkEnableOption
"discocss, a tiny Discord CSS injector for Linux and MacOS";
(lib.mdDoc "discocss, a tiny Discord CSS injector for Linux and MacOS");
package = mkPackageOptionMD pkgs "discocss" { };
@ -18,13 +18,13 @@ in {
discordAlias = mkOption {
type = types.bool;
default = true;
description = "Whether to alias discocss to discord.";
description = lib.mdDoc "Whether to alias discocss to discord.";
};
css = mkOption {
type = types.str;
default = "";
description = "The custom CSS for discocss to use.";
description = lib.mdDoc "The custom CSS for discocss to use.";
};
};
};

10
modules/programs/eclipse.nix
View file

@ -11,14 +11,14 @@ in {
options = {
programs.eclipse = {
enable = mkEnableOption "Eclipse";
enable = mkEnableOption (lib.mdDoc "Eclipse");
package = mkOption {
type = types.package;
default = pkgs.eclipses.eclipse-platform;
defaultText = literalExpression "pkgs.eclipses.eclipse-platform";
example = literalExpression "pkgs.eclipses.eclipse-java";
description = ''
description = lib.mdDoc ''
The Eclipse package to install.
'';
};
@ -27,7 +27,7 @@ in {
type = types.bool;
default = false;
example = true;
description = ''
description = lib.mdDoc ''
Whether to enable the Lombok Java Agent in Eclipse. This is
necessary to use the Lombok class annotations.
'';
@ -36,13 +36,13 @@ in {
jvmArgs = mkOption {
type = types.listOf types.str;
default = [ ];
description = "JVM arguments to use for the Eclipse process.";
description = lib.mdDoc "JVM arguments to use for the Eclipse process.";
};
plugins = mkOption {
type = types.listOf types.package;
default = [ ];
description = "Plugins that should be added to Eclipse.";
description = lib.mdDoc "Plugins that should be added to Eclipse.";
};
};
};

20
modules/programs/emacs.nix
View file

@ -28,14 +28,14 @@ in {
options = {
programs.emacs = {
enable = mkEnableOption "Emacs";
enable = mkEnableOption (lib.mdDoc "Emacs");
package = mkOption {
type = types.package;
default = pkgs.emacs;
defaultText = literalExpression "pkgs.emacs";
example = literalExpression "pkgs.emacs25-nox";
description = "The Emacs package to use.";
description = lib.mdDoc "The Emacs package to use.";
};
# NOTE: The config is placed in default.el instead of ~/.emacs.d so that
@ -48,12 +48,12 @@ in {
example = ''
(setq standard-indent 2)
'';
description = ''
description = lib.mdDoc ''
Configuration to include in the Emacs default init file. See
<link xlink:href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Init-File.html"/>
<https://www.gnu.org/software/emacs/manual/html_node/elisp/Init-File.html>
for more.
</para><para>
Note, the <literal>inhibit-startup-message</literal> Emacs option
Note, the `inhibit-startup-message` Emacs option
cannot be set here since Emacs disallows setting it from the default
initialization file.
'';
@ -64,10 +64,10 @@ in {
type = hm.types.selectorFunction;
defaultText = "epkgs: []";
example = literalExpression "epkgs: [ epkgs.emms epkgs.magit ]";
description = ''
description = lib.mdDoc ''
Extra packages available to Emacs. To get a list of
available packages run:
<command>nix-env -f '&lt;nixpkgs&gt;' -qaP -A emacsPackages</command>.
{command}`nix-env -f '<nixpkgs>' -qaP -A emacsPackages`.
'';
};
@ -81,7 +81,7 @@ in {
# ...
};
'';
description = ''
description = lib.mdDoc ''
Allows overriding packages within the Emacs package set.
'';
};
@ -90,7 +90,7 @@ in {
type = types.package;
visible = false;
readOnly = true;
description = ''
description = lib.mdDoc ''
The Emacs package including any overrides and extra packages.
'';
};

8
modules/programs/eww.nix
View file

@ -10,14 +10,14 @@ in {
meta.maintainers = [ hm.maintainers.mainrs ];
options.programs.eww = {
enable = mkEnableOption "eww";
enable = mkEnableOption (lib.mdDoc "eww");
package = mkOption {
type = types.package;
default = pkgs.eww;
defaultText = literalExpression "pkgs.eww";
example = literalExpression "pkgs.eww";
description = ''
description = lib.mdDoc ''
The eww package to install.
'';
};
@ -25,9 +25,9 @@ in {
configDir = mkOption {
type = types.path;
example = literalExpression "./eww-config-dir";
description = ''
description = lib.mdDoc ''
The directory that gets symlinked to
<filename>$XDG_CONFIG_HOME/eww</filename>.
{file}`$XDG_CONFIG_HOME/eww`.
'';
};
};

15
modules/programs/exa.nix
View file

@ -7,15 +7,16 @@ with lib;
options.programs.exa = {
enable =
mkEnableOption "exa, a modern replacement for <command>ls</command>";
mkEnableOption (lib.mdDoc "exa, a modern replacement for {command}`ls`");
enableAliases = mkEnableOption "recommended exa aliases (ls, ll…)";
enableAliases =
mkEnableOption (lib.mdDoc "recommended exa aliases (ls, ll…)");
extraOptions = mkOption {
type = types.listOf types.str;
default = [ ];
example = [ "--group-directories-first" "--header" ];
description = ''
description = lib.mdDoc ''
Extra command line options passed to exa.
'';
};
@ -23,16 +24,16 @@ with lib;
icons = mkOption {
type = types.bool;
default = false;
description = ''
Display icons next to file names (<option>--icons</option> argument).
description = lib.mdDoc ''
Display icons next to file names ({option}`--icons` argument).
'';
};
git = mkOption {
type = types.bool;
default = false;
description = ''
List each file's Git status if tracked or ignored (<option>--git</option> argument).
description = lib.mdDoc ''
List each file's Git status if tracked or ignored ({option}`--git` argument).
'';
};

10
modules/programs/feh.nix
View file

@ -25,7 +25,7 @@ let
in {
options.programs.feh = {
enable = mkEnableOption "feh - a fast and light image viewer";
enable = mkEnableOption (lib.mdDoc "feh - a fast and light image viewer");
package = mkPackageOptionMD pkgs "feh" { };
@ -37,11 +37,11 @@ in {
zoom_out = "C-4";
prev_img = [ 3 "C-3" ];
};
description = ''
description = lib.mdDoc ''
Override feh's default mouse button mapping. If you want to disable an
action, set its value to null. If you want to bind multiple buttons to
an action, set its value to a list.
See <link xlink:href="https://man.finalrewind.org/1/feh/#x425554544f4e53"/> for
See <https://man.finalrewind.org/1/feh/#x425554544f4e53> for
default bindings and available commands.
'';
};
@ -54,11 +54,11 @@ in {
zoom_out = "minus";
prev_img = [ "h" "Left" ];
};
description = ''
description = lib.mdDoc ''
Override feh's default keybindings. If you want to disable a keybinding
set its value to null. If you want to bind multiple keys to an action,
set its value to a list.
See <link xlink:href="https://man.finalrewind.org/1/feh/#x4b455953"/> for
See <https://man.finalrewind.org/1/feh/#x4b455953> for
default bindings and available commands.
'';
};

67
modules/programs/firefox.nix
View file

@ -134,7 +134,7 @@ in {
options = {
programs.firefox = {
enable = mkEnableOption "Firefox";
enable = mkEnableOption (lib.mdDoc "Firefox");
package = mkOption {
type = types.package;
@ -154,7 +154,7 @@ in {
};
}
'';
description = ''
description = lib.mdDoc ''
The Firefox package to use. If state version ≥ 19.09 then
this should be a wrapped Firefox package. For earlier state
versions it should be an unwrapped Firefox package.
@ -167,13 +167,13 @@ in {
name = mkOption {
type = types.str;
default = name;
description = "Profile name.";
description = lib.mdDoc "Profile name.";
};
id = mkOption {
type = types.ints.unsigned;
default = 0;
description = ''
description = lib.mdDoc ''
Profile ID. This should be set to a unique number per profile.
'';
};
@ -198,7 +198,7 @@ in {
}];
}
'';
description = ''
description = lib.mdDoc ''
Attribute set of Firefox preferences.
Firefox only supports int, bool, and string types for
@ -210,15 +210,15 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Extra preferences to add to <filename>user.js</filename>.
description = lib.mdDoc ''
Extra preferences to add to {file}`user.js`.
'';
};
userChrome = mkOption {
type = types.lines;
default = "";
description = "Custom Firefox user chrome CSS.";
description = lib.mdDoc "Custom Firefox user chrome CSS.";
example = ''
/* Hide tab bar in FF Quantum */
@-moz-document url("chrome://browser/content/browser.xul") {
@ -237,7 +237,7 @@ in {
userContent = mkOption {
type = types.lines;
default = "";
description = "Custom Firefox user content CSS.";
description = lib.mdDoc "Custom Firefox user content CSS.";
example = ''
/* Hide scrollbar in FF Quantum */
*{scrollbar-width:none !important}
@ -251,24 +251,25 @@ in {
name = mkOption {
type = types.str;
default = name;
description = "Bookmark name.";
description = lib.mdDoc "Bookmark name.";
};
tags = mkOption {
type = types.listOf types.str;
default = [ ];
description = "Bookmark tags.";
description = lib.mdDoc "Bookmark tags.";
};
keyword = mkOption {
type = types.nullOr types.str;
default = null;
description = "Bookmark search keyword.";
description = lib.mdDoc "Bookmark search keyword.";
};
url = mkOption {
type = types.str;
description = "Bookmark url, use %s for search terms.";
description =
lib.mdDoc "Bookmark url, use %s for search terms.";
};
};
}) // {
@ -282,19 +283,20 @@ in {
name = mkOption {
type = types.str;
default = name;
description = "Directory name.";
description = lib.mdDoc "Directory name.";
};
bookmarks = mkOption {
type = types.listOf nodeType;
default = [ ];
description = "Bookmarks within directory.";
description = lib.mdDoc "Bookmarks within directory.";
};
toolbar = mkOption {
type = types.bool;
default = false;
description = "If directory should be shown in toolbar.";
description =
lib.mdDoc "If directory should be shown in toolbar.";
};
};
}) // {
@ -334,7 +336,7 @@ in {
}
]
'';
description = ''
description = lib.mdDoc ''
Preloaded bookmarks. Note, this may silently overwrite any
previously existing bookmarks!
'';
@ -343,21 +345,21 @@ in {
path = mkOption {
type = types.str;
default = name;
description = "Profile path.";
description = lib.mdDoc "Profile path.";
};
isDefault = mkOption {
type = types.bool;
default = config.id == 0;
defaultText = "true if profile ID is 0";
description = "Whether this is a default profile.";
description = lib.mdDoc "Whether this is a default profile.";
};
search = {
force = mkOption {
type = with types; bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to force replace the existing search
configuration. This is recommended since Firefox will
replace the symlink for the search configuration on every
@ -370,7 +372,7 @@ in {
type = with types; nullOr str;
default = null;
example = "DuckDuckGo";
description = ''
description = lib.mdDoc ''
The default search engine used in the address bar and search bar.
'';
};
@ -379,7 +381,7 @@ in {
type = with types; uniq (listOf str);
default = [ ];
example = [ "DuckDuckGo" "Google" ];
description = ''
description = lib.mdDoc ''
The order the search engines are listed in. Any engines
that aren't included in this list will be listed after
these in an unspecified order.
@ -415,19 +417,18 @@ in {
"Google".metaData.alias = "@g"; # builtin engines only support specifying one additional alias
}
'';
description = ''
description = lib.mdDoc ''
Attribute set of search engine configurations. Engines
that only have <varname>metaData</varname> specified will
that only have {var}`metaData` specified will
be treated as builtin to Firefox.
</para><para>
See <link xlink:href=
"https://searchfox.org/mozilla-central/rev/669329e284f8e8e2bb28090617192ca9b4ef3380/toolkit/components/search/SearchEngine.jsm#1138-1177">SearchEngine.jsm</link>
See [SearchEngine.jsm](https://searchfox.org/mozilla-central/rev/669329e284f8e8e2bb28090617192ca9b4ef3380/toolkit/components/search/SearchEngine.jsm#1138-1177)
in Firefox's source for available options. We maintain a
mapping to let you specify all options in the referenced
link without underscores, but it may fall out of date with
future options.
</para><para>
Note, <varname>icon</varname> is also a special option
Note, {var}`icon` is also a special option
added by Home Manager to make it convenient to specify
absolute icon paths.
'';
@ -462,17 +463,17 @@ in {
};
}));
default = { };
description = "Attribute set of Firefox profiles.";
description = lib.mdDoc "Attribute set of Firefox profiles.";
};
enableGnomeExtensions = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable the GNOME Shell native host connector. Note, you
also need to set the NixOS option
<literal>services.gnome.gnome-browser-connector.enable</literal> to
<literal>true</literal>.
`services.gnome.gnome-browser-connector.enable` to
`true`.
'';
};
};

61
modules/programs/fish.nix
View file

@ -10,19 +10,19 @@ let
options = {
src = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path to the plugin folder.
</para><para>
Relevant pieces will be added to the fish function path and
the completion path. The <filename>init.fish</filename> and
<filename>key_binding.fish</filename> files are sourced if
the completion path. The {file}`init.fish` and
{file}`key_binding.fish` files are sourced if
they exist.
'';
};
name = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
The name of the plugin.
'';
};
@ -33,7 +33,7 @@ let
options = {
body = mkOption {
type = types.lines;
description = ''
description = lib.mdDoc ''
The function body.
'';
};
@ -41,7 +41,7 @@ let
argumentNames = mkOption {
type = with types; nullOr (either str (listOf str));
default = null;
description = ''
description = lib.mdDoc ''
Assigns the value of successive command line arguments to the names
given.
'';
@ -50,7 +50,7 @@ let
description = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
A description of what the function does, suitable as a completion
description.
'';
@ -59,7 +59,7 @@ let
wraps = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Causes the function to inherit completions from the given wrapped
command.
'';
@ -68,7 +68,7 @@ let
onEvent = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Tells fish to run this function when the specified named event is
emitted. Fish internally generates named events e.g. when showing the
prompt.
@ -78,7 +78,7 @@ let
onVariable = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Tells fish to run this function when the specified variable changes
value.
'';
@ -87,9 +87,9 @@ let
onJobExit = mkOption {
type = with types; nullOr (either str int);
default = null;
description = ''
description = lib.mdDoc ''
Tells fish to run this function when the job with the specified group
ID exits. Instead of a PID, the stringer <literal>caller</literal> can
ID exits. Instead of a PID, the stringer `caller` can
be specified. This is only legal when in a command substitution, and
will result in the handler being triggered by the exit of the job
which created this command substitution.
@ -100,11 +100,11 @@ let
type = with types; nullOr (either str int);
default = null;
example = "$fish_pid";
description = ''
description = lib.mdDoc ''
Tells fish to run this function when the fish child process with the
specified process ID exits. Instead of a PID, for backwards
compatibility, <literal>%self</literal> can be specified as an alias
for <literal>$fish_pid</literal>, and the function will be run when
compatibility, `%self` can be specified as an alias
for `$fish_pid`, and the function will be run when
the current fish instance exits.
'';
};
@ -113,7 +113,7 @@ let
type = with types; nullOr (either str int);
default = null;
example = [ "SIGHUP" "HUP" 1 ];
description = ''
description = lib.mdDoc ''
Tells fish to run this function when the specified signal is
delievered. The signal can be a signal number or signal name.
'';
@ -122,7 +122,7 @@ let
noScopeShadowing = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Allows the function to access the variables of calling functions.
'';
};
@ -130,7 +130,7 @@ let
inheritVariable = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Snapshots the value of the specified variable and defines a local
variable with that same name and value when the function is defined.
'';
@ -172,13 +172,14 @@ in {
options = {
programs.fish = {
enable = mkEnableOption "fish, the friendly interactive shell";
enable =
mkEnableOption (lib.mdDoc "fish, the friendly interactive shell");
package = mkOption {
type = types.package;
default = pkgs.fish;
defaultText = literalExpression "pkgs.fish";
description = ''
description = lib.mdDoc ''
The fish package to install. May be used to change the version.
'';
};
@ -192,7 +193,7 @@ in {
"..." = "cd ../..";
}
'';
description = ''
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names
in this option) to command strings or directly to build outputs.
'';
@ -205,7 +206,7 @@ in {
l = "less";
gco = "git checkout";
};
description = ''
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names
in this option) to abbreviations. Abbreviations are expanded with
the longer phrase after they are entered.
@ -215,7 +216,7 @@ in {
shellInit = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell script code called during fish shell
initialisation.
'';
@ -224,7 +225,7 @@ in {
loginShellInit = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell script code called during fish login shell
initialisation.
'';
@ -233,7 +234,7 @@ in {
interactiveShellInit = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Shell script code called during interactive fish shell
initialisation.
'';
@ -268,9 +269,9 @@ in {
}
]
'';
description = ''
description = lib.mdDoc ''
The plugins to source in
<filename>conf.d/99plugins.fish</filename>.
{file}`conf.d/99plugins.fish`.
'';
};
@ -287,9 +288,9 @@ in {
gitignore = "curl -sL https://www.gitignore.io/api/$argv";
}
'';
description = ''
description = lib.mdDoc ''
Basic functions to add to fish. For more information see
<link xlink:href="https://fishshell.com/docs/current/cmds/function.html"/>.
<https://fishshell.com/docs/current/cmds/function.html>.
'';
};
};

11
modules/programs/foot.nix
View file

@ -11,24 +11,23 @@ in {
meta.maintainers = with lib.maintainers; [ plabadens ];
options.programs.foot = {
enable = mkEnableOption "Foot terminal";
enable = mkEnableOption (lib.mdDoc "Foot terminal");
package = mkOption {
type = types.package;
default = pkgs.foot;
defaultText = literalExpression "pkgs.foot";
description = "The foot package to install";
description = lib.mdDoc "The foot package to install";
};
server.enable = mkEnableOption "Foot terminal server";
server.enable = mkEnableOption (lib.mdDoc "Foot terminal server");
settings = mkOption {
type = iniFormat.type;
default = { };
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/foot/foot.ini</filename>. See <link
xlink:href="https://codeberg.org/dnkl/foot/src/branch/master/foot.ini"/>
{file}`$XDG_CONFIG_HOME/foot/foot.ini`. See <https://codeberg.org/dnkl/foot/src/branch/master/foot.ini>
for a list of available options.
'';
example = literalExpression ''

9
modules/programs/fuzzel.nix
View file

@ -13,7 +13,7 @@ in {
meta.maintainers = [ lib.maintainers.Scrumplex ];
options.programs.fuzzel = {
enable = mkEnableOption "fuzzel";
enable = mkEnableOption (lib.mdDoc "fuzzel");
package = mkPackageOptionMD pkgs "fuzzel" { };
@ -29,11 +29,10 @@ in {
colors.background = "ffffffff";
}
'';
description = ''
description = lib.mdDoc ''
Configuration for fuzzel written to
<filename>$XDG_CONFIG_HOME/fuzzel/fuzzel.ini</filename>. See
<citerefentry><refentrytitle>fuzzel.ini</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for a list of available options.
{file}`$XDG_CONFIG_HOME/fuzzel/fuzzel.ini`. See
{manpage}`fuzzel.ini(5)` for a list of available options.
'';
};
};

42
modules/programs/fzf.nix
View file

@ -17,20 +17,20 @@ in {
];
options.programs.fzf = {
enable = mkEnableOption "fzf - a command-line fuzzy finder";
enable = mkEnableOption (lib.mdDoc "fzf - a command-line fuzzy finder");
package = mkOption {
type = types.package;
default = pkgs.fzf;
defaultText = literalExpression "pkgs.fzf";
description = "Package providing the <command>fzf</command> tool.";
description = lib.mdDoc "Package providing the {command}`fzf` tool.";
};
defaultCommand = mkOption {
type = types.nullOr types.str;
default = null;
example = "fd --type f";
description = ''
description = lib.mdDoc ''
The command that gets executed as the default source for fzf
when running.
'';
@ -40,7 +40,7 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "--height 40%" "--border" ];
description = ''
description = lib.mdDoc ''
Extra command line options given to fzf by default.
'';
};
@ -49,7 +49,7 @@ in {
type = types.nullOr types.str;
default = null;
example = "fd --type f";
description = ''
description = lib.mdDoc ''
The command that gets executed as the source for fzf for the
CTRL-T keybinding.
'';
@ -59,7 +59,7 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "--preview 'head {}'" ];
description = ''
description = lib.mdDoc ''
Command line options for the CTRL-T keybinding.
'';
};
@ -68,7 +68,7 @@ in {
type = types.nullOr types.str;
default = null;
example = "fd --type d";
description = ''
description = lib.mdDoc ''
The command that gets executed as the source for fzf for the
ALT-C keybinding.
'';
@ -78,7 +78,7 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "--preview 'tree -C {} | head -200'" ];
description = ''
description = lib.mdDoc ''
Command line options for the ALT-C keybinding.
'';
};
@ -87,7 +87,7 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "--sort" "--exact" ];
description = ''
description = lib.mdDoc ''
Command line options for the CTRL-R keybinding.
'';
};
@ -103,26 +103,26 @@ in {
"fg+" = "#d4d4d4";
}
'';
description = ''
Color scheme options added to <literal>FZF_DEFAULT_OPTS</literal>. See
<link xlink:href="https://github.com/junegunn/fzf/wiki/Color-schemes"/>
description = lib.mdDoc ''
Color scheme options added to `FZF_DEFAULT_OPTS`. See
<https://github.com/junegunn/fzf/wiki/Color-schemes>
for documentation.
'';
};
tmux = {
enableShellIntegration = mkEnableOption ''
setting <literal>FZF_TMUX=1</literal> which causes shell integration to use fzf-tmux
'';
enableShellIntegration = mkEnableOption (lib.mdDoc ''
setting `FZF_TMUX=1` which causes shell integration to use fzf-tmux
'');
shellIntegrationOptions = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''[ "-d 40%" ]'';
description = ''
If <option>programs.fzf.tmux.enableShellIntegration</option> is set to <literal>true</literal>,
description = lib.mdDoc ''
If {option}`programs.fzf.tmux.enableShellIntegration` is set to `true`,
shell integration will use these options for fzf-tmux.
See <command>fzf-tmux --help</command> for available options.
See {command}`fzf-tmux --help` for available options.
'';
};
};
@ -130,7 +130,7 @@ in {
enableBashIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Bash integration.
'';
};
@ -138,7 +138,7 @@ in {
enableZshIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Zsh integration.
'';
};
@ -146,7 +146,7 @@ in {
enableFishIntegration = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable Fish integration.
'';
};

8
modules/programs/gallery-dl.nix
View file

@ -12,7 +12,7 @@ in {
meta.maintainers = [ ];
options.programs.gallery-dl = {
enable = mkEnableOption "gallery-dl";
enable = mkEnableOption (lib.mdDoc "gallery-dl");
settings = mkOption {
type = jsonFormat.type;
@ -22,10 +22,10 @@ in {
extractor.base-directory = "~/Downloads";
}
'';
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/gallery-dl/config.json</filename>. See
<link xlink:href="https://github.com/mikf/gallery-dl#configuration"/>
{file}`$XDG_CONFIG_HOME/gallery-dl/config.json`. See
<https://github.com/mikf/gallery-dl#configuration>
for supported values.
'';
};

21
modules/programs/getmail-accounts.nix
View file

@ -4,13 +4,14 @@ with lib;
{
options.getmail = {
enable = mkEnableOption "the getmail mail retriever for this account";
enable =
mkEnableOption (lib.mdDoc "the getmail mail retriever for this account");
destinationCommand = mkOption {
type = types.nullOr types.str;
default = null;
example = "\${pkgs.maildrop}/bin/maildrop";
description = ''
description = lib.mdDoc ''
Specify a command delivering the incoming mail to your maildir.
'';
};
@ -19,29 +20,29 @@ with lib;
type = types.nonEmptyListOf types.str;
default = [ ];
example = [ "INBOX" "INBOX.spam" ];
description = ''
description = lib.mdDoc ''
A non-empty list of mailboxes. To download all mail you can
use the <literal>ALL</literal> mailbox.
use the `ALL` mailbox.
'';
};
delete = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Enable if you want to delete read messages from the server. Most
users should either enable <literal>delete</literal> or disable
<literal>readAll</literal>.
users should either enable `delete` or disable
`readAll`.
'';
};
readAll = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Enable if you want to fetch all, even the read messages from the
server. Most users should either enable <literal>delete</literal> or
disable <literal>readAll</literal>.
server. Most users should either enable `delete` or
disable `readAll`.
'';
};

21
modules/programs/gh.nix
View file

@ -21,14 +21,14 @@ let
pv = "pr view";
}
'';
description = ''
description = lib.mdDoc ''
Aliases that allow you to create nicknames for gh commands.
'';
};
editor = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
The editor that gh should run when creating issues, pull requests, etc.
If blank, will refer to environment.
'';
@ -37,7 +37,7 @@ let
type = types.str;
default = "https";
example = "ssh";
description = ''
description = lib.mdDoc ''
The protocol to use when performing Git operations.
'';
};
@ -63,20 +63,20 @@ in {
];
options.programs.gh = {
enable = mkEnableOption "GitHub CLI tool";
enable = mkEnableOption (lib.mdDoc "GitHub CLI tool");
package = mkOption {
type = types.package;
default = pkgs.gh;
defaultText = literalExpression "pkgs.gh";
description = "Package providing <command>gh</command>.";
description = lib.mdDoc "Package providing {command}`gh`.";
};
settings = mkOption {
type = settingsType;
default = { };
description =
"Configuration written to <filename>$XDG_CONFIG_HOME/gh/config.yml</filename>.";
description = lib.mdDoc
"Configuration written to {file}`$XDG_CONFIG_HOME/gh/config.yml`.";
example = literalExpression ''
{
git_protocol = "ssh";
@ -92,15 +92,16 @@ in {
};
enableGitCredentialHelper =
mkEnableOption "the gh git credential helper for github.com" // {
mkEnableOption (lib.mdDoc "the gh git credential helper for github.com")
// {
default = true;
};
extensions = mkOption {
type = types.listOf types.package;
default = [ ];
description = ''
gh extensions, see <link xlink:href="https://cli.github.com/manual/gh_extension"/>.
description = lib.mdDoc ''
gh extensions, see <https://cli.github.com/manual/gh_extension>.
'';
example = literalExpression "[ pkgs.gh-eco ]";
};

8
modules/programs/git-cliff.nix
View file

@ -11,7 +11,7 @@ in {
meta.maintainers = [ hm.maintainers.NateCox ];
options.programs.git-cliff = {
enable = mkEnableOption "git-cliff changelog generator";
enable = mkEnableOption (lib.mdDoc "git-cliff changelog generator");
package = mkPackageOptionMD pkgs "git-cliff" { };
@ -24,10 +24,10 @@ in {
trim = true;
}
'';
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/git-cliff/cliff.toml</filename>. See
<link xlink:href="https://git-cliff.org/docs/configuration" />
{file}`$XDG_CONFIG_HOME/git-cliff/cliff.toml`. See
<https://git-cliff.org/docs/configuration>
for the documentation.
'';
};

3
modules/programs/git-credential-oauth.nix
View file

@ -9,7 +9,8 @@ in {
options = {
programs.git-credential-oauth = {
enable = lib.mkEnableOption "Git authentication handler for OAuth";
enable =
lib.mkEnableOption (lib.mdDoc "Git authentication handler for OAuth");
package = lib.mkPackageOptionMD pkgs "git-credential-oauth" { };
};

91
modules/programs/git.nix
View file

@ -62,10 +62,10 @@ let
options = {
key = mkOption {
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The default GPG signing key fingerprint.
</para><para>
Set to <literal>null</literal> to let GnuPG decide what signing key
Set to `null` to let GnuPG decide what signing key
to use depending on commit’s author.
'';
};
@ -73,14 +73,15 @@ let
signByDefault = mkOption {
type = types.bool;
default = false;
description = "Whether commits and tags should be signed by default.";
description =
lib.mdDoc "Whether commits and tags should be signed by default.";
};
gpgPath = mkOption {
type = types.str;
default = "${pkgs.gnupg}/bin/gpg2";
defaultText = "\${pkgs.gnupg}/bin/gpg2";
description = "Path to GnuPG binary to use.";
description = lib.mdDoc "Path to GnuPG binary to use.";
};
};
};
@ -90,19 +91,16 @@ let
condition = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Include this configuration only when <varname>condition</varname>
description = lib.mdDoc ''
Include this configuration only when {var}`condition`
matches. Allowed conditions are described in
<citerefentry>
<refentrytitle>git-config</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
{manpage}`git-config(1)`.
'';
};
path = mkOption {
type = with types; either str path;
description = "Path of the configuration file to include.";
description = lib.mdDoc "Path of the configuration file to include.";
};
contents = mkOption {
@ -120,21 +118,18 @@ let
};
};
'';
description = ''
description = lib.mdDoc ''
Configuration to include. If empty then a path must be given.
This follows the configuration structure as described in
<citerefentry>
<refentrytitle>git-config</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
{manpage}`git-config(1)`.
'';
};
contentSuffix = mkOption {
type = types.str;
default = "gitconfig";
description = ''
description = lib.mdDoc ''
Nix store name for the git configuration text file,
when generating the configuration text from nix options.
'';
@ -151,41 +146,42 @@ in {
options = {
programs.git = {
enable = mkEnableOption "Git";
enable = mkEnableOption (lib.mdDoc "Git");
package = mkOption {
type = types.package;
default = pkgs.git;
defaultText = literalExpression "pkgs.git";
description = ''
Git package to install. Use <varname>pkgs.gitAndTools.gitFull</varname>
to gain access to <command>git send-email</command> for instance.
description = lib.mdDoc ''
Git package to install. Use {var}`pkgs.gitAndTools.gitFull`
to gain access to {command}`git send-email` for instance.
'';
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = "Default user name to use.";
description = lib.mdDoc "Default user name to use.";
};
userEmail = mkOption {
type = types.nullOr types.str;
default = null;
description = "Default user email to use.";
description = lib.mdDoc "Default user email to use.";
};
aliases = mkOption {
type = types.attrsOf types.str;
default = { };
example = { co = "checkout"; };
description = "Git aliases to define.";
description = lib.mdDoc "Git aliases to define.";
};
signing = mkOption {
type = types.nullOr signModule;
default = null;
description = "Options related to signing commits using GnuPG.";
description =
lib.mdDoc "Options related to signing commits using GnuPG.";
};
extraConfig = mkOption {
@ -195,7 +191,7 @@ in {
core = { whitespace = "trailing-space,space-before-tab"; };
url."ssh://git@host".insteadOf = "otherhost";
};
description = ''
description = lib.mdDoc ''
Additional configuration to add. The use of string values is
deprecated and will be removed in the future.
'';
@ -209,9 +205,9 @@ in {
pre-commit = ./pre-commit-script;
}
'';
description = ''
description = lib.mdDoc ''
Configuration helper for Git hooks.
See <link xlink:href="https://git-scm.com/docs/githooks" />
See <https://git-scm.com/docs/githooks>
for reference.
'';
};
@ -225,14 +221,15 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "*~" "*.swp" ];
description = "List of paths that should be globally ignored.";
description =
lib.mdDoc "List of paths that should be globally ignored.";
};
attributes = mkOption {
type = types.listOf types.str;
default = [ ];
example = [ "*.pdf diff=pdf" ];
description = "List of defining attributes set globally.";
description = lib.mdDoc "List of defining attributes set globally.";
};
includes = mkOption {
@ -247,18 +244,18 @@ in {
}
]
'';
description = "List of configuration files to include.";
description = lib.mdDoc "List of configuration files to include.";
};
lfs = {
enable = mkEnableOption "Git Large File Storage";
enable = mkEnableOption (lib.mdDoc "Git Large File Storage");
skipSmudge = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Skip automatic downloading of objects on clone or pull.
This requires a manual <command>git lfs pull</command>
This requires a manual {command}`git lfs pull`
every time a new commit is checked out on your repository.
'';
};
@ -276,7 +273,7 @@ in {
type = types.enum [ "light" "dark" ];
default = "light";
example = "dark";
description = ''
description = lib.mdDoc ''
Determines whether difftastic should use the lighter or darker colors
for syntax highlighting.
'';
@ -286,7 +283,7 @@ in {
type = types.enum [ "always" "auto" "never" ];
default = "auto";
example = "always";
description = ''
description = lib.mdDoc ''
Determines when difftastic should color its output.
'';
};
@ -296,7 +293,7 @@ in {
types.enum [ "side-by-side" "side-by-side-show-both" "inline" ];
default = "side-by-side";
example = "inline";
description = ''
description = lib.mdDoc ''
Determines how the output displays - in one column or two columns.
'';
};
@ -328,7 +325,7 @@ in {
file-decoration-style = "none";
};
};
description = ''
description = lib.mdDoc ''
Options to configure delta.
'';
};
@ -345,8 +342,8 @@ in {
pagerOpts = mkOption {
type = types.listOf types.str;
default = [ "--tabs=4" "-RFX" ];
description = ''
Arguments to be passed to <command>less</command>.
description = lib.mdDoc ''
Arguments to be passed to {command}`less`.
'';
};
@ -354,7 +351,7 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
description = lib.mdDoc ''
Whether the first block of an empty line should be colored.
'';
};
@ -363,7 +360,7 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
description = lib.mdDoc ''
Simplify git header chunks to a more human readable format.
'';
};
@ -372,8 +369,8 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
Whether the <literal>+</literal> or <literal>-</literal> at
description = lib.mdDoc ''
Whether the `+` or `-` at
line-start should be removed.
'';
};
@ -382,7 +379,7 @@ in {
type = types.bool;
default = true;
example = false;
description = ''
description = lib.mdDoc ''
By default, the separator for the file header uses Unicode
line-drawing characters. If this is causing output errors on
your terminal, set this to false to use ASCII characters instead.
@ -393,7 +390,7 @@ in {
type = types.nullOr types.int;
default = null;
example = false;
description = ''
description = lib.mdDoc ''
By default, the separator for the file header spans the full
width of the terminal. Use this setting to set the width of
the file header manually.

14
modules/programs/gitui.nix
View file

@ -10,14 +10,14 @@ in {
meta.maintainers = [ hm.maintainers.mifom ];
options.programs.gitui = {
enable =
mkEnableOption "gitui, blazing fast terminal-ui for git written in rust";
enable = mkEnableOption
(lib.mdDoc "gitui, blazing fast terminal-ui for git written in rust");
package = mkOption {
type = types.package;
default = pkgs.gitui;
defaultText = "pkgs.gitui";
description = "The package to use.";
description = lib.mdDoc "The package to use.";
};
keyConfig = mkOption {
@ -28,9 +28,9 @@ in {
quit: Some(( code: Char('q'), modifiers: ( bits: 0,),)),
exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)),
'';
description = ''
description = lib.mdDoc ''
Key config in Ron file format. This is written to
<filename>$XDG_CONFIG_HOME/gitui/key_config.ron</filename>.
{file}`$XDG_CONFIG_HOME/gitui/key_config.ron`.
'';
};
@ -61,9 +61,9 @@ in {
branch_fg: LightYellow,
)
'';
description = ''
description = lib.mdDoc ''
Theme in Ron file format. This is written to
<filename>$XDG_CONFIG_HOME/gitui/theme.ron</filename>.
{file}`$XDG_CONFIG_HOME/gitui/theme.ron`.
'';
};
};

59
modules/programs/gnome-terminal.nix
View file

@ -18,12 +18,12 @@ let
options = {
foreground = mkOption {
type = types.str;
description = "The foreground color.";
description = lib.mdDoc "The foreground color.";
};
background = mkOption {
type = types.str;
description = "The background color.";
description = lib.mdDoc "The background color.";
};
};
});
@ -32,35 +32,37 @@ let
options = {
foregroundColor = mkOption {
type = types.str;
description = "The foreground color.";
description = lib.mdDoc "The foreground color.";
};
backgroundColor = mkOption {
type = types.str;
description = "The background color.";
description = lib.mdDoc "The background color.";
};
boldColor = mkOption {
default = null;
type = types.nullOr types.str;
description = "The bold color, null to use same as foreground.";
description =
lib.mdDoc "The bold color, null to use same as foreground.";
};
palette = mkOption {
type = types.listOf types.str;
description = "The terminal palette.";
description = lib.mdDoc "The terminal palette.";
};
cursor = mkOption {
default = null;
type = types.nullOr backForeSubModule;
description = "The color for the terminal cursor.";
description = lib.mdDoc "The color for the terminal cursor.";
};
highlight = mkOption {
default = null;
type = types.nullOr backForeSubModule;
description = "The colors for the terminal’s highlighted area.";
description =
lib.mdDoc "The colors for the terminal’s highlighted area.";
};
};
});
@ -70,43 +72,44 @@ let
default = mkOption {
default = false;
type = types.bool;
description = "Whether this should be the default profile.";
description = lib.mdDoc "Whether this should be the default profile.";
};
visibleName = mkOption {
type = types.str;
description = "The profile name.";
description = lib.mdDoc "The profile name.";
};
colors = mkOption {
default = null;
type = types.nullOr profileColorsSubModule;
description = "The terminal colors, null to use system default.";
description =
lib.mdDoc "The terminal colors, null to use system default.";
};
cursorBlinkMode = mkOption {
default = "system";
type = types.enum [ "system" "on" "off" ];
description = "The cursor blink mode.";
description = lib.mdDoc "The cursor blink mode.";
};
cursorShape = mkOption {
default = "block";
type = types.enum [ "block" "ibeam" "underline" ];
description = "The cursor shape.";
description = lib.mdDoc "The cursor shape.";
};
font = mkOption {
default = null;
type = types.nullOr types.str;
description = "The font name, null to use system default.";
description = lib.mdDoc "The font name, null to use system default.";
};
allowBold = mkOption {
default = null;
type = types.nullOr types.bool;
description = ''
If <literal>true</literal>, allow applications in the
description = lib.mdDoc ''
If `true`, allow applications in the
terminal to make text boldface.
'';
};
@ -114,19 +117,19 @@ let
scrollOnOutput = mkOption {
default = true;
type = types.bool;
description = "Whether to scroll when output is written.";
description = lib.mdDoc "Whether to scroll when output is written.";
};
showScrollbar = mkOption {
default = true;
type = types.bool;
description = "Whether the scroll bar should be visible.";
description = lib.mdDoc "Whether the scroll bar should be visible.";
};
scrollbackLines = mkOption {
default = 10000;
type = types.nullOr types.int;
description = ''
description = lib.mdDoc ''
The number of scrollback lines to keep, null for infinite.
'';
};
@ -134,7 +137,7 @@ let
customCommand = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
The command to use to start the shell, or null for default shell.
'';
};
@ -142,7 +145,7 @@ let
loginShell = mkOption {
default = false;
type = types.bool;
description = "Run command as a login shell.";
description = lib.mdDoc "Run command as a login shell.";
};
backspaceBinding = mkOption {
@ -172,7 +175,7 @@ let
boldIsBright = mkOption {
default = null;
type = types.nullOr types.bool;
description = "Whether bold text is shown in bright colors.";
description = lib.mdDoc "Whether bold text is shown in bright colors.";
};
deleteBinding = mkOption {
@ -202,13 +205,13 @@ let
audibleBell = mkOption {
default = true;
type = types.bool;
description = "Turn on/off the terminal's bell.";
description = lib.mdDoc "Turn on/off the terminal's bell.";
};
transparencyPercent = mkOption {
default = null;
type = types.nullOr (types.ints.between 0 100);
description = "Background transparency in percent.";
description = lib.mdDoc "Background transparency in percent.";
};
};
});
@ -275,24 +278,24 @@ in {
options = {
programs.gnome-terminal = {
enable = mkEnableOption "Gnome Terminal";
enable = mkEnableOption (lib.mdDoc "Gnome Terminal");
showMenubar = mkOption {
default = true;
type = types.bool;
description = "Whether to show the menubar by default";
description = lib.mdDoc "Whether to show the menubar by default";
};
themeVariant = mkOption {
default = "default";
type = types.enum [ "default" "light" "dark" "system" ];
description = "The theme variation to request";
description = lib.mdDoc "The theme variation to request";
};
profile = mkOption {
default = { };
type = types.attrsOf profileSubModule;
description = "A set of Gnome Terminal profiles.";
description = lib.mdDoc "A set of Gnome Terminal profiles.";
};
};
};

24
modules/programs/go.nix
View file

@ -11,13 +11,13 @@ in {
options = {
programs.go = {
enable = mkEnableOption "Go";
enable = mkEnableOption (lib.mdDoc "Go");
package = mkOption {
type = types.package;
default = pkgs.go;
defaultText = literalExpression "pkgs.go";
description = "The Go package to use.";
description = lib.mdDoc "The Go package to use.";
};
packages = mkOption {
@ -29,16 +29,16 @@ in {
"golang.org/x/time" = builtins.fetchGit "https://go.googlesource.com/time";
}
'';
description = "Packages to add to GOPATH.";
description = lib.mdDoc "Packages to add to GOPATH.";
};
goPath = mkOption {
type = with types; nullOr str;
default = null;
example = "go";
description = ''
Primary <envar>GOPATH</envar> relative to
<envar>HOME</envar>. It will be exported first and therefore
description = lib.mdDoc ''
Primary {env}`GOPATH` relative to
{env}`HOME`. It will be exported first and therefore
used by default by the Go tooling.
'';
};
@ -47,9 +47,9 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "extraGoPath1" "extraGoPath2" ];
description = ''
Extra <envar>GOPATH</envar>s relative to <envar>HOME</envar> appended
after <xref linkend="opt-programs.go.goPath"/>, if that option is set.
description = lib.mdDoc ''
Extra {env}`GOPATH`s relative to {env}`HOME` appended
after [](#opt-programs.go.goPath), if that option is set.
'';
};
@ -57,15 +57,15 @@ in {
type = with types; nullOr str;
default = null;
example = ".local/bin.go";
description = "GOBIN relative to HOME";
description = lib.mdDoc "GOBIN relative to HOME";
};
goPrivate = mkOption {
type = with types; listOf str;
default = [ ];
example = [ "*.corp.example.com" "rsc.io/private" ];
description = ''
The <envar>GOPRIVATE</envar> environment variable controls
description = lib.mdDoc ''
The {env}`GOPRIVATE` environment variable controls
which modules the go command considers to be private (not
available publicly) and should therefore not use the proxy
or checksum database.

65
modules/programs/gpg.nix
View file

@ -25,14 +25,14 @@ let
text = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Text of an OpenPGP public key.
'';
};
source = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path of an OpenPGP public key file.
'';
};
@ -139,7 +139,7 @@ let
in {
options.programs.gpg = {
enable = mkEnableOption "GnuPG";
enable = mkEnableOption (lib.mdDoc "GnuPG");
package = mkOption {
type = types.package;
@ -147,7 +147,7 @@ in {
defaultText = literalExpression "pkgs.gnupg";
example = literalExpression "pkgs.gnupg23";
description =
"The Gnupg package to use (also used the gpg-agent service).";
lib.mdDoc "The Gnupg package to use (also used the gpg-agent service).";
};
settings = mkOption {
@ -159,17 +159,13 @@ in {
s2k-cipher-algo = "AES128";
}
'';
description = ''
description = lib.mdDoc ''
GnuPG configuration options. Available options are described
in
<link xlink:href="https://gnupg.org/documentation/manpage.html">
<citerefentry>
<refentrytitle>gpg</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</link>.
</para>
<para>
[
{manpage}`gpg(1)`
](https://gnupg.org/documentation/manpage.html).
Note that lists are converted to duplicate keys.
'';
};
@ -182,15 +178,12 @@ in {
disable-ccid = true;
}
'';
description = ''
description = lib.mdDoc ''
SCdaemon configuration options. Available options are described
in
<link xlink:href="https://www.gnupg.org/documentation/manuals/gnupg/Scdaemon-Options.html">
<citerefentry>
<refentrytitle>scdaemon</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</link>.
[
{manpage}`scdaemon(1)`
](https://www.gnupg.org/documentation/manuals/gnupg/Scdaemon-Options.html).
'';
};
@ -200,19 +193,19 @@ in {
default = "${config.home.homeDirectory}/.gnupg";
defaultText =
literalExpression ''"''${config.home.homeDirectory}/.gnupg"'';
description = "Directory to store keychains and configuration.";
description = lib.mdDoc "Directory to store keychains and configuration.";
};
mutableKeys = mkOption {
type = types.bool;
default = true;
description = ''
If set to <literal>true</literal>, you may manage your keyring as a user
using the <literal>gpg</literal> command. Upon activation, the keyring
description = lib.mdDoc ''
If set to `true`, you may manage your keyring as a user
using the `gpg` command. Upon activation, the keyring
will have managed keys added without overwriting unmanaged keys.
</para><para>
If set to <literal>false</literal>, the path
<filename>$GNUPGHOME/pubring.kbx</filename> will become an immutable
If set to `false`, the path
{file}`$GNUPGHOME/pubring.kbx` will become an immutable
link to the Nix store, denying modifications.
'';
};
@ -220,16 +213,16 @@ in {
mutableTrust = mkOption {
type = types.bool;
default = true;
description = ''
If set to <literal>true</literal>, you may manage trust as a user using
the <command>gpg</command> command. Upon activation, trusted keys have
description = lib.mdDoc ''
If set to `true`, you may manage trust as a user using
the {command}`gpg` command. Upon activation, trusted keys have
their trust set without overwriting unmanaged keys.
</para><para>
If set to <literal>false</literal>, the path
<filename>$GNUPGHOME/trustdb.gpg</filename> will be
<emphasis>overwritten</emphasis> on each activation, removing trust for
If set to `false`, the path
{file}`$GNUPGHOME/trustdb.gpg` will be
*overwritten* on each activation, removing trust for
any unmanaged keys. Be careful to make a backup of your old
<filename>trustdb.gpg</filename> before switching to immutable trust!
{file}`trustdb.gpg` before switching to immutable trust!
'';
};
@ -239,7 +232,7 @@ in {
[ { source = ./pubkeys.txt; } ]
'';
default = [ ];
description = ''
description = lib.mdDoc ''
A list of public keys to be imported into GnuPG. Note, these key files
will be copied into the world-readable Nix store.
'';

7
modules/programs/havoc.nix
View file

@ -11,17 +11,16 @@ in {
meta.maintainers = with lib.maintainers; [ AndersonTorres ];
options.programs.havoc = {
enable = mkEnableOption "Havoc terminal";
enable = mkEnableOption (lib.mdDoc "Havoc terminal");
package = mkPackageOptionMD pkgs "havoc" { };
settings = mkOption {
type = iniFormat.type;
default = { };
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/havoc.cfg</filename>. See <link
xlink:href="https://raw.githubusercontent.com/ii8/havoc/master/havoc.cfg"/>
{file}`$XDG_CONFIG_HOME/havoc.cfg`. See <https://raw.githubusercontent.com/ii8/havoc/master/havoc.cfg>
for a list of available options.
'';
example = literalExpression ''

34
modules/programs/helix.nix
View file

@ -9,21 +9,21 @@ in {
meta.maintainers = [ hm.maintainers.Philipp-M ];
options.programs.helix = {
enable = mkEnableOption "helix text editor";
enable = mkEnableOption (lib.mdDoc "helix text editor");
package = mkOption {
type = types.package;
default = pkgs.helix;
defaultText = literalExpression "pkgs.helix";
description = "The package to use for helix.";
description = lib.mdDoc "The package to use for helix.";
};
defaultEditor = mkOption {
type = types.bool;
default = false;
description = ''
Whether to configure <command>hx</command> as the default
editor using the <envar>EDITOR</envar> environment variable.
description = lib.mdDoc ''
Whether to configure {command}`hx` as the default
editor using the {env}`EDITOR` environment variable.
'';
};
@ -45,11 +45,11 @@ in {
};
}
'';
description = ''
description = lib.mdDoc ''
Configuration written to
<filename>$XDG_CONFIG_HOME/helix/config.toml</filename>.
</para><para>
See <link xlink:href="https://docs.helix-editor.com/configuration.html" />
{file}`$XDG_CONFIG_HOME/helix/config.toml`.
See <https://docs.helix-editor.com/configuration.html>
for the full list of options.
'';
};
@ -80,11 +80,11 @@ in {
}];
}
'';
description = ''
description = lib.mdDoc ''
Language specific configuration at
<filename>$XDG_CONFIG_HOME/helix/languages.toml</filename>.
</para><para>
See <link xlink:href="https://docs.helix-editor.com/languages.html" />
{file}`$XDG_CONFIG_HOME/helix/languages.toml`.
See <https://docs.helix-editor.com/languages.html>
for more information.
'';
};
@ -149,12 +149,12 @@ in {
};
}
'';
description = ''
description = lib.mdDoc ''
Each theme is written to
<filename>$XDG_CONFIG_HOME/helix/themes/theme-name.toml</filename>.
{file}`$XDG_CONFIG_HOME/helix/themes/theme-name.toml`.
Where the name of each attribute is the theme-name (in the example "base16").
</para><para>
See <link xlink:href="https://docs.helix-editor.com/themes.html" />
See <https://docs.helix-editor.com/themes.html>
for the full list of options.
'';
};

54
modules/programs/hexchat.nix
View file

@ -11,37 +11,37 @@ let
autoconnect = mkOption {
type = nullOr bool;
default = false;
description = "Autoconnect to network.";
description = lib.mdDoc "Autoconnect to network.";
};
connectToSelectedServerOnly = mkOption {
type = nullOr bool;
default = true;
description = "Connect to selected server only.";
description = lib.mdDoc "Connect to selected server only.";
};
bypassProxy = mkOption {
type = nullOr bool;
default = true;
description = "Bypass proxy.";
description = lib.mdDoc "Bypass proxy.";
};
forceSSL = mkOption {
type = nullOr bool;
default = false;
description = "Use SSL for all servers.";
description = lib.mdDoc "Use SSL for all servers.";
};
acceptInvalidSSLCertificates = mkOption {
type = nullOr bool;
default = false;
description = "Accept invalid SSL certificates.";
description = lib.mdDoc "Accept invalid SSL certificates.";
};
useGlobalUserInformation = mkOption {
type = nullOr bool;
default = false;
description = "Use global user information.";
description = lib.mdDoc "Use global user information.";
};
};
};
@ -53,21 +53,23 @@ let
type = listOf str;
default = [ ];
example = [ "#home-manager" "#linux" "#nix" ];
description = "Channels list to autojoin on connecting to server.";
description =
lib.mdDoc "Channels list to autojoin on connecting to server.";
};
charset = mkOption {
type = nullOr str;
default = null;
example = "UTF-8 (Unicode)";
description = "Character set.";
description = lib.mdDoc "Character set.";
};
commands = mkOption {
type = listOf str;
default = [ ];
example = literalExpression ''[ "ECHO Greetings fellow Nixer! ]'';
description = "Commands to be executed on connecting to server.";
description =
lib.mdDoc "Commands to be executed on connecting to server.";
};
loginMethod = mkOption {
@ -108,13 +110,13 @@ let
nickname = mkOption {
type = nullOr str;
default = null;
description = "Primary nickname.";
description = lib.mdDoc "Primary nickname.";
};
nickname2 = mkOption {
type = nullOr str;
default = null;
description = "Secondary nickname.";
description = lib.mdDoc "Secondary nickname.";
};
options = mkOption {
@ -124,13 +126,13 @@ let
autoconnect = true;
useGlobalUserInformation = true;
};
description = "Channel options.";
description = lib.mdDoc "Channel options.";
};
password = mkOption {
type = nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Password to use. Note this password will be readable by all user's
in the Nix store.
'';
@ -139,17 +141,17 @@ let
realName = mkOption {
type = nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Real name. Is used to populate the real name field that appears when
someone uses the <literal>WHOIS</literal> command on your nick.
someone uses the `WHOIS` command on your nick.
'';
};
userName = mkOption {
type = nullOr str;
default = null;
description = ''
User name. Part of your <literal>user@host</literal> hostmask that
description = lib.mdDoc ''
User name. Part of your `user@host` hostmask that
appears to other on IRC.
'';
};
@ -158,7 +160,7 @@ let
type = listOf str;
default = [ ];
example = [ "irc.oftc.net" ];
description = "IRC Server Address List.";
description = lib.mdDoc "IRC Server Address List.";
};
};
};
@ -219,7 +221,7 @@ in {
meta.maintainers = with maintainers; [ thiagokokada ];
options.programs.hexchat = with types; {
enable = mkEnableOption "HexChat, a graphical IRC client";
enable = mkEnableOption (lib.mdDoc "HexChat, a graphical IRC client");
channels = mkOption {
type = attrsOf modChannelOption;
@ -254,8 +256,8 @@ in {
userName = "my_username";
};
}'';
description = ''
Configures <filename>$XDG_CONFIG_HOME/hexchat/servlist.conf</filename>.
description = lib.mdDoc ''
Configures {file}`$XDG_CONFIG_HOME/hexchat/servlist.conf`.
'';
};
@ -270,9 +272,9 @@ in {
text_font = "Monospace 14";
};
'';
description = ''
Configuration for <filename>$XDG_CONFIG_HOME/hexchat/hexchat.conf</filename>, see
<link xlink:href="https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings"/>
description = lib.mdDoc ''
Configuration for {file}`$XDG_CONFIG_HOME/hexchat/hexchat.conf`, see
<https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings>
for supported values.
'';
};
@ -307,9 +309,9 @@ in {
stripRoot = false;
};
'';
description = ''
description = lib.mdDoc ''
Theme package for HexChat. Expects a derivation containing decompressed
theme files. Note, <literal>.hct</literal> files are actually ZIP files,
theme files. Note, `.hct` files are actually ZIP files,
as seen in example.
'';
};

32
modules/programs/himalaya.nix
View file

@ -118,21 +118,22 @@ in {
options = {
programs.himalaya = {
enable = lib.mkEnableOption "the Himalaya email client";
enable = lib.mkEnableOption (lib.mdDoc "the Himalaya email client");
package = lib.mkPackageOptionMD pkgs "himalaya" { };
settings = lib.mkOption {
type = lib.types.submodule { freeformType = tomlFormat.type; };
default = { };
description = ''
description = lib.mdDoc ''
Himalaya global configuration.
See <link xlink:href="https://pimalaya.org/himalaya/cli/configuration/global.html"/> for supported values.
See <https://pimalaya.org/himalaya/cli/configuration/global.html> for supported values.
'';
};
};
services = {
himalaya-notify = {
enable = lib.mkEnableOption "the Himalaya new emails notifier service";
enable = lib.mkEnableOption
(lib.mdDoc "the Himalaya new emails notifier service");
environment = lib.mkOption {
type = with lib.types; attrsOf str;
@ -142,7 +143,7 @@ in {
"PASSWORD_STORE_DIR" = "~/.password-store";
}
'';
description = ''
description = lib.mdDoc ''
Extra environment variables to be exported in the service.
'';
};
@ -152,7 +153,7 @@ in {
type = with lib.types; nullOr str;
default = null;
example = "gmail";
description = ''
description = lib.mdDoc ''
Name of the account the notifier should be started for. If
no account is given, the default one is used.
'';
@ -162,7 +163,7 @@ in {
type = with lib.types; nullOr int;
default = null;
example = "500";
description = ''
description = lib.mdDoc ''
Notifier lifetime of the IDLE session (in seconds).
'';
};
@ -170,8 +171,8 @@ in {
};
himalaya-watch = {
enable =
lib.mkEnableOption "the Himalaya folder changes watcher service";
enable = lib.mkEnableOption
(lib.mdDoc "the Himalaya folder changes watcher service");
environment = lib.mkOption {
type = with lib.types; attrsOf str;
@ -181,7 +182,7 @@ in {
"PASSWORD_STORE_DIR" = "~/.password-store";
}
'';
description = ''
description = lib.mdDoc ''
Extra environment variables to be exported in the service.
'';
};
@ -191,7 +192,7 @@ in {
type = with lib.types; nullOr str;
default = null;
example = "gmail";
description = ''
description = lib.mdDoc ''
Name of the account the watcher should be started for. If
no account is given, the default one is used.
'';
@ -201,7 +202,7 @@ in {
type = with lib.types; nullOr int;
default = null;
example = "500";
description = ''
description = lib.mdDoc ''
Watcher lifetime of the IDLE session (in seconds).
'';
};
@ -212,7 +213,8 @@ in {
accounts.email.accounts = lib.mkOption {
type = lib.types.attrsOf (lib.types.submodule {
options.himalaya = {
enable = lib.mkEnableOption "Himalaya for this email account";
enable =
lib.mkEnableOption (lib.mdDoc "Himalaya for this email account");
# TODO: remove me for the next release
backend = lib.mkOption {
@ -236,9 +238,9 @@ in {
settings = lib.mkOption {
type = lib.types.submodule { freeformType = tomlFormat.type; };
default = { };
description = ''
description = lib.mdDoc ''
Himalaya configuration for this email account.
See <link xlink:href="https://pimalaya.org/himalaya/cli/configuration/account.html"/> for supported values.
See <https://pimalaya.org/himalaya/cli/configuration/account.html> for supported values.
'';
};
};

10
modules/programs/home-manager.nix
View file

@ -11,17 +11,17 @@ in {
options = {
programs.home-manager = {
enable = mkEnableOption "Home Manager";
enable = mkEnableOption (lib.mdDoc "Home Manager");
path = mkOption {
type = types.nullOr types.str;
default = null;
example = "$HOME/devel/home-manager";
description = ''
description = lib.mdDoc ''
The default path to use for Home Manager. When
<literal>null</literal>, then the <filename>home-manager</filename>
channel, <filename>$HOME/.config/nixpkgs/home-manager</filename>, and
<filename>$HOME/.nixpkgs/home-manager</filename> will be attempted.
`null`, then the {file}`home-manager`
channel, {file}`$HOME/.config/nixpkgs/home-manager`, and
{file}`$HOME/.nixpkgs/home-manager` will be attempted.
'';
};
};

8
modules/programs/hstr.nix
View file

@ -10,17 +10,17 @@ in {
meta.maintainers = [ hm.maintainers.Dines97 ];
options.programs.hstr = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
Bash And Zsh shell history suggest box - easily view, navigate, search and
manage your command history'';
manage your command history'');
package = mkPackageOptionMD pkgs "hstr" { };
enableBashIntegration = mkEnableOption "Bash integration" // {
enableBashIntegration = mkEnableOption (lib.mdDoc "Bash integration") // {
default = true;
};
enableZshIntegration = mkEnableOption "Zsh integration" // {
enableZshIntegration = mkEnableOption (lib.mdDoc "Zsh integration") // {
default = true;
};
};

8
modules/programs/htop.nix
View file

@ -110,7 +110,7 @@ in {
meta.maintainers = [ hm.maintainers.bjpbakker ];
options.programs.htop = {
enable = mkEnableOption "htop";
enable = mkEnableOption (lib.mdDoc "htop");
settings = mkOption {
type = types.attrs;
@ -149,9 +149,9 @@ in {
(text "Systemd")
]);
'';
description = ''
description = lib.mdDoc ''
Configuration options to add to
<filename>$XDG_CONFIG_HOME/htop/htoprc</filename>.
{file}`$XDG_CONFIG_HOME/htop/htoprc`.
'';
};
@ -159,7 +159,7 @@ in {
type = types.package;
default = pkgs.htop;
defaultText = literalExpression "pkgs.htop";
description = "Package containing the <command>htop</command> program.";
description = lib.mdDoc "Package containing the {command}`htop` program.";
};
};

6
modules/programs/hyfetch.nix
View file

@ -10,13 +10,13 @@ in {
meta.maintainers = [ maintainers.lilyinstarlight ];
options.programs.hyfetch = {
enable = mkEnableOption "hyfetch";
enable = mkEnableOption (lib.mdDoc "hyfetch");
package = mkOption {
type = types.package;
default = pkgs.hyfetch;
defaultText = literalExpression "pkgs.hyfetch";
description = "The hyfetch package to use.";
description = lib.mdDoc "The hyfetch package to use.";
};
settings = mkOption {
@ -31,7 +31,7 @@ in {
};
}
'';
description = "JSON config for HyFetch";
description = lib.mdDoc "JSON config for HyFetch";
};
};

40
modules/programs/i3status-rust.nix
View file

@ -12,7 +12,8 @@ in {
meta.maintainers = with lib.maintainers; [ farlion thiagokokada ];
options.programs.i3status-rust = {
enable = mkEnableOption "a replacement for i3-status written in Rust";
enable =
mkEnableOption (lib.mdDoc "a replacement for i3-status written in Rust");
bars = mkOption {
type = types.attrsOf (types.submodule {
@ -49,10 +50,10 @@ in {
format = " $timestamp.datetime(f:'%a %d/%m %R') ";
}
];
description = ''
description = lib.mdDoc ''
Configuration blocks to add to i3status-rust
<filename>config</filename>. See
<link xlink:href="https://github.com/greshake/i3status-rust/blob/master/blocks.md"/>
{file}`config`. See
<https://github.com/greshake/i3status-rust/blob/master/blocks.md>
for block options.
'';
example = literalExpression ''
@ -86,9 +87,9 @@ in {
settings = mkOption {
type = settingsFormat.type;
default = { };
description = ''
description = lib.mdDoc ''
Any extra options to add to i3status-rust
<filename>config</filename>.
{file}`config`.
'';
example = literalExpression ''
{
@ -106,9 +107,9 @@ in {
icons = mkOption {
type = types.str;
default = "none";
description = ''
description = lib.mdDoc ''
The icons set to use. See
<link xlink:href="https://github.com/greshake/i3status-rust/blob/master/doc/themes.md"/>
<https://github.com/greshake/i3status-rust/blob/master/doc/themes.md>
for a list of available icon sets.
'';
example = "awesome6";
@ -117,9 +118,9 @@ in {
theme = mkOption {
type = types.str;
default = "plain";
description = ''
description = lib.mdDoc ''
The theme to use. See
<link xlink:href="https://github.com/greshake/i3status-rust/blob/master/doc/themes.md"/>
<https://github.com/greshake/i3status-rust/blob/master/doc/themes.md>
for a list of available themes.
'';
example = "gruvbox-dark";
@ -161,20 +162,17 @@ in {
];
};
};
description = ''
description = lib.mdDoc ''
Attribute set of i3status-rust bars, each with their own configuration.
Each bar <varname>name</varname> generates a config file suffixed with
the bar's <varname>name</varname> from the attribute set, like so:
<filename>config-''${name}.toml</filename>.
</para><para>
Each bar {var}`name` generates a config file suffixed with
the bar's {var}`name` from the attribute set, like so:
{file}`config-''${name}.toml`.
This way, multiple config files can be generated, such as for having a
top and a bottom bar.
</para><para>
See
<citerefentry>
<refentrytitle>i3status-rust</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`i3status-rust(1)`
for options.
'';
example = literalExpression ''
@ -228,7 +226,7 @@ in {
type = types.package;
default = pkgs.i3status-rust;
defaultText = literalExpression "pkgs.i3status-rust";
description = "Package providing i3status-rust";
description = lib.mdDoc "Package providing i3status-rust";
};
};

37
modules/programs/i3status.nix
View file

@ -36,12 +36,12 @@ in {
meta.maintainers = [ hm.maintainers.justinlovinger ];
options.programs.i3status = {
enable = mkEnableOption "i3status";
enable = mkEnableOption (lib.mdDoc "i3status");
enableDefault = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether or not to enable
the default configuration.
'';
@ -50,14 +50,11 @@ in {
general = mkOption {
type = settingsType;
default = { };
description = ''
Configuration to add to i3status <filename>config</filename>
<literal>general</literal> section.
description = lib.mdDoc ''
Configuration to add to i3status {file}`config`
`general` section.
See
<citerefentry>
<refentrytitle>i3status</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
@ -77,26 +74,23 @@ in {
enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether or not to enable this module.
'';
};
position = mkOption {
type = with types; either int float;
description = ''
Position of this module in i3status <literal>order</literal>.
description = lib.mdDoc ''
Position of this module in i3status `order`.
'';
};
settings = mkOption {
type = settingsType;
default = { };
description = ''
description = lib.mdDoc ''
Configuration to add to this i3status module.
See
<citerefentry>
<refentrytitle>i3status</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
@ -110,13 +104,10 @@ in {
};
});
default = { };
description = ''
Modules to add to i3status <filename>config</filename> file.
description = lib.mdDoc ''
Modules to add to i3status {file}`config` file.
See
<citerefentry>
<refentrytitle>i3status</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''

11
modules/programs/imv.nix
View file

@ -13,20 +13,17 @@ in {
meta.maintainers = [ maintainers.christoph-heiss ];
options.programs.imv = {
enable = mkEnableOption
"imv: a command line image viewer intended for use with tiling window managers";
enable = mkEnableOption (lib.mdDoc
"imv: a command line image viewer intended for use with tiling window managers");
package = mkPackageOptionMD pkgs "imv" { };
settings = mkOption {
default = { };
type = with types; attrsOf (attrsOf (oneOf [ bool int str ]));
description = ''
description = lib.mdDoc ''
Configuration options for imv. See
<citerefentry>
<refentrytitle>imv</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
{manpage}`imv(5)`.
'';
example = literalExpression ''
{

Some files were not shown because too many files have changed in this diff Show more