12167 lines
2 MiB
12167 lines
2 MiB
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix A. Configuration Options</title><link rel="stylesheet" type="text/css" href="style.css" /><link rel="stylesheet" type="text/css" href="overrides.css" /><link rel="stylesheet" type="text/css" href="mono-blue.css" /><script src="highlight.pack.js" type="text/javascript"></script><script src="highlight.load.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.2" /><link rel="home" href="index.html" title="Home Manager Manual" /><link rel="up" href="index.html" title="Home Manager Manual" /><link rel="prev" href="index.html" title="Home Manager Manual" /><link rel="next" href="nixos-options.html" title="Appendix B. NixOS Module Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix A. Configuration Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="nixos-options.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-options"></a>Appendix A. Configuration Options</h1></div></div></div><div class="variablelist"><a id="home-manager-options"></a><dl class="variablelist"><dt><span class="term"><a id="opt-_module.args"></a><a class="term" href="options.html#opt-_module.args"><code class="option">_module.args</code></a></span></dt><dd><p>Additional arguments passed to each module in addition to ones
|
||
like <code class="literal">lib</code>, <code class="literal">config</code>,
|
||
and <code class="literal">pkgs</code>, <code class="literal">modulesPath</code>.
|
||
</p><p>
|
||
This option is also available to all submodules. Submodules do not
|
||
inherit args from their parent module, nor do they provide args to
|
||
their parent module or sibling submodules. The sole exception to
|
||
this is the argument <code class="literal">name</code> which is provided by
|
||
parent modules to a submodule and contains the attribute name
|
||
the submodule is bound to, or a unique generated name if it is
|
||
not bound to an attribute.
|
||
</p><p>
|
||
Some arguments are already passed by default, of which the
|
||
following <span class="emphasis"><em>cannot</em></span> be changed with this option:
|
||
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||
<code class="varname">lib</code>: The nixpkgs library.
|
||
</p></li><li class="listitem"><p>
|
||
<code class="varname">config</code>: The results of all options after merging the values from all modules together.
|
||
</p></li><li class="listitem"><p>
|
||
<code class="varname">options</code>: The options declared in all modules.
|
||
</p></li><li class="listitem"><p>
|
||
<code class="varname">specialArgs</code>: The <code class="literal">specialArgs</code> argument passed to <code class="literal">evalModules</code>.
|
||
</p></li><li class="listitem"><p>
|
||
All attributes of <code class="varname">specialArgs</code>
|
||
</p><p>
|
||
Whereas option values can generally depend on other option values
|
||
thanks to laziness, this does not apply to <code class="literal">imports</code>, which
|
||
must be computed statically before anything else.
|
||
</p><p>
|
||
For this reason, callers of the module system can provide <code class="literal">specialArgs</code>
|
||
which are available during import resolution.
|
||
</p><p>
|
||
For NixOS, <code class="literal">specialArgs</code> includes
|
||
<code class="varname">modulesPath</code>, which allows you to import
|
||
extra modules from the nixpkgs package tree without having to
|
||
somehow make the module aware of the location of the
|
||
<code class="literal">nixpkgs</code> or NixOS directories.
|
||
</p><pre class="programlisting">
|
||
{ modulesPath, ... }: {
|
||
imports = [
|
||
(modulesPath + "/profiles/minimal.nix")
|
||
];
|
||
}
|
||
</pre><p>
|
||
</p></li></ul></div><p>
|
||
</p><p>
|
||
For NixOS, the default value for this option includes at least this argument:
|
||
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||
<code class="varname">pkgs</code>: The nixpkgs package set according to
|
||
the <code class="option">nixpkgs.pkgs</code> option.
|
||
</p></li></ul></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> lazy attribute set of raw value</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/lib/modules.nix#blob-path" target="_top">
|
||
<home-manager/lib/modules.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts"></a><a class="term" href="options.html#opt-accounts.email.accounts"><code class="option">accounts.email.accounts</code></a></span></dt><dd><p>List of email accounts.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mu.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mu.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/himalaya.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/himalaya.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/getmail.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.address"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.address"><code class="option">accounts.email.accounts.<name>.address</code></a></span></dt><dd><p>The email address of this account.</p><p><span class="emphasis"><em>Type:</em></span> string matching the pattern .*@.*</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"jane.doe@example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.aliases"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.aliases"><code class="option">accounts.email.accounts.<name>.aliases</code></a></span></dt><dd><p>Alternative email addresses of this account.</p><p><span class="emphasis"><em>Type:</em></span> list of string matching the pattern .*@.*</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"webmaster@example.org" "admin@example.org"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.alot.contactCompletion"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.alot.contactCompletion"><code class="option">accounts.email.accounts.<name>.alot.contactCompletion</code></a></span></dt><dd><p>Contact completion configuration as expected per alot.
|
||
See <a class="link" href="http://alot.readthedocs.io/en/latest/configuration/contacts_completion.html" target="_top">alot's wiki</a> for
|
||
explanation about possible values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
command = "'\${pkgs.notmuch}/bin/notmuch address --format=json --output=recipients date:6M..'"; regexp = '''\[?{"name": "(?P<name>.*)", "address": "(?P<email>.+)", "name-addr": ".*"}[,\]]?'''; shellcommand_external_filtering = "False"; type = "shellcommand";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
type = "shellcommand";
|
||
command = "abook --mutt-query";
|
||
regexp = "'^(?P<email>[^@]+@[^\t]+)\t+(?P<name>[^\t]+)'";
|
||
ignorecase = "True";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.alot.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.alot.extraConfig"><code class="option">accounts.email.accounts.<name>.alot.extraConfig</code></a></span></dt><dd><p>Extra settings to add to this Alot account configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.alot.sendMailCommand"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.alot.sendMailCommand"><code class="option">accounts.email.accounts.<name>.alot.sendMailCommand</code></a></span></dt><dd><p>Command to send a mail. If msmtp is enabled for the account,
|
||
then this is set to
|
||
<span class="command"><strong>msmtpq --read-envelope-from --read-recipients</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.astroid.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.astroid.enable"><code class="option">accounts.email.accounts.<name>.astroid.enable</code></a></span></dt><dd><p>Whether to enable Astroid.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.astroid.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.astroid.extraConfig"><code class="option">accounts.email.accounts.<name>.astroid.extraConfig</code></a></span></dt><dd><p>Extra settings to add to this astroid account configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
select_query = "";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.astroid.sendMailCommand"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.astroid.sendMailCommand"><code class="option">accounts.email.accounts.<name>.astroid.sendMailCommand</code></a></span></dt><dd><p>Command to send a mail. If msmtp is enabled for the account,
|
||
then this is set to
|
||
<span class="command"><strong>msmtpq --read-envelope-from --read-recipients</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.flavor"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.flavor"><code class="option">accounts.email.accounts.<name>.flavor</code></a></span></dt><dd><p>Some email providers have peculiar behavior that require
|
||
special treatment. This option is therefore intended to
|
||
indicate the nature of the provider.
|
||
</p><p>
|
||
When this indicates a specific provider then, for example,
|
||
the IMAP and SMTP server configuration may be set
|
||
automatically.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "plain", "gmail.com", "runbox.com", "fastmail.com"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"plain"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.folders"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.folders"><code class="option">accounts.email.accounts.<name>.folders</code></a></span></dt><dd><p>Standard email folders.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.folders.drafts"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.folders.drafts"><code class="option">accounts.email.accounts.<name>.folders.drafts</code></a></span></dt><dd><p>Relative path of the drafts mail folder.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Drafts"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.folders.inbox"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.folders.inbox"><code class="option">accounts.email.accounts.<name>.folders.inbox</code></a></span></dt><dd><p>Relative path of the inbox mail.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Inbox"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.folders.sent"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.folders.sent"><code class="option">accounts.email.accounts.<name>.folders.sent</code></a></span></dt><dd><p>Relative path of the sent mail folder.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Sent"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.folders.trash"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.folders.trash"><code class="option">accounts.email.accounts.<name>.folders.trash</code></a></span></dt><dd><p>Relative path of the deleted mail folder.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Trash"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.getmail.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.getmail.enable"><code class="option">accounts.email.accounts.<name>.getmail.enable</code></a></span></dt><dd><p>Whether to enable the getmail mail retriever for this account.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.getmail.delete"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.getmail.delete"><code class="option">accounts.email.accounts.<name>.getmail.delete</code></a></span></dt><dd><p>Enable if you want to delete read messages from the server. Most
|
||
users should either enable <code class="literal">delete</code> or disable
|
||
<code class="literal">readAll</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.getmail.destinationCommand"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.getmail.destinationCommand"><code class="option">accounts.email.accounts.<name>.getmail.destinationCommand</code></a></span></dt><dd><p>Specify a command delivering the incoming mail to your maildir.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.maildrop}/bin/maildrop"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.getmail.mailboxes"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.getmail.mailboxes"><code class="option">accounts.email.accounts.<name>.getmail.mailboxes</code></a></span></dt><dd><p>A non-empty list of mailboxes. To download all mail you can
|
||
use the <code class="literal">ALL</code> mailbox.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> non-empty list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"INBOX" "INBOX.spam"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.getmail.readAll"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.getmail.readAll"><code class="option">accounts.email.accounts.<name>.getmail.readAll</code></a></span></dt><dd><p>Enable if you want to fetch all, even the read messages from the
|
||
server. Most users should either enable <code class="literal">delete</code> or
|
||
disable <code class="literal">readAll</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.gpg"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.gpg"><code class="option">accounts.email.accounts.<name>.gpg</code></a></span></dt><dd><p>GPG configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.gpg.encryptByDefault"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.gpg.encryptByDefault"><code class="option">accounts.email.accounts.<name>.gpg.encryptByDefault</code></a></span></dt><dd><p>Encrypt outgoing messages by default.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.gpg.key"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.gpg.key"><code class="option">accounts.email.accounts.<name>.gpg.key</code></a></span></dt><dd><p>The key to use as listed in <span class="command"><strong>gpg --list-keys</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.gpg.signByDefault"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.gpg.signByDefault"><code class="option">accounts.email.accounts.<name>.gpg.signByDefault</code></a></span></dt><dd><p>Sign messages by default.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.himalaya.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.himalaya.enable"><code class="option">accounts.email.accounts.<name>.himalaya.enable</code></a></span></dt><dd><p>Whether to enable the himalaya mail client for this account
|
||
.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/himalaya.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/himalaya.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.himalaya.settings"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.himalaya.settings"><code class="option">accounts.email.accounts.<name>.himalaya.settings</code></a></span></dt><dd><p>Extra settings to add to this <span class="command"><strong>himalaya</strong></span>
|
||
account configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
default-page-size = 50;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/himalaya.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/himalaya.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap"><code class="option">accounts.email.accounts.<name>.imap</code></a></span></dt><dd><p>The IMAP configuration to use for this account.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap.host"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap.host"><code class="option">accounts.email.accounts.<name>.imap.host</code></a></span></dt><dd><p>Hostname of IMAP server.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"imap.example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap.port"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap.port"><code class="option">accounts.email.accounts.<name>.imap.port</code></a></span></dt><dd><p>The port on which the IMAP server listens. If
|
||
<code class="literal">null</code> then the default port is used.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">993</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap.tls"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap.tls"><code class="option">accounts.email.accounts.<name>.imap.tls</code></a></span></dt><dd><p>Configuration for secure connections.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap.tls.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap.tls.enable"><code class="option">accounts.email.accounts.<name>.imap.tls.enable</code></a></span></dt><dd><p>Whether to enable TLS/SSL.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap.tls.certificatesFile"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap.tls.certificatesFile"><code class="option">accounts.email.accounts.<name>.imap.tls.certificatesFile</code></a></span></dt><dd><p>Path to file containing certificate authorities that should
|
||
be used to validate the connection authenticity. If
|
||
<code class="literal">null</code> then the system default is used.
|
||
Note, if set then the system default may still be accepted.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"config.accounts.email.certificatesFile"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imap.tls.useStartTls"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imap.tls.useStartTls"><code class="option">accounts.email.accounts.<name>.imap.tls.useStartTls</code></a></span></dt><dd><p>Whether to use STARTTLS.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imapnotify.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imapnotify.enable"><code class="option">accounts.email.accounts.<name>.imapnotify.enable</code></a></span></dt><dd><p>Whether to enable imapnotify.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imapnotify.boxes"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imapnotify.boxes"><code class="option">accounts.email.accounts.<name>.imapnotify.boxes</code></a></span></dt><dd><p>IMAP folders to watch.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"Inbox" "[Gmail]/MyLabel"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imapnotify.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imapnotify.extraConfig"><code class="option">accounts.email.accounts.<name>.imapnotify.extraConfig</code></a></span></dt><dd><p>Additional configuration to add for this account.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
wait = 10;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imapnotify.onNotify"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imapnotify.onNotify"><code class="option">accounts.email.accounts.<name>.imapnotify.onNotify</code></a></span></dt><dd><p>Shell commands to run on any event.</p><p><span class="emphasis"><em>Type:</em></span> string or attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.isync}/bin/mbsync test-%s"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.imapnotify.onNotifyPost"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.imapnotify.onNotifyPost"><code class="option">accounts.email.accounts.<name>.imapnotify.onNotifyPost</code></a></span></dt><dd><p>Shell commands to run after onNotify event.</p><p><span class="emphasis"><em>Type:</em></span> string or attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
mail = "\${pkgs.notmuch}/bin/notmuch new && \${pkgs.libnotify}/bin/notify-send 'New mail arrived'";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.enable"><code class="option">accounts.email.accounts.<name>.lieer.enable</code></a></span></dt><dd><p>Whether to enable lieer Gmail synchronization for notmuch.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.notmuchSetupWarning"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.notmuchSetupWarning"><code class="option">accounts.email.accounts.<name>.lieer.notmuchSetupWarning</code></a></span></dt><dd><p>Warn if Notmuch is not also enabled for this account.
|
||
</p><p>
|
||
This can safely be disabled if <span class="command"><strong>notmuch init</strong></span>
|
||
has been used to configure this account outside of Home
|
||
Manager.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings"><code class="option">accounts.email.accounts.<name>.lieer.settings</code></a></span></dt><dd><p>Settings which are applied to <code class="filename">.gmailieer.json</code>
|
||
for the account.
|
||
</p><p>
|
||
See the <a class="link" href="https://github.com/gauteh/lieer/" target="_top">lieer manual</a>
|
||
for documentation of settings not explicitly covered by this module.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.drop_non_existing_label"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.drop_non_existing_label"><code class="option">accounts.email.accounts.<name>.lieer.settings.drop_non_existing_label</code></a></span></dt><dd><p>Allow missing labels on the Gmail side to be dropped.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.file_extension"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.file_extension"><code class="option">accounts.email.accounts.<name>.lieer.settings.file_extension</code></a></span></dt><dd><p>Extension to include in local file names, which can be useful
|
||
for indexing with third-party programs.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"mbox"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.ignore_empty_history"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.ignore_empty_history"><code class="option">accounts.email.accounts.<name>.lieer.settings.ignore_empty_history</code></a></span></dt><dd><p>Work around a Gmail API quirk where an empty change history
|
||
is sometimes returned.
|
||
</p><p>
|
||
See this
|
||
<a class="link" href="https://github.com/gauteh/lieer/issues/120" target="_top">GitHub issue</a>
|
||
for more details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.ignore_remote_labels"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.ignore_remote_labels"><code class="option">accounts.email.accounts.<name>.lieer.settings.ignore_remote_labels</code></a></span></dt><dd><p>Set Gmail labels to ignore when syncing from remote labels to
|
||
local tags (before translations).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"CATEGORY_FORUMS" "CATEGORY_PROMOTIONS" "CATEGORY_UPDATES" "CATEGORY_SOCIAL" "CATEGORY_PERSONAL"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.ignore_tags"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.ignore_tags"><code class="option">accounts.email.accounts.<name>.lieer.settings.ignore_tags</code></a></span></dt><dd><p>Set labels to ignore when syncing from local tags to
|
||
remote labels (after translations).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.local_trash_tag"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.local_trash_tag"><code class="option">accounts.email.accounts.<name>.lieer.settings.local_trash_tag</code></a></span></dt><dd><p>Local tag to which the remote Gmail 'TRASH' label is translated.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"trash"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.remove_local_messages"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.remove_local_messages"><code class="option">accounts.email.accounts.<name>.lieer.settings.remove_local_messages</code></a></span></dt><dd><p>Remove local messages that have been deleted on the remote.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.replace_slash_with_dot"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.replace_slash_with_dot"><code class="option">accounts.email.accounts.<name>.lieer.settings.replace_slash_with_dot</code></a></span></dt><dd><p>Replace '/' with '.' in Gmail labels.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.settings.timeout"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.settings.timeout"><code class="option">accounts.email.accounts.<name>.lieer.settings.timeout</code></a></span></dt><dd><p>HTTP timeout in seconds. 0 means forever or system timeout.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">600</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.sync.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.sync.enable"><code class="option">accounts.email.accounts.<name>.lieer.sync.enable</code></a></span></dt><dd><p>Whether to enable lieer synchronization service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.lieer.sync.frequency"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.lieer.sync.frequency"><code class="option">accounts.email.accounts.<name>.lieer.sync.frequency</code></a></span></dt><dd><p>How often to synchronize the account.
|
||
</p><p>
|
||
This value is passed to the systemd timer configuration as the
|
||
onCalendar option. See
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>
|
||
for more information about the format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"*:0/5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.maildir"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.maildir"><code class="option">accounts.email.accounts.<name>.maildir</code></a></span></dt><dd><p>Maildir configuration for this account.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
path = "\${name}";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.maildir.path"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.maildir.path"><code class="option">accounts.email.accounts.<name>.maildir.path</code></a></span></dt><dd><p>Path to maildir directory where mail for this account is
|
||
stored. This is relative to the base maildir path.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.enable"><code class="option">accounts.email.accounts.<name>.mbsync.enable</code></a></span></dt><dd><p>Whether to enable synchronization using mbsync.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.create"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.create"><code class="option">accounts.email.accounts.<name>.mbsync.create</code></a></span></dt><dd><p>Automatically create missing mailboxes within the
|
||
given mail store.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "none", "maildir", "imap", "both"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"maildir"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.expunge"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.expunge"><code class="option">accounts.email.accounts.<name>.mbsync.expunge</code></a></span></dt><dd><p>Permanently remove messages marked for deletion from
|
||
the given mail store.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "none", "maildir", "imap", "both"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"both"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.extraConfig.account"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.extraConfig.account"><code class="option">accounts.email.accounts.<name>.mbsync.extraConfig.account</code></a></span></dt><dd><p>Account section extra configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
PipelineDepth = 10;
|
||
Timeout = 60;
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.extraConfig.channel"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.extraConfig.channel"><code class="option">accounts.email.accounts.<name>.mbsync.extraConfig.channel</code></a></span></dt><dd><p>Per channel extra configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
MaxMessages = 10000;
|
||
MaxSize = "1m";
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.extraConfig.local"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.extraConfig.local"><code class="option">accounts.email.accounts.<name>.mbsync.extraConfig.local</code></a></span></dt><dd><p>Local store extra configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.extraConfig.remote"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.extraConfig.remote"><code class="option">accounts.email.accounts.<name>.mbsync.extraConfig.remote</code></a></span></dt><dd><p>Remote store extra configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.flatten"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.flatten"><code class="option">accounts.email.accounts.<name>.mbsync.flatten</code></a></span></dt><dd><p>If set, flattens the hierarchy within the maildir by
|
||
substituting the canonical hierarchy delimiter
|
||
<code class="literal">/</code> with this value.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"."</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups"><code class="option">accounts.email.accounts.<name>.mbsync.groups</code></a></span></dt><dd><p>Some email providers (Gmail) have a different directory hierarchy for
|
||
synchronized email messages. Namely, when using mbsync without specifying
|
||
a set of channels into a group, all synchronized directories end up beneath
|
||
the <code class="literal">[Gmail]/</code> directory.
|
||
</p><p>
|
||
This option allows you to specify a group, and subsequently channels that
|
||
will allow you to sync your mail into an arbitrary hierarchy.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.channels"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.channels"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.channels</code></a></span></dt><dd><p>List of channels that should be grouped together into this group. When
|
||
performing a synchronization, the groups are synchronized, rather than
|
||
the individual channels.
|
||
</p><p>
|
||
Using these channels and then grouping them together allows for you to
|
||
define the maildir hierarchy as you see fit.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.extraConfig"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to <span class="emphasis"><em>THIS</em></span> channel's
|
||
configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
Create = "both";
|
||
CopyArrivalDate = "yes";
|
||
MaxMessages = 10000;
|
||
MaxSize = "1m";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.farPattern"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.farPattern"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.farPattern</code></a></span></dt><dd><p>IMAP4 patterns for which mailboxes on the remote mail server to sync.
|
||
If <code class="literal">Patterns</code> are specified, <code class="literal">farPattern</code>
|
||
is interpreted as a prefix which is not matched against the patterns,
|
||
and is not affected by mailbox list overrides.
|
||
</p><p>
|
||
If this is left as the default, then mbsync will default to the pattern
|
||
<code class="literal">INBOX</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"[Gmail]/Sent Mail"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.name"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.name"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.name</code></a></span></dt><dd><p>The unique name for THIS channel in THIS group. The group will refer to
|
||
this channel by this name.
|
||
</p><p>
|
||
In addition, you can manually sync just this channel by specifying this
|
||
name to mbsync on the command line.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹name›"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.nearPattern"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.nearPattern"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.nearPattern</code></a></span></dt><dd><p>Name for where mail coming from the remote (far) mail server will end up
|
||
locally. The mailbox specified by the far pattern will be placed in
|
||
this directory.
|
||
</p><p>
|
||
If this is left as the default, then mbsync will default to the pattern
|
||
<code class="literal">INBOX</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Sent"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.patterns"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.channels._name_.patterns"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.patterns</code></a></span></dt><dd><p>Instead of synchronizing <span class="emphasis"><em>just</em></span> the mailboxes that
|
||
match the <code class="literal">farPattern</code>, use it as a prefix which is
|
||
not matched against the patterns, and is not affected by mailbox list
|
||
overrides.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"INBOX"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.groups._name_.name"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.groups._name_.name"><code class="option">accounts.email.accounts.<name>.mbsync.groups.<name>.name</code></a></span></dt><dd><p>The name of this group for this account. These names are different than
|
||
some others, because they will hide channel names that are the same.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹name›"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.patterns"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.patterns"><code class="option">accounts.email.accounts.<name>.mbsync.patterns</code></a></span></dt><dd><p>Pattern of mailboxes to synchronize.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"*"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.remove"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.remove"><code class="option">accounts.email.accounts.<name>.mbsync.remove</code></a></span></dt><dd><p>Propagate mailbox deletions to the given mail store.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "none", "maildir", "imap", "both"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"imap"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mbsync.subFolders"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mbsync.subFolders"><code class="option">accounts.email.accounts.<name>.mbsync.subFolders</code></a></span></dt><dd><p>The on-disk folder naming style. This option has no
|
||
effect when <code class="option">flatten</code> is used.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "Verbatim", "Maildir++", "Legacy"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Verbatim"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Maildir++"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.msmtp.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.msmtp.enable"><code class="option">accounts.email.accounts.<name>.msmtp.enable</code></a></span></dt><dd><p>Whether to enable msmtp.
|
||
</p><p>
|
||
If enabled then it is possible to use the
|
||
<em class="parameter"><code>--account</code></em> command line
|
||
option to send a message for a given account using the
|
||
<span class="command"><strong>msmtp</strong></span> or <span class="command"><strong>msmtpq</strong></span> tool.
|
||
For example, <span class="command"><strong>msmtp --account=private</strong></span> would
|
||
send using the account defined in
|
||
<code class="option">accounts.email.accounts.private</code>. If the
|
||
<em class="parameter"><code>--account</code></em> option is not
|
||
given then the primary account will be used.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.msmtp.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.msmtp.extraConfig"><code class="option">accounts.email.accounts.<name>.msmtp.extraConfig</code></a></span></dt><dd><p>Extra configuration options to add to <code class="filename">~/.msmtprc</code>.
|
||
See <a class="link" href="https://marlam.de/msmtp/msmtprc.txt" target="_top">https://marlam.de/msmtp/msmtprc.txt</a> for
|
||
examples.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
auth = "login";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.msmtp.tls.fingerprint"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.msmtp.tls.fingerprint"><code class="option">accounts.email.accounts.<name>.msmtp.tls.fingerprint</code></a></span></dt><dd><p>Fingerprint of a trusted TLS certificate.
|
||
The fingerprint can be obtained by executing
|
||
<span class="command"><strong>msmtp --serverinfo --tls --tls-certcheck=off</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string matching the pattern ([[:alnum:]]{2}:)+[[:alnum:]]{2}</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"my:SH:a2:56:ha:sh"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.mu.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.mu.enable"><code class="option">accounts.email.accounts.<name>.mu.enable</code></a></span></dt><dd><p>Whether to enable mu indexing.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mu.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mu.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.name"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.name"><code class="option">accounts.email.accounts.<name>.name</code></a></span></dt><dd><p>Unique identifier of the account. This is set to the
|
||
attribute name of the account configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.neomutt.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.neomutt.enable"><code class="option">accounts.email.accounts.<name>.neomutt.enable</code></a></span></dt><dd><p>Whether to enable NeoMutt.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.neomutt.extraConfig"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.neomutt.extraConfig"><code class="option">accounts.email.accounts.<name>.neomutt.extraConfig</code></a></span></dt><dd><p>Extra lines to add to the folder hook for this account.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"color status cyan default"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.neomutt.extraMailboxes"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.neomutt.extraMailboxes"><code class="option">accounts.email.accounts.<name>.neomutt.extraMailboxes</code></a></span></dt><dd><p>List of extra mailboxes</p><p><span class="emphasis"><em>Type:</em></span> list of string or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.neomutt.mailboxName"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.neomutt.mailboxName"><code class="option">accounts.email.accounts.<name>.neomutt.mailboxName</code></a></span></dt><dd><p>Use a different name as mailbox name</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"==== <mailbox-name> ==="</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.neomutt.sendMailCommand"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.neomutt.sendMailCommand"><code class="option">accounts.email.accounts.<name>.neomutt.sendMailCommand</code></a></span></dt><dd><p>Command to send a mail. If not set, neomutt will be in charge of sending mails.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">if config.msmtp.enable then
|
||
"msmtpq --read-envelope-from --read-recipients"
|
||
else
|
||
null
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"msmtpq --read-envelope-from --read-recipients"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.notmuch.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.notmuch.enable"><code class="option">accounts.email.accounts.<name>.notmuch.enable</code></a></span></dt><dd><p>Whether to enable notmuch indexing.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.offlineimap.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.offlineimap.enable"><code class="option">accounts.email.accounts.<name>.offlineimap.enable</code></a></span></dt><dd><p>Whether to enable OfflineIMAP.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.offlineimap.extraConfig.account"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.offlineimap.extraConfig.account"><code class="option">accounts.email.accounts.<name>.offlineimap.extraConfig.account</code></a></span></dt><dd><p>Extra configuration options to add to the account section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
autorefresh = 20;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.offlineimap.extraConfig.local"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.offlineimap.extraConfig.local"><code class="option">accounts.email.accounts.<name>.offlineimap.extraConfig.local</code></a></span></dt><dd><p>Extra configuration options to add to the local account
|
||
section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
sync_deletes = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.offlineimap.extraConfig.remote"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.offlineimap.extraConfig.remote"><code class="option">accounts.email.accounts.<name>.offlineimap.extraConfig.remote</code></a></span></dt><dd><p>Extra configuration options to add to the remote account
|
||
section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
expunge = false; maxconnections = 2;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.offlineimap.postSyncHookCommand"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.offlineimap.postSyncHookCommand"><code class="option">accounts.email.accounts.<name>.offlineimap.postSyncHookCommand</code></a></span></dt><dd><p>Command to run after fetching new mails.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.passwordCommand"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.passwordCommand"><code class="option">accounts.email.accounts.<name>.passwordCommand</code></a></span></dt><dd><p>A command, which when run writes the account password on
|
||
standard output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"secret-tool lookup email me@example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.primary"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.primary"><code class="option">accounts.email.accounts.<name>.primary</code></a></span></dt><dd><p>Whether this is the primary account. Only one account may be
|
||
set as primary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.realName"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.realName"><code class="option">accounts.email.accounts.<name>.realName</code></a></span></dt><dd><p>Name displayed when sending mails.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Jane Doe"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.signature"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.signature"><code class="option">accounts.email.accounts.<name>.signature</code></a></span></dt><dd><p>Signature configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.signature.command"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.signature.command"><code class="option">accounts.email.accounts.<name>.signature.command</code></a></span></dt><dd><p>A command that generates a signature.</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.writeScript "signature" "echo This is my signature"
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.signature.showSignature"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.signature.showSignature"><code class="option">accounts.email.accounts.<name>.signature.showSignature</code></a></span></dt><dd><p>Method to communicate the signature.</p><p><span class="emphasis"><em>Type:</em></span> one of "append", "attach", "none"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.signature.text"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.signature.text"><code class="option">accounts.email.accounts.<name>.signature.text</code></a></span></dt><dd><p>Signature content.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
--
|
||
Luke Skywalker
|
||
May the force be with you.
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp"><code class="option">accounts.email.accounts.<name>.smtp</code></a></span></dt><dd><p>The SMTP configuration to use for this account.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp.host"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp.host"><code class="option">accounts.email.accounts.<name>.smtp.host</code></a></span></dt><dd><p>Hostname of SMTP server.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"smtp.example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp.port"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp.port"><code class="option">accounts.email.accounts.<name>.smtp.port</code></a></span></dt><dd><p>The port on which the SMTP server listens. If
|
||
<code class="literal">null</code> then the default port is used.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">465</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp.tls"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp.tls"><code class="option">accounts.email.accounts.<name>.smtp.tls</code></a></span></dt><dd><p>Configuration for secure connections.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp.tls.enable"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp.tls.enable"><code class="option">accounts.email.accounts.<name>.smtp.tls.enable</code></a></span></dt><dd><p>Whether to enable TLS/SSL.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp.tls.certificatesFile"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp.tls.certificatesFile"><code class="option">accounts.email.accounts.<name>.smtp.tls.certificatesFile</code></a></span></dt><dd><p>Path to file containing certificate authorities that should
|
||
be used to validate the connection authenticity. If
|
||
<code class="literal">null</code> then the system default is used.
|
||
Note, if set then the system default may still be accepted.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"config.accounts.email.certificatesFile"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.smtp.tls.useStartTls"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.smtp.tls.useStartTls"><code class="option">accounts.email.accounts.<name>.smtp.tls.useStartTls</code></a></span></dt><dd><p>Whether to use STARTTLS.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts._name_.userName"></a><a class="term" href="options.html#opt-accounts.email.accounts._name_.userName"><code class="option">accounts.email.accounts.<name>.userName</code></a></span></dt><dd><p>The server username of this account. This will be used as
|
||
the SMTP and IMAP user name.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.certificatesFile"></a><a class="term" href="options.html#opt-accounts.email.certificatesFile"><code class="option">accounts.email.certificatesFile</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"/etc/ssl/certs/ca-certificates.crt"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.maildirBasePath"></a><a class="term" href="options.html#opt-accounts.email.maildirBasePath"><code class="option">accounts.email.maildirBasePath</code></a></span></dt><dd><p>The base directory for account maildir directories. May be a
|
||
relative path, in which case it is relative the home
|
||
directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Maildir"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/accounts/email.nix#blob-path" target="_top">
|
||
<home-manager/modules/accounts/email.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-dconf.settings"></a><a class="term" href="options.html#opt-dconf.settings"><code class="option">dconf.settings</code></a></span></dt><dd><p>Settings to write to the dconf configuration system.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of GVariant value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"org/gnome/calculator" = {
|
||
button-mode = "programming";
|
||
show-thousands = true;
|
||
base = 10;
|
||
word-size = 64;
|
||
window-position = lib.hm.gvariant.mkTuple [100 100];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/dconf.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/dconf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-fonts.fontconfig.enable"></a><a class="term" href="options.html#opt-fonts.fontconfig.enable"><code class="option">fonts.fontconfig.enable</code></a></span></dt><dd><p>Whether to enable fontconfig configuration. This will, for
|
||
example, allow fontconfig to discover fonts and
|
||
configurations installed through
|
||
<code class="varname">home.packages</code> and
|
||
<span class="command"><strong>nix-env</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/fontconfig.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/fontconfig.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.enable"></a><a class="term" href="options.html#opt-gtk.enable"><code class="option">gtk.enable</code></a></span></dt><dd><p>Whether to enable GTK 2/3 configuration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.cursorTheme"></a><a class="term" href="options.html#opt-gtk.cursorTheme"><code class="option">gtk.cursorTheme</code></a></span></dt><dd><p>The cursor theme to use.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.cursorTheme.package"></a><a class="term" href="options.html#opt-gtk.cursorTheme.package"><code class="option">gtk.cursorTheme.package</code></a></span></dt><dd><p>Package providing the cursor theme. This package will be installed
|
||
to your profile. If <code class="literal">null</code> then the theme
|
||
is assumed to already be available in your profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.vanilla-dmz</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.cursorTheme.name"></a><a class="term" href="options.html#opt-gtk.cursorTheme.name"><code class="option">gtk.cursorTheme.name</code></a></span></dt><dd><p>The name of the cursor theme within the package.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Vanilla-DMZ"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.cursorTheme.size"></a><a class="term" href="options.html#opt-gtk.cursorTheme.size"><code class="option">gtk.cursorTheme.size</code></a></span></dt><dd><p>The size of the cursor.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">16</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.font"></a><a class="term" href="options.html#opt-gtk.font"><code class="option">gtk.font</code></a></span></dt><dd><p>The font to use in GTK+ 2/3 applications.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.font.package"></a><a class="term" href="options.html#opt-gtk.font.package"><code class="option">gtk.font.package</code></a></span></dt><dd><p>Package providing the font. This package will be installed
|
||
to your profile. If <code class="literal">null</code> then the font
|
||
is assumed to already be available in your profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.dejavu_fonts</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.font.name"></a><a class="term" href="options.html#opt-gtk.font.name"><code class="option">gtk.font.name</code></a></span></dt><dd><p>The family name of the font within the package.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"DejaVu Sans"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.font.size"></a><a class="term" href="options.html#opt-gtk.font.size"><code class="option">gtk.font.size</code></a></span></dt><dd><p>The size of the font.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.gtk2.configLocation"></a><a class="term" href="options.html#opt-gtk.gtk2.configLocation"><code class="option">gtk.gtk2.configLocation</code></a></span></dt><dd><p>The location to put the GTK configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"${config.home.homeDirectory}/.gtkrc-2.0"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"${config.xdg.configHome}/gtk-2.0/gtkrc"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.gtk2.extraConfig"></a><a class="term" href="options.html#opt-gtk.gtk2.extraConfig"><code class="option">gtk.gtk2.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add verbatim to
|
||
<code class="filename">~/.gtkrc-2.0</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"gtk-can-change-accels = 1"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.gtk3.bookmarks"></a><a class="term" href="options.html#opt-gtk.gtk3.bookmarks"><code class="option">gtk.gtk3.bookmarks</code></a></span></dt><dd><p>Bookmarks in the sidebar of the GTK file browser</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"file:///home/jane/Documents"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.gtk3.extraConfig"></a><a class="term" href="options.html#opt-gtk.gtk3.extraConfig"><code class="option">gtk.gtk3.extraConfig</code></a></span></dt><dd><p>Extra configuration options to add to
|
||
<code class="filename">$XDG_CONFIG_HOME/gtk-3.0/settings.ini</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
gtk-cursor-blink = false; gtk-recent-files-limit = 20;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.gtk3.extraCss"></a><a class="term" href="options.html#opt-gtk.gtk3.extraCss"><code class="option">gtk.gtk3.extraCss</code></a></span></dt><dd><p>Extra configuration lines to add verbatim to
|
||
<code class="filename">$XDG_CONFIG_HOME/gtk-3.0/gtk.css</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.gtk4.extraConfig"></a><a class="term" href="options.html#opt-gtk.gtk4.extraConfig"><code class="option">gtk.gtk4.extraConfig</code></a></span></dt><dd><p>Extra configuration options to add to
|
||
<code class="filename">$XDG_CONFIG_HOME/gtk-4.0/settings.ini</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
gtk-cursor-blink = false; gtk-recent-files-limit = 20;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.iconTheme"></a><a class="term" href="options.html#opt-gtk.iconTheme"><code class="option">gtk.iconTheme</code></a></span></dt><dd><p>The icon theme to use.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.iconTheme.package"></a><a class="term" href="options.html#opt-gtk.iconTheme.package"><code class="option">gtk.iconTheme.package</code></a></span></dt><dd><p>Package providing the icon theme. This package will be installed
|
||
to your profile. If <code class="literal">null</code> then the theme
|
||
is assumed to already be available in your profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.gnome.adwaita-icon-theme</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.iconTheme.name"></a><a class="term" href="options.html#opt-gtk.iconTheme.name"><code class="option">gtk.iconTheme.name</code></a></span></dt><dd><p>The name of the icon theme within the package.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Adwaita"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.theme"></a><a class="term" href="options.html#opt-gtk.theme"><code class="option">gtk.theme</code></a></span></dt><dd><p>The GTK+2/3 theme to use.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.theme.package"></a><a class="term" href="options.html#opt-gtk.theme.package"><code class="option">gtk.theme.package</code></a></span></dt><dd><p>Package providing the theme. This package will be installed
|
||
to your profile. If <code class="literal">null</code> then the theme
|
||
is assumed to already be available in your profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.gnome.gnome-themes-extra</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-gtk.theme.name"></a><a class="term" href="options.html#opt-gtk.theme.name"><code class="option">gtk.theme.name</code></a></span></dt><dd><p>The name of the theme within the package.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Adwaita"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/gtk.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/gtk.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.enableDebugInfo"></a><a class="term" href="options.html#opt-home.enableDebugInfo"><code class="option">home.enableDebugInfo</code></a></span></dt><dd><p>Some Nix-packages provide debug symbols for
|
||
<span class="command"><strong>gdb</strong></span> in the <code class="literal">debug</code>-output.
|
||
This option ensures that those are automatically fetched from
|
||
the binary cache if available and <span class="command"><strong>gdb</strong></span> is
|
||
configured to find those symbols.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/debug.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/debug.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.enableNixpkgsReleaseCheck"></a><a class="term" href="options.html#opt-home.enableNixpkgsReleaseCheck"><code class="option">home.enableNixpkgsReleaseCheck</code></a></span></dt><dd><p>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 than corresponds with your chosen release of
|
||
Nixpkgs.
|
||
</p><p>
|
||
When this option is enabled and a mismatch is detected then a warning
|
||
will be printed when the user configuration is being built.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.packages"></a><a class="term" href="options.html#opt-home.packages"><code class="option">home.packages</code></a></span></dt><dd><p>The set of packages to appear in the user environment.</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.activation"></a><a class="term" href="options.html#opt-home.activation"><code class="option">home.activation</code></a></span></dt><dd><p>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.
|
||
|
||
</p><p>
|
||
|
||
If the script block produces any observable side effect, such
|
||
as writing or deleting files, then it
|
||
<span class="emphasis"><em>must</em></span> be placed after the special
|
||
<code class="literal">writeBoundary</code> 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
|
||
<code class="literal">checkLinkTargets</code> script block checks for
|
||
collisions between non-managed files and files defined in
|
||
<code class="varname"><a class="link" href="options.html#opt-home.file">home.file</a></code>.
|
||
|
||
</p><p>
|
||
|
||
A script block should respect the <code class="varname">DRY_RUN</code>
|
||
variable, if it is set then the actions taken by the script
|
||
should be logged to standard out and not actually performed.
|
||
The variable <code class="varname">DRY_RUN_CMD</code> is set to
|
||
<span class="command"><strong>echo</strong></span> if dry run is enabled.
|
||
|
||
</p><p>
|
||
|
||
A script block should also respect the
|
||
<code class="varname">VERBOSE</code> variable, and if set print
|
||
information on standard out that may be useful for debugging
|
||
any issue that may arise. The variable
|
||
<code class="varname">VERBOSE_ARG</code> is set to
|
||
<code class="option">--verbose</code> if verbose output is enabled.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> DAG of strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] ''
|
||
$DRY_RUN_CMD ln -s $VERBOSE_ARG \
|
||
${builtins.toPath ./link-me-directly} $HOME
|
||
'';
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.extraOutputsToInstall"></a><a class="term" href="options.html#opt-home.extraOutputsToInstall"><code class="option">home.extraOutputsToInstall</code></a></span></dt><dd><p>List of additional package outputs of the packages
|
||
<code class="varname">home.packages</code> that should be installed into
|
||
the user environment.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"doc" "info" "devdoc"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file"></a><a class="term" href="options.html#opt-home.file"><code class="option">home.file</code></a></span></dt><dd><p>Attribute set of files to link into the user home.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.executable"></a><a class="term" href="options.html#opt-home.file._name_.executable"><code class="option">home.file.<name>.executable</code></a></span></dt><dd><p>Set the execute bit. If <code class="literal">null</code>, defaults to the mode
|
||
of the <code class="varname">source</code> file or to <code class="literal">false</code>
|
||
for files created through the <code class="varname">text</code> option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.onChange"></a><a class="term" href="options.html#opt-home.file._name_.onChange"><code class="option">home.file.<name>.onChange</code></a></span></dt><dd><p>Shell commands to run when file has changed between
|
||
generations. The script will be run
|
||
<span class="emphasis"><em>after</em></span> the new files have been linked
|
||
into place.
|
||
</p><p>
|
||
Note, this code is always run when <code class="literal">recursive</code> is
|
||
enabled.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.recursive"></a><a class="term" href="options.html#opt-home.file._name_.recursive"><code class="option">home.file.<name>.recursive</code></a></span></dt><dd><p>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.
|
||
</p><p>
|
||
If <code class="literal">false</code> (the default) then the target
|
||
will be a symbolic link to the source directory. If
|
||
<code class="literal">true</code> 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.source"></a><a class="term" href="options.html#opt-home.file._name_.source"><code class="option">home.file.<name>.source</code></a></span></dt><dd><p>Path of the source file or directory. If
|
||
<a class="link" href="options.html#opt-home.file._name_.text">home.file.<name?>.text</a>
|
||
is non-null then this option will automatically point to a file
|
||
containing that text.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.target"></a><a class="term" href="options.html#opt-home.file._name_.target"><code class="option">home.file.<name>.target</code></a></span></dt><dd><p>Path to target file relative to <code class="envar">HOME</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><name></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.text"></a><a class="term" href="options.html#opt-home.file._name_.text"><code class="option">home.file.<name>.text</code></a></span></dt><dd><p>Text of the file. If this option is null then
|
||
<a class="link" href="options.html#opt-home.file._name_.source">home.file.<name?>.source</a>
|
||
must be set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/files.nix#blob-path" target="_top">
|
||
<home-manager/modules/files.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.homeDirectory"></a><a class="term" href="options.html#opt-home.homeDirectory"><code class="option">home.homeDirectory</code></a></span></dt><dd><p>The user's home directory. Must be an absolute path.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">"$HOME" for state version < 20.09,
|
||
undefined for state version ≥ 20.09
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"/home/jane.doe"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.keyboard"></a><a class="term" href="options.html#opt-home.keyboard"><code class="option">home.keyboard</code></a></span></dt><dd><p>Keyboard configuration. Set to <code class="literal">null</code> to
|
||
disable Home Manager keyboard management.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">"{ }" for state version < 21.11,
|
||
"null" for state version ≥ 21.11
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.keyboard.layout"></a><a class="term" href="options.html#opt-home.keyboard.layout"><code class="option">home.keyboard.layout</code></a></span></dt><dd><p>Keyboard layout. If <code class="literal">null</code>, then the system
|
||
configuration will be used.
|
||
</p><p>
|
||
This defaults to <code class="literal">null</code> for state
|
||
version ≥ 19.09 and <code class="literal">"us"</code> otherwise.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.keyboard.model"></a><a class="term" href="options.html#opt-home.keyboard.model"><code class="option">home.keyboard.model</code></a></span></dt><dd><p>Keyboard model.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"presario"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.keyboard.options"></a><a class="term" href="options.html#opt-home.keyboard.options"><code class="option">home.keyboard.options</code></a></span></dt><dd><p>X keyboard options; layout switching goes here.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"grp:caps_toggle" "grp_led:scroll"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.keyboard.variant"></a><a class="term" href="options.html#opt-home.keyboard.variant"><code class="option">home.keyboard.variant</code></a></span></dt><dd><p>X keyboard variant. If <code class="literal">null</code>, then the
|
||
system configuration will be used.
|
||
</p><p>
|
||
This defaults to <code class="literal">null</code> for state
|
||
version ≥ 19.09 and <code class="literal">""</code> otherwise.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"colemak"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language"></a><a class="term" href="options.html#opt-home.language"><code class="option">home.language</code></a></span></dt><dd><p>Language configuration.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.address"></a><a class="term" href="options.html#opt-home.language.address"><code class="option">home.language.address</code></a></span></dt><dd><p>The language to use for addresses.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.base"></a><a class="term" href="options.html#opt-home.language.base"><code class="option">home.language.base</code></a></span></dt><dd><p>The language to use unless overridden by a more specific option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.collate"></a><a class="term" href="options.html#opt-home.language.collate"><code class="option">home.language.collate</code></a></span></dt><dd><p>The language to use for collation (alphabetical ordering).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.ctype"></a><a class="term" href="options.html#opt-home.language.ctype"><code class="option">home.language.ctype</code></a></span></dt><dd><p>Character classification category.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.measurement"></a><a class="term" href="options.html#opt-home.language.measurement"><code class="option">home.language.measurement</code></a></span></dt><dd><p>The language to use for measurement values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.messages"></a><a class="term" href="options.html#opt-home.language.messages"><code class="option">home.language.messages</code></a></span></dt><dd><p>The language to use for messages, application UI languages, etc.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.monetary"></a><a class="term" href="options.html#opt-home.language.monetary"><code class="option">home.language.monetary</code></a></span></dt><dd><p>The language to use for formatting currencies and money amounts.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.name"></a><a class="term" href="options.html#opt-home.language.name"><code class="option">home.language.name</code></a></span></dt><dd><p>The language to use for personal names.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.numeric"></a><a class="term" href="options.html#opt-home.language.numeric"><code class="option">home.language.numeric</code></a></span></dt><dd><p>The language to use for numerical values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.paper"></a><a class="term" href="options.html#opt-home.language.paper"><code class="option">home.language.paper</code></a></span></dt><dd><p>The language to use for paper sizes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.telephone"></a><a class="term" href="options.html#opt-home.language.telephone"><code class="option">home.language.telephone</code></a></span></dt><dd><p>The language to use for telephone numbers.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.language.time"></a><a class="term" href="options.html#opt-home.language.time"><code class="option">home.language.time</code></a></span></dt><dd><p>The language to use for formatting times.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor"></a><a class="term" href="options.html#opt-home.pointerCursor"><code class="option">home.pointerCursor</code></a></span></dt><dd><p>Cursor configuration. Set to <code class="literal">null</code> to disable.
|
||
</p><p>
|
||
Top-level options declared under this submodule are backend indepedent
|
||
options. Options declared under namespaces such as <code class="literal">x11</code>
|
||
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, <code class="varname">
|
||
<a class="link" href="options.html#opt-home.pointerCursor.x11.enable">home.pointerCursor.x11.enable</a>
|
||
</code> will enable x11 cursor configurations.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.package"></a><a class="term" href="options.html#opt-home.pointerCursor.package"><code class="option">home.pointerCursor.package</code></a></span></dt><dd><p>Package providing the cursor theme.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.vanilla-dmz</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.gtk.enable"></a><a class="term" href="options.html#opt-home.pointerCursor.gtk.enable"><code class="option">home.pointerCursor.gtk.enable</code></a></span></dt><dd><p>Whether to enable gtk config generation for <code class="option">home.pointerCursor</code>
|
||
.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.name"></a><a class="term" href="options.html#opt-home.pointerCursor.name"><code class="option">home.pointerCursor.name</code></a></span></dt><dd><p>The cursor name within the package.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Vanilla-DMZ"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.size"></a><a class="term" href="options.html#opt-home.pointerCursor.size"><code class="option">home.pointerCursor.size</code></a></span></dt><dd><p>The cursor size.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">32</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">64</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.x11.enable"></a><a class="term" href="options.html#opt-home.pointerCursor.x11.enable"><code class="option">home.pointerCursor.x11.enable</code></a></span></dt><dd><p>Whether to enable x11 config generation for <code class="option">home.pointerCursor</code>
|
||
.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.x11.defaultCursor"></a><a class="term" href="options.html#opt-home.pointerCursor.x11.defaultCursor"><code class="option">home.pointerCursor.x11.defaultCursor</code></a></span></dt><dd><p>The default cursor file to use within the package.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"left_ptr"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"X_cursor"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.profileDirectory"></a><a class="term" href="options.html#opt-home.profileDirectory"><code class="option">home.profileDirectory</code></a></span></dt><dd><p>The profile directory where Home Manager generations are installed.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">"${home.homeDirectory}/.nix-profile" or
|
||
"/etc/profiles/per-user/${home.username}"
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.sessionPath"></a><a class="term" href="options.html#opt-home.sessionPath"><code class="option">home.sessionPath</code></a></span></dt><dd><p>Extra directories to add to <code class="envar">PATH</code>.
|
||
|
||
</p><p>
|
||
|
||
These directories are added to the <code class="envar">PATH</code> variable in a
|
||
double-quoted context, so expressions like <code class="code">$HOME</code> are
|
||
expanded by the shell. However, since expressions like <code class="code">~</code> or
|
||
<code class="code">*</code> are escaped, they will end up in the <code class="envar">PATH</code>
|
||
verbatim.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"$HOME/.local/bin" "\${xdg.configHome}/emacs/bin" ".git/safe/../../bin"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.sessionVariables"></a><a class="term" href="options.html#opt-home.sessionVariables"><code class="option">home.sessionVariables</code></a></span></dt><dd><p>Environment variables to always set at login.
|
||
</p><p>
|
||
The values may refer to other environment variables using
|
||
POSIX.2 style variable references. For example, a variable
|
||
<code class="varname">parameter</code> may be referenced as
|
||
<code class="code">$parameter</code> or <code class="code">${parameter}</code>. A
|
||
default value <code class="literal">foo</code> may be given as per
|
||
<code class="code">${parameter:-foo}</code> and, similarly, an alternate
|
||
value <code class="literal">bar</code> can be given as per
|
||
<code class="code">${parameter:+bar}</code>.
|
||
</p><p>
|
||
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
|
||
</p><pre class="programlisting nix">
|
||
home.sessionVariables = {
|
||
FOO = "Hello";
|
||
BAR = "$FOO World!";
|
||
};
|
||
</pre><p>
|
||
may not work as expected. If you need to reference another
|
||
session variable, then do so inside Nix instead. The above
|
||
example then becomes
|
||
</p><pre class="programlisting nix">
|
||
home.sessionVariables = {
|
||
FOO = "Hello";
|
||
BAR = "${config.home.sessionVariables.FOO} World!";
|
||
};
|
||
</pre><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
EDITOR = "emacs"; GS_OPTIONS = "-sPAPERSIZE=a4";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.shellAliases"></a><a class="term" href="options.html#opt-home.shellAliases"><code class="option">home.shellAliases</code></a></span></dt><dd><p>An attribute set that maps aliases (the top level attribute names
|
||
in this option) to command strings or directly to build outputs.
|
||
</p><p>
|
||
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
|
||
<a class="xref" href="options.html#opt-programs.bash.shellAliases"><code class="option">programs.bash.shellAliases</code></a> for Bash.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
g = "git";
|
||
"..." = "cd ../..";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.stateVersion"></a><a class="term" href="options.html#opt-home.stateVersion"><code class="option">home.stateVersion</code></a></span></dt><dd><p>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.
|
||
</p><p>
|
||
The <span class="emphasis"><em>state version</em></span> 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
|
||
conversion or moving files.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05", "21.11", "22.05", "22.11"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"18.09"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/version.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/version.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.username"></a><a class="term" href="options.html#opt-home.username"><code class="option">home.username</code></a></span></dt><dd><p>The user's username.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">"$USER" for state version < 20.09,
|
||
undefined for state version ≥ 20.09
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"jane.doe"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
|
||
<home-manager/modules/home-environment.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.enabled"></a><a class="term" href="options.html#opt-i18n.inputMethod.enabled"><code class="option">i18n.inputMethod.enabled</code></a></span></dt><dd><p>Select the enabled input method. Input methods is a software to input
|
||
symbols that are not available on standard input devices.
|
||
</p><p>
|
||
Input methods are specially used to input Chinese, Japanese and Korean
|
||
characters.
|
||
</p><p>
|
||
Currently the following input methods are available in Home Manager:
|
||
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">fcitx</code></span></dt><dd><p>
|
||
A customizable lightweight input method
|
||
extra input engines can be added using
|
||
<code class="literal">i18n.inputMethod.fcitx.engines</code>.
|
||
</p></dd><dt><span class="term"><code class="literal">fcitx5</code></span></dt><dd><p>
|
||
The next generation of fcitx,
|
||
addons (including engines, dictionaries, skins) can be added using
|
||
<code class="literal">i18n.inputMethod.fcitx5.addons</code>.
|
||
</p></dd><dt><span class="term"><code class="literal">nabi</code></span></dt><dd><p>
|
||
A Korean input method based on XIM. Nabi doesn't support Qt 5.
|
||
</p></dd><dt><span class="term"><code class="literal">uim</code></span></dt><dd><p>
|
||
The universal input method, is a library with a XIM bridge.
|
||
uim mainly support Chinese, Japanese and Korean.
|
||
</p></dd><dt><span class="term"><code class="literal">hime</code></span></dt><dd><p>An extremely easy-to-use input method framework.</p></dd><dt><span class="term"><code class="literal">kime</code></span></dt><dd><p>A Korean IME.</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "fcitx", "fcitx5", "nabi", "uim", "hime", "kime"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fcitx"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/i18n/input-method/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.fcitx.engines"></a><a class="term" href="options.html#opt-i18n.inputMethod.fcitx.engines"><code class="option">i18n.inputMethod.fcitx.engines</code></a></span></dt><dd><p>Enabled Fcitx engines. Available engines are: <code class="literal">anthy</code>, <code class="literal">chewing</code>, <code class="literal">cloudpinyin</code>, <code class="literal">hangul</code>, <code class="literal">libpinyin</code>, <code class="literal">m17n</code>, <code class="literal">mozc</code>, <code class="literal">rime</code>, <code class="literal">skk</code>, <code class="literal">table-extra</code>, <code class="literal">table-other</code>, <code class="literal">unikey</code>.</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">with pkgs.fcitx-engines; [ mozc hangul ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/fcitx.nix#blob-path" target="_top">
|
||
<home-manager/modules/i18n/input-method/fcitx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.fcitx5.addons"></a><a class="term" href="options.html#opt-i18n.inputMethod.fcitx5.addons"><code class="option">i18n.inputMethod.fcitx5.addons</code></a></span></dt><dd><p>Enabled Fcitx5 addons.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">with pkgs; [ fcitx5-rime ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/fcitx5.nix#blob-path" target="_top">
|
||
<home-manager/modules/i18n/input-method/fcitx5.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.kime.config"></a><a class="term" href="options.html#opt-i18n.inputMethod.kime.config"><code class="option">i18n.inputMethod.kime.config</code></a></span></dt><dd><p>kime configuration. Refer to
|
||
<a class="link" href="https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md" target="_top">https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md</a>
|
||
for details on supported values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
daemon = {
|
||
modules = ["Xim" "Indicator"];
|
||
};
|
||
|
||
indicator = {
|
||
icon_color = "White";
|
||
};
|
||
|
||
engine = {
|
||
hangul = {
|
||
layout = "dubeolsik";
|
||
};
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/kime.nix#blob-path" target="_top">
|
||
<home-manager/modules/i18n/input-method/kime.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.uim.toolbar"></a><a class="term" href="options.html#opt-i18n.inputMethod.uim.toolbar"><code class="option">i18n.inputMethod.uim.toolbar</code></a></span></dt><dd><p>Selected UIM toolbar.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "gtk", "gtk3", "gtk-systray", "gtk3-systray", "qt4"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"gtk"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"gtk-systray"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/uim.nix#blob-path" target="_top">
|
||
<home-manager/modules/i18n/input-method/uim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.enable"></a><a class="term" href="options.html#opt-launchd.enable"><code class="option">launchd.enable</code></a></span></dt><dd><p>Whether to enable Home Manager to define per-user daemons by making use
|
||
of launchd's LaunchAgents.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.stdenv.hostPlatform.isDarwin</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents"></a><a class="term" href="options.html#opt-launchd.agents"><code class="option">launchd.agents</code></a></span></dt><dd><p>Define LaunchAgents.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.enable"></a><a class="term" href="options.html#opt-launchd.agents._name_.enable"><code class="option">launchd.agents.<name>.enable</code></a></span></dt><dd><p>Whether to enable ‹name›.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config"></a><a class="term" href="options.html#opt-launchd.agents._name_.config"><code class="option">launchd.agents.<name>.config</code></a></span></dt><dd><p>Define a launchd job. See <span class="citerefentry"><span class="refentrytitle">launchd.plist</span>(5)</span> for details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
ProgramArguments = [ "/usr/bin/say" "Good afternoon" ];
|
||
StartCalendarInterval = {
|
||
Hour = 12;
|
||
Minute = 0;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.AbandonProcessGroup"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.AbandonProcessGroup"><code class="option">launchd.agents.<name>.config.AbandonProcessGroup</code></a></span></dt><dd><p>When a job dies, launchd kills any remaining processes with the same process group ID as the job. Set-ting Setting
|
||
ting this key to true disables that behavior.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Debug"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Debug"><code class="option">launchd.agents.<name>.config.Debug</code></a></span></dt><dd><p>This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while
|
||
dealing with this job.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Disabled"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Disabled"><code class="option">launchd.agents.<name>.config.Disabled</code></a></span></dt><dd><p>This optional key is used as a hint to <code class="literal">launchctl(1)</code> 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 run-ning running
|
||
ning system. If you wish to know whether a job is loaded in launchd, reading this key from a configura-tion configuration
|
||
tion file yourself is not a sufficient test. You should query launchd for the presence of the job using
|
||
the <code class="literal">launchctl(1)</code> list subcommand or use the ServiceManagement framework's
|
||
<code class="literal">SMJobCopyDictionary()</code> 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 <code class="literal">launchctl(1)</code> load and unload subcommands. These subcommands no
|
||
longer modify the configuration file, so the value displayed in the configuration file is not necessar-ily necessarily
|
||
ily the value that <code class="literal">launchctl(1)</code> will apply. See <code class="literal">launchctl(1)</code> for more information.
|
||
|
||
Please also be mindful that you should only use this key if the provided on-demand and KeepAlive crite-ria criteria
|
||
ria are insufficient to describe the conditions under which your job needs to run. The cost to have a
|
||
job loaded in launchd is negligible, so there is no harm in loading a job which only runs once or very
|
||
rarely.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.EnableGlobbing"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.EnableGlobbing"><code class="option">launchd.agents.<name>.config.EnableGlobbing</code></a></span></dt><dd><p>This flag causes launchd to use the <code class="literal">glob(3)</code> mechanism to update the program arguments before invoca-tion. invocation.
|
||
tion.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.EnableTransactions"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.EnableTransactions"><code class="option">launchd.agents.<name>.config.EnableTransactions</code></a></span></dt><dd><p>This flag instructs launchd that the job promises to use <code class="literal">vproc_transaction_begin(3)</code> and
|
||
<code class="literal">vproc_transaction_end(3)</code> 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.EnvironmentVariables"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.EnvironmentVariables"><code class="option">launchd.agents.<name>.config.EnvironmentVariables</code></a></span></dt><dd><p>This optional key is used to specify additional environment variables to be set before running the
|
||
job.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.ExitTimeOut"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.ExitTimeOut"><code class="option">launchd.agents.<name>.config.ExitTimeOut</code></a></span></dt><dd><p>The amount of time launchd waits before sending a SIGKILL signal. The default value is 20 seconds. The
|
||
value zero is interpreted as infinity.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.GroupName"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.GroupName"><code class="option">launchd.agents.<name>.config.GroupName</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits"><code class="option">launchd.agents.<name>.config.HardResourceLimits</code></a></span></dt><dd><p>Resource limits to be imposed on the job. These adjust variables set with <code class="literal">setrlimit(2)</code>. The following
|
||
keys apply:
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
NumberOfFiles = 4096;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.CPU"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.CPU"><code class="option">launchd.agents.<name>.config.HardResourceLimits.CPU</code></a></span></dt><dd><p>The maximum amount of cpu time (in seconds) to be used by each process.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.Core"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.Core"><code class="option">launchd.agents.<name>.config.HardResourceLimits.Core</code></a></span></dt><dd><p>The largest size (in bytes) core file that may be created.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.Data"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.Data"><code class="option">launchd.agents.<name>.config.HardResourceLimits.Data</code></a></span></dt><dd><p>The maximum size (in bytes) of the data segment for a process; this defines how far a program may
|
||
extend its break with the <code class="literal">sbrk(2)</code> system call.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.FileSize"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.FileSize"><code class="option">launchd.agents.<name>.config.HardResourceLimits.FileSize</code></a></span></dt><dd><p>The largest size (in bytes) file that may be created.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.MemoryLock"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.MemoryLock"><code class="option">launchd.agents.<name>.config.HardResourceLimits.MemoryLock</code></a></span></dt><dd><p>The maximum size (in bytes) which a process may lock into memory using the <code class="literal">mlock(2)</code> function.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.NumberOfFiles"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.NumberOfFiles"><code class="option">launchd.agents.<name>.config.HardResourceLimits.NumberOfFiles</code></a></span></dt><dd><p>The maximum number of open files for this process. Setting this value in a system wide daemon
|
||
will set the <code class="literal">sysctl(3)</code> kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResource-Limits) (HardResourceLimits)
|
||
Limits) value in addition to the <code class="literal">setrlimit(2)</code> values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.NumberOfProcesses"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.NumberOfProcesses"><code class="option">launchd.agents.<name>.config.HardResourceLimits.NumberOfProcesses</code></a></span></dt><dd><p>The maximum number of simultaneous processes for this user id. Setting this value in a system
|
||
wide daemon will set the <code class="literal">sysctl(3)</code> kern.maxproc (SoftResourceLimits) or kern.maxprocperuid
|
||
(HardResourceLimits) value in addition to the <code class="literal">setrlimit(2)</code> values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.ResidentSetSize"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.ResidentSetSize"><code class="option">launchd.agents.<name>.config.HardResourceLimits.ResidentSetSize</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.HardResourceLimits.Stack"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.HardResourceLimits.Stack"><code class="option">launchd.agents.<name>.config.HardResourceLimits.Stack</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.InitGroups"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.InitGroups"><code class="option">launchd.agents.<name>.config.InitGroups</code></a></span></dt><dd><p>This optional key specifies whether <code class="literal">initgroups(3)</code> 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.KeepAlive"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.KeepAlive"><code class="option">launchd.agents.<name>.config.KeepAlive</code></a></span></dt><dd><p>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 dictio-nary dictionary
|
||
nary of conditions may be specified to selectively control whether launchd keeps a job alive or not. If
|
||
multiple keys are provided, launchd ORs them, thus providing maximum flexibility to the job to refine
|
||
the logic and stall if necessary. If launchd finds no reason to restart the job, it falls back on
|
||
demand based invocation. Jobs that exit quickly and frequently when configured to be kept alive will
|
||
be throttled to converve system resources.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Label"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Label"><code class="option">launchd.agents.<name>.config.Label</code></a></span></dt><dd><p>This required key uniquely identifies the job to launchd.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.LaunchOnlyOnce"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.LaunchOnlyOnce"><code class="option">launchd.agents.<name>.config.LaunchOnlyOnce</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.LimitLoadFromHosts"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.LimitLoadFromHosts"><code class="option">launchd.agents.<name>.config.LimitLoadFromHosts</code></a></span></dt><dd><p>This configuration file only applies to hosts NOT listed with this key. Note: One should set kern.host-name kern.hostname
|
||
name in <code class="literal">sysctl.conf(5)</code> for this feature to work reliably.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.LimitLoadToHosts"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.LimitLoadToHosts"><code class="option">launchd.agents.<name>.config.LimitLoadToHosts</code></a></span></dt><dd><p>This configuration file only applies to the hosts listed with this key. Note: One should set kern.host-name kern.hostname
|
||
name in <code class="literal">sysctl.conf(5)</code> for this feature to work reliably.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.LimitLoadToSessionType"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.LimitLoadToSessionType"><code class="option">launchd.agents.<name>.config.LimitLoadToSessionType</code></a></span></dt><dd><p>This configuration file only applies to sessions of the type specified. This key is used in concert
|
||
with the -S flag to <span class="command"><strong>launchctl</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.LowPriorityIO"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.LowPriorityIO"><code class="option">launchd.agents.<name>.config.LowPriorityIO</code></a></span></dt><dd><p>This optional key specifies whether the kernel should consider this daemon to be low priority when
|
||
doing file system I/O.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.MachServices"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.MachServices"><code class="option">launchd.agents.<name>.config.MachServices</code></a></span></dt><dd><p>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.
|
||
|
||
Finally, for the job itself, the values will be replaced with Mach ports at the time of check-in with
|
||
launchd.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
ResetAtClose = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.MachServices.HideUntilCheckIn"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.MachServices.HideUntilCheckIn"><code class="option">launchd.agents.<name>.config.MachServices.HideUntilCheckIn</code></a></span></dt><dd><p>Reserve the name in the namespace, but cause bootstrap_look_up() to fail until the job has
|
||
checked in with launchd.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.MachServices.ResetAtClose"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.MachServices.ResetAtClose"><code class="option">launchd.agents.<name>.config.MachServices.ResetAtClose</code></a></span></dt><dd><p>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 boot-strap_look_up() bootstrap_look_up()
|
||
strap_look_up() calls, so that clients can trust that after receiving a port death notification,
|
||
the new port will have already been recreated. Setting the value to true should be done with
|
||
care. Not all clients may be able to handle this behavior. The default value is false.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Nice"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Nice"><code class="option">launchd.agents.<name>.config.Nice</code></a></span></dt><dd><p>This optional key specifies what nice(3) value should be applied to the daemon.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.OnDemand"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.OnDemand"><code class="option">launchd.agents.<name>.config.OnDemand</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.ProcessType"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.ProcessType"><code class="option">launchd.agents.<name>.config.ProcessType</code></a></span></dt><dd><p>This optional key describes, at a high level, the intended purpose of the job. The system will apply
|
||
resource limits based on what kind of job it is. If left unspecified, the system will apply light
|
||
resource limits to the job, throttling its CPU usage and I/O bandwidth. The following are valid values:
|
||
|
||
Background
|
||
Background jobs are generally processes that do work that was not directly requested by the user.
|
||
The resource limits applied to Background jobs are intended to prevent them from disrupting the
|
||
user experience.
|
||
|
||
Standard
|
||
Standard jobs are equivalent to no ProcessType being set.
|
||
|
||
Adaptive
|
||
Adaptive jobs move between the Background and Interactive classifications based on activity over
|
||
XPC connections. See <code class="literal">xpc_transaction_begin(3)</code> for details.
|
||
|
||
Interactive
|
||
Interactive jobs run with the same resource limitations as apps, that is to say, none. Interac-tive Interactive
|
||
tive jobs are critical to maintaining a responsive user experience, and this key should only be
|
||
used if an app's ability to be responsive depends on it, and cannot be made Adaptive.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "Background", "Standard", "Adaptive", "Interactive"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Background"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Program"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Program"><code class="option">launchd.agents.<name>.config.Program</code></a></span></dt><dd><p>This key maps to the first argument of <code class="literal">execvp(3)</code>. 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.ProgramArguments"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.ProgramArguments"><code class="option">launchd.agents.<name>.config.ProgramArguments</code></a></span></dt><dd><p>This key maps to the second argument of <code class="literal">execvp(3)</code>. This key is required in the absence of the Program
|
||
key. Please note: many people are confused by this key. Please read <code class="literal">execvp(3)</code> very carefully!
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.QueueDirectories"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.QueueDirectories"><code class="option">launchd.agents.<name>.config.QueueDirectories</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.RootDirectory"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.RootDirectory"><code class="option">launchd.agents.<name>.config.RootDirectory</code></a></span></dt><dd><p>This optional key is used to specify a directory to <code class="literal">chroot(2)</code> to before running the job.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.RunAtLoad"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.RunAtLoad"><code class="option">launchd.agents.<name>.config.RunAtLoad</code></a></span></dt><dd><p>This optional key is used to control whether your job is launched once at the time the job is loaded.
|
||
The default is false.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets"><code class="option">launchd.agents.<name>.config.Sockets</code></a></span></dt><dd><p>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 appli-cation application
|
||
cation developer to use to differentiate which descriptors correspond to which application level proto-cols protocols
|
||
cols (e.g. http vs. ftp vs. DNS...). At check-in time, the value of each Sockets dictionary key will
|
||
be an array of descriptors. Daemon/Agent writers should consider all descriptors of a given key to be
|
||
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 <code class="literal">getaddrinfo(3)</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.Bonjour"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.Bonjour"><code class="option">launchd.agents.<name>.config.Sockets.<name>.Bonjour</code></a></span></dt><dd><p>This optional key can be used to request that the service be registered with the
|
||
<code class="literal">mDNSResponder(8)</code>. If the value is boolean, the service name is inferred from the SockService-Name. SockServiceName.
|
||
Name.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.MulticastGroup"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.MulticastGroup"><code class="option">launchd.agents.<name>.config.Sockets.<name>.MulticastGroup</code></a></span></dt><dd><p>This optional key can be used to request that the datagram socket join a multicast group. If the
|
||
value is a hostname, then <code class="literal">getaddrinfo(3)</code> 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 Sock-Family SockFamily
|
||
Family family also be set, otherwise the results are undefined.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SecureSocketWithKey"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SecureSocketWithKey"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SecureSocketWithKey</code></a></span></dt><dd><p>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 inher-ited inherited
|
||
ited by all jobs spawned by launchd.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockFamily"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockFamily"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockFamily</code></a></span></dt><dd><p>This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "IPv4", "IPv6"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockNodeName"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockNodeName"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockNodeName</code></a></span></dt><dd><p>This optional key specifies the node to <code class="literal">connect(2)</code> or <code class="literal">bind(2)</code> to.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockPassive"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockPassive"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockPassive</code></a></span></dt><dd><p>This optional key specifies whether <code class="literal">listen(2)</code> or <code class="literal">connect(2)</code> should be called on the created file
|
||
descriptor. The default is true ("to listen").
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockPathMode"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockPathMode"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockPathMode</code></a></span></dt><dd><p>This optional key specifies the mode of the socket. Known bug: Property lists don't support
|
||
octal, so please convert the value to decimal.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockPathName"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockPathName"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockPathName</code></a></span></dt><dd><p>This optional key implies SockFamily is set to "Unix". It specifies the path to <code class="literal">connect(2)</code> or
|
||
<code class="literal">bind(2)</code> to.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockProtocol"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockProtocol"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockProtocol</code></a></span></dt><dd><p>This optional key specifies the protocol to be passed to <code class="literal">socket(2)</code>. The only value understood by
|
||
this key at the moment is "TCP".
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or value "TCP" (singular enum)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockServiceName"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockServiceName"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockServiceName</code></a></span></dt><dd><p>This optional key specifies the service on the node to <code class="literal">connect(2)</code> or <code class="literal">bind(2)</code> to.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Sockets._name_.SockType"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Sockets._name_.SockType"><code class="option">launchd.agents.<name>.config.Sockets.<name>.SockType</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "stream", "dgram", "seqpacket"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits"><code class="option">launchd.agents.<name>.config.SoftResourceLimits</code></a></span></dt><dd><p>Resource limits to be imposed on the job. These adjust variables set with <code class="literal">setrlimit(2)</code>. The following
|
||
keys apply:
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.CPU"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.CPU"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.CPU</code></a></span></dt><dd><p>The maximum amount of cpu time (in seconds) to be used by each process.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.Core"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.Core"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.Core</code></a></span></dt><dd><p>The largest size (in bytes) core file that may be created.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.Data"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.Data"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.Data</code></a></span></dt><dd><p>The maximum size (in bytes) of the data segment for a process; this defines how far a program may
|
||
extend its break with the <code class="literal">sbrk(2)</code> system call.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.FileSize"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.FileSize"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.FileSize</code></a></span></dt><dd><p>The largest size (in bytes) file that may be created.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.MemoryLock"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.MemoryLock"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.MemoryLock</code></a></span></dt><dd><p>The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.NumberOfFiles"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.NumberOfFiles"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.NumberOfFiles</code></a></span></dt><dd><p>The maximum number of open files for this process. Setting this value in a system wide daemon
|
||
will set the <code class="literal">sysctl(3)</code> kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResource-Limits) (HardResourceLimits)
|
||
Limits) value in addition to the <code class="literal">setrlimit(2)</code> values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.NumberOfProcesses"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.NumberOfProcesses"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.NumberOfProcesses</code></a></span></dt><dd><p>The maximum number of simultaneous processes for this user id. Setting this value in a system
|
||
wide daemon will set the <code class="literal">sysctl(3)</code> kern.maxproc (SoftResourceLimits) or kern.maxprocperuid
|
||
(HardResourceLimits) value in addition to the <code class="literal">setrlimit(2)</code> values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.ResidentSetSize"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.ResidentSetSize"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.ResidentSetSize</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.SoftResourceLimits.Stack"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.SoftResourceLimits.Stack"><code class="option">launchd.agents.<name>.config.SoftResourceLimits.Stack</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StandardErrorPath"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StandardErrorPath"><code class="option">launchd.agents.<name>.config.StandardErrorPath</code></a></span></dt><dd><p>This optional key specifies what file should be used for data being sent to stderr when using <code class="literal">stdio(3)</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StandardInPath"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StandardInPath"><code class="option">launchd.agents.<name>.config.StandardInPath</code></a></span></dt><dd><p>This optional key specifies what file should be used for data being supplied to stdin when using
|
||
<code class="literal">stdio(3)</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StandardOutPath"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StandardOutPath"><code class="option">launchd.agents.<name>.config.StandardOutPath</code></a></span></dt><dd><p>This optional key specifies what file should be used for data being sent to stdout when using <code class="literal">stdio(3)</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartCalendarInterval"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartCalendarInterval"><code class="option">launchd.agents.<name>.config.StartCalendarInterval</code></a></span></dt><dd><p>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 <code class="literal">crontab(5)</code>. 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
Hour = 2; Minute = 30;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartCalendarInterval._.Day"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartCalendarInterval._.Day"><code class="option">launchd.agents.<name>.config.StartCalendarInterval.*.Day</code></a></span></dt><dd><p>The day on which this job will be run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartCalendarInterval._.Hour"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartCalendarInterval._.Hour"><code class="option">launchd.agents.<name>.config.StartCalendarInterval.*.Hour</code></a></span></dt><dd><p>The hour on which this job will be run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartCalendarInterval._.Minute"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartCalendarInterval._.Minute"><code class="option">launchd.agents.<name>.config.StartCalendarInterval.*.Minute</code></a></span></dt><dd><p>The minute on which this job will be run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartCalendarInterval._.Month"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartCalendarInterval._.Month"><code class="option">launchd.agents.<name>.config.StartCalendarInterval.*.Month</code></a></span></dt><dd><p>The month on which this job will be run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartCalendarInterval._.Weekday"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartCalendarInterval._.Weekday"><code class="option">launchd.agents.<name>.config.StartCalendarInterval.*.Weekday</code></a></span></dt><dd><p>The weekday on which this job will be run (0 and 7 are Sunday).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartInterval"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartInterval"><code class="option">launchd.agents.<name>.config.StartInterval</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.StartOnMount"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.StartOnMount"><code class="option">launchd.agents.<name>.config.StartOnMount</code></a></span></dt><dd><p>This optional key causes the job to be started every time a filesystem is mounted.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.ThrottleInterval"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.ThrottleInterval"><code class="option">launchd.agents.<name>.config.ThrottleInterval</code></a></span></dt><dd><p>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.
|
||
This not only reduces the latency of responses, but it encourages developers to amortize the cost of
|
||
program invocation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.TimeOut"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.TimeOut"><code class="option">launchd.agents.<name>.config.TimeOut</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.Umask"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.Umask"><code class="option">launchd.agents.<name>.config.Umask</code></a></span></dt><dd><p>This optional key specifies what value should be passed to <code class="literal">umask(2)</code> before running the job. Known bug:
|
||
Property lists don't support octal, so please convert the value to decimal.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.UserName"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.UserName"><code class="option">launchd.agents.<name>.config.UserName</code></a></span></dt><dd><p>This optional key specifies the user to run the job as. This key is only applicable when launchd is
|
||
running as root.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.WaitForDebugger"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.WaitForDebugger"><code class="option">launchd.agents.<name>.config.WaitForDebugger</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.WatchPaths"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.WatchPaths"><code class="option">launchd.agents.<name>.config.WatchPaths</code></a></span></dt><dd><p>This optional key causes the job to be started if any one of the listed paths are modified.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.WorkingDirectory"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.WorkingDirectory"><code class="option">launchd.agents.<name>.config.WorkingDirectory</code></a></span></dt><dd><p>This optional key is used to specify a directory to <code class="literal">chdir(2)</code> to before running the job.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.inetdCompatibility"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.inetdCompatibility"><code class="option">launchd.agents.<name>.config.inetdCompatibility</code></a></span></dt><dd><p>The presence of this key specifies that the daemon expects to be run as if it were launched from inetd.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
Wait = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-launchd.agents._name_.config.inetdCompatibility.Wait"></a><a class="term" href="options.html#opt-launchd.agents._name_.config.inetdCompatibility.Wait"><code class="option">launchd.agents.<name>.config.inetdCompatibility.Wait</code></a></span></dt><dd><p>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 <code class="literal">accept(2)</code> is
|
||
called on behalf of the job, and the result is passed via the standard in/out/error descriptors.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/launchd/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/launchd/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-lib"></a><a class="term" href="options.html#opt-lib"><code class="option">lib</code></a></span></dt><dd><p>This option allows modules to define helper functions,
|
||
constants, etc.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/lib.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/lib.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-manual.html.enable"></a><a class="term" href="options.html#opt-manual.html.enable"><code class="option">manual.html.enable</code></a></span></dt><dd><p>Whether to install the HTML manual. This also installs the
|
||
<span class="command"><strong>home-manager-help</strong></span> tool, which opens a local
|
||
copy of the Home Manager manual in the system web browser.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/manual.nix#blob-path" target="_top">
|
||
<home-manager/modules/manual.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-manual.json.enable"></a><a class="term" href="options.html#opt-manual.json.enable"><code class="option">manual.json.enable</code></a></span></dt><dd><p>Whether to install a JSON formatted list of all Home Manager
|
||
options. This can be located at
|
||
<code class="filename"><profile directory>/share/doc/home-manager/options.json</code>,
|
||
and may be used for navigating definitions, auto-completing,
|
||
and other miscellaneous tasks.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/manual.nix#blob-path" target="_top">
|
||
<home-manager/modules/manual.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-manual.manpages.enable"></a><a class="term" href="options.html#opt-manual.manpages.enable"><code class="option">manual.manpages.enable</code></a></span></dt><dd><p>Whether to install the configuration manual page. The manual can
|
||
be reached by <span class="command"><strong>man home-configuration.nix</strong></span>.
|
||
</p><p>
|
||
When looking at the manual page pretend that all references to
|
||
NixOS stuff are actually references to Home Manager stuff.
|
||
Thanks!
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/manual.nix#blob-path" target="_top">
|
||
<home-manager/modules/manual.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-news.display"></a><a class="term" href="options.html#opt-news.display"><code class="option">news.display</code></a></span></dt><dd><p>How unread and relevant news should be presented when
|
||
running <span class="command"><strong>home-manager build</strong></span> and
|
||
<span class="command"><strong>home-manager switch</strong></span>.
|
||
|
||
</p><p>
|
||
|
||
The options are
|
||
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">silent</code></span></dt><dd><p>
|
||
Do not print anything during build or switch. The
|
||
<span class="command"><strong>home-manager news</strong></span> command still
|
||
works for viewing the entries.
|
||
</p></dd><dt><span class="term"><code class="literal">notify</code></span></dt><dd><p>
|
||
The number of unread and relevant news entries will be
|
||
printed to standard output. The <span class="command"><strong>home-manager
|
||
news</strong></span> command can later be used to view the
|
||
entries.
|
||
</p></dd><dt><span class="term"><code class="literal">show</code></span></dt><dd><p>
|
||
A pager showing unread news entries is opened.
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "silent", "notify", "show"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"notify"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/news.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/news.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.package"></a><a class="term" href="options.html#opt-nix.package"><code class="option">nix.package</code></a></span></dt><dd><p>The Nix package that the configuration should be generated for.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.nix</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.checkConfig"></a><a class="term" href="options.html#opt-nix.checkConfig"><code class="option">nix.checkConfig</code></a></span></dt><dd><p>If enabled (the default), checks for data type mismatches and that Nix
|
||
can parse the generated nix.conf.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.extraOptions"></a><a class="term" href="options.html#opt-nix.extraOptions"><code class="option">nix.extraOptions</code></a></span></dt><dd><p>Additional text appended to <code class="filename">nix.conf</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
keep-outputs = true
|
||
keep-derivations = true
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.registry"></a><a class="term" href="options.html#opt-nix.registry"><code class="option">nix.registry</code></a></span></dt><dd><p>User level flake registry.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.registry._name_.exact"></a><a class="term" href="options.html#opt-nix.registry._name_.exact"><code class="option">nix.registry.<name>.exact</code></a></span></dt><dd><p>Whether the <code class="option">from</code> reference needs to match exactly. If set,
|
||
a <code class="option">from</code> reference like <code class="literal">nixpkgs</code> does not
|
||
match with a reference like <code class="literal">nixpkgs/nixos-20.03</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.registry._name_.flake"></a><a class="term" href="options.html#opt-nix.registry._name_.flake"><code class="option">nix.registry.<name>.flake</code></a></span></dt><dd><p>The flake input to which <code class="option">from></code> is to be rewritten.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">nixpkgs</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.registry._name_.from"></a><a class="term" href="options.html#opt-nix.registry._name_.from"><code class="option">nix.registry.<name>.from</code></a></span></dt><dd><p>The flake reference to be rewritten.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean or package</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
id = "nixpkgs"; type = "indirect";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.registry._name_.to"></a><a class="term" href="options.html#opt-nix.registry._name_.to"><code class="option">nix.registry.<name>.to</code></a></span></dt><dd><p>The flake reference to which <code class="option">from></code> is to be rewritten.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean or package</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
owner = "my-org"; repo = "my-nixpkgs"; type = "github";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nix.settings"></a><a class="term" href="options.html#opt-nix.settings"><code class="option">nix.settings</code></a></span></dt><dd><p>Configuration for Nix, see
|
||
<a class="link" href="https://nixos.org/manual/nix/stable/#sec-conf-file" target="_top">https://nixos.org/manual/nix/stable/#sec-conf-file</a> or
|
||
<span class="citerefentry"><span class="refentrytitle">nix.conf</span>(5)</span> for avalaible options.
|
||
The value declared here will be translated directly to the key-value pairs Nix expects.
|
||
</p><p>
|
||
Configuration specified in <code class="option">nix.extraOptions</code> which will be appended
|
||
verbatim to the resulting config file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of Nix config atom (null, bool, int, float, str, path or package) or list of Nix config atom (null, bool, int, float, str, path or package)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
use-sandbox = true;
|
||
show-trace = true;
|
||
system-features = [ "big-parallel" "kvm" "recursive-nix" ];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nix.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nixpkgs.config"></a><a class="term" href="options.html#opt-nixpkgs.config"><code class="option">nixpkgs.config</code></a></span></dt><dd><p>The configuration of the Nix Packages collection. (For
|
||
details, see the Nixpkgs documentation.) It allows you to set
|
||
package configuration options.
|
||
|
||
</p><p>
|
||
|
||
If <code class="literal">null</code>, then configuration is taken from
|
||
the fallback location, for example,
|
||
<code class="filename">~/.config/nixpkgs/config.nix</code>.
|
||
|
||
</p><p>
|
||
|
||
Note, this option will not apply outside your Home Manager
|
||
configuration like when installing manually through
|
||
<span class="command"><strong>nix-env</strong></span>. If you want to apply it both
|
||
inside and outside Home Manager you can put it in a separate
|
||
file and include something like
|
||
|
||
</p><pre class="programlisting nix">
|
||
nixpkgs.config = import ./nixpkgs-config.nix;
|
||
xdg.configFile."nixpkgs/config.nix".source = ./nixpkgs-config.nix;
|
||
</pre><p>
|
||
|
||
in your Home Manager configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or nixpkgs config</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
allowBroken = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nixpkgs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nixpkgs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-nixpkgs.overlays"></a><a class="term" href="options.html#opt-nixpkgs.overlays"><code class="option">nixpkgs.overlays</code></a></span></dt><dd><p>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 <span class="emphasis"><em>original</em></span> Nixpkgs. The
|
||
first argument should be used for finding dependencies, and
|
||
the second should be used for overriding recipes.
|
||
|
||
</p><p>
|
||
|
||
If <code class="literal">null</code>, then the overlays are taken from
|
||
the fallback location, for example,
|
||
<code class="filename">~/.config/nixpkgs/overlays</code>.
|
||
|
||
</p><p>
|
||
|
||
Like <code class="varname">nixpkgs.config</code> this option only
|
||
applies within the Home Manager configuration. See
|
||
<code class="varname">nixpkgs.config</code> for a suggested setup that
|
||
works both internally and externally.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of nixpkgs overlay</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[ (self: super: {
|
||
openssh = super.openssh.override {
|
||
hpnSupport = true;
|
||
withKerberos = true;
|
||
kerberos = self.libkrb5;
|
||
};
|
||
};
|
||
) ]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/nixpkgs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/nixpkgs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-pam.sessionVariables"></a><a class="term" href="options.html#opt-pam.sessionVariables"><code class="option">pam.sessionVariables</code></a></span></dt><dd><p>Environment variables that will be set for the PAM session.
|
||
The variable values must be as described in
|
||
<span class="citerefentry"><span class="refentrytitle">pam_env.conf</span>(5)</span>.
|
||
</p><p>
|
||
Note, this option will become deprecated in the future and its use is
|
||
therefore discouraged.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
EDITOR = "vim";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/pam.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/pam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-pam.yubico.authorizedYubiKeys.ids"></a><a class="term" href="options.html#opt-pam.yubico.authorizedYubiKeys.ids"><code class="option">pam.yubico.authorizedYubiKeys.ids</code></a></span></dt><dd><p>List of authorized YubiKey token IDs. Refer to
|
||
<a class="link" href="https://developers.yubico.com/yubico-pam" target="_top">https://developers.yubico.com/yubico-pam</a>
|
||
for details on how to obtain the token ID of a YubiKey.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string of length 12</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/pam.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/pam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-pam.yubico.authorizedYubiKeys.path"></a><a class="term" href="options.html#opt-pam.yubico.authorizedYubiKeys.path"><code class="option">pam.yubico.authorizedYubiKeys.path</code></a></span></dt><dd><p>File path to write the authorized YubiKeys,
|
||
relative to <code class="envar">HOME</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">".yubico/authorized_yubikeys"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/pam.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/pam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.abook.enable"></a><a class="term" href="options.html#opt-programs.abook.enable"><code class="option">programs.abook.enable</code></a></span></dt><dd><p>Whether to enable Abook.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/abook.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/abook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.abook.extraConfig"></a><a class="term" href="options.html#opt-programs.abook.extraConfig"><code class="option">programs.abook.extraConfig</code></a></span></dt><dd><p>Extra lines added to <code class="filename">$HOME/.config/abook/abookrc</code>.
|
||
Available configuration options are described in the abook repository:
|
||
<a class="link" href="https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc" target="_top">https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
field pager = Pager
|
||
view CONTACT = name, email
|
||
set autosave=true
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/abook.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/abook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.afew.enable"></a><a class="term" href="options.html#opt-programs.afew.enable"><code class="option">programs.afew.enable</code></a></span></dt><dd><p>Whether to enable the afew initial tagging script for Notmuch.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/afew.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/afew.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.afew.extraConfig"></a><a class="term" href="options.html#opt-programs.afew.extraConfig"><code class="option">programs.afew.extraConfig</code></a></span></dt><dd><p>Extra lines added to afew configuration file. Available
|
||
configuration options are described in the afew manual:
|
||
<a class="link" href="https://afew.readthedocs.io/en/latest/configuration.html" target="_top">https://afew.readthedocs.io/en/latest/configuration.html</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">''
|
||
[SpamFilter]
|
||
[KillThreadsFilter]
|
||
[ListMailsFilter]
|
||
[ArchiveSentMailsFilter]
|
||
[InboxFilter]
|
||
''</pre><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
[SpamFilter]
|
||
|
||
[Filter.0]
|
||
query = from:pointyheaded@boss.com
|
||
tags = -new;+boss
|
||
message = Message from above
|
||
|
||
[InboxFilter]
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/afew.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/afew.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alacritty.enable"></a><a class="term" href="options.html#opt-programs.alacritty.enable"><code class="option">programs.alacritty.enable</code></a></span></dt><dd><p>Whether to enable Alacritty.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alacritty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alacritty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alacritty.package"></a><a class="term" href="options.html#opt-programs.alacritty.package"><code class="option">programs.alacritty.package</code></a></span></dt><dd><p>The Alacritty package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.alacritty</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alacritty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alacritty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alacritty.settings"></a><a class="term" href="options.html#opt-programs.alacritty.settings"><code class="option">programs.alacritty.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/alacritty/alacritty.yml</code>. See
|
||
<a class="link" href="https://github.com/alacritty/alacritty/blob/master/alacritty.yml" target="_top">https://github.com/alacritty/alacritty/blob/master/alacritty.yml</a>
|
||
for the default configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
window.dimensions = {
|
||
lines = 3;
|
||
columns = 200;
|
||
};
|
||
key_bindings = [
|
||
{
|
||
key = "K";
|
||
mods = "Control";
|
||
chars = "\\x0c";
|
||
}
|
||
];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alacritty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alacritty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.enable"></a><a class="term" href="options.html#opt-programs.alot.enable"><code class="option">programs.alot.enable</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings"></a><a class="term" href="options.html#opt-programs.alot.bindings"><code class="option">programs.alot.bindings</code></a></span></dt><dd><p>Keybindings.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings.bufferlist"></a><a class="term" href="options.html#opt-programs.alot.bindings.bufferlist"><code class="option">programs.alot.bindings.bufferlist</code></a></span></dt><dd><p>Bufferlist mode keybindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings.envelope"></a><a class="term" href="options.html#opt-programs.alot.bindings.envelope"><code class="option">programs.alot.bindings.envelope</code></a></span></dt><dd><p>Envelope mode keybindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings.global"></a><a class="term" href="options.html#opt-programs.alot.bindings.global"><code class="option">programs.alot.bindings.global</code></a></span></dt><dd><p>Global keybindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings.search"></a><a class="term" href="options.html#opt-programs.alot.bindings.search"><code class="option">programs.alot.bindings.search</code></a></span></dt><dd><p>Search mode keybindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings.taglist"></a><a class="term" href="options.html#opt-programs.alot.bindings.taglist"><code class="option">programs.alot.bindings.taglist</code></a></span></dt><dd><p>Taglist mode keybindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.bindings.thread"></a><a class="term" href="options.html#opt-programs.alot.bindings.thread"><code class="option">programs.alot.bindings.thread</code></a></span></dt><dd><p>Thread mode keybindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.extraConfig"></a><a class="term" href="options.html#opt-programs.alot.extraConfig"><code class="option">programs.alot.extraConfig</code></a></span></dt><dd><p>Extra lines added to alot configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.hooks"></a><a class="term" href="options.html#opt-programs.alot.hooks"><code class="option">programs.alot.hooks</code></a></span></dt><dd><p>Content of the hooks file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.settings"></a><a class="term" href="options.html#opt-programs.alot.settings"><code class="option">programs.alot.settings</code></a></span></dt><dd><p>Configuration options added to alot configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
auto_remove_unread = true; handle_mouse = true; initial_command = "search tag:inbox AND NOT tag:killed"; prefer_plaintext = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
auto_remove_unread = true;
|
||
ask_subject = false;
|
||
thread_indent_replies = 2;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.tags"></a><a class="term" href="options.html#opt-programs.alot.tags"><code class="option">programs.alot.tags</code></a></span></dt><dd><p>How to display the tags.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.tags._name_.focus"></a><a class="term" href="options.html#opt-programs.alot.tags._name_.focus"><code class="option">programs.alot.tags.<name>.focus</code></a></span></dt><dd><p>How to display the tag when focused.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.tags._name_.normal"></a><a class="term" href="options.html#opt-programs.alot.tags._name_.normal"><code class="option">programs.alot.tags.<name>.normal</code></a></span></dt><dd><p>How to display the tag when unfocused.
|
||
See <a class="link" href="https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting" target="_top">https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"'','', 'white','light red', 'white','#d66'"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.tags._name_.translated"></a><a class="term" href="options.html#opt-programs.alot.tags._name_.translated"><code class="option">programs.alot.tags.<name>.translated</code></a></span></dt><dd><p>Fixed string representation for this tag. The tag can be
|
||
hidden from view, if the key translated is set to
|
||
<code class="literal">""</code>, the empty string.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.alot.tags._name_.translation"></a><a class="term" href="options.html#opt-programs.alot.tags._name_.translation"><code class="option">programs.alot.tags.<name>.translation</code></a></span></dt><dd><p>A pair of strings that define a regular substitution to
|
||
compute the string representation on the fly using
|
||
<code class="literal">re.sub</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/alot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/alot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.aria2.enable"></a><a class="term" href="options.html#opt-programs.aria2.enable"><code class="option">programs.aria2.enable</code></a></span></dt><dd><p>Whether to enable aria2.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aria2.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/aria2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.aria2.extraConfig"></a><a class="term" href="options.html#opt-programs.aria2.extraConfig"><code class="option">programs.aria2.extraConfig</code></a></span></dt><dd><p>Extra lines added to <code class="filename">aria2.conf</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aria2.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/aria2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.aria2.settings"></a><a class="term" href="options.html#opt-programs.aria2.settings"><code class="option">programs.aria2.settings</code></a></span></dt><dd><p>Options to add to <code class="filename">aria2.conf</code> file.
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">aria2c</span>(1)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or floating point number or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
listen-port = 60000;
|
||
dht-listen-port = 60000;
|
||
seed-ratio = 1.0;
|
||
max-upload-limit = "50K";
|
||
ftp-pasv = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/aria2.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/aria2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.astroid.enable"></a><a class="term" href="options.html#opt-programs.astroid.enable"><code class="option">programs.astroid.enable</code></a></span></dt><dd><p>Whether to enable Astroid.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.astroid.externalEditor"></a><a class="term" href="options.html#opt-programs.astroid.externalEditor"><code class="option">programs.astroid.externalEditor</code></a></span></dt><dd><p>You can use <code class="code">%1</code>, <code class="code">%2</code>, and
|
||
<code class="code">%3</code> to refer respectively to:
|
||
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>file name</p></li><li class="listitem"><p>server name</p></li><li class="listitem"><p>socket ID</p></li></ol></div><p>
|
||
See <a class="link" href="https://github.com/astroidmail/astroid/wiki/Customizing-editor" target="_top">https://github.com/astroidmail/astroid/wiki/Customizing-editor</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"nvim-qt -- -c 'set ft=mail' '+set fileencoding=utf-8' '+set ff=unix' '+set enc=utf-8' '+set fo+=w' %1"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.astroid.extraConfig"></a><a class="term" href="options.html#opt-programs.astroid.extraConfig"><code class="option">programs.astroid.extraConfig</code></a></span></dt><dd><p>JSON config that will override the default Astroid configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
poll.interval = 0;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.astroid.pollScript"></a><a class="term" href="options.html#opt-programs.astroid.pollScript"><code class="option">programs.astroid.pollScript</code></a></span></dt><dd><p>Script to run to fetch/update mails.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"mbsync gmail"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/astroid.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/astroid.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.atuin.enable"></a><a class="term" href="options.html#opt-programs.atuin.enable"><code class="option">programs.atuin.enable</code></a></span></dt><dd><p>Whether to enable atuin.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/atuin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/atuin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.atuin.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.atuin.enableBashIntegration"><code class="option">programs.atuin.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Atuin's Bash integration. This will bind
|
||
<code class="literal">ctrl-r</code> to open the Atuin history.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/atuin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/atuin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.atuin.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.atuin.enableFishIntegration"><code class="option">programs.atuin.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Atuin's Fish integration.
|
||
</p><p>
|
||
If enabled, this will bind the up-arrow key to open the Atuin history.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/atuin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/atuin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.atuin.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.atuin.enableZshIntegration"><code class="option">programs.atuin.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Atuin's Zsh integration.
|
||
</p><p>
|
||
If enabled, this will bind <code class="literal">ctrl-r</code> and the up-arrow
|
||
key to open the Atuin history.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/atuin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/atuin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.atuin.package"></a><a class="term" href="options.html#opt-programs.atuin.package"><code class="option">programs.atuin.package</code></a></span></dt><dd><p>The package to use for atuin.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.atuin</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/atuin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/atuin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.atuin.settings"></a><a class="term" href="options.html#opt-programs.atuin.settings"><code class="option">programs.atuin.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/atuin/config.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/ellie/atuin/blob/main/docs/config.md" target="_top">https://github.com/ellie/atuin/blob/main/docs/config.md</a> for the full list
|
||
of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> Atuin configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
auto_sync = true;
|
||
sync_frequency = "5m";
|
||
sync_address = "https://api.atuin.sh";
|
||
search_mode = "prefix";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/atuin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/atuin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autojump.enable"></a><a class="term" href="options.html#opt-programs.autojump.enable"><code class="option">programs.autojump.enable</code></a></span></dt><dd><p>Whether to enable autojump.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autojump.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autojump.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autojump.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.autojump.enableBashIntegration"><code class="option">programs.autojump.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autojump.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autojump.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autojump.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.autojump.enableFishIntegration"><code class="option">programs.autojump.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autojump.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autojump.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autojump.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.autojump.enableZshIntegration"><code class="option">programs.autojump.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autojump.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autojump.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.enable"></a><a class="term" href="options.html#opt-programs.autorandr.enable"><code class="option">programs.autorandr.enable</code></a></span></dt><dd><p>Whether to enable Autorandr.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.hooks"></a><a class="term" href="options.html#opt-programs.autorandr.hooks"><code class="option">programs.autorandr.hooks</code></a></span></dt><dd><p>Global hook scripts</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
postswitch = {
|
||
"notify-i3" = "${pkgs.i3}/bin/i3-msg restart";
|
||
"change-background" = readFile ./change-background.sh;
|
||
"change-dpi" = ''
|
||
case "$AUTORANDR_CURRENT_PROFILE" in
|
||
default)
|
||
DPI=120
|
||
;;
|
||
home)
|
||
DPI=192
|
||
;;
|
||
work)
|
||
DPI=144
|
||
;;
|
||
*)
|
||
echo "Unknown profle: $AUTORANDR_CURRENT_PROFILE"
|
||
exit 1
|
||
esac
|
||
|
||
echo "Xft.dpi: $DPI" | ${pkgs.xorg.xrdb}/bin/xrdb -merge
|
||
''
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.hooks.postswitch"></a><a class="term" href="options.html#opt-programs.autorandr.hooks.postswitch"><code class="option">programs.autorandr.hooks.postswitch</code></a></span></dt><dd><p>Postswitch hook executed after mode switch.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.hooks.predetect"></a><a class="term" href="options.html#opt-programs.autorandr.hooks.predetect"><code class="option">programs.autorandr.hooks.predetect</code></a></span></dt><dd><p>Predetect hook executed before autorandr attempts to run xrandr.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.hooks.preswitch"></a><a class="term" href="options.html#opt-programs.autorandr.hooks.preswitch"><code class="option">programs.autorandr.hooks.preswitch</code></a></span></dt><dd><p>Preswitch hook executed before mode switch.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles"></a><a class="term" href="options.html#opt-programs.autorandr.profiles"><code class="option">programs.autorandr.profiles</code></a></span></dt><dd><p>Autorandr profiles specification.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"work" = {
|
||
fingerprint = {
|
||
eDP1 = "<EDID>";
|
||
DP1 = "<EDID>";
|
||
};
|
||
config = {
|
||
eDP1.enable = false;
|
||
DP1 = {
|
||
enable = true;
|
||
crtc = 0;
|
||
primary = true;
|
||
position = "0x0";
|
||
mode = "3840x2160";
|
||
gamma = "1.0:0.909:0.833";
|
||
rate = "60.00";
|
||
rotate = "left";
|
||
};
|
||
};
|
||
hooks.postswitch = readFile ./work-postswitch.sh;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config"><code class="option">programs.autorandr.profiles.<name>.config</code></a></span></dt><dd><p>Per output profile configuration.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.enable"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.enable"><code class="option">programs.autorandr.profiles.<name>.config.<name>.enable</code></a></span></dt><dd><p>Whether to enable the output.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.crtc"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.crtc"><code class="option">programs.autorandr.profiles.<name>.config.<name>.crtc</code></a></span></dt><dd><p>Output video display controller.</p><p><span class="emphasis"><em>Type:</em></span> null or unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.dpi"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.dpi"><code class="option">programs.autorandr.profiles.<name>.config.<name>.dpi</code></a></span></dt><dd><p>Output DPI configuration.</p><p><span class="emphasis"><em>Type:</em></span> null or positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">96</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.filter"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.filter"><code class="option">programs.autorandr.profiles.<name>.config.<name>.filter</code></a></span></dt><dd><p>Interpolation method to be used for scaling the output.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "bilinear", "nearest"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"nearest"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.gamma"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.gamma"><code class="option">programs.autorandr.profiles.<name>.config.<name>.gamma</code></a></span></dt><dd><p>Output gamma configuration.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"1.0:0.909:0.833"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.mode"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.mode"><code class="option">programs.autorandr.profiles.<name>.config.<name>.mode</code></a></span></dt><dd><p>Output resolution.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"3840x2160"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.position"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.position"><code class="option">programs.autorandr.profiles.<name>.config.<name>.position</code></a></span></dt><dd><p>Output position</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"5760x0"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.primary"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.primary"><code class="option">programs.autorandr.profiles.<name>.config.<name>.primary</code></a></span></dt><dd><p>Whether output should be marked as primary</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.rate"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.rate"><code class="option">programs.autorandr.profiles.<name>.config.<name>.rate</code></a></span></dt><dd><p>Output framerate.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"60.00"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.rotate"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.rotate"><code class="option">programs.autorandr.profiles.<name>.config.<name>.rotate</code></a></span></dt><dd><p>Output rotate configuration.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "normal", "left", "right", "inverted"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"left"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.scale"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.scale"><code class="option">programs.autorandr.profiles.<name>.config.<name>.scale</code></a></span></dt><dd><p>Output scale configuration.
|
||
</p><p>
|
||
Either configure by pixels or a scaling factor. When using pixel method the
|
||
<span class="citerefentry"><span class="refentrytitle">xrandr</span>(1)</span>
|
||
option
|
||
<em class="parameter"><code>--scale-from</code></em>
|
||
will be used; when using factor method the option
|
||
<em class="parameter"><code>--scale</code></em>
|
||
will be used.
|
||
</p><p>
|
||
This option is a shortcut version of the transform option and they are mutually
|
||
exclusive.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
x = 1.25;
|
||
y = 1.25;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.scale.method"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.scale.method"><code class="option">programs.autorandr.profiles.<name>.config.<name>.scale.method</code></a></span></dt><dd><p>Output scaling method.</p><p><span class="emphasis"><em>Type:</em></span> one of "factor", "pixel"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"factor"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"pixel"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.scale.x"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.scale.x"><code class="option">programs.autorandr.profiles.<name>.config.<name>.scale.x</code></a></span></dt><dd><p>Horizontal scaling factor/pixels.</p><p><span class="emphasis"><em>Type:</em></span> floating point number or positive integer, meaning >0</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.scale.y"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.scale.y"><code class="option">programs.autorandr.profiles.<name>.config.<name>.scale.y</code></a></span></dt><dd><p>Vertical scaling factor/pixels.</p><p><span class="emphasis"><em>Type:</em></span> floating point number or positive integer, meaning >0</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.config._name_.transform"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.config._name_.transform"><code class="option">programs.autorandr.profiles.<name>.config.<name>.transform</code></a></span></dt><dd><p>Refer to
|
||
<span class="citerefentry"><span class="refentrytitle">xrandr</span>(1)</span>
|
||
for the documentation of the transform matrix.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or 3×3 matrix of floating point numbers</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
[ 0.6 0.0 0.0 ]
|
||
[ 0.0 0.6 0.0 ]
|
||
[ 0.0 0.0 1.0 ]
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.fingerprint"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.fingerprint"><code class="option">programs.autorandr.profiles.<name>.fingerprint</code></a></span></dt><dd><p>Output name to EDID mapping.
|
||
Use <code class="code">autorandr --fingerprint</code> to get current setup values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.hooks"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.hooks"><code class="option">programs.autorandr.profiles.<name>.hooks</code></a></span></dt><dd><p>Profile hook scripts.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.hooks.postswitch"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.hooks.postswitch"><code class="option">programs.autorandr.profiles.<name>.hooks.postswitch</code></a></span></dt><dd><p>Postswitch hook executed after mode switch.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.hooks.predetect"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.hooks.predetect"><code class="option">programs.autorandr.profiles.<name>.hooks.predetect</code></a></span></dt><dd><p>Predetect hook executed before autorandr attempts to run xrandr.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.autorandr.profiles._name_.hooks.preswitch"></a><a class="term" href="options.html#opt-programs.autorandr.profiles._name_.hooks.preswitch"><code class="option">programs.autorandr.profiles.<name>.hooks.preswitch</code></a></span></dt><dd><p>Preswitch hook executed before mode switch.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/autorandr.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/autorandr.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.enable"></a><a class="term" href="options.html#opt-programs.bash.enable"><code class="option">programs.bash.enable</code></a></span></dt><dd><p>Whether to enable GNU Bourne-Again SHell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.enableVteIntegration"></a><a class="term" href="options.html#opt-programs.bash.enableVteIntegration"><code class="option">programs.bash.enableVteIntegration</code></a></span></dt><dd><p>Whether to enable integration with terminals using the VTE
|
||
library. This will let the terminal track the current working
|
||
directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/vte.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/vte.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.bashrcExtra"></a><a class="term" href="options.html#opt-programs.bash.bashrcExtra"><code class="option">programs.bash.bashrcExtra</code></a></span></dt><dd><p>Extra commands that should be placed in <code class="filename">~/.bashrc</code>.
|
||
Note that these commands will be run even in non-interactive shells.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.historyControl"></a><a class="term" href="options.html#opt-programs.bash.historyControl"><code class="option">programs.bash.historyControl</code></a></span></dt><dd><p>Controlling how commands are saved on the history list.</p><p><span class="emphasis"><em>Type:</em></span> list of one of "erasedups", "ignoredups", "ignorespace"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.historyFile"></a><a class="term" href="options.html#opt-programs.bash.historyFile"><code class="option">programs.bash.historyFile</code></a></span></dt><dd><p>Location of the bash history file.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.historyFileSize"></a><a class="term" href="options.html#opt-programs.bash.historyFileSize"><code class="option">programs.bash.historyFileSize</code></a></span></dt><dd><p>Number of history lines to keep on file.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">100000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.historyIgnore"></a><a class="term" href="options.html#opt-programs.bash.historyIgnore"><code class="option">programs.bash.historyIgnore</code></a></span></dt><dd><p>List of commands that should not be saved to the history list.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"ls" "cd" "exit"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.historySize"></a><a class="term" href="options.html#opt-programs.bash.historySize"><code class="option">programs.bash.historySize</code></a></span></dt><dd><p>Number of history lines to keep in memory.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.initExtra"></a><a class="term" href="options.html#opt-programs.bash.initExtra"><code class="option">programs.bash.initExtra</code></a></span></dt><dd><p>Extra commands that should be run when initializing an
|
||
interactive shell.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.logoutExtra"></a><a class="term" href="options.html#opt-programs.bash.logoutExtra"><code class="option">programs.bash.logoutExtra</code></a></span></dt><dd><p>Extra commands that should be run when logging out of an
|
||
interactive shell.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.profileExtra"></a><a class="term" href="options.html#opt-programs.bash.profileExtra"><code class="option">programs.bash.profileExtra</code></a></span></dt><dd><p>Extra commands that should be run when initializing a login
|
||
shell.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.sessionVariables"></a><a class="term" href="options.html#opt-programs.bash.sessionVariables"><code class="option">programs.bash.sessionVariables</code></a></span></dt><dd><p>Environment variables that will be set for the Bash session.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
MAILCHECK = 30;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.shellAliases"></a><a class="term" href="options.html#opt-programs.bash.shellAliases"><code class="option">programs.bash.shellAliases</code></a></span></dt><dd><p>An attribute set that maps aliases (the top level attribute names in
|
||
this option) to command strings or directly to build outputs.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
ll = "ls -l";
|
||
".." = "cd ..";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bash.shellOptions"></a><a class="term" href="options.html#opt-programs.bash.shellOptions"><code class="option">programs.bash.shellOptions</code></a></span></dt><dd><p>Shell options to set. Prefix an option with
|
||
<span class="quote">“<span class="quote"><code class="literal">-</code></span>”</span> to unset.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"histappend" "checkwinsize" "extglob" "globstar" "checkjobs"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"extglob" "-cdspell"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bash.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bash.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bat.enable"></a><a class="term" href="options.html#opt-programs.bat.enable"><code class="option">programs.bat.enable</code></a></span></dt><dd><p>Whether to enable bat, a cat clone with wings.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bat.config"></a><a class="term" href="options.html#opt-programs.bat.config"><code class="option">programs.bat.config</code></a></span></dt><dd><p>Bat configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
map-syntax =
|
||
[
|
||
"*.jenkinsfile:Groovy" "*.props:Java Properties"
|
||
]
|
||
; pager = "less -FR"; theme = "TwoDark";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bat.themes"></a><a class="term" href="options.html#opt-programs.bat.themes"><code class="option">programs.bat.themes</code></a></span></dt><dd><p>Additional themes to provide.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
dracula = builtins.readFile (pkgs.fetchFromGitHub {
|
||
owner = "dracula";
|
||
repo = "sublime"; # Bat uses sublime syntax for its themes
|
||
rev = "26c57ec282abcaa76e57e055f38432bd827ac34e";
|
||
sha256 = "019hfl4zbn4vm4154hh3bwk6hm7bdxbr1hdww83nabxwjn99ndhv";
|
||
} + "/Dracula.tmTheme");
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.beets.enable"></a><a class="term" href="options.html#opt-programs.beets.enable"><code class="option">programs.beets.enable</code></a></span></dt><dd><p>Whether to enable the beets music library manager. This
|
||
defaults to <code class="literal">false</code> for state
|
||
version ≥ 19.03. For earlier versions beets is enabled if
|
||
<code class="option">programs.beets.settings</code> is non-empty.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"false"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/beets.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/beets.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.beets.package"></a><a class="term" href="options.html#opt-programs.beets.package"><code class="option">programs.beets.package</code></a></span></dt><dd><p>The <code class="literal">beets</code> package to use.
|
||
Can be used to specify extensions.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.beets</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">(pkgs.beets.override { enableCheck = true; })</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/beets.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/beets.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.beets.settings"></a><a class="term" href="options.html#opt-programs.beets.settings"><code class="option">programs.beets.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/beets/config.yaml</code>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/beets.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/beets.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bottom.enable"></a><a class="term" href="options.html#opt-programs.bottom.enable"><code class="option">programs.bottom.enable</code></a></span></dt><dd><p>Whether to enable bottom, a cross-platform graphical process/system monitor with a
|
||
customizable interface.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bottom.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bottom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bottom.package"></a><a class="term" href="options.html#opt-programs.bottom.package"><code class="option">programs.bottom.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>bottom</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.bottom</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bottom.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bottom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bottom.settings"></a><a class="term" href="options.html#opt-programs.bottom.settings"><code class="option">programs.bottom.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/bottom/bottom.toml</code> on Linux or
|
||
<code class="filename">$HOME/Library/Application Support/bottom/bottom.toml</code> on Darwin.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml" target="_top">https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml</a>
|
||
for the default configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
flags = {
|
||
avg_cpu = true;
|
||
temperature_type = "c";
|
||
};
|
||
|
||
colors = {
|
||
low_battery_color = "red";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bottom.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/bottom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.enable"></a><a class="term" href="options.html#opt-programs.broot.enable"><code class="option">programs.broot.enable</code></a></span></dt><dd><p>Whether to enable Broot, a better way to navigate directories.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.broot.enableBashIntegration"><code class="option">programs.broot.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.broot.enableFishIntegration"><code class="option">programs.broot.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.broot.enableZshIntegration"><code class="option">programs.broot.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.package"></a><a class="term" href="options.html#opt-programs.broot.package"><code class="option">programs.broot.package</code></a></span></dt><dd><p>Package providing broot</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.broot</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.modal"></a><a class="term" href="options.html#opt-programs.broot.modal"><code class="option">programs.broot.modal</code></a></span></dt><dd><p>Whether to enable modal (vim) mode.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.skin"></a><a class="term" href="options.html#opt-programs.broot.skin"><code class="option">programs.broot.skin</code></a></span></dt><dd><p>Color configuration.
|
||
</p><p>
|
||
Complete list of keys (expected to change before the v1 of broot):
|
||
|
||
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">char_match</code></p></li><li class="listitem"><p><code class="literal">code</code></p></li><li class="listitem"><p><code class="literal">directory</code></p></li><li class="listitem"><p><code class="literal">exe</code></p></li><li class="listitem"><p><code class="literal">file</code></p></li><li class="listitem"><p><code class="literal">file_error</code></p></li><li class="listitem"><p><code class="literal">flag_label</code></p></li><li class="listitem"><p><code class="literal">flag_value</code></p></li><li class="listitem"><p><code class="literal">input</code></p></li><li class="listitem"><p><code class="literal">link</code></p></li><li class="listitem"><p><code class="literal">permissions</code></p></li><li class="listitem"><p><code class="literal">selected_line</code></p></li><li class="listitem"><p><code class="literal">size_bar_full</code></p></li><li class="listitem"><p><code class="literal">size_bar_void</code></p></li><li class="listitem"><p><code class="literal">size_text</code></p></li><li class="listitem"><p><code class="literal">spinner</code></p></li><li class="listitem"><p><code class="literal">status_error</code></p></li><li class="listitem"><p><code class="literal">status_normal</code></p></li><li class="listitem"><p><code class="literal">table_border</code></p></li><li class="listitem"><p><code class="literal">tree</code></p></li><li class="listitem"><p><code class="literal">unlisted</code></p></li></ul></div><p>
|
||
Add <code class="literal">_fg</code> for a foreground color and
|
||
<code class="literal">_bg</code> for a background colors.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
status_normal_fg = "grayscale(18)";
|
||
status_normal_bg = "grayscale(3)";
|
||
status_error_fg = "red";
|
||
status_error_bg = "yellow";
|
||
tree_fg = "red";
|
||
selected_line_bg = "grayscale(7)";
|
||
permissions_fg = "grayscale(12)";
|
||
size_bar_full_bg = "red";
|
||
size_bar_void_bg = "black";
|
||
directory_fg = "lightyellow";
|
||
input_fg = "cyan";
|
||
flag_value_fg = "lightyellow";
|
||
table_border_fg = "red";
|
||
code_fg = "lightyellow";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.verbs"></a><a class="term" href="options.html#opt-programs.broot.verbs"><code class="option">programs.broot.verbs</code></a></span></dt><dd><p>Define new verbs. For more information, see
|
||
<a class="link" href="https://dystroy.org/broot/documentation/configuration/#verb-definition-attributes" target="_top">https://dystroy.org/broot/documentation/configuration/#verb-definition-attributes</a>.
|
||
</p><p>
|
||
The possible attributes are:
|
||
</p><p>
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">invocation</code> (optional)</span></dt><dd><p>how the verb is called by the user, with placeholders for arguments</p></dd><dt><span class="term"><code class="literal">execution</code> (mandatory)</span></dt><dd><p>how the verb is executed</p></dd><dt><span class="term"><code class="literal">key</code> (optional)</span></dt><dd><p>a keyboard key triggering execution</p></dd><dt><span class="term"><code class="literal">shortcut</code> (optional)</span></dt><dd><p>an alternate way to call the verb (without
|
||
the arguments part)</p></dd><dt><span class="term"><code class="literal">leave_broot</code> (optional)</span></dt><dd><p>whether to quit broot on execution
|
||
(default: <code class="literal">true</code>)</p></dd><dt><span class="term"><code class="literal">from_shell</code> (optional)</span></dt><dd><p>whether the verb must be executed from the
|
||
parent shell (default:
|
||
<code class="literal">false</code>)</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of attribute set of boolean or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
execution = ":parent"; invocation = "p";
|
||
}
|
||
|
||
{
|
||
execution = "$EDITOR {file}"; invocation = "edit"; shortcut = "e";
|
||
}
|
||
|
||
{
|
||
execution = "$EDITOR {directory}/{subpath}"; invocation = "create {subpath}";
|
||
}
|
||
|
||
{
|
||
execution = "less {file}"; invocation = "view";
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ invocation = "p"; execution = ":parent"; }
|
||
{ invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
|
||
{ invocation = "create {subpath}"; execution = "$EDITOR {directory}/{subpath}"; }
|
||
{ invocation = "view"; execution = "less {file}"; }
|
||
{
|
||
invocation = "blop {name}\\.{type}";
|
||
execution = "/bin/mkdir {parent}/{type} && /usr/bin/nvim {parent}/{type}/{name}.{type}";
|
||
from_shell = true;
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/broot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.browserpass.enable"></a><a class="term" href="options.html#opt-programs.browserpass.enable"><code class="option">programs.browserpass.enable</code></a></span></dt><dd><p>Whether to enable the browserpass extension host application.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/browserpass.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/browserpass.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.browserpass.browsers"></a><a class="term" href="options.html#opt-programs.browserpass.browsers"><code class="option">programs.browserpass.browsers</code></a></span></dt><dd><p>Which browsers to install browserpass for</p><p><span class="emphasis"><em>Type:</em></span> list of one of "brave", "chrome", "chromium", "firefox", "vivaldi"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"brave" "chrome" "chromium" "firefox" "vivaldi"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"firefox"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/browserpass.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/browserpass.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.enable"></a><a class="term" href="options.html#opt-programs.chromium.enable"><code class="option">programs.chromium.enable</code></a></span></dt><dd><p>Whether to enable Chromium.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.package"></a><a class="term" href="options.html#opt-programs.chromium.package"><code class="option">programs.chromium.package</code></a></span></dt><dd><p>The Chromium package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.chromium</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.commandLineArgs"></a><a class="term" href="options.html#opt-programs.chromium.commandLineArgs"><code class="option">programs.chromium.commandLineArgs</code></a></span></dt><dd><p>List of command-line arguments to be passed to Chromium.
|
||
</p><p>
|
||
Note this option does not have any effect when using a
|
||
custom package for <code class="option">programs.chromium.package</code>.
|
||
</p><p>
|
||
For a list of common switches, see
|
||
<a class="link" href="https://chromium.googlesource.com/chromium/src/+/refs/heads/main/chrome/common/chrome_switches.cc" target="_top">Chrome switches</a>.
|
||
</p><p>
|
||
To search switches for other components, see
|
||
<a class="link" href="https://source.chromium.org/search?q=file:switches.cc&ss=chromium%2Fchromium%2Fsrc" target="_top">Chromium codesearch</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--enable-logging=stderr" "--ignore-gpu-blocklist"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.extensions"></a><a class="term" href="options.html#opt-programs.chromium.extensions"><code class="option">programs.chromium.extensions</code></a></span></dt><dd><p>List of Chromium extensions to install.
|
||
To find the extension ID, check its URL on the
|
||
<a class="link" href="https://chrome.google.com/webstore/category/extensions" target="_top">Chrome Web Store</a>.
|
||
</p><p>
|
||
To install extensions outside of the Chrome Web Store set
|
||
<code class="literal">updateUrl</code> or <code class="literal">crxPath</code> and
|
||
<code class="literal">version</code> as explained in the
|
||
<a class="link" href="https://developer.chrome.com/docs/extensions/mv2/external_extensions" target="_top">Chrome
|
||
documentation</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule or string convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin
|
||
{
|
||
id = "dcpihecpambacapedldabdbpakmachpb";
|
||
updateUrl = "https://raw.githubusercontent.com/iamadamdev/bypass-paywalls-chrome/master/updates.xml";
|
||
}
|
||
{
|
||
id = "aaaaaaaaaabbbbbbbbbbcccccccccc";
|
||
crxPath = "/home/share/extension.crx";
|
||
version = "1.0";
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.extensions._.crxPath"></a><a class="term" href="options.html#opt-programs.chromium.extensions._.crxPath"><code class="option">programs.chromium.extensions.*.crxPath</code></a></span></dt><dd><p>Path to the extension's crx file. Linux only.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.extensions._.id"></a><a class="term" href="options.html#opt-programs.chromium.extensions._.id"><code class="option">programs.chromium.extensions.*.id</code></a></span></dt><dd><p>The extension's ID from the Chome Web Store url or the unpacked crx.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string matching the pattern [a-zA-Z]{32}</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.extensions._.updateUrl"></a><a class="term" href="options.html#opt-programs.chromium.extensions._.updateUrl"><code class="option">programs.chromium.extensions.*.updateUrl</code></a></span></dt><dd><p>URL of the extension's update manifest XML file. Linux only.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"https://clients2.google.com/service/update2/crx"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.chromium.extensions._.version"></a><a class="term" href="options.html#opt-programs.chromium.extensions._.version"><code class="option">programs.chromium.extensions.*.version</code></a></span></dt><dd><p>The extension's version, required for local installation. Linux only.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/chromium.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/chromium.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.command-not-found.enable"></a><a class="term" href="options.html#opt-programs.command-not-found.enable"><code class="option">programs.command-not-found.enable</code></a></span></dt><dd><p>Whether to enable command-not-found hook for interactive shell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/command-not-found/command-not-found.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/command-not-found/command-not-found.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.command-not-found.dbPath"></a><a class="term" href="options.html#opt-programs.command-not-found.dbPath"><code class="option">programs.command-not-found.dbPath</code></a></span></dt><dd><p>Absolute path to <code class="filename">programs.sqlite</code>. By
|
||
default this file will be provided by your channel
|
||
(nixexprs.tar.xz).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/command-not-found/command-not-found.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/command-not-found/command-not-found.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.dircolors.enable"></a><a class="term" href="options.html#opt-programs.dircolors.enable"><code class="option">programs.dircolors.enable</code></a></span></dt><dd><p>Whether to manage <code class="filename">.dir_colors</code>
|
||
and set <code class="code">LS_COLORS</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/dircolors.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/dircolors.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.dircolors.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.dircolors.enableBashIntegration"><code class="option">programs.dircolors.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/dircolors.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/dircolors.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.dircolors.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.dircolors.enableFishIntegration"><code class="option">programs.dircolors.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/dircolors.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/dircolors.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.dircolors.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.dircolors.enableZshIntegration"><code class="option">programs.dircolors.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/dircolors.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/dircolors.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.dircolors.extraConfig"></a><a class="term" href="options.html#opt-programs.dircolors.extraConfig"><code class="option">programs.dircolors.extraConfig</code></a></span></dt><dd><p>Extra lines added to <code class="filename">.dir_colors</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/dircolors.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/dircolors.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.dircolors.settings"></a><a class="term" href="options.html#opt-programs.dircolors.settings"><code class="option">programs.dircolors.settings</code></a></span></dt><dd><p>Options to add to <code class="filename">.dir_colors</code> file.
|
||
See <span class="command"><strong>dircolors --print-database</strong></span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
OTHER_WRITABLE = "30;46";
|
||
".sh" = "01;32";
|
||
".csh" = "01;32";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/dircolors.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/dircolors.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.enable"></a><a class="term" href="options.html#opt-programs.direnv.enable"><code class="option">programs.direnv.enable</code></a></span></dt><dd><p>Whether to enable direnv, the environment switcher.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.direnv.enableBashIntegration"><code class="option">programs.direnv.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.direnv.enableFishIntegration"><code class="option">programs.direnv.enableFishIntegration</code></a></span></dt><dd><p>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
|
||
</p><pre class="programlisting nix">
|
||
environment.pathsToLink = [ "/share/fish" ];
|
||
</pre><p>
|
||
to the system configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.direnv.enableZshIntegration"><code class="option">programs.direnv.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.config"></a><a class="term" href="options.html#opt-programs.direnv.config"><code class="option">programs.direnv.config</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/direnv/config.toml</code>.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">direnv.toml</span>(1)</span>.
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.nix-direnv.enable"></a><a class="term" href="options.html#opt-programs.direnv.nix-direnv.enable"><code class="option">programs.direnv.nix-direnv.enable</code></a></span></dt><dd><p>Whether to enable <a class="link" href="https://github.com/nix-community/nix-direnv" target="_top">nix-direnv</a>,
|
||
a fast, persistent use_nix implementation for direnv.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.direnv.stdlib"></a><a class="term" href="options.html#opt-programs.direnv.stdlib"><code class="option">programs.direnv.stdlib</code></a></span></dt><dd><p>Custom stdlib written to
|
||
<code class="filename">$XDG_CONFIG_HOME/direnv/direnvrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/direnv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/direnv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eclipse.enable"></a><a class="term" href="options.html#opt-programs.eclipse.enable"><code class="option">programs.eclipse.enable</code></a></span></dt><dd><p>Whether to enable Eclipse.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eclipse.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eclipse.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eclipse.enableLombok"></a><a class="term" href="options.html#opt-programs.eclipse.enableLombok"><code class="option">programs.eclipse.enableLombok</code></a></span></dt><dd><p>Whether to enable the Lombok Java Agent in Eclipse. This is
|
||
necessary to use the Lombok class annotations.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eclipse.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eclipse.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eclipse.package"></a><a class="term" href="options.html#opt-programs.eclipse.package"><code class="option">programs.eclipse.package</code></a></span></dt><dd><p>The Eclipse package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.eclipses.eclipse-platform</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.eclipses.eclipse-java</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eclipse.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eclipse.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eclipse.jvmArgs"></a><a class="term" href="options.html#opt-programs.eclipse.jvmArgs"><code class="option">programs.eclipse.jvmArgs</code></a></span></dt><dd><p>JVM arguments to use for the Eclipse process.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eclipse.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eclipse.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eclipse.plugins"></a><a class="term" href="options.html#opt-programs.eclipse.plugins"><code class="option">programs.eclipse.plugins</code></a></span></dt><dd><p>Plugins that should be added to Eclipse.</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eclipse.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eclipse.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.emacs.enable"></a><a class="term" href="options.html#opt-programs.emacs.enable"><code class="option">programs.emacs.enable</code></a></span></dt><dd><p>Whether to enable Emacs.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.emacs.package"></a><a class="term" href="options.html#opt-programs.emacs.package"><code class="option">programs.emacs.package</code></a></span></dt><dd><p>The Emacs package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.emacs</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.emacs25-nox</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.emacs.extraConfig"></a><a class="term" href="options.html#opt-programs.emacs.extraConfig"><code class="option">programs.emacs.extraConfig</code></a></span></dt><dd><p>Configuration to include in the Emacs default init file. See
|
||
<a class="link" href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Init-File.html" target="_top">https://www.gnu.org/software/emacs/manual/html_node/elisp/Init-File.html</a>
|
||
for more.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
(setq standard-indent 2)
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.emacs.extraPackages"></a><a class="term" href="options.html#opt-programs.emacs.extraPackages"><code class="option">programs.emacs.extraPackages</code></a></span></dt><dd><p>Extra packages available to Emacs. To get a list of
|
||
available packages run:
|
||
<span class="command"><strong>nix-env -f '<nixpkgs>' -qaP -A emacsPackages</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> Function that takes an attribute set and returns a list containing a selection of the values of the input set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"epkgs: []"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">epkgs: [ epkgs.emms epkgs.magit ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.emacs.overrides"></a><a class="term" href="options.html#opt-programs.emacs.overrides"><code class="option">programs.emacs.overrides</code></a></span></dt><dd><p>Allows overriding packages within the Emacs package set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> An overlay function, takes self and super and returns an attribute set overriding the desired attributes.</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"self: super: {}"</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">self: super: rec {
|
||
haskell-mode = self.melpaPackages.haskell-mode;
|
||
# ...
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eww.enable"></a><a class="term" href="options.html#opt-programs.eww.enable"><code class="option">programs.eww.enable</code></a></span></dt><dd><p>Whether to enable eww.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eww.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eww.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eww.package"></a><a class="term" href="options.html#opt-programs.eww.package"><code class="option">programs.eww.package</code></a></span></dt><dd><p>The eww package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.eww</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.eww</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eww.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eww.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.eww.configDir"></a><a class="term" href="options.html#opt-programs.eww.configDir"><code class="option">programs.eww.configDir</code></a></span></dt><dd><p>The directory that gets symlinked to
|
||
<code class="filename">$XDG_CONFIG_HOME/eww</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">./eww-config-dir</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/eww.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/eww.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.exa.enable"></a><a class="term" href="options.html#opt-programs.exa.enable"><code class="option">programs.exa.enable</code></a></span></dt><dd><p>Whether to enable exa, a modern replacement for <span class="command"><strong>ls</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/exa.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/exa.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.exa.enableAliases"></a><a class="term" href="options.html#opt-programs.exa.enableAliases"><code class="option">programs.exa.enableAliases</code></a></span></dt><dd><p>Whether to enable recommended exa aliases.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/exa.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/exa.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.feh.enable"></a><a class="term" href="options.html#opt-programs.feh.enable"><code class="option">programs.feh.enable</code></a></span></dt><dd><p>Whether to enable feh - a fast and light image viewer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/feh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/feh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.feh.buttons"></a><a class="term" href="options.html#opt-programs.feh.buttons"><code class="option">programs.feh.buttons</code></a></span></dt><dd><p>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 <a class="link" href="https://man.finalrewind.org/1/feh/#x425554544f4e53" target="_top">https://man.finalrewind.org/1/feh/#x425554544f4e53</a> for
|
||
default bindings and available commands.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string or signed integer or list of string or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
prev_img =
|
||
[
|
||
3 "C-3"
|
||
]
|
||
; zoom_in = 4; zoom_out = "C-4";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/feh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/feh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.feh.keybindings"></a><a class="term" href="options.html#opt-programs.feh.keybindings"><code class="option">programs.feh.keybindings</code></a></span></dt><dd><p>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 <a class="link" href="https://man.finalrewind.org/1/feh/#x4b455953" target="_top">https://man.finalrewind.org/1/feh/#x4b455953</a> for
|
||
default bindings and available commands.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
prev_img =
|
||
[
|
||
"h" "Left"
|
||
]
|
||
; zoom_in = "plus"; zoom_out = "minus";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/feh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/feh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.enable"></a><a class="term" href="options.html#opt-programs.firefox.enable"><code class="option">programs.firefox.enable</code></a></span></dt><dd><p>Whether to enable Firefox.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.enableGnomeExtensions"></a><a class="term" href="options.html#opt-programs.firefox.enableGnomeExtensions"><code class="option">programs.firefox.enableGnomeExtensions</code></a></span></dt><dd><p>Whether to enable the GNOME Shell native host connector. Note, you
|
||
also need to set the NixOS option
|
||
<code class="literal">services.gnome3.chrome-gnome-shell.enable</code> to
|
||
<code class="literal">true</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.package"></a><a class="term" href="options.html#opt-programs.firefox.package"><code class="option">programs.firefox.package</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.firefox</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.firefox.override {
|
||
# See nixpkgs' firefox/wrapper.nix to check which options you can use
|
||
cfg = {
|
||
# Gnome shell native connector
|
||
enableGnomeExtensions = true;
|
||
# Tridactyl native connector
|
||
enableTridactylNative = true;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.extensions"></a><a class="term" href="options.html#opt-programs.firefox.extensions"><code class="option">programs.firefox.extensions</code></a></span></dt><dd><p>List of Firefox add-on packages to install. Some
|
||
pre-packaged add-ons are accessible from NUR,
|
||
<a class="link" href="https://github.com/nix-community/NUR" target="_top">https://github.com/nix-community/NUR</a>.
|
||
Once you have NUR installed run
|
||
|
||
</p><pre class="screen console">
|
||
<code class="prompt">$</code> <strong class="userinput"><code>nix-env -f '<nixpkgs>' -qaP -A nur.repos.rycee.firefox-addons</code></strong>
|
||
</pre><p>
|
||
|
||
to list the available Firefox add-ons.
|
||
|
||
</p><p>
|
||
|
||
Note that it is necessary to manually enable these
|
||
extensions inside Firefox after the first installation.
|
||
|
||
</p><p>
|
||
|
||
Extensions listed here will only be available in Firefox
|
||
profiles managed through the
|
||
<a class="link" href="options.html#opt-programs.firefox.profiles">programs.firefox.profiles</a>
|
||
option. This is due to recent changes in the way Firefox
|
||
handles extension side-loading.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">with pkgs.nur.repos.rycee.firefox-addons; [
|
||
https-everywhere
|
||
privacy-badger
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles"></a><a class="term" href="options.html#opt-programs.firefox.profiles"><code class="option">programs.firefox.profiles</code></a></span></dt><dd><p>Attribute set of Firefox profiles.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.bookmarks"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.bookmarks"><code class="option">programs.firefox.profiles.<name>.bookmarks</code></a></span></dt><dd><p>Preloaded bookmarks. Note, this may silently overwrite any
|
||
previously existing bookmarks!
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
wikipedia = {
|
||
keyword = "wiki";
|
||
url = "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
|
||
};
|
||
"kernel.org" = {
|
||
url = "https://www.kernel.org";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.bookmarks._name_.keyword"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.bookmarks._name_.keyword"><code class="option">programs.firefox.profiles.<name>.bookmarks.<name>.keyword</code></a></span></dt><dd><p>Bookmark search keyword.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.bookmarks._name_.name"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.bookmarks._name_.name"><code class="option">programs.firefox.profiles.<name>.bookmarks.<name>.name</code></a></span></dt><dd><p>Bookmark name.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹name›"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.bookmarks._name_.url"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.bookmarks._name_.url"><code class="option">programs.firefox.profiles.<name>.bookmarks.<name>.url</code></a></span></dt><dd><p>Bookmark url, use %s for search terms.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.extraConfig"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.extraConfig"><code class="option">programs.firefox.profiles.<name>.extraConfig</code></a></span></dt><dd><p>Extra preferences to add to <code class="filename">user.js</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.id"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.id"><code class="option">programs.firefox.profiles.<name>.id</code></a></span></dt><dd><p>Profile ID. This should be set to a unique number per profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.isDefault"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.isDefault"><code class="option">programs.firefox.profiles.<name>.isDefault</code></a></span></dt><dd><p>Whether this is a default profile.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"true if profile ID is 0"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.name"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.name"><code class="option">programs.firefox.profiles.<name>.name</code></a></span></dt><dd><p>Profile name.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹name›"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.path"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.path"><code class="option">programs.firefox.profiles.<name>.path</code></a></span></dt><dd><p>Profile path.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹name›"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.settings"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.settings"><code class="option">programs.firefox.profiles.<name>.settings</code></a></span></dt><dd><p>Attribute set of Firefox preferences.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"browser.startup.homepage" = "https://nixos.org";
|
||
"browser.search.region" = "GB";
|
||
"browser.search.isUS" = false;
|
||
"distribution.searchplugins.defaultLocale" = "en-GB";
|
||
"general.useragent.locale" = "en-GB";
|
||
"browser.bookmarks.showMobileBookmarks" = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.userChrome"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.userChrome"><code class="option">programs.firefox.profiles.<name>.userChrome</code></a></span></dt><dd><p>Custom Firefox user chrome CSS.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
/* Hide tab bar in FF Quantum */
|
||
@-moz-document url("chrome://browser/content/browser.xul") {
|
||
#TabsToolbar {
|
||
visibility: collapse !important;
|
||
margin-bottom: 21px !important;
|
||
}
|
||
|
||
#sidebar-box[sidebarcommand="treestyletab_piro_sakura_ne_jp-sidebar-action"] #sidebar-header {
|
||
visibility: collapse !important;
|
||
}
|
||
}
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.firefox.profiles._name_.userContent"></a><a class="term" href="options.html#opt-programs.firefox.profiles._name_.userContent"><code class="option">programs.firefox.profiles.<name>.userContent</code></a></span></dt><dd><p>Custom Firefox user content CSS.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
/* Hide scrollbar in FF Quantum */
|
||
*{scrollbar-width:none !important}
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/firefox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.enable"></a><a class="term" href="options.html#opt-programs.fish.enable"><code class="option">programs.fish.enable</code></a></span></dt><dd><p>Whether to enable fish, the friendly interactive shell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.package"></a><a class="term" href="options.html#opt-programs.fish.package"><code class="option">programs.fish.package</code></a></span></dt><dd><p>The fish package to install. May be used to change the version.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.fish</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.functions"></a><a class="term" href="options.html#opt-programs.fish.functions"><code class="option">programs.fish.functions</code></a></span></dt><dd><p>Basic functions to add to fish. For more information see
|
||
<a class="link" href="https://fishshell.com/docs/current/cmds/function.html" target="_top">https://fishshell.com/docs/current/cmds/function.html</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n" or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
__fish_command_not_found_handler = {
|
||
body = "__fish_default_command_not_found_handler $argv[1]";
|
||
onEvent = "fish_command_not_found";
|
||
};
|
||
|
||
gitignore = "curl -sL https://www.gitignore.io/api/$argv";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.interactiveShellInit"></a><a class="term" href="options.html#opt-programs.fish.interactiveShellInit"><code class="option">programs.fish.interactiveShellInit</code></a></span></dt><dd><p>Shell script code called during interactive fish shell
|
||
initialisation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.loginShellInit"></a><a class="term" href="options.html#opt-programs.fish.loginShellInit"><code class="option">programs.fish.loginShellInit</code></a></span></dt><dd><p>Shell script code called during fish login shell
|
||
initialisation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.plugins"></a><a class="term" href="options.html#opt-programs.fish.plugins"><code class="option">programs.fish.plugins</code></a></span></dt><dd><p>The plugins to source in
|
||
<code class="filename">conf.d/99plugins.fish</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
name = "z";
|
||
src = pkgs.fetchFromGitHub {
|
||
owner = "jethrokuan";
|
||
repo = "z";
|
||
rev = "ddeb28a7b6a1f0ec6dae40c636e5ca4908ad160a";
|
||
sha256 = "0c5i7sdrsp0q3vbziqzdyqn4fmp235ax4mn4zslrswvn8g3fvdyh";
|
||
};
|
||
}
|
||
|
||
# oh-my-fish plugins are stored in their own repositories, which
|
||
# makes them simple to import into home-manager.
|
||
{
|
||
name = "fasd";
|
||
src = pkgs.fetchFromGitHub {
|
||
owner = "oh-my-fish";
|
||
repo = "plugin-fasd";
|
||
rev = "38a5b6b6011106092009549e52249c6d6f501fba";
|
||
sha256 = "06v37hqy5yrv5a6ssd1p3cjd9y3hnp19d3ab7dag56fs1qmgyhbs";
|
||
};
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.plugins._.name"></a><a class="term" href="options.html#opt-programs.fish.plugins._.name"><code class="option">programs.fish.plugins.*.name</code></a></span></dt><dd><p>The name of the plugin.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.plugins._.src"></a><a class="term" href="options.html#opt-programs.fish.plugins._.src"><code class="option">programs.fish.plugins.*.src</code></a></span></dt><dd><p>Path to the plugin folder.
|
||
</p><p>
|
||
Relevant pieces will be added to the fish function path and
|
||
the completion path. The <code class="filename">init.fish</code> and
|
||
<code class="filename">key_binding.fish</code> files are sourced if
|
||
they exist.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.shellAbbrs"></a><a class="term" href="options.html#opt-programs.fish.shellAbbrs"><code class="option">programs.fish.shellAbbrs</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
gco = "git checkout"; l = "less";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.shellAliases"></a><a class="term" href="options.html#opt-programs.fish.shellAliases"><code class="option">programs.fish.shellAliases</code></a></span></dt><dd><p>An attribute set that maps aliases (the top level attribute names
|
||
in this option) to command strings or directly to build outputs.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
g = "git";
|
||
"..." = "cd ../..";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fish.shellInit"></a><a class="term" href="options.html#opt-programs.fish.shellInit"><code class="option">programs.fish.shellInit</code></a></span></dt><dd><p>Shell script code called during fish shell
|
||
initialisation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fish.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fish.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.foot.enable"></a><a class="term" href="options.html#opt-programs.foot.enable"><code class="option">programs.foot.enable</code></a></span></dt><dd><p>Whether to enable Foot terminal.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/foot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/foot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.foot.package"></a><a class="term" href="options.html#opt-programs.foot.package"><code class="option">programs.foot.package</code></a></span></dt><dd><p>The foot package to install</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.foot</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/foot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/foot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.foot.server.enable"></a><a class="term" href="options.html#opt-programs.foot.server.enable"><code class="option">programs.foot.server.enable</code></a></span></dt><dd><p>Whether to enable Foot terminal server.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/foot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/foot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.foot.settings"></a><a class="term" href="options.html#opt-programs.foot.settings"><code class="option">programs.foot.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/foot/foot.ini</code>. See <a class="link" href="https://codeberg.org/dnkl/foot/src/branch/master/foot.ini" target="_top">https://codeberg.org/dnkl/foot/src/branch/master/foot.ini</a>
|
||
for a list of available options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
main = {
|
||
term = "xterm-256color";
|
||
|
||
font = "Fira Code:size=11";
|
||
dpi-aware = "yes";
|
||
};
|
||
|
||
mouse = {
|
||
hide-when-typing = "yes";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/foot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/foot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.enable"></a><a class="term" href="options.html#opt-programs.fzf.enable"><code class="option">programs.fzf.enable</code></a></span></dt><dd><p>Whether to enable fzf - a command-line fuzzy finder.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.fzf.enableBashIntegration"><code class="option">programs.fzf.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.fzf.enableFishIntegration"><code class="option">programs.fzf.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.fzf.enableZshIntegration"><code class="option">programs.fzf.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.package"></a><a class="term" href="options.html#opt-programs.fzf.package"><code class="option">programs.fzf.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>fzf</strong></span> tool.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.fzf</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.changeDirWidgetCommand"></a><a class="term" href="options.html#opt-programs.fzf.changeDirWidgetCommand"><code class="option">programs.fzf.changeDirWidgetCommand</code></a></span></dt><dd><p>The command that gets executed as the source for fzf for the
|
||
ALT-C keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fd --type d"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.changeDirWidgetOptions"></a><a class="term" href="options.html#opt-programs.fzf.changeDirWidgetOptions"><code class="option">programs.fzf.changeDirWidgetOptions</code></a></span></dt><dd><p>Command line options for the ALT-C keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--preview 'tree -C {} | head -200'"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.defaultCommand"></a><a class="term" href="options.html#opt-programs.fzf.defaultCommand"><code class="option">programs.fzf.defaultCommand</code></a></span></dt><dd><p>The command that gets executed as the default source for fzf
|
||
when running.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fd --type f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.defaultOptions"></a><a class="term" href="options.html#opt-programs.fzf.defaultOptions"><code class="option">programs.fzf.defaultOptions</code></a></span></dt><dd><p>Extra command line options given to fzf by default.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--height 40%" "--border"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.fileWidgetCommand"></a><a class="term" href="options.html#opt-programs.fzf.fileWidgetCommand"><code class="option">programs.fzf.fileWidgetCommand</code></a></span></dt><dd><p>The command that gets executed as the source for fzf for the
|
||
CTRL-T keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fd --type f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.fileWidgetOptions"></a><a class="term" href="options.html#opt-programs.fzf.fileWidgetOptions"><code class="option">programs.fzf.fileWidgetOptions</code></a></span></dt><dd><p>Command line options for the CTRL-T keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--preview 'head {}'"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.historyWidgetOptions"></a><a class="term" href="options.html#opt-programs.fzf.historyWidgetOptions"><code class="option">programs.fzf.historyWidgetOptions</code></a></span></dt><dd><p>Command line options for the CTRL-R keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--sort" "--exact"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.tmux.enableShellIntegration"></a><a class="term" href="options.html#opt-programs.fzf.tmux.enableShellIntegration"><code class="option">programs.fzf.tmux.enableShellIntegration</code></a></span></dt><dd><p>Whether to enable setting <code class="literal">FZF_TMUX=1</code> which causes shell integration to use fzf-tmux
|
||
.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.fzf.tmux.shellIntegrationOptions"></a><a class="term" href="options.html#opt-programs.fzf.tmux.shellIntegrationOptions"><code class="option">programs.fzf.tmux.shellIntegrationOptions</code></a></span></dt><dd><p>If <code class="option">programs.fzf.tmux.enableShellIntegration</code> is set to <code class="literal">true</code>,
|
||
shell integration will use these options for fzf-tmux.
|
||
See <span class="command"><strong>fzf-tmux --help</strong></span> for available options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ "-d 40%" ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/fzf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/fzf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.enable"></a><a class="term" href="options.html#opt-programs.gh.enable"><code class="option">programs.gh.enable</code></a></span></dt><dd><p>Whether to enable GitHub CLI tool.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.enableGitCredentialHelper"></a><a class="term" href="options.html#opt-programs.gh.enableGitCredentialHelper"><code class="option">programs.gh.enableGitCredentialHelper</code></a></span></dt><dd><p>Whether to enable the gh git credential helper for github.com.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.package"></a><a class="term" href="options.html#opt-programs.gh.package"><code class="option">programs.gh.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>gh</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.gh</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.settings"></a><a class="term" href="options.html#opt-programs.gh.settings"><code class="option">programs.gh.settings</code></a></span></dt><dd><p>Configuration written to <code class="filename">$XDG_CONFIG_HOME/gh/config.yml</code>.</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
git_protocol = "ssh";
|
||
|
||
prompt = "enabled";
|
||
|
||
aliases = {
|
||
co = "pr checkout";
|
||
pv = "pr view";
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.settings.aliases"></a><a class="term" href="options.html#opt-programs.gh.settings.aliases"><code class="option">programs.gh.settings.aliases</code></a></span></dt><dd><p>Aliases that allow you to create nicknames for gh commands.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
co = "pr checkout";
|
||
pv = "pr view";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.settings.editor"></a><a class="term" href="options.html#opt-programs.gh.settings.editor"><code class="option">programs.gh.settings.editor</code></a></span></dt><dd><p>The editor that gh should run when creating issues, pull requests, etc.
|
||
If blank, will refer to environment.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gh.settings.git_protocol"></a><a class="term" href="options.html#opt-programs.gh.settings.git_protocol"><code class="option">programs.gh.settings.git_protocol</code></a></span></dt><dd><p>The protocol to use when performing Git operations.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"https"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"ssh"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.enable"></a><a class="term" href="options.html#opt-programs.git.enable"><code class="option">programs.git.enable</code></a></span></dt><dd><p>Whether to enable Git.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.package"></a><a class="term" href="options.html#opt-programs.git.package"><code class="option">programs.git.package</code></a></span></dt><dd><p>Git package to install. Use <code class="varname">pkgs.gitAndTools.gitFull</code>
|
||
to gain access to <span class="command"><strong>git send-email</strong></span> for instance.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.git</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.aliases"></a><a class="term" href="options.html#opt-programs.git.aliases"><code class="option">programs.git.aliases</code></a></span></dt><dd><p>Git aliases to define.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
co = "checkout";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.attributes"></a><a class="term" href="options.html#opt-programs.git.attributes"><code class="option">programs.git.attributes</code></a></span></dt><dd><p>List of defining attributes set globally.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"*.pdf diff=pdf"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.delta.enable"></a><a class="term" href="options.html#opt-programs.git.delta.enable"><code class="option">programs.git.delta.enable</code></a></span></dt><dd><p>Whether to enable the <span class="command"><strong>delta</strong></span> syntax highlighter.
|
||
See <a class="link" href="https://github.com/dandavison/delta" target="_top">https://github.com/dandavison/delta</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.delta.options"></a><a class="term" href="options.html#opt-programs.git.delta.options"><code class="option">programs.git.delta.options</code></a></span></dt><dd><p>Options to configure delta.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean or signed integer or attribute set of string or boolean or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
decorations =
|
||
{
|
||
commit-decoration-style = "bold yellow box ul"; file-decoration-style = "none"; file-style = "bold yellow ul";
|
||
}
|
||
; features = "decorations"; whitespace-error-style = "22 reverse";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.diff-so-fancy.enable"></a><a class="term" href="options.html#opt-programs.git.diff-so-fancy.enable"><code class="option">programs.git.diff-so-fancy.enable</code></a></span></dt><dd><p>Enable the <span class="command"><strong>diff-so-fancy</strong></span> diff colorizer.
|
||
See <a class="link" href="https://github.com/so-fancy/diff-so-fancy" target="_top">https://github.com/so-fancy/diff-so-fancy</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.diff-so-fancy.changeHunkIndicators"></a><a class="term" href="options.html#opt-programs.git.diff-so-fancy.changeHunkIndicators"><code class="option">programs.git.diff-so-fancy.changeHunkIndicators</code></a></span></dt><dd><p>Simplify git header chunks to a more human readable format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.diff-so-fancy.markEmptyLines"></a><a class="term" href="options.html#opt-programs.git.diff-so-fancy.markEmptyLines"><code class="option">programs.git.diff-so-fancy.markEmptyLines</code></a></span></dt><dd><p>Whether the first block of an empty line should be colored.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.diff-so-fancy.rulerWidth"></a><a class="term" href="options.html#opt-programs.git.diff-so-fancy.rulerWidth"><code class="option">programs.git.diff-so-fancy.rulerWidth</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.diff-so-fancy.stripLeadingSymbols"></a><a class="term" href="options.html#opt-programs.git.diff-so-fancy.stripLeadingSymbols"><code class="option">programs.git.diff-so-fancy.stripLeadingSymbols</code></a></span></dt><dd><p>Whether the <code class="literal">+</code> or <code class="literal">-</code> at
|
||
line-start should be removed.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.diff-so-fancy.useUnicodeRuler"></a><a class="term" href="options.html#opt-programs.git.diff-so-fancy.useUnicodeRuler"><code class="option">programs.git.diff-so-fancy.useUnicodeRuler</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.difftastic.enable"></a><a class="term" href="options.html#opt-programs.git.difftastic.enable"><code class="option">programs.git.difftastic.enable</code></a></span></dt><dd><p>Enable the <span class="command"><strong>difft</strong></span> syntax highlighter.
|
||
See <a class="link" href="https://github.com/Wilfred/difftastic" target="_top">https://github.com/Wilfred/difftastic</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.difftastic.background"></a><a class="term" href="options.html#opt-programs.git.difftastic.background"><code class="option">programs.git.difftastic.background</code></a></span></dt><dd><p>Determines whether difftastic should use the lighter or darker colors
|
||
for syntax highlithing.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "light", "dark"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"light"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"dark"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.difftastic.color"></a><a class="term" href="options.html#opt-programs.git.difftastic.color"><code class="option">programs.git.difftastic.color</code></a></span></dt><dd><p>Determines when difftastic should color its output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "always", "auto", "never"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"auto"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"always"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.extraConfig"></a><a class="term" href="options.html#opt-programs.git.extraConfig"><code class="option">programs.git.extraConfig</code></a></span></dt><dd><p>Additional configuration to add. The use of string values is
|
||
deprecated and will be removed in the future.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n" or attribute set of attribute set of string or boolean or signed integer or list of string or boolean or signed integer or attribute set of string or boolean or signed integer or list of string or boolean or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
core =
|
||
{
|
||
whitespace = "trailing-space,space-before-tab";
|
||
}
|
||
; url =
|
||
{
|
||
ssh://git@host =
|
||
{
|
||
insteadOf = "otherhost";
|
||
}
|
||
;
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.ignores"></a><a class="term" href="options.html#opt-programs.git.ignores"><code class="option">programs.git.ignores</code></a></span></dt><dd><p>List of paths that should be globally ignored.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"*~" "*.swp"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.includes"></a><a class="term" href="options.html#opt-programs.git.includes"><code class="option">programs.git.includes</code></a></span></dt><dd><p>List of configuration files to include.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ path = "~/path/to/config.inc"; }
|
||
{
|
||
path = "~/path/to/conditional.inc";
|
||
condition = "gitdir:~/src/dir";
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.includes._.condition"></a><a class="term" href="options.html#opt-programs.git.includes._.condition"><code class="option">programs.git.includes.*.condition</code></a></span></dt><dd><p>Include this configuration only when <code class="varname">condition</code>
|
||
matches. Allowed conditions are described in
|
||
<span class="citerefentry"><span class="refentrytitle">git-config</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.includes._.contents"></a><a class="term" href="options.html#opt-programs.git.includes._.contents"><code class="option">programs.git.includes.*.contents</code></a></span></dt><dd><p>Configuration to include. If empty then a path must be given.
|
||
|
||
This follows the configuration structure as described in
|
||
<span class="citerefentry"><span class="refentrytitle">git-config</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
user = {
|
||
email = "bob@work.example.com";
|
||
name = "Bob Work";
|
||
signingKey = "1A2B3C4D5E6F7G8H";
|
||
};
|
||
commit = {
|
||
gpgSign = true;
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.includes._.path"></a><a class="term" href="options.html#opt-programs.git.includes._.path"><code class="option">programs.git.includes.*.path</code></a></span></dt><dd><p>Path of the configuration file to include.</p><p><span class="emphasis"><em>Type:</em></span> string or path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.lfs.enable"></a><a class="term" href="options.html#opt-programs.git.lfs.enable"><code class="option">programs.git.lfs.enable</code></a></span></dt><dd><p>Whether to enable Git Large File Storage.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.lfs.skipSmudge"></a><a class="term" href="options.html#opt-programs.git.lfs.skipSmudge"><code class="option">programs.git.lfs.skipSmudge</code></a></span></dt><dd><p>Skip automatic downloading of objects on clone or pull.
|
||
This requires a manual <span class="command"><strong>git lfs pull</strong></span>
|
||
every time a new commit is checked out on your repository.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.signing"></a><a class="term" href="options.html#opt-programs.git.signing"><code class="option">programs.git.signing</code></a></span></dt><dd><p>Options related to signing commits using GnuPG.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.signing.gpgPath"></a><a class="term" href="options.html#opt-programs.git.signing.gpgPath"><code class="option">programs.git.signing.gpgPath</code></a></span></dt><dd><p>Path to GnuPG binary to use.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.gnupg}/bin/gpg2"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.signing.key"></a><a class="term" href="options.html#opt-programs.git.signing.key"><code class="option">programs.git.signing.key</code></a></span></dt><dd><p>The default GPG signing key fingerprint.
|
||
</p><p>
|
||
Set to <code class="literal">null</code> to let GnuPG decide what signing key
|
||
to use depending on commit’s author.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.signing.signByDefault"></a><a class="term" href="options.html#opt-programs.git.signing.signByDefault"><code class="option">programs.git.signing.signByDefault</code></a></span></dt><dd><p>Whether commits should be signed by default.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.userEmail"></a><a class="term" href="options.html#opt-programs.git.userEmail"><code class="option">programs.git.userEmail</code></a></span></dt><dd><p>Default user email to use.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.git.userName"></a><a class="term" href="options.html#opt-programs.git.userName"><code class="option">programs.git.userName</code></a></span></dt><dd><p>Default user name to use.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/git.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/git.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gitui.enable"></a><a class="term" href="options.html#opt-programs.gitui.enable"><code class="option">programs.gitui.enable</code></a></span></dt><dd><p>Whether to enable gitui, blazing fast terminal-ui for git written in rust.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gitui.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gitui.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gitui.package"></a><a class="term" href="options.html#opt-programs.gitui.package"><code class="option">programs.gitui.package</code></a></span></dt><dd><p>The package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.gitui"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gitui.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gitui.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gitui.keyConfig"></a><a class="term" href="options.html#opt-programs.gitui.keyConfig"><code class="option">programs.gitui.keyConfig</code></a></span></dt><dd><p>Key config in Ron file format. This is written to
|
||
<code class="filename">$XDG_CONFIG_HOME/gitui/key_config.ron</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
exit: Some(( code: Char('c'), modifiers: ( bits: 2,),)),
|
||
quit: Some(( code: Char('q'), modifiers: ( bits: 0,),)),
|
||
exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)),
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gitui.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gitui.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gitui.theme"></a><a class="term" href="options.html#opt-programs.gitui.theme"><code class="option">programs.gitui.theme</code></a></span></dt><dd><p>Theme in Ron file format. This is written to
|
||
<code class="filename">$XDG_CONFIG_HOME/gitui/theme.ron</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">''
|
||
(
|
||
selected_tab: Reset,
|
||
command_fg: White,
|
||
selection_bg: Blue,
|
||
cmdbar_extra_lines_bg: Blue,
|
||
disabled_fg: DarkGray,
|
||
diff_line_add: Green,
|
||
diff_line_delete: Red,
|
||
diff_file_added: LightGreen,
|
||
diff_file_removed: LightRed,
|
||
diff_file_moved: LightMagenta,
|
||
diff_file_modified: Yellow,
|
||
commit_hash: Magenta,
|
||
commit_time: LightCyan,
|
||
commit_author: Green,
|
||
danger_fg: Red,
|
||
push_gauge_bg: Blue,
|
||
push_gauge_fg: Reset,
|
||
)
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gitui.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gitui.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.enable"></a><a class="term" href="options.html#opt-programs.gnome-terminal.enable"><code class="option">programs.gnome-terminal.enable</code></a></span></dt><dd><p>Whether to enable Gnome Terminal.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile"><code class="option">programs.gnome-terminal.profile</code></a></span></dt><dd><p>A set of Gnome Terminal profiles.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.allowBold"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.allowBold"><code class="option">programs.gnome-terminal.profile.<name>.allowBold</code></a></span></dt><dd><p>If <code class="literal">true</code>, allow applications in the
|
||
terminal to make text boldface.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.audibleBell"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.audibleBell"><code class="option">programs.gnome-terminal.profile.<name>.audibleBell</code></a></span></dt><dd><p>Turn on/off the terminal's bell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.backspaceBinding"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.backspaceBinding"><code class="option">programs.gnome-terminal.profile.<name>.backspaceBinding</code></a></span></dt><dd><p>Which string the terminal should send to an application when the user
|
||
presses the <span class="emphasis"><em>Backspace</em></span> key.
|
||
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">auto</code></span></dt><dd><p>
|
||
Attempt to determine the right value from the terminal's IO settings.
|
||
</p></dd><dt><span class="term"><code class="literal">ascii-backspace</code></span></dt><dd><p>
|
||
Send an ASCII backspace character (0x08).
|
||
</p></dd><dt><span class="term"><code class="literal">ascii-delete</code></span></dt><dd><p>
|
||
Send an ASCII delete character (0x7F).
|
||
</p></dd><dt><span class="term"><code class="literal">delete-sequence</code></span></dt><dd><p>
|
||
Send the <span class="quote">“<span class="quote">@7</span>”</span> control sequence.
|
||
</p></dd><dt><span class="term"><code class="literal">tty</code></span></dt><dd><p>
|
||
Send terminal’s <span class="quote">“<span class="quote">erase</span>”</span> setting.
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "auto", "ascii-backspace", "ascii-delete", "delete-sequence", "tty"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"ascii-delete"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.boldIsBright"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.boldIsBright"><code class="option">programs.gnome-terminal.profile.<name>.boldIsBright</code></a></span></dt><dd><p>Whether bold text is shown in bright colors.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors"><code class="option">programs.gnome-terminal.profile.<name>.colors</code></a></span></dt><dd><p>The terminal colors, null to use system default.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.backgroundColor"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.backgroundColor"><code class="option">programs.gnome-terminal.profile.<name>.colors.backgroundColor</code></a></span></dt><dd><p>The background color.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.boldColor"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.boldColor"><code class="option">programs.gnome-terminal.profile.<name>.colors.boldColor</code></a></span></dt><dd><p>The bold color, null to use same as foreground.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.cursor"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.cursor"><code class="option">programs.gnome-terminal.profile.<name>.colors.cursor</code></a></span></dt><dd><p>The color for the terminal cursor.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.cursor.background"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.cursor.background"><code class="option">programs.gnome-terminal.profile.<name>.colors.cursor.background</code></a></span></dt><dd><p>The background color.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.cursor.foreground"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.cursor.foreground"><code class="option">programs.gnome-terminal.profile.<name>.colors.cursor.foreground</code></a></span></dt><dd><p>The foreground color.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.foregroundColor"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.foregroundColor"><code class="option">programs.gnome-terminal.profile.<name>.colors.foregroundColor</code></a></span></dt><dd><p>The foreground color.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.highlight"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.highlight"><code class="option">programs.gnome-terminal.profile.<name>.colors.highlight</code></a></span></dt><dd><p>The colors for the terminal’s highlighted area.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.highlight.background"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.highlight.background"><code class="option">programs.gnome-terminal.profile.<name>.colors.highlight.background</code></a></span></dt><dd><p>The background color.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.highlight.foreground"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.highlight.foreground"><code class="option">programs.gnome-terminal.profile.<name>.colors.highlight.foreground</code></a></span></dt><dd><p>The foreground color.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.colors.palette"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.colors.palette"><code class="option">programs.gnome-terminal.profile.<name>.colors.palette</code></a></span></dt><dd><p>The terminal palette.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.cursorBlinkMode"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.cursorBlinkMode"><code class="option">programs.gnome-terminal.profile.<name>.cursorBlinkMode</code></a></span></dt><dd><p>The cursor blink mode.</p><p><span class="emphasis"><em>Type:</em></span> one of "system", "on", "off"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"system"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.cursorShape"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.cursorShape"><code class="option">programs.gnome-terminal.profile.<name>.cursorShape</code></a></span></dt><dd><p>The cursor shape.</p><p><span class="emphasis"><em>Type:</em></span> one of "block", "ibeam", "underline"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"block"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.customCommand"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.customCommand"><code class="option">programs.gnome-terminal.profile.<name>.customCommand</code></a></span></dt><dd><p>The command to use to start the shell, or null for default shell.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.default"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.default"><code class="option">programs.gnome-terminal.profile.<name>.default</code></a></span></dt><dd><p>Whether this should be the default profile.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.deleteBinding"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.deleteBinding"><code class="option">programs.gnome-terminal.profile.<name>.deleteBinding</code></a></span></dt><dd><p>Which string the terminal should send to an application when the user
|
||
presses the <span class="emphasis"><em>Delete</em></span> key.
|
||
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">auto</code></span></dt><dd><p>
|
||
Send the <span class="quote">“<span class="quote">@7</span>”</span> control sequence.
|
||
</p></dd><dt><span class="term"><code class="literal">ascii-backspace</code></span></dt><dd><p>
|
||
Send an ASCII backspace character (0x08).
|
||
</p></dd><dt><span class="term"><code class="literal">ascii-delete</code></span></dt><dd><p>
|
||
Send an ASCII delete character (0x7F).
|
||
</p></dd><dt><span class="term"><code class="literal">delete-sequence</code></span></dt><dd><p>
|
||
Send the <span class="quote">“<span class="quote">@7</span>”</span> control sequence.
|
||
</p></dd><dt><span class="term"><code class="literal">tty</code></span></dt><dd><p>
|
||
Send terminal’s <span class="quote">“<span class="quote">erase</span>”</span> setting.
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "auto", "ascii-backspace", "ascii-delete", "delete-sequence", "tty"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"delete-sequence"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.font"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.font"><code class="option">programs.gnome-terminal.profile.<name>.font</code></a></span></dt><dd><p>The font name, null to use system default.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.loginShell"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.loginShell"><code class="option">programs.gnome-terminal.profile.<name>.loginShell</code></a></span></dt><dd><p>Run command as a login shell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.scrollOnOutput"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.scrollOnOutput"><code class="option">programs.gnome-terminal.profile.<name>.scrollOnOutput</code></a></span></dt><dd><p>Whether to scroll when output is written.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.scrollbackLines"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.scrollbackLines"><code class="option">programs.gnome-terminal.profile.<name>.scrollbackLines</code></a></span></dt><dd><p>The number of scrollback lines to keep, null for infinite.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.showScrollbar"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.showScrollbar"><code class="option">programs.gnome-terminal.profile.<name>.showScrollbar</code></a></span></dt><dd><p>Whether the scroll bar should be visible.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.transparencyPercent"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.transparencyPercent"><code class="option">programs.gnome-terminal.profile.<name>.transparencyPercent</code></a></span></dt><dd><p>Background transparency in percent.</p><p><span class="emphasis"><em>Type:</em></span> null or integer between 0 and 100 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.profile._name_.visibleName"></a><a class="term" href="options.html#opt-programs.gnome-terminal.profile._name_.visibleName"><code class="option">programs.gnome-terminal.profile.<name>.visibleName</code></a></span></dt><dd><p>The profile name.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.showMenubar"></a><a class="term" href="options.html#opt-programs.gnome-terminal.showMenubar"><code class="option">programs.gnome-terminal.showMenubar</code></a></span></dt><dd><p>Whether to show the menubar by default</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gnome-terminal.themeVariant"></a><a class="term" href="options.html#opt-programs.gnome-terminal.themeVariant"><code class="option">programs.gnome-terminal.themeVariant</code></a></span></dt><dd><p>The theme variation to request</p><p><span class="emphasis"><em>Type:</em></span> one of "default", "light", "dark", "system"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"default"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gnome-terminal.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gnome-terminal.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.enable"></a><a class="term" href="options.html#opt-programs.go.enable"><code class="option">programs.go.enable</code></a></span></dt><dd><p>Whether to enable Go.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.package"></a><a class="term" href="options.html#opt-programs.go.package"><code class="option">programs.go.package</code></a></span></dt><dd><p>The Go package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.go</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.packages"></a><a class="term" href="options.html#opt-programs.go.packages"><code class="option">programs.go.packages</code></a></span></dt><dd><p>Packages to add to GOPATH.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"golang.org/x/text" = builtins.fetchGit "https://go.googlesource.com/text";
|
||
"golang.org/x/time" = builtins.fetchGit "https://go.googlesource.com/time";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.extraGoPaths"></a><a class="term" href="options.html#opt-programs.go.extraGoPaths"><code class="option">programs.go.extraGoPaths</code></a></span></dt><dd><p>Extra <code class="envar">GOPATH</code>s relative to <code class="envar">HOME</code> appended
|
||
after
|
||
<code class="varname"><a class="link" href="options.html#opt-programs.go.goPath">programs.go.goPath</a></code>,
|
||
if that option is set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"extraGoPath1" "extraGoPath2"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.goBin"></a><a class="term" href="options.html#opt-programs.go.goBin"><code class="option">programs.go.goBin</code></a></span></dt><dd><p>GOBIN relative to HOME</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">".local/bin.go"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.goPath"></a><a class="term" href="options.html#opt-programs.go.goPath"><code class="option">programs.go.goPath</code></a></span></dt><dd><p>Primary <code class="envar">GOPATH</code> relative to
|
||
<code class="envar">HOME</code>. It will be exported first and therefore
|
||
used by default by the Go tooling.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"go"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.goPrivate"></a><a class="term" href="options.html#opt-programs.go.goPrivate"><code class="option">programs.go.goPrivate</code></a></span></dt><dd><p>The <code class="envar">GOPRIVATE</code> 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"*.corp.example.com" "rsc.io/private"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.enable"></a><a class="term" href="options.html#opt-programs.gpg.enable"><code class="option">programs.gpg.enable</code></a></span></dt><dd><p>Whether to enable GnuPG.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.package"></a><a class="term" href="options.html#opt-programs.gpg.package"><code class="option">programs.gpg.package</code></a></span></dt><dd><p>The Gnupg package to use (also used the gpg-agent service).</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.gnupg</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.gnupg23</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.homedir"></a><a class="term" href="options.html#opt-programs.gpg.homedir"><code class="option">programs.gpg.homedir</code></a></span></dt><dd><p>Directory to store keychains and configuration.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"${config.home.homeDirectory}/.gnupg"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"${config.xdg.dataHome}/gnupg"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.mutableKeys"></a><a class="term" href="options.html#opt-programs.gpg.mutableKeys"><code class="option">programs.gpg.mutableKeys</code></a></span></dt><dd><p>If set to <code class="literal">true</code>, you may manage your keyring as a user
|
||
using the <code class="literal">gpg</code> command. Upon activation, the keyring
|
||
will have managed keys added without overwriting unmanaged keys.
|
||
</p><p>
|
||
If set to <code class="literal">false</code>, the path
|
||
<code class="filename">$GNUPGHOME/pubring.kbx</code> will become an immutable
|
||
link to the Nix store, denying modifications.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.mutableTrust"></a><a class="term" href="options.html#opt-programs.gpg.mutableTrust"><code class="option">programs.gpg.mutableTrust</code></a></span></dt><dd><p>If set to <code class="literal">true</code>, you may manage trust as a user using
|
||
the <span class="command"><strong>gpg</strong></span> command. Upon activation, trusted keys have
|
||
their trust set without overwriting unmanaged keys.
|
||
</p><p>
|
||
If set to <code class="literal">false</code>, the path
|
||
<code class="filename">$GNUPGHOME/trustdb.gpg</code> will be
|
||
<span class="emphasis"><em>overwritten</em></span> on each activation, removing trust for
|
||
any unmanaged keys. Be careful to make a backup of your old
|
||
<code class="filename">trustdb.gpg</code> before switching to immutable trust!
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.publicKeys"></a><a class="term" href="options.html#opt-programs.gpg.publicKeys"><code class="option">programs.gpg.publicKeys</code></a></span></dt><dd><p>A list of public keys to be imported into GnuPG. Note, these key files
|
||
will be copied into the world-readable Nix store.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[ { source = ./pubkeys.txt; } ]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.publicKeys._.source"></a><a class="term" href="options.html#opt-programs.gpg.publicKeys._.source"><code class="option">programs.gpg.publicKeys.*.source</code></a></span></dt><dd><p>Path of an OpenPGP public key file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.publicKeys._.text"></a><a class="term" href="options.html#opt-programs.gpg.publicKeys._.text"><code class="option">programs.gpg.publicKeys.*.text</code></a></span></dt><dd><p>Text of an OpenPGP public key.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.publicKeys._.trust"></a><a class="term" href="options.html#opt-programs.gpg.publicKeys._.trust"><code class="option">programs.gpg.publicKeys.*.trust</code></a></span></dt><dd><p>The amount of trust you have in the key ownership and the care the
|
||
owner puts into signing other keys. The available levels are
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">unknown</code> or <code class="literal">1</code></span></dt><dd><p>I don't know or won't say.</p></dd><dt><span class="term"><code class="literal">never</code> or <code class="literal">2</code></span></dt><dd><p>I do NOT trust.</p></dd><dt><span class="term"><code class="literal">marginal</code> or <code class="literal">3</code></span></dt><dd><p>I trust marginally.</p></dd><dt><span class="term"><code class="literal">full</code> or <code class="literal">4</code></span></dt><dd><p>I trust fully.</p></dd><dt><span class="term"><code class="literal">ultimate</code> or <code class="literal">5</code></span></dt><dd><p>I trust ultimately.</p></dd></dl></div><p>
|
||
</p><p>
|
||
See <a class="link" href="https://www.gnupg.org/gph/en/manual/x334.html" target="_top">https://www.gnupg.org/gph/en/manual/x334.html</a>
|
||
for more.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "unknown", 1, "never", 2, "marginal", 3, "full", 4, "ultimate", 5</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.scdaemonSettings"></a><a class="term" href="options.html#opt-programs.gpg.scdaemonSettings"><code class="option">programs.gpg.scdaemonSettings</code></a></span></dt><dd><p>SCdaemon configuration options. Available options are described
|
||
in the gpg scdaemon manpage:
|
||
<a class="link" href="https://www.gnupg.org/documentation/manuals/gnupg/Scdaemon-Options.html" target="_top">https://www.gnupg.org/documentation/manuals/gnupg/Scdaemon-Options.html</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean or list of string</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
disable-ccid = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.gpg.settings"></a><a class="term" href="options.html#opt-programs.gpg.settings"><code class="option">programs.gpg.settings</code></a></span></dt><dd><p>GnuPG configuration options. Available options are described
|
||
in the gpg manpage:
|
||
<a class="link" href="https://gnupg.org/documentation/manpage.html" target="_top">https://gnupg.org/documentation/manpage.html</a>.
|
||
</p><p>
|
||
Note that lists are converted to duplicate keys.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean or list of string</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
no-comments = false;
|
||
s2k-cipher-algo = "AES128";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/gpg.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/gpg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.helix.enable"></a><a class="term" href="options.html#opt-programs.helix.enable"><code class="option">programs.helix.enable</code></a></span></dt><dd><p>Whether to enable helix text editor.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/helix.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/helix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.helix.package"></a><a class="term" href="options.html#opt-programs.helix.package"><code class="option">programs.helix.package</code></a></span></dt><dd><p>The package to use for helix.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.helix</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/helix.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/helix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.helix.languages"></a><a class="term" href="options.html#opt-programs.helix.languages"><code class="option">programs.helix.languages</code></a></span></dt><dd><p>Language specific configuration at
|
||
<code class="filename">$XDG_CONFIG_HOME/helix/languages.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://docs.helix-editor.com/languages.html" target="_top">https://docs.helix-editor.com/languages.html</a>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
auto-format = false; name = "rust";
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/helix.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/helix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.helix.settings"></a><a class="term" href="options.html#opt-programs.helix.settings"><code class="option">programs.helix.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/helix/config.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://docs.helix-editor.com/configuration.html" target="_top">https://docs.helix-editor.com/configuration.html</a>
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
theme = "base16";
|
||
lsp.display-messages = true;
|
||
keys.normal = {
|
||
space.space = "file_picker";
|
||
space.w = ":w";
|
||
space.q = ":q";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/helix.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/helix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.helix.themes"></a><a class="term" href="options.html#opt-programs.helix.themes"><code class="option">programs.helix.themes</code></a></span></dt><dd><p>Each theme is written to
|
||
<code class="filename">$XDG_CONFIG_HOME/helix/themes/theme-name.toml</code>.
|
||
Where the name of each attribute is the theme-name (in the example "base16").
|
||
</p><p>
|
||
See <a class="link" href="https://docs.helix-editor.com/themes.html" target="_top">https://docs.helix-editor.com/themes.html</a>
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
base16 = let
|
||
transparent = "none";
|
||
gray = "#665c54";
|
||
dark-gray = "#3c3836";
|
||
white = "#fbf1c7";
|
||
black = "#282828";
|
||
red = "#fb4934";
|
||
green = "#b8bb26";
|
||
yellow = "#fabd2f";
|
||
orange = "#fe8019";
|
||
blue = "#83a598";
|
||
magenta = "#d3869b";
|
||
cyan = "#8ec07c";
|
||
in {
|
||
"ui.menu" = transparent;
|
||
"ui.menu.selected" = { modifiers = [ "reversed" ]; };
|
||
"ui.linenr" = { fg = gray; bg = dark-gray; };
|
||
"ui.popup" = { modifiers = [ "reversed" ]; };
|
||
"ui.linenr.selected" = { fg = white; bg = black; modifiers = [ "bold" ]; };
|
||
"ui.selection" = { fg = black; bg = blue; };
|
||
"ui.selection.primary" = { modifiers = [ "reversed" ]; };
|
||
"comment" = { fg = gray; };
|
||
"ui.statusline" = { fg = white; bg = dark-gray; };
|
||
"ui.statusline.inactive" = { fg = dark-gray; bg = white; };
|
||
"ui.help" = { fg = dark-gray; bg = white; };
|
||
"ui.cursor" = { modifiers = [ "reversed" ]; };
|
||
"variable" = red;
|
||
"variable.builtin" = orange;
|
||
"constant.numeric" = orange;
|
||
"constant" = orange;
|
||
"attributes" = yellow;
|
||
"type" = yellow;
|
||
"ui.cursor.match" = { fg = yellow; modifiers = [ "underlined" ]; };
|
||
"string" = green;
|
||
"variable.other.member" = red;
|
||
"constant.character.escape" = cyan;
|
||
"function" = blue;
|
||
"constructor" = blue;
|
||
"special" = blue;
|
||
"keyword" = magenta;
|
||
"label" = magenta;
|
||
"namespace" = blue;
|
||
"diff.plus" = green;
|
||
"diff.delta" = yellow;
|
||
"diff.minus" = red;
|
||
"diagnostic" = { modifiers = [ "underlined" ]; };
|
||
"ui.gutter" = { bg = black; };
|
||
"info" = blue;
|
||
"hint" = dark-gray;
|
||
"debug" = dark-gray;
|
||
"warning" = yellow;
|
||
"error" = red;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/helix.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/helix.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.enable"></a><a class="term" href="options.html#opt-programs.hexchat.enable"><code class="option">programs.hexchat.enable</code></a></span></dt><dd><p>Whether to enable HexChat, a graphical IRC client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels"></a><a class="term" href="options.html#opt-programs.hexchat.channels"><code class="option">programs.hexchat.channels</code></a></span></dt><dd><p>Configures <code class="filename">$XDG_CONFIG_HOME/hexchat/servlist.conf</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
freenode = {
|
||
autojoin = [
|
||
"#home-manager"
|
||
"#linux"
|
||
"#nixos"
|
||
];
|
||
charset = "UTF-8 (Unicode)";
|
||
commands = [
|
||
"ECHO Buzz Lightyear sent you a message: 'To Infinity... and Beyond!'"
|
||
];
|
||
loginMethod = sasl;
|
||
nickname = "my_nickname";
|
||
nickname2 = "my_secondchoice";
|
||
options = {
|
||
acceptInvalidSSLCertificates = false;
|
||
autoconnect = true;
|
||
bypassProxy = true;
|
||
connectToSelectedServerOnly = true;
|
||
useGlobalUserInformation = false;
|
||
forceSSL = false;
|
||
};
|
||
password = "my_password";
|
||
realName = "my_realname";
|
||
servers = [
|
||
"chat.freenode.net"
|
||
"irc.freenode.net"
|
||
];
|
||
userName = "my_username";
|
||
};
|
||
}</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.autojoin"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.autojoin"><code class="option">programs.hexchat.channels.<name>.autojoin</code></a></span></dt><dd><p>Channels list to autojoin on connecting to server.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"#home-manager" "#linux" "#nix"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.charset"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.charset"><code class="option">programs.hexchat.channels.<name>.charset</code></a></span></dt><dd><p>Character set.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"UTF-8 (Unicode)"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.commands"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.commands"><code class="option">programs.hexchat.channels.<name>.commands</code></a></span></dt><dd><p>Commands to be executed on connecting to server.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ "ECHO Greetings fellow Nixer! ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.loginMethod"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.loginMethod"><code class="option">programs.hexchat.channels.<name>.loginMethod</code></a></span></dt><dd><p>The login method. The allowed options are:
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">null</code></span></dt><dd><p>Default</p></dd><dt><span class="term"><code class="literal">"nickServMsg"</code></span></dt><dd><p>NickServ (/MSG NickServ + password)</p></dd><dt><span class="term"><code class="literal">"nickServ"</code></span></dt><dd><p>NickServ (/NICKSERV + password)</p></dd><dt><span class="term"><code class="literal">"challengeAuth"</code></span></dt><dd><p>Challenge Auth (username + password)</p></dd><dt><span class="term"><code class="literal">"sasl"</code></span></dt><dd><p>SASL (username + password)</p></dd><dt><span class="term"><code class="literal">"serverPassword"</code></span></dt><dd><p>Server password (/PASS password)</p></dd><dt><span class="term"><code class="literal">"saslExternal"</code></span></dt><dd><p>SASL EXTERNAL (cert)</p></dd><dt><span class="term"><code class="literal">"customCommands"</code></span></dt><dd><p>Use "commands" field for auth. For example
|
||
</p><pre class="programlisting nix">
|
||
commands = [ "/msg NickServ IDENTIFY my_password" ]
|
||
</pre><p>
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "challengeAuth", "customCommands", "nickServ", "nickServMsg", "sasl", "saslExternal", "serverPassword"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.nickname"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.nickname"><code class="option">programs.hexchat.channels.<name>.nickname</code></a></span></dt><dd><p>Primary nickname.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.nickname2"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.nickname2"><code class="option">programs.hexchat.channels.<name>.nickname2</code></a></span></dt><dd><p>Secondary nickname.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options"><code class="option">programs.hexchat.channels.<name>.options</code></a></span></dt><dd><p>Channel options.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
autoconnect = true; useGlobalUserInformation = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options.acceptInvalidSSLCertificates"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options.acceptInvalidSSLCertificates"><code class="option">programs.hexchat.channels.<name>.options.acceptInvalidSSLCertificates</code></a></span></dt><dd><p>Accept invalid SSL certificates.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options.autoconnect"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options.autoconnect"><code class="option">programs.hexchat.channels.<name>.options.autoconnect</code></a></span></dt><dd><p>Autoconnect to network.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options.bypassProxy"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options.bypassProxy"><code class="option">programs.hexchat.channels.<name>.options.bypassProxy</code></a></span></dt><dd><p>Bypass proxy.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options.connectToSelectedServerOnly"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options.connectToSelectedServerOnly"><code class="option">programs.hexchat.channels.<name>.options.connectToSelectedServerOnly</code></a></span></dt><dd><p>Connect to selected server only.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options.forceSSL"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options.forceSSL"><code class="option">programs.hexchat.channels.<name>.options.forceSSL</code></a></span></dt><dd><p>Use SSL for all servers.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.options.useGlobalUserInformation"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.options.useGlobalUserInformation"><code class="option">programs.hexchat.channels.<name>.options.useGlobalUserInformation</code></a></span></dt><dd><p>Use global user information.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.password"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.password"><code class="option">programs.hexchat.channels.<name>.password</code></a></span></dt><dd><p>Password to use. Note this password will be readable by all user's
|
||
in the Nix store.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.realName"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.realName"><code class="option">programs.hexchat.channels.<name>.realName</code></a></span></dt><dd><p>Real name. Is used to populate the real name field that appears when
|
||
someone uses the <code class="literal">WHOIS</code> command on your nick.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.servers"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.servers"><code class="option">programs.hexchat.channels.<name>.servers</code></a></span></dt><dd><p>IRC Server Address List.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"chat.freenode.net" "irc.freenode.net"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.channels._name_.userName"></a><a class="term" href="options.html#opt-programs.hexchat.channels._name_.userName"><code class="option">programs.hexchat.channels.<name>.userName</code></a></span></dt><dd><p>User name. Part of your <code class="literal">user@host</code> hostmask that
|
||
appears to other on IRC.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.overwriteConfigFiles"></a><a class="term" href="options.html#opt-programs.hexchat.overwriteConfigFiles"><code class="option">programs.hexchat.overwriteConfigFiles</code></a></span></dt><dd><p>Enables overwriting HexChat configuration files
|
||
(<code class="filename">hexchat.conf</code>, <code class="filename">servlist.conf</code>).
|
||
Any existing HexChat configuration will be lost. Certify to back-up any
|
||
previous configuration before enabling this.
|
||
</p><p>
|
||
Enabling this setting is recommended, because everytime HexChat
|
||
application is closed it overwrites Nix/Home Manager provided
|
||
configuration files, causing:
|
||
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>
|
||
Nix/Home Manager provided configuration to be out of sync with
|
||
actual active HexChat configuration.
|
||
</p></li><li class="listitem"><p>
|
||
Blocking Nix/Home Manager updates until configuration files are
|
||
manually removed.
|
||
</p></li></ol></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.settings"></a><a class="term" href="options.html#opt-programs.hexchat.settings"><code class="option">programs.hexchat.settings</code></a></span></dt><dd><p>Configuration for <code class="filename">$XDG_CONFIG_HOME/hexchat/hexchat.conf</code>, see
|
||
<a class="link" href="https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings" target="_top">https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings</a>
|
||
for supported values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
irc_nick1 = "mynick";
|
||
irc_username = "bob";
|
||
irc_realname = "Bart Simpson";
|
||
text_font = "Monospace 14";
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.hexchat.theme"></a><a class="term" href="options.html#opt-programs.hexchat.theme"><code class="option">programs.hexchat.theme</code></a></span></dt><dd><p>Theme package for HexChat. Expects a derivation containing decompressed
|
||
theme files. Note, <code class="literal">.hct</code> files are actually ZIP files,
|
||
as seen in example.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">source = pkgs.fetchzip {
|
||
url = "https://dl.hexchat.net/themes/Monokai.hct#Monokai.zip";
|
||
sha256 = "sha256-WCdgEr8PwKSZvBMs0fN7E2gOjNM0c2DscZGSKSmdID0=";
|
||
stripRoot = false;
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/hexchat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/hexchat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.himalaya.enable"></a><a class="term" href="options.html#opt-programs.himalaya.enable"><code class="option">programs.himalaya.enable</code></a></span></dt><dd><p>Whether to enable himalaya mail client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/himalaya.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/himalaya.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.himalaya.package"></a><a class="term" href="options.html#opt-programs.himalaya.package"><code class="option">programs.himalaya.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>himalaya</strong></span> mail client.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.himalaya</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/himalaya.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/himalaya.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.himalaya.settings"></a><a class="term" href="options.html#opt-programs.himalaya.settings"><code class="option">programs.himalaya.settings</code></a></span></dt><dd><p>Global <span class="command"><strong>himalaya</strong></span> configuration values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
default-page-size = 50;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/himalaya.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/himalaya.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.home-manager.enable"></a><a class="term" href="options.html#opt-programs.home-manager.enable"><code class="option">programs.home-manager.enable</code></a></span></dt><dd><p>Whether to enable Home Manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/home-manager.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/home-manager.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.home-manager.path"></a><a class="term" href="options.html#opt-programs.home-manager.path"><code class="option">programs.home-manager.path</code></a></span></dt><dd><p>The default path to use for Home Manager. If this path does
|
||
not exist then
|
||
<code class="filename">$HOME/.config/nixpkgs/home-manager</code> and
|
||
<code class="filename">$HOME/.nixpkgs/home-manager</code> will be
|
||
attempted.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"$HOME/devel/home-manager"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/home-manager.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/home-manager.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.htop.enable"></a><a class="term" href="options.html#opt-programs.htop.enable"><code class="option">programs.htop.enable</code></a></span></dt><dd><p>Whether to enable htop.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/htop.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/htop.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.htop.package"></a><a class="term" href="options.html#opt-programs.htop.package"><code class="option">programs.htop.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>htop</strong></span> program.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.htop</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/htop.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/htop.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.htop.settings"></a><a class="term" href="options.html#opt-programs.htop.settings"><code class="option">programs.htop.settings</code></a></span></dt><dd><p>Configuration options to add to
|
||
<code class="filename">$XDG_CONFIG_HOME/htop/htoprc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
color_scheme = 6;
|
||
cpu_count_from_one = 0;
|
||
delay = 15;
|
||
fields = with config.lib.htop.fields; [
|
||
PID
|
||
USER
|
||
PRIORITY
|
||
NICE
|
||
M_SIZE
|
||
M_RESIDENT
|
||
M_SHARE
|
||
STATE
|
||
PERCENT_CPU
|
||
PERCENT_MEM
|
||
TIME
|
||
COMM
|
||
];
|
||
highlight_base_name = 1;
|
||
highlight_megabytes = 1;
|
||
highlight_threads = 1;
|
||
} // (with config.lib.htop; leftMeters [
|
||
(bar "AllCPUs2")
|
||
(bar "Memory")
|
||
(bar "Swap")
|
||
(text "Zram")
|
||
]) // (with config.lib.htop; rightMeters [
|
||
(text "Tasks")
|
||
(text "LoadAverage")
|
||
(text "Uptime")
|
||
(text "Systemd")
|
||
]);
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/htop.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/htop.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.enable"></a><a class="term" href="options.html#opt-programs.i3status.enable"><code class="option">programs.i3status.enable</code></a></span></dt><dd><p>Whether to enable i3status.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.enableDefault"></a><a class="term" href="options.html#opt-programs.i3status.enableDefault"><code class="option">programs.i3status.enableDefault</code></a></span></dt><dd><p>Whether or not to enable
|
||
the default configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.general"></a><a class="term" href="options.html#opt-programs.i3status.general"><code class="option">programs.i3status.general</code></a></span></dt><dd><p>Configuration to add to i3status <code class="filename">config</code>
|
||
<code class="code">general</code> section.
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">i3status</span>(1)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
colors = true;
|
||
color_good = "#e0e0e0";
|
||
color_degraded = "#d7ae00";
|
||
color_bad = "#f69d6a";
|
||
interval = 1;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.modules"></a><a class="term" href="options.html#opt-programs.i3status.modules"><code class="option">programs.i3status.modules</code></a></span></dt><dd><p>Modules to add to i3status <code class="filename">config</code> file.
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">i3status</span>(1)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"volume master" = {
|
||
position = 1;
|
||
settings = {
|
||
format = "♪ %volume";
|
||
format_muted = "♪ muted (%volume)";
|
||
device = "pulse:1";
|
||
};
|
||
};
|
||
"disk /" = {
|
||
position = 2;
|
||
settings = {
|
||
format = "/ %avail";
|
||
};
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.modules._name_.enable"></a><a class="term" href="options.html#opt-programs.i3status.modules._name_.enable"><code class="option">programs.i3status.modules.<name>.enable</code></a></span></dt><dd><p>Whether or not to enable this module.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.modules._name_.position"></a><a class="term" href="options.html#opt-programs.i3status.modules._name_.position"><code class="option">programs.i3status.modules.<name>.position</code></a></span></dt><dd><p>Position of this module in i3status <code class="code">order</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer or floating point number</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status.modules._name_.settings"></a><a class="term" href="options.html#opt-programs.i3status.modules._name_.settings"><code class="option">programs.i3status.modules.<name>.settings</code></a></span></dt><dd><p>Configuration to add to this i3status module.
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">i3status</span>(1)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
format = "♪ %volume";
|
||
format_muted = "♪ muted (%volume)";
|
||
device = "pulse:1";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.enable"></a><a class="term" href="options.html#opt-programs.i3status-rust.enable"><code class="option">programs.i3status-rust.enable</code></a></span></dt><dd><p>Whether to enable a replacement for i3-status written in Rust.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.package"></a><a class="term" href="options.html#opt-programs.i3status-rust.package"><code class="option">programs.i3status-rust.package</code></a></span></dt><dd><p>Package providing i3status-rust</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.i3status-rust</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars"><code class="option">programs.i3status-rust.bars</code></a></span></dt><dd><p>Attribute set of i3status-rust bars, each with their own configuration.
|
||
Each bar <code class="varname">name</code> generates a config file suffixed with
|
||
the bar's <code class="varname">name</code> from the attribute set, like so:
|
||
<code class="filename">config-<em class="replaceable"><code>name</code></em>.toml</code>.
|
||
</p><p>
|
||
This way, multiple config files can be generated, such as for having a
|
||
top and a bottom bar.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">i3status-rust</span>(1)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
default =
|
||
{
|
||
blocks =
|
||
[
|
||
|
||
{
|
||
alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ;
|
||
}
|
||
|
||
{
|
||
block = "memory"; display_type = "memory"; format_mem = "{mem_used_percents}"; format_swap = "{swap_used_percents}";
|
||
}
|
||
|
||
{
|
||
block = "cpu"; interval = 1;
|
||
}
|
||
|
||
{
|
||
block = "load"; format = "{1m}"; interval = 1;
|
||
}
|
||
|
||
{
|
||
block = "sound";
|
||
}
|
||
|
||
{
|
||
block = "time"; format = "%a %d/%m %R"; interval = 60;
|
||
}
|
||
|
||
]
|
||
;
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">bottom = {
|
||
blocks = [
|
||
{
|
||
block = "disk_space";
|
||
path = "/";
|
||
alias = "/";
|
||
info_type = "available";
|
||
unit = "GB";
|
||
interval = 60;
|
||
warning = 20.0;
|
||
alert = 10.0;
|
||
}
|
||
{
|
||
block = "memory";
|
||
display_type = "memory";
|
||
format_mem = "{mem_used_percents}";
|
||
format_swap = "{swap_used_percents}";
|
||
}
|
||
{
|
||
block = "cpu";
|
||
interval = 1;
|
||
}
|
||
{
|
||
block = "load";
|
||
interval = 1;
|
||
format = "{1m}";
|
||
}
|
||
{ block = "sound"; }
|
||
{
|
||
block = "time";
|
||
interval = 60;
|
||
format = "%a %d/%m %R";
|
||
}
|
||
];
|
||
settings = {
|
||
theme = {
|
||
name = "solarized-dark";
|
||
overrides = {
|
||
idle_bg = "#123456";
|
||
idle_fg = "#abcdef";
|
||
};
|
||
};
|
||
};
|
||
icons = "awesome5";
|
||
theme = "gruvbox-dark";
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.blocks"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.blocks"><code class="option">programs.i3status-rust.bars.<name>.blocks</code></a></span></dt><dd><p>Configuration blocks to add to i3status-rust
|
||
<code class="filename">config</code>. See
|
||
<a class="link" href="https://github.com/greshake/i3status-rust/blob/master/blocks.md" target="_top">https://github.com/greshake/i3status-rust/blob/master/blocks.md</a>
|
||
for block options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ;
|
||
}
|
||
|
||
{
|
||
block = "memory"; display_type = "memory"; format_mem = "{mem_used_percents}"; format_swap = "{swap_used_percents}";
|
||
}
|
||
|
||
{
|
||
block = "cpu"; interval = 1;
|
||
}
|
||
|
||
{
|
||
block = "load"; format = "{1m}"; interval = 1;
|
||
}
|
||
|
||
{
|
||
block = "sound";
|
||
}
|
||
|
||
{
|
||
block = "time"; format = "%a %d/%m %R"; interval = 60;
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
block = "disk_space";
|
||
path = "/";
|
||
alias = "/";
|
||
info_type = "available";
|
||
unit = "GB";
|
||
interval = 60;
|
||
warning = 20.0;
|
||
alert = 10.0;
|
||
}
|
||
{
|
||
block = "sound";
|
||
format = "{output_name} {volume}%";
|
||
on_click = "pavucontrol --tab=3";
|
||
mappings = {
|
||
"alsa_output.pci-0000_00_1f.3.analog-stereo" = "";
|
||
"bluez_sink.70_26_05_DA_27_A4.a2dp_sink" = "";
|
||
};
|
||
}
|
||
];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.icons"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.icons"><code class="option">programs.i3status-rust.bars.<name>.icons</code></a></span></dt><dd><p>The icons set to use. See
|
||
<a class="link" href="https://github.com/greshake/i3status-rust/blob/master/themes.md" target="_top">https://github.com/greshake/i3status-rust/blob/master/themes.md</a>
|
||
for a list of available icon sets.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"awesome5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.settings"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.settings"><code class="option">programs.i3status-rust.bars.<name>.settings</code></a></span></dt><dd><p>Any extra options to add to i3status-rust
|
||
<code class="filename">config</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
theme = {
|
||
name = "solarized-dark";
|
||
overrides = {
|
||
idle_bg = "#123456";
|
||
idle_fg = "#abcdef";
|
||
};
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.theme"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.theme"><code class="option">programs.i3status-rust.bars.<name>.theme</code></a></span></dt><dd><p>The theme to use. See
|
||
<a class="link" href="https://github.com/greshake/i3status-rust/blob/master/themes.md" target="_top">https://github.com/greshake/i3status-rust/blob/master/themes.md</a>
|
||
for a list of available themes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"plain"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"gruvbox-dark"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/i3status-rust.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/i3status-rust.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.info.enable"></a><a class="term" href="options.html#opt-programs.info.enable"><code class="option">programs.info.enable</code></a></span></dt><dd><p>Whether to enable GNU Info.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/info.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/info.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ion.enable"></a><a class="term" href="options.html#opt-programs.ion.enable"><code class="option">programs.ion.enable</code></a></span></dt><dd><p>Whether to enable the Ion Shell. Compatible with Redox and Linux.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ion.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ion.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ion.package"></a><a class="term" href="options.html#opt-programs.ion.package"><code class="option">programs.ion.package</code></a></span></dt><dd><p>The ion package to install. May be used to change the version.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.ion</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ion.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ion.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ion.initExtra"></a><a class="term" href="options.html#opt-programs.ion.initExtra"><code class="option">programs.ion.initExtra</code></a></span></dt><dd><p>Ion script which is called during ion initialization.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ion.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ion.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ion.shellAliases"></a><a class="term" href="options.html#opt-programs.ion.shellAliases"><code class="option">programs.ion.shellAliases</code></a></span></dt><dd><p>An attribute set that maps aliases (the top level attribute names
|
||
in this option) to command strings or directly to build outputs.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
g = "git";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ion.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ion.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.enable"></a><a class="term" href="options.html#opt-programs.irssi.enable"><code class="option">programs.irssi.enable</code></a></span></dt><dd><p>Whether to enable the Irssi chat client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.aliases"></a><a class="term" href="options.html#opt-programs.irssi.aliases"><code class="option">programs.irssi.aliases</code></a></span></dt><dd><p>An attribute set that maps aliases to commands.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
BYE = "quit"; J = "join";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.extraConfig"></a><a class="term" href="options.html#opt-programs.irssi.extraConfig"><code class="option">programs.irssi.extraConfig</code></a></span></dt><dd><p>These lines are appended to the Irssi configuration.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks"></a><a class="term" href="options.html#opt-programs.irssi.networks"><code class="option">programs.irssi.networks</code></a></span></dt><dd><p>An attribute set of chat networks.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
freenode = {
|
||
nick = "hmuser";
|
||
server = {
|
||
address = "chat.freenode.net";
|
||
port = 6697;
|
||
autoConnect = true;
|
||
};
|
||
channels = {
|
||
nixos.autoJoin = true;
|
||
};
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.autoCommands"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.autoCommands"><code class="option">programs.irssi.networks.<name>.autoCommands</code></a></span></dt><dd><p>List of commands to execute on connect.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.channels"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.channels"><code class="option">programs.irssi.networks.<name>.channels</code></a></span></dt><dd><p>Channels for the given network.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.channels._name_.autoJoin"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.channels._name_.autoJoin"><code class="option">programs.irssi.networks.<name>.channels.<name>.autoJoin</code></a></span></dt><dd><p>Whether to join this channel on connect.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.nick"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.nick"><code class="option">programs.irssi.networks.<name>.nick</code></a></span></dt><dd><p>Nickname in that network.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.server.address"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.server.address"><code class="option">programs.irssi.networks.<name>.server.address</code></a></span></dt><dd><p>Address of the chat server.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.server.autoConnect"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.server.autoConnect"><code class="option">programs.irssi.networks.<name>.server.autoConnect</code></a></span></dt><dd><p>Whether Irssi connects to the server on launch.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.server.port"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.server.port"><code class="option">programs.irssi.networks.<name>.server.port</code></a></span></dt><dd><p>Port of the chat server.</p><p><span class="emphasis"><em>Type:</em></span> 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">6667</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.server.ssl.enable"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.server.ssl.enable"><code class="option">programs.irssi.networks.<name>.server.ssl.enable</code></a></span></dt><dd><p>Whether SSL should be used.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.server.ssl.certificateFile"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.server.ssl.certificateFile"><code class="option">programs.irssi.networks.<name>.server.ssl.certificateFile</code></a></span></dt><dd><p>Path to a file containing the certificate used for
|
||
client authentication to the server.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.server.ssl.verify"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.server.ssl.verify"><code class="option">programs.irssi.networks.<name>.server.ssl.verify</code></a></span></dt><dd><p>Whether the SSL certificate should be verified.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.irssi.networks._name_.type"></a><a class="term" href="options.html#opt-programs.irssi.networks._name_.type"><code class="option">programs.irssi.networks.<name>.type</code></a></span></dt><dd><p>Type of the network.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"IRC"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/irssi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/irssi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.java.enable"></a><a class="term" href="options.html#opt-programs.java.enable"><code class="option">programs.java.enable</code></a></span></dt><dd><p>Install the Java development kit and set the <code class="envar">JAVA_HOME</code>
|
||
variable.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/java.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/java.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.java.package"></a><a class="term" href="options.html#opt-programs.java.package"><code class="option">programs.java.package</code></a></span></dt><dd><p>Java package to install. Typical values are
|
||
<code class="literal">pkgs.jdk</code> or <code class="literal">pkgs.jre</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.jdk"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/java.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/java.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.jq.enable"></a><a class="term" href="options.html#opt-programs.jq.enable"><code class="option">programs.jq.enable</code></a></span></dt><dd><p>Whether to enable the jq command-line JSON processor.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/jq.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/jq.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.jq.package"></a><a class="term" href="options.html#opt-programs.jq.package"><code class="option">programs.jq.package</code></a></span></dt><dd><p>jq package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.jq</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/jq.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/jq.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.jq.colors"></a><a class="term" href="options.html#opt-programs.jq.colors"><code class="option">programs.jq.colors</code></a></span></dt><dd><p>The colors used in colored JSON output.</p><p>See <a class="link" href="https://stedolan.github.io/jq/manual/#Colors" target="_top">https://stedolan.github.io/jq/manual/#Colors</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
arrays = "1;37"; false = "0;37"; null = "1;30"; numbers = "0;37"; objects = "1;37"; strings = "0;32"; true = "0;37";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
null = "1;30";
|
||
false = "0;31";
|
||
true = "0;32";
|
||
numbers = "0;36";
|
||
strings = "0;33";
|
||
arrays = "1;35";
|
||
objects = "1;37";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/jq.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/jq.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.just.enable"></a><a class="term" href="options.html#opt-programs.just.enable"><code class="option">programs.just.enable</code></a></span></dt><dd><p>Whether to enable just, a handy way to save and run project-specific commands.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/just.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/just.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.just.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.just.enableBashIntegration"><code class="option">programs.just.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/just.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/just.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.just.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.just.enableFishIntegration"><code class="option">programs.just.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/just.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/just.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.just.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.just.enableZshIntegration"><code class="option">programs.just.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/just.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/just.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.just.package"></a><a class="term" href="options.html#opt-programs.just.package"><code class="option">programs.just.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>just</strong></span> tool.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.just</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/just.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/just.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.enable"></a><a class="term" href="options.html#opt-programs.kakoune.enable"><code class="option">programs.kakoune.enable</code></a></span></dt><dd><p>Whether to enable the kakoune text editor.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config"></a><a class="term" href="options.html#opt-programs.kakoune.config"><code class="option">programs.kakoune.config</code></a></span></dt><dd><p>kakoune configuration options.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.alignWithTabs"></a><a class="term" href="options.html#opt-programs.kakoune.config.alignWithTabs"><code class="option">programs.kakoune.config.alignWithTabs</code></a></span></dt><dd><p>Use tabs for the align command.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.autoComplete"></a><a class="term" href="options.html#opt-programs.kakoune.config.autoComplete"><code class="option">programs.kakoune.config.autoComplete</code></a></span></dt><dd><p>Modes in which to display possible completions.
|
||
The kakoune default is <code class="literal">[ "insert" "prompt" ]</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of one of "insert", "prompt"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.autoInfo"></a><a class="term" href="options.html#opt-programs.kakoune.config.autoInfo"><code class="option">programs.kakoune.config.autoInfo</code></a></span></dt><dd><p>Contexts in which to display automatic information box.
|
||
The kakoune default is <code class="literal">[ "command" "onkey" ]</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of one of "command", "onkey", "normal"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"command" "normal"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.autoReload"></a><a class="term" href="options.html#opt-programs.kakoune.config.autoReload"><code class="option">programs.kakoune.config.autoReload</code></a></span></dt><dd><p>Reload buffers when an external modification is detected.
|
||
The kakoune default is <code class="literal">"ask"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "yes", "no", "ask"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.colorScheme"></a><a class="term" href="options.html#opt-programs.kakoune.config.colorScheme"><code class="option">programs.kakoune.config.colorScheme</code></a></span></dt><dd><p>Set the color scheme. To see available schemes, enter
|
||
<span class="command"><strong>colorscheme</strong></span> at the kakoune prompt.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.hooks"></a><a class="term" href="options.html#opt-programs.kakoune.config.hooks"><code class="option">programs.kakoune.config.hooks</code></a></span></dt><dd><p>Global hooks. For documentation, see
|
||
<a class="link" href="https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc" target="_top">https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.hooks._.commands"></a><a class="term" href="options.html#opt-programs.kakoune.config.hooks._.commands"><code class="option">programs.kakoune.config.hooks.*.commands</code></a></span></dt><dd><p>Commands to run when the hook is activated.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"set-option window indentwidth 2"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.hooks._.group"></a><a class="term" href="options.html#opt-programs.kakoune.config.hooks._.group"><code class="option">programs.kakoune.config.hooks.*.group</code></a></span></dt><dd><p>Add the hook to the named group.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.hooks._.name"></a><a class="term" href="options.html#opt-programs.kakoune.config.hooks._.name"><code class="option">programs.kakoune.config.hooks.*.name</code></a></span></dt><dd><p>The name of the hook. For a description, see
|
||
<a class="link" href="https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc#default-hooks" target="_top">https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc#default-hooks</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "NormalBegin", "NormalIdle", "NormalEnd", "NormalKey", "InsertBegin", "InsertIdle", "InsertEnd", "InsertKey", "InsertChar", "InsertDelete", "InsertMove", "WinCreate", "WinClose", "WinResize", "WinDisplay", "WinSetOption", "BufSetOption", "BufNewFile", "BufOpenFile", "BufCreate", "BufWritePre", "BufWritePost", "BufReload", "BufClose", "BufOpenFifo", "BufReadFifo", "BufCloseFifo", "RuntimeError", "ModeChange", "PromptIdle", "GlobalSetOption", "KakBegin", "KakEnd", "FocusIn", "FocusOut", "RawKey", "InsertCompletionShow", "InsertCompletionHide", "InsertCompletionSelect", "ModuleLoaded"</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"SetOption"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.hooks._.once"></a><a class="term" href="options.html#opt-programs.kakoune.config.hooks._.once"><code class="option">programs.kakoune.config.hooks.*.once</code></a></span></dt><dd><p>Remove the hook after running it once.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.hooks._.option"></a><a class="term" href="options.html#opt-programs.kakoune.config.hooks._.option"><code class="option">programs.kakoune.config.hooks.*.option</code></a></span></dt><dd><p>Additional option to pass to the hook.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"filetype=latex"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.incrementalSearch"></a><a class="term" href="options.html#opt-programs.kakoune.config.incrementalSearch"><code class="option">programs.kakoune.config.incrementalSearch</code></a></span></dt><dd><p>Execute a search as it is being typed.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.indentWidth"></a><a class="term" href="options.html#opt-programs.kakoune.config.indentWidth"><code class="option">programs.kakoune.config.indentWidth</code></a></span></dt><dd><p>The width of an indentation in spaces.
|
||
The kakoune default is <code class="literal">4</code>.
|
||
If <code class="literal">0</code>, a tab will be used instead.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.keyMappings"></a><a class="term" href="options.html#opt-programs.kakoune.config.keyMappings"><code class="option">programs.kakoune.config.keyMappings</code></a></span></dt><dd><p>User-defined key mappings. For documentation, see
|
||
<a class="link" href="https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc" target="_top">https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.keyMappings._.docstring"></a><a class="term" href="options.html#opt-programs.kakoune.config.keyMappings._.docstring"><code class="option">programs.kakoune.config.keyMappings.*.docstring</code></a></span></dt><dd><p>Optional documentation text to display in info boxes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.keyMappings._.effect"></a><a class="term" href="options.html#opt-programs.kakoune.config.keyMappings._.effect"><code class="option">programs.kakoune.config.keyMappings.*.effect</code></a></span></dt><dd><p>The sequence of keys to be mapped.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">":wq<ret>"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.keyMappings._.key"></a><a class="term" href="options.html#opt-programs.kakoune.config.keyMappings._.key"><code class="option">programs.kakoune.config.keyMappings.*.key</code></a></span></dt><dd><p>The key to be mapped. See
|
||
<a class="link" href="https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc#mappable-keys" target="_top">https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc#mappable-keys</a>
|
||
for possible values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"<a-x>"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.keyMappings._.mode"></a><a class="term" href="options.html#opt-programs.kakoune.config.keyMappings._.mode"><code class="option">programs.kakoune.config.keyMappings.*.mode</code></a></span></dt><dd><p>The mode in which the mapping takes effect.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"user"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.numberLines"></a><a class="term" href="options.html#opt-programs.kakoune.config.numberLines"><code class="option">programs.kakoune.config.numberLines</code></a></span></dt><dd><p>Settings for the number lines highlighter.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.numberLines.enable"></a><a class="term" href="options.html#opt-programs.kakoune.config.numberLines.enable"><code class="option">programs.kakoune.config.numberLines.enable</code></a></span></dt><dd><p>Whether to enable the number lines highlighter.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.numberLines.highlightCursor"></a><a class="term" href="options.html#opt-programs.kakoune.config.numberLines.highlightCursor"><code class="option">programs.kakoune.config.numberLines.highlightCursor</code></a></span></dt><dd><p>Highlight the cursor line with a separate face.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.numberLines.relative"></a><a class="term" href="options.html#opt-programs.kakoune.config.numberLines.relative"><code class="option">programs.kakoune.config.numberLines.relative</code></a></span></dt><dd><p>Show line numbers relative to the main cursor line.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.numberLines.separator"></a><a class="term" href="options.html#opt-programs.kakoune.config.numberLines.separator"><code class="option">programs.kakoune.config.numberLines.separator</code></a></span></dt><dd><p>String that separates the line number column from the
|
||
buffer contents. The kakoune default is
|
||
<code class="literal">"|"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.scrollOff"></a><a class="term" href="options.html#opt-programs.kakoune.config.scrollOff"><code class="option">programs.kakoune.config.scrollOff</code></a></span></dt><dd><p>How many lines and columns to keep visible around the cursor.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.scrollOff.columns"></a><a class="term" href="options.html#opt-programs.kakoune.config.scrollOff.columns"><code class="option">programs.kakoune.config.scrollOff.columns</code></a></span></dt><dd><p>The number of columns to keep visible around the cursor.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.scrollOff.lines"></a><a class="term" href="options.html#opt-programs.kakoune.config.scrollOff.lines"><code class="option">programs.kakoune.config.scrollOff.lines</code></a></span></dt><dd><p>The number of lines to keep visible around the cursor.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showMatching"></a><a class="term" href="options.html#opt-programs.kakoune.config.showMatching"><code class="option">programs.kakoune.config.showMatching</code></a></span></dt><dd><p>Highlight the matching char of the character under the
|
||
selections' cursor using the <code class="literal">MatchingChar</code>
|
||
face.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace"><code class="option">programs.kakoune.config.showWhitespace</code></a></span></dt><dd><p>Settings for the show whitespaces highlighter.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace.enable"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace.enable"><code class="option">programs.kakoune.config.showWhitespace.enable</code></a></span></dt><dd><p>Whether to enable the show whitespace highlighter.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace.lineFeed"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace.lineFeed"><code class="option">programs.kakoune.config.showWhitespace.lineFeed</code></a></span></dt><dd><p>The character to display for line feeds.
|
||
The kakoune default is <code class="literal">"¬"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace.nonBreakingSpace"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace.nonBreakingSpace"><code class="option">programs.kakoune.config.showWhitespace.nonBreakingSpace</code></a></span></dt><dd><p>The character to display for non-breaking spaces.
|
||
The kakoune default is <code class="literal">"⍽"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace.space"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace.space"><code class="option">programs.kakoune.config.showWhitespace.space</code></a></span></dt><dd><p>The character to display for spaces.
|
||
The kakoune default is <code class="literal">"·"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace.tab"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace.tab"><code class="option">programs.kakoune.config.showWhitespace.tab</code></a></span></dt><dd><p>The character to display for tabs.
|
||
The kakoune default is <code class="literal">"→"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.showWhitespace.tabStop"></a><a class="term" href="options.html#opt-programs.kakoune.config.showWhitespace.tabStop"><code class="option">programs.kakoune.config.showWhitespace.tabStop</code></a></span></dt><dd><p>The character to append to tabs to reach the width of a tabstop.
|
||
The kakoune default is <code class="literal">" "</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.tabStop"></a><a class="term" href="options.html#opt-programs.kakoune.config.tabStop"><code class="option">programs.kakoune.config.tabStop</code></a></span></dt><dd><p>The width of a tab in spaces. The kakoune default is
|
||
<code class="literal">6</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui"><code class="option">programs.kakoune.config.ui</code></a></span></dt><dd><p>Settings for the ncurses interface.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.enableMouse"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.enableMouse"><code class="option">programs.kakoune.config.ui.enableMouse</code></a></span></dt><dd><p>Whether to enable mouse support.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.assistant"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.assistant"><code class="option">programs.kakoune.config.ui.assistant</code></a></span></dt><dd><p>The assistant displayed in info boxes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "clippy", "cat", "dilbert", "none"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"clippy"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.changeColors"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.changeColors"><code class="option">programs.kakoune.config.ui.changeColors</code></a></span></dt><dd><p>Change color palette.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.setTitle"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.setTitle"><code class="option">programs.kakoune.config.ui.setTitle</code></a></span></dt><dd><p>Change the title of the terminal emulator.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.shiftFunctionKeys"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.shiftFunctionKeys"><code class="option">programs.kakoune.config.ui.shiftFunctionKeys</code></a></span></dt><dd><p>Amount by which shifted function keys are offset. That
|
||
is, if the terminal sends F13 for Shift-F1, this
|
||
should be <code class="literal">12</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.statusLine"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.statusLine"><code class="option">programs.kakoune.config.ui.statusLine</code></a></span></dt><dd><p>Where to display the status line.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "top", "bottom"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"bottom"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.useBuiltinKeyParser"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.useBuiltinKeyParser"><code class="option">programs.kakoune.config.ui.useBuiltinKeyParser</code></a></span></dt><dd><p>Bypass ncurses key parser and use an internal one.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.wheelDownButton"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.wheelDownButton"><code class="option">programs.kakoune.config.ui.wheelDownButton</code></a></span></dt><dd><p>Button to send for wheel down events.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.ui.wheelUpButton"></a><a class="term" href="options.html#opt-programs.kakoune.config.ui.wheelUpButton"><code class="option">programs.kakoune.config.ui.wheelUpButton</code></a></span></dt><dd><p>Button to send for wheel up events.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.wrapLines"></a><a class="term" href="options.html#opt-programs.kakoune.config.wrapLines"><code class="option">programs.kakoune.config.wrapLines</code></a></span></dt><dd><p>Settings for the wrap lines highlighter.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.wrapLines.enable"></a><a class="term" href="options.html#opt-programs.kakoune.config.wrapLines.enable"><code class="option">programs.kakoune.config.wrapLines.enable</code></a></span></dt><dd><p>Whether to enable the wrap lines highlighter.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.wrapLines.indent"></a><a class="term" href="options.html#opt-programs.kakoune.config.wrapLines.indent"><code class="option">programs.kakoune.config.wrapLines.indent</code></a></span></dt><dd><p>Preserve line indentation when wrapping.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.wrapLines.marker"></a><a class="term" href="options.html#opt-programs.kakoune.config.wrapLines.marker"><code class="option">programs.kakoune.config.wrapLines.marker</code></a></span></dt><dd><p>Prefix wrapped lines with marker text.
|
||
If not <code class="literal">null</code>,
|
||
the marker text will be displayed in the indentation if possible.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"⏎"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.wrapLines.maxWidth"></a><a class="term" href="options.html#opt-programs.kakoune.config.wrapLines.maxWidth"><code class="option">programs.kakoune.config.wrapLines.maxWidth</code></a></span></dt><dd><p>Wrap text at maxWidth, even if the window is wider.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.config.wrapLines.word"></a><a class="term" href="options.html#opt-programs.kakoune.config.wrapLines.word"><code class="option">programs.kakoune.config.wrapLines.word</code></a></span></dt><dd><p>Wrap at word boundaries instead of codepoint boundaries.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.extraConfig"></a><a class="term" href="options.html#opt-programs.kakoune.extraConfig"><code class="option">programs.kakoune.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to
|
||
<code class="filename">$XDG_CONFIG_HOME/kak/kakrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.plugins"></a><a class="term" href="options.html#opt-programs.kakoune.plugins"><code class="option">programs.kakoune.plugins</code></a></span></dt><dd><p>List of kakoune plugins to install. To get a list of
|
||
supported plugins run:
|
||
<span class="command"><strong>nix-env -f '<nixpkgs>' -qaP -A kakounePlugins</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.kakounePlugins.kak-fzf ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kakoune.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kakoune.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.enable"></a><a class="term" href="options.html#opt-programs.keychain.enable"><code class="option">programs.keychain.enable</code></a></span></dt><dd><p>Whether to enable keychain.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.keychain.enableBashIntegration"><code class="option">programs.keychain.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.keychain.enableFishIntegration"><code class="option">programs.keychain.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.enableXsessionIntegration"></a><a class="term" href="options.html#opt-programs.keychain.enableXsessionIntegration"><code class="option">programs.keychain.enableXsessionIntegration</code></a></span></dt><dd><p>Whether to run keychain from your <code class="filename">~/.xsession</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.keychain.enableZshIntegration"><code class="option">programs.keychain.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.package"></a><a class="term" href="options.html#opt-programs.keychain.package"><code class="option">programs.keychain.package</code></a></span></dt><dd><p>Keychain package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.keychain</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.agents"></a><a class="term" href="options.html#opt-programs.keychain.agents"><code class="option">programs.keychain.agents</code></a></span></dt><dd><p>Agents to add.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.extraFlags"></a><a class="term" href="options.html#opt-programs.keychain.extraFlags"><code class="option">programs.keychain.extraFlags</code></a></span></dt><dd><p>Extra flags to pass to keychain.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"--quiet"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.inheritType"></a><a class="term" href="options.html#opt-programs.keychain.inheritType"><code class="option">programs.keychain.inheritType</code></a></span></dt><dd><p>Inherit type to attempt from agent variables from the environment.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "local", "any", "local-once", "any-once"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.keychain.keys"></a><a class="term" href="options.html#opt-programs.keychain.keys"><code class="option">programs.keychain.keys</code></a></span></dt><dd><p>Keys to add to keychain.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"id_rsa"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/keychain.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/keychain.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.enable"></a><a class="term" href="options.html#opt-programs.kitty.enable"><code class="option">programs.kitty.enable</code></a></span></dt><dd><p>Whether to enable Kitty terminal emulator.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.package"></a><a class="term" href="options.html#opt-programs.kitty.package"><code class="option">programs.kitty.package</code></a></span></dt><dd><p>Kitty package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.kitty</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.darwinLaunchOptions"></a><a class="term" href="options.html#opt-programs.kitty.darwinLaunchOptions"><code class="option">programs.kitty.darwinLaunchOptions</code></a></span></dt><dd><p>Command-line options to use when launched by Mac OS GUI</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
"--single-instance"
|
||
"--directory=/tmp/my-dir"
|
||
"--listen-on=unix:/tmp/my-socket"
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.environment"></a><a class="term" href="options.html#opt-programs.kitty.environment"><code class="option">programs.kitty.environment</code></a></span></dt><dd><p>Environment variables to set or override.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"LS_COLORS" = "1";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.extraConfig"></a><a class="term" href="options.html#opt-programs.kitty.extraConfig"><code class="option">programs.kitty.extraConfig</code></a></span></dt><dd><p>Additional configuration to add.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.font"></a><a class="term" href="options.html#opt-programs.kitty.font"><code class="option">programs.kitty.font</code></a></span></dt><dd><p>The font to use.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.font.package"></a><a class="term" href="options.html#opt-programs.kitty.font.package"><code class="option">programs.kitty.font.package</code></a></span></dt><dd><p>Package providing the font. This package will be installed
|
||
to your profile. If <code class="literal">null</code> then the font
|
||
is assumed to already be available in your profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.dejavu_fonts</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.font.name"></a><a class="term" href="options.html#opt-programs.kitty.font.name"><code class="option">programs.kitty.font.name</code></a></span></dt><dd><p>The family name of the font within the package.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"DejaVu Sans"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.font.size"></a><a class="term" href="options.html#opt-programs.kitty.font.size"><code class="option">programs.kitty.font.size</code></a></span></dt><dd><p>The size of the font.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.keybindings"></a><a class="term" href="options.html#opt-programs.kitty.keybindings"><code class="option">programs.kitty.keybindings</code></a></span></dt><dd><p>Mapping of keybindings to actions.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"ctrl+c" = "copy_or_interrupt";
|
||
"ctrl+f>2" = "set_font_size 20";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.settings"></a><a class="term" href="options.html#opt-programs.kitty.settings"><code class="option">programs.kitty.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/kitty/kitty.conf</code>. See
|
||
<a class="link" href="https://sw.kovidgoyal.net/kitty/conf.html" target="_top">https://sw.kovidgoyal.net/kitty/conf.html</a>
|
||
for the documentation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
scrollback_lines = 10000;
|
||
enable_audio_bell = false;
|
||
update_check_interval = 0;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kitty.theme"></a><a class="term" href="options.html#opt-programs.kitty.theme"><code class="option">programs.kitty.theme</code></a></span></dt><dd><p>Apply a Kitty color theme. This option takes the friendly name of
|
||
any theme given by the command <span class="command"><strong>kitty +kitten themes</strong></span>.
|
||
See <a class="link" href="https://github.com/kovidgoyal/kitty-themes" target="_top">https://github.com/kovidgoyal/kitty-themes</a>
|
||
for more details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Space Gray Eighties"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kitty.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kitty.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.enable"></a><a class="term" href="options.html#opt-programs.kodi.enable"><code class="option">programs.kodi.enable</code></a></span></dt><dd><p>Whether to enable Kodi.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kodi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kodi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.package"></a><a class="term" href="options.html#opt-programs.kodi.package"><code class="option">programs.kodi.package</code></a></span></dt><dd><p>The <code class="literal">kodi</code> package to use.
|
||
Can be used to specify extensions.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.kodi</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ pkgs.kodi.withPackages (exts: [ exts.pvr-iptvsimple ]) }
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kodi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kodi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.addonSettings"></a><a class="term" href="options.html#opt-programs.kodi.addonSettings"><code class="option">programs.kodi.addonSettings</code></a></span></dt><dd><p>Attribute set with the plugin namespace as toplevel key and the plugins
|
||
settings as lower level key/value pairs.
|
||
</p><p>
|
||
Kodi will still show the settings of plugins configured via this
|
||
mechanism in the GUI and they appear to be mutable. This however is
|
||
not the case and the settings will stay as specified via Home Manager.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ "service.xbmc.versioncheck".versioncheck_enable = "false"; }
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kodi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kodi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.datadir"></a><a class="term" href="options.html#opt-programs.kodi.datadir"><code class="option">programs.kodi.datadir</code></a></span></dt><dd><p>Directory to store configuration and metadata.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"${config.home.homeDirectory}/.kodi"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"${config.xdg.dataHome}/kodi"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kodi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kodi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.settings"></a><a class="term" href="options.html#opt-programs.kodi.settings"><code class="option">programs.kodi.settings</code></a></span></dt><dd><p>Configuration to write to the <code class="literal">advancedsettings.xml</code>
|
||
file in kodis userdata directory. Settings specified here will be
|
||
immutable from inside kodi and be hidden from the GUI settings dialog.
|
||
</p><p>
|
||
See <a class="link" href="https://kodi.wiki/view/Advancedsettings.xml" target="_top">https://kodi.wiki/view/Advancedsettings.xml</a> as
|
||
reference for how settings need to be specified.
|
||
</p><p>
|
||
The innermost attributes must be of type str.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute sets of strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ videolibrary.showemptytvshows = "true"; }
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kodi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kodi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.sources"></a><a class="term" href="options.html#opt-programs.kodi.sources"><code class="option">programs.kodi.sources</code></a></span></dt><dd><p>Contents to populate the file <code class="literal">sources.xml</code> in kodis
|
||
userdata directory.
|
||
</p><p>
|
||
See <a class="link" href="https://kodi.wiki/view/Sources.xml" target="_top">https://kodi.wiki/view/Sources.xml</a> as
|
||
reference for how sources need to be specified.
|
||
</p><p>
|
||
Kodi will still show the dialogs to modify sources in the GUI and they
|
||
appear to be mutable. This however is not the case and the sources will
|
||
stay as specified via Home Manager.
|
||
</p><p>
|
||
The innermost attributes must be of type str.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute sets or lists of strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
video = {
|
||
default = "movies";
|
||
source = [
|
||
{ name = "videos"; path = "/path/to/videos"; allowsharing = "true"; }
|
||
{ name = "movies"; path = "/path/to/movies"; allowsharing = "true"; }
|
||
];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/kodi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/kodi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lazygit.enable"></a><a class="term" href="options.html#opt-programs.lazygit.enable"><code class="option">programs.lazygit.enable</code></a></span></dt><dd><p>Whether to enable lazygit, a simple terminal UI for git commands.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lazygit.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lazygit.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lazygit.settings"></a><a class="term" href="options.html#opt-programs.lazygit.settings"><code class="option">programs.lazygit.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/lazygit/config.yml</code> on Linux
|
||
or <code class="filename">~/Library/Application Support/lazygit/config.yml</code> on Darwin. See
|
||
<a class="link" href="https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md" target="_top">https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md</a>
|
||
for supported values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
gui.theme = {
|
||
lightTheme = true;
|
||
activeBorderColor = [ "blue" "bold" ];
|
||
inactiveBorderColor = [ "black" ];
|
||
selectedLineBgColor = [ "default" ];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lazygit.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lazygit.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.less.enable"></a><a class="term" href="options.html#opt-programs.less.enable"><code class="option">programs.less.enable</code></a></span></dt><dd><p>Whether to enable less, opposite of more.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/less.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/less.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.less.keys"></a><a class="term" href="options.html#opt-programs.less.keys"><code class="option">programs.less.keys</code></a></span></dt><dd><p>Extra configuration for <span class="command"><strong>less</strong></span> written to
|
||
<code class="filename">$XDG_CONFIG_HOME/lesskey</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
s back-line
|
||
t forw-line
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/less.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/less.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lesspipe.enable"></a><a class="term" href="options.html#opt-programs.lesspipe.enable"><code class="option">programs.lesspipe.enable</code></a></span></dt><dd><p>Whether to enable lesspipe preprocessor for less.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lesspipe.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lesspipe.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.enable"></a><a class="term" href="options.html#opt-programs.lf.enable"><code class="option">programs.lf.enable</code></a></span></dt><dd><p>Whether to enable lf.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.package"></a><a class="term" href="options.html#opt-programs.lf.package"><code class="option">programs.lf.package</code></a></span></dt><dd><p>lf package to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.lf</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.cmdKeybindings"></a><a class="term" href="options.html#opt-programs.lf.cmdKeybindings"><code class="option">programs.lf.cmdKeybindings</code></a></span></dt><dd><p>Keys to bind to command line commands which can only be one of the
|
||
builtin commands. Keys set to null or an empty string are deleted.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">{ "<c-g>" = "cmd-escape"; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.commands"></a><a class="term" href="options.html#opt-programs.lf.commands"><code class="option">programs.lf.commands</code></a></span></dt><dd><p>Commands to declare. Commands set to null or an empty string are
|
||
deleted.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
get-mime-type = ''%xdg-mime query filetype "$f"''; open = "$$OPENER $f";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.extraConfig"></a><a class="term" href="options.html#opt-programs.lf.extraConfig"><code class="option">programs.lf.extraConfig</code></a></span></dt><dd><p>Custom lfrc lines.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
$mkdir -p ~/.trash
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.keybindings"></a><a class="term" href="options.html#opt-programs.lf.keybindings"><code class="option">programs.lf.keybindings</code></a></span></dt><dd><p>Keys to bind. Keys set to null or an empty string are deleted.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
D = "trash"; U = "!du -sh"; gg = null; gh = "cd ~"; i = "$less $f";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.previewer.keybinding"></a><a class="term" href="options.html#opt-programs.lf.previewer.keybinding"><code class="option">programs.lf.previewer.keybinding</code></a></span></dt><dd><p>Key to bind to the script at <code class="varname">previewer.source</code> and
|
||
pipe through less. Setting to null will not bind any key.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"i"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.previewer.source"></a><a class="term" href="options.html#opt-programs.lf.previewer.source"><code class="option">programs.lf.previewer.source</code></a></span></dt><dd><p>Script or executable to use to preview files. Sets lf's
|
||
<code class="varname">previewer</code> option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.writeShellScript "pv.sh" ''
|
||
#!/bin/sh
|
||
|
||
case "$1" in
|
||
*.tar*) tar tf "$1";;
|
||
*.zip) unzip -l "$1";;
|
||
*.rar) unrar l "$1";;
|
||
*.7z) 7z l "$1";;
|
||
*.pdf) pdftotext "$1" -;;
|
||
*) highlight -O ansi "$1" || cat "$1";;
|
||
esac
|
||
''
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lf.settings"></a><a class="term" href="options.html#opt-programs.lf.settings"><code class="option">programs.lf.settings</code></a></span></dt><dd><p>An attribute set of lf settings. The attribute names and corresponding
|
||
values must be among the following supported options.
|
||
|
||
</p><div class="informaltable"><table class="informaltable" border="0"><colgroup><col /></colgroup><tbody><tr><td><code class="varname">anchorfind</code></td><td>boolean</td></tr><tr><td><code class="varname">color256</code></td><td>boolean</td></tr><tr><td><code class="varname">dircounts</code></td><td>boolean</td></tr><tr><td><code class="varname">dirfirst</code></td><td>boolean</td></tr><tr><td><code class="varname">drawbox</code></td><td>boolean</td></tr><tr><td><code class="varname">errorfmt</code></td><td>string</td></tr><tr><td><code class="varname">filesep</code></td><td>string</td></tr><tr><td><code class="varname">findlen</code></td><td>signed integer</td></tr><tr><td><code class="varname">globsearch</code></td><td>boolean</td></tr><tr><td><code class="varname">hidden</code></td><td>boolean</td></tr><tr><td><code class="varname">icons</code></td><td>boolean</td></tr><tr><td><code class="varname">ifs</code></td><td>string</td></tr><tr><td><code class="varname">ignorecase</code></td><td>boolean</td></tr><tr><td><code class="varname">ignoredia</code></td><td>boolean</td></tr><tr><td><code class="varname">incsearch</code></td><td>boolean</td></tr><tr><td><code class="varname">info</code></td><td>string</td></tr><tr><td><code class="varname">number</code></td><td>boolean</td></tr><tr><td><code class="varname">period</code></td><td>signed integer</td></tr><tr><td><code class="varname">preview</code></td><td>boolean</td></tr><tr><td><code class="varname">promptfmt</code></td><td>string</td></tr><tr><td><code class="varname">ratios</code></td><td>string</td></tr><tr><td><code class="varname">relativenumber</code></td><td>boolean</td></tr><tr><td><code class="varname">reverse</code></td><td>boolean</td></tr><tr><td><code class="varname">scrolloff</code></td><td>signed integer</td></tr><tr><td><code class="varname">shell</code></td><td>string</td></tr><tr><td><code class="varname">shellopts</code></td><td>string</td></tr><tr><td><code class="varname">smartcase</code></td><td>boolean</td></tr><tr><td><code class="varname">smartdia</code></td><td>boolean</td></tr><tr><td><code class="varname">sortby</code></td><td>string</td></tr><tr><td><code class="varname">tabstop</code></td><td>signed integer</td></tr><tr><td><code class="varname">timefmt</code></td><td>string</td></tr><tr><td><code class="varname">wrapscan</code></td><td>boolean</td></tr><tr><td><code class="varname">wrapscroll</code></td><td>boolean</td></tr></tbody></table></div><p>
|
||
|
||
See the lf documentation for detailed descriptions of these options.
|
||
Note, use <code class="varname">previewer</code> to set lf's
|
||
<code class="varname">previewer</code> option, and
|
||
<code class="varname">extraConfig</code> for any other option not listed above.
|
||
All string options are quoted with double quotes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
number = true; ratios = "1:1:2"; tabstop = 4;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lf.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lf.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lieer.enable"></a><a class="term" href="options.html#opt-programs.lieer.enable"><code class="option">programs.lieer.enable</code></a></span></dt><dd><p>Whether to enable lieer Gmail synchronization for notmuch.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lieer.package"></a><a class="term" href="options.html#opt-programs.lieer.package"><code class="option">programs.lieer.package</code></a></span></dt><dd><p>lieer package to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.gmailieer"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lsd.enable"></a><a class="term" href="options.html#opt-programs.lsd.enable"><code class="option">programs.lsd.enable</code></a></span></dt><dd><p>Whether to enable lsd.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lsd.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lsd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lsd.enableAliases"></a><a class="term" href="options.html#opt-programs.lsd.enableAliases"><code class="option">programs.lsd.enableAliases</code></a></span></dt><dd><p>Whether to enable recommended lsd aliases.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lsd.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lsd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lsd.settings"></a><a class="term" href="options.html#opt-programs.lsd.settings"><code class="option">programs.lsd.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/lsd/config.yaml</code>. See
|
||
<a class="link" href="https://github.com/Peltoche/lsd#config-file-content" target="_top">https://github.com/Peltoche/lsd#config-file-content</a>
|
||
for supported values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
date = "relative"; ignore-globs =
|
||
[
|
||
".git" ".hg"
|
||
]
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/lsd.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/lsd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.enable"></a><a class="term" href="options.html#opt-programs.mako.enable"><code class="option">programs.mako.enable</code></a></span></dt><dd><p>Whether to enable Mako, lightweight notification daemon for Wayland
|
||
.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.package"></a><a class="term" href="options.html#opt-programs.mako.package"><code class="option">programs.mako.package</code></a></span></dt><dd><p>The mako package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.mako</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.actions"></a><a class="term" href="options.html#opt-programs.mako.actions"><code class="option">programs.mako.actions</code></a></span></dt><dd><p>Applications may request an action to be associated with activating a
|
||
notification. Disabling this will cause mako to ignore these requests.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.anchor"></a><a class="term" href="options.html#opt-programs.mako.anchor"><code class="option">programs.mako.anchor</code></a></span></dt><dd><p>Show notifications at the specified position on the output.
|
||
Supported values are top-right, top-center, top-left, bottom-right,
|
||
bottom-center, bottom-left, and center.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "top-right", "top-center", "top-left", "bottom-right", "bottom-center", "bottom-left", "center"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"top-right"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.backgroundColor"></a><a class="term" href="options.html#opt-programs.mako.backgroundColor"><code class="option">programs.mako.backgroundColor</code></a></span></dt><dd><p>Set popup background color to a specific color, represented in hex
|
||
color code.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#285577FF"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.borderColor"></a><a class="term" href="options.html#opt-programs.mako.borderColor"><code class="option">programs.mako.borderColor</code></a></span></dt><dd><p>Set popup border color to a specific color, represented in hex color
|
||
code.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#4C7899FF"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.borderRadius"></a><a class="term" href="options.html#opt-programs.mako.borderRadius"><code class="option">programs.mako.borderRadius</code></a></span></dt><dd><p>Set popup corner radius to the specified number of pixels.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.borderSize"></a><a class="term" href="options.html#opt-programs.mako.borderSize"><code class="option">programs.mako.borderSize</code></a></span></dt><dd><p>Set popup border size to the specified number of pixels.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">1</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.defaultTimeout"></a><a class="term" href="options.html#opt-programs.mako.defaultTimeout"><code class="option">programs.mako.defaultTimeout</code></a></span></dt><dd><p>Set the default timeout to timeout in milliseconds. To disable the
|
||
timeout, set it to zero.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.extraConfig"></a><a class="term" href="options.html#opt-programs.mako.extraConfig"><code class="option">programs.mako.extraConfig</code></a></span></dt><dd><p>Additional configuration.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[urgency=low]
|
||
border-color=#b8bb26
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.font"></a><a class="term" href="options.html#opt-programs.mako.font"><code class="option">programs.mako.font</code></a></span></dt><dd><p>Font to use, in Pango format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"monospace 10"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.format"></a><a class="term" href="options.html#opt-programs.mako.format"><code class="option">programs.mako.format</code></a></span></dt><dd><p>Set notification format string to format. See FORMAT SPECIFIERS for
|
||
more information. To change this for grouped notifications, set it
|
||
within a grouped criteria.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">''<b>%s</b>\n%b''</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.groupBy"></a><a class="term" href="options.html#opt-programs.mako.groupBy"><code class="option">programs.mako.groupBy</code></a></span></dt><dd><p>A comma-separated list of criteria fields that will be compared to
|
||
other visible notifications to determine if this one should form a
|
||
group with them. All listed criteria must be exactly equal for two
|
||
notifications to group.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.height"></a><a class="term" href="options.html#opt-programs.mako.height"><code class="option">programs.mako.height</code></a></span></dt><dd><p>Set maximum height of notification popups. Notifications whose text
|
||
takes up less space are shrunk to fit.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">100</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.iconPath"></a><a class="term" href="options.html#opt-programs.mako.iconPath"><code class="option">programs.mako.iconPath</code></a></span></dt><dd><p>Paths to search for icons when a notification specifies a name
|
||
instead of a full path. Colon-delimited. This approximates the search
|
||
algorithm used by the XDG Icon Theme Specification, but does not
|
||
support any of the theme metadata. Therefore, if you want to search
|
||
parent themes, you'll need to add them to the path manually.
|
||
</p><p>
|
||
The <code class="filename">/usr/share/icons/hicolor</code> and
|
||
<code class="filename">/usr/share/pixmaps</code> directories are
|
||
always searched.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.icons"></a><a class="term" href="options.html#opt-programs.mako.icons"><code class="option">programs.mako.icons</code></a></span></dt><dd><p>Whether or not to show icons in notifications.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.ignoreTimeout"></a><a class="term" href="options.html#opt-programs.mako.ignoreTimeout"><code class="option">programs.mako.ignoreTimeout</code></a></span></dt><dd><p>If set, mako will ignore the expire timeout sent by notifications
|
||
and use the one provided by default-timeout instead.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.layer"></a><a class="term" href="options.html#opt-programs.mako.layer"><code class="option">programs.mako.layer</code></a></span></dt><dd><p>Arrange mako at the specified layer, relative to normal windows.
|
||
Supported values are background, bottom, top, and overlay. Using
|
||
overlay will cause notifications to be displayed above fullscreen
|
||
windows, though this may also occur at top depending on your
|
||
compositor.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "background", "bottom", "top", "overlay"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"top"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.margin"></a><a class="term" href="options.html#opt-programs.mako.margin"><code class="option">programs.mako.margin</code></a></span></dt><dd><p>Set margin of each edge specified in pixels. Specify single value to
|
||
apply margin on all sides. Two comma-seperated values will set
|
||
vertical and horizontal edges seperately. Four comma-seperated will
|
||
give each edge a seperate value.
|
||
For example: 10,20,5 will set top margin to 10, left and right to 20
|
||
and bottom to five.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"10"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.markup"></a><a class="term" href="options.html#opt-programs.mako.markup"><code class="option">programs.mako.markup</code></a></span></dt><dd><p>If 1, enable Pango markup. If 0, disable Pango markup. If enabled,
|
||
Pango markup will be interpreted in your format specifier and in the
|
||
body of notifications.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.maxIconSize"></a><a class="term" href="options.html#opt-programs.mako.maxIconSize"><code class="option">programs.mako.maxIconSize</code></a></span></dt><dd><p>Set maximum icon size to the specified number of pixels.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">64</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.maxVisible"></a><a class="term" href="options.html#opt-programs.mako.maxVisible"><code class="option">programs.mako.maxVisible</code></a></span></dt><dd><p>Set maximum number of visible notifications. Set -1 to show all.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.output"></a><a class="term" href="options.html#opt-programs.mako.output"><code class="option">programs.mako.output</code></a></span></dt><dd><p>Show notifications on the specified output. If empty, notifications
|
||
will appear on the focused output. Requires the compositor to support
|
||
the Wayland protocol xdg-output-unstable-v1 version 2.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.padding"></a><a class="term" href="options.html#opt-programs.mako.padding"><code class="option">programs.mako.padding</code></a></span></dt><dd><p>Set padding of each edge specified in pixels. Specify single value to
|
||
apply margin on all sides. Two comma-seperated values will set
|
||
vertical and horizontal edges seperately. Four comma-seperated will
|
||
give each edge a seperate value.
|
||
For example: 10,20,5 will set top margin to 10, left and right to 20
|
||
and bottom to five.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.progressColor"></a><a class="term" href="options.html#opt-programs.mako.progressColor"><code class="option">programs.mako.progressColor</code></a></span></dt><dd><p>Set popup progress indicator color to a specific color,
|
||
represented in hex color code. To draw the progress
|
||
indicator on top of the background color, use the
|
||
<code class="literal">over</code> attribute. To replace the background
|
||
color, use the <code class="literal">source</code> attribute (this can
|
||
be useful when the notification is semi-transparent).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"over #5588AAFF"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.sort"></a><a class="term" href="options.html#opt-programs.mako.sort"><code class="option">programs.mako.sort</code></a></span></dt><dd><p>Sorts incoming notifications by time and/or priority in ascending(+)
|
||
or descending(-) order.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "+time", "-time", "+priority", "-priority"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"-time"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.textColor"></a><a class="term" href="options.html#opt-programs.mako.textColor"><code class="option">programs.mako.textColor</code></a></span></dt><dd><p>Set popup text color to a specific color, represented in hex color
|
||
code.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#FFFFFFFF"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mako.width"></a><a class="term" href="options.html#opt-programs.mako.width"><code class="option">programs.mako.width</code></a></span></dt><dd><p>Set width of notification popups in specified number of pixels.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">300</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mako.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mako.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.man.enable"></a><a class="term" href="options.html#opt-programs.man.enable"><code class="option">programs.man.enable</code></a></span></dt><dd><p>Whether to enable manual pages and the <span class="command"><strong>man</strong></span>
|
||
command. This also includes "man" outputs of all
|
||
<code class="literal">home.packages</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/man.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/man.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.man.package"></a><a class="term" href="options.html#opt-programs.man.package"><code class="option">programs.man.package</code></a></span></dt><dd><p>The man package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.man</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/man.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/man.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.man.generateCaches"></a><a class="term" href="options.html#opt-programs.man.generateCaches"><code class="option">programs.man.generateCaches</code></a></span></dt><dd><p>Whether to generate the manual page index caches using
|
||
<span class="citerefentry"><span class="refentrytitle">mandb</span>(8)</span>. This allows searching for a page or
|
||
keyword using utilities like <span class="citerefentry"><span class="refentrytitle">apropos</span>(1)</span>.
|
||
</p><p>
|
||
This feature is disabled by default because it slows down
|
||
building. If you don't mind waiting a few more seconds when
|
||
Home Manager builds a new generation, you may safely enable
|
||
this option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/man.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/man.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mangohud.enable"></a><a class="term" href="options.html#opt-programs.mangohud.enable"><code class="option">programs.mangohud.enable</code></a></span></dt><dd><p>Whether to enable Mangohud.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mangohud.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mangohud.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mangohud.enableSessionWide"></a><a class="term" href="options.html#opt-programs.mangohud.enableSessionWide"><code class="option">programs.mangohud.enableSessionWide</code></a></span></dt><dd><p>Sets environment variables so that
|
||
MangoHud is started on any application that supports it.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mangohud.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mangohud.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mangohud.package"></a><a class="term" href="options.html#opt-programs.mangohud.package"><code class="option">programs.mangohud.package</code></a></span></dt><dd><p>The Mangohud package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.mangohud</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mangohud.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mangohud.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mangohud.settings"></a><a class="term" href="options.html#opt-programs.mangohud.settings"><code class="option">programs.mangohud.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/MangoHud/MangoHud.conf</code>. See
|
||
<a class="link" href="https://github.com/flightlessmango/MangoHud/blob/master/bin/MangoHud.conf" target="_top">https://github.com/flightlessmango/MangoHud/blob/master/bin/MangoHud.conf</a>
|
||
for the default configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or floating point number or string or path or list of signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
output_folder = ~/Documents/mangohud/;
|
||
full = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mangohud.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mangohud.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mangohud.settingsPerApplication"></a><a class="term" href="options.html#opt-programs.mangohud.settingsPerApplication"><code class="option">programs.mangohud.settingsPerApplication</code></a></span></dt><dd><p>Sets MangoHud settings per application.
|
||
Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/MangoHud/{application_name}.conf</code>. See
|
||
<a class="link" href="https://github.com/flightlessmango/MangoHud/blob/master/bin/MangoHud.conf" target="_top">https://github.com/flightlessmango/MangoHud/blob/master/bin/MangoHud.conf</a>
|
||
for the default configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of boolean or signed integer or floating point number or string or path or list of signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
mpv = {
|
||
no_display = true;
|
||
}
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mangohud.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mangohud.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.matplotlib.enable"></a><a class="term" href="options.html#opt-programs.matplotlib.enable"><code class="option">programs.matplotlib.enable</code></a></span></dt><dd><p>Whether to enable matplotlib, a plotting library for python.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/matplotlib.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/matplotlib.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.matplotlib.config"></a><a class="term" href="options.html#opt-programs.matplotlib.config"><code class="option">programs.matplotlib.config</code></a></span></dt><dd><p>Add terms to the <code class="filename">matplotlibrc</code> file to
|
||
control the default matplotlib behavior.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
backend = "Qt5Agg";
|
||
axes = {
|
||
grid = true;
|
||
facecolor = "black";
|
||
edgecolor = "FF9900";
|
||
};
|
||
grid.color = "FF9900";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/matplotlib.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/matplotlib.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.matplotlib.extraConfig"></a><a class="term" href="options.html#opt-programs.matplotlib.extraConfig"><code class="option">programs.matplotlib.extraConfig</code></a></span></dt><dd><p>Additional commands for matplotlib that will be added to the
|
||
<code class="filename">matplotlibrc</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/matplotlib.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/matplotlib.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mbsync.enable"></a><a class="term" href="options.html#opt-programs.mbsync.enable"><code class="option">programs.mbsync.enable</code></a></span></dt><dd><p>Whether to enable mbsync IMAP4 and Maildir mailbox synchronizer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mbsync.package"></a><a class="term" href="options.html#opt-programs.mbsync.package"><code class="option">programs.mbsync.package</code></a></span></dt><dd><p>The package to use for the mbsync binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.isync</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.isync</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mbsync.extraConfig"></a><a class="term" href="options.html#opt-programs.mbsync.extraConfig"><code class="option">programs.mbsync.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to the mbsync configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mbsync.groups"></a><a class="term" href="options.html#opt-programs.mbsync.groups"><code class="option">programs.mbsync.groups</code></a></span></dt><dd><p>Definition of groups.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
inboxes = {
|
||
account1 = [ "Inbox" ];
|
||
account2 = [ "Inbox" ];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.enable"></a><a class="term" href="options.html#opt-programs.mcfly.enable"><code class="option">programs.mcfly.enable</code></a></span></dt><dd><p>Whether to enable mcfly.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.mcfly.enableBashIntegration"><code class="option">programs.mcfly.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.mcfly.enableFishIntegration"><code class="option">programs.mcfly.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.enableFuzzySearch"></a><a class="term" href="options.html#opt-programs.mcfly.enableFuzzySearch"><code class="option">programs.mcfly.enableFuzzySearch</code></a></span></dt><dd><p>Whether to enable fuzzy searching.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.enableLightTheme"></a><a class="term" href="options.html#opt-programs.mcfly.enableLightTheme"><code class="option">programs.mcfly.enableLightTheme</code></a></span></dt><dd><p>Whether to enable light mode theme.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.mcfly.enableZshIntegration"><code class="option">programs.mcfly.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mcfly.keyScheme"></a><a class="term" href="options.html#opt-programs.mcfly.keyScheme"><code class="option">programs.mcfly.keyScheme</code></a></span></dt><dd><p>Key scheme to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "emacs", "vim"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"emacs"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mcfly.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mcfly.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.enable"></a><a class="term" href="options.html#opt-programs.mercurial.enable"><code class="option">programs.mercurial.enable</code></a></span></dt><dd><p>Whether to enable Mercurial.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.package"></a><a class="term" href="options.html#opt-programs.mercurial.package"><code class="option">programs.mercurial.package</code></a></span></dt><dd><p>Mercurial package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.mercurial</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.aliases"></a><a class="term" href="options.html#opt-programs.mercurial.aliases"><code class="option">programs.mercurial.aliases</code></a></span></dt><dd><p>Mercurial aliases to define.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.extraConfig"></a><a class="term" href="options.html#opt-programs.mercurial.extraConfig"><code class="option">programs.mercurial.extraConfig</code></a></span></dt><dd><p>Additional configuration to add.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.ignores"></a><a class="term" href="options.html#opt-programs.mercurial.ignores"><code class="option">programs.mercurial.ignores</code></a></span></dt><dd><p>List of globs for files to be globally ignored.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"*~" "*.swp"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.ignoresRegexp"></a><a class="term" href="options.html#opt-programs.mercurial.ignoresRegexp"><code class="option">programs.mercurial.ignoresRegexp</code></a></span></dt><dd><p>List of regular expressions for files to be globally ignored.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"^.*~$" ''^.*\.swp$''
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.userEmail"></a><a class="term" href="options.html#opt-programs.mercurial.userEmail"><code class="option">programs.mercurial.userEmail</code></a></span></dt><dd><p>Default user email to use.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mercurial.userName"></a><a class="term" href="options.html#opt-programs.mercurial.userName"><code class="option">programs.mercurial.userName</code></a></span></dt><dd><p>Default user name to use.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mercurial.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mercurial.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.enable"></a><a class="term" href="options.html#opt-programs.mpv.enable"><code class="option">programs.mpv.enable</code></a></span></dt><dd><p>Whether to enable mpv.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.package"></a><a class="term" href="options.html#opt-programs.mpv.package"><code class="option">programs.mpv.package</code></a></span></dt><dd><p>Package providing mpv.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of mpv-with-scripts-0.34.1)</code></em></code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.wrapMpv (pkgs.mpv-unwrapped.override { vapoursynthSupport = true; }) { youtubeSupport = true; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.bindings"></a><a class="term" href="options.html#opt-programs.mpv.bindings"><code class="option">programs.mpv.bindings</code></a></span></dt><dd><p>Input configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/mpv/input.conf</code>. See
|
||
<span class="citerefentry"><span class="refentrytitle">mpv</span>(1)</span>
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
WHEEL_UP = "seek 10";
|
||
WHEEL_DOWN = "seek -10";
|
||
"Alt+0" = "set window-scale 0.5";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.config"></a><a class="term" href="options.html#opt-programs.mpv.config"><code class="option">programs.mpv.config</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/mpv/mpv.conf</code>. See
|
||
<span class="citerefentry"><span class="refentrytitle">mpv</span>(1)</span>
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean or floating point number or list of string or signed integer or boolean or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
profile = "gpu-hq";
|
||
force-window = true;
|
||
ytdl-format = "bestvideo+bestaudio";
|
||
cache-default = 4000000;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.defaultProfiles"></a><a class="term" href="options.html#opt-programs.mpv.defaultProfiles"><code class="option">programs.mpv.defaultProfiles</code></a></span></dt><dd><p>Profiles to be applied by default. Options set by them are overridden
|
||
by options set in <a class="xref" href="options.html#opt-programs.mpv.config"><code class="option">programs.mpv.config</code></a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"gpu-hq"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.profiles"></a><a class="term" href="options.html#opt-programs.mpv.profiles"><code class="option">programs.mpv.profiles</code></a></span></dt><dd><p>Sub-configuration options for specific profiles written to
|
||
<code class="filename">$XDG_CONFIG_HOME/mpv/mpv.conf</code>. See
|
||
<code class="option">programs.mpv.config</code> for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string or signed integer or boolean or floating point number or list of string or signed integer or boolean or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
fast = {
|
||
vo = "vdpau";
|
||
};
|
||
"protocol.dvd" = {
|
||
profile-desc = "profile for dvd:// streams";
|
||
alang = "en";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mpv.scripts"></a><a class="term" href="options.html#opt-programs.mpv.scripts"><code class="option">programs.mpv.scripts</code></a></span></dt><dd><p>List of scripts to use with mpv.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.mpvScripts.mpris ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mpv.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mpv.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.msmtp.enable"></a><a class="term" href="options.html#opt-programs.msmtp.enable"><code class="option">programs.msmtp.enable</code></a></span></dt><dd><p>Whether to enable msmtp.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.msmtp.extraAccounts"></a><a class="term" href="options.html#opt-programs.msmtp.extraAccounts"><code class="option">programs.msmtp.extraAccounts</code></a></span></dt><dd><p>Extra configuration lines to add to the end of <code class="filename">~/.msmtprc</code>.
|
||
See <a class="link" href="https://marlam.de/msmtp/msmtprc.txt" target="_top">https://marlam.de/msmtp/msmtprc.txt</a> for examples.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.msmtp.extraConfig"></a><a class="term" href="options.html#opt-programs.msmtp.extraConfig"><code class="option">programs.msmtp.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to <code class="filename">~/.msmtprc</code>.
|
||
See <a class="link" href="https://marlam.de/msmtp/msmtprc.txt" target="_top">https://marlam.de/msmtp/msmtprc.txt</a> for examples.
|
||
</p><p>
|
||
Note, if running msmtp fails with the error message "account default
|
||
was already defined" then you probably have an account command here.
|
||
Account commands should be placed in
|
||
<a class="xref" href="options.html#opt-accounts.email.accounts._name_.msmtp.extraConfig"><code class="option">accounts.email.accounts.<name>.msmtp.extraConfig</code></a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/msmtp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/msmtp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.mu.enable"></a><a class="term" href="options.html#opt-programs.mu.enable"><code class="option">programs.mu.enable</code></a></span></dt><dd><p>Whether to enable mu, a maildir indexer and searcher.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/mu.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/mu.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.navi.enable"></a><a class="term" href="options.html#opt-programs.navi.enable"><code class="option">programs.navi.enable</code></a></span></dt><dd><p>Whether to enable Navi.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/navi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/navi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.navi.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.navi.enableBashIntegration"><code class="option">programs.navi.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/navi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/navi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.navi.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.navi.enableFishIntegration"><code class="option">programs.navi.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/navi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/navi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.navi.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.navi.enableZshIntegration"><code class="option">programs.navi.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/navi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/navi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.navi.package"></a><a class="term" href="options.html#opt-programs.navi.package"><code class="option">programs.navi.package</code></a></span></dt><dd><p>The package to use for the navi binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.navi</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/navi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/navi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.navi.settings"></a><a class="term" href="options.html#opt-programs.navi.settings"><code class="option">programs.navi.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/navi/config.yaml</code> on Linux or
|
||
<code class="filename">$HOME/Library/Application Support/navi/config.yaml</code>
|
||
on Darwin. See
|
||
<a class="link" href="https://github.com/denisidoro/navi/blob/master/docs/config_file.md" target="_top">https://github.com/denisidoro/navi/blob/master/docs/config_file.md</a>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
cheats = {
|
||
paths = [
|
||
"~/cheats/"
|
||
];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/navi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/navi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.enable"></a><a class="term" href="options.html#opt-programs.ncmpcpp.enable"><code class="option">programs.ncmpcpp.enable</code></a></span></dt><dd><p>Whether to enable ncmpcpp - an ncurses Music Player Daemon (MPD) client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.package"></a><a class="term" href="options.html#opt-programs.ncmpcpp.package"><code class="option">programs.ncmpcpp.package</code></a></span></dt><dd><p>Package providing the <code class="code">ncmpcpp</code> command.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.ncmpcpp</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.ncmpcpp.override { visualizerSupport = true; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.bindings"></a><a class="term" href="options.html#opt-programs.ncmpcpp.bindings"><code class="option">programs.ncmpcpp.bindings</code></a></span></dt><dd><p>List of keybindings.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ key = "j"; command = "scroll_down"; }
|
||
{ key = "k"; command = "scroll_up"; }
|
||
{ key = "J"; command = [ "select_item" "scroll_down" ]; }
|
||
{ key = "K"; command = [ "select_item" "scroll_up" ]; }
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.bindings._.command"></a><a class="term" href="options.html#opt-programs.ncmpcpp.bindings._.command"><code class="option">programs.ncmpcpp.bindings.*.command</code></a></span></dt><dd><p>Command or sequence of commands to be executed.</p><p><span class="emphasis"><em>Type:</em></span> string or list of string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"scroll_down"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.bindings._.key"></a><a class="term" href="options.html#opt-programs.ncmpcpp.bindings._.key"><code class="option">programs.ncmpcpp.bindings.*.key</code></a></span></dt><dd><p>Key to bind.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"j"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.mpdMusicDir"></a><a class="term" href="options.html#opt-programs.ncmpcpp.mpdMusicDir"><code class="option">programs.ncmpcpp.mpdMusicDir</code></a></span></dt><dd><p>Value of the <code class="code">mpd_music_dir</code> setting. On Linux platforms the
|
||
value of <code class="varname">services.mpd.musicDirectory</code> is used as the
|
||
default if <code class="varname">services.mpd.enable</code> is
|
||
<code class="literal">true</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">if pkgs.stdenv.hostPlatform.isLinux && config.services.mpd.enable then
|
||
config.services.mpd.musicDirectory
|
||
else
|
||
null
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"~/music"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncmpcpp.settings"></a><a class="term" href="options.html#opt-programs.ncmpcpp.settings"><code class="option">programs.ncmpcpp.settings</code></a></span></dt><dd><p>Attribute set from name of a setting to its value. For available options
|
||
see
|
||
<span class="citerefentry"><span class="refentrytitle">ncmpcpp</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
ncmpcpp_directory = "~/.local/share/ncmpcpp";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncmpcpp.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncmpcpp.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncspot.enable"></a><a class="term" href="options.html#opt-programs.ncspot.enable"><code class="option">programs.ncspot.enable</code></a></span></dt><dd><p>Whether to enable ncspot.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncspot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncspot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncspot.package"></a><a class="term" href="options.html#opt-programs.ncspot.package"><code class="option">programs.ncspot.package</code></a></span></dt><dd><p>The package to use for ncspot.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.ncspot</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncspot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncspot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ncspot.settings"></a><a class="term" href="options.html#opt-programs.ncspot.settings"><code class="option">programs.ncspot.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/ncspot/config.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/hrkfdn/ncspot#configuration" target="_top">https://github.com/hrkfdn/ncspot#configuration</a>
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
shuffle = true;
|
||
gapless = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ncspot.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ncspot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ne.enable"></a><a class="term" href="options.html#opt-programs.ne.enable"><code class="option">programs.ne.enable</code></a></span></dt><dd><p>Whether to enable ne.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ne.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ne.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ne.automaticPreferences"></a><a class="term" href="options.html#opt-programs.ne.automaticPreferences"><code class="option">programs.ne.automaticPreferences</code></a></span></dt><dd><p>Automatic preferences files for ne.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
nix = ''
|
||
TAB 0
|
||
TS 2
|
||
'';
|
||
js = ''
|
||
TS 4
|
||
'';
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ne.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ne.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ne.defaultPreferences"></a><a class="term" href="options.html#opt-programs.ne.defaultPreferences"><code class="option">programs.ne.defaultPreferences</code></a></span></dt><dd><p>Default preferences for ne.
|
||
</p><p>
|
||
Equivalent to <code class="literal">programs.ne.automaticPreferences.".default"</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ne.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ne.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ne.keybindings"></a><a class="term" href="options.html#opt-programs.ne.keybindings"><code class="option">programs.ne.keybindings</code></a></span></dt><dd><p>Keybinding file for ne.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
KEY 7f BS
|
||
SEQ "\x1b[1;5D" 7f
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ne.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ne.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ne.menus"></a><a class="term" href="options.html#opt-programs.ne.menus"><code class="option">programs.ne.menus</code></a></span></dt><dd><p>Menu configuration file for ne.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ne.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ne.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ne.virtualExtensions"></a><a class="term" href="options.html#opt-programs.ne.virtualExtensions"><code class="option">programs.ne.virtualExtensions</code></a></span></dt><dd><p>Virtual extensions configuration file for ne.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
sh 1 ^#!\s*/.*\b(bash|sh|ksh|zsh)\s*
|
||
csh 1 ^#!\s*/.*\b(csh|tcsh)\s*
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ne.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ne.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.enable"></a><a class="term" href="options.html#opt-programs.neomutt.enable"><code class="option">programs.neomutt.enable</code></a></span></dt><dd><p>Whether to enable the NeoMutt mail client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.package"></a><a class="term" href="options.html#opt-programs.neomutt.package"><code class="option">programs.neomutt.package</code></a></span></dt><dd><p>The neomutt package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.neomutt</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.binds"></a><a class="term" href="options.html#opt-programs.neomutt.binds"><code class="option">programs.neomutt.binds</code></a></span></dt><dd><p>List of keybindings.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.binds._.action"></a><a class="term" href="options.html#opt-programs.neomutt.binds._.action"><code class="option">programs.neomutt.binds.*.action</code></a></span></dt><dd><p>Specify the action to take.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"<enter-command>toggle sidebar_visible<enter><refresh>"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.binds._.key"></a><a class="term" href="options.html#opt-programs.neomutt.binds._.key"><code class="option">programs.neomutt.binds.*.key</code></a></span></dt><dd><p>The key to bind.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"<left>"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.binds._.map"></a><a class="term" href="options.html#opt-programs.neomutt.binds._.map"><code class="option">programs.neomutt.binds.*.map</code></a></span></dt><dd><p>Select the menu to bind the command to.</p><p><span class="emphasis"><em>Type:</em></span> one of "alias", "attach", "browser", "compose", "editor", "generic", "index", "mix", "pager", "pgp", "postpone", "query", "smime" or list of one of "alias", "attach", "browser", "compose", "editor", "generic", "index", "mix", "pager", "pgp", "postpone", "query", "smime"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"index"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.changeFolderWhenSourcingAccount"></a><a class="term" href="options.html#opt-programs.neomutt.changeFolderWhenSourcingAccount"><code class="option">programs.neomutt.changeFolderWhenSourcingAccount</code></a></span></dt><dd><p>Whether to enable changing the folder when sourcing an account.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.checkStatsInterval"></a><a class="term" href="options.html#opt-programs.neomutt.checkStatsInterval"><code class="option">programs.neomutt.checkStatsInterval</code></a></span></dt><dd><p>Enable and set the interval of automatic mail check.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">60</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.editor"></a><a class="term" href="options.html#opt-programs.neomutt.editor"><code class="option">programs.neomutt.editor</code></a></span></dt><dd><p>Select the editor used for writing mail.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$EDITOR"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.extraConfig"></a><a class="term" href="options.html#opt-programs.neomutt.extraConfig"><code class="option">programs.neomutt.extraConfig</code></a></span></dt><dd><p>Extra configuration appended to the end.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.macros"></a><a class="term" href="options.html#opt-programs.neomutt.macros"><code class="option">programs.neomutt.macros</code></a></span></dt><dd><p>List of macros.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.macros._.action"></a><a class="term" href="options.html#opt-programs.neomutt.macros._.action"><code class="option">programs.neomutt.macros.*.action</code></a></span></dt><dd><p>Specify the action to take.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"<enter-command>toggle sidebar_visible<enter><refresh>"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.macros._.key"></a><a class="term" href="options.html#opt-programs.neomutt.macros._.key"><code class="option">programs.neomutt.macros.*.key</code></a></span></dt><dd><p>The key to bind.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"<left>"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.macros._.map"></a><a class="term" href="options.html#opt-programs.neomutt.macros._.map"><code class="option">programs.neomutt.macros.*.map</code></a></span></dt><dd><p>Select the menu to bind the command to.</p><p><span class="emphasis"><em>Type:</em></span> one of "alias", "attach", "browser", "compose", "editor", "generic", "index", "mix", "pager", "pgp", "postpone", "query", "smime" or list of one of "alias", "attach", "browser", "compose", "editor", "generic", "index", "mix", "pager", "pgp", "postpone", "query", "smime"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"index"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.settings"></a><a class="term" href="options.html#opt-programs.neomutt.settings"><code class="option">programs.neomutt.settings</code></a></span></dt><dd><p>Extra configuration appended to the end.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.sidebar"></a><a class="term" href="options.html#opt-programs.neomutt.sidebar"><code class="option">programs.neomutt.sidebar</code></a></span></dt><dd><p>Options related to the sidebar.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.sidebar.enable"></a><a class="term" href="options.html#opt-programs.neomutt.sidebar.enable"><code class="option">programs.neomutt.sidebar.enable</code></a></span></dt><dd><p>Whether to enable sidebar support.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.sidebar.format"></a><a class="term" href="options.html#opt-programs.neomutt.sidebar.format"><code class="option">programs.neomutt.sidebar.format</code></a></span></dt><dd><p>Sidebar format. Check neomutt documentation for details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"%D%?F? [%F]?%* %?N?%N/?%S"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.sidebar.shortPath"></a><a class="term" href="options.html#opt-programs.neomutt.sidebar.shortPath"><code class="option">programs.neomutt.sidebar.shortPath</code></a></span></dt><dd><p>By default sidebar shows the full path of the mailbox, but
|
||
with this enabled only the relative name is shown.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.sidebar.width"></a><a class="term" href="options.html#opt-programs.neomutt.sidebar.width"><code class="option">programs.neomutt.sidebar.width</code></a></span></dt><dd><p>Width of the sidebar</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">22</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.sort"></a><a class="term" href="options.html#opt-programs.neomutt.sort"><code class="option">programs.neomutt.sort</code></a></span></dt><dd><p>Sorting method on messages.</p><p><span class="emphasis"><em>Type:</em></span> one of "date", "date-received", "from", "mailbox-order", "score", "size", "spam", "subject", "threads", "to", "reverse-date", "reverse-date-received", "reverse-from", "reverse-mailbox-order", "reverse-score", "reverse-size", "reverse-spam", "reverse-subject", "reverse-threads", "reverse-to"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"threads"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neomutt.vimKeys"></a><a class="term" href="options.html#opt-programs.neomutt.vimKeys"><code class="option">programs.neomutt.vimKeys</code></a></span></dt><dd><p>Enable vim-like bindings.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neomutt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neomutt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.enable"></a><a class="term" href="options.html#opt-programs.neovim.enable"><code class="option">programs.neovim.enable</code></a></span></dt><dd><p>Whether to enable Neovim.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.package"></a><a class="term" href="options.html#opt-programs.neovim.package"><code class="option">programs.neovim.package</code></a></span></dt><dd><p>The package to use for the neovim binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.neovim-unwrapped</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.coc.enable"></a><a class="term" href="options.html#opt-programs.neovim.coc.enable"><code class="option">programs.neovim.coc.enable</code></a></span></dt><dd><p>Whether to enable Coc.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.coc.package"></a><a class="term" href="options.html#opt-programs.neovim.coc.package"><code class="option">programs.neovim.coc.package</code></a></span></dt><dd><p>The package to use for the CoC plugin.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.vimPlugins.coc-nvim</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.coc.pluginConfig"></a><a class="term" href="options.html#opt-programs.neovim.coc.pluginConfig"><code class="option">programs.neovim.coc.pluginConfig</code></a></span></dt><dd><p>Script to configure CoC. Must be viml.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.coc.settings"></a><a class="term" href="options.html#opt-programs.neovim.coc.settings"><code class="option">programs.neovim.coc.settings</code></a></span></dt><dd><p>Extra configuration lines to add to
|
||
<code class="filename">$XDG_CONFIG_HOME/nvim/coc-settings.json</code>
|
||
See
|
||
<a class="link" href="https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file" target="_top">https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file</a>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"suggest.noselect" = true;
|
||
"suggest.enablePreview" = true;
|
||
"suggest.enablePreselect" = false;
|
||
"suggest.disableKind" = true;
|
||
languageserver = {
|
||
haskell = {
|
||
command = "haskell-language-server-wrapper";
|
||
args = [ "--lsp" ];
|
||
rootPatterns = [
|
||
"*.cabal"
|
||
"stack.yaml"
|
||
"cabal.project"
|
||
"package.yaml"
|
||
"hie.yaml"
|
||
];
|
||
filetypes = [ "haskell" "lhaskell" ];
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.configure"></a><a class="term" href="options.html#opt-programs.neovim.configure"><code class="option">programs.neovim.configure</code></a></span></dt><dd><p>Deprecated. Please use the other options.
|
||
|
||
Generate your init file from your list of plugins and custom commands,
|
||
and loads it from the store via <span class="command"><strong>nvim -u /nix/store/hash-vimrc</strong></span>
|
||
|
||
</p><p>
|
||
|
||
This option is mutually exclusive with <code class="varname">extraConfig</code>
|
||
and <code class="varname">plugins</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">configure = {
|
||
customRC = $'''
|
||
" here your custom configuration goes!
|
||
$''';
|
||
packages.myVimPackage = with pkgs.vimPlugins; {
|
||
# loaded on launch
|
||
start = [ fugitive ];
|
||
# manually loadable by calling `:packadd $plugin-name`
|
||
opt = [ ];
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.extraConfig"></a><a class="term" href="options.html#opt-programs.neovim.extraConfig"><code class="option">programs.neovim.extraConfig</code></a></span></dt><dd><p>Custom vimrc lines.
|
||
|
||
</p><p>
|
||
|
||
This option is mutually exclusive with <code class="varname">configure</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
set nocompatible
|
||
set nobackup
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.extraLuaPackages"></a><a class="term" href="options.html#opt-programs.neovim.extraLuaPackages"><code class="option">programs.neovim.extraLuaPackages</code></a></span></dt><dd><p>A function in lua5_1.withPackages format, which returns a
|
||
list of Lua packages required for your plugins to work.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> lua5.1 packages in lua5_1.withPackages format or list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">(ps: with ps; [ luautf8 ])</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.extraPackages"></a><a class="term" href="options.html#opt-programs.neovim.extraPackages"><code class="option">programs.neovim.extraPackages</code></a></span></dt><dd><p>Extra packages available to nvim.</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.shfmt ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.extraPython3Packages"></a><a class="term" href="options.html#opt-programs.neovim.extraPython3Packages"><code class="option">programs.neovim.extraPython3Packages</code></a></span></dt><dd><p>A function in python.withPackages format, which returns a
|
||
list of Python 3 packages required for your plugins to work.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> python3 packages in python.withPackages format or list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">ps: [ ]</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">(ps: with ps; [ python-language-server ])</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.generatedConfigViml"></a><a class="term" href="options.html#opt-programs.neovim.generatedConfigViml"><code class="option">programs.neovim.generatedConfigViml</code></a></span></dt><dd><p>Generated vimscript config.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n" <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.generatedConfigs"></a><a class="term" href="options.html#opt-programs.neovim.generatedConfigs"><code class="option">programs.neovim.generatedConfigs</code></a></span></dt><dd><p>Generated configurations with as key their language (set via type).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of strings concatenated with "\n" <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
viml = ''
|
||
" Generated by home-manager
|
||
set packpath^=/nix/store/cn8vvv4ymxjf8cfzg7db15b2838nqqib-vim-pack-dir
|
||
set runtimepath^=/nix/store/cn8vvv4ymxjf8cfzg7db15b2838nqqib-vim-pack-dir
|
||
'';
|
||
|
||
lua = ''
|
||
-- Generated by home-manager
|
||
vim.opt.background = "dark"
|
||
'';
|
||
}</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.plugins"></a><a class="term" href="options.html#opt-programs.neovim.plugins"><code class="option">programs.neovim.plugins</code></a></span></dt><dd><p>List of vim plugins to install optionally associated with
|
||
configuration to be placed in init.vim.
|
||
|
||
</p><p>
|
||
|
||
This option is mutually exclusive with <code class="varname">configure</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">with pkgs.vimPlugins; [
|
||
yankring
|
||
vim-nix
|
||
{ plugin = vim-startify;
|
||
config = "let g:startify_change_to_vcs_root = 0";
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.viAlias"></a><a class="term" href="options.html#opt-programs.neovim.viAlias"><code class="option">programs.neovim.viAlias</code></a></span></dt><dd><p>Symlink <span class="command"><strong>vi</strong></span> to <span class="command"><strong>nvim</strong></span> binary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.vimAlias"></a><a class="term" href="options.html#opt-programs.neovim.vimAlias"><code class="option">programs.neovim.vimAlias</code></a></span></dt><dd><p>Symlink <span class="command"><strong>vim</strong></span> to <span class="command"><strong>nvim</strong></span> binary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.vimdiffAlias"></a><a class="term" href="options.html#opt-programs.neovim.vimdiffAlias"><code class="option">programs.neovim.vimdiffAlias</code></a></span></dt><dd><p>Alias <span class="command"><strong>vimdiff</strong></span> to <span class="command"><strong>nvim -d</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.withNodeJs"></a><a class="term" href="options.html#opt-programs.neovim.withNodeJs"><code class="option">programs.neovim.withNodeJs</code></a></span></dt><dd><p>Enable node provider. Set to <code class="literal">true</code> to
|
||
use Node plugins.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.withPython3"></a><a class="term" href="options.html#opt-programs.neovim.withPython3"><code class="option">programs.neovim.withPython3</code></a></span></dt><dd><p>Enable Python 3 provider. Set to <code class="literal">true</code> to
|
||
use Python 3 plugins.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.neovim.withRuby"></a><a class="term" href="options.html#opt-programs.neovim.withRuby"><code class="option">programs.neovim.withRuby</code></a></span></dt><dd><p>Enable ruby provider.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/neovim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/neovim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.enable"></a><a class="term" href="options.html#opt-programs.newsboat.enable"><code class="option">programs.newsboat.enable</code></a></span></dt><dd><p>Whether to enable the Newsboat feed reader.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.autoReload"></a><a class="term" href="options.html#opt-programs.newsboat.autoReload"><code class="option">programs.newsboat.autoReload</code></a></span></dt><dd><p>Whether to enable automatic reloading while newsboat is running.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.browser"></a><a class="term" href="options.html#opt-programs.newsboat.browser"><code class="option">programs.newsboat.browser</code></a></span></dt><dd><p>External browser to use.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.xdg-utils}/bin/xdg-open"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.extraConfig"></a><a class="term" href="options.html#opt-programs.newsboat.extraConfig"><code class="option">programs.newsboat.extraConfig</code></a></span></dt><dd><p>Extra configuration values that will be appended to the end.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.maxItems"></a><a class="term" href="options.html#opt-programs.newsboat.maxItems"><code class="option">programs.newsboat.maxItems</code></a></span></dt><dd><p>Maximum number of items per feed, 0 for infinite.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.queries"></a><a class="term" href="options.html#opt-programs.newsboat.queries"><code class="option">programs.newsboat.queries</code></a></span></dt><dd><p>A list of queries to use.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
foo = ''rssurl =~ "example.com"'';
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.reloadThreads"></a><a class="term" href="options.html#opt-programs.newsboat.reloadThreads"><code class="option">programs.newsboat.reloadThreads</code></a></span></dt><dd><p>How many threads to use for updating the feeds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.reloadTime"></a><a class="term" href="options.html#opt-programs.newsboat.reloadTime"><code class="option">programs.newsboat.reloadTime</code></a></span></dt><dd><p>Time in minutes between reloads.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">60</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.urls"></a><a class="term" href="options.html#opt-programs.newsboat.urls"><code class="option">programs.newsboat.urls</code></a></span></dt><dd><p>List of news feeds.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
tags =
|
||
[
|
||
"foo" "bar"
|
||
]
|
||
; url = "http://example.com";
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.urls._.tags"></a><a class="term" href="options.html#opt-programs.newsboat.urls._.tags"><code class="option">programs.newsboat.urls.*.tags</code></a></span></dt><dd><p>Feed tags.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"foo" "bar"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.urls._.title"></a><a class="term" href="options.html#opt-programs.newsboat.urls._.title"><code class="option">programs.newsboat.urls.*.title</code></a></span></dt><dd><p>Feed title.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"ORF News"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.urls._.url"></a><a class="term" href="options.html#opt-programs.newsboat.urls._.url"><code class="option">programs.newsboat.urls.*.url</code></a></span></dt><dd><p>Feed URL.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"http://example.com"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/newsboat.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/newsboat.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.enable"></a><a class="term" href="options.html#opt-programs.nix-index.enable"><code class="option">programs.nix-index.enable</code></a></span></dt><dd><p>Whether to enable nix-index, a file database for nixpkgs.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nix-index.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nix-index.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.nix-index.enableBashIntegration"><code class="option">programs.nix-index.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nix-index.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nix-index.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.nix-index.enableFishIntegration"><code class="option">programs.nix-index.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nix-index.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nix-index.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.nix-index.enableZshIntegration"><code class="option">programs.nix-index.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nix-index.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nix-index.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.package"></a><a class="term" href="options.html#opt-programs.nix-index.package"><code class="option">programs.nix-index.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>nix-index</strong></span> tool.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nix-index</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nix-index.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nix-index.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.enable"></a><a class="term" href="options.html#opt-programs.nnn.enable"><code class="option">programs.nnn.enable</code></a></span></dt><dd><p>Whether to enable nnn.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.package"></a><a class="term" href="options.html#opt-programs.nnn.package"><code class="option">programs.nnn.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>nnn</strong></span> program.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nnn</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.nnn.override ({ withNerdIcons = true; });</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.bookmarks"></a><a class="term" href="options.html#opt-programs.nnn.bookmarks"><code class="option">programs.nnn.bookmarks</code></a></span></dt><dd><p>Directory bookmarks.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
d = "~/Documents";
|
||
D = "~/Downloads";
|
||
p = "~/Pictures";
|
||
v = "~/Videos";
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.extraPackages"></a><a class="term" href="options.html#opt-programs.nnn.extraPackages"><code class="option">programs.nnn.extraPackages</code></a></span></dt><dd><p>Extra packages available to nnn.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">with pkgs; [ ffmpegthumbnailer mediainfo sxiv ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.plugins"></a><a class="term" href="options.html#opt-programs.nnn.plugins"><code class="option">programs.nnn.plugins</code></a></span></dt><dd><p>Manage nnn plugins.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.plugins.mappings"></a><a class="term" href="options.html#opt-programs.nnn.plugins.mappings"><code class="option">programs.nnn.plugins.mappings</code></a></span></dt><dd><p>Key mappings to the plugins.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
c = "fzcd";
|
||
f = "finder";
|
||
v = "imgview";
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nnn.plugins.src"></a><a class="term" href="options.html#opt-programs.nnn.plugins.src"><code class="option">programs.nnn.plugins.src</code></a></span></dt><dd><p>Path to the plugin folder.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">(pkgs.fetchFromGitHub {
|
||
owner = "jarun";
|
||
repo = "nnn";
|
||
rev = "v4.0";
|
||
sha256 = "sha256-Hpc8YaJeAzJoEi7aJ6DntH2VLkoR6ToP6tPYn3llR7k=";
|
||
}) + "/plugins";
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nnn.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nnn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.noti.enable"></a><a class="term" href="options.html#opt-programs.noti.enable"><code class="option">programs.noti.enable</code></a></span></dt><dd><p>Whether to enable Noti.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/noti.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/noti.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.noti.settings"></a><a class="term" href="options.html#opt-programs.noti.settings"><code class="option">programs.noti.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/noti/noti.yaml</code>.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">noti.yaml</span>(5)</span>.
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
say = {
|
||
voice = "Alex";
|
||
};
|
||
slack = {
|
||
token = "1234567890abcdefg";
|
||
channel = "@jaime";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/noti.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/noti.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.enable"></a><a class="term" href="options.html#opt-programs.notmuch.enable"><code class="option">programs.notmuch.enable</code></a></span></dt><dd><p>Whether to enable Notmuch mail indexer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.extraConfig"></a><a class="term" href="options.html#opt-programs.notmuch.extraConfig"><code class="option">programs.notmuch.extraConfig</code></a></span></dt><dd><p>Options that should be appended to the notmuch configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.hooks.postInsert"></a><a class="term" href="options.html#opt-programs.notmuch.hooks.postInsert"><code class="option">programs.notmuch.hooks.postInsert</code></a></span></dt><dd><p>Bash statements run after a message has been inserted
|
||
into the database and initial tags have been applied.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.hooks.postNew"></a><a class="term" href="options.html#opt-programs.notmuch.hooks.postNew"><code class="option">programs.notmuch.hooks.postNew</code></a></span></dt><dd><p>Bash statements run after new messages have been imported
|
||
into the database and initial tags have been applied.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
notmuch tag +nixos -- tag:new and from:nixos1@discoursemail.com
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.hooks.preNew"></a><a class="term" href="options.html#opt-programs.notmuch.hooks.preNew"><code class="option">programs.notmuch.hooks.preNew</code></a></span></dt><dd><p>Bash statements run before scanning or importing new
|
||
messages into the database.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"mbsync --all"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.maildir.synchronizeFlags"></a><a class="term" href="options.html#opt-programs.notmuch.maildir.synchronizeFlags"><code class="option">programs.notmuch.maildir.synchronizeFlags</code></a></span></dt><dd><p>Whether to synchronize Maildir flags.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.new"></a><a class="term" href="options.html#opt-programs.notmuch.new"><code class="option">programs.notmuch.new</code></a></span></dt><dd><p>Options related to email processing performed by
|
||
<span class="command"><strong>notmuch new</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.new.ignore"></a><a class="term" href="options.html#opt-programs.notmuch.new.ignore"><code class="option">programs.notmuch.new.ignore</code></a></span></dt><dd><p>A list to specify files and directories that will not be
|
||
searched for messages by <span class="command"><strong>notmuch new</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.new.tags"></a><a class="term" href="options.html#opt-programs.notmuch.new.tags"><code class="option">programs.notmuch.new.tags</code></a></span></dt><dd><p>A list of tags that will be added to all messages
|
||
incorporated by <span class="command"><strong>notmuch new</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"unread" "inbox"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"new"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.notmuch.search.excludeTags"></a><a class="term" href="options.html#opt-programs.notmuch.search.excludeTags"><code class="option">programs.notmuch.search.excludeTags</code></a></span></dt><dd><p>A list of tags that will be excluded from search results by
|
||
default. Using an excluded tag in a query will override that
|
||
exclusion.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"deleted" "spam"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"trash" "spam"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/notmuch.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/notmuch.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.enable"></a><a class="term" href="options.html#opt-programs.nushell.enable"><code class="option">programs.nushell.enable</code></a></span></dt><dd><p>Whether to enable nushell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nushell.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nushell.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.package"></a><a class="term" href="options.html#opt-programs.nushell.package"><code class="option">programs.nushell.package</code></a></span></dt><dd><p>The package to use for nushell.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nushell</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nushell.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nushell.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.settings"></a><a class="term" href="options.html#opt-programs.nushell.settings"><code class="option">programs.nushell.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/nushell/config.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://www.nushell.sh/book/configuration.html" target="_top">https://www.nushell.sh/book/configuration.html</a> for the full list
|
||
of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> Nushell configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
edit_mode = "vi";
|
||
startup = [ "alias la [] { ls -a }" "alias e [msg] { echo $msg }" ];
|
||
key_timeout = 10;
|
||
completion_mode = "circular";
|
||
no_auto_pivot = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/nushell.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/nushell.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.enable"></a><a class="term" href="options.html#opt-programs.obs-studio.enable"><code class="option">programs.obs-studio.enable</code></a></span></dt><dd><p>Whether to enable obs-studio.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/obs-studio.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/obs-studio.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.package"></a><a class="term" href="options.html#opt-programs.obs-studio.package"><code class="option">programs.obs-studio.package</code></a></span></dt><dd><p>OBS Studio package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.obs-studio</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/obs-studio.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/obs-studio.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.plugins"></a><a class="term" href="options.html#opt-programs.obs-studio.plugins"><code class="option">programs.obs-studio.plugins</code></a></span></dt><dd><p>Optional OBS plugins.</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.obs-studio-plugins.wlrobs ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/obs-studio.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/obs-studio.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.octant.enable"></a><a class="term" href="options.html#opt-programs.octant.enable"><code class="option">programs.octant.enable</code></a></span></dt><dd><p>Whether to enable octant.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/octant.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/octant.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.octant.package"></a><a class="term" href="options.html#opt-programs.octant.package"><code class="option">programs.octant.package</code></a></span></dt><dd><p>The Octant package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.octant</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.octant-other</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/octant.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/octant.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.octant.plugins"></a><a class="term" href="options.html#opt-programs.octant.plugins"><code class="option">programs.octant.plugins</code></a></span></dt><dd><p>Optional Octant plugins.</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.starboard-octant-plugin ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/octant.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/octant.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.offlineimap.enable"></a><a class="term" href="options.html#opt-programs.offlineimap.enable"><code class="option">programs.offlineimap.enable</code></a></span></dt><dd><p>Whether to enable OfflineIMAP.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.offlineimap.extraConfig.default"></a><a class="term" href="options.html#opt-programs.offlineimap.extraConfig.default"><code class="option">programs.offlineimap.extraConfig.default</code></a></span></dt><dd><p>Extra configuration options added to the
|
||
<code class="option">DEFAULT</code> section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
gmailtrashfolder = "[Gmail]/Papierkorb";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.offlineimap.extraConfig.general"></a><a class="term" href="options.html#opt-programs.offlineimap.extraConfig.general"><code class="option">programs.offlineimap.extraConfig.general</code></a></span></dt><dd><p>Extra configuration options added to the
|
||
<code class="option">general</code> section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
maxage = 30; ui = "blinkenlights";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.offlineimap.extraConfig.mbnames"></a><a class="term" href="options.html#opt-programs.offlineimap.extraConfig.mbnames"><code class="option">programs.offlineimap.extraConfig.mbnames</code></a></span></dt><dd><p>Extra configuration options added to the
|
||
<code class="code">mbnames</code> section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
filename = "~/.config/mutt/mailboxes";
|
||
header = "'mailboxes '";
|
||
peritem = "'+%(accountname)s/%(foldername)s'";
|
||
sep = "' '";
|
||
footer = "'\\n'";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.offlineimap.pythonFile"></a><a class="term" href="options.html#opt-programs.offlineimap.pythonFile"><code class="option">programs.offlineimap.pythonFile</code></a></span></dt><dd><p>Python code that can then be used in other parts of the
|
||
configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">''
|
||
import subprocess
|
||
|
||
def get_pass(service, cmd):
|
||
return subprocess.check_output(cmd, )
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/offlineimap.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/offlineimap.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.opam.enable"></a><a class="term" href="options.html#opt-programs.opam.enable"><code class="option">programs.opam.enable</code></a></span></dt><dd><p>Whether to enable Opam.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/opam.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/opam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.opam.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.opam.enableBashIntegration"><code class="option">programs.opam.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/opam.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/opam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.opam.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.opam.enableZshIntegration"><code class="option">programs.opam.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/opam.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/opam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.opam.package"></a><a class="term" href="options.html#opt-programs.opam.package"><code class="option">programs.opam.package</code></a></span></dt><dd><p>Opam package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.opam</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/opam.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/opam.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.enable"></a><a class="term" href="options.html#opt-programs.pandoc.enable"><code class="option">programs.pandoc.enable</code></a></span></dt><dd><p>Whether to enable pandoc.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.package"></a><a class="term" href="options.html#opt-programs.pandoc.package"><code class="option">programs.pandoc.package</code></a></span></dt><dd><p>The pandoc package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.pandoc</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.citationStyles"></a><a class="term" href="options.html#opt-programs.pandoc.citationStyles"><code class="option">programs.pandoc.citationStyles</code></a></span></dt><dd><p>List of .csl files to install.</p><p><span class="emphasis"><em>Type:</em></span> list of path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ path/to/file.csl ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.defaults"></a><a class="term" href="options.html#opt-programs.pandoc.defaults"><code class="option">programs.pandoc.defaults</code></a></span></dt><dd><p>Options to set by default.
|
||
These will be converted to JSON and written to a defaults
|
||
file (see Default files in pandoc documentation).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
metadata = {
|
||
author = "John Doe";
|
||
};
|
||
pdf-engine = "xelatex";
|
||
citeproc = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.defaultsFile"></a><a class="term" href="options.html#opt-programs.pandoc.defaultsFile"><code class="option">programs.pandoc.defaultsFile</code></a></span></dt><dd><p>Resulting defaults file.</p><p><span class="emphasis"><em>Type:</em></span> path <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.finalPackage"></a><a class="term" href="options.html#opt-programs.pandoc.finalPackage"><code class="option">programs.pandoc.finalPackage</code></a></span></dt><dd><p>Resulting package.</p><p><span class="emphasis"><em>Type:</em></span> package <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pandoc.templates"></a><a class="term" href="options.html#opt-programs.pandoc.templates"><code class="option">programs.pandoc.templates</code></a></span></dt><dd><p>Custom templates.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"default.latex" = path/to/your/template;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pandoc.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pandoc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.password-store.enable"></a><a class="term" href="options.html#opt-programs.password-store.enable"><code class="option">programs.password-store.enable</code></a></span></dt><dd><p>Whether to enable Password store.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/password-store.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/password-store.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.password-store.package"></a><a class="term" href="options.html#opt-programs.password-store.package"><code class="option">programs.password-store.package</code></a></span></dt><dd><p>The <code class="literal">pass</code> package to use.
|
||
Can be used to specify extensions.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.pass</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.pass.withExtensions (exts: [ exts.pass-otp ])
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/password-store.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/password-store.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.password-store.settings"></a><a class="term" href="options.html#opt-programs.password-store.settings"><code class="option">programs.password-store.settings</code></a></span></dt><dd><p>The <code class="literal">pass</code> environment variables dictionary.
|
||
</p><p>
|
||
See the "Environment variables" section of
|
||
<span class="citerefentry"><span class="refentrytitle">pass</span>(1)</span>
|
||
and the extension man pages for more information about the
|
||
available keys.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">{ PASSWORD_STORE_DIR = "$XDG_DATA_HOME/password-store"; }
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
PASSWORD_STORE_DIR = "/some/directory";
|
||
PASSWORD_STORE_KEY = "12345678";
|
||
PASSWORD_STORE_CLIP_TIME = "60";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/password-store.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/password-store.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pazi.enable"></a><a class="term" href="options.html#opt-programs.pazi.enable"><code class="option">programs.pazi.enable</code></a></span></dt><dd><p>Whether to enable pazi.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pazi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pazi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pazi.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.pazi.enableBashIntegration"><code class="option">programs.pazi.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pazi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pazi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pazi.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.pazi.enableFishIntegration"><code class="option">programs.pazi.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pazi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pazi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pazi.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.pazi.enableZshIntegration"><code class="option">programs.pazi.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pazi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pazi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.enable"></a><a class="term" href="options.html#opt-programs.pet.enable"><code class="option">programs.pet.enable</code></a></span></dt><dd><p>Whether to enable pet.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.selectcmdPackage"></a><a class="term" href="options.html#opt-programs.pet.selectcmdPackage"><code class="option">programs.pet.selectcmdPackage</code></a></span></dt><dd><p>The package needed for the <code class="varname">settings.selectcmd</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.fzf</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.settings"></a><a class="term" href="options.html#opt-programs.pet.settings"><code class="option">programs.pet.settings</code></a></span></dt><dd><p>Settings written to <code class="filename">config.toml</code>. See the pet
|
||
documentation for details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.snippets"></a><a class="term" href="options.html#opt-programs.pet.snippets"><code class="option">programs.pet.snippets</code></a></span></dt><dd><p>The snippets.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.snippets._.command"></a><a class="term" href="options.html#opt-programs.pet.snippets._.command"><code class="option">programs.pet.snippets.*.command</code></a></span></dt><dd><p>The command.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"git rev-list --count HEAD"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.snippets._.description"></a><a class="term" href="options.html#opt-programs.pet.snippets._.description"><code class="option">programs.pet.snippets.*.description</code></a></span></dt><dd><p>Description of the snippet.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Count the number of commits in the current branch"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.snippets._.output"></a><a class="term" href="options.html#opt-programs.pet.snippets._.output"><code class="option">programs.pet.snippets.*.output</code></a></span></dt><dd><p>Example output of the command.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"473"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pet.snippets._.tag"></a><a class="term" href="options.html#opt-programs.pet.snippets._.tag"><code class="option">programs.pet.snippets.*.tag</code></a></span></dt><dd><p>List of tags attached to the command.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">["git" "nixpkgs"]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pet.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pidgin.enable"></a><a class="term" href="options.html#opt-programs.pidgin.enable"><code class="option">programs.pidgin.enable</code></a></span></dt><dd><p>Whether to enable Pidgin messaging client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pidgin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pidgin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pidgin.package"></a><a class="term" href="options.html#opt-programs.pidgin.package"><code class="option">programs.pidgin.package</code></a></span></dt><dd><p>The Pidgin package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.pidgin</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pidgin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pidgin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pidgin.plugins"></a><a class="term" href="options.html#opt-programs.pidgin.plugins"><code class="option">programs.pidgin.plugins</code></a></span></dt><dd><p>Plugins that should be available to Pidgin.</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.pidgin-otr pkgs.pidgin-osd ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pidgin.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pidgin.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.piston-cli.enable"></a><a class="term" href="options.html#opt-programs.piston-cli.enable"><code class="option">programs.piston-cli.enable</code></a></span></dt><dd><p>Whether to enable piston-cli, code runner.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/piston-cli.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/piston-cli.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.piston-cli.package"></a><a class="term" href="options.html#opt-programs.piston-cli.package"><code class="option">programs.piston-cli.package</code></a></span></dt><dd><p>The piston-cli package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.piston-cli</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/piston-cli.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/piston-cli.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.piston-cli.settings"></a><a class="term" href="options.html#opt-programs.piston-cli.settings"><code class="option">programs.piston-cli.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/piston-cli/config.yml</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
theme = "emacs";
|
||
box_style = "MINIMAL_DOUBLE_HEAD";
|
||
prompt_continuation = "...";
|
||
prompt_start = ">>>";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/piston-cli.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/piston-cli.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.enable"></a><a class="term" href="options.html#opt-programs.powerline-go.enable"><code class="option">programs.powerline-go.enable</code></a></span></dt><dd><p>Whether to enable Powerline-go, a beautiful and useful low-latency prompt for your shell.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.extraUpdatePS1"></a><a class="term" href="options.html#opt-programs.powerline-go.extraUpdatePS1"><code class="option">programs.powerline-go.extraUpdatePS1</code></a></span></dt><dd><p>Shell code to execute after the prompt is set.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
PS1=$PS1"NixOS> ";
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.modules"></a><a class="term" href="options.html#opt-programs.powerline-go.modules"><code class="option">programs.powerline-go.modules</code></a></span></dt><dd><p>List of module names to load. The list of all available
|
||
modules as well as the choice of default ones are at
|
||
<a class="link" href="https://github.com/justjanne/powerline-go" target="_top">https://github.com/justjanne/powerline-go</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"host" "ssh" "cwd" "gitlite" "jobs" "exit"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.modulesRight"></a><a class="term" href="options.html#opt-programs.powerline-go.modulesRight"><code class="option">programs.powerline-go.modulesRight</code></a></span></dt><dd><p>List of module names to load to be displayed on the right side.
|
||
Currently not supported by bash. Specifying a value for this
|
||
option will force powerline-go to use the eval format to set
|
||
the prompt.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"host" "venv" "git"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.newline"></a><a class="term" href="options.html#opt-programs.powerline-go.newline"><code class="option">programs.powerline-go.newline</code></a></span></dt><dd><p>Set to true if the prompt should be on a line of its own.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.pathAliases"></a><a class="term" href="options.html#opt-programs.powerline-go.pathAliases"><code class="option">programs.powerline-go.pathAliases</code></a></span></dt><dd><p>Pairs of full-path and corresponding desired short name. You
|
||
may use '~' to represent your home directory but you should
|
||
protect it to avoid shell substitution.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ "\\~/projects/home-manager" = "prj:home-manager"; }
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.powerline-go.settings"></a><a class="term" href="options.html#opt-programs.powerline-go.settings"><code class="option">programs.powerline-go.settings</code></a></span></dt><dd><p>This can be any key/value pair as described in
|
||
<a class="link" href="https://github.com/justjanne/powerline-go" target="_top">https://github.com/justjanne/powerline-go</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
hostname-only-if-ssh = true;
|
||
numeric-exit-codes = true;
|
||
cwd-max-depth = 7;
|
||
ignore-repos = [ "/home/me/big-project" "/home/me/huge-project" ];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/powerline-go.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/powerline-go.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pubs.enable"></a><a class="term" href="options.html#opt-programs.pubs.enable"><code class="option">programs.pubs.enable</code></a></span></dt><dd><p>Whether to enable pubs.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pubs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pubs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pubs.package"></a><a class="term" href="options.html#opt-programs.pubs.package"><code class="option">programs.pubs.package</code></a></span></dt><dd><p>The package to use for the pubs script.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.pubs</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pubs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pubs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pubs.extraConfig"></a><a class="term" href="options.html#opt-programs.pubs.extraConfig"><code class="option">programs.pubs.extraConfig</code></a></span></dt><dd><p>Configuration using syntax written to
|
||
<code class="filename">$HOME/.pubsrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
[main]
|
||
pubsdir = ${config.home.homeDirectory}/.pubs
|
||
docsdir = ${config.home.homeDirectory}/.pubs/doc
|
||
doc_add = link
|
||
open_cmd = xdg-open
|
||
|
||
[plugins]
|
||
active = git,alias
|
||
|
||
[[alias]]
|
||
|
||
[[[la]]]
|
||
command = list -a
|
||
description = lists papers in lexicographic order
|
||
|
||
[[git]]
|
||
quiet = True
|
||
manual = False
|
||
force_color = False
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pubs.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pubs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pylint.enable"></a><a class="term" href="options.html#opt-programs.pylint.enable"><code class="option">programs.pylint.enable</code></a></span></dt><dd><p>Whether to enable the pylint Python linter.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pylint.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pylint.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pylint.package"></a><a class="term" href="options.html#opt-programs.pylint.package"><code class="option">programs.pylint.package</code></a></span></dt><dd><p>The pylint package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.python3Packages.pylint</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pylint.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pylint.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.pylint.settings"></a><a class="term" href="options.html#opt-programs.pylint.settings"><code class="option">programs.pylint.settings</code></a></span></dt><dd><p>The pylint configuration.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string) or a non-empty list of them</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{}</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/pylint.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/pylint.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.enable"></a><a class="term" href="options.html#opt-programs.qutebrowser.enable"><code class="option">programs.qutebrowser.enable</code></a></span></dt><dd><p>Whether to enable qutebrowser.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.enableDefaultBindings"></a><a class="term" href="options.html#opt-programs.qutebrowser.enableDefaultBindings"><code class="option">programs.qutebrowser.enableDefaultBindings</code></a></span></dt><dd><p>Disable to prevent loading default key bindings.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.package"></a><a class="term" href="options.html#opt-programs.qutebrowser.package"><code class="option">programs.qutebrowser.package</code></a></span></dt><dd><p>Qutebrowser package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.qutebrowser</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.aliases"></a><a class="term" href="options.html#opt-programs.qutebrowser.aliases"><code class="option">programs.qutebrowser.aliases</code></a></span></dt><dd><p>Aliases for commands.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.extraConfig"></a><a class="term" href="options.html#opt-programs.qutebrowser.extraConfig"><code class="option">programs.qutebrowser.extraConfig</code></a></span></dt><dd><p>Extra lines added to qutebrowser <code class="filename">config.py</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.keyBindings"></a><a class="term" href="options.html#opt-programs.qutebrowser.keyBindings"><code class="option">programs.qutebrowser.keyBindings</code></a></span></dt><dd><p>Key bindings mapping keys to commands in different modes. This setting
|
||
is a dictionary containing mode names and dictionaries mapping keys to
|
||
commands: <code class="literal">{mode: {key: command}}</code> If you want to map
|
||
a key to another key, check the <code class="literal">keyMappings</code> setting
|
||
instead. For modifiers, you can use either <code class="literal">-</code> or
|
||
<code class="literal">+</code> as delimiters, and these names:
|
||
|
||
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||
Control: <code class="literal">Control</code>, <code class="literal">Ctrl</code>
|
||
</p></li><li class="listitem"><p>
|
||
Meta: <code class="literal">Meta</code>, <code class="literal">Windows</code>,
|
||
<code class="literal">Mod4</code>
|
||
</p></li><li class="listitem"><p>
|
||
Alt: <code class="literal">Alt</code>, <code class="literal">Mod1</code>
|
||
</p></li><li class="listitem"><p>
|
||
Shift: <code class="literal">Shift</code>
|
||
</p></li></ul></div><p>
|
||
|
||
For simple keys (no <code class="literal"><></code>-signs), a capital
|
||
letter means the key is pressed with Shift. For special keys (with
|
||
<code class="literal"><></code>-signs), you need to explicitly add
|
||
<code class="literal">Shift-</code> to match a key pressed with shift. If you
|
||
want a binding to do nothing, bind it to the <code class="literal">nop</code>
|
||
command. If you want a default binding to be passed through to the
|
||
website, bind it to null. Note that some commands which are only useful
|
||
for bindings (but not used interactively) are hidden from the command
|
||
completion. See <code class="literal">:</code>help for a full list of available
|
||
commands. The following modes are available:
|
||
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">normal</code></span></dt><dd><p>
|
||
Default mode, where most commands are invoked.
|
||
</p></dd><dt><span class="term"><code class="literal">insert</code></span></dt><dd><p>
|
||
Entered when an input field is focused on a website, or by
|
||
pressing i in normal mode. Passes through almost all keypresses
|
||
to the website, but has some bindings like
|
||
<code class="literal"><Ctrl-e></code> to open an external editor.
|
||
Note that single keys can’t be bound in this mode.
|
||
</p></dd><dt><span class="term"><code class="literal">hint</code></span></dt><dd><p>
|
||
Entered when f is pressed to select links with the keyboard. Note
|
||
that single keys can’t be bound in this mode.
|
||
</p></dd><dt><span class="term"><code class="literal">passthrough</code></span></dt><dd><p>
|
||
Similar to insert mode, but passes through all keypresses except
|
||
<code class="literal"><Escape></code> to leave the mode. It might be
|
||
useful to bind <code class="literal"><Escape></code> to some other
|
||
key in this mode if you want to be able to send an Escape key to
|
||
the website as well. Note that single keys can’t be bound in this
|
||
mode.
|
||
</p></dd><dt><span class="term"><code class="literal">command</code></span></dt><dd><p>
|
||
Entered when pressing the : key in order to enter a command. Note
|
||
that single keys can’t be bound in this mode.
|
||
</p></dd><dt><span class="term"><code class="literal">prompt</code></span></dt><dd><p>
|
||
Entered when there’s a prompt to display, like for download
|
||
locations or when invoked from JavaScript.
|
||
</p></dd><dt><span class="term"><code class="literal">yesno</code></span></dt><dd><p>
|
||
Entered when there’s a yes/no prompt displayed.
|
||
</p></dd><dt><span class="term"><code class="literal">caret</code></span></dt><dd><p>
|
||
Entered when pressing the v mode, used to select text using the
|
||
keyboard.
|
||
</p></dd><dt><span class="term"><code class="literal">register</code></span></dt><dd><p>
|
||
Entered when qutebrowser is waiting for a register name/key for
|
||
commands like <code class="literal">:set-mark</code>.
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
normal = {
|
||
"<Ctrl-v>" = "spawn mpv {url}";
|
||
",p" = "spawn --userscript qute-pass";
|
||
",l" = ''config-cycle spellcheck.languages ["en-GB"] ["en-US"]'';
|
||
};
|
||
prompt = {
|
||
"<Ctrl-y>" = "prompt-yes";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.keyMappings"></a><a class="term" href="options.html#opt-programs.qutebrowser.keyMappings"><code class="option">programs.qutebrowser.keyMappings</code></a></span></dt><dd><p>This setting can be used to map keys to other keys. When the key used
|
||
as dictionary-key is pressed, the binding for the key used as
|
||
dictionary-value is invoked instead. This is useful for global
|
||
remappings of keys, for example to map Ctrl-[ to Escape. Note that when
|
||
a key is bound (via <code class="literal">bindings.default</code> or
|
||
<code class="literal">bindings.commands</code>), the mapping is ignored.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.loadAutoconfig"></a><a class="term" href="options.html#opt-programs.qutebrowser.loadAutoconfig"><code class="option">programs.qutebrowser.loadAutoconfig</code></a></span></dt><dd><p>Load settings configured via the GUI.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.quickmarks"></a><a class="term" href="options.html#opt-programs.qutebrowser.quickmarks"><code class="option">programs.qutebrowser.quickmarks</code></a></span></dt><dd><p>Quickmarks to add to qutebrowser's <code class="filename">quickmarks</code> file.
|
||
Note that when Home Manager manages your quickmarks, you cannot edit them at runtime.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
nixpkgs = "https://github.com/NixOS/nixpkgs";
|
||
home-manager = "https://github.com/nix-community/home-manager";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.searchEngines"></a><a class="term" href="options.html#opt-programs.qutebrowser.searchEngines"><code class="option">programs.qutebrowser.searchEngines</code></a></span></dt><dd><p>Search engines that can be used via the address bar. Maps a search
|
||
engine name (such as <code class="literal">DEFAULT</code>, or
|
||
<code class="literal">ddg</code>) to a URL with a <code class="literal">{}</code>
|
||
placeholder. The placeholder will be replaced by the search term, use
|
||
<code class="literal">{{</code> and <code class="literal">}}</code> for literal
|
||
<code class="literal">{/}</code> signs. The search engine named
|
||
<code class="literal">DEFAULT</code> is used when
|
||
<code class="literal">url.auto_search</code> is turned on and something else than
|
||
a URL was entered to be opened. Other search engines can be used by
|
||
prepending the search engine name to the search term, for example
|
||
<code class="literal">:open google qutebrowser</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
w = "https://en.wikipedia.org/wiki/Special:Search?search={}&go=Go&ns0=1";
|
||
aw = "https://wiki.archlinux.org/?search={}";
|
||
nw = "https://nixos.wiki/index.php?search={}";
|
||
g = "https://www.google.com/search?hl=en&q={}";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.qutebrowser.settings"></a><a class="term" href="options.html#opt-programs.qutebrowser.settings"><code class="option">programs.qutebrowser.settings</code></a></span></dt><dd><p>Options to add to qutebrowser <code class="filename">config.py</code> file.
|
||
See <a class="link" href="https://qutebrowser.org/doc/help/settings.html" target="_top">https://qutebrowser.org/doc/help/settings.html</a>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
colors = {
|
||
hints = {
|
||
bg = "#000000";
|
||
fg = "#ffffff";
|
||
};
|
||
tabs.bar.bg = "#000000";
|
||
};
|
||
tabs.tabs_are_windows = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/qutebrowser.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/qutebrowser.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.enable"></a><a class="term" href="options.html#opt-programs.rbw.enable"><code class="option">programs.rbw.enable</code></a></span></dt><dd><p>Whether to enable rbw, a CLI Bitwarden client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.package"></a><a class="term" href="options.html#opt-programs.rbw.package"><code class="option">programs.rbw.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>rbw</strong></span> tool and its
|
||
<span class="command"><strong>rbw-agent</strong></span> daemon.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.rbw</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.settings"></a><a class="term" href="options.html#opt-programs.rbw.settings"><code class="option">programs.rbw.settings</code></a></span></dt><dd><p>rbw configuration, if not defined the configuration will not be
|
||
managed by Home Manager.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
email = "name@example.com";
|
||
lock_timeout = 300;
|
||
pinentry = "gnome3";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.settings.base_url"></a><a class="term" href="options.html#opt-programs.rbw.settings.base_url"><code class="option">programs.rbw.settings.base_url</code></a></span></dt><dd><p>The base-url for a self-hosted bitwarden installation.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"bitwarden.example.com"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.settings.email"></a><a class="term" href="options.html#opt-programs.rbw.settings.email"><code class="option">programs.rbw.settings.email</code></a></span></dt><dd><p>The email address for your bitwarden account.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"name@example.com"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.settings.identity_url"></a><a class="term" href="options.html#opt-programs.rbw.settings.identity_url"><code class="option">programs.rbw.settings.identity_url</code></a></span></dt><dd><p>The identity url for your bitwarden installation.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"identity.example.com"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.settings.lock_timeout"></a><a class="term" href="options.html#opt-programs.rbw.settings.lock_timeout"><code class="option">programs.rbw.settings.lock_timeout</code></a></span></dt><dd><p>The amount of time that your login information should be cached.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">3600</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">300</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rbw.settings.pinentry"></a><a class="term" href="options.html#opt-programs.rbw.settings.pinentry"><code class="option">programs.rbw.settings.pinentry</code></a></span></dt><dd><p>Which pinentry interface to use. Beware that
|
||
<code class="literal">pinentry-gnome3</code> may not work on non-Gnome
|
||
systems. You can fix it by adding the following to your
|
||
system configuration:
|
||
</p><pre class="programlisting nix">
|
||
services.dbus.packages = [ pkgs.gcr ];
|
||
</pre><p>
|
||
For this reason, the default is <code class="literal">gtk2</code> for
|
||
now.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package or one of "curses", "tty", "gtk2", "emacs", "gnome3", "qt"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"gtk2"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"gnome3"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rbw.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rbw.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.readline.enable"></a><a class="term" href="options.html#opt-programs.readline.enable"><code class="option">programs.readline.enable</code></a></span></dt><dd><p>Whether to enable readline.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/readline.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/readline.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.readline.bindings"></a><a class="term" href="options.html#opt-programs.readline.bindings"><code class="option">programs.readline.bindings</code></a></span></dt><dd><p>Readline bindings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ "\\C-h" = "backward-kill-word"; }
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/readline.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/readline.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.readline.extraConfig"></a><a class="term" href="options.html#opt-programs.readline.extraConfig"><code class="option">programs.readline.extraConfig</code></a></span></dt><dd><p>Configuration lines appended unchanged to the end of the
|
||
<code class="filename">~/.inputrc</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/readline.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/readline.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.readline.includeSystemConfig"></a><a class="term" href="options.html#opt-programs.readline.includeSystemConfig"><code class="option">programs.readline.includeSystemConfig</code></a></span></dt><dd><p>Whether to include the system-wide configuration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/readline.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/readline.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.readline.variables"></a><a class="term" href="options.html#opt-programs.readline.variables"><code class="option">programs.readline.variables</code></a></span></dt><dd><p>Readline customization variable assignments.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
expand-tilde = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/readline.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/readline.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.enable"></a><a class="term" href="options.html#opt-programs.rofi.enable"><code class="option">programs.rofi.enable</code></a></span></dt><dd><p>Whether to enable Rofi: A window switcher, application launcher and dmenu replacement.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.package"></a><a class="term" href="options.html#opt-programs.rofi.package"><code class="option">programs.rofi.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>rofi</strong></span> binary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of rofi-1.7.3)</code></em></code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.rofi.override { plugins = [ pkgs.rofi-emoji ]; };
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.configPath"></a><a class="term" href="options.html#opt-programs.rofi.configPath"><code class="option">programs.rofi.configPath</code></a></span></dt><dd><p>Path where to put generated configuration file.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_CONFIG_HOME/rofi/config.rasi"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.cycle"></a><a class="term" href="options.html#opt-programs.rofi.cycle"><code class="option">programs.rofi.cycle</code></a></span></dt><dd><p>Whether to cycle through the results list.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.extraConfig"></a><a class="term" href="options.html#opt-programs.rofi.extraConfig"><code class="option">programs.rofi.extraConfig</code></a></span></dt><dd><p>Additional configuration to add.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer or boolean or Rasi literal string or list of string or signed integer or boolean or Rasi literal string or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
modi = "drun,emoji,ssh";
|
||
kb-primary-paste = "Control+V,Shift+Insert";
|
||
kb-secondary-paste = "Control+v,Insert";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.finalPackage"></a><a class="term" href="options.html#opt-programs.rofi.finalPackage"><code class="option">programs.rofi.finalPackage</code></a></span></dt><dd><p>Resulting customized rofi package.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.font"></a><a class="term" href="options.html#opt-programs.rofi.font"><code class="option">programs.rofi.font</code></a></span></dt><dd><p>Font to use.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Droid Sans Mono 14"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.location"></a><a class="term" href="options.html#opt-programs.rofi.location"><code class="option">programs.rofi.location</code></a></span></dt><dd><p>The location rofi appears on the screen.</p><p><span class="emphasis"><em>Type:</em></span> one of "bottom", "bottom-left", "bottom-right", "center", "left", "right", "top", "top-left", "top-right"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"center"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.pass.enable"></a><a class="term" href="options.html#opt-programs.rofi.pass.enable"><code class="option">programs.rofi.pass.enable</code></a></span></dt><dd><p>Whether to enable rofi integration with password-store.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi-pass.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi-pass.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.pass.extraConfig"></a><a class="term" href="options.html#opt-programs.rofi.pass.extraConfig"><code class="option">programs.rofi.pass.extraConfig</code></a></span></dt><dd><p>Extra configuration to be added at to the rofi-pass config file.
|
||
Additional examples can be found at
|
||
<a class="link" href="https://github.com/carnager/rofi-pass/blob/master/config.example" target="_top">https://github.com/carnager/rofi-pass/blob/master/config.example</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
URL_field='url'
|
||
USERNAME_field='user'
|
||
AUTOTYPE_field='autotype'
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi-pass.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi-pass.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.pass.stores"></a><a class="term" href="options.html#opt-programs.rofi.pass.stores"><code class="option">programs.rofi.pass.stores</code></a></span></dt><dd><p>Directory roots of your password-stores.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi-pass.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi-pass.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.plugins"></a><a class="term" href="options.html#opt-programs.rofi.plugins"><code class="option">programs.rofi.plugins</code></a></span></dt><dd><p>List of rofi plugins to be installed.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.rofi-calc ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.terminal"></a><a class="term" href="options.html#opt-programs.rofi.terminal"><code class="option">programs.rofi.terminal</code></a></span></dt><dd><p>Path to the terminal which will be used to run console applications
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.gnome.gnome_terminal}/bin/gnome-terminal"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.theme"></a><a class="term" href="options.html#opt-programs.rofi.theme"><code class="option">programs.rofi.theme</code></a></span></dt><dd><p>Name of theme or path to theme file in rasi format or attribute set with
|
||
theme configuration. Available named themes can be viewed using the
|
||
<span class="command"><strong>rofi-theme-selector</strong></span> tool.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or path or attribute set of attribute set of string or signed integer or boolean or Rasi literal string or list of string or signed integer or boolean or Rasi literal string or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">let
|
||
# Use `mkLiteral` for string-like values that should show without
|
||
# quotes, e.g.:
|
||
# {
|
||
# foo = "abc"; => foo: "abc";
|
||
# bar = mkLiteral "abc"; => bar: abc;
|
||
# };
|
||
inherit (config.lib.formats.rasi) mkLiteral;
|
||
in {
|
||
"*" = {
|
||
background-color = mkLiteral "#000000";
|
||
foreground-color = mkLiteral "rgba ( 250, 251, 252, 100 % )";
|
||
border-color = mkLiteral "#FFFFFF";
|
||
width = 512;
|
||
};
|
||
|
||
"#inputbar" = {
|
||
children = map mkLiteral [ "prompt" "entry" ];
|
||
};
|
||
|
||
"#textbox-prompt-colon" = {
|
||
expand = false;
|
||
str = ":";
|
||
margin = mkLiteral "0px 0.3em 0em 0em";
|
||
text-color = mkLiteral "@foreground-color";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.xoffset"></a><a class="term" href="options.html#opt-programs.rofi.xoffset"><code class="option">programs.rofi.xoffset</code></a></span></dt><dd><p>Offset in the x-axis in pixels relative to the chosen location.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rofi.yoffset"></a><a class="term" href="options.html#opt-programs.rofi.yoffset"><code class="option">programs.rofi.yoffset</code></a></span></dt><dd><p>Offset in the y-axis in pixels relative to the chosen location.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rofi.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rofi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rtorrent.enable"></a><a class="term" href="options.html#opt-programs.rtorrent.enable"><code class="option">programs.rtorrent.enable</code></a></span></dt><dd><p>Whether to enable rTorrent.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rtorrent.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rtorrent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.rtorrent.settings"></a><a class="term" href="options.html#opt-programs.rtorrent.settings"><code class="option">programs.rtorrent.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/rtorrent/rtorrent.rc</code>. See
|
||
<a class="link" href="https://github.com/rakshasa/rtorrent/wiki/Config-Guide" target="_top">https://github.com/rakshasa/rtorrent/wiki/Config-Guide</a>
|
||
for explanation about possible values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/rtorrent.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/rtorrent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sagemath.enable"></a><a class="term" href="options.html#opt-programs.sagemath.enable"><code class="option">programs.sagemath.enable</code></a></span></dt><dd><p>Whether to enable SageMath, a mathematics software system.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sagemath.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sagemath.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sagemath.package"></a><a class="term" href="options.html#opt-programs.sagemath.package"><code class="option">programs.sagemath.package</code></a></span></dt><dd><p>The SageMath package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.sage</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sagemath.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sagemath.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sagemath.configDir"></a><a class="term" href="options.html#opt-programs.sagemath.configDir"><code class="option">programs.sagemath.configDir</code></a></span></dt><dd><p>Directory where the <code class="filename">sage.init</code> file will be stored.
|
||
Note that the upstream default is <code class="filename">~/.sage</code>,
|
||
but our default is to follow XDG.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">${config.xdg.configHome}/sage</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sagemath.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sagemath.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sagemath.dataDir"></a><a class="term" href="options.html#opt-programs.sagemath.dataDir"><code class="option">programs.sagemath.dataDir</code></a></span></dt><dd><p>Location for <code class="envar">DOT_SAGE</code>.
|
||
Note that the upstream default is <code class="filename">~/.sage</code>,
|
||
but our default is to follow XDG.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">${config.xdg.dataHome}/sage</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sagemath.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sagemath.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sagemath.initScript"></a><a class="term" href="options.html#opt-programs.sagemath.initScript"><code class="option">programs.sagemath.initScript</code></a></span></dt><dd><p>Contents of the <code class="filename">init.sage</code> file that is loaded on startup.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"%colors linux"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sagemath.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sagemath.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.enable"></a><a class="term" href="options.html#opt-programs.sbt.enable"><code class="option">programs.sbt.enable</code></a></span></dt><dd><p>Whether to enable sbt.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.package"></a><a class="term" href="options.html#opt-programs.sbt.package"><code class="option">programs.sbt.package</code></a></span></dt><dd><p>The package with sbt to be installed.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.sbt</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.baseConfigPath"></a><a class="term" href="options.html#opt-programs.sbt.baseConfigPath"><code class="option">programs.sbt.baseConfigPath</code></a></span></dt><dd><p>Where the plugins and credentials should be located.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">".sbt/1.0"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.credentials"></a><a class="term" href="options.html#opt-programs.sbt.credentials"><code class="option">programs.sbt.credentials</code></a></span></dt><dd><p>A list of credentials to define in the sbt configuration directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[{
|
||
realm = "Sonatype Nexus Repository Manager";
|
||
host = "example.com";
|
||
user = "user";
|
||
passwordCommand = "pass show sbt/user@example.com";
|
||
}]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.credentials._.host"></a><a class="term" href="options.html#opt-programs.sbt.credentials._.host"><code class="option">programs.sbt.credentials.*.host</code></a></span></dt><dd><p>The hostname of the repository you're authenticating to.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.credentials._.passwordCommand"></a><a class="term" href="options.html#opt-programs.sbt.credentials._.passwordCommand"><code class="option">programs.sbt.credentials.*.passwordCommand</code></a></span></dt><dd><p>The command that provides the password or authentication token for
|
||
the repository.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.credentials._.realm"></a><a class="term" href="options.html#opt-programs.sbt.credentials._.realm"><code class="option">programs.sbt.credentials.*.realm</code></a></span></dt><dd><p>The realm of the repository you're authenticating to.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.credentials._.user"></a><a class="term" href="options.html#opt-programs.sbt.credentials._.user"><code class="option">programs.sbt.credentials.*.user</code></a></span></dt><dd><p>The user you're using to authenticate.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.plugins"></a><a class="term" href="options.html#opt-programs.sbt.plugins"><code class="option">programs.sbt.plugins</code></a></span></dt><dd><p>A list of plugins to place in the sbt configuration directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
org = "net.virtual-void";
|
||
artifact = "sbt-dependency-graph";
|
||
version = "0.10.0-RC1";
|
||
}
|
||
{
|
||
org = "com.dwijnand";
|
||
artifact = "sbt-project-graph";
|
||
version = "0.4.0";
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.plugins._.artifact"></a><a class="term" href="options.html#opt-programs.sbt.plugins._.artifact"><code class="option">programs.sbt.plugins.*.artifact</code></a></span></dt><dd><p>The name of the artifact.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.plugins._.org"></a><a class="term" href="options.html#opt-programs.sbt.plugins._.org"><code class="option">programs.sbt.plugins.*.org</code></a></span></dt><dd><p>The organization the artifact is published under.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sbt.plugins._.version"></a><a class="term" href="options.html#opt-programs.sbt.plugins._.version"><code class="option">programs.sbt.plugins.*.version</code></a></span></dt><dd><p>The version of the plugin.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sbt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sbt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.scmpuff.enable"></a><a class="term" href="options.html#opt-programs.scmpuff.enable"><code class="option">programs.scmpuff.enable</code></a></span></dt><dd><p>Whether to enable scmpuff, a command line tool that allows you to work quicker with Git by
|
||
substituting numeric shortcuts for files.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/scmpuff.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/scmpuff.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.scmpuff.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.scmpuff.enableBashIntegration"><code class="option">programs.scmpuff.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/scmpuff.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/scmpuff.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.scmpuff.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.scmpuff.enableZshIntegration"><code class="option">programs.scmpuff.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/scmpuff.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/scmpuff.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.scmpuff.package"></a><a class="term" href="options.html#opt-programs.scmpuff.package"><code class="option">programs.scmpuff.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>scmpuff</strong></span> tool.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.scmpuff</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/scmpuff.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/scmpuff.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.enable"></a><a class="term" href="options.html#opt-programs.senpai.enable"><code class="option">programs.senpai.enable</code></a></span></dt><dd><p>Whether to enable senpai.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.package"></a><a class="term" href="options.html#opt-programs.senpai.package"><code class="option">programs.senpai.package</code></a></span></dt><dd><p>The <code class="literal">senpai</code> package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.senpai</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config"></a><a class="term" href="options.html#opt-programs.senpai.config"><code class="option">programs.senpai.config</code></a></span></dt><dd><p>Configuration for senpai. For a complete list of options, see
|
||
<span class="citerefentry"><span class="refentrytitle">senpai</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
addr = "libera.chat:6697";
|
||
nick = "nicholas";
|
||
password = "verysecurepassword";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.addr"></a><a class="term" href="options.html#opt-programs.senpai.config.addr"><code class="option">programs.senpai.config.addr</code></a></span></dt><dd><p>The address (host[:port]) of the IRC server. senpai uses TLS
|
||
connections by default unless you specify no-tls option. TLS
|
||
connections default to port 6697, plain-text use port 6667.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.nick"></a><a class="term" href="options.html#opt-programs.senpai.config.nick"><code class="option">programs.senpai.config.nick</code></a></span></dt><dd><p>Your nickname, sent with a NICK IRC message. It mustn't contain
|
||
spaces or colons (:).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.no-tls"></a><a class="term" href="options.html#opt-programs.senpai.config.no-tls"><code class="option">programs.senpai.config.no-tls</code></a></span></dt><dd><p>Disables TLS encryption.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.password"></a><a class="term" href="options.html#opt-programs.senpai.config.password"><code class="option">programs.senpai.config.password</code></a></span></dt><dd><p>Your password, used for SASL authentication. Note that it will
|
||
reside world-readable in the Nix store.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/senpai.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/senpai.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sioyek.enable"></a><a class="term" href="options.html#opt-programs.sioyek.enable"><code class="option">programs.sioyek.enable</code></a></span></dt><dd><p>Whether to enable Sioyek is a PDF viewer designed for reading research papers and technical books..</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sioyek.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sioyek.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sioyek.package"></a><a class="term" href="options.html#opt-programs.sioyek.package"><code class="option">programs.sioyek.package</code></a></span></dt><dd><p>Package providing the sioyek binary</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.sioyek</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sioyek.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sioyek.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sioyek.bindings"></a><a class="term" href="options.html#opt-programs.sioyek.bindings"><code class="option">programs.sioyek.bindings</code></a></span></dt><dd><p>Input configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/sioyek/keys_user.config</code>.
|
||
See <a class="link" href="https://github.com/ahrm/sioyek/blob/main/pdf_viewer/keys.config" target="_top">https://github.com/ahrm/sioyek/blob/main/pdf_viewer/keys.config</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"move_up" = "k";
|
||
"move_down" = "j";
|
||
"move_left" = "h";
|
||
"move_right" = "l";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sioyek.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sioyek.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sioyek.config"></a><a class="term" href="options.html#opt-programs.sioyek.config"><code class="option">programs.sioyek.config</code></a></span></dt><dd><p>Input configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/sioyek/prefs_user.config</code>.
|
||
See <a class="link" href="https://github.com/ahrm/sioyek/blob/main/pdf_viewer/prefs.config" target="_top">https://github.com/ahrm/sioyek/blob/main/pdf_viewer/prefs.config</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"background_color" = "1.0 1.0 1.0";
|
||
"text_highlight_color" = "1.0 0.0 0.0";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sioyek.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sioyek.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.enable"></a><a class="term" href="options.html#opt-programs.skim.enable"><code class="option">programs.skim.enable</code></a></span></dt><dd><p>Whether to enable skim - a command-line fuzzy finder.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.skim.enableBashIntegration"><code class="option">programs.skim.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.skim.enableFishIntegration"><code class="option">programs.skim.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.skim.enableZshIntegration"><code class="option">programs.skim.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.package"></a><a class="term" href="options.html#opt-programs.skim.package"><code class="option">programs.skim.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>skim</strong></span> tool.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.skim</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.changeDirWidgetCommand"></a><a class="term" href="options.html#opt-programs.skim.changeDirWidgetCommand"><code class="option">programs.skim.changeDirWidgetCommand</code></a></span></dt><dd><p>The command that gets executed as the source for skim for the
|
||
ALT-C keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fd --type d"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.changeDirWidgetOptions"></a><a class="term" href="options.html#opt-programs.skim.changeDirWidgetOptions"><code class="option">programs.skim.changeDirWidgetOptions</code></a></span></dt><dd><p>Command line options for the ALT-C keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--preview 'tree -C {} | head -200'"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.defaultCommand"></a><a class="term" href="options.html#opt-programs.skim.defaultCommand"><code class="option">programs.skim.defaultCommand</code></a></span></dt><dd><p>The command that gets executed as the default source for skim
|
||
when running.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fd --type f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.defaultOptions"></a><a class="term" href="options.html#opt-programs.skim.defaultOptions"><code class="option">programs.skim.defaultOptions</code></a></span></dt><dd><p>Extra command line options given to skim by default.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--height 40%" "--prompt ⟫"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.fileWidgetCommand"></a><a class="term" href="options.html#opt-programs.skim.fileWidgetCommand"><code class="option">programs.skim.fileWidgetCommand</code></a></span></dt><dd><p>The command that gets executed as the source for skim for the
|
||
CTRL-T keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fd --type f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.fileWidgetOptions"></a><a class="term" href="options.html#opt-programs.skim.fileWidgetOptions"><code class="option">programs.skim.fileWidgetOptions</code></a></span></dt><dd><p>Command line options for the CTRL-T keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--preview 'head {}'"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.historyWidgetOptions"></a><a class="term" href="options.html#opt-programs.skim.historyWidgetOptions"><code class="option">programs.skim.historyWidgetOptions</code></a></span></dt><dd><p>Command line options for the CTRL-R keybinding.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--tac" "--exact"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/skim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/skim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sm64ex.enable"></a><a class="term" href="options.html#opt-programs.sm64ex.enable"><code class="option">programs.sm64ex.enable</code></a></span></dt><dd><p>Whether to enable sm64ex.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sm64ex.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sm64ex.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sm64ex.package"></a><a class="term" href="options.html#opt-programs.sm64ex.package"><code class="option">programs.sm64ex.package</code></a></span></dt><dd><p>The sm64ex package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of sm64ex-unstable-2021-11-30)</code></em></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sm64ex.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sm64ex.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sm64ex.baserom"></a><a class="term" href="options.html#opt-programs.sm64ex.baserom"><code class="option">programs.sm64ex.baserom</code></a></span></dt><dd><p>The path to the Super Mario 64 baserom to extract assets from.</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">/home/foo/baserom.us.z64</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sm64ex.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sm64ex.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sm64ex.extraCompileFlags"></a><a class="term" href="options.html#opt-programs.sm64ex.extraCompileFlags"><code class="option">programs.sm64ex.extraCompileFlags</code></a></span></dt><dd><p>Extra flags to pass to the compiler. See
|
||
<a class="link" href="https://github.com/sm64pc/sm64ex/wiki/Build-options" target="_top">https://github.com/sm64pc/sm64ex/wiki/Build-options</a>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
"BETTERCAMERA=1"
|
||
"NODRAWINGDISTANCE=1"
|
||
];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sm64ex.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sm64ex.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sm64ex.region"></a><a class="term" href="options.html#opt-programs.sm64ex.region"><code class="option">programs.sm64ex.region</code></a></span></dt><dd><p>Your baserom's region. Note that only "us", "eu", and "jp" are supported.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "us", "eu", "jp"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">us</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">jp</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sm64ex.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sm64ex.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sm64ex.settings"></a><a class="term" href="options.html#opt-programs.sm64ex.settings"><code class="option">programs.sm64ex.settings</code></a></span></dt><dd><p>Settings for sm64ex's <code class="filename">$XDG_DATA_HOME/sm64pc/sm64config.txt</code> file.</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of string or signed integer or boolean or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
fullscreen = false;
|
||
window_x = 0;
|
||
window_y = 0;
|
||
window_w = 1920;
|
||
window_h = 1080;
|
||
vsync = 1;
|
||
texture_filtering = 1;
|
||
master_volume = 127;
|
||
music_volume = 127;
|
||
sfx_volume = 127;
|
||
env_volume = 127;
|
||
key_a = [ "0026" "1000" "1103" ];
|
||
key_b = [ "0033" "1002" "1101" ];
|
||
key_start = [ "0039" "1006" "ffff" ];
|
||
key_l = [ "0034" "1007" "1104" ];
|
||
key_r = [ "0036" "100a" "1105" ];
|
||
key_z = [ "0025" "1009" "1102" ];
|
||
key_cup = [ "100b" "ffff" "ffff" ];
|
||
key_cdown = [ "100c" "ffff" "ffff" ];
|
||
key_cleft = [ "100d" "ffff" "ffff" ];
|
||
key_cright = [ "100e" "ffff" "ffff" ];
|
||
key_stickup = [ "0011" "ffff" "ffff" ];
|
||
key_stickdown = [ "001f" "ffff" "ffff" ];
|
||
key_stickleft = [ "001e" "ffff" "ffff" ];
|
||
key_stickright = [ "0020" "ffff" "ffff" ];
|
||
stick_deadzone = 16;
|
||
rumble_strength = 10;
|
||
skip_intro = 1;
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sm64ex.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sm64ex.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sqls.enable"></a><a class="term" href="options.html#opt-programs.sqls.enable"><code class="option">programs.sqls.enable</code></a></span></dt><dd><p>Whether to enable sqls, a SQL language server written in Go.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sqls.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sqls.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.sqls.settings"></a><a class="term" href="options.html#opt-programs.sqls.settings"><code class="option">programs.sqls.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/sqls/config.yml</code>. See
|
||
<a class="link" href="https://github.com/lighttiger2505/sqls#db-configuration" target="_top">https://github.com/lighttiger2505/sqls#db-configuration</a>
|
||
for supported values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
lowercaseKeywords = true;
|
||
connections = [
|
||
{
|
||
driver = "mysql";
|
||
dataSourceName = "root:root@tcp(127.0.0.1:13306)/world";
|
||
}
|
||
];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/sqls.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/sqls.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.enable"></a><a class="term" href="options.html#opt-programs.ssh.enable"><code class="option">programs.ssh.enable</code></a></span></dt><dd><p>Whether to enable SSH client configuration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.compression"></a><a class="term" href="options.html#opt-programs.ssh.compression"><code class="option">programs.ssh.compression</code></a></span></dt><dd><p>Specifies whether to use compression.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.controlMaster"></a><a class="term" href="options.html#opt-programs.ssh.controlMaster"><code class="option">programs.ssh.controlMaster</code></a></span></dt><dd><p>Configure sharing of multiple sessions over a single network connection.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "yes", "no", "ask", "auto", "autoask"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"no"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.controlPath"></a><a class="term" href="options.html#opt-programs.ssh.controlPath"><code class="option">programs.ssh.controlPath</code></a></span></dt><dd><p>Specify path to the control socket used for connection sharing.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.ssh/master-%r@%n:%p"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.controlPersist"></a><a class="term" href="options.html#opt-programs.ssh.controlPersist"><code class="option">programs.ssh.controlPersist</code></a></span></dt><dd><p>Whether control socket should remain open in the background.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"no"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"10m"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.extraConfig"></a><a class="term" href="options.html#opt-programs.ssh.extraConfig"><code class="option">programs.ssh.extraConfig</code></a></span></dt><dd><p>Extra configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.extraOptionOverrides"></a><a class="term" href="options.html#opt-programs.ssh.extraOptionOverrides"><code class="option">programs.ssh.extraOptionOverrides</code></a></span></dt><dd><p>Extra SSH configuration options that take precedence over any
|
||
host specific configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.forwardAgent"></a><a class="term" href="options.html#opt-programs.ssh.forwardAgent"><code class="option">programs.ssh.forwardAgent</code></a></span></dt><dd><p>Whether the connection to the authentication agent (if any)
|
||
will be forwarded to the remote machine.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.hashKnownHosts"></a><a class="term" href="options.html#opt-programs.ssh.hashKnownHosts"><code class="option">programs.ssh.hashKnownHosts</code></a></span></dt><dd><p>Indicates that
|
||
<span class="citerefentry"><span class="refentrytitle">ssh</span>(1)</span>
|
||
should hash host names and addresses when they are added to
|
||
the known hosts file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.includes"></a><a class="term" href="options.html#opt-programs.ssh.includes"><code class="option">programs.ssh.includes</code></a></span></dt><dd><p>File globs of ssh config files that should be included via the
|
||
<code class="literal">Include</code> directive.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">ssh_config</span>(5)</span>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks"><code class="option">programs.ssh.matchBlocks</code></a></span></dt><dd><p>Specify per-host settings. Note, if the order of rules matter
|
||
then use the DAG functions to express the dependencies as
|
||
shown in the example.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">ssh_config</span>(5)</span>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list or DAG of submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"john.example.com" = {
|
||
hostname = "example.com";
|
||
user = "john";
|
||
};
|
||
foo = lib.hm.dag.entryBefore ["john.example.com"] {
|
||
hostname = "example.com";
|
||
identityFile = "/home/john/.ssh/foo_rsa";
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.addressFamily"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.addressFamily"><code class="option">programs.ssh.matchBlocks.<name>.addressFamily</code></a></span></dt><dd><p>Specifies which address family to use when connecting.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "any", "inet", "inet6"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.certificateFile"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.certificateFile"><code class="option">programs.ssh.matchBlocks.<name>.certificateFile</code></a></span></dt><dd><p>Specifies files from which the user certificate is read.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string or null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.checkHostIP"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.checkHostIP"><code class="option">programs.ssh.matchBlocks.<name>.checkHostIP</code></a></span></dt><dd><p>Check the host IP address in the
|
||
<code class="filename">known_hosts</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.compression"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.compression"><code class="option">programs.ssh.matchBlocks.<name>.compression</code></a></span></dt><dd><p>Specifies whether to use compression. Omitted from the host
|
||
block when <code class="literal">null</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.dynamicForwards"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.dynamicForwards"><code class="option">programs.ssh.matchBlocks.<name>.dynamicForwards</code></a></span></dt><dd><p>Specify dynamic port forwardings. See
|
||
<span class="citerefentry"><span class="refentrytitle">ssh_config</span>(5)</span> for <code class="literal">DynamicForward</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[ { port = 8080; } ];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.dynamicForwards._.address"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.dynamicForwards._.address"><code class="option">programs.ssh.matchBlocks.<name>.dynamicForwards.*.address</code></a></span></dt><dd><p>The address where to bind the port.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"localhost"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.dynamicForwards._.port"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.dynamicForwards._.port"><code class="option">programs.ssh.matchBlocks.<name>.dynamicForwards.*.port</code></a></span></dt><dd><p>Specifies port number to bind on bind address.</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">8080</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.extraOptions"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.extraOptions"><code class="option">programs.ssh.matchBlocks.<name>.extraOptions</code></a></span></dt><dd><p>Extra configuration options for the host.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.forwardAgent"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.forwardAgent"><code class="option">programs.ssh.matchBlocks.<name>.forwardAgent</code></a></span></dt><dd><p>Whether the connection to the authentication agent (if any)
|
||
will be forwarded to the remote machine.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.forwardX11"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.forwardX11"><code class="option">programs.ssh.matchBlocks.<name>.forwardX11</code></a></span></dt><dd><p>Specifies whether X11 connections will be automatically redirected
|
||
over the secure channel and <code class="envar">DISPLAY</code> set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.forwardX11Trusted"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.forwardX11Trusted"><code class="option">programs.ssh.matchBlocks.<name>.forwardX11Trusted</code></a></span></dt><dd><p>Specifies whether remote X11 clients will have full access to the
|
||
original X11 display.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.host"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.host"><code class="option">programs.ssh.matchBlocks.<name>.host</code></a></span></dt><dd><p>The host pattern used by this conditional block.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"*.example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.hostname"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.hostname"><code class="option">programs.ssh.matchBlocks.<name>.hostname</code></a></span></dt><dd><p>Specifies the real host name to log into.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.identitiesOnly"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.identitiesOnly"><code class="option">programs.ssh.matchBlocks.<name>.identitiesOnly</code></a></span></dt><dd><p>Specifies that ssh should only use the authentication
|
||
identity explicitly configured in the
|
||
<code class="filename">~/.ssh/config</code> files or passed on the
|
||
ssh command-line, even if <span class="command"><strong>ssh-agent</strong></span>
|
||
offers more identities.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.identityFile"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.identityFile"><code class="option">programs.ssh.matchBlocks.<name>.identityFile</code></a></span></dt><dd><p>Specifies files from which the user identity is read.
|
||
Identities will be tried in the given order.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string or null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.localForwards"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.localForwards"><code class="option">programs.ssh.matchBlocks.<name>.localForwards</code></a></span></dt><dd><p>Specify local port forwardings. See
|
||
<span class="citerefentry"><span class="refentrytitle">ssh_config</span>(5)</span> for <code class="literal">LocalForward</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
bind.port = 8080;
|
||
host.address = "10.0.0.13";
|
||
host.port = 80;
|
||
}
|
||
];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.localForwards._.bind.address"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.localForwards._.bind.address"><code class="option">programs.ssh.matchBlocks.<name>.localForwards.*.bind.address</code></a></span></dt><dd><p>The address where to bind the port.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"localhost"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.localForwards._.bind.port"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.localForwards._.bind.port"><code class="option">programs.ssh.matchBlocks.<name>.localForwards.*.bind.port</code></a></span></dt><dd><p>Specifies port number to bind on bind address.</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">8080</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.localForwards._.host.address"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.localForwards._.host.address"><code class="option">programs.ssh.matchBlocks.<name>.localForwards.*.host.address</code></a></span></dt><dd><p>The address where to forward the traffic to.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.localForwards._.host.port"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.localForwards._.host.port"><code class="option">programs.ssh.matchBlocks.<name>.localForwards.*.host.port</code></a></span></dt><dd><p>Specifies port number to forward the traffic to.</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">80</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.port"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.port"><code class="option">programs.ssh.matchBlocks.<name>.port</code></a></span></dt><dd><p>Specifies port number to connect on remote host.</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.proxyCommand"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.proxyCommand"><code class="option">programs.ssh.matchBlocks.<name>.proxyCommand</code></a></span></dt><dd><p>The command to use to connect to the server.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.proxyJump"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.proxyJump"><code class="option">programs.ssh.matchBlocks.<name>.proxyJump</code></a></span></dt><dd><p>The proxy host to use to connect to the server.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.remoteForwards"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.remoteForwards"><code class="option">programs.ssh.matchBlocks.<name>.remoteForwards</code></a></span></dt><dd><p>Specify remote port forwardings. See
|
||
<span class="citerefentry"><span class="refentrytitle">ssh_config</span>(5)</span> for <code class="literal">RemoteForward</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
bind.port = 8080;
|
||
host.address = "10.0.0.13";
|
||
host.port = 80;
|
||
}
|
||
];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.remoteForwards._.bind.address"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.remoteForwards._.bind.address"><code class="option">programs.ssh.matchBlocks.<name>.remoteForwards.*.bind.address</code></a></span></dt><dd><p>The address where to bind the port.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"localhost"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.remoteForwards._.bind.port"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.remoteForwards._.bind.port"><code class="option">programs.ssh.matchBlocks.<name>.remoteForwards.*.bind.port</code></a></span></dt><dd><p>Specifies port number to bind on bind address.</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">8080</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.remoteForwards._.host.address"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.remoteForwards._.host.address"><code class="option">programs.ssh.matchBlocks.<name>.remoteForwards.*.host.address</code></a></span></dt><dd><p>The address where to forward the traffic to.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"example.org"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.remoteForwards._.host.port"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.remoteForwards._.host.port"><code class="option">programs.ssh.matchBlocks.<name>.remoteForwards.*.host.port</code></a></span></dt><dd><p>Specifies port number to forward the traffic to.</p><p><span class="emphasis"><em>Type:</em></span> null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">80</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.sendEnv"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.sendEnv"><code class="option">programs.ssh.matchBlocks.<name>.sendEnv</code></a></span></dt><dd><p>Environment variables to send from the local host to the
|
||
server.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.serverAliveCountMax"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.serverAliveCountMax"><code class="option">programs.ssh.matchBlocks.<name>.serverAliveCountMax</code></a></span></dt><dd><p>Sets the number of server alive messages which may be sent
|
||
without SSH receiving any messages back from the server.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">3</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.serverAliveInterval"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.serverAliveInterval"><code class="option">programs.ssh.matchBlocks.<name>.serverAliveInterval</code></a></span></dt><dd><p>Set timeout in seconds after which response will be requested.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.matchBlocks._name_.user"></a><a class="term" href="options.html#opt-programs.ssh.matchBlocks._name_.user"><code class="option">programs.ssh.matchBlocks.<name>.user</code></a></span></dt><dd><p>Specifies the user to log in as.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.serverAliveCountMax"></a><a class="term" href="options.html#opt-programs.ssh.serverAliveCountMax"><code class="option">programs.ssh.serverAliveCountMax</code></a></span></dt><dd><p>Sets the default number of server alive messages which may be
|
||
sent without SSH receiving any messages back from the server.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">3</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.serverAliveInterval"></a><a class="term" href="options.html#opt-programs.ssh.serverAliveInterval"><code class="option">programs.ssh.serverAliveInterval</code></a></span></dt><dd><p>Set default timeout in seconds after which response will be requested.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.ssh.userKnownHostsFile"></a><a class="term" href="options.html#opt-programs.ssh.userKnownHostsFile"><code class="option">programs.ssh.userKnownHostsFile</code></a></span></dt><dd><p>Specifies one or more files to use for the user host key
|
||
database, separated by whitespace. The default is
|
||
<code class="filename">~/.ssh/known_hosts</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.ssh/known_hosts"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/ssh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.enable"></a><a class="term" href="options.html#opt-programs.starship.enable"><code class="option">programs.starship.enable</code></a></span></dt><dd><p>Whether to enable starship.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.starship.enableBashIntegration"><code class="option">programs.starship.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.starship.enableFishIntegration"><code class="option">programs.starship.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.enableIonIntegration"></a><a class="term" href="options.html#opt-programs.starship.enableIonIntegration"><code class="option">programs.starship.enableIonIntegration</code></a></span></dt><dd><p>Whether to enable Ion integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.starship.enableZshIntegration"><code class="option">programs.starship.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.package"></a><a class="term" href="options.html#opt-programs.starship.package"><code class="option">programs.starship.package</code></a></span></dt><dd><p>The package to use for the starship binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.starship</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.starship.settings"></a><a class="term" href="options.html#opt-programs.starship.settings"><code class="option">programs.starship.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/starship.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://starship.rs/config/" target="_top">https://starship.rs/config/</a> for the full list
|
||
of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> Starship configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
add_newline = false;
|
||
format = lib.concatStrings [
|
||
"$line_break"
|
||
"$package"
|
||
"$line_break"
|
||
"$character"
|
||
];
|
||
scan_timeout = 10;
|
||
character = {
|
||
success_symbol = "➜";
|
||
error_symbol = "➜";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/starship.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/starship.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.swaylock.settings"></a><a class="term" href="options.html#opt-programs.swaylock.settings"><code class="option">programs.swaylock.settings</code></a></span></dt><dd><p>Default arguments to <span class="command"><strong>swaylock</strong></span>. An empty set
|
||
disables configuration generation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or floating point number or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
color = "808080"; font-size = 24; indicator-idle-visible = false; indicator-radius = 100; line-color = "ffffff"; show-failed-attempts = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/swaylock.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/swaylock.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.taskwarrior.enable"></a><a class="term" href="options.html#opt-programs.taskwarrior.enable"><code class="option">programs.taskwarrior.enable</code></a></span></dt><dd><p>Whether to enable Task Warrior.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/taskwarrior.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/taskwarrior.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.taskwarrior.colorTheme"></a><a class="term" href="options.html#opt-programs.taskwarrior.colorTheme"><code class="option">programs.taskwarrior.colorTheme</code></a></span></dt><dd><p>Either one of the default provided theme as string, or a
|
||
path to a theme configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"dark-blue-256"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/taskwarrior.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/taskwarrior.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.taskwarrior.config"></a><a class="term" href="options.html#opt-programs.taskwarrior.config"><code class="option">programs.taskwarrior.config</code></a></span></dt><dd><p>Key-value configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/task/taskrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
confirmation = false;
|
||
report.minimal.filter = "status:pending";
|
||
report.active.columns = [ "id" "start" "entry.age" "priority" "project" "due" "description" ];
|
||
report.active.labels = [ "ID" "Started" "Age" "Priority" "Project" "Due" "Description" ];
|
||
taskd = {
|
||
certificate = "/path/to/cert";
|
||
key = "/path/to/key";
|
||
ca = "/path/to/ca";
|
||
server = "host.domain:53589";
|
||
credentials = "Org/First Last/cf31f287-ee9e-43a8-843e-e8bbd5de4294";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/taskwarrior.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/taskwarrior.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.taskwarrior.dataLocation"></a><a class="term" href="options.html#opt-programs.taskwarrior.dataLocation"><code class="option">programs.taskwarrior.dataLocation</code></a></span></dt><dd><p>Location where Task Warrior will store its data.
|
||
</p><p>
|
||
Home Manager will attempt to create this directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_DATA_HOME/task"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/taskwarrior.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/taskwarrior.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.taskwarrior.extraConfig"></a><a class="term" href="options.html#opt-programs.taskwarrior.extraConfig"><code class="option">programs.taskwarrior.extraConfig</code></a></span></dt><dd><p>Additional content written at the end of
|
||
<code class="filename">$XDG_CONFIG_HOME/task/taskrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/taskwarrior.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/taskwarrior.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tealdeer.enable"></a><a class="term" href="options.html#opt-programs.tealdeer.enable"><code class="option">programs.tealdeer.enable</code></a></span></dt><dd><p>Whether to enable Tealdeer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tealdeer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tealdeer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tealdeer.settings"></a><a class="term" href="options.html#opt-programs.tealdeer.settings"><code class="option">programs.tealdeer.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/tealdeer/config.toml</code> on Linux or
|
||
<code class="filename">$HOME/Library/Application Support/tealdeer/config.toml</code>
|
||
on Darwin. See
|
||
<a class="link" href="https://dbrgn.github.io/tealdeer/config.html" target="_top">https://dbrgn.github.io/tealdeer/config.html</a>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
display = {
|
||
compact = false;
|
||
use_pager = true;
|
||
};
|
||
updates = {
|
||
auto_update = false;
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tealdeer.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tealdeer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.terminator.enable"></a><a class="term" href="options.html#opt-programs.terminator.enable"><code class="option">programs.terminator.enable</code></a></span></dt><dd><p>Whether to enable terminator, a tiling terminal emulator.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/terminator.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/terminator.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.terminator.package"></a><a class="term" href="options.html#opt-programs.terminator.package"><code class="option">programs.terminator.package</code></a></span></dt><dd><p>terminator package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of terminator-2.1.1)</code></em></code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.terminator</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/terminator.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/terminator.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.terminator.config"></a><a class="term" href="options.html#opt-programs.terminator.config"><code class="option">programs.terminator.config</code></a></span></dt><dd><p>configuration for terminator.
|
||
</p><p>
|
||
For a list of all possible options refer to the
|
||
<span class="citerefentry"><span class="refentrytitle">terminator_config</span>(5)</span>
|
||
man page.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
global_config.borderless = true;
|
||
profiles.default.background_color = "#002b36";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/terminator.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/terminator.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.enable"></a><a class="term" href="options.html#opt-programs.termite.enable"><code class="option">programs.termite.enable</code></a></span></dt><dd><p>Whether to enable Termite VTE-based terminal.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.enableVteIntegration"></a><a class="term" href="options.html#opt-programs.termite.enableVteIntegration"><code class="option">programs.termite.enableVteIntegration</code></a></span></dt><dd><p>Whether to enable Shell VTE integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.allowBold"></a><a class="term" href="options.html#opt-programs.termite.allowBold"><code class="option">programs.termite.allowBold</code></a></span></dt><dd><p>Allow the output of bold characters when the bold escape sequence appears.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.audibleBell"></a><a class="term" href="options.html#opt-programs.termite.audibleBell"><code class="option">programs.termite.audibleBell</code></a></span></dt><dd><p>Have the terminal beep on the terminal bell.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.backgroundColor"></a><a class="term" href="options.html#opt-programs.termite.backgroundColor"><code class="option">programs.termite.backgroundColor</code></a></span></dt><dd><p>Background color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"rgba(63, 63, 63, 0.8)"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.browser"></a><a class="term" href="options.html#opt-programs.termite.browser"><code class="option">programs.termite.browser</code></a></span></dt><dd><p>Set the default browser for opening links. If its not set, $BROWSER is read.
|
||
If that's not set, url hints will be disabled.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.xdg-utils}/xdg-open"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.clickableUrl"></a><a class="term" href="options.html#opt-programs.termite.clickableUrl"><code class="option">programs.termite.clickableUrl</code></a></span></dt><dd><p>Auto-detected URLs can be clicked on to open them in your browser.
|
||
Only enabled if a browser is configured or detected.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.colorsExtra"></a><a class="term" href="options.html#opt-programs.termite.colorsExtra"><code class="option">programs.termite.colorsExtra</code></a></span></dt><dd><p>Extra colors options that should be added to [colors] section.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
color0 = #3f3f3f
|
||
color1 = #705050
|
||
color2 = #60b48a
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.cursorBlink"></a><a class="term" href="options.html#opt-programs.termite.cursorBlink"><code class="option">programs.termite.cursorBlink</code></a></span></dt><dd><p>Specify the how the terminal's cursor should behave.
|
||
Accepts system to respect the gtk global configuration,
|
||
on and off to explicitly enable or disable them.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "system", "on", "off"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"system"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.cursorColor"></a><a class="term" href="options.html#opt-programs.termite.cursorColor"><code class="option">programs.termite.cursorColor</code></a></span></dt><dd><p>Cursor color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#dcdccc"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.cursorForegroundColor"></a><a class="term" href="options.html#opt-programs.termite.cursorForegroundColor"><code class="option">programs.termite.cursorForegroundColor</code></a></span></dt><dd><p>Cursor foreground color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#dcdccc"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.cursorShape"></a><a class="term" href="options.html#opt-programs.termite.cursorShape"><code class="option">programs.termite.cursorShape</code></a></span></dt><dd><p>Specify how the cursor should look. Accepts block, ibeam and underline.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "block", "underline", "ibeam"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"block"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.dynamicTitle"></a><a class="term" href="options.html#opt-programs.termite.dynamicTitle"><code class="option">programs.termite.dynamicTitle</code></a></span></dt><dd><p>Settings dynamic title allows the terminal and the shell to
|
||
update the terminal's title.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.filterUnmatchedUrls"></a><a class="term" href="options.html#opt-programs.termite.filterUnmatchedUrls"><code class="option">programs.termite.filterUnmatchedUrls</code></a></span></dt><dd><p>Whether to hide url hints not matching input in url hints mode.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.font"></a><a class="term" href="options.html#opt-programs.termite.font"><code class="option">programs.termite.font</code></a></span></dt><dd><p>The font description for the terminal's font.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Monospace 12"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.foregroundBoldColor"></a><a class="term" href="options.html#opt-programs.termite.foregroundBoldColor"><code class="option">programs.termite.foregroundBoldColor</code></a></span></dt><dd><p>Foreground bold color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.foregroundColor"></a><a class="term" href="options.html#opt-programs.termite.foregroundColor"><code class="option">programs.termite.foregroundColor</code></a></span></dt><dd><p>Foreground color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#dcdccc"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.fullscreen"></a><a class="term" href="options.html#opt-programs.termite.fullscreen"><code class="option">programs.termite.fullscreen</code></a></span></dt><dd><p>Enables entering fullscreen mode by pressing F11.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.geometry"></a><a class="term" href="options.html#opt-programs.termite.geometry"><code class="option">programs.termite.geometry</code></a></span></dt><dd><p>The default window geometry for new terminal windows.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"640x480"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.highlightColor"></a><a class="term" href="options.html#opt-programs.termite.highlightColor"><code class="option">programs.termite.highlightColor</code></a></span></dt><dd><p>highlight color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#2f2f2f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsActiveBackgroundColor"></a><a class="term" href="options.html#opt-programs.termite.hintsActiveBackgroundColor"><code class="option">programs.termite.hintsActiveBackgroundColor</code></a></span></dt><dd><p>Hints active background color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#3f3f3f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsActiveForegroundColor"></a><a class="term" href="options.html#opt-programs.termite.hintsActiveForegroundColor"><code class="option">programs.termite.hintsActiveForegroundColor</code></a></span></dt><dd><p>Hints active foreground color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#e68080"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsBackgroundColor"></a><a class="term" href="options.html#opt-programs.termite.hintsBackgroundColor"><code class="option">programs.termite.hintsBackgroundColor</code></a></span></dt><dd><p>Hints background color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#3f3f3f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsBorderColor"></a><a class="term" href="options.html#opt-programs.termite.hintsBorderColor"><code class="option">programs.termite.hintsBorderColor</code></a></span></dt><dd><p>Hints border color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#3f3f3f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsBorderWidth"></a><a class="term" href="options.html#opt-programs.termite.hintsBorderWidth"><code class="option">programs.termite.hintsBorderWidth</code></a></span></dt><dd><p>Hints border width.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsExtra"></a><a class="term" href="options.html#opt-programs.termite.hintsExtra"><code class="option">programs.termite.hintsExtra</code></a></span></dt><dd><p>Extra hints options that should be added to [hints] section.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"border = #3f3f3f"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsFont"></a><a class="term" href="options.html#opt-programs.termite.hintsFont"><code class="option">programs.termite.hintsFont</code></a></span></dt><dd><p>The font description for the hints font.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Monospace 12"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsForegroundColor"></a><a class="term" href="options.html#opt-programs.termite.hintsForegroundColor"><code class="option">programs.termite.hintsForegroundColor</code></a></span></dt><dd><p>Hints foreground color value.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#dcdccc"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsPadding"></a><a class="term" href="options.html#opt-programs.termite.hintsPadding"><code class="option">programs.termite.hintsPadding</code></a></span></dt><dd><p>Hints padding.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.hintsRoundness"></a><a class="term" href="options.html#opt-programs.termite.hintsRoundness"><code class="option">programs.termite.hintsRoundness</code></a></span></dt><dd><p>Hints roundness.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.2"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.iconName"></a><a class="term" href="options.html#opt-programs.termite.iconName"><code class="option">programs.termite.iconName</code></a></span></dt><dd><p>The name of the icon to be used for the terminal process.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"terminal"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.modifyOtherKeys"></a><a class="term" href="options.html#opt-programs.termite.modifyOtherKeys"><code class="option">programs.termite.modifyOtherKeys</code></a></span></dt><dd><p>Emit escape sequences for extra keys,
|
||
like the modifyOtherKeys resource for
|
||
<span class="citerefentry"><span class="refentrytitle">xterm</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.mouseAutohide"></a><a class="term" href="options.html#opt-programs.termite.mouseAutohide"><code class="option">programs.termite.mouseAutohide</code></a></span></dt><dd><p>Automatically hide the mouse pointer when you start typing.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.optionsExtra"></a><a class="term" href="options.html#opt-programs.termite.optionsExtra"><code class="option">programs.termite.optionsExtra</code></a></span></dt><dd><p>Extra options that should be added to [options] section.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fullscreen = true"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.scrollOnKeystroke"></a><a class="term" href="options.html#opt-programs.termite.scrollOnKeystroke"><code class="option">programs.termite.scrollOnKeystroke</code></a></span></dt><dd><p>Scroll to the bottom automatically when a key is pressed.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.scrollOnOutput"></a><a class="term" href="options.html#opt-programs.termite.scrollOnOutput"><code class="option">programs.termite.scrollOnOutput</code></a></span></dt><dd><p>Scroll to the bottom when the shell generates output.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.scrollbackLines"></a><a class="term" href="options.html#opt-programs.termite.scrollbackLines"><code class="option">programs.termite.scrollbackLines</code></a></span></dt><dd><p>Set the number of lines to limit the terminal's scrollback.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">10000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.scrollbar"></a><a class="term" href="options.html#opt-programs.termite.scrollbar"><code class="option">programs.termite.scrollbar</code></a></span></dt><dd><p>Scrollbar position.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "off", "left", "right"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.searchWrap"></a><a class="term" href="options.html#opt-programs.termite.searchWrap"><code class="option">programs.termite.searchWrap</code></a></span></dt><dd><p>Search from top again when you hit the bottom.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.sizeHints"></a><a class="term" href="options.html#opt-programs.termite.sizeHints"><code class="option">programs.termite.sizeHints</code></a></span></dt><dd><p>Enable size hints. Locks the terminal resizing
|
||
to increments of the terminal's cell size.
|
||
Requires a window manager that respects scroll hints.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.termite.urgentOnBell"></a><a class="term" href="options.html#opt-programs.termite.urgentOnBell"><code class="option">programs.termite.urgentOnBell</code></a></span></dt><dd><p>Sets the window as urgent on the terminal bell.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/termite.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/termite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.texlive.enable"></a><a class="term" href="options.html#opt-programs.texlive.enable"><code class="option">programs.texlive.enable</code></a></span></dt><dd><p>Whether to enable TeX Live.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/texlive.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/texlive.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.texlive.package"></a><a class="term" href="options.html#opt-programs.texlive.package"><code class="option">programs.texlive.package</code></a></span></dt><dd><p>Resulting customized TeX Live package.</p><p><span class="emphasis"><em>Type:</em></span> package <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/texlive.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/texlive.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.texlive.packageSet"></a><a class="term" href="options.html#opt-programs.texlive.packageSet"><code class="option">programs.texlive.packageSet</code></a></span></dt><dd><p>TeX Live package set to use.</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.texlive</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/texlive.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/texlive.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.texlive.extraPackages"></a><a class="term" href="options.html#opt-programs.texlive.extraPackages"><code class="option">programs.texlive.extraPackages</code></a></span></dt><dd><p>Extra packages available to TeX Live.</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"tpkgs: { inherit (tpkgs) collection-basic; }"</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">tpkgs: { inherit (tpkgs) collection-fontsrecommended algorithms; }
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/texlive.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/texlive.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.timidity.enable"></a><a class="term" href="options.html#opt-programs.timidity.enable"><code class="option">programs.timidity.enable</code></a></span></dt><dd><p>Whether to enable timidity, a software MIDI renderer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/timidity.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/timidity.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.timidity.package"></a><a class="term" href="options.html#opt-programs.timidity.package"><code class="option">programs.timidity.package</code></a></span></dt><dd><p>The timidity package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.timidity</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/timidity.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/timidity.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.timidity.extraConfig"></a><a class="term" href="options.html#opt-programs.timidity.extraConfig"><code class="option">programs.timidity.extraConfig</code></a></span></dt><dd><p>Extra configuration.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
soundfont ${pkgs.soundfont-fluid}/share/soundfonts/FluidR3_GM2-2.sf2
|
||
''
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/timidity.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/timidity.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.timidity.finalPackage"></a><a class="term" href="options.html#opt-programs.timidity.finalPackage"><code class="option">programs.timidity.finalPackage</code></a></span></dt><dd><p>Resulting package.</p><p><span class="emphasis"><em>Type:</em></span> package <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/timidity.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/timidity.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tint2.enable"></a><a class="term" href="options.html#opt-programs.tint2.enable"><code class="option">programs.tint2.enable</code></a></span></dt><dd><p>Whether to enable tint2, a simple, unobtrusive and light panel for Xorg.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tint2.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tint2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tint2.package"></a><a class="term" href="options.html#opt-programs.tint2.package"><code class="option">programs.tint2.package</code></a></span></dt><dd><p>Tint2 package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.tint2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tint2.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tint2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tint2.extraConfig"></a><a class="term" href="options.html#opt-programs.tint2.extraConfig"><code class="option">programs.tint2.extraConfig</code></a></span></dt><dd><p>Commands for tint2 that will be add to the <code class="filename">tint2rc</code>
|
||
file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tint2.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tint2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tiny.enable"></a><a class="term" href="options.html#opt-programs.tiny.enable"><code class="option">programs.tiny.enable</code></a></span></dt><dd><p>Whether to enable tiny, a TUI IRC client written in Rust.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tiny.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tiny.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tiny.package"></a><a class="term" href="options.html#opt-programs.tiny.package"><code class="option">programs.tiny.package</code></a></span></dt><dd><p>The <span class="command"><strong>tiny</strong></span> package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.tiny</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tiny.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tiny.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tiny.settings"></a><a class="term" href="options.html#opt-programs.tiny.settings"><code class="option">programs.tiny.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/tiny/config.yml</code>. See
|
||
<a class="link" href="https://github.com/osa1/tiny/blob/master/crates/tiny/config.yml" target="_top">https://github.com/osa1/tiny/blob/master/crates/tiny/config.yml</a>
|
||
for the default configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
servers = [
|
||
{
|
||
addr = "irc.libera.chat";
|
||
port = 6697;
|
||
tls = true;
|
||
realname = "John Doe";
|
||
nicks = [ "tinyuser" ];
|
||
}
|
||
];
|
||
defaults = {
|
||
nicks = [ "tinyuser" ];
|
||
realname = "John Doe";
|
||
join = [];
|
||
tls = true;
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tiny.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tiny.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.enable"></a><a class="term" href="options.html#opt-programs.tmux.enable"><code class="option">programs.tmux.enable</code></a></span></dt><dd><p>Whether to enable tmux.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.package"></a><a class="term" href="options.html#opt-programs.tmux.package"><code class="option">programs.tmux.package</code></a></span></dt><dd><p>The tmux package to install</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.tmux</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.tmux</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.aggressiveResize"></a><a class="term" href="options.html#opt-programs.tmux.aggressiveResize"><code class="option">programs.tmux.aggressiveResize</code></a></span></dt><dd><p>Resize the window to the size of the smallest session for
|
||
which it is the current window.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.baseIndex"></a><a class="term" href="options.html#opt-programs.tmux.baseIndex"><code class="option">programs.tmux.baseIndex</code></a></span></dt><dd><p>Base index for windows and panes.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">1</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.clock24"></a><a class="term" href="options.html#opt-programs.tmux.clock24"><code class="option">programs.tmux.clock24</code></a></span></dt><dd><p>Use 24 hour clock.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.customPaneNavigationAndResize"></a><a class="term" href="options.html#opt-programs.tmux.customPaneNavigationAndResize"><code class="option">programs.tmux.customPaneNavigationAndResize</code></a></span></dt><dd><p>Override the hjkl and HJKL bindings for pane navigation and
|
||
resizing in VI mode.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.disableConfirmationPrompt"></a><a class="term" href="options.html#opt-programs.tmux.disableConfirmationPrompt"><code class="option">programs.tmux.disableConfirmationPrompt</code></a></span></dt><dd><p>Disable confirmation prompt before killing a pane or window
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.escapeTime"></a><a class="term" href="options.html#opt-programs.tmux.escapeTime"><code class="option">programs.tmux.escapeTime</code></a></span></dt><dd><p>Time in milliseconds for which tmux waits after an escape is
|
||
input.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">500</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.extraConfig"></a><a class="term" href="options.html#opt-programs.tmux.extraConfig"><code class="option">programs.tmux.extraConfig</code></a></span></dt><dd><p>Additional configuration to add to
|
||
<code class="filename">tmux.conf</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.historyLimit"></a><a class="term" href="options.html#opt-programs.tmux.historyLimit"><code class="option">programs.tmux.historyLimit</code></a></span></dt><dd><p>Maximum number of lines held in window history.</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">2000</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.keyMode"></a><a class="term" href="options.html#opt-programs.tmux.keyMode"><code class="option">programs.tmux.keyMode</code></a></span></dt><dd><p>VI or Emacs style shortcuts.</p><p><span class="emphasis"><em>Type:</em></span> one of "emacs", "vi"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"emacs"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"vi"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.newSession"></a><a class="term" href="options.html#opt-programs.tmux.newSession"><code class="option">programs.tmux.newSession</code></a></span></dt><dd><p>Automatically spawn a session if trying to attach and none
|
||
are running.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.plugins"></a><a class="term" href="options.html#opt-programs.tmux.plugins"><code class="option">programs.tmux.plugins</code></a></span></dt><dd><p>List of tmux plugins to be included at the end of your tmux
|
||
configuration. The sensible plugin, however, is defaulted to
|
||
run at the top of your configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of plugin packages or submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">with pkgs; [
|
||
tmuxPlugins.cpu
|
||
{
|
||
plugin = tmuxPlugins.resurrect;
|
||
extraConfig = "set -g @resurrect-strategy-nvim 'session'";
|
||
}
|
||
{
|
||
plugin = tmuxPlugins.continuum;
|
||
extraConfig = ''
|
||
set -g @continuum-restore 'on'
|
||
set -g @continuum-save-interval '60' # minutes
|
||
'';
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.prefix"></a><a class="term" href="options.html#opt-programs.tmux.prefix"><code class="option">programs.tmux.prefix</code></a></span></dt><dd><p>Set the prefix key. Overrules the "shortcut" option when set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"C-a"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.resizeAmount"></a><a class="term" href="options.html#opt-programs.tmux.resizeAmount"><code class="option">programs.tmux.resizeAmount</code></a></span></dt><dd><p>Number of lines/columns when resizing.</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">10</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.reverseSplit"></a><a class="term" href="options.html#opt-programs.tmux.reverseSplit"><code class="option">programs.tmux.reverseSplit</code></a></span></dt><dd><p>Reverse the window split shortcuts.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.secureSocket"></a><a class="term" href="options.html#opt-programs.tmux.secureSocket"><code class="option">programs.tmux.secureSocket</code></a></span></dt><dd><p>Store tmux socket under <code class="filename">/run</code>, which is more
|
||
secure than <code class="filename">/tmp</code>, but as a downside it doesn't
|
||
survive user logout.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.sensibleOnTop"></a><a class="term" href="options.html#opt-programs.tmux.sensibleOnTop"><code class="option">programs.tmux.sensibleOnTop</code></a></span></dt><dd><p>Run the sensible plugin at the top of the configuration. It
|
||
is possible to override the sensible settings using the
|
||
<code class="option">programs.tmux.extraConfig</code> option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.shell"></a><a class="term" href="options.html#opt-programs.tmux.shell"><code class="option">programs.tmux.shell</code></a></span></dt><dd><p>Set the default-shell tmux variable.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.zsh}/bin/zsh"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.shortcut"></a><a class="term" href="options.html#opt-programs.tmux.shortcut"><code class="option">programs.tmux.shortcut</code></a></span></dt><dd><p>CTRL following by this key is used as the main shortcut.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"b"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"a"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.terminal"></a><a class="term" href="options.html#opt-programs.tmux.terminal"><code class="option">programs.tmux.terminal</code></a></span></dt><dd><p>Set the $TERM variable.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"screen"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"screen-256color"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.tmuxinator.enable"></a><a class="term" href="options.html#opt-programs.tmux.tmuxinator.enable"><code class="option">programs.tmux.tmuxinator.enable</code></a></span></dt><dd><p>Whether to enable tmuxinator.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.tmux.tmuxp.enable"></a><a class="term" href="options.html#opt-programs.tmux.tmuxp.enable"><code class="option">programs.tmux.tmuxp.enable</code></a></span></dt><dd><p>Whether to enable tmuxp.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/tmux.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/tmux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.topgrade.enable"></a><a class="term" href="options.html#opt-programs.topgrade.enable"><code class="option">programs.topgrade.enable</code></a></span></dt><dd><p>Whether to enable topgrade.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/topgrade.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/topgrade.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.topgrade.package"></a><a class="term" href="options.html#opt-programs.topgrade.package"><code class="option">programs.topgrade.package</code></a></span></dt><dd><p>The package to use for the topgrade binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.topgrade</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/topgrade.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/topgrade.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.topgrade.settings"></a><a class="term" href="options.html#opt-programs.topgrade.settings"><code class="option">programs.topgrade.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/topgrade.toml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/r-darwish/topgrade/wiki/Step-list" target="_top">https://github.com/r-darwish/topgrade/wiki/Step-list</a> for the full list
|
||
of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
assume_yes = true;
|
||
disable = [
|
||
"flutter"
|
||
"node"
|
||
];
|
||
set_title = false;
|
||
cleanup = true;
|
||
commands = {
|
||
"Run garbage collection on Nix store" = "nix-collect-garbage";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/topgrade.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/topgrade.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.enable"></a><a class="term" href="options.html#opt-programs.urxvt.enable"><code class="option">programs.urxvt.enable</code></a></span></dt><dd><p>Whether to enable rxvt-unicode terminal emulator.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.package"></a><a class="term" href="options.html#opt-programs.urxvt.package"><code class="option">programs.urxvt.package</code></a></span></dt><dd><p>rxvt-unicode package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.rxvt_unicode</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.extraConfig"></a><a class="term" href="options.html#opt-programs.urxvt.extraConfig"><code class="option">programs.urxvt.extraConfig</code></a></span></dt><dd><p>Additional configuration to add.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
shading = 15;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.fonts"></a><a class="term" href="options.html#opt-programs.urxvt.fonts"><code class="option">programs.urxvt.fonts</code></a></span></dt><dd><p>List of fonts to be used.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"xft:Droid Sans Mono Nerd Font:size=9"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.iso14755"></a><a class="term" href="options.html#opt-programs.urxvt.iso14755"><code class="option">programs.urxvt.iso14755</code></a></span></dt><dd><p>ISO14755 support for viewing and entering unicode characters.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.keybindings"></a><a class="term" href="options.html#opt-programs.urxvt.keybindings"><code class="option">programs.urxvt.keybindings</code></a></span></dt><dd><p>Mapping of keybindings to actions</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"Shift-Control-C" = "eval:selection_to_clipboard";
|
||
"Shift-Control-V" = "eval:paste_clipboard";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.bar"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.bar"><code class="option">programs.urxvt.scroll.bar</code></a></span></dt><dd><p>Scrollbar settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.bar.enable"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.bar.enable"><code class="option">programs.urxvt.scroll.bar.enable</code></a></span></dt><dd><p>Whether to enable the scrollbar</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.bar.align"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.bar.align"><code class="option">programs.urxvt.scroll.bar.align</code></a></span></dt><dd><p>Scrollbar alignment.</p><p><span class="emphasis"><em>Type:</em></span> one of "top", "bottom", "center"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"center"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.bar.floating"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.bar.floating"><code class="option">programs.urxvt.scroll.bar.floating</code></a></span></dt><dd><p>Whether to display an rxvt scrollbar without a trough.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.bar.position"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.bar.position"><code class="option">programs.urxvt.scroll.bar.position</code></a></span></dt><dd><p>Scrollbar position.</p><p><span class="emphasis"><em>Type:</em></span> one of "left", "right"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"right"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.bar.style"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.bar.style"><code class="option">programs.urxvt.scroll.bar.style</code></a></span></dt><dd><p>Scrollbar style.</p><p><span class="emphasis"><em>Type:</em></span> one of "rxvt", "plain", "next", "xterm"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"plain"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.keepPosition"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.keepPosition"><code class="option">programs.urxvt.scroll.keepPosition</code></a></span></dt><dd><p>Whether to keep a scroll position when TTY receives new lines.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.lines"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.lines"><code class="option">programs.urxvt.scroll.lines</code></a></span></dt><dd><p>Number of lines to save in the scrollback buffer.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.scrollOnKeystroke"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.scrollOnKeystroke"><code class="option">programs.urxvt.scroll.scrollOnKeystroke</code></a></span></dt><dd><p>Whether to scroll to bottom on keyboard input.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.scroll.scrollOnOutput"></a><a class="term" href="options.html#opt-programs.urxvt.scroll.scrollOnOutput"><code class="option">programs.urxvt.scroll.scrollOnOutput</code></a></span></dt><dd><p>Whether to scroll to bottom on TTY output.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.shading"></a><a class="term" href="options.html#opt-programs.urxvt.shading"><code class="option">programs.urxvt.shading</code></a></span></dt><dd><p>Darken (0 .. 99) or lighten (101 .. 200) the transparent background.</p><p><span class="emphasis"><em>Type:</em></span> integer between 0 and 200 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">100</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.urxvt.transparent"></a><a class="term" href="options.html#opt-programs.urxvt.transparent"><code class="option">programs.urxvt.transparent</code></a></span></dt><dd><p>Whether to enable pseudo-transparency.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/urxvt.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/urxvt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vim.enable"></a><a class="term" href="options.html#opt-programs.vim.enable"><code class="option">programs.vim.enable</code></a></span></dt><dd><p>Whether to enable Vim.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vim.package"></a><a class="term" href="options.html#opt-programs.vim.package"><code class="option">programs.vim.package</code></a></span></dt><dd><p>Resulting customized vim package</p><p><span class="emphasis"><em>Type:</em></span> package <span class="emphasis"><em>(read only)</em></span></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vim.packageConfigurable"></a><a class="term" href="options.html#opt-programs.vim.packageConfigurable"><code class="option">programs.vim.packageConfigurable</code></a></span></dt><dd><p>Configurable vim package</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.vim_configurable"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vim.extraConfig"></a><a class="term" href="options.html#opt-programs.vim.extraConfig"><code class="option">programs.vim.extraConfig</code></a></span></dt><dd><p>Custom .vimrc lines</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
set nocompatible
|
||
set nobackup
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vim.plugins"></a><a class="term" href="options.html#opt-programs.vim.plugins"><code class="option">programs.vim.plugins</code></a></span></dt><dd><p>List of vim plugins to install. To get a list of supported plugins run:
|
||
<span class="command"><strong>nix-env -f '<nixpkgs>' -qaP -A vimPlugins</strong></span>.
|
||
|
||
</p><p>
|
||
|
||
Note: String values are deprecated, please use actual packages.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
<em class="replaceable"><code>(build of vimplugin-vim-sensible-2022-04-11)</code></em>
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.vimPlugins.YankRing ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vim.settings"></a><a class="term" href="options.html#opt-programs.vim.settings"><code class="option">programs.vim.settings</code></a></span></dt><dd><p>At attribute set of Vim settings. The attribute names and
|
||
corresponding values must be among the following supported
|
||
options.
|
||
|
||
</p><div class="informaltable"><table class="informaltable" border="0"><colgroup><col /></colgroup><tbody><tr><td><code class="varname">background</code></td><td>one of "dark", "light"</td></tr><tr><td><code class="varname">backupdir</code></td><td>list of string</td></tr><tr><td><code class="varname">copyindent</code></td><td>boolean</td></tr><tr><td><code class="varname">directory</code></td><td>list of string</td></tr><tr><td><code class="varname">expandtab</code></td><td>boolean</td></tr><tr><td><code class="varname">hidden</code></td><td>boolean</td></tr><tr><td><code class="varname">history</code></td><td>signed integer</td></tr><tr><td><code class="varname">ignorecase</code></td><td>boolean</td></tr><tr><td><code class="varname">modeline</code></td><td>boolean</td></tr><tr><td><code class="varname">mouse</code></td><td>one of "n", "v", "i", "c", "h", "a", "r"</td></tr><tr><td><code class="varname">mousefocus</code></td><td>boolean</td></tr><tr><td><code class="varname">mousehide</code></td><td>boolean</td></tr><tr><td><code class="varname">mousemodel</code></td><td>one of "extend", "popup", "popup_setpos"</td></tr><tr><td><code class="varname">number</code></td><td>boolean</td></tr><tr><td><code class="varname">relativenumber</code></td><td>boolean</td></tr><tr><td><code class="varname">shiftwidth</code></td><td>signed integer</td></tr><tr><td><code class="varname">smartcase</code></td><td>boolean</td></tr><tr><td><code class="varname">tabstop</code></td><td>signed integer</td></tr><tr><td><code class="varname">undodir</code></td><td>list of string</td></tr><tr><td><code class="varname">undofile</code></td><td>boolean</td></tr></tbody></table></div><p>
|
||
|
||
See the Vim documentation for detailed descriptions of these
|
||
options. Note, use <code class="varname">extraConfig</code> to
|
||
manually set any options not listed above.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
expandtab = true;
|
||
history = 1000;
|
||
background = "dark";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vim.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.enable"></a><a class="term" href="options.html#opt-programs.vscode.enable"><code class="option">programs.vscode.enable</code></a></span></dt><dd><p>Whether to enable Visual Studio Code.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.package"></a><a class="term" href="options.html#opt-programs.vscode.package"><code class="option">programs.vscode.package</code></a></span></dt><dd><p>Version of Visual Studio Code to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of vscode-1.68.0)</code></em></code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.vscodium</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.extensions"></a><a class="term" href="options.html#opt-programs.vscode.extensions"><code class="option">programs.vscode.extensions</code></a></span></dt><dd><p>The extensions Visual Studio Code should be started with.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.vscode-extensions.bbenoist.nix ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.haskell.enable"></a><a class="term" href="options.html#opt-programs.vscode.haskell.enable"><code class="option">programs.vscode.haskell.enable</code></a></span></dt><dd><p>Whether to enable Haskell integration for Visual Studio Code.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode/haskell.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode/haskell.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.haskell.hie.enable"></a><a class="term" href="options.html#opt-programs.vscode.haskell.hie.enable"><code class="option">programs.vscode.haskell.hie.enable</code></a></span></dt><dd><p>Whether to enable Haskell IDE engine integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode/haskell.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode/haskell.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.haskell.hie.executablePath"></a><a class="term" href="options.html#opt-programs.vscode.haskell.hie.executablePath"><code class="option">programs.vscode.haskell.hie.executablePath</code></a></span></dt><dd><p>The path to the Haskell IDE Engine executable.
|
||
</p><p>
|
||
Because hie-nix is not packaged in Nixpkgs, you need to add it as an
|
||
overlay or set this option. Example overlay configuration:
|
||
</p><pre class="programlisting nix">nixpkgs.overlays = [
|
||
(self: super: { hie-nix = import ~/src/hie-nix {}; })
|
||
]
|
||
</pre><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"${pkgs.hie-nix.hies}/bin/hie-wrapper"</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">(import ~/src/haskell-ide-engine {}).hies + "/bin/hie-wrapper";
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode/haskell.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode/haskell.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.keybindings"></a><a class="term" href="options.html#opt-programs.vscode.keybindings"><code class="option">programs.vscode.keybindings</code></a></span></dt><dd><p>Keybindings written to Visual Studio Code's
|
||
<code class="filename">keybindings.json</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
key = "ctrl+c";
|
||
command = "editor.action.clipboardCopyAction";
|
||
when = "textInputFocus";
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.keybindings._.args"></a><a class="term" href="options.html#opt-programs.vscode.keybindings._.args"><code class="option">programs.vscode.keybindings.*.args</code></a></span></dt><dd><p>Optional arguments for a command.</p><p><span class="emphasis"><em>Type:</em></span> null or JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
direction = "up";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.keybindings._.command"></a><a class="term" href="options.html#opt-programs.vscode.keybindings._.command"><code class="option">programs.vscode.keybindings.*.command</code></a></span></dt><dd><p>The VS Code command to execute.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"editor.action.clipboardCopyAction"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.keybindings._.key"></a><a class="term" href="options.html#opt-programs.vscode.keybindings._.key"><code class="option">programs.vscode.keybindings.*.key</code></a></span></dt><dd><p>The key or key-combination to bind.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"ctrl+c"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.keybindings._.when"></a><a class="term" href="options.html#opt-programs.vscode.keybindings._.when"><code class="option">programs.vscode.keybindings.*.when</code></a></span></dt><dd><p>Optional context filter.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"textInputFocus"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.mutableExtensionsDir"></a><a class="term" href="options.html#opt-programs.vscode.mutableExtensionsDir"><code class="option">programs.vscode.mutableExtensionsDir</code></a></span></dt><dd><p>Whether extensions can be installed or updated manually
|
||
or by Visual Studio Code.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.userSettings"></a><a class="term" href="options.html#opt-programs.vscode.userSettings"><code class="option">programs.vscode.userSettings</code></a></span></dt><dd><p>Configuration written to Visual Studio Code's
|
||
<code class="filename">settings.json</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"update.channel" = "none";
|
||
"[nix]"."editor.tabSize" = 2;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.vscode.userTasks"></a><a class="term" href="options.html#opt-programs.vscode.userTasks"><code class="option">programs.vscode.userTasks</code></a></span></dt><dd><p>Configuration written to Visual Studio Code's
|
||
<code class="filename">tasks.json</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"version": "2.0.0",
|
||
"tasks": [
|
||
{
|
||
"type": "shell",
|
||
"label": "Hello task",
|
||
"command": "hello",
|
||
}
|
||
]
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/vscode.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/vscode.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.watson.enable"></a><a class="term" href="options.html#opt-programs.watson.enable"><code class="option">programs.watson.enable</code></a></span></dt><dd><p>Whether to enable watson, a wonderful CLI to track your time.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/watson.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/watson.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.watson.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.watson.enableBashIntegration"><code class="option">programs.watson.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable watson's bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/watson.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/watson.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.watson.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.watson.enableFishIntegration"><code class="option">programs.watson.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable watson's fish integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/watson.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/watson.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.watson.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.watson.enableZshIntegration"><code class="option">programs.watson.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable watson's zsh integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/watson.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/watson.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.watson.package"></a><a class="term" href="options.html#opt-programs.watson.package"><code class="option">programs.watson.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>watson</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.watson</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/watson.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/watson.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.watson.settings"></a><a class="term" href="options.html#opt-programs.watson.settings"><code class="option">programs.watson.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/watson/config</code> on Linux or
|
||
<code class="filename">$HOME/Library/Application Support/watson/config</code> on Darwin.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/TailorDev/Watson/blob/master/docs/user-guide/configuration.md" target="_top">https://github.com/TailorDev/Watson/blob/master/docs/user-guide/configuration.md</a>
|
||
for an example configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
backend = {
|
||
url = "https://api.crick.fr";
|
||
token = "yourapitoken";
|
||
};
|
||
|
||
options = {
|
||
stop_on_start = true;
|
||
stop_on_restart = false;
|
||
date_format = "%Y.%m.%d";
|
||
time_format = "%H:%M:%S%z";
|
||
week_start = "monday";
|
||
log_current = false;
|
||
pager = true;
|
||
report_current = false;
|
||
reverse_log = true;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/watson.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/watson.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.waybar.enable"></a><a class="term" href="options.html#opt-programs.waybar.enable"><code class="option">programs.waybar.enable</code></a></span></dt><dd><p>Whether to enable Waybar.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/waybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/waybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.waybar.package"></a><a class="term" href="options.html#opt-programs.waybar.package"><code class="option">programs.waybar.package</code></a></span></dt><dd><p>Waybar package to use. Set to <code class="code">null</code> to use the default package.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.waybar</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/waybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/waybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.waybar.settings"></a><a class="term" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a></span></dt><dd><p>Configuration for Waybar, see <a class="link" href="https://github.com/Alexays/Waybar/wiki/Configuration" target="_top">https://github.com/Alexays/Waybar/wiki/Configuration</a>
|
||
for supported values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of JSON value or attribute set of JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
mainBar = {
|
||
layer = "top";
|
||
position = "top";
|
||
height = 30;
|
||
output = [
|
||
"eDP-1"
|
||
"HDMI-A-1"
|
||
];
|
||
modules-left = [ "sway/workspaces" "sway/mode" "wlr/taskbar" ];
|
||
modules-center = [ "sway/window" "custom/hello-from-waybar" ];
|
||
modules-right = [ "mpd" "custom/mymodule#with-css-id" "temperature" ];
|
||
|
||
"sway/workspaces" = {
|
||
disable-scroll = true;
|
||
all-outputs = true;
|
||
};
|
||
"custom/hello-from-waybar" = {
|
||
format = "hello {}";
|
||
max-length = 40;
|
||
interval = "once";
|
||
exec = pkgs.writeShellScript "hello-from-waybar" ''
|
||
echo "from within waybar"
|
||
'';
|
||
};
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/waybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/waybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.waybar.style"></a><a class="term" href="options.html#opt-programs.waybar.style"><code class="option">programs.waybar.style</code></a></span></dt><dd><p>CSS style of the bar.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/Alexays/Waybar/wiki/Configuration" target="_top">https://github.com/Alexays/Waybar/wiki/Configuration</a>
|
||
for the documentation.
|
||
</p><p>
|
||
If the value is set to a path literal, then the path will be used as the css file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
* {
|
||
border: none;
|
||
border-radius: 0;
|
||
font-family: Source Code Pro;
|
||
}
|
||
window#waybar {
|
||
background: #16191C;
|
||
color: #AAB2BF;
|
||
}
|
||
#workspaces button {
|
||
padding: 0 5px;
|
||
}
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/waybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/waybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.waybar.systemd.enable"></a><a class="term" href="options.html#opt-programs.waybar.systemd.enable"><code class="option">programs.waybar.systemd.enable</code></a></span></dt><dd><p>Whether to enable Waybar systemd integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/waybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/waybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.waybar.systemd.target"></a><a class="term" href="options.html#opt-programs.waybar.systemd.target"><code class="option">programs.waybar.systemd.target</code></a></span></dt><dd><p>The systemd target that will automatically start the Waybar service.
|
||
</p><p>
|
||
When setting this value to <code class="literal">"sway-session.target"</code>,
|
||
make sure to also enable <code class="option">wayland.windowManager.sway.systemdIntegration</code>,
|
||
otherwise the service may never be started.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"graphical-session.target"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"sway-session.target"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/waybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/waybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.xmobar.enable"></a><a class="term" href="options.html#opt-programs.xmobar.enable"><code class="option">programs.xmobar.enable</code></a></span></dt><dd><p>Whether to enable Xmobar, a minimalistic status bar.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/xmobar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/xmobar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.xmobar.package"></a><a class="term" href="options.html#opt-programs.xmobar.package"><code class="option">programs.xmobar.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>xmobar</strong></span> binary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.haskellPackages.xmobar</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/xmobar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/xmobar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.xmobar.extraConfig"></a><a class="term" href="options.html#opt-programs.xmobar.extraConfig"><code class="option">programs.xmobar.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to
|
||
<code class="filename">$XDG_CONFIG_HOME/xmobar/.xmobarrc</code>.
|
||
See
|
||
<a class="link" href="https://xmobar.org/#configuration" target="_top">https://xmobar.org/#configuration</a>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">Config
|
||
{ font = "Fira Code"
|
||
, borderColor = "#d0d0d0"
|
||
, border = FullB
|
||
, borderWidth = 3
|
||
, bgColor = "#222"
|
||
, fgColor = "grey"
|
||
, position = TopSize C 99 30
|
||
, commands =
|
||
[ Run Cpu ["-t", "cpu: <fc=#4eb4fa><bar> <total>%</fc>"] 10
|
||
, Run Network "enp3s0" ["-S", "True", "-t", "eth: <fc=#4eb4fa><rx></fc>/<fc=#4eb4fa><tx></fc>"] 10
|
||
, Run Memory ["-t","mem: <fc=#4eb4fa><usedbar> <usedratio>%</fc>"] 10
|
||
, Run Date "date: <fc=#4eb4fa>%a %d %b %Y %H:%M:%S </fc>" "date" 10
|
||
, Run StdinReader
|
||
]
|
||
, sepChar = "%"
|
||
, alignSep = "}{"
|
||
, template = " %StdinReader% | %cpu% | %memory% | %enp3s0% }{%date% "
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/xmobar.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/xmobar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.z-lua.enable"></a><a class="term" href="options.html#opt-programs.z-lua.enable"><code class="option">programs.z-lua.enable</code></a></span></dt><dd><p>Whether to enable z.lua.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/z-lua.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/z-lua.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.z-lua.enableAliases"></a><a class="term" href="options.html#opt-programs.z-lua.enableAliases"><code class="option">programs.z-lua.enableAliases</code></a></span></dt><dd><p>Whether to enable recommended z.lua aliases.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/z-lua.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/z-lua.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.z-lua.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.z-lua.enableBashIntegration"><code class="option">programs.z-lua.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/z-lua.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/z-lua.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.z-lua.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.z-lua.enableFishIntegration"><code class="option">programs.z-lua.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/z-lua.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/z-lua.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.z-lua.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.z-lua.enableZshIntegration"><code class="option">programs.z-lua.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/z-lua.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/z-lua.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.z-lua.options"></a><a class="term" href="options.html#opt-programs.z-lua.options"><code class="option">programs.z-lua.options</code></a></span></dt><dd><p>List of options to pass to z.lua.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"enhanced" "once" "fzf"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/z-lua.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/z-lua.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zathura.enable"></a><a class="term" href="options.html#opt-programs.zathura.enable"><code class="option">programs.zathura.enable</code></a></span></dt><dd><p>Whether to enable Zathura, a highly customizable and functional document viewer
|
||
focused on keyboard interaction.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zathura.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zathura.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zathura.package"></a><a class="term" href="options.html#opt-programs.zathura.package"><code class="option">programs.zathura.package</code></a></span></dt><dd><p>The Zathura package to use</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.zathura"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zathura.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zathura.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zathura.extraConfig"></a><a class="term" href="options.html#opt-programs.zathura.extraConfig"><code class="option">programs.zathura.extraConfig</code></a></span></dt><dd><p>Additional commands for zathura that will be added to the
|
||
<code class="filename">zathurarc</code> file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zathura.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zathura.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zathura.options"></a><a class="term" href="options.html#opt-programs.zathura.options"><code class="option">programs.zathura.options</code></a></span></dt><dd><p>Add <code class="option">:set</code> command options to zathura and make
|
||
them permanent. See
|
||
<span class="citerefentry"><span class="refentrytitle">zathurarc</span>(5)</span>
|
||
for the full list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
default-bg = "#000000"; default-fg = "#FFFFFF";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zathura.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zathura.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zellij.enable"></a><a class="term" href="options.html#opt-programs.zellij.enable"><code class="option">programs.zellij.enable</code></a></span></dt><dd><p>Whether to enable zellij.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zellij.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zellij.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zellij.package"></a><a class="term" href="options.html#opt-programs.zellij.package"><code class="option">programs.zellij.package</code></a></span></dt><dd><p>The zellij package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.zellij</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zellij.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zellij.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zellij.settings"></a><a class="term" href="options.html#opt-programs.zellij.settings"><code class="option">programs.zellij.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/zellij/config.yaml</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://zellij.dev/documentation" target="_top">https://zellij.dev/documentation</a> for the full
|
||
list of options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
theme = "custom";
|
||
themes.custom.fg = 5;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zellij.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zellij.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zoxide.enable"></a><a class="term" href="options.html#opt-programs.zoxide.enable"><code class="option">programs.zoxide.enable</code></a></span></dt><dd><p>Whether to enable zoxide.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zoxide.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zoxide.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zoxide.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.zoxide.enableBashIntegration"><code class="option">programs.zoxide.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zoxide.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zoxide.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zoxide.enableFishIntegration"></a><a class="term" href="options.html#opt-programs.zoxide.enableFishIntegration"><code class="option">programs.zoxide.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zoxide.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zoxide.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zoxide.enableZshIntegration"></a><a class="term" href="options.html#opt-programs.zoxide.enableZshIntegration"><code class="option">programs.zoxide.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zoxide.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zoxide.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zoxide.package"></a><a class="term" href="options.html#opt-programs.zoxide.package"><code class="option">programs.zoxide.package</code></a></span></dt><dd><p>Zoxide package to install.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.zoxide</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zoxide.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zoxide.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zoxide.options"></a><a class="term" href="options.html#opt-programs.zoxide.options"><code class="option">programs.zoxide.options</code></a></span></dt><dd><p>List of options to pass to zoxide.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--no-aliases"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zoxide.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zoxide.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.enable"></a><a class="term" href="options.html#opt-programs.zsh.enable"><code class="option">programs.zsh.enable</code></a></span></dt><dd><p>Whether to enable Z shell (Zsh).</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.enableAutosuggestions"></a><a class="term" href="options.html#opt-programs.zsh.enableAutosuggestions"><code class="option">programs.zsh.enableAutosuggestions</code></a></span></dt><dd><p>Enable zsh autosuggestions</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.enableCompletion"></a><a class="term" href="options.html#opt-programs.zsh.enableCompletion"><code class="option">programs.zsh.enableCompletion</code></a></span></dt><dd><p>Enable zsh completion. Don't forget to add
|
||
</p><pre class="programlisting nix">
|
||
environment.pathsToLink = [ "/share/zsh" ];
|
||
</pre><p>
|
||
to your system configuration to get completion for system packages (e.g. systemd).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.enableSyntaxHighlighting"></a><a class="term" href="options.html#opt-programs.zsh.enableSyntaxHighlighting"><code class="option">programs.zsh.enableSyntaxHighlighting</code></a></span></dt><dd><p>Enable zsh syntax highlighting</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.enableVteIntegration"></a><a class="term" href="options.html#opt-programs.zsh.enableVteIntegration"><code class="option">programs.zsh.enableVteIntegration</code></a></span></dt><dd><p>Whether to enable integration with terminals using the VTE
|
||
library. This will let the terminal track the current working
|
||
directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/vte.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/vte.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.autocd"></a><a class="term" href="options.html#opt-programs.zsh.autocd"><code class="option">programs.zsh.autocd</code></a></span></dt><dd><p>Automatically enter into a directory if typed directly into shell.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.cdpath"></a><a class="term" href="options.html#opt-programs.zsh.cdpath"><code class="option">programs.zsh.cdpath</code></a></span></dt><dd><p>List of paths to autocomplete calls to `cd`.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.completionInit"></a><a class="term" href="options.html#opt-programs.zsh.completionInit"><code class="option">programs.zsh.completionInit</code></a></span></dt><dd><p>Initialization commands to run when completion is enabled.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"autoload -U compinit && compinit"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.defaultKeymap"></a><a class="term" href="options.html#opt-programs.zsh.defaultKeymap"><code class="option">programs.zsh.defaultKeymap</code></a></span></dt><dd><p>The default base keymap to use.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "emacs", "vicmd", "viins"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"emacs"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.dirHashes"></a><a class="term" href="options.html#opt-programs.zsh.dirHashes"><code class="option">programs.zsh.dirHashes</code></a></span></dt><dd><p>An attribute set that adds to named directory hash table.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
docs = "$HOME/Documents";
|
||
vids = "$HOME/Videos";
|
||
dl = "$HOME/Downloads";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.dotDir"></a><a class="term" href="options.html#opt-programs.zsh.dotDir"><code class="option">programs.zsh.dotDir</code></a></span></dt><dd><p>Directory where the zsh configuration and more should be located,
|
||
relative to the users home directory. The default is the home
|
||
directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">".config/zsh"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.envExtra"></a><a class="term" href="options.html#opt-programs.zsh.envExtra"><code class="option">programs.zsh.envExtra</code></a></span></dt><dd><p>Extra commands that should be added to <code class="filename">.zshenv</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history"></a><a class="term" href="options.html#opt-programs.zsh.history"><code class="option">programs.zsh.history</code></a></span></dt><dd><p>Options related to commands history configuration.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.expireDuplicatesFirst"></a><a class="term" href="options.html#opt-programs.zsh.history.expireDuplicatesFirst"><code class="option">programs.zsh.history.expireDuplicatesFirst</code></a></span></dt><dd><p>Expire duplicates first.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.extended"></a><a class="term" href="options.html#opt-programs.zsh.history.extended"><code class="option">programs.zsh.history.extended</code></a></span></dt><dd><p>Save timestamp into the history file.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.ignoreDups"></a><a class="term" href="options.html#opt-programs.zsh.history.ignoreDups"><code class="option">programs.zsh.history.ignoreDups</code></a></span></dt><dd><p>Do not enter command lines into the history list
|
||
if they are duplicates of the previous event.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.ignorePatterns"></a><a class="term" href="options.html#opt-programs.zsh.history.ignorePatterns"><code class="option">programs.zsh.history.ignorePatterns</code></a></span></dt><dd><p>Do not enter command lines into the history list
|
||
if they match any one of the given shell patterns.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ "rm *" "pkill *" ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.ignoreSpace"></a><a class="term" href="options.html#opt-programs.zsh.history.ignoreSpace"><code class="option">programs.zsh.history.ignoreSpace</code></a></span></dt><dd><p>Do not enter command lines into the history list
|
||
if the first character is a space.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.path"></a><a class="term" href="options.html#opt-programs.zsh.history.path"><code class="option">programs.zsh.history.path</code></a></span></dt><dd><p>History file location</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">"$HOME/.zsh_history" if state version ≥ 20.03,
|
||
"$ZDOTDIR/.zsh_history" otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"${config.xdg.dataHome}/zsh/zsh_history"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.save"></a><a class="term" href="options.html#opt-programs.zsh.history.save"><code class="option">programs.zsh.history.save</code></a></span></dt><dd><p>Number of history lines to save.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.share"></a><a class="term" href="options.html#opt-programs.zsh.history.share"><code class="option">programs.zsh.history.share</code></a></span></dt><dd><p>Share command history between zsh sessions.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.history.size"></a><a class="term" href="options.html#opt-programs.zsh.history.size"><code class="option">programs.zsh.history.size</code></a></span></dt><dd><p>Number of history lines to keep.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.initExtra"></a><a class="term" href="options.html#opt-programs.zsh.initExtra"><code class="option">programs.zsh.initExtra</code></a></span></dt><dd><p>Extra commands that should be added to <code class="filename">.zshrc</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.initExtraBeforeCompInit"></a><a class="term" href="options.html#opt-programs.zsh.initExtraBeforeCompInit"><code class="option">programs.zsh.initExtraBeforeCompInit</code></a></span></dt><dd><p>Extra commands that should be added to <code class="filename">.zshrc</code> before compinit.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.initExtraFirst"></a><a class="term" href="options.html#opt-programs.zsh.initExtraFirst"><code class="option">programs.zsh.initExtraFirst</code></a></span></dt><dd><p>Commands that should be added to top of <code class="filename">.zshrc</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.localVariables"></a><a class="term" href="options.html#opt-programs.zsh.localVariables"><code class="option">programs.zsh.localVariables</code></a></span></dt><dd><p>Extra local variables defined at the top of <code class="filename">.zshrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
POWERLEVEL9K_LEFT_PROMPT_ELEMENTS =
|
||
[
|
||
"dir" "vcs"
|
||
]
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.loginExtra"></a><a class="term" href="options.html#opt-programs.zsh.loginExtra"><code class="option">programs.zsh.loginExtra</code></a></span></dt><dd><p>Extra commands that should be added to <code class="filename">.zlogin</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.logoutExtra"></a><a class="term" href="options.html#opt-programs.zsh.logoutExtra"><code class="option">programs.zsh.logoutExtra</code></a></span></dt><dd><p>Extra commands that should be added to <code class="filename">.zlogout</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.oh-my-zsh"></a><a class="term" href="options.html#opt-programs.zsh.oh-my-zsh"><code class="option">programs.zsh.oh-my-zsh</code></a></span></dt><dd><p>Options to configure oh-my-zsh.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.oh-my-zsh.enable"></a><a class="term" href="options.html#opt-programs.zsh.oh-my-zsh.enable"><code class="option">programs.zsh.oh-my-zsh.enable</code></a></span></dt><dd><p>Whether to enable oh-my-zsh.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.oh-my-zsh.custom"></a><a class="term" href="options.html#opt-programs.zsh.oh-my-zsh.custom"><code class="option">programs.zsh.oh-my-zsh.custom</code></a></span></dt><dd><p>Path to a custom oh-my-zsh package to override config of
|
||
oh-my-zsh. See <a class="link" href="https://github.com/robbyrussell/oh-my-zsh/wiki/Customization" target="_top">https://github.com/robbyrussell/oh-my-zsh/wiki/Customization</a>
|
||
for more information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"$HOME/my_customizations"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.oh-my-zsh.extraConfig"></a><a class="term" href="options.html#opt-programs.zsh.oh-my-zsh.extraConfig"><code class="option">programs.zsh.oh-my-zsh.extraConfig</code></a></span></dt><dd><p>Extra settings for plugins.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.oh-my-zsh.plugins"></a><a class="term" href="options.html#opt-programs.zsh.oh-my-zsh.plugins"><code class="option">programs.zsh.oh-my-zsh.plugins</code></a></span></dt><dd><p>List of oh-my-zsh plugins
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"git" "sudo"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.oh-my-zsh.theme"></a><a class="term" href="options.html#opt-programs.zsh.oh-my-zsh.theme"><code class="option">programs.zsh.oh-my-zsh.theme</code></a></span></dt><dd><p>Name of the theme to be used by oh-my-zsh.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"robbyrussell"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.plugins"></a><a class="term" href="options.html#opt-programs.zsh.plugins"><code class="option">programs.zsh.plugins</code></a></span></dt><dd><p>Plugins to source in <code class="filename">.zshrc</code>.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
# will source zsh-autosuggestions.plugin.zsh
|
||
name = "zsh-autosuggestions";
|
||
src = pkgs.fetchFromGitHub {
|
||
owner = "zsh-users";
|
||
repo = "zsh-autosuggestions";
|
||
rev = "v0.4.0";
|
||
sha256 = "0z6i9wjjklb4lvr7zjhbphibsyx51psv50gm07mbb0kj9058j6kc";
|
||
};
|
||
}
|
||
{
|
||
name = "enhancd";
|
||
file = "init.sh";
|
||
src = pkgs.fetchFromGitHub {
|
||
owner = "b4b4r07";
|
||
repo = "enhancd";
|
||
rev = "v2.2.1";
|
||
sha256 = "0iqa9j09fwm6nj5rpip87x3hnvbbz9w9ajgm6wkrd5fls8fn8i5g";
|
||
};
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.plugins._.file"></a><a class="term" href="options.html#opt-programs.zsh.plugins._.file"><code class="option">programs.zsh.plugins.*.file</code></a></span></dt><dd><p>The plugin script to source.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.plugins._.name"></a><a class="term" href="options.html#opt-programs.zsh.plugins._.name"><code class="option">programs.zsh.plugins.*.name</code></a></span></dt><dd><p>The name of the plugin.
|
||
|
||
Don't forget to add <code class="option">file</code>
|
||
if the script name does not follow convention.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.plugins._.src"></a><a class="term" href="options.html#opt-programs.zsh.plugins._.src"><code class="option">programs.zsh.plugins.*.src</code></a></span></dt><dd><p>Path to the plugin folder.
|
||
|
||
Will be added to <code class="envar">fpath</code> and <code class="envar">PATH</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto"></a><a class="term" href="options.html#opt-programs.zsh.prezto"><code class="option">programs.zsh.prezto</code></a></span></dt><dd><p>Options to configure prezto.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.enable"></a><a class="term" href="options.html#opt-programs.zsh.prezto.enable"><code class="option">programs.zsh.prezto.enable</code></a></span></dt><dd><p>Whether to enable prezto.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.autosuggestions.color"></a><a class="term" href="options.html#opt-programs.zsh.prezto.autosuggestions.color"><code class="option">programs.zsh.prezto.autosuggestions.color</code></a></span></dt><dd><p>Set the query found color.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fg=blue"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.caseSensitive"></a><a class="term" href="options.html#opt-programs.zsh.prezto.caseSensitive"><code class="option">programs.zsh.prezto.caseSensitive</code></a></span></dt><dd><p>Set case-sensitivity for completion, history lookup, etc.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.color"></a><a class="term" href="options.html#opt-programs.zsh.prezto.color"><code class="option">programs.zsh.prezto.color</code></a></span></dt><dd><p>Color output (auto set to 'no' on dumb terminals)</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.completions.ignoredHosts"></a><a class="term" href="options.html#opt-programs.zsh.prezto.completions.ignoredHosts"><code class="option">programs.zsh.prezto.completions.ignoredHosts</code></a></span></dt><dd><p>Set the entries to ignore in static */etc/hosts* for host completion.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"0.0.0.0" "127.0.0.1"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.editor.dotExpansion"></a><a class="term" href="options.html#opt-programs.zsh.prezto.editor.dotExpansion"><code class="option">programs.zsh.prezto.editor.dotExpansion</code></a></span></dt><dd><p>Auto convert .... to ../..</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.editor.keymap"></a><a class="term" href="options.html#opt-programs.zsh.prezto.editor.keymap"><code class="option">programs.zsh.prezto.editor.keymap</code></a></span></dt><dd><p>Set the key mapping style to 'emacs' or 'vi'.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "emacs", "vi"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"emacs"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"vi"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.editor.promptContext"></a><a class="term" href="options.html#opt-programs.zsh.prezto.editor.promptContext"><code class="option">programs.zsh.prezto.editor.promptContext</code></a></span></dt><dd><p>Allow the zsh prompt context to be shown.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.extraConfig"></a><a class="term" href="options.html#opt-programs.zsh.prezto.extraConfig"><code class="option">programs.zsh.prezto.extraConfig</code></a></span></dt><dd><p>Additional configuration to add to <code class="filename">.zpreztorc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.extraFunctions"></a><a class="term" href="options.html#opt-programs.zsh.prezto.extraFunctions"><code class="option">programs.zsh.prezto.extraFunctions</code></a></span></dt><dd><p>Set the Zsh functions to load (man zshcontrib).</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"zargs" "zmv"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.extraModules"></a><a class="term" href="options.html#opt-programs.zsh.prezto.extraModules"><code class="option">programs.zsh.prezto.extraModules</code></a></span></dt><dd><p>Set the Zsh modules to load (man zshmodules).</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"attr" "stat"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.git.submoduleIgnore"></a><a class="term" href="options.html#opt-programs.zsh.prezto.git.submoduleIgnore"><code class="option">programs.zsh.prezto.git.submoduleIgnore</code></a></span></dt><dd><p>Ignore submodules when they are 'dirty', 'untracked', 'all', or 'none'.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "dirty", "untracked", "all", "none"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"all"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.gnuUtility.prefix"></a><a class="term" href="options.html#opt-programs.zsh.prezto.gnuUtility.prefix"><code class="option">programs.zsh.prezto.gnuUtility.prefix</code></a></span></dt><dd><p>Set the command prefix on non-GNU systems.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"g"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.historySubstring.foundColor"></a><a class="term" href="options.html#opt-programs.zsh.prezto.historySubstring.foundColor"><code class="option">programs.zsh.prezto.historySubstring.foundColor</code></a></span></dt><dd><p>Set the query found color.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fg=blue"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.historySubstring.globbingFlags"></a><a class="term" href="options.html#opt-programs.zsh.prezto.historySubstring.globbingFlags"><code class="option">programs.zsh.prezto.historySubstring.globbingFlags</code></a></span></dt><dd><p>Set the search globbing flags.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.historySubstring.notFoundColor"></a><a class="term" href="options.html#opt-programs.zsh.prezto.historySubstring.notFoundColor"><code class="option">programs.zsh.prezto.historySubstring.notFoundColor</code></a></span></dt><dd><p>Set the query not found color.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"fg=red"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.macOS.dashKeyword"></a><a class="term" href="options.html#opt-programs.zsh.prezto.macOS.dashKeyword"><code class="option">programs.zsh.prezto.macOS.dashKeyword</code></a></span></dt><dd><p>Set the keyword used by `mand` to open man pages in Dash.app</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"manpages"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.pmoduleDirs"></a><a class="term" href="options.html#opt-programs.zsh.prezto.pmoduleDirs"><code class="option">programs.zsh.prezto.pmoduleDirs</code></a></span></dt><dd><p>Add additional directories to load prezto modules from</p><p><span class="emphasis"><em>Type:</em></span> list of path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"$HOME/.zprezto-contrib"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.pmodules"></a><a class="term" href="options.html#opt-programs.zsh.prezto.pmodules"><code class="option">programs.zsh.prezto.pmodules</code></a></span></dt><dd><p>Set the Prezto modules to load (browse modules). The order matters.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"environment" "terminal" "editor" "history" "directory" "spectrum" "utility" "completion" "prompt"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.prompt.pwdLength"></a><a class="term" href="options.html#opt-programs.zsh.prezto.prompt.pwdLength"><code class="option">programs.zsh.prezto.prompt.pwdLength</code></a></span></dt><dd><p>Set the working directory prompt display length. By
|
||
default, it is set to 'short'. Set it to 'long' (without '~' expansion) for
|
||
longer or 'full' (with '~' expansion) for even longer prompt display.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "short", "long", "full"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"short"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.prompt.showReturnVal"></a><a class="term" href="options.html#opt-programs.zsh.prezto.prompt.showReturnVal"><code class="option">programs.zsh.prezto.prompt.showReturnVal</code></a></span></dt><dd><p>Set the prompt to display the return code along with an
|
||
indicator for non-zero return codes. This is not supported by all prompts.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.prompt.theme"></a><a class="term" href="options.html#opt-programs.zsh.prezto.prompt.theme"><code class="option">programs.zsh.prezto.prompt.theme</code></a></span></dt><dd><p>Set the prompt theme to load. Setting it to 'random'
|
||
loads a random theme. Auto set to 'off' on dumb terminals.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"sorin"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"pure"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.python.virtualenvAutoSwitch"></a><a class="term" href="options.html#opt-programs.zsh.prezto.python.virtualenvAutoSwitch"><code class="option">programs.zsh.prezto.python.virtualenvAutoSwitch</code></a></span></dt><dd><p>Auto switch to Python virtualenv on directory change.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.python.virtualenvInitialize"></a><a class="term" href="options.html#opt-programs.zsh.prezto.python.virtualenvInitialize"><code class="option">programs.zsh.prezto.python.virtualenvInitialize</code></a></span></dt><dd><p>Automatically initialize virtualenvwrapper if pre-requisites are met.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.ruby.chrubyAutoSwitch"></a><a class="term" href="options.html#opt-programs.zsh.prezto.ruby.chrubyAutoSwitch"><code class="option">programs.zsh.prezto.ruby.chrubyAutoSwitch</code></a></span></dt><dd><p>Auto switch the Ruby version on directory change.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.screen.autoStartLocal"></a><a class="term" href="options.html#opt-programs.zsh.prezto.screen.autoStartLocal"><code class="option">programs.zsh.prezto.screen.autoStartLocal</code></a></span></dt><dd><p>Auto start a session when Zsh is launched in a local terminal.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.screen.autoStartRemote"></a><a class="term" href="options.html#opt-programs.zsh.prezto.screen.autoStartRemote"><code class="option">programs.zsh.prezto.screen.autoStartRemote</code></a></span></dt><dd><p>Auto start a session when Zsh is launched in a SSH connection.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.ssh.identities"></a><a class="term" href="options.html#opt-programs.zsh.prezto.ssh.identities"><code class="option">programs.zsh.prezto.ssh.identities</code></a></span></dt><dd><p>Set the SSH identities to load into the agent.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"id_rsa" "id_rsa2" "id_github"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.syntaxHighlighting.highlighters"></a><a class="term" href="options.html#opt-programs.zsh.prezto.syntaxHighlighting.highlighters"><code class="option">programs.zsh.prezto.syntaxHighlighting.highlighters</code></a></span></dt><dd><p>Set syntax highlighters. By default, only the main
|
||
highlighter is enabled.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"main" "brackets" "pattern" "line" "cursor" "root"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.syntaxHighlighting.pattern"></a><a class="term" href="options.html#opt-programs.zsh.prezto.syntaxHighlighting.pattern"><code class="option">programs.zsh.prezto.syntaxHighlighting.pattern</code></a></span></dt><dd><p>Set syntax pattern styles.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
rm*-rf* = "fg=white,bold,bg=red";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.syntaxHighlighting.styles"></a><a class="term" href="options.html#opt-programs.zsh.prezto.syntaxHighlighting.styles"><code class="option">programs.zsh.prezto.syntaxHighlighting.styles</code></a></span></dt><dd><p>Set syntax highlighting styles.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
builtin = "bg=blue"; command = "bg=blue"; function = "bg=blue";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.terminal.autoTitle"></a><a class="term" href="options.html#opt-programs.zsh.prezto.terminal.autoTitle"><code class="option">programs.zsh.prezto.terminal.autoTitle</code></a></span></dt><dd><p>Auto set the tab and window titles.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.terminal.multiplexerTitleFormat"></a><a class="term" href="options.html#opt-programs.zsh.prezto.terminal.multiplexerTitleFormat"><code class="option">programs.zsh.prezto.terminal.multiplexerTitleFormat</code></a></span></dt><dd><p>Set the multiplexer title format.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"%s"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.terminal.tabTitleFormat"></a><a class="term" href="options.html#opt-programs.zsh.prezto.terminal.tabTitleFormat"><code class="option">programs.zsh.prezto.terminal.tabTitleFormat</code></a></span></dt><dd><p>Set the tab title format.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"%m: %s"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.terminal.windowTitleFormat"></a><a class="term" href="options.html#opt-programs.zsh.prezto.terminal.windowTitleFormat"><code class="option">programs.zsh.prezto.terminal.windowTitleFormat</code></a></span></dt><dd><p>Set the window title format.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"%n@%m: %s"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.tmux.autoStartLocal"></a><a class="term" href="options.html#opt-programs.zsh.prezto.tmux.autoStartLocal"><code class="option">programs.zsh.prezto.tmux.autoStartLocal</code></a></span></dt><dd><p>Auto start a session when Zsh is launched in a local terminal.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.tmux.autoStartRemote"></a><a class="term" href="options.html#opt-programs.zsh.prezto.tmux.autoStartRemote"><code class="option">programs.zsh.prezto.tmux.autoStartRemote</code></a></span></dt><dd><p>Auto start a session when Zsh is launched in a SSH connection.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.tmux.defaultSessionName"></a><a class="term" href="options.html#opt-programs.zsh.prezto.tmux.defaultSessionName"><code class="option">programs.zsh.prezto.tmux.defaultSessionName</code></a></span></dt><dd><p>Set the default session name.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"YOUR DEFAULT SESSION NAME"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.tmux.itermIntegration"></a><a class="term" href="options.html#opt-programs.zsh.prezto.tmux.itermIntegration"><code class="option">programs.zsh.prezto.tmux.itermIntegration</code></a></span></dt><dd><p>Integrate with iTerm2.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.prezto.utility.safeOps"></a><a class="term" href="options.html#opt-programs.zsh.prezto.utility.safeOps"><code class="option">programs.zsh.prezto.utility.safeOps</code></a></span></dt><dd><p>Enabled safe options. This aliases cp, ln, mv and rm so
|
||
that they prompt before deleting or overwriting files. Set to 'no' to disable
|
||
this safer behavior.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh/prezto.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh/prezto.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.profileExtra"></a><a class="term" href="options.html#opt-programs.zsh.profileExtra"><code class="option">programs.zsh.profileExtra</code></a></span></dt><dd><p>Extra commands that should be added to <code class="filename">.zprofile</code>.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.sessionVariables"></a><a class="term" href="options.html#opt-programs.zsh.sessionVariables"><code class="option">programs.zsh.sessionVariables</code></a></span></dt><dd><p>Environment variables that will be set for zsh session.</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
MAILCHECK = 30;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.shellAliases"></a><a class="term" href="options.html#opt-programs.zsh.shellAliases"><code class="option">programs.zsh.shellAliases</code></a></span></dt><dd><p>An attribute set that maps aliases (the top level attribute names in
|
||
this option) to command strings or directly to build outputs.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
ll = "ls -l";
|
||
".." = "cd ..";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.shellGlobalAliases"></a><a class="term" href="options.html#opt-programs.zsh.shellGlobalAliases"><code class="option">programs.zsh.shellGlobalAliases</code></a></span></dt><dd><p>Similar to <code class="varname"><a class="link" href="options.html#opt-programs.zsh.shellAliases">opt-programs.zsh.shellAliases</a></code>,
|
||
but are substituted anywhere on a line.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
UUID = "$(uuidgen | tr -d \\n)";
|
||
G = "| grep";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zsh.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zsh.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.zplug.enable"></a><a class="term" href="options.html#opt-programs.zsh.zplug.enable"><code class="option">programs.zsh.zplug.enable</code></a></span></dt><dd><p>Whether to enable zplug - a zsh plugin manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zplug.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zplug.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.zplug.plugins"></a><a class="term" href="options.html#opt-programs.zsh.zplug.plugins"><code class="option">programs.zsh.zplug.plugins</code></a></span></dt><dd><p>List of zplug plugins.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zplug.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zplug.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.zplug.plugins._.name"></a><a class="term" href="options.html#opt-programs.zsh.zplug.plugins._.name"><code class="option">programs.zsh.zplug.plugins.*.name</code></a></span></dt><dd><p>The name of the plugin.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zplug.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zplug.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.zplug.plugins._.tags"></a><a class="term" href="options.html#opt-programs.zsh.zplug.plugins._.tags"><code class="option">programs.zsh.zplug.plugins.*.tags</code></a></span></dt><dd><p>The plugin tags.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zplug.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zplug.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.zplug.zplugHome"></a><a class="term" href="options.html#opt-programs.zsh.zplug.zplugHome"><code class="option">programs.zsh.zplug.zplugHome</code></a></span></dt><dd><p>Path to zplug home directory.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.zplug"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/zplug.nix#blob-path" target="_top">
|
||
<home-manager/modules/programs/zplug.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-qt.enable"></a><a class="term" href="options.html#opt-qt.enable"><code class="option">qt.enable</code></a></span></dt><dd><p>Whether to enable Qt 4 and 5 configuration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/qt.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/qt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-qt.platformTheme"></a><a class="term" href="options.html#opt-qt.platformTheme"><code class="option">qt.platformTheme</code></a></span></dt><dd><p>Selects the platform theme to use for Qt applications.</p><p>The options are
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">gtk</code></span></dt><dd><p>Use GTK theme with
|
||
<a class="link" href="https://github.com/qt/qtstyleplugins" target="_top">qtstyleplugins</a>
|
||
</p></dd><dt><span class="term"><code class="literal">gnome</code></span></dt><dd><p>Use GNOME theme with
|
||
<a class="link" href="https://github.com/FedoraQt/QGnomePlatform" target="_top">qgnomeplatform</a>
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "gtk", "gnome"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"gnome"</code></p><p><span class="emphasis"><em>Related packages:</em></span> </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">pkgs.qgnomeplatform</code> (qgnomeplatform-0.8.4): QPlatformTheme for a better Qt application inclusion in GNOME</p></li><li class="listitem"><p><code class="literal">pkgs.libsForQt5.qtstyleplugins</code> (qtstyleplugins-unstable-2017-03-11): Additional style plugins for Qt5, including BB10, GTK, Cleanlooks, Motif, Plastique</p></li></ul></div><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/qt.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/qt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-qt.style.package"></a><a class="term" href="options.html#opt-qt.style.package"><code class="option">qt.style.package</code></a></span></dt><dd><p>Theme package to be used in Qt5 applications.</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.adwaita-qt</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/qt.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/qt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-qt.style.name"></a><a class="term" href="options.html#opt-qt.style.name"><code class="option">qt.style.name</code></a></span></dt><dd><p>Selects the style to use for Qt5 applications.</p><p>The options are
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">adwaita</code>, </span><span class="term"><code class="literal">adwaita-dark</code></span></dt><dd><p>Use Adwaita Qt style with
|
||
<a class="link" href="https://github.com/FedoraQt/adwaita-qt" target="_top">adwaita</a>
|
||
</p></dd><dt><span class="term"><code class="literal">cleanlooks</code>, </span><span class="term"><code class="literal">gtk2</code>, </span><span class="term"><code class="literal">motif</code>, </span><span class="term"><code class="literal">plastique</code></span></dt><dd><p>Use styles from
|
||
<a class="link" href="https://github.com/qt/qtstyleplugins" target="_top">qtstyleplugins</a>
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"adwaita-dark"</code></p><p><span class="emphasis"><em>Related packages:</em></span> </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">pkgs.adwaita-qt</code> (adwaita-qt-1.4.1): A style to bend Qt applications to look like they belong into GNOME Shell</p></li><li class="listitem"><p><code class="literal">pkgs.libsForQt5.qtstyleplugins</code> (qtstyleplugins-unstable-2017-03-11): Additional style plugins for Qt5, including BB10, GTK, Cleanlooks, Motif, Plastique</p></li></ul></div><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/qt.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/qt.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.barrier.client.enable"></a><a class="term" href="options.html#opt-services.barrier.client.enable"><code class="option">services.barrier.client.enable</code></a></span></dt><dd><p>Whether to enable Barrier Client daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/barrier.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/barrier.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.barrier.client.enableCrypto"></a><a class="term" href="options.html#opt-services.barrier.client.enableCrypto"><code class="option">services.barrier.client.enableCrypto</code></a></span></dt><dd><p>Whether to enable crypto (SSL) plugin.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/barrier.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/barrier.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.barrier.client.enableDragDrop"></a><a class="term" href="options.html#opt-services.barrier.client.enableDragDrop"><code class="option">services.barrier.client.enableDragDrop</code></a></span></dt><dd><p>Whether to enable file drag & drop.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/barrier.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/barrier.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.barrier.client.extraFlags"></a><a class="term" href="options.html#opt-services.barrier.client.extraFlags"><code class="option">services.barrier.client.extraFlags</code></a></span></dt><dd><p>Additional flags to pass to <span class="command"><strong>barrierc</strong></span>.
|
||
See <span class="command"><strong>barrierc --help</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ "-f" ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/barrier.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/barrier.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.barrier.client.name"></a><a class="term" href="options.html#opt-services.barrier.client.name"><code class="option">services.barrier.client.name</code></a></span></dt><dd><p>Screen name of client. Defaults to hostname.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/barrier.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/barrier.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.barrier.client.server"></a><a class="term" href="options.html#opt-services.barrier.client.server"><code class="option">services.barrier.client.server</code></a></span></dt><dd><p>Server to connect to formatted as
|
||
<code class="literal"><host>[:<port>]</code>.
|
||
Port defaults to <code class="literal">24800</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/barrier.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/barrier.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.betterlockscreen.enable"></a><a class="term" href="options.html#opt-services.betterlockscreen.enable"><code class="option">services.betterlockscreen.enable</code></a></span></dt><dd><p>Whether to enable betterlockscreen, a screen-locker module.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/betterlockscreen.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/betterlockscreen.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.betterlockscreen.package"></a><a class="term" href="options.html#opt-services.betterlockscreen.package"><code class="option">services.betterlockscreen.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>betterlockscreen</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.betterlockscreen</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/betterlockscreen.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/betterlockscreen.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.betterlockscreen.arguments"></a><a class="term" href="options.html#opt-services.betterlockscreen.arguments"><code class="option">services.betterlockscreen.arguments</code></a></span></dt><dd><p>List of arguments appended to <code class="literal">./betterlockscreen --lock [args]</code></p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/betterlockscreen.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/betterlockscreen.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.betterlockscreen.inactiveInterval"></a><a class="term" href="options.html#opt-services.betterlockscreen.inactiveInterval"><code class="option">services.betterlockscreen.inactiveInterval</code></a></span></dt><dd><p>Value used for <code class="option">services.screen-locker.inactiveInterval</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/betterlockscreen.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/betterlockscreen.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.blueman-applet.enable"></a><a class="term" href="options.html#opt-services.blueman-applet.enable"><code class="option">services.blueman-applet.enable</code></a></span></dt><dd><p>Whether to enable the Blueman applet.
|
||
</p><p>
|
||
Note, for the applet to work, the 'blueman' service should
|
||
be enabled system-wide. You can enable it in the system
|
||
configuration using
|
||
</p><pre class="programlisting nix">
|
||
services.blueman.enable = true;
|
||
</pre><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/blueman-applet.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/blueman-applet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.caffeine.enable"></a><a class="term" href="options.html#opt-services.caffeine.enable"><code class="option">services.caffeine.enable</code></a></span></dt><dd><p>Whether to enable Caffeine service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/caffeine.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/caffeine.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.enable"></a><a class="term" href="options.html#opt-services.cbatticon.enable"><code class="option">services.cbatticon.enable</code></a></span></dt><dd><p>Whether to enable cbatticon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.commandCriticalLevel"></a><a class="term" href="options.html#opt-services.cbatticon.commandCriticalLevel"><code class="option">services.cbatticon.commandCriticalLevel</code></a></span></dt><dd><p>Command to execute when the critical battery level is reached.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
notify-send "battery critical!"
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.commandLeftClick"></a><a class="term" href="options.html#opt-services.cbatticon.commandLeftClick"><code class="option">services.cbatticon.commandLeftClick</code></a></span></dt><dd><p>Command to execute when left clicking on the tray icon.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.criticalLevelPercent"></a><a class="term" href="options.html#opt-services.cbatticon.criticalLevelPercent"><code class="option">services.cbatticon.criticalLevelPercent</code></a></span></dt><dd><p>Critical level percentage of the battery in percent (without
|
||
the percent symbol).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or integer between 0 and 100 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.hideNotification"></a><a class="term" href="options.html#opt-services.cbatticon.hideNotification"><code class="option">services.cbatticon.hideNotification</code></a></span></dt><dd><p>Hide the notification popups.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.iconType"></a><a class="term" href="options.html#opt-services.cbatticon.iconType"><code class="option">services.cbatticon.iconType</code></a></span></dt><dd><p>Icon type to display in the system tray.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "standard", "notification", "symbolic"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"symbolic"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.lowLevelPercent"></a><a class="term" href="options.html#opt-services.cbatticon.lowLevelPercent"><code class="option">services.cbatticon.lowLevelPercent</code></a></span></dt><dd><p>Low level percentage of the battery in percent (without the
|
||
percent symbol).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or integer between 0 and 100 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">20</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.updateIntervalSeconds"></a><a class="term" href="options.html#opt-services.cbatticon.updateIntervalSeconds"><code class="option">services.cbatticon.updateIntervalSeconds</code></a></span></dt><dd><p>Number of seconds between updates of the battery information.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/cbatticon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/cbatticon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.clipmenu.enable"></a><a class="term" href="options.html#opt-services.clipmenu.enable"><code class="option">services.clipmenu.enable</code></a></span></dt><dd><p>Whether to enable clipmenu, the clipboard management daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/clipmenu.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/clipmenu.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.clipmenu.package"></a><a class="term" href="options.html#opt-services.clipmenu.package"><code class="option">services.clipmenu.package</code></a></span></dt><dd><p>clipmenu derivation to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.clipmenu"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/clipmenu.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/clipmenu.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.devilspie2.enable"></a><a class="term" href="options.html#opt-services.devilspie2.enable"><code class="option">services.devilspie2.enable</code></a></span></dt><dd><p>Whether to enable Devilspie2, a window matching utility, allowing the user to
|
||
perform scripted actions on windows as they are created.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/devilspie2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/devilspie2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.devilspie2.config"></a><a class="term" href="options.html#opt-services.devilspie2.config"><code class="option">services.devilspie2.config</code></a></span></dt><dd><p>Content of file placed in the devilspie2 config directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
if (get_window_class() == "Gnome-terminal") then
|
||
make_always_on_top();
|
||
end
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/devilspie2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/devilspie2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dropbox.enable"></a><a class="term" href="options.html#opt-services.dropbox.enable"><code class="option">services.dropbox.enable</code></a></span></dt><dd><p>Whether to enable Dropbox daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dropbox.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dropbox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dropbox.path"></a><a class="term" href="options.html#opt-services.dropbox.path"><code class="option">services.dropbox.path</code></a></span></dt><dd><p>Where to put the Dropbox directory.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"${config.home.homeDirectory}/Dropbox"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dropbox.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dropbox.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.enable"></a><a class="term" href="options.html#opt-services.dunst.enable"><code class="option">services.dunst.enable</code></a></span></dt><dd><p>Whether to enable the dunst notification daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.package"></a><a class="term" href="options.html#opt-services.dunst.package"><code class="option">services.dunst.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>dunst</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.dunst</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.configFile"></a><a class="term" href="options.html#opt-services.dunst.configFile"><code class="option">services.dunst.configFile</code></a></span></dt><dd><p>Path to the configuration file read by dunst.
|
||
</p><p>
|
||
Note that the configuration generated by Home Manager will be
|
||
written to <code class="filename">$XDG_CONFIG_HOME/dunst/dunstrc</code>
|
||
regardless. This allows using a mutable configuration file generated
|
||
from the immutable one, useful in scenarios where live reloading is
|
||
desired.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_CONFIG_HOME/dunst/dunstrc"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.iconTheme"></a><a class="term" href="options.html#opt-services.dunst.iconTheme"><code class="option">services.dunst.iconTheme</code></a></span></dt><dd><p>Set the icon theme.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
name = "hicolor"; package = <em class="replaceable"><code>(build of hicolor-icon-theme-0.17)</code></em>; size = "32x32";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.iconTheme.package"></a><a class="term" href="options.html#opt-services.dunst.iconTheme.package"><code class="option">services.dunst.iconTheme.package</code></a></span></dt><dd><p>Package providing the theme.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.gnome.adwaita-icon-theme</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.iconTheme.name"></a><a class="term" href="options.html#opt-services.dunst.iconTheme.name"><code class="option">services.dunst.iconTheme.name</code></a></span></dt><dd><p>The name of the theme within the package.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Adwaita"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.iconTheme.size"></a><a class="term" href="options.html#opt-services.dunst.iconTheme.size"><code class="option">services.dunst.iconTheme.size</code></a></span></dt><dd><p>The desired icon size.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"32x32"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"16x16"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.settings"></a><a class="term" href="options.html#opt-services.dunst.settings"><code class="option">services.dunst.settings</code></a></span></dt><dd><p>Configuration written to <code class="filename">$XDG_CONFIG_HOME/dunst/dunstrc</code>.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string or boolean or signed integer or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
global = {
|
||
geometry = "300x5-30+50";
|
||
transparency = 10;
|
||
frame_color = "#eceff1";
|
||
font = "Droid Sans 9";
|
||
};
|
||
|
||
urgency_normal = {
|
||
background = "#37474f";
|
||
foreground = "#eceff1";
|
||
timeout = 10;
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.settings.global.icon_path"></a><a class="term" href="options.html#opt-services.dunst.settings.global.icon_path"><code class="option">services.dunst.settings.global.icon_path</code></a></span></dt><dd><p>Paths where dunst will look for icons.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with ":"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dunst.waylandDisplay"></a><a class="term" href="options.html#opt-services.dunst.waylandDisplay"><code class="option">services.dunst.waylandDisplay</code></a></span></dt><dd><p>Set the service's <code class="envar">WAYLAND_DISPLAY</code> environment variable.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dunst.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dunst.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dwm-status.enable"></a><a class="term" href="options.html#opt-services.dwm-status.enable"><code class="option">services.dwm-status.enable</code></a></span></dt><dd><p>Whether to enable dwm-status user service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dwm-status.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dwm-status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dwm-status.package"></a><a class="term" href="options.html#opt-services.dwm-status.package"><code class="option">services.dwm-status.package</code></a></span></dt><dd><p>Which dwm-status package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.dwm-status</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"pkgs.dwm-status.override { enableAlsaUtils = false; }"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dwm-status.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dwm-status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dwm-status.extraConfig"></a><a class="term" href="options.html#opt-services.dwm-status.extraConfig"><code class="option">services.dwm-status.extraConfig</code></a></span></dt><dd><p>Extra config of dwm-status.</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
separator = "#";
|
||
|
||
battery = {
|
||
notifier_levels = [ 2 5 10 15 20 ];
|
||
};
|
||
|
||
time = {
|
||
format = "%H:%M";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dwm-status.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dwm-status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.dwm-status.order"></a><a class="term" href="options.html#opt-services.dwm-status.order"><code class="option">services.dwm-status.order</code></a></span></dt><dd><p>List of enabled features in order.</p><p><span class="emphasis"><em>Type:</em></span> list of one of "audio", "backlight", "battery", "cpu_load", "network", "time"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/dwm-status.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/dwm-status.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.easyeffects.enable"></a><a class="term" href="options.html#opt-services.easyeffects.enable"><code class="option">services.easyeffects.enable</code></a></span></dt><dd><p>Whether to enable Easyeffects daemon.
|
||
Note, it is necessary to add
|
||
</p><pre class="programlisting nix">
|
||
programs.dconf.enable = true;
|
||
</pre><p>
|
||
to your system configuration for the daemon to work correctly.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/easyeffects.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/easyeffects.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.easyeffects.preset"></a><a class="term" href="options.html#opt-services.easyeffects.preset"><code class="option">services.easyeffects.preset</code></a></span></dt><dd><p>Which preset to use when starting easyeffects.
|
||
Will likely need to launch easyeffects to initially create preset.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/easyeffects.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/easyeffects.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.enable"></a><a class="term" href="options.html#opt-services.emacs.enable"><code class="option">services.emacs.enable</code></a></span></dt><dd><p>Whether to enable the Emacs daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.package"></a><a class="term" href="options.html#opt-services.emacs.package"><code class="option">services.emacs.package</code></a></span></dt><dd><p>The Emacs package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">if config.programs.emacs.enable then config.programs.emacs.finalPackage
|
||
else pkgs.emacs
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.client.enable"></a><a class="term" href="options.html#opt-services.emacs.client.enable"><code class="option">services.emacs.client.enable</code></a></span></dt><dd><p>Whether to enable generation of Emacs client desktop file.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.client.arguments"></a><a class="term" href="options.html#opt-services.emacs.client.arguments"><code class="option">services.emacs.client.arguments</code></a></span></dt><dd><p>Command-line arguments to pass to <span class="command"><strong>emacsclient</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"-c"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.defaultEditor"></a><a class="term" href="options.html#opt-services.emacs.defaultEditor"><code class="option">services.emacs.defaultEditor</code></a></span></dt><dd><p>Whether to configure <span class="command"><strong>emacsclient</strong></span> as the default
|
||
editor using the <code class="envar">EDITOR</code> environment variable.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.extraOptions"></a><a class="term" href="options.html#opt-services.emacs.extraOptions"><code class="option">services.emacs.extraOptions</code></a></span></dt><dd><p>Extra command-line arguments to pass to <span class="command"><strong>emacs</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"-f" "exwm-enable"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.emacs.socketActivation.enable"></a><a class="term" href="options.html#opt-services.emacs.socketActivation.enable"><code class="option">services.emacs.socketActivation.enable</code></a></span></dt><dd><p>Whether to enable systemd socket activation for the Emacs service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/emacs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/emacs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.espanso.enable"></a><a class="term" href="options.html#opt-services.espanso.enable"><code class="option">services.espanso.enable</code></a></span></dt><dd><p>Whether to enable Espanso: cross platform text expander in Rust.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/espanso.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/espanso.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.espanso.package"></a><a class="term" href="options.html#opt-services.espanso.package"><code class="option">services.espanso.package</code></a></span></dt><dd><p>Which espanso package to use</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.espanso</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/espanso.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/espanso.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.espanso.settings"></a><a class="term" href="options.html#opt-services.espanso.settings"><code class="option">services.espanso.settings</code></a></span></dt><dd><p>The Espanso configuration to use. See
|
||
<a class="link" href="https://espanso.org/docs/configuration/" target="_top">https://espanso.org/docs/configuration/</a>
|
||
for a description of available options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
matches =
|
||
[
|
||
|
||
]
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
matches = [
|
||
{ # Simple text replacement
|
||
trigger = ":espanso";
|
||
replace = "Hi there!";
|
||
}
|
||
{ # Dates
|
||
trigger = ":date";
|
||
replace = "{{mydate}}";
|
||
vars = [{
|
||
name = "mydate";
|
||
type = "date";
|
||
params = { format = "%m/%d/%Y"; };
|
||
}];
|
||
}
|
||
{ # Shell commands
|
||
trigger = ":shell";
|
||
replace = "{{output}}";
|
||
vars = [{
|
||
name = "output";
|
||
type = "shell";
|
||
params = { cmd = "echo Hello from your shell"; };
|
||
}];
|
||
}
|
||
];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/espanso.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/espanso.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.etesync-dav.enable"></a><a class="term" href="options.html#opt-services.etesync-dav.enable"><code class="option">services.etesync-dav.enable</code></a></span></dt><dd><p>Whether to enable etesync-dav.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/etesync-dav.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/etesync-dav.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.etesync-dav.package"></a><a class="term" href="options.html#opt-services.etesync-dav.package"><code class="option">services.etesync-dav.package</code></a></span></dt><dd><p>The etesync-dav derivation to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.etesync-dav"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/etesync-dav.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/etesync-dav.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.etesync-dav.serverUrl"></a><a class="term" href="options.html#opt-services.etesync-dav.serverUrl"><code class="option">services.etesync-dav.serverUrl</code></a></span></dt><dd><p>The URL to the etesync server.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"https://api.etesync.com/"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/etesync-dav.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/etesync-dav.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.etesync-dav.settings"></a><a class="term" href="options.html#opt-services.etesync-dav.settings"><code class="option">services.etesync-dav.settings</code></a></span></dt><dd><p>Settings for etesync-dav, passed as environment variables.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
ETESYNC_LISTEN_ADDRESS = "localhost";
|
||
ETESYNC_LISTEN_PORT = 37358;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/etesync-dav.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/etesync-dav.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.flameshot.enable"></a><a class="term" href="options.html#opt-services.flameshot.enable"><code class="option">services.flameshot.enable</code></a></span></dt><dd><p>Whether to enable Flameshot.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/flameshot.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/flameshot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.flameshot.package"></a><a class="term" href="options.html#opt-services.flameshot.package"><code class="option">services.flameshot.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>flameshot</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.flameshot</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/flameshot.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/flameshot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.flameshot.settings"></a><a class="term" href="options.html#opt-services.flameshot.settings"><code class="option">services.flameshot.settings</code></a></span></dt><dd><p>Configuration to use for Flameshot. See
|
||
<a class="link" href="https://github.com/flameshot-org/flameshot/blob/master/flameshot.example.ini" target="_top">https://github.com/flameshot-org/flameshot/blob/master/flameshot.example.ini</a>
|
||
for available options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
General =
|
||
{
|
||
disabledTrayIcon = true; showStartupLaunchMessage = false;
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/flameshot.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/flameshot.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fluidsynth.enable"></a><a class="term" href="options.html#opt-services.fluidsynth.enable"><code class="option">services.fluidsynth.enable</code></a></span></dt><dd><p>Whether to enable fluidsynth midi synthesizer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fluidsynth.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fluidsynth.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fluidsynth.extraOptions"></a><a class="term" href="options.html#opt-services.fluidsynth.extraOptions"><code class="option">services.fluidsynth.extraOptions</code></a></span></dt><dd><p>Extra arguments, added verbatim to the fluidsynth command. See
|
||
<span class="citerefentry"><span class="refentrytitle">fluidsynth.conf</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--sample-rate 96000"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fluidsynth.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fluidsynth.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fluidsynth.soundFont"></a><a class="term" href="options.html#opt-services.fluidsynth.soundFont"><code class="option">services.fluidsynth.soundFont</code></a></span></dt><dd><p>The soundfont file to use, in SoundFont 2 format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.soundfont-fluid}/share/soundfonts/FluidR3_GM2-2.sf2"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fluidsynth.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fluidsynth.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fluidsynth.soundService"></a><a class="term" href="options.html#opt-services.fluidsynth.soundService"><code class="option">services.fluidsynth.soundService</code></a></span></dt><dd><p>The systemd sound service to depend on.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "jack", "pipewire-pulse", "pulseaudio"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pulseaudio"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"pipewire-pulse"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fluidsynth.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fluidsynth.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fnott.enable"></a><a class="term" href="options.html#opt-services.fnott.enable"><code class="option">services.fnott.enable</code></a></span></dt><dd><p>Whether to enable fnott, a lightweight Wayland notification daemon for wlroots-based compositors
|
||
.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fnott.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fnott.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fnott.package"></a><a class="term" href="options.html#opt-services.fnott.package"><code class="option">services.fnott.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>fnott</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.fnott</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fnott.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fnott.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fnott.configFile"></a><a class="term" href="options.html#opt-services.fnott.configFile"><code class="option">services.fnott.configFile</code></a></span></dt><dd><p>Path to the configuration file read by fnott.
|
||
</p><p>
|
||
Note that environment variables in the path won't be properly expanded.
|
||
</p><p>
|
||
The configuration specified under
|
||
<code class="option">services.fnott.settings</code> will be generated and
|
||
written to <code class="filename">$XDG_CONFIG_HOME/fnott/fnott.ini</code>
|
||
regardless of this option. This allows using a mutable configuration file
|
||
generated from the immutable one, useful in scenarios where live reloading is desired.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_CONFIG_HOME/fnott/fnott.ini"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fnott.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fnott.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fnott.extraFlags"></a><a class="term" href="options.html#opt-services.fnott.extraFlags"><code class="option">services.fnott.extraFlags</code></a></span></dt><dd><p>Extra arguments to use for executing fnott.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"-s"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fnott.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fnott.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fnott.settings"></a><a class="term" href="options.html#opt-services.fnott.settings"><code class="option">services.fnott.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/fnott/fnott.ini</code>.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">fnott.ini</span>(5)</span> for a list of avaliable options and <a class="link" href="https://codeberg.org/dnkl/fnott/src/branch/master/fnott.ini" target="_top">https://codeberg.org/dnkl/fnott/src/branch/master/fnott.ini</a>
|
||
for an example configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
main = {
|
||
notification-margin = 5;
|
||
};
|
||
|
||
low = {
|
||
timeout = 5;
|
||
title-font = "Dina:weight=bold:slant=italic";
|
||
title-color = "ffffff";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fnott.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fnott.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fusuma.enable"></a><a class="term" href="options.html#opt-services.fusuma.enable"><code class="option">services.fusuma.enable</code></a></span></dt><dd><p>Whether to enable the fusuma systemd service to automatically enable touchpad gesture.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fusuma.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fusuma.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fusuma.package"></a><a class="term" href="options.html#opt-services.fusuma.package"><code class="option">services.fusuma.package</code></a></span></dt><dd><p>Package providing <span class="command"><strong>fusuma</strong></span>.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.fusuma</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fusuma.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fusuma.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fusuma.extraPackages"></a><a class="term" href="options.html#opt-services.fusuma.extraPackages"><code class="option">services.fusuma.extraPackages</code></a></span></dt><dd><p>Extra packages needs to bring to the scope of fusuma service.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.coreutils</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">with pkgs; [ coreutils xdotool ];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fusuma.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fusuma.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.fusuma.settings"></a><a class="term" href="options.html#opt-services.fusuma.settings"><code class="option">services.fusuma.settings</code></a></span></dt><dd><p>YAML config that will override the default fusuma configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
enable = true;
|
||
extraPackages = with pkgs;[ xdotool ];
|
||
config = {
|
||
threshold = {
|
||
swipe = 0.1;
|
||
};
|
||
interval = {
|
||
swipe = 0.7;
|
||
};
|
||
swipe = {
|
||
"3" = {
|
||
left = {
|
||
# GNOME: Switch to left workspace
|
||
command = "xdotool key ctrl+alt+Right";
|
||
};
|
||
};
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/fusuma.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/fusuma.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.enable"></a><a class="term" href="options.html#opt-services.gammastep.enable"><code class="option">services.gammastep.enable</code></a></span></dt><dd><p>Whether to enable Gammastep.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.package"></a><a class="term" href="options.html#opt-services.gammastep.package"><code class="option">services.gammastep.package</code></a></span></dt><dd><p>Gammastep derivation to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.gammastep</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.dawnTime"></a><a class="term" href="options.html#opt-services.gammastep.dawnTime"><code class="option">services.gammastep.dawnTime</code></a></span></dt><dd><p>Set the time interval of dawn manually.
|
||
The times must be specified as HH:MM in 24-hour format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"6:00-7:45"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.duskTime"></a><a class="term" href="options.html#opt-services.gammastep.duskTime"><code class="option">services.gammastep.duskTime</code></a></span></dt><dd><p>Set the time interval of dusk manually.
|
||
The times must be specified as HH:MM in 24-hour format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"18:35-20:15"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.latitude"></a><a class="term" href="options.html#opt-services.gammastep.latitude"><code class="option">services.gammastep.latitude</code></a></span></dt><dd><p>Your current latitude, between <code class="literal">-90.0</code> and
|
||
<code class="literal">90.0</code>. Must be provided along with
|
||
longitude.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.longitude"></a><a class="term" href="options.html#opt-services.gammastep.longitude"><code class="option">services.gammastep.longitude</code></a></span></dt><dd><p>Your current longitude, between <code class="literal">-180.0</code> and
|
||
<code class="literal">180.0</code>. Must be provided along with
|
||
latitude.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.provider"></a><a class="term" href="options.html#opt-services.gammastep.provider"><code class="option">services.gammastep.provider</code></a></span></dt><dd><p>The location provider to use for determining your location. If set to
|
||
<code class="literal">manual</code> you must also provide latitude/longitude.
|
||
If set to <code class="literal">geoclue2</code>, you must also enable the global
|
||
geoclue2 service.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "manual", "geoclue2"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"manual"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.settings"></a><a class="term" href="options.html#opt-services.gammastep.settings"><code class="option">services.gammastep.settings</code></a></span></dt><dd><p>The configuration to pass to Gammastep.
|
||
Available options for Gammastep described in
|
||
<span class="citerefentry"><span class="refentrytitle">gammastep</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
general = {
|
||
adjustment-method = "randr";
|
||
};
|
||
randr = {
|
||
screen = 0;
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.temperature.day"></a><a class="term" href="options.html#opt-services.gammastep.temperature.day"><code class="option">services.gammastep.temperature.day</code></a></span></dt><dd><p>Colour temperature to use during the day, between
|
||
<code class="literal">1000</code> and <code class="literal">25000</code> K.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5500</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.temperature.night"></a><a class="term" href="options.html#opt-services.gammastep.temperature.night"><code class="option">services.gammastep.temperature.night</code></a></span></dt><dd><p>Colour temperature to use at night, between
|
||
<code class="literal">1000</code> and <code class="literal">25000</code> K.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">3700</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gammastep.tray"></a><a class="term" href="options.html#opt-services.gammastep.tray"><code class="option">services.gammastep.tray</code></a></span></dt><dd><p>Start the gammastep-indicator tray applet.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/gammastep.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/gammastep.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.getmail.enable"></a><a class="term" href="options.html#opt-services.getmail.enable"><code class="option">services.getmail.enable</code></a></span></dt><dd><p>Whether to enable the getmail systemd service to automatically retrieve mail.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.getmail.frequency"></a><a class="term" href="options.html#opt-services.getmail.frequency"><code class="option">services.getmail.frequency</code></a></span></dt><dd><p>The refresh frequency. Check <code class="literal">man systemd.time</code> for
|
||
more information on the syntax. If you use a gpg-agent in
|
||
combination with the passwordCommand, keep the poll
|
||
frequency below the cache-ttl value (as set by the
|
||
<code class="literal">default</code>) to avoid pinentry asking
|
||
permanently for a password.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"*:0/5"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"hourly"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/getmail.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/getmail.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.git-sync.enable"></a><a class="term" href="options.html#opt-services.git-sync.enable"><code class="option">services.git-sync.enable</code></a></span></dt><dd><p>Whether to enable git-sync services.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/git-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/git-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.git-sync.package"></a><a class="term" href="options.html#opt-services.git-sync.package"><code class="option">services.git-sync.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>git-sync</strong></span> program.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.git-sync</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/git-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/git-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.git-sync.repositories"></a><a class="term" href="options.html#opt-services.git-sync.repositories"><code class="option">services.git-sync.repositories</code></a></span></dt><dd><p>The repositories that should be synchronized.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/git-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/git-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.git-sync.repositories._name_.interval"></a><a class="term" href="options.html#opt-services.git-sync.repositories._name_.interval"><code class="option">services.git-sync.repositories.<name>.interval</code></a></span></dt><dd><p>The interval, specified in seconds, at which the synchronization will
|
||
be triggered even without filesystem changes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">500</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/git-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/git-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.git-sync.repositories._name_.path"></a><a class="term" href="options.html#opt-services.git-sync.repositories._name_.path"><code class="option">services.git-sync.repositories.<name>.path</code></a></span></dt><dd><p>The path at which to sync the repository</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/git-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/git-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.git-sync.repositories._name_.uri"></a><a class="term" href="options.html#opt-services.git-sync.repositories._name_.uri"><code class="option">services.git-sync.repositories.<name>.uri</code></a></span></dt><dd><p>The URI of the remote to be synchronized. This is only used in the
|
||
event that the directory does not already exist. See
|
||
<a class="link" href="https://git-scm.com/docs/git-clone#_git_urls" target="_top">https://git-scm.com/docs/git-clone#_git_urls</a>
|
||
for the supported URIs.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"git+ssh://user@example.com:/~[user]/path/to/repo.git"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/git-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/git-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gnome-keyring.enable"></a><a class="term" href="options.html#opt-services.gnome-keyring.enable"><code class="option">services.gnome-keyring.enable</code></a></span></dt><dd><p>Whether to enable GNOME Keyring.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gnome-keyring.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gnome-keyring.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gnome-keyring.components"></a><a class="term" href="options.html#opt-services.gnome-keyring.components"><code class="option">services.gnome-keyring.components</code></a></span></dt><dd><p>The GNOME keyring components to start. If empty then the
|
||
default set of components will be started.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of one of "pkcs11", "secrets", "ssh"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gnome-keyring.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gnome-keyring.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enable"></a><a class="term" href="options.html#opt-services.gpg-agent.enable"><code class="option">services.gpg-agent.enable</code></a></span></dt><dd><p>Whether to enable GnuPG private key agent.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enableBashIntegration"></a><a class="term" href="options.html#opt-services.gpg-agent.enableBashIntegration"><code class="option">services.gpg-agent.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enableExtraSocket"></a><a class="term" href="options.html#opt-services.gpg-agent.enableExtraSocket"><code class="option">services.gpg-agent.enableExtraSocket</code></a></span></dt><dd><p>Whether to enable extra socket of the GnuPG key agent (useful for GPG
|
||
Agent forwarding).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enableFishIntegration"></a><a class="term" href="options.html#opt-services.gpg-agent.enableFishIntegration"><code class="option">services.gpg-agent.enableFishIntegration</code></a></span></dt><dd><p>Whether to enable Fish integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enableScDaemon"></a><a class="term" href="options.html#opt-services.gpg-agent.enableScDaemon"><code class="option">services.gpg-agent.enableScDaemon</code></a></span></dt><dd><p>Make use of the scdaemon tool. This option has the effect of
|
||
enabling the ability to do smartcard operations. When
|
||
disabled, this option passes
|
||
<code class="option">disable-scdaemon</code> setting to gpg-agent.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enableSshSupport"></a><a class="term" href="options.html#opt-services.gpg-agent.enableSshSupport"><code class="option">services.gpg-agent.enableSshSupport</code></a></span></dt><dd><p>Whether to use the GnuPG key agent for SSH keys.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.enableZshIntegration"></a><a class="term" href="options.html#opt-services.gpg-agent.enableZshIntegration"><code class="option">services.gpg-agent.enableZshIntegration</code></a></span></dt><dd><p>Whether to enable Zsh integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.defaultCacheTtl"></a><a class="term" href="options.html#opt-services.gpg-agent.defaultCacheTtl"><code class="option">services.gpg-agent.defaultCacheTtl</code></a></span></dt><dd><p>Set the time a cache entry is valid to the given number of
|
||
seconds.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.defaultCacheTtlSsh"></a><a class="term" href="options.html#opt-services.gpg-agent.defaultCacheTtlSsh"><code class="option">services.gpg-agent.defaultCacheTtlSsh</code></a></span></dt><dd><p>Set the time a cache entry used for SSH keys is valid to the
|
||
given number of seconds.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.extraConfig"></a><a class="term" href="options.html#opt-services.gpg-agent.extraConfig"><code class="option">services.gpg-agent.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to append to the gpg-agent
|
||
configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
allow-emacs-pinentry
|
||
allow-loopback-pinentry
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.grabKeyboardAndMouse"></a><a class="term" href="options.html#opt-services.gpg-agent.grabKeyboardAndMouse"><code class="option">services.gpg-agent.grabKeyboardAndMouse</code></a></span></dt><dd><p>Tell the pinentry to grab the keyboard and mouse. This
|
||
option should in general be used to avoid X-sniffing
|
||
attacks. When disabled, this option passes
|
||
<code class="option">no-grab</code> setting to gpg-agent.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.maxCacheTtl"></a><a class="term" href="options.html#opt-services.gpg-agent.maxCacheTtl"><code class="option">services.gpg-agent.maxCacheTtl</code></a></span></dt><dd><p>Set the maximum time a cache entry is valid to n seconds. After this
|
||
time a cache entry will be expired even if it has been accessed
|
||
recently or has been set using gpg-preset-passphrase. The default is
|
||
2 hours (7200 seconds).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.maxCacheTtlSsh"></a><a class="term" href="options.html#opt-services.gpg-agent.maxCacheTtlSsh"><code class="option">services.gpg-agent.maxCacheTtlSsh</code></a></span></dt><dd><p>Set the maximum time a cache entry used for SSH keys is valid to n
|
||
seconds. After this time a cache entry will be expired even if it has
|
||
been accessed recently or has been set using gpg-preset-passphrase.
|
||
The default is 2 hours (7200 seconds).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.pinentryFlavor"></a><a class="term" href="options.html#opt-services.gpg-agent.pinentryFlavor"><code class="option">services.gpg-agent.pinentryFlavor</code></a></span></dt><dd><p>Which pinentry interface to use. If not
|
||
<code class="literal">null</code>, it sets
|
||
<code class="option">pinentry-program</code> in
|
||
<code class="filename">gpg-agent.conf</code>. Beware that
|
||
<code class="literal">pinentry-gnome3</code> may not work on non-Gnome
|
||
systems. You can fix it by adding the following to your
|
||
system configuration:
|
||
</p><pre class="programlisting nix">
|
||
services.dbus.packages = [ pkgs.gcr ];
|
||
</pre><p>
|
||
For this reason, the default is <code class="literal">gtk2</code> for
|
||
now.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "curses", "tty", "gtk2", "emacs", "gnome3", "qt"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"gtk2"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"gnome3"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.sshKeys"></a><a class="term" href="options.html#opt-services.gpg-agent.sshKeys"><code class="option">services.gpg-agent.sshKeys</code></a></span></dt><dd><p>Which GPG keys (by keygrip) to expose as SSH keys.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gpg-agent.verbose"></a><a class="term" href="options.html#opt-services.gpg-agent.verbose"><code class="option">services.gpg-agent.verbose</code></a></span></dt><dd><p>Whether to produce verbose output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gpg-agent.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gpg-agent.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.grobi.enable"></a><a class="term" href="options.html#opt-services.grobi.enable"><code class="option">services.grobi.enable</code></a></span></dt><dd><p>Whether to enable the grobi display setup daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/grobi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/grobi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.grobi.executeAfter"></a><a class="term" href="options.html#opt-services.grobi.executeAfter"><code class="option">services.grobi.executeAfter</code></a></span></dt><dd><p>Commands to be run after an output configuration was
|
||
changed. The Nix value declared here will be translated to
|
||
JSON and written to the <code class="option">execute_after</code> key
|
||
in <code class="filename">$XDG_CONFIG_HOME/grobi.conf</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"setxkbmap dvorak"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/grobi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/grobi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.grobi.rules"></a><a class="term" href="options.html#opt-services.grobi.rules"><code class="option">services.grobi.rules</code></a></span></dt><dd><p>These are the rules grobi tries to match to the current
|
||
output configuration. The rules are evaluated top to bottom,
|
||
the first matching rule is applied and processing stops. See
|
||
<a class="link" href="https://github.com/fd0/grobi/blob/master/doc/grobi.conf" target="_top">https://github.com/fd0/grobi/blob/master/doc/grobi.conf</a>
|
||
for more information. The Nix value declared here will be
|
||
translated to JSON and written to the <code class="option">rules</code>
|
||
key in <code class="filename">$XDG_CONFIG_HOME/grobi.conf</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of attribute set of string or boolean or signed integer or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
name = "Home";
|
||
outputs_connected = [ "DP-2" ];
|
||
configure_single = "DP-2";
|
||
primary = true;
|
||
atomic = true;
|
||
execute_after = [
|
||
"${pkgs.xorg.xrandr}/bin/xrandr --dpi 96"
|
||
"${pkgs.xmonad-with-packages}/bin/xmonad --restart";
|
||
];
|
||
}
|
||
{
|
||
name = "Mobile";
|
||
outputs_disconnected = [ "DP-2" ];
|
||
configure_single = "eDP-1";
|
||
primary = true;
|
||
atomic = true;
|
||
execute_after = [
|
||
"${pkgs.xorg.xrandr}/bin/xrandr --dpi 120"
|
||
"${pkgs.xmonad-with-packages}/bin/xmonad --restart";
|
||
];
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/grobi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/grobi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.enable"></a><a class="term" href="options.html#opt-services.gromit-mpx.enable"><code class="option">services.gromit-mpx.enable</code></a></span></dt><dd><p>Whether to enable Gromit-MPX annotation tool.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.package"></a><a class="term" href="options.html#opt-services.gromit-mpx.package"><code class="option">services.gromit-mpx.package</code></a></span></dt><dd><p>The gromit-mpx package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.gromit-mpx"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.hotKey"></a><a class="term" href="options.html#opt-services.gromit-mpx.hotKey"><code class="option">services.gromit-mpx.hotKey</code></a></span></dt><dd><p>A keysym or raw keycode that toggles the activation state of
|
||
gromit-mpx. Set to <code class="literal">null</code> to disable the
|
||
hotkey in which case you'll have to activate gromit-mpx
|
||
manually using the command line.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"F9"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Insert"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.opacity"></a><a class="term" href="options.html#opt-services.gromit-mpx.opacity"><code class="option">services.gromit-mpx.opacity</code></a></span></dt><dd><p>Opacity of the drawing overlay.</p><p><span class="emphasis"><em>Type:</em></span> float between 0.0 and 1.0 (inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"></code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal"></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools"><code class="option">services.gromit-mpx.tools</code></a></span></dt><dd><p>Tool definitions for gromit-mpx to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
color = "red"; device = "default"; size = 5; type = "pen";
|
||
}
|
||
|
||
{
|
||
color = "blue"; device = "default"; modifiers =
|
||
[
|
||
"SHIFT"
|
||
]
|
||
; size = 5; type = "pen";
|
||
}
|
||
|
||
{
|
||
color = "yellow"; device = "default"; modifiers =
|
||
[
|
||
"CONTROL"
|
||
]
|
||
; size = 5; type = "pen";
|
||
}
|
||
|
||
{
|
||
arrowSize = 1; color = "green"; device = "default"; modifiers =
|
||
[
|
||
"2"
|
||
]
|
||
; size = 6; type = "pen";
|
||
}
|
||
|
||
{
|
||
device = "default"; modifiers =
|
||
[
|
||
"3"
|
||
]
|
||
; size = 75; type = "eraser";
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.arrowSize"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.arrowSize"><code class="option">services.gromit-mpx.tools.*.arrowSize</code></a></span></dt><dd><p>If not <code class="literal">null</code>, automatically draw an arrow
|
||
at the end of a stroke with the given size.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.color"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.color"><code class="option">services.gromit-mpx.tools.*.color</code></a></span></dt><dd><p>The stroke (or recolor) color of the tool.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"red"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ff00ff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.device"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.device"><code class="option">services.gromit-mpx.tools.*.device</code></a></span></dt><dd><p>Use this tool with the given xinput device. The device with
|
||
the name default works with any input.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"default"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.modifiers"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.modifiers"><code class="option">services.gromit-mpx.tools.*.modifiers</code></a></span></dt><dd><p>Only activate this tool if the given modifiers are also active.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of one of "1", "2", "3", "4", "5", "SHIFT", "CONTROL", "ALT", "META"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"SHIFT"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.size"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.size"><code class="option">services.gromit-mpx.tools.*.size</code></a></span></dt><dd><p>The tool size.</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">3</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.type"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.type"><code class="option">services.gromit-mpx.tools.*.type</code></a></span></dt><dd><p>Which type of tool this is.</p><p><span class="emphasis"><em>Type:</em></span> one of "pen", "eraser", "recolor"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pen"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"eraser"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.undoKey"></a><a class="term" href="options.html#opt-services.gromit-mpx.undoKey"><code class="option">services.gromit-mpx.undoKey</code></a></span></dt><dd><p>A keysym or raw keycode that causes gromit-mpx to undo the
|
||
last stroke. Use this key along with the shift key to redo an
|
||
undone stoke. Set to <code class="literal">null</code> to disable the
|
||
undo hotkey.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"F10"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/gromit-mpx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/gromit-mpx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.home-manager.autoUpgrade.enable"></a><a class="term" href="options.html#opt-services.home-manager.autoUpgrade.enable"><code class="option">services.home-manager.autoUpgrade.enable</code></a></span></dt><dd><p>Whether to enable the Home Manager upgrade service that periodically updates your Nix
|
||
channels before running <code class="code">home-manager switch</code>.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/home-manager-auto-upgrade.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/home-manager-auto-upgrade.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.home-manager.autoUpgrade.frequency"></a><a class="term" href="options.html#opt-services.home-manager.autoUpgrade.frequency"><code class="option">services.home-manager.autoUpgrade.frequency</code></a></span></dt><dd><p>The interval at which the Home Manager auto upgrade is run.
|
||
This value is passed to the systemd timer configuration
|
||
as the <code class="code">OnCalendar</code> option.
|
||
The format is described in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"weekly"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/home-manager-auto-upgrade.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/home-manager-auto-upgrade.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.enable"></a><a class="term" href="options.html#opt-services.hound.enable"><code class="option">services.hound.enable</code></a></span></dt><dd><p>Whether to enable hound.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/hound.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/hound.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.databasePath"></a><a class="term" href="options.html#opt-services.hound.databasePath"><code class="option">services.hound.databasePath</code></a></span></dt><dd><p>The Hound database path.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_DATA_HOME/hound"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/hound.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/hound.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.listenAddress"></a><a class="term" href="options.html#opt-services.hound.listenAddress"><code class="option">services.hound.listenAddress</code></a></span></dt><dd><p>Listen address of the Hound daemon.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"localhost:6080"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/hound.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/hound.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.maxConcurrentIndexers"></a><a class="term" href="options.html#opt-services.hound.maxConcurrentIndexers"><code class="option">services.hound.maxConcurrentIndexers</code></a></span></dt><dd><p>Limit the amount of concurrent indexers.</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/hound.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/hound.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.repositories"></a><a class="term" href="options.html#opt-services.hound.repositories"><code class="option">services.hound.repositories</code></a></span></dt><dd><p>The repository configuration.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
SomeGitRepo = {
|
||
url = "https://www.github.com/YourOrganization/RepoOne.git";
|
||
ms-between-poll = 10000;
|
||
exclude-dot-files = true;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/hound.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/hound.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.imapnotify.enable"></a><a class="term" href="options.html#opt-services.imapnotify.enable"><code class="option">services.imapnotify.enable</code></a></span></dt><dd><p>Whether to enable imapnotify.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/imapnotify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/imapnotify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.enable"></a><a class="term" href="options.html#opt-services.kanshi.enable"><code class="option">services.kanshi.enable</code></a></span></dt><dd><p>Whether to enable kanshi, a Wayland daemon that automatically configures outputs.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.package"></a><a class="term" href="options.html#opt-services.kanshi.package"><code class="option">services.kanshi.package</code></a></span></dt><dd><p>kanshi derivation to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.kanshi</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.extraConfig"></a><a class="term" href="options.html#opt-services.kanshi.extraConfig"><code class="option">services.kanshi.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to append to the kanshi
|
||
configuration file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles"></a><a class="term" href="options.html#opt-services.kanshi.profiles"><code class="option">services.kanshi.profiles</code></a></span></dt><dd><p>List of profiles.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">undocked = {
|
||
outputs = [
|
||
{
|
||
criteria = "eDP-1";
|
||
}
|
||
];
|
||
};
|
||
docked = {
|
||
outputs = [
|
||
{
|
||
criteria = "eDP-1";
|
||
}
|
||
{
|
||
criteria = "Some Company ASDF 4242";
|
||
transform = "90";
|
||
}
|
||
];
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.exec"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.exec"><code class="option">services.kanshi.profiles.<name>.exec</code></a></span></dt><dd><p>Commands executed after the profile is succesfully applied.
|
||
Note that if you provide multiple commands, they will be
|
||
executed asynchronously with no guaranteed ordering.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string or string convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"[ \${pkg.sway}/bin/swaymsg workspace 1, move workspace to eDP-1 ]"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs"><code class="option">services.kanshi.profiles.<name>.outputs</code></a></span></dt><dd><p>Outputs configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs._.criteria"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs._.criteria"><code class="option">services.kanshi.profiles.<name>.outputs.*.criteria</code></a></span></dt><dd><p>The criteria can either be an output name, an output description or "*".
|
||
The latter can be used to match any output.
|
||
|
||
On
|
||
<span class="citerefentry"><span class="refentrytitle">sway</span>(1)</span>,
|
||
output names and descriptions can be obtained via
|
||
<code class="literal">swaymsg -t get_outputs</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs._.mode"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs._.mode"><code class="option">services.kanshi.profiles.<name>.outputs.*.mode</code></a></span></dt><dd><p><width>x<height>[@<rate>[Hz]]
|
||
</p><p>
|
||
Configures the specified output to use the specified mode.
|
||
Modes are a combination of width and height (in pixels) and
|
||
a refresh rate (in Hz) that your display can be configured to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"1920x1080@60Hz"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs._.position"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs._.position"><code class="option">services.kanshi.profiles.<name>.outputs.*.position</code></a></span></dt><dd><p><x>,<y>
|
||
</p><p>
|
||
Places the output at the specified position in the global coordinates
|
||
space.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"1600,0"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs._.scale"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs._.scale"><code class="option">services.kanshi.profiles.<name>.outputs.*.scale</code></a></span></dt><dd><p>Scales the output by the specified scale factor.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs._.status"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs._.status"><code class="option">services.kanshi.profiles.<name>.outputs.*.status</code></a></span></dt><dd><p>Enables or disables the specified output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "enable", "disable"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.profiles._name_.outputs._.transform"></a><a class="term" href="options.html#opt-services.kanshi.profiles._name_.outputs._.transform"><code class="option">services.kanshi.profiles.<name>.outputs.*.transform</code></a></span></dt><dd><p>Sets the output transform.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "normal", "90", "180", "270", "flipped", "flipped-90", "flipped-180", "flipped-270"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kanshi.systemdTarget"></a><a class="term" href="options.html#opt-services.kanshi.systemdTarget"><code class="option">services.kanshi.systemdTarget</code></a></span></dt><dd><p>Systemd target to bind to.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"sway-session.target"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kanshi.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kanshi.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kbfs.enable"></a><a class="term" href="options.html#opt-services.kbfs.enable"><code class="option">services.kbfs.enable</code></a></span></dt><dd><p>Whether to enable Keybase File System.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kbfs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kbfs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kbfs.extraFlags"></a><a class="term" href="options.html#opt-services.kbfs.extraFlags"><code class="option">services.kbfs.extraFlags</code></a></span></dt><dd><p>Additional flags to pass to the Keybase filesystem on launch.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"-label kbfs" "-mount-type normal"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kbfs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kbfs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kbfs.mountPoint"></a><a class="term" href="options.html#opt-services.kbfs.mountPoint"><code class="option">services.kbfs.mountPoint</code></a></span></dt><dd><p>Mount point for the Keybase filesystem, relative to
|
||
<code class="envar">HOME</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"keybase"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kbfs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kbfs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kdeconnect.enable"></a><a class="term" href="options.html#opt-services.kdeconnect.enable"><code class="option">services.kdeconnect.enable</code></a></span></dt><dd><p>Whether to enable KDE connect.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kdeconnect.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kdeconnect.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.kdeconnect.indicator"></a><a class="term" href="options.html#opt-services.kdeconnect.indicator"><code class="option">services.kdeconnect.indicator</code></a></span></dt><dd><p>Whether to enable kdeconnect-indicator service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/kdeconnect.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/kdeconnect.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.keepassx.enable"></a><a class="term" href="options.html#opt-services.keepassx.enable"><code class="option">services.keepassx.enable</code></a></span></dt><dd><p>Whether to enable the KeePassX password manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/keepassx.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/keepassx.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.keybase.enable"></a><a class="term" href="options.html#opt-services.keybase.enable"><code class="option">services.keybase.enable</code></a></span></dt><dd><p>Whether to enable Keybase.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/keybase.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/keybase.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.keynav.enable"></a><a class="term" href="options.html#opt-services.keynav.enable"><code class="option">services.keynav.enable</code></a></span></dt><dd><p>Whether to enable keynav.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/keynav.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/keynav.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.lieer.enable"></a><a class="term" href="options.html#opt-services.lieer.enable"><code class="option">services.lieer.enable</code></a></span></dt><dd><p>Whether to enable lieer Gmail synchronization service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/lieer.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/lieer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.lorri.enable"></a><a class="term" href="options.html#opt-services.lorri.enable"><code class="option">services.lorri.enable</code></a></span></dt><dd><p>Whether to enable lorri build daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/lorri.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/lorri.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.lorri.package"></a><a class="term" href="options.html#opt-services.lorri.package"><code class="option">services.lorri.package</code></a></span></dt><dd><p>Which lorri package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.lorri</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/lorri.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/lorri.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.enable"></a><a class="term" href="options.html#opt-services.mbsync.enable"><code class="option">services.mbsync.enable</code></a></span></dt><dd><p>Whether to enable mbsync.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.package"></a><a class="term" href="options.html#opt-services.mbsync.package"><code class="option">services.mbsync.package</code></a></span></dt><dd><p>The package to use for the mbsync binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.isync</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.isync</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.configFile"></a><a class="term" href="options.html#opt-services.mbsync.configFile"><code class="option">services.mbsync.configFile</code></a></span></dt><dd><p>Optional configuration file to link to use instead of
|
||
the default file (<code class="filename">~/.mbsyncrc</code>).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.frequency"></a><a class="term" href="options.html#opt-services.mbsync.frequency"><code class="option">services.mbsync.frequency</code></a></span></dt><dd><p>How often to run mbsync. This value is passed to the systemd
|
||
timer configuration as the onCalendar option. See
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>
|
||
for more information about the format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"*:0/5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.postExec"></a><a class="term" href="options.html#opt-services.mbsync.postExec"><code class="option">services.mbsync.postExec</code></a></span></dt><dd><p>An optional command to run after mbsync executes successfully.
|
||
This is useful for running mailbox indexing tools.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.mu}/bin/mu index"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.preExec"></a><a class="term" href="options.html#opt-services.mbsync.preExec"><code class="option">services.mbsync.preExec</code></a></span></dt><dd><p>An optional command to run before mbsync executes. This is
|
||
useful for creating the directories mbsync is going to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"mkdir -p %h/mail"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mbsync.verbose"></a><a class="term" href="options.html#opt-services.mbsync.verbose"><code class="option">services.mbsync.verbose</code></a></span></dt><dd><p>Whether mbsync should produce verbose output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mbsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mbsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mopidy.enable"></a><a class="term" href="options.html#opt-services.mopidy.enable"><code class="option">services.mopidy.enable</code></a></span></dt><dd><p>Whether to enable Mopidy music player daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mopidy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mopidy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mopidy.extensionPackages"></a><a class="term" href="options.html#opt-services.mopidy.extensionPackages"><code class="option">services.mopidy.extensionPackages</code></a></span></dt><dd><p>Mopidy extensions that should be loaded by the service.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">with pkgs; [ mopidy-spotify mopidy-mpd mopidy-mpris ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mopidy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mopidy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mopidy.settings"></a><a class="term" href="options.html#opt-services.mopidy.settings"><code class="option">services.mopidy.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/mopidy/mopidy.conf</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://docs.mopidy.com/en/latest/config/" target="_top">https://docs.mopidy.com/en/latest/config/</a> for
|
||
more details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of Mopidy config value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
file = {
|
||
media_dirs = [
|
||
"$XDG_MUSIC_DIR|Music"
|
||
"~/library|Library"
|
||
];
|
||
follow_symlinks = true;
|
||
excluded_file_extensions = [
|
||
".html"
|
||
".zip"
|
||
".jpg"
|
||
".jpeg"
|
||
".png"
|
||
];
|
||
};
|
||
|
||
# Please don't put your mopidy-spotify configuration in the public. :)
|
||
# Think of your Spotify Premium subscription!
|
||
spotify = {
|
||
client_id = "CLIENT_ID";
|
||
client_secret = "CLIENT_SECRET";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mopidy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mopidy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.enable"></a><a class="term" href="options.html#opt-services.mpd.enable"><code class="option">services.mpd.enable</code></a></span></dt><dd><p>Whether to enable MPD, the music player daemon.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.package"></a><a class="term" href="options.html#opt-services.mpd.package"><code class="option">services.mpd.package</code></a></span></dt><dd><p>The MPD package to run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.mpd"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.dataDir"></a><a class="term" href="options.html#opt-services.mpd.dataDir"><code class="option">services.mpd.dataDir</code></a></span></dt><dd><p>The directory where MPD stores its state, tag cache,
|
||
playlists etc.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_DATA_HOME/mpd"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.dbFile"></a><a class="term" href="options.html#opt-services.mpd.dbFile"><code class="option">services.mpd.dbFile</code></a></span></dt><dd><p>The path to MPD's database. If set to
|
||
<code class="literal">null</code> the parameter is omitted from the
|
||
configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${dataDir}/tag_cache"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.extraConfig"></a><a class="term" href="options.html#opt-services.mpd.extraConfig"><code class="option">services.mpd.extraConfig</code></a></span></dt><dd><p>Extra directives added to to the end of MPD's configuration
|
||
file, <code class="filename">mpd.conf</code>. Basic configuration
|
||
like file location and uid/gid is added automatically to the
|
||
beginning of the file. For available options see
|
||
<span class="citerefentry"><span class="refentrytitle">mpd.conf</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.musicDirectory"></a><a class="term" href="options.html#opt-services.mpd.musicDirectory"><code class="option">services.mpd.musicDirectory</code></a></span></dt><dd><p>The directory where mpd reads music from.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/music"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.network.listenAddress"></a><a class="term" href="options.html#opt-services.mpd.network.listenAddress"><code class="option">services.mpd.network.listenAddress</code></a></span></dt><dd><p>The address for the daemon to listen on.
|
||
Use <code class="literal">any</code> to listen on all addresses.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"127.0.0.1"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"any"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.network.port"></a><a class="term" href="options.html#opt-services.mpd.network.port"><code class="option">services.mpd.network.port</code></a></span></dt><dd><p>The TCP port on which the the daemon will listen.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">6600</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.network.startWhenNeeded"></a><a class="term" href="options.html#opt-services.mpd.network.startWhenNeeded"><code class="option">services.mpd.network.startWhenNeeded</code></a></span></dt><dd><p>Enable systemd socket activation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd.playlistDirectory"></a><a class="term" href="options.html#opt-services.mpd.playlistDirectory"><code class="option">services.mpd.playlistDirectory</code></a></span></dt><dd><p>The directory where mpd stores playlists.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${dataDir}/playlists"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd-discord-rpc.enable"></a><a class="term" href="options.html#opt-services.mpd-discord-rpc.enable"><code class="option">services.mpd-discord-rpc.enable</code></a></span></dt><dd><p>Whether to enable the mpd-discord-rpc service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd-discord-rpc.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd-discord-rpc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd-discord-rpc.package"></a><a class="term" href="options.html#opt-services.mpd-discord-rpc.package"><code class="option">services.mpd-discord-rpc.package</code></a></span></dt><dd><p>mpd-discord-rpc package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.mpd-discord-rpc</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd-discord-rpc.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd-discord-rpc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpd-discord-rpc.settings"></a><a class="term" href="options.html#opt-services.mpd-discord-rpc.settings"><code class="option">services.mpd-discord-rpc.settings</code></a></span></dt><dd><p>Configuration included in <code class="literal">config.toml</code>.
|
||
For available options see <a class="link" href="https://github.com/JakeStanger/mpd-discord-rpc#configuration" target="_top">https://github.com/JakeStanger/mpd-discord-rpc#configuration</a>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
hosts = [ "localhost:6600" ];
|
||
format = {
|
||
details = "$title";
|
||
state = "On $album by $artist";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpd-discord-rpc.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpd-discord-rpc.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.enable"></a><a class="term" href="options.html#opt-services.mpdris2.enable"><code class="option">services.mpdris2.enable</code></a></span></dt><dd><p>Whether to enable mpDris2 the MPD to MPRIS2 bridge.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.package"></a><a class="term" href="options.html#opt-services.mpdris2.package"><code class="option">services.mpdris2.package</code></a></span></dt><dd><p>The mpDris2 package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.mpdris2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.mpd.host"></a><a class="term" href="options.html#opt-services.mpdris2.mpd.host"><code class="option">services.mpdris2.mpd.host</code></a></span></dt><dd><p>The address where MPD is listening for connections.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"config.services.mpd.network.listenAddress"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"192.168.1.1"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.mpd.musicDirectory"></a><a class="term" href="options.html#opt-services.mpdris2.mpd.musicDirectory"><code class="option">services.mpdris2.mpd.musicDirectory</code></a></span></dt><dd><p>If set, mpDris2 will use this directory to access music artwork.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"config.services.mpd.musicDirectory"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.mpd.password"></a><a class="term" href="options.html#opt-services.mpdris2.mpd.password"><code class="option">services.mpdris2.mpd.password</code></a></span></dt><dd><p>The password to connect to MPD.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.mpd.port"></a><a class="term" href="options.html#opt-services.mpdris2.mpd.port"><code class="option">services.mpdris2.mpd.port</code></a></span></dt><dd><p>The port number where MPD is listening for connections.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"config.services.mpd.network.port"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.multimediaKeys"></a><a class="term" href="options.html#opt-services.mpdris2.multimediaKeys"><code class="option">services.mpdris2.multimediaKeys</code></a></span></dt><dd><p>Whether to enable multimedia key support.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpdris2.notifications"></a><a class="term" href="options.html#opt-services.mpdris2.notifications"><code class="option">services.mpdris2.notifications</code></a></span></dt><dd><p>Whether to enable song change notifications.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpdris2.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpdris2.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.mpris-proxy.enable"></a><a class="term" href="options.html#opt-services.mpris-proxy.enable"><code class="option">services.mpris-proxy.enable</code></a></span></dt><dd><p>Whether to enable a proxy forwarding Bluetooth MIDI controls via MPRIS2 to control media players.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/mpris-proxy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/mpris-proxy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes"></a><a class="term" href="options.html#opt-services.muchsync.remotes"><code class="option">services.muchsync.remotes</code></a></span></dt><dd><p>Muchsync remotes to synchronise with.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
server = {
|
||
frequency = "*:0/10";
|
||
remote.host = "server.tld";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.frequency"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.frequency"><code class="option">services.muchsync.remotes.<name>.frequency</code></a></span></dt><dd><p>How often to run <span class="command"><strong>muchsync</strong></span>. This
|
||
value is passed to the systemd timer configuration as the
|
||
<code class="literal">OnCalendar</code> option. See
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>
|
||
for more information about the format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"*:0/5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.local.checkForModifiedFiles"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.local.checkForModifiedFiles"><code class="option">services.muchsync.remotes.<name>.local.checkForModifiedFiles</code></a></span></dt><dd><p>Check for locally modified files.
|
||
Without this option, muchsync assumes that files in a maildir are
|
||
never edited.
|
||
</p><p>
|
||
<code class="option">checkForModifiedFiles</code> disables certain
|
||
optimizations so as to make muchsync at least check the timestamp on
|
||
every file, which will detect modified files at the cost of a longer
|
||
startup time.
|
||
</p><p>
|
||
This option is useful if your software regularly modifies the
|
||
contents of mail files (e.g., because you are running offlineimap
|
||
with "synclabels = yes").
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.local.importNew"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.local.importNew"><code class="option">services.muchsync.remotes.<name>.local.importNew</code></a></span></dt><dd><p>Whether to begin the synchronisation by running
|
||
<span class="command"><strong>notmuch new</strong></span> locally.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.remote.checkForModifiedFiles"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.remote.checkForModifiedFiles"><code class="option">services.muchsync.remotes.<name>.remote.checkForModifiedFiles</code></a></span></dt><dd><p>Check for modified files on the remote side.
|
||
Without this option, muchsync assumes that files in a maildir are
|
||
never edited.
|
||
</p><p>
|
||
<code class="option">checkForModifiedFiles</code> disables certain
|
||
optimizations so as to make muchsync at least check the timestamp on
|
||
every file, which will detect modified files at the cost of a longer
|
||
startup time.
|
||
</p><p>
|
||
This option is useful if your software regularly modifies the
|
||
contents of mail files (e.g., because you are running offlineimap
|
||
with "synclabels = yes").
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.remote.host"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.remote.host"><code class="option">services.muchsync.remotes.<name>.remote.host</code></a></span></dt><dd><p>Remote SSH host to synchronize with.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.remote.importNew"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.remote.importNew"><code class="option">services.muchsync.remotes.<name>.remote.importNew</code></a></span></dt><dd><p>Whether to begin the synchronisation by running
|
||
<span class="command"><strong>notmuch new</strong></span> on the remote side.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.remote.muchsyncPath"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.remote.muchsyncPath"><code class="option">services.muchsync.remotes.<name>.remote.muchsyncPath</code></a></span></dt><dd><p>Specifies the path to muchsync on the server.
|
||
Ordinarily, muchsync should be in the default PATH on the server
|
||
so this option is not required.
|
||
However, this option is useful if you have to install muchsync in
|
||
a non-standard place or wish to test development versions of the
|
||
code.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$PATH/muchsync"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.sshCommand"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.sshCommand"><code class="option">services.muchsync.remotes.<name>.sshCommand</code></a></span></dt><dd><p>Specifies a command line to pass to <span class="command"><strong>/bin/sh</strong></span>
|
||
to execute a command on another machine.
|
||
</p><p>
|
||
Note that because this string is passed to the shell,
|
||
special characters including spaces may need to be escaped.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"ssh -CTaxq"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.muchsync.remotes._name_.upload"></a><a class="term" href="options.html#opt-services.muchsync.remotes._name_.upload"><code class="option">services.muchsync.remotes.<name>.upload</code></a></span></dt><dd><p>Whether to propagate local changes to the remote.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/muchsync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/muchsync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.network-manager-applet.enable"></a><a class="term" href="options.html#opt-services.network-manager-applet.enable"><code class="option">services.network-manager-applet.enable</code></a></span></dt><dd><p>Whether to enable the Network Manager applet.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/network-manager-applet.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/network-manager-applet.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.nextcloud-client.enable"></a><a class="term" href="options.html#opt-services.nextcloud-client.enable"><code class="option">services.nextcloud-client.enable</code></a></span></dt><dd><p>Whether to enable Nextcloud Client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/nextcloud-client.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/nextcloud-client.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.nextcloud-client.package"></a><a class="term" href="options.html#opt-services.nextcloud-client.package"><code class="option">services.nextcloud-client.package</code></a></span></dt><dd><p>The package to use for the nextcloud client binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nextcloud-client</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/nextcloud-client.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/nextcloud-client.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.nextcloud-client.startInBackground"></a><a class="term" href="options.html#opt-services.nextcloud-client.startInBackground"><code class="option">services.nextcloud-client.startInBackground</code></a></span></dt><dd><p>Whether to start the Nextcloud client in the background.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/nextcloud-client.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/nextcloud-client.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.notify-osd.enable"></a><a class="term" href="options.html#opt-services.notify-osd.enable"><code class="option">services.notify-osd.enable</code></a></span></dt><dd><p>Whether to enable notify-osd.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/notify-osd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/notify-osd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.notify-osd.package"></a><a class="term" href="options.html#opt-services.notify-osd.package"><code class="option">services.notify-osd.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>notify-osd</strong></span> program.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.notify-osd</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/notify-osd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/notify-osd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.opensnitch-ui.enable"></a><a class="term" href="options.html#opt-services.opensnitch-ui.enable"><code class="option">services.opensnitch-ui.enable</code></a></span></dt><dd><p>Whether to enable Opensnitch client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/opensnitch-ui.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/opensnitch-ui.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.owncloud-client.enable"></a><a class="term" href="options.html#opt-services.owncloud-client.enable"><code class="option">services.owncloud-client.enable</code></a></span></dt><dd><p>Whether to enable Owncloud Client.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/owncloud-client.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/owncloud-client.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pantalaimon.enable"></a><a class="term" href="options.html#opt-services.pantalaimon.enable"><code class="option">services.pantalaimon.enable</code></a></span></dt><dd><p>Whether to enable Pantalaimon, an E2EE aware proxy daemon for matrix clients.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pantalaimon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pantalaimon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pantalaimon.package"></a><a class="term" href="options.html#opt-services.pantalaimon.package"><code class="option">services.pantalaimon.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>pantalaimon</strong></span> executable to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.pantalaimon</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pantalaimon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pantalaimon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pantalaimon.settings"></a><a class="term" href="options.html#opt-services.pantalaimon.settings"><code class="option">services.pantalaimon.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/pantalaimon/pantalaimon.conf</code>.
|
||
</p><p>
|
||
See <a class="link" href="https://github.com/matrix-org/pantalaimon/blob/master/docs/manpantalaimon.5.md" target="_top">https://github.com/matrix-org/pantalaimon/blob/master/docs/manpantalaimon.5.md</a> or
|
||
<span class="citerefentry"><span class="refentrytitle">pantalaimon</span>(5)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
Default = {
|
||
LogLevel = "Debug";
|
||
SSL = true;
|
||
};
|
||
local-matrix = {
|
||
Homeserver = "https://matrix.org";
|
||
ListenAddress = "127.0.0.1";
|
||
ListenPort = 8008;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pantalaimon.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pantalaimon.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.parcellite.enable"></a><a class="term" href="options.html#opt-services.parcellite.enable"><code class="option">services.parcellite.enable</code></a></span></dt><dd><p>Whether to enable Parcellite.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/parcellite.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/parcellite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.parcellite.package"></a><a class="term" href="options.html#opt-services.parcellite.package"><code class="option">services.parcellite.package</code></a></span></dt><dd><p>Parcellite derivation to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.parcellite</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.clipit</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/parcellite.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/parcellite.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pass-secret-service.enable"></a><a class="term" href="options.html#opt-services.pass-secret-service.enable"><code class="option">services.pass-secret-service.enable</code></a></span></dt><dd><p>Whether to enable Pass libsecret service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pass-secret-service.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pass-secret-service.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.password-store-sync.enable"></a><a class="term" href="options.html#opt-services.password-store-sync.enable"><code class="option">services.password-store-sync.enable</code></a></span></dt><dd><p>Whether to enable Password store periodic sync.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/password-store-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/password-store-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.password-store-sync.frequency"></a><a class="term" href="options.html#opt-services.password-store-sync.frequency"><code class="option">services.password-store-sync.frequency</code></a></span></dt><dd><p>How often to synchronise the password store git repository with its
|
||
default upstream.
|
||
</p><p>
|
||
This value is passed to the systemd timer configuration as the
|
||
<code class="literal">onCalendar</code> option.
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>
|
||
for more information about the format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"*:0/5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/password-store-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/password-store-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pasystray.enable"></a><a class="term" href="options.html#opt-services.pasystray.enable"><code class="option">services.pasystray.enable</code></a></span></dt><dd><p>Whether to enable PulseAudio system tray.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pasystray.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pasystray.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pbgopy.enable"></a><a class="term" href="options.html#opt-services.pbgopy.enable"><code class="option">services.pbgopy.enable</code></a></span></dt><dd><p>Whether to enable pbgopy.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pbgopy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pbgopy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pbgopy.cache.ttl"></a><a class="term" href="options.html#opt-services.pbgopy.cache.ttl"><code class="option">services.pbgopy.cache.ttl</code></a></span></dt><dd><p>The TTL for the cache. Use <code class="literal">"0s"</code> to disable it.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"24h"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"10m"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pbgopy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pbgopy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pbgopy.httpAuth"></a><a class="term" href="options.html#opt-services.pbgopy.httpAuth"><code class="option">services.pbgopy.httpAuth</code></a></span></dt><dd><p>Basic HTTP authentication's username and password. Both the username and
|
||
password are escaped.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"user:pass"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pbgopy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pbgopy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pbgopy.port"></a><a class="term" href="options.html#opt-services.pbgopy.port"><code class="option">services.pbgopy.port</code></a></span></dt><dd><p>The port to host the pbgopy server on.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">9090</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">8080</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pbgopy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pbgopy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.enable"></a><a class="term" href="options.html#opt-services.picom.enable"><code class="option">services.picom.enable</code></a></span></dt><dd><p>Whether to enable Picom X11 compositor.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.package"></a><a class="term" href="options.html#opt-services.picom.package"><code class="option">services.picom.package</code></a></span></dt><dd><p>picom derivation to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.picom</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.picom</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.activeOpacity"></a><a class="term" href="options.html#opt-services.picom.activeOpacity"><code class="option">services.picom.activeOpacity</code></a></span></dt><dd><p>Opacity of active windows.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"1.0"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.backend"></a><a class="term" href="options.html#opt-services.picom.backend"><code class="option">services.picom.backend</code></a></span></dt><dd><p>Backend to use: <code class="literal">glx</code> or <code class="literal">xrender</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"glx"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.blur"></a><a class="term" href="options.html#opt-services.picom.blur"><code class="option">services.picom.blur</code></a></span></dt><dd><p>Enable background blur on transparent windows.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.blurExclude"></a><a class="term" href="options.html#opt-services.picom.blurExclude"><code class="option">services.picom.blurExclude</code></a></span></dt><dd><p>List of windows to exclude background blur.
|
||
See the
|
||
<span class="citerefentry"><span class="refentrytitle">picom</span>(1)</span>
|
||
man page for more examples.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"class_g = 'slop'" "class_i = 'polybar'"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.experimentalBackends"></a><a class="term" href="options.html#opt-services.picom.experimentalBackends"><code class="option">services.picom.experimentalBackends</code></a></span></dt><dd><p>Whether to use the new experimental backends.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.extraOptions"></a><a class="term" href="options.html#opt-services.picom.extraOptions"><code class="option">services.picom.extraOptions</code></a></span></dt><dd><p>Additional Picom configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
unredir-if-possible = true;
|
||
dbe = true;
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.fade"></a><a class="term" href="options.html#opt-services.picom.fade"><code class="option">services.picom.fade</code></a></span></dt><dd><p>Fade windows in and out.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.fadeDelta"></a><a class="term" href="options.html#opt-services.picom.fadeDelta"><code class="option">services.picom.fadeDelta</code></a></span></dt><dd><p>Time between fade animation step (in ms).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.fadeExclude"></a><a class="term" href="options.html#opt-services.picom.fadeExclude"><code class="option">services.picom.fadeExclude</code></a></span></dt><dd><p>List of conditions of windows that should not be faded.
|
||
See the
|
||
<span class="citerefentry"><span class="refentrytitle">picom</span>(1)</span>
|
||
man page for more examples.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"window_type *= 'menu'" "name ~= 'Firefox$'" "focused = 1"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.fadeSteps"></a><a class="term" href="options.html#opt-services.picom.fadeSteps"><code class="option">services.picom.fadeSteps</code></a></span></dt><dd><p>Opacity change between fade steps (in and out).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
"0.028" "0.03"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"0.04" "0.04"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.inactiveDim"></a><a class="term" href="options.html#opt-services.picom.inactiveDim"><code class="option">services.picom.inactiveDim</code></a></span></dt><dd><p>Dim inactive windows.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"0.0"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.2"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.inactiveOpacity"></a><a class="term" href="options.html#opt-services.picom.inactiveOpacity"><code class="option">services.picom.inactiveOpacity</code></a></span></dt><dd><p>Opacity of inactive windows.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"1.0"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.menuOpacity"></a><a class="term" href="options.html#opt-services.picom.menuOpacity"><code class="option">services.picom.menuOpacity</code></a></span></dt><dd><p>Opacity of dropdown and popup menu.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"1.0"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.noDNDShadow"></a><a class="term" href="options.html#opt-services.picom.noDNDShadow"><code class="option">services.picom.noDNDShadow</code></a></span></dt><dd><p>Avoid shadow on drag-and-drop windows.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.noDockShadow"></a><a class="term" href="options.html#opt-services.picom.noDockShadow"><code class="option">services.picom.noDockShadow</code></a></span></dt><dd><p>Avoid shadow on docks.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.opacityRule"></a><a class="term" href="options.html#opt-services.picom.opacityRule"><code class="option">services.picom.opacityRule</code></a></span></dt><dd><p>List of opacity rules.
|
||
See the
|
||
<span class="citerefentry"><span class="refentrytitle">picom</span>(1)</span>
|
||
man page for more examples.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"87:class_i ?= 'scratchpad'" "91:class_i ?= 'xterm'"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.shadow"></a><a class="term" href="options.html#opt-services.picom.shadow"><code class="option">services.picom.shadow</code></a></span></dt><dd><p>Draw window shadows.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.shadowExclude"></a><a class="term" href="options.html#opt-services.picom.shadowExclude"><code class="option">services.picom.shadowExclude</code></a></span></dt><dd><p>List of conditions of windows that should have no shadow.
|
||
See the
|
||
<span class="citerefentry"><span class="refentrytitle">picom</span>(1)</span>
|
||
man page for more examples.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"window_type *= 'menu'" "name ~= 'Firefox$'" "focused = 1"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.shadowOffsets"></a><a class="term" href="options.html#opt-services.picom.shadowOffsets"><code class="option">services.picom.shadowOffsets</code></a></span></dt><dd><p>Horizontal and vertical offsets for shadows (in pixels).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
-15 -15
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
-10 -15
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.shadowOpacity"></a><a class="term" href="options.html#opt-services.picom.shadowOpacity"><code class="option">services.picom.shadowOpacity</code></a></span></dt><dd><p>Window shadows opacity (number in range 0 - 1).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"0.75"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"0.8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.picom.vSync"></a><a class="term" href="options.html#opt-services.picom.vSync"><code class="option">services.picom.vSync</code></a></span></dt><dd><p>Enable vertical synchronization.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/picom.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/picom.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.plan9port.fontsrv.enable"></a><a class="term" href="options.html#opt-services.plan9port.fontsrv.enable"><code class="option">services.plan9port.fontsrv.enable</code></a></span></dt><dd><p>Whether to enable the Plan 9 file system access to host fonts.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/plan9port.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/plan9port.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.plan9port.plumber.enable"></a><a class="term" href="options.html#opt-services.plan9port.plumber.enable"><code class="option">services.plan9port.plumber.enable</code></a></span></dt><dd><p>Whether to enable the Plan 9 file system for interprocess messaging.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/plan9port.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/plan9port.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.playerctld.enable"></a><a class="term" href="options.html#opt-services.playerctld.enable"><code class="option">services.playerctld.enable</code></a></span></dt><dd><p>Whether to enable playerctld daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/playerctld.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/playerctld.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.playerctld.package"></a><a class="term" href="options.html#opt-services.playerctld.package"><code class="option">services.playerctld.package</code></a></span></dt><dd><p>The playerctl package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.playerctl</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/playerctld.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/playerctld.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.plex-mpv-shim.enable"></a><a class="term" href="options.html#opt-services.plex-mpv-shim.enable"><code class="option">services.plex-mpv-shim.enable</code></a></span></dt><dd><p>Whether to enable Plex mpv shim.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/plex-mpv-shim.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/plex-mpv-shim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.plex-mpv-shim.package"></a><a class="term" href="options.html#opt-services.plex-mpv-shim.package"><code class="option">services.plex-mpv-shim.package</code></a></span></dt><dd><p>The package to use for the Plex mpv shim.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.plex-mpv-shim</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/plex-mpv-shim.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/plex-mpv-shim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.plex-mpv-shim.settings"></a><a class="term" href="options.html#opt-services.plex-mpv-shim.settings"><code class="option">services.plex-mpv-shim.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/plex-mpv-shim/config.json</code>. See
|
||
<a class="link" href="https://github.com/iwalton3/plex-mpv-shim/blob/master/README.md" target="_top">https://github.com/iwalton3/plex-mpv-shim/blob/master/README.md</a>
|
||
for the configuration documentation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> JSON value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
adaptive_transcode = false;
|
||
allow_http = false;
|
||
always_transcode = false;
|
||
audio_ac3passthrough = false;
|
||
audio_dtspassthrough = false;
|
||
auto_play = true;
|
||
auto_transcode = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/plex-mpv-shim.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/plex-mpv-shim.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.polybar.enable"></a><a class="term" href="options.html#opt-services.polybar.enable"><code class="option">services.polybar.enable</code></a></span></dt><dd><p>Whether to enable Polybar status bar.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/polybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/polybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.polybar.package"></a><a class="term" href="options.html#opt-services.polybar.package"><code class="option">services.polybar.package</code></a></span></dt><dd><p>Polybar package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.polybar</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.polybar.override {
|
||
i3GapsSupport = true;
|
||
alsaSupport = true;
|
||
iwSupport = true;
|
||
githubSupport = true;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/polybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/polybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.polybar.config"></a><a class="term" href="options.html#opt-services.polybar.config"><code class="option">services.polybar.config</code></a></span></dt><dd><p>Polybar configuration. Can be either path to a file, or set of attributes
|
||
that will be used to create the final configuration.
|
||
See also <code class="option">services.polybar.settings</code> for a more nix-friendly format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string or boolean or signed integer or list of string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"bar/top" = {
|
||
monitor = "\${env:MONITOR:eDP1}";
|
||
width = "100%";
|
||
height = "3%";
|
||
radius = 0;
|
||
modules-center = "date";
|
||
};
|
||
|
||
"module/date" = {
|
||
type = "internal/date";
|
||
internal = 5;
|
||
date = "%d.%m.%y";
|
||
time = "%H:%M";
|
||
label = "%time% %date%";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/polybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/polybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.polybar.extraConfig"></a><a class="term" href="options.html#opt-services.polybar.extraConfig"><code class="option">services.polybar.extraConfig</code></a></span></dt><dd><p>Additional configuration to add.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
[module/date]
|
||
type = internal/date
|
||
interval = 5
|
||
date = "%d.%m.%y"
|
||
time = %H:%M
|
||
format-prefix-foreground = \''${colors.foreground-alt}
|
||
label = %time% %date%
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/polybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/polybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.polybar.script"></a><a class="term" href="options.html#opt-services.polybar.script"><code class="option">services.polybar.script</code></a></span></dt><dd><p>This script will be used to start the polybars.
|
||
Set all necessary environment variables here and start all bars.
|
||
It can be assumed that <span class="command"><strong>polybar</strong></span> executable is in the <code class="envar">PATH</code>.
|
||
|
||
Note, this script must start all bars in the background and then terminate.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"polybar bar &"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/polybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/polybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.polybar.settings"></a><a class="term" href="options.html#opt-services.polybar.settings"><code class="option">services.polybar.settings</code></a></span></dt><dd><p>Polybar configuration. This takes a nix attrset and converts it to the
|
||
strange data format that polybar uses.
|
||
Each entry will be converted to a section in the output file.
|
||
Several things are treated specially: nested keys are converted
|
||
to dash-separated keys; the special <code class="literal">text</code> key is ignored as a nested key,
|
||
to allow mixing different levels of nesting; and lists are converted to
|
||
polybar's <code class="literal">foo-0, foo-1, ...</code> format.
|
||
</p><p>
|
||
For example:
|
||
</p><pre class="programlisting nix">
|
||
"module/volume" = {
|
||
type = "internal/pulseaudio";
|
||
format.volume = "<ramp-volume> <label-volume>";
|
||
label.muted.text = "🔇";
|
||
label.muted.foreground = "#666";
|
||
ramp.volume = ["🔈" "🔉" "🔊"];
|
||
click.right = "pavucontrol &";
|
||
}
|
||
</pre><p>
|
||
becomes:
|
||
</p><pre class="programlisting ini">
|
||
[module/volume]
|
||
type=internal/pulseaudio
|
||
format-volume=<ramp-volume> <label-volume>
|
||
label-muted=🔇
|
||
label-muted-foreground=#666
|
||
ramp-volume-0=🔈
|
||
ramp-volume-1=🔉
|
||
ramp-volume-2=🔊
|
||
click-right=pavucontrol &
|
||
</pre><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute sets</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"module/volume" = {
|
||
type = "internal/pulseaudio";
|
||
format.volume = "<ramp-volume> <label-volume>";
|
||
label.muted.text = "🔇";
|
||
label.muted.foreground = "#666";
|
||
ramp.volume = ["🔈" "🔉" "🔊"];
|
||
click.right = "pavucontrol &";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/polybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/polybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.poweralertd.enable"></a><a class="term" href="options.html#opt-services.poweralertd.enable"><code class="option">services.poweralertd.enable</code></a></span></dt><dd><p>Whether to enable the Upower-powered power alerterd.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/poweralertd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/poweralertd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pulseeffects.enable"></a><a class="term" href="options.html#opt-services.pulseeffects.enable"><code class="option">services.pulseeffects.enable</code></a></span></dt><dd><p>Whether to enable Pulseeffects daemon
|
||
Note, it is necessary to add
|
||
</p><pre class="programlisting nix">
|
||
programs.dconf.enable = true;
|
||
</pre><p>
|
||
to your system configuration for the daemon to work correctly.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pulseeffects.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pulseeffects.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pulseeffects.package"></a><a class="term" href="options.html#opt-services.pulseeffects.package"><code class="option">services.pulseeffects.package</code></a></span></dt><dd><p>Pulseeffects package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.pulseeffects-legacy</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pulseeffects.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pulseeffects.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.pulseeffects.preset"></a><a class="term" href="options.html#opt-services.pulseeffects.preset"><code class="option">services.pulseeffects.preset</code></a></span></dt><dd><p>Which preset to use when starting pulseeffects.
|
||
Will likely need to launch pulseeffects to initially create preset.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/pulseeffects.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/pulseeffects.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.random-background.enable"></a><a class="term" href="options.html#opt-services.random-background.enable"><code class="option">services.random-background.enable</code></a></span></dt><dd><p>Whether to enable random desktop background.
|
||
</p><p>
|
||
Note, if you are using NixOS and have set up a custom
|
||
desktop manager session for Home Manager, then the session
|
||
configuration must have the <code class="option">bgSupport</code>
|
||
option set to <code class="literal">true</code> or the background
|
||
image set by this module may be overwritten.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/random-background.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/random-background.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.random-background.enableXinerama"></a><a class="term" href="options.html#opt-services.random-background.enableXinerama"><code class="option">services.random-background.enableXinerama</code></a></span></dt><dd><p>Will place a separate image per screen when enabled,
|
||
otherwise a single image will be stretched across all
|
||
screens.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/random-background.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/random-background.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.random-background.display"></a><a class="term" href="options.html#opt-services.random-background.display"><code class="option">services.random-background.display</code></a></span></dt><dd><p>Display background images according to this option.</p><p><span class="emphasis"><em>Type:</em></span> one of "center", "fill", "max", "scale", "tile"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"fill"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/random-background.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/random-background.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.random-background.imageDirectory"></a><a class="term" href="options.html#opt-services.random-background.imageDirectory"><code class="option">services.random-background.imageDirectory</code></a></span></dt><dd><p>The directory of images from which a background should be
|
||
chosen. Should be formatted in a way understood by systemd,
|
||
e.g., '%h' is the home directory.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"%h/backgrounds"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/random-background.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/random-background.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.random-background.interval"></a><a class="term" href="options.html#opt-services.random-background.interval"><code class="option">services.random-background.interval</code></a></span></dt><dd><p>The duration between changing background image, set to null
|
||
to only set background when logging in. Should be formatted
|
||
as a duration understood by systemd.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"1h"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/random-background.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/random-background.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.enable"></a><a class="term" href="options.html#opt-services.redshift.enable"><code class="option">services.redshift.enable</code></a></span></dt><dd><p>Whether to enable Redshift.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.package"></a><a class="term" href="options.html#opt-services.redshift.package"><code class="option">services.redshift.package</code></a></span></dt><dd><p>Redshift derivation to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.redshift</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.dawnTime"></a><a class="term" href="options.html#opt-services.redshift.dawnTime"><code class="option">services.redshift.dawnTime</code></a></span></dt><dd><p>Set the time interval of dawn manually.
|
||
The times must be specified as HH:MM in 24-hour format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"6:00-7:45"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.duskTime"></a><a class="term" href="options.html#opt-services.redshift.duskTime"><code class="option">services.redshift.duskTime</code></a></span></dt><dd><p>Set the time interval of dusk manually.
|
||
The times must be specified as HH:MM in 24-hour format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"18:35-20:15"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.latitude"></a><a class="term" href="options.html#opt-services.redshift.latitude"><code class="option">services.redshift.latitude</code></a></span></dt><dd><p>Your current latitude, between <code class="literal">-90.0</code> and
|
||
<code class="literal">90.0</code>. Must be provided along with
|
||
longitude.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.longitude"></a><a class="term" href="options.html#opt-services.redshift.longitude"><code class="option">services.redshift.longitude</code></a></span></dt><dd><p>Your current longitude, between <code class="literal">-180.0</code> and
|
||
<code class="literal">180.0</code>. Must be provided along with
|
||
latitude.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.provider"></a><a class="term" href="options.html#opt-services.redshift.provider"><code class="option">services.redshift.provider</code></a></span></dt><dd><p>The location provider to use for determining your location. If set to
|
||
<code class="literal">manual</code> you must also provide latitude/longitude.
|
||
If set to <code class="literal">geoclue2</code>, you must also enable the global
|
||
geoclue2 service.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "manual", "geoclue2"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"manual"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.settings"></a><a class="term" href="options.html#opt-services.redshift.settings"><code class="option">services.redshift.settings</code></a></span></dt><dd><p>The configuration to pass to Redshift.
|
||
Available options for Redshift described in
|
||
<span class="citerefentry"><span class="refentrytitle">redshift</span>(1)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
redshift = {
|
||
adjustment-method = "randr";
|
||
};
|
||
randr = {
|
||
screen = 0;
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.temperature.day"></a><a class="term" href="options.html#opt-services.redshift.temperature.day"><code class="option">services.redshift.temperature.day</code></a></span></dt><dd><p>Colour temperature to use during the day, between
|
||
<code class="literal">1000</code> and <code class="literal">25000</code> K.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5500</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.temperature.night"></a><a class="term" href="options.html#opt-services.redshift.temperature.night"><code class="option">services.redshift.temperature.night</code></a></span></dt><dd><p>Colour temperature to use at night, between
|
||
<code class="literal">1000</code> and <code class="literal">25000</code> K.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">3700</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.tray"></a><a class="term" href="options.html#opt-services.redshift.tray"><code class="option">services.redshift.tray</code></a></span></dt><dd><p>Start the redshift-gtk tray applet.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/redshift-gammastep/redshift.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/redshift-gammastep/redshift.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.rsibreak.enable"></a><a class="term" href="options.html#opt-services.rsibreak.enable"><code class="option">services.rsibreak.enable</code></a></span></dt><dd><p>Whether to enable rsibreak.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/rsibreak.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/rsibreak.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.enable"></a><a class="term" href="options.html#opt-services.screen-locker.enable"><code class="option">services.screen-locker.enable</code></a></span></dt><dd><p>Whether to enable screen locker for X session.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.inactiveInterval"></a><a class="term" href="options.html#opt-services.screen-locker.inactiveInterval"><code class="option">services.screen-locker.inactiveInterval</code></a></span></dt><dd><p>Inactive time interval in minutes after which session will be locked.
|
||
The minimum is 1 minute, and the maximum is 1 hour.
|
||
If <code class="option">xautolock.enable</code> is true, it will use this setting.
|
||
See <a class="link" href="https://linux.die.net/man/1/xautolock" target="_top">https://linux.die.net/man/1/xautolock</a>.
|
||
Otherwise, this will be used with <span class="command"><strong>xset</strong></span> to configure
|
||
the X server's screensaver timeout.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">10</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.lockCmd"></a><a class="term" href="options.html#opt-services.screen-locker.lockCmd"><code class="option">services.screen-locker.lockCmd</code></a></span></dt><dd><p>Locker command to run.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.i3lock}/bin/i3lock -n -c 000000"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xautolock.enable"></a><a class="term" href="options.html#opt-services.screen-locker.xautolock.enable"><code class="option">services.screen-locker.xautolock.enable</code></a></span></dt><dd><p>Use xautolock for time-based locking.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xautolock.package"></a><a class="term" href="options.html#opt-services.screen-locker.xautolock.package"><code class="option">services.screen-locker.xautolock.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>xautolock</strong></span> binary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of xautolock-2.2-7-ga23dd5c)</code></em></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xautolock.detectSleep"></a><a class="term" href="options.html#opt-services.screen-locker.xautolock.detectSleep"><code class="option">services.screen-locker.xautolock.detectSleep</code></a></span></dt><dd><p>Whether to reset xautolock timers when awaking from sleep.
|
||
No effect if <code class="option">xautolock.enable</code> is false.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xautolock.extraOptions"></a><a class="term" href="options.html#opt-services.screen-locker.xautolock.extraOptions"><code class="option">services.screen-locker.xautolock.extraOptions</code></a></span></dt><dd><p>Extra command-line arguments to pass to <span class="command"><strong>xautolock</strong></span>.
|
||
No effect if <code class="option">xautolock.enable</code> is false.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xss-lock.package"></a><a class="term" href="options.html#opt-services.screen-locker.xss-lock.package"><code class="option">services.screen-locker.xss-lock.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>xss-lock</strong></span> binary.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><em class="replaceable"><code>(build of xss-lock-unstable-2018-05-31)</code></em></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xss-lock.extraOptions"></a><a class="term" href="options.html#opt-services.screen-locker.xss-lock.extraOptions"><code class="option">services.screen-locker.xss-lock.extraOptions</code></a></span></dt><dd><p>Extra command-line arguments to pass to <span class="command"><strong>xss-lock</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.screen-locker.xss-lock.screensaverCycle"></a><a class="term" href="options.html#opt-services.screen-locker.xss-lock.screensaverCycle"><code class="option">services.screen-locker.xss-lock.screensaverCycle</code></a></span></dt><dd><p>X server's screensaver cycle value expresed as seconds.
|
||
This will be used with <span class="command"><strong>xset</strong></span> to configure
|
||
the cycle along with timeout.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">600</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/screen-locker.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/screen-locker.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.spotifyd.enable"></a><a class="term" href="options.html#opt-services.spotifyd.enable"><code class="option">services.spotifyd.enable</code></a></span></dt><dd><p>Whether to enable SpotifyD connect.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/spotifyd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/spotifyd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.spotifyd.package"></a><a class="term" href="options.html#opt-services.spotifyd.package"><code class="option">services.spotifyd.package</code></a></span></dt><dd><p>The <code class="literal">spotifyd</code> package to use.
|
||
Can be used to specify extensions.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.spotifyd</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">(pkgs.spotifyd.override { withKeyring = true; })</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/spotifyd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/spotifyd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.spotifyd.settings"></a><a class="term" href="options.html#opt-services.spotifyd.settings"><code class="option">services.spotifyd.settings</code></a></span></dt><dd><p>Configuration for spotifyd</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
global = {
|
||
username = "Alex";
|
||
password = "foo";
|
||
device_name = "nix";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/spotifyd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/spotifyd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.stalonetray.enable"></a><a class="term" href="options.html#opt-services.stalonetray.enable"><code class="option">services.stalonetray.enable</code></a></span></dt><dd><p>Whether to enable Stalonetray system tray.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/stalonetray.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/stalonetray.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.stalonetray.package"></a><a class="term" href="options.html#opt-services.stalonetray.package"><code class="option">services.stalonetray.package</code></a></span></dt><dd><p>The package to use for the Stalonetray binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.stalonetray</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.stalonetray</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/stalonetray.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/stalonetray.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.stalonetray.config"></a><a class="term" href="options.html#opt-services.stalonetray.config"><code class="option">services.stalonetray.config</code></a></span></dt><dd><p>Stalonetray configuration as a set of attributes.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string or boolean or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#cccccc"; decorations = null; geometry = "3x1-600+0"; icon_size = 30; sticky = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/stalonetray.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/stalonetray.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.stalonetray.extraConfig"></a><a class="term" href="options.html#opt-services.stalonetray.extraConfig"><code class="option">services.stalonetray.extraConfig</code></a></span></dt><dd><p>Additional configuration lines for stalonetrayrc.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
geometry 3x1-600+0
|
||
decorations none
|
||
icon_size 30
|
||
sticky true
|
||
background "#cccccc"
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/stalonetray.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/stalonetray.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.status-notifier-watcher.enable"></a><a class="term" href="options.html#opt-services.status-notifier-watcher.enable"><code class="option">services.status-notifier-watcher.enable</code></a></span></dt><dd><p>Whether to enable Status Notifier Watcher.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/status-notifier-watcher.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/status-notifier-watcher.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.status-notifier-watcher.package"></a><a class="term" href="options.html#opt-services.status-notifier-watcher.package"><code class="option">services.status-notifier-watcher.package</code></a></span></dt><dd><p>The package to use for the status notifier watcher binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.haskellPackages.status-notifier-item</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.haskellPackages.status-notifier-item</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/status-notifier-watcher.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/status-notifier-watcher.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.enable"></a><a class="term" href="options.html#opt-services.swayidle.enable"><code class="option">services.swayidle.enable</code></a></span></dt><dd><p>Whether to enable idle manager for Wayland.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.package"></a><a class="term" href="options.html#opt-services.swayidle.package"><code class="option">services.swayidle.package</code></a></span></dt><dd><p>Swayidle package to install.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.swayidle</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.events"></a><a class="term" href="options.html#opt-services.swayidle.events"><code class="option">services.swayidle.events</code></a></span></dt><dd><p>Run command on occurence of a event.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ event = "before-sleep"; command = "swaylock"; }
|
||
{ event = "lock"; command = "lock"; }
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.events._.command"></a><a class="term" href="options.html#opt-services.swayidle.events._.command"><code class="option">services.swayidle.events.*.command</code></a></span></dt><dd><p>Command to run when event occurs.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.events._.event"></a><a class="term" href="options.html#opt-services.swayidle.events._.event"><code class="option">services.swayidle.events.*.event</code></a></span></dt><dd><p>Event name.</p><p><span class="emphasis"><em>Type:</em></span> one of "before-sleep", "after-resume", "lock", "unlock"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.extraArgs"></a><a class="term" href="options.html#opt-services.swayidle.extraArgs"><code class="option">services.swayidle.extraArgs</code></a></span></dt><dd><p>Extra arguments to pass to swayidle.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.timeouts"></a><a class="term" href="options.html#opt-services.swayidle.timeouts"><code class="option">services.swayidle.timeouts</code></a></span></dt><dd><p>List of commands to run after idle timeout.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ timeout = 60; command = "swaylock -fF"; }
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.timeouts._.command"></a><a class="term" href="options.html#opt-services.swayidle.timeouts._.command"><code class="option">services.swayidle.timeouts.*.command</code></a></span></dt><dd><p>Command to run after timeout seconds of inactivity.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.timeouts._.resumeCommand"></a><a class="term" href="options.html#opt-services.swayidle.timeouts._.resumeCommand"><code class="option">services.swayidle.timeouts.*.resumeCommand</code></a></span></dt><dd><p>Command to run when there is activity again.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.swayidle.timeouts._.timeout"></a><a class="term" href="options.html#opt-services.swayidle.timeouts._.timeout"><code class="option">services.swayidle.timeouts.*.timeout</code></a></span></dt><dd><p>Timeout in seconds.</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning >0</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">60</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/swayidle.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/swayidle.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.sxhkd.enable"></a><a class="term" href="options.html#opt-services.sxhkd.enable"><code class="option">services.sxhkd.enable</code></a></span></dt><dd><p>Whether to enable simple X hotkey daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/sxhkd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/sxhkd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.sxhkd.package"></a><a class="term" href="options.html#opt-services.sxhkd.package"><code class="option">services.sxhkd.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>sxhkd</strong></span> executable.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.sxhkd"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/sxhkd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/sxhkd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.sxhkd.extraConfig"></a><a class="term" href="options.html#opt-services.sxhkd.extraConfig"><code class="option">services.sxhkd.extraConfig</code></a></span></dt><dd><p>Additional configuration to add.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">super + {_,shift +} {1-9,0}
|
||
i3-msg {workspace,move container to workspace} {1-10}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/sxhkd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/sxhkd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.sxhkd.extraOptions"></a><a class="term" href="options.html#opt-services.sxhkd.extraOptions"><code class="option">services.sxhkd.extraOptions</code></a></span></dt><dd><p>Command line arguments to invoke <span class="command"><strong>sxhkd</strong></span> with.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ "-m 1" ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/sxhkd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/sxhkd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.sxhkd.keybindings"></a><a class="term" href="options.html#opt-services.sxhkd.keybindings"><code class="option">services.sxhkd.keybindings</code></a></span></dt><dd><p>An attribute set that assigns hotkeys to commands.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"super + shift + {r,c}" = "i3-msg {restart,reload}";
|
||
"super + {s,w}" = "i3-msg {stacking,tabbed}";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/sxhkd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/sxhkd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.syncthing.enable"></a><a class="term" href="options.html#opt-services.syncthing.enable"><code class="option">services.syncthing.enable</code></a></span></dt><dd><p>Whether to enable Syncthing continuous file synchronization.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/syncthing.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/syncthing.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.syncthing.extraOptions"></a><a class="term" href="options.html#opt-services.syncthing.extraOptions"><code class="option">services.syncthing.extraOptions</code></a></span></dt><dd><p>Extra command-line arguments to pass to <span class="command"><strong>syncthing</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--gui-apikey=apiKey"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/syncthing.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/syncthing.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.syncthing.tray"></a><a class="term" href="options.html#opt-services.syncthing.tray"><code class="option">services.syncthing.tray</code></a></span></dt><dd><p>Syncthing tray service configuration.</p><p><span class="emphasis"><em>Type:</em></span> boolean or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
enable = false;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/syncthing.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/syncthing.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.systembus-notify.enable"></a><a class="term" href="options.html#opt-services.systembus-notify.enable"><code class="option">services.systembus-notify.enable</code></a></span></dt><dd><p>Whether to enable systembus-notify - system bus notification daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/systembus-notify.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/systembus-notify.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.taffybar.enable"></a><a class="term" href="options.html#opt-services.taffybar.enable"><code class="option">services.taffybar.enable</code></a></span></dt><dd><p>Whether to enable Taffybar.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/taffybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/taffybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.taffybar.package"></a><a class="term" href="options.html#opt-services.taffybar.package"><code class="option">services.taffybar.package</code></a></span></dt><dd><p>The package to use for the Taffybar binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.taffybar</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.taffybar</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/taffybar.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/taffybar.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.tahoe-lafs.enable"></a><a class="term" href="options.html#opt-services.tahoe-lafs.enable"><code class="option">services.tahoe-lafs.enable</code></a></span></dt><dd><p>Whether to enable Tahoe-LAFS.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/tahoe-lafs.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/tahoe-lafs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.taskwarrior-sync.enable"></a><a class="term" href="options.html#opt-services.taskwarrior-sync.enable"><code class="option">services.taskwarrior-sync.enable</code></a></span></dt><dd><p>Whether to enable Taskwarrior periodic sync.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/taskwarrior-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/taskwarrior-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.taskwarrior-sync.frequency"></a><a class="term" href="options.html#opt-services.taskwarrior-sync.frequency"><code class="option">services.taskwarrior-sync.frequency</code></a></span></dt><dd><p>How often to run <code class="literal">taskwarrior sync</code>. This
|
||
value is passed to the systemd timer configuration as the
|
||
<code class="literal">OnCalendar</code> option. See
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>
|
||
for more information about the format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"*:0/5"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/taskwarrior-sync.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/taskwarrior-sync.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.trayer.enable"></a><a class="term" href="options.html#opt-services.trayer.enable"><code class="option">services.trayer.enable</code></a></span></dt><dd><p>Whether to enable trayer, the lightweight GTK2+ systray for UNIX desktops.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/trayer.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/trayer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.trayer.package"></a><a class="term" href="options.html#opt-services.trayer.package"><code class="option">services.trayer.package</code></a></span></dt><dd><p>The package to use for the trayer binary.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.trayer</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.trayer</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/trayer.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/trayer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.trayer.settings"></a><a class="term" href="options.html#opt-services.trayer.settings"><code class="option">services.trayer.settings</code></a></span></dt><dd><p>Trayer configuration as a set of attributes. Further details can be
|
||
found at <a class="link" href="https://github.com/sargon/trayer-srg" target="_top">https://github.com/sargon/trayer-srg</a>.
|
||
|
||
</p><div class="informaltable"><table class="informaltable" border="0"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Values</th><th>Default</th></tr></thead><tbody><tr><td><code class="varname">SetDockType</code></td><td>boolean</td><td>true|false</td><td>true</td></tr><tr><td><code class="varname">SetPartialStrut</code></td><td>boolean</td><td>true|false</td><td>true</td></tr><tr><td><code class="varname">align</code></td><td>string</td><td>left|right|center</td><td>center</td></tr><tr><td><code class="varname">alpha</code></td><td>signed integer</td><td>number</td><td>127</td></tr><tr><td><code class="varname">distance</code></td><td>signed integer</td><td>number</td><td>0</td></tr><tr><td><code class="varname">distancefrom</code></td><td>string</td><td>left|right|top|bottom</td><td>top</td></tr><tr><td><code class="varname">edge</code></td><td>string</td><td>left|right|top|bottom|none</td><td>bottom</td></tr><tr><td><code class="varname">expand</code></td><td>boolean</td><td>true|false</td><td>true</td></tr><tr><td><code class="varname">height</code></td><td>signed integer</td><td>number</td><td>26</td></tr><tr><td><code class="varname">heighttype</code></td><td>string</td><td>request|pixel</td><td>pixel</td></tr><tr><td><code class="varname">iconspacing</code></td><td>signed integer</td><td>number</td><td>0</td></tr><tr><td><code class="varname">margin</code></td><td>signed integer</td><td>number</td><td>0</td></tr><tr><td><code class="varname">monitor</code></td><td>string</td><td>number|primary</td><td>0</td></tr><tr><td><code class="varname">padding</code></td><td>signed integer</td><td>number</td><td>0</td></tr><tr><td><code class="varname">tint</code></td><td>string</td><td>int</td><td>0xFFFFFFFF</td></tr><tr><td><code class="varname">transparent</code></td><td>boolean</td><td>true|false</td><td>false</td></tr><tr><td><code class="varname">width</code></td><td>signed integer</td><td>number</td><td>100</td></tr><tr><td><code class="varname">widthtype</code></td><td>string</td><td>request|pixel|percent</td><td>percent</td></tr></tbody></table></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string or boolean or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
edge = "top";
|
||
padding = 6;
|
||
SetDockType = true;
|
||
tint = "0x282c34";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/trayer.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/trayer.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.enable"></a><a class="term" href="options.html#opt-services.twmn.enable"><code class="option">services.twmn.enable</code></a></span></dt><dd><p>Whether to enable twmn, a tiling window manager notification daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.duration"></a><a class="term" href="options.html#opt-services.twmn.duration"><code class="option">services.twmn.duration</code></a></span></dt><dd><p>The time each notification remains visible, in milliseconds.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">3000</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.extraConfig"></a><a class="term" href="options.html#opt-services.twmn.extraConfig"><code class="option">services.twmn.extraConfig</code></a></span></dt><dd><p>Extra configuration options to add to the twmnd config file. See
|
||
<a class="link" href="https://github.com/sboli/twmn/blob/master/README.md" target="_top">https://github.com/sboli/twmn/blob/master/README.md</a>
|
||
for details.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">{ main.activation_command = "\${pkgs.hello}/bin/hello"; }</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.host"></a><a class="term" href="options.html#opt-services.twmn.host"><code class="option">services.twmn.host</code></a></span></dt><dd><p>Host address to listen on for notifications.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"127.0.0.1"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"laptop.lan"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.icons.critical"></a><a class="term" href="options.html#opt-services.twmn.icons.critical"><code class="option">services.twmn.icons.critical</code></a></span></dt><dd><p>Path to the critical notifications' icon.</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.icons.info"></a><a class="term" href="options.html#opt-services.twmn.icons.info"><code class="option">services.twmn.icons.info</code></a></span></dt><dd><p>Path to the informative notifications' icon.</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.icons.warning"></a><a class="term" href="options.html#opt-services.twmn.icons.warning"><code class="option">services.twmn.icons.warning</code></a></span></dt><dd><p>Path to the warning notifications' icon.</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.port"></a><a class="term" href="options.html#opt-services.twmn.port"><code class="option">services.twmn.port</code></a></span></dt><dd><p>UDP port to listen on for notifications.</p><p><span class="emphasis"><em>Type:</em></span> 16 bit unsigned integer; between 0 and 65535 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">9797</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.screen"></a><a class="term" href="options.html#opt-services.twmn.screen"><code class="option">services.twmn.screen</code></a></span></dt><dd><p>Screen number to display notifications on when using a multi-head
|
||
desktop.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.soundCommand"></a><a class="term" href="options.html#opt-services.twmn.soundCommand"><code class="option">services.twmn.soundCommand</code></a></span></dt><dd><p>Command to execute to play a notification's sound.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.text.color"></a><a class="term" href="options.html#opt-services.twmn.text.color"><code class="option">services.twmn.text.color</code></a></span></dt><dd><p>Notification's text color. RGB hex and keywords (e.g. <code class="literal">lightgray</code>)
|
||
are supported.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#999999"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"lightgray"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.text.font.package"></a><a class="term" href="options.html#opt-services.twmn.text.font.package"><code class="option">services.twmn.text.font.package</code></a></span></dt><dd><p>Notification text's font package. If <code class="literal">null</code> then
|
||
the font is assumed to already be available in your profile.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.dejavu_fonts</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.text.font.family"></a><a class="term" href="options.html#opt-services.twmn.text.font.family"><code class="option">services.twmn.text.font.family</code></a></span></dt><dd><p>Notification text's font family.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Sans"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Noto Sans"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.text.font.size"></a><a class="term" href="options.html#opt-services.twmn.text.font.size"><code class="option">services.twmn.text.font.size</code></a></span></dt><dd><p>Notification text's font size.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">13</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">42</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.text.font.variant"></a><a class="term" href="options.html#opt-services.twmn.text.font.variant"><code class="option">services.twmn.text.font.variant</code></a></span></dt><dd><p>Notification text's font variant.</p><p><span class="emphasis"><em>Type:</em></span> one of "oblique", "italic", "ultra-light", "light", "medium", "semi-bold", "bold", "ultra-bold", "heavy", "ultra-condensed", "extra-condensed", "condensed", "semi-condensed", "semi-expanded", "expanded", "extra-expanded", "ultra-expanded"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"medium"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"heavy"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.text.maxLength"></a><a class="term" href="options.html#opt-services.twmn.text.maxLength"><code class="option">services.twmn.text.maxLength</code></a></span></dt><dd><p>Maximum length of the text before it is cut and suffixed with "...".
|
||
Never cuts if <code class="literal">null</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">80</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.alwaysOnTop"></a><a class="term" href="options.html#opt-services.twmn.window.alwaysOnTop"><code class="option">services.twmn.window.alwaysOnTop</code></a></span></dt><dd><p>Whether to enable forcing the notification window to always be on top.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.bounce.enable"></a><a class="term" href="options.html#opt-services.twmn.window.animation.bounce.enable"><code class="option">services.twmn.window.animation.bounce.enable</code></a></span></dt><dd><p>Whether to enable notification bounce when displaying next notification directly..</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.bounce.duration"></a><a class="term" href="options.html#opt-services.twmn.window.animation.bounce.duration"><code class="option">services.twmn.window.animation.bounce.duration</code></a></span></dt><dd><p>The bounce animation duration in milliseconds.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">500</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">618</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.easeIn"></a><a class="term" href="options.html#opt-services.twmn.window.animation.easeIn"><code class="option">services.twmn.window.animation.easeIn</code></a></span></dt><dd><p>Options for the notification appearance's animation.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
curve = 19;
|
||
duration = 618;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.easeIn.curve"></a><a class="term" href="options.html#opt-services.twmn.window.animation.easeIn.curve"><code class="option">services.twmn.window.animation.easeIn.curve</code></a></span></dt><dd><p>The qt easing-curve animation to use for the animation. See
|
||
<a class="link" href="https://doc.qt.io/qt-5/qeasingcurve.html#Type-enum" target="_top">
|
||
QEasingCurve documentation</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> integer between 0 and 40 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">38</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">19</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.easeIn.duration"></a><a class="term" href="options.html#opt-services.twmn.window.animation.easeIn.duration"><code class="option">services.twmn.window.animation.easeIn.duration</code></a></span></dt><dd><p>The animation duration in milliseconds.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">1000</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">618</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.easeOut"></a><a class="term" href="options.html#opt-services.twmn.window.animation.easeOut"><code class="option">services.twmn.window.animation.easeOut</code></a></span></dt><dd><p>Options for the notification disappearance's animation.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
curve = 19;
|
||
duration = 618;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.easeOut.curve"></a><a class="term" href="options.html#opt-services.twmn.window.animation.easeOut.curve"><code class="option">services.twmn.window.animation.easeOut.curve</code></a></span></dt><dd><p>The qt easing-curve animation to use for the animation. See
|
||
<a class="link" href="https://doc.qt.io/qt-5/qeasingcurve.html#Type-enum" target="_top">
|
||
QEasingCurve documentation</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> integer between 0 and 40 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">38</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">19</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.animation.easeOut.duration"></a><a class="term" href="options.html#opt-services.twmn.window.animation.easeOut.duration"><code class="option">services.twmn.window.animation.easeOut.duration</code></a></span></dt><dd><p>The animation duration in milliseconds.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">1000</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">618</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.color"></a><a class="term" href="options.html#opt-services.twmn.window.color"><code class="option">services.twmn.window.color</code></a></span></dt><dd><p>Notification's background color. RGB hex and keywords (e.g.
|
||
<code class="literal">lightgray</code>) are supported.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#000000"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"lightgray"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.height"></a><a class="term" href="options.html#opt-services.twmn.window.height"><code class="option">services.twmn.window.height</code></a></span></dt><dd><p>Height of the slide bar. Useful to match your tiling window
|
||
manager's bar.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">18</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">42</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.offset.x"></a><a class="term" href="options.html#opt-services.twmn.window.offset.x"><code class="option">services.twmn.window.offset.x</code></a></span></dt><dd><p>Offset of the notification's slide starting point in pixels on the
|
||
horizontal axis (positive is rightward).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">50</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.offset.y"></a><a class="term" href="options.html#opt-services.twmn.window.offset.y"><code class="option">services.twmn.window.offset.y</code></a></span></dt><dd><p>Offset of the notification's slide starting point in pixels on the
|
||
vertical axis (positive is upward).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">-100</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.opacity"></a><a class="term" href="options.html#opt-services.twmn.window.opacity"><code class="option">services.twmn.window.opacity</code></a></span></dt><dd><p>The notification window's opacity.</p><p><span class="emphasis"><em>Type:</em></span> integer between 0 and 100 (both inclusive)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">100</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">80</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.twmn.window.position"></a><a class="term" href="options.html#opt-services.twmn.window.position"><code class="option">services.twmn.window.position</code></a></span></dt><dd><p>Position of the notification slide. The notification will slide
|
||
in vertically from the border if placed in
|
||
<code class="literal">top_center</code> or <code class="literal">bottom_center</code>,
|
||
horizontally otherwise.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "tr", "top_right", "tl", "top_left", "br", "bottom_right", "bl", "bottom_left", "tc", "top_center", "bc", "bottom_center", "c", "center"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"top_right"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"bottom_left"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/twmn.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/twmn.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.udiskie.enable"></a><a class="term" href="options.html#opt-services.udiskie.enable"><code class="option">services.udiskie.enable</code></a></span></dt><dd><p>Whether to enable udiskie mount daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/udiskie.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/udiskie.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.udiskie.automount"></a><a class="term" href="options.html#opt-services.udiskie.automount"><code class="option">services.udiskie.automount</code></a></span></dt><dd><p>Whether to automatically mount new devices.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/udiskie.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/udiskie.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.udiskie.notify"></a><a class="term" href="options.html#opt-services.udiskie.notify"><code class="option">services.udiskie.notify</code></a></span></dt><dd><p>Whether to show pop-up notifications.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/udiskie.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/udiskie.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.udiskie.tray"></a><a class="term" href="options.html#opt-services.udiskie.tray"><code class="option">services.udiskie.tray</code></a></span></dt><dd><p>Whether to display tray icon.
|
||
</p><p>
|
||
The options are
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">always</code></span></dt><dd><p>Always show tray icon.</p></dd><dt><span class="term"><code class="literal">auto</code></span></dt><dd><p>
|
||
Show tray icon only when there is a device available.
|
||
</p></dd><dt><span class="term"><code class="literal">never</code></span></dt><dd><p>Never show tray icon.</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "always", "auto", "never"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"auto"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/udiskie.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/udiskie.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unclutter.enable"></a><a class="term" href="options.html#opt-services.unclutter.enable"><code class="option">services.unclutter.enable</code></a></span></dt><dd><p>Whether to enable unclutter.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unclutter.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unclutter.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unclutter.package"></a><a class="term" href="options.html#opt-services.unclutter.package"><code class="option">services.unclutter.package</code></a></span></dt><dd><p>unclutter derivation to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.unclutter-xfixes</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unclutter.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unclutter.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unclutter.extraOptions"></a><a class="term" href="options.html#opt-services.unclutter.extraOptions"><code class="option">services.unclutter.extraOptions</code></a></span></dt><dd><p>More arguments to pass to the unclutter command.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"exclude-root" "ignore-scrolling"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unclutter.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unclutter.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unclutter.threshold"></a><a class="term" href="options.html#opt-services.unclutter.threshold"><code class="option">services.unclutter.threshold</code></a></span></dt><dd><p>Minimum number of pixels considered cursor movement.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">1</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unclutter.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unclutter.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unclutter.timeout"></a><a class="term" href="options.html#opt-services.unclutter.timeout"><code class="option">services.unclutter.timeout</code></a></span></dt><dd><p>Number of seconds before the cursor is marked inactive.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">1</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unclutter.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unclutter.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unison.enable"></a><a class="term" href="options.html#opt-services.unison.enable"><code class="option">services.unison.enable</code></a></span></dt><dd><p>Whether to enable Unison synchronisation.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unison.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unison.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unison.pairs"></a><a class="term" href="options.html#opt-services.unison.pairs"><code class="option">services.unison.pairs</code></a></span></dt><dd><p>Unison root pairs to keep synchronised.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"my-documents" = {
|
||
roots = [
|
||
"/home/user/documents"
|
||
"ssh://remote/documents"
|
||
];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unison.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unison.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unison.pairs._name_.commandOptions"></a><a class="term" href="options.html#opt-services.unison.pairs._name_.commandOptions"><code class="option">services.unison.pairs.<name>.commandOptions</code></a></span></dt><dd><p>Additional command line options as a dictionary to pass to the
|
||
<code class="literal">unison</code> program.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">unison</span>(1)</span>
|
||
for a list of available options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
auto = "true"; batch = "true"; log = "false"; repeat = "watch"; sshcmd = "\${pkgs.openssh}/bin/ssh"; ui = "text";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unison.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unison.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unison.pairs._name_.roots"></a><a class="term" href="options.html#opt-services.unison.pairs._name_.roots"><code class="option">services.unison.pairs.<name>.roots</code></a></span></dt><dd><p>Pair of roots to synchronise.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string of length 2</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
"/home/user/documents"
|
||
"ssh://remote/documents"
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unison.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unison.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.unison.pairs._name_.stateDirectory"></a><a class="term" href="options.html#opt-services.unison.pairs._name_.stateDirectory"><code class="option">services.unison.pairs.<name>.stateDirectory</code></a></span></dt><dd><p>Unison state directory to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_DATA_HOME/unison"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/unison.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/unison.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.volnoti.enable"></a><a class="term" href="options.html#opt-services.volnoti.enable"><code class="option">services.volnoti.enable</code></a></span></dt><dd><p>Whether to enable Volnoti volume HUD daemon.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/volnoti.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/volnoti.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.volnoti.package"></a><a class="term" href="options.html#opt-services.volnoti.package"><code class="option">services.volnoti.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>volnoti</strong></span> program.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.volnoti</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/volnoti.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/volnoti.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.enable"></a><a class="term" href="options.html#opt-services.wlsunset.enable"><code class="option">services.wlsunset.enable</code></a></span></dt><dd><p>Whether to enable wlsunset.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.package"></a><a class="term" href="options.html#opt-services.wlsunset.package"><code class="option">services.wlsunset.package</code></a></span></dt><dd><p>wlsunset derivation to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.wlsunset"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.gamma"></a><a class="term" href="options.html#opt-services.wlsunset.gamma"><code class="option">services.wlsunset.gamma</code></a></span></dt><dd><p>Gamma value to use.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"1.0"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.latitude"></a><a class="term" href="options.html#opt-services.wlsunset.latitude"><code class="option">services.wlsunset.latitude</code></a></span></dt><dd><p>Your current latitude, between <code class="literal">-90.0</code> and
|
||
<code class="literal">90.0</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.longitude"></a><a class="term" href="options.html#opt-services.wlsunset.longitude"><code class="option">services.wlsunset.longitude</code></a></span></dt><dd><p>Your current longitude, between <code class="literal">-180.0</code> and
|
||
<code class="literal">180.0</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.systemdTarget"></a><a class="term" href="options.html#opt-services.wlsunset.systemdTarget"><code class="option">services.wlsunset.systemdTarget</code></a></span></dt><dd><p>Systemd target to bind to.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"graphical-session.target"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.temperature.day"></a><a class="term" href="options.html#opt-services.wlsunset.temperature.day"><code class="option">services.wlsunset.temperature.day</code></a></span></dt><dd><p>Colour temperature to use during the day, in Kelvin (K).
|
||
This value must be greater than <code class="literal">temperature.night</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">6500</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.wlsunset.temperature.night"></a><a class="term" href="options.html#opt-services.wlsunset.temperature.night"><code class="option">services.wlsunset.temperature.night</code></a></span></dt><dd><p>Colour temperature to use during the night, in Kelvin (K).
|
||
This value must be smaller than <code class="literal">temperature.day</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">4000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/wlsunset.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/wlsunset.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xcape.enable"></a><a class="term" href="options.html#opt-services.xcape.enable"><code class="option">services.xcape.enable</code></a></span></dt><dd><p>Whether to enable xcape.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xcape.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xcape.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xcape.mapExpression"></a><a class="term" href="options.html#opt-services.xcape.mapExpression"><code class="option">services.xcape.mapExpression</code></a></span></dt><dd><p>The value has the grammar <code class="literal">Key[|OtherKey]</code>.
|
||
</p><p>
|
||
The list of key names is found in the header file
|
||
<code class="filename">X11/keysymdef.h</code> (remove the
|
||
<code class="literal">XK_</code> prefix). Note that due to limitations
|
||
of X11 shifted keys must be specified as a shift key
|
||
followed by the key to be pressed rather than the actual
|
||
name of the character. For example to generate "{" the
|
||
expression <code class="literal">Shift_L|bracketleft</code> could be
|
||
used (assuming that you have a key with "{" above "[").
|
||
</p><p>
|
||
You can also specify keys in decimal (prefix #), octal (#0),
|
||
or hexadecimal (#0x). They will be interpreted as keycodes
|
||
unless no corresponding key name is found.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
Control_L = "Control_L|O"; Shift_L = "Escape";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xcape.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xcape.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xcape.timeout"></a><a class="term" href="options.html#opt-services.xcape.timeout"><code class="option">services.xcape.timeout</code></a></span></dt><dd><p>If you hold a key longer than this timeout, xcape will not
|
||
generate a key event. Default is 500 ms.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">500</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xcape.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xcape.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xembed-sni-proxy.enable"></a><a class="term" href="options.html#opt-services.xembed-sni-proxy.enable"><code class="option">services.xembed-sni-proxy.enable</code></a></span></dt><dd><p>Whether to enable XEmbed SNI Proxy.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xembed-sni-proxy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xembed-sni-proxy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xembed-sni-proxy.package"></a><a class="term" href="options.html#opt-services.xembed-sni-proxy.package"><code class="option">services.xembed-sni-proxy.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>xembedsniproxy</strong></span>
|
||
program.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.plasma-workspace</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xembed-sni-proxy.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xembed-sni-proxy.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.enable"></a><a class="term" href="options.html#opt-services.xidlehook.enable"><code class="option">services.xidlehook.enable</code></a></span></dt><dd><p>Whether to enable xidlehook systemd service.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.package"></a><a class="term" href="options.html#opt-services.xidlehook.package"><code class="option">services.xidlehook.package</code></a></span></dt><dd><p>The package to use for xidlehook.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pkgs.xidlehook"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.environment"></a><a class="term" href="options.html#opt-services.xidlehook.environment"><code class="option">services.xidlehook.environment</code></a></span></dt><dd><p>Extra environment variables to be exported in the script.
|
||
These options are passed unescaped as <code class="code">export name=value</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"primary-display" = "$(xrandr | awk '/ primary/{print $1}')";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.not-when-audio"></a><a class="term" href="options.html#opt-services.xidlehook.not-when-audio"><code class="option">services.xidlehook.not-when-audio</code></a></span></dt><dd><p>Disable locking when audio is playing.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.not-when-fullscreen"></a><a class="term" href="options.html#opt-services.xidlehook.not-when-fullscreen"><code class="option">services.xidlehook.not-when-fullscreen</code></a></span></dt><dd><p>Disable locking when a fullscreen application is in use.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.once"></a><a class="term" href="options.html#opt-services.xidlehook.once"><code class="option">services.xidlehook.once</code></a></span></dt><dd><p>Whether to enable running the program once and exiting.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.timers"></a><a class="term" href="options.html#opt-services.xidlehook.timers"><code class="option">services.xidlehook.timers</code></a></span></dt><dd><p>A set of commands to be executed after a specific idle timeout.
|
||
The commands specified in <code class="literal">command</code> and <code class="literal">canceller</code>
|
||
are passed escaped to the script.
|
||
To use or re-use environment variables that are script-dependent, specify them
|
||
in the <code class="literal">environment</code> section.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{
|
||
delay = 60;
|
||
command = "xrandr --output \"$PRIMARY_DISPLAY\" --brightness .1";
|
||
canceller = "xrandr --output \"$PRIMARY_DISPLAY\" --brightness 1";
|
||
}
|
||
{
|
||
delay = 120;
|
||
command = "${pkgs.writeShellScript "my-script" ''
|
||
# A complex script to run
|
||
''}";
|
||
}
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.timers._.canceller"></a><a class="term" href="options.html#opt-services.xidlehook.timers._.canceller"><code class="option">services.xidlehook.timers.*.canceller</code></a></span></dt><dd><p>Command executed when the user becomes active again.
|
||
This is only executed if the next timer has not been reached.
|
||
Path to executables are accepted.
|
||
The command is automatically escaped.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">${pkgs.libnotify}/bin/notify-send "Idle" "Resuming activity"
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.timers._.command"></a><a class="term" href="options.html#opt-services.xidlehook.timers._.command"><code class="option">services.xidlehook.timers.*.command</code></a></span></dt><dd><p>Command executed after the idle timeout is reached.
|
||
Path to executables are accepted.
|
||
The command is automatically escaped.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">${pkgs.libnotify}/bin/notify-send "Idle" "Sleeping in 1 minute"
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xidlehook.timers._.delay"></a><a class="term" href="options.html#opt-services.xidlehook.timers._.delay"><code class="option">services.xidlehook.timers.*.delay</code></a></span></dt><dd><p>Time before executing the command.</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">60</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xidlehook.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xidlehook.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xscreensaver.enable"></a><a class="term" href="options.html#opt-services.xscreensaver.enable"><code class="option">services.xscreensaver.enable</code></a></span></dt><dd><p>Whether to enable XScreenSaver.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xscreensaver.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xscreensaver.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xscreensaver.settings"></a><a class="term" href="options.html#opt-services.xscreensaver.settings"><code class="option">services.xscreensaver.settings</code></a></span></dt><dd><p>The settings to use for XScreenSaver.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
fadeTicks = 20; lock = false; mode = "blank";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xscreensaver.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xscreensaver.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsettingsd.enable"></a><a class="term" href="options.html#opt-services.xsettingsd.enable"><code class="option">services.xsettingsd.enable</code></a></span></dt><dd><p>Whether to enable xsettingsd.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsettingsd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsettingsd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsettingsd.package"></a><a class="term" href="options.html#opt-services.xsettingsd.package"><code class="option">services.xsettingsd.package</code></a></span></dt><dd><p>Package containing the <span class="command"><strong>xsettingsd</strong></span> program.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.xsettingsd</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsettingsd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsettingsd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsettingsd.settings"></a><a class="term" href="options.html#opt-services.xsettingsd.settings"><code class="option">services.xsettingsd.settings</code></a></span></dt><dd><p>Xsettingsd options for configuration file. See
|
||
<a class="link" href="https://github.com/derat/xsettingsd/wiki/Settings" target="_top">https://github.com/derat/xsettingsd/wiki/Settings</a>
|
||
for documentation on these values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"Net/ThemeName" = "Numix";
|
||
"Xft/Antialias" = true;
|
||
"Xft/Hinting" = true;
|
||
"Xft/RGBA" = "rgb";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsettingsd.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsettingsd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.enable"></a><a class="term" href="options.html#opt-services.xsuspender.enable"><code class="option">services.xsuspender.enable</code></a></span></dt><dd><p>Whether to enable XSuspender.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.debug"></a><a class="term" href="options.html#opt-services.xsuspender.debug"><code class="option">services.xsuspender.debug</code></a></span></dt><dd><p>Whether to enable debug output.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults"></a><a class="term" href="options.html#opt-services.xsuspender.defaults"><code class="option">services.xsuspender.defaults</code></a></span></dt><dd><p>XSuspender defaults.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.autoSuspendOnBattery"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.autoSuspendOnBattery"><code class="option">services.xsuspender.defaults.autoSuspendOnBattery</code></a></span></dt><dd><p>Whether to auto-apply rules when switching to battery
|
||
power even if the window(s) didn't just lose focus.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.downclockOnBattery"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.downclockOnBattery"><code class="option">services.xsuspender.defaults.downclockOnBattery</code></a></span></dt><dd><p>Limit CPU consumption for this factor when on battery power.
|
||
Value 1 means 50% decrease, 2 means 66%, 3 means 75% etc.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.execResume"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.execResume"><code class="option">services.xsuspender.defaults.execResume</code></a></span></dt><dd><p>Before resuming, execute this shell script. Resume the
|
||
process regardless script failure.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"echo resuming ..."</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.execSuspend"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.execSuspend"><code class="option">services.xsuspender.defaults.execSuspend</code></a></span></dt><dd><p>Before suspending, execute this shell script. If it fails,
|
||
abort suspension.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">''echo "suspending window $XID of process $PID"''</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.matchWmClassContains"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.matchWmClassContains"><code class="option">services.xsuspender.defaults.matchWmClassContains</code></a></span></dt><dd><p>Match windows that wm class contains string.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.matchWmClassGroupContains"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.matchWmClassGroupContains"><code class="option">services.xsuspender.defaults.matchWmClassGroupContains</code></a></span></dt><dd><p>Match windows where wm class group contains string.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.matchWmNameContains"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.matchWmNameContains"><code class="option">services.xsuspender.defaults.matchWmNameContains</code></a></span></dt><dd><p>Match windows where wm name contains string.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.onlyOnBattery"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.onlyOnBattery"><code class="option">services.xsuspender.defaults.onlyOnBattery</code></a></span></dt><dd><p>Whether to enable process suspend only on battery.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.resumeEvery"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.resumeEvery"><code class="option">services.xsuspender.defaults.resumeEvery</code></a></span></dt><dd><p>Resume interval in seconds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">50</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.resumeFor"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.resumeFor"><code class="option">services.xsuspender.defaults.resumeFor</code></a></span></dt><dd><p>Resume duration in seconds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.sendSignals"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.sendSignals"><code class="option">services.xsuspender.defaults.sendSignals</code></a></span></dt><dd><p>Whether to send SIGSTOP / SIGCONT signals or not.
|
||
If false just the exec scripts are run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.suspendDelay"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.suspendDelay"><code class="option">services.xsuspender.defaults.suspendDelay</code></a></span></dt><dd><p>Initial suspend delay in seconds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.defaults.suspendSubtreePattern"></a><a class="term" href="options.html#opt-services.xsuspender.defaults.suspendSubtreePattern"><code class="option">services.xsuspender.defaults.suspendSubtreePattern</code></a></span></dt><dd><p>Also suspend descendant processes that match this regex.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules"></a><a class="term" href="options.html#opt-services.xsuspender.rules"><code class="option">services.xsuspender.rules</code></a></span></dt><dd><p>Attribute set of XSuspender rules.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
Chromium =
|
||
{
|
||
matchWmClassContains = "chromium-browser"; suspendDelay = 10; suspendSubtreePattern = "chromium";
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.autoSuspendOnBattery"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.autoSuspendOnBattery"><code class="option">services.xsuspender.rules.<name>.autoSuspendOnBattery</code></a></span></dt><dd><p>Whether to auto-apply rules when switching to battery
|
||
power even if the window(s) didn't just lose focus.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.downclockOnBattery"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.downclockOnBattery"><code class="option">services.xsuspender.rules.<name>.downclockOnBattery</code></a></span></dt><dd><p>Limit CPU consumption for this factor when on battery power.
|
||
Value 1 means 50% decrease, 2 means 66%, 3 means 75% etc.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.execResume"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.execResume"><code class="option">services.xsuspender.rules.<name>.execResume</code></a></span></dt><dd><p>Before resuming, execute this shell script. Resume the
|
||
process regardless script failure.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"echo resuming ..."</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.execSuspend"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.execSuspend"><code class="option">services.xsuspender.rules.<name>.execSuspend</code></a></span></dt><dd><p>Before suspending, execute this shell script. If it fails,
|
||
abort suspension.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">''echo "suspending window $XID of process $PID"''</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.matchWmClassContains"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.matchWmClassContains"><code class="option">services.xsuspender.rules.<name>.matchWmClassContains</code></a></span></dt><dd><p>Match windows that wm class contains string.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.matchWmClassGroupContains"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.matchWmClassGroupContains"><code class="option">services.xsuspender.rules.<name>.matchWmClassGroupContains</code></a></span></dt><dd><p>Match windows where wm class group contains string.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.matchWmNameContains"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.matchWmNameContains"><code class="option">services.xsuspender.rules.<name>.matchWmNameContains</code></a></span></dt><dd><p>Match windows where wm name contains string.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.onlyOnBattery"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.onlyOnBattery"><code class="option">services.xsuspender.rules.<name>.onlyOnBattery</code></a></span></dt><dd><p>Whether to enable process suspend only on battery.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.resumeEvery"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.resumeEvery"><code class="option">services.xsuspender.rules.<name>.resumeEvery</code></a></span></dt><dd><p>Resume interval in seconds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">50</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.resumeFor"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.resumeFor"><code class="option">services.xsuspender.rules.<name>.resumeFor</code></a></span></dt><dd><p>Resume duration in seconds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.sendSignals"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.sendSignals"><code class="option">services.xsuspender.rules.<name>.sendSignals</code></a></span></dt><dd><p>Whether to send SIGSTOP / SIGCONT signals or not.
|
||
If false just the exec scripts are run.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.suspendDelay"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.suspendDelay"><code class="option">services.xsuspender.rules.<name>.suspendDelay</code></a></span></dt><dd><p>Initial suspend delay in seconds.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.xsuspender.rules._name_.suspendSubtreePattern"></a><a class="term" href="options.html#opt-services.xsuspender.rules._name_.suspendSubtreePattern"><code class="option">services.xsuspender.rules.<name>.suspendSubtreePattern</code></a></span></dt><dd><p>Also suspend descendant processes that match this regex.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/xsuspender.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/xsuspender.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-specialization"></a><a class="term" href="options.html#opt-specialization"><code class="option">specialization</code></a></span></dt><dd><p>A set of named specialized configurations. These can be used to extend
|
||
your base configuration with additional settings. For example, you can
|
||
have specializations named <span class="quote">“<span class="quote">light</span>”</span> and <span class="quote">“<span class="quote">dark</span>”</span>
|
||
that applies light and dark color theme configurations.
|
||
|
||
</p><p>
|
||
|
||
Note, this is an experimental option for now and you therefore have to
|
||
activate the specialization by looking up and running the activation
|
||
script yourself. Note, running the activation script will create a new
|
||
Home Manager generation.
|
||
|
||
</p><p>
|
||
|
||
For example, to activate the <span class="quote">“<span class="quote">dark</span>”</span> specialization. You can
|
||
first look up your current Home Manager generation by running
|
||
|
||
</p><pre class="programlisting console">
|
||
$ home-manager generations | head -1
|
||
2022-05-02 22:49 : id 1758 -> /nix/store/jy…ac-home-manager-generation
|
||
</pre><p>
|
||
|
||
then run
|
||
|
||
</p><pre class="programlisting console">
|
||
$ /nix/store/jy…ac-home-manager-generation/specialization/dark/activate
|
||
Starting Home Manager activation
|
||
…
|
||
</pre><p>
|
||
|
||
</p><p>
|
||
|
||
WARNING! Since this option is experimental, the activation process may
|
||
change in backwards incompatible ways.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/specialization.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/specialization.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-specialization._name_.configuration"></a><a class="term" href="options.html#opt-specialization._name_.configuration"><code class="option">specialization.<name>.configuration</code></a></span></dt><dd><p>Arbitrary Home Manager configuration settings.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/specialization.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/specialization.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.automounts"></a><a class="term" href="options.html#opt-systemd.user.automounts"><code class="option">systemd.user.automounts</code></a></span></dt><dd><p>Definition of systemd per-user automount units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.automount</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd automount unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
automount-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Automount = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.mounts"></a><a class="term" href="options.html#opt-systemd.user.mounts"><code class="option">systemd.user.mounts</code></a></span></dt><dd><p>Definition of systemd per-user mount units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd mount unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
mount-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Mount = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.paths"></a><a class="term" href="options.html#opt-systemd.user.paths"><code class="option">systemd.user.paths</code></a></span></dt><dd><p>Definition of systemd per-user path units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.path</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd path unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
path-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Path = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.services"></a><a class="term" href="options.html#opt-systemd.user.services"><code class="option">systemd.user.services</code></a></span></dt><dd><p>Definition of systemd per-user service units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd service unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
service-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Service = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.servicesStartTimeoutMs"></a><a class="term" href="options.html#opt-systemd.user.servicesStartTimeoutMs"><code class="option">systemd.user.servicesStartTimeoutMs</code></a></span></dt><dd><p>How long to wait for started services to fail until their start is
|
||
considered successful. The value 0 indicates no timeout.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unsigned integer, meaning >=0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">0</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.sessionVariables"></a><a class="term" href="options.html#opt-systemd.user.sessionVariables"><code class="option">systemd.user.sessionVariables</code></a></span></dt><dd><p>Environment variables that will be set for the user session.
|
||
The variable values must be as described in
|
||
<span class="citerefentry"><span class="refentrytitle">environment.d</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
EDITOR = "vim";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.slices"></a><a class="term" href="options.html#opt-systemd.user.slices"><code class="option">systemd.user.slices</code></a></span></dt><dd><p>Definition of systemd per-user slices units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.slices</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd slices unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
slices-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Slices = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.sockets"></a><a class="term" href="options.html#opt-systemd.user.sockets"><code class="option">systemd.user.sockets</code></a></span></dt><dd><p>Definition of systemd per-user socket units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.socket</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd socket unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
socket-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Socket = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.startServices"></a><a class="term" href="options.html#opt-systemd.user.startServices"><code class="option">systemd.user.startServices</code></a></span></dt><dd><p>Whether new or changed services that are wanted by active targets
|
||
should be started. Additionally, stop obsolete services from the
|
||
previous generation.
|
||
</p><p>
|
||
The alternatives are
|
||
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">suggest</code> (or <code class="literal">false</code>)</span></dt><dd><p>
|
||
Use a very simple shell script to print suggested
|
||
<span class="command"><strong>systemctl</strong></span> commands to run. You will have to
|
||
manually run those commands after the switch.
|
||
</p></dd><dt><span class="term"><code class="literal">legacy</code> (or <code class="literal">true</code>)</span></dt><dd><p>
|
||
Use a Ruby script to, in a more robust fashion, determine the
|
||
necessary changes and automatically run the
|
||
<span class="command"><strong>systemctl</strong></span> commands.
|
||
</p></dd><dt><span class="term"><code class="literal">sd-switch</code></span></dt><dd><p>
|
||
Use sd-switch, a third party application, to perform the service
|
||
updates. This tool offers more features while having a small
|
||
closure size. Note, it requires a fully functional user D-Bus
|
||
session. Once tested and deemed sufficiently robust, this will
|
||
become the default.
|
||
</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean or one of "suggest", "legacy", "sd-switch"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"suggest"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.systemctlPath"></a><a class="term" href="options.html#opt-systemd.user.systemctlPath"><code class="option">systemd.user.systemctlPath</code></a></span></dt><dd><p>Absolute path to the <span class="command"><strong>systemctl</strong></span> tool. This
|
||
option may need to be set if running Home Manager on a
|
||
non-NixOS distribution.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.systemd}/bin/systemctl"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.targets"></a><a class="term" href="options.html#opt-systemd.user.targets"><code class="option">systemd.user.targets</code></a></span></dt><dd><p>Definition of systemd per-user target units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.target</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd target unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
target-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Target = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.timers"></a><a class="term" href="options.html#opt-systemd.user.timers"><code class="option">systemd.user.timers</code></a></span></dt><dd><p>Definition of systemd per-user timer units. Attributes are
|
||
merged recursively.
|
||
</p><p>
|
||
Note that the attributes follow the capitalization and naming used
|
||
by systemd. More details can be found in
|
||
<span class="citerefentry"><span class="refentrytitle">systemd.timer</span>(5)</span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> systemd timer unit configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
timer-name = {
|
||
Unit = {
|
||
Description = "Example description";
|
||
Documentation = [ "man:example(1)" "man:example(5)" ];
|
||
};
|
||
|
||
Timer = {
|
||
…
|
||
};
|
||
};
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/systemd.nix#blob-path" target="_top">
|
||
<home-manager/modules/systemd.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-systemd.user.tmpfiles.rules"></a><a class="term" href="options.html#opt-systemd.user.tmpfiles.rules"><code class="option">systemd.user.tmpfiles.rules</code></a></span></dt><dd><p>Rules for creating and cleaning up temporary files
|
||
automatically. See
|
||
<span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span>
|
||
for the exact format.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"L /home/user/Documents - - - - /mnt/data/Documents"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/tmpfiles.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/tmpfiles.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults"></a><a class="term" href="options.html#opt-targets.darwin.defaults"><code class="option">targets.darwin.defaults</code></a></span></dt><dd><p>Set macOS user defaults. Values set to <code class="literal">null</code> are
|
||
ignored.
|
||
|
||
</p><div class="warning"><h3 class="title">Warning</h3><p>
|
||
Some settings might require a re-login to take effect.
|
||
</p></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
com.apple.desktopservices =
|
||
{
|
||
DSDontWriteNetworkStores = true; DSDontWriteUSBStores = true;
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.AppleLanguages"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.AppleLanguages"><code class="option">targets.darwin.defaults.NSGlobalDomain.AppleLanguages</code></a></span></dt><dd><p>Sets the language to use in the preferred order.</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"en"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.AppleLocale"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.AppleLocale"><code class="option">targets.darwin.defaults.NSGlobalDomain.AppleLocale</code></a></span></dt><dd><p>Configures the user locale.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"en_US"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.AppleMeasurementUnits"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.AppleMeasurementUnits"><code class="option">targets.darwin.defaults.NSGlobalDomain.AppleMeasurementUnits</code></a></span></dt><dd><p>Sets the measurement unit.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "Centimeters", "Inches"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Centimeters"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.AppleMetricUnits"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.AppleMetricUnits"><code class="option">targets.darwin.defaults.NSGlobalDomain.AppleMetricUnits</code></a></span></dt><dd><p>Whether to enable the metric system.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.AppleTemperatureUnit"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.AppleTemperatureUnit"><code class="option">targets.darwin.defaults.NSGlobalDomain.AppleTemperatureUnit</code></a></span></dt><dd><p>Sets the temperature unit.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "Celsius", "Fahrenheit"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Celsius"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticCapitalizationEnabled"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticCapitalizationEnabled"><code class="option">targets.darwin.defaults.NSGlobalDomain.NSAutomaticCapitalizationEnabled</code></a></span></dt><dd><p>Whether to enable automatic captilization.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticDashSubstitutionEnabled"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticDashSubstitutionEnabled"><code class="option">targets.darwin.defaults.NSGlobalDomain.NSAutomaticDashSubstitutionEnabled</code></a></span></dt><dd><p>Whether to enable smart dashes.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticPeriodSubstitutionEnabled"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticPeriodSubstitutionEnabled"><code class="option">targets.darwin.defaults.NSGlobalDomain.NSAutomaticPeriodSubstitutionEnabled</code></a></span></dt><dd><p>Whether to enable period with double space.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticQuoteSubstitutionEnabled"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticQuoteSubstitutionEnabled"><code class="option">targets.darwin.defaults.NSGlobalDomain.NSAutomaticQuoteSubstitutionEnabled</code></a></span></dt><dd><p>Whether to enable smart quotes.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticSpellingCorrectionEnabled"></a><a class="term" href="options.html#opt-targets.darwin.defaults.NSGlobalDomain.NSAutomaticSpellingCorrectionEnabled"><code class="option">targets.darwin.defaults.NSGlobalDomain.NSAutomaticSpellingCorrectionEnabled</code></a></span></dt><dd><p>Whether to enable spelling correction.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.AutoFillCreditCardData"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.AutoFillCreditCardData"><code class="option">targets.darwin.defaults.com.apple.Safari.AutoFillCreditCardData</code></a></span></dt><dd><p>Whether to enable autofill of credit card numbers.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.AutoFillPasswords"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.AutoFillPasswords"><code class="option">targets.darwin.defaults.com.apple.Safari.AutoFillPasswords</code></a></span></dt><dd><p>Whether to enable autofill of usernames and passwords.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.AutoOpenSafeDownloads"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.AutoOpenSafeDownloads"><code class="option">targets.darwin.defaults.com.apple.Safari.AutoOpenSafeDownloads</code></a></span></dt><dd><p>Whether to enable opening of downloaded files.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.IncludeDevelopMenu"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.IncludeDevelopMenu"><code class="option">targets.darwin.defaults.com.apple.Safari.IncludeDevelopMenu</code></a></span></dt><dd><p>Whether to enable "Develop" menu in the menu bar.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.ShowOverlayStatusBar"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.ShowOverlayStatusBar"><code class="option">targets.darwin.defaults.com.apple.Safari.ShowOverlayStatusBar</code></a></span></dt><dd><p>Whether to enable status bar.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.WebKitDeveloperExtrasEnabledPreferenceKey"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.WebKitDeveloperExtrasEnabledPreferenceKey"><code class="option">targets.darwin.defaults.com.apple.Safari.WebKitDeveloperExtrasEnabledPreferenceKey</code></a></span></dt><dd><p>Configures the web inspector.
|
||
|
||
</p><div class="warning"><h3 class="title">Warning</h3><p>
|
||
Instead of setting this option directly, set
|
||
<code class="option">IncludeDevelopMenu</code> instead.
|
||
</p></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.WebKitPreferences.developerExtrasEnabled"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.WebKitPreferences.developerExtrasEnabled"><code class="option">targets.darwin.defaults.com.apple.Safari.WebKitPreferences.developerExtrasEnabled</code></a></span></dt><dd><p>Configures the web inspector.
|
||
|
||
</p><div class="warning"><h3 class="title">Warning</h3><p>
|
||
Instead of setting this option directly, set
|
||
<code class="option">IncludeDevelopMenu</code> instead.
|
||
</p></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.Safari.SandboxBroker.ShowDevelopMenu"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.Safari.SandboxBroker.ShowDevelopMenu"><code class="option">targets.darwin.defaults.com.apple.Safari.SandboxBroker.ShowDevelopMenu</code></a></span></dt><dd><p>Show the "Develop" menu in Safari's menubar.
|
||
|
||
</p><div class="warning"><h3 class="title">Warning</h3><p>
|
||
Instead of setting this option directly, set
|
||
<code class="option">"com.apple.Safari".IncludeDevelopMenu</code> instead.
|
||
</p></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.desktopservices.DSDontWriteNetworkStores"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.desktopservices.DSDontWriteNetworkStores"><code class="option">targets.darwin.defaults.com.apple.desktopservices.DSDontWriteNetworkStores</code></a></span></dt><dd><p>Disable use of <code class="filename">.DS_Store</code> files on network shares.
|
||
See <a class="link" href="https://support.apple.com/en-us/HT208209" target="_top">the
|
||
official article</a> for more info.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.desktopservices.DSDontWriteUSBStores"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.desktopservices.DSDontWriteUSBStores"><code class="option">targets.darwin.defaults.com.apple.desktopservices.DSDontWriteUSBStores</code></a></span></dt><dd><p>Disable use of <code class="filename">.DS_Store</code> files on thumb drives.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.dock.expose-group-apps"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.dock.expose-group-apps"><code class="option">targets.darwin.defaults.com.apple.dock.expose-group-apps</code></a></span></dt><dd><p>Whether to enable grouping of windows by application in Mission Control.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.dock.size-immutable"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.dock.size-immutable"><code class="option">targets.darwin.defaults.com.apple.dock.size-immutable</code></a></span></dt><dd><p>Whether to enable locking of the dock size.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.dock.tilesize"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.dock.tilesize"><code class="option">targets.darwin.defaults.com.apple.dock.tilesize</code></a></span></dt><dd><p>Sets the size of the dock.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">64</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.apple.menuextra.battery.ShowPercent"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.apple.menuextra.battery.ShowPercent"><code class="option">targets.darwin.defaults.com.apple.menuextra.battery.ShowPercent</code></a></span></dt><dd><p>This option no longer works on macOS 11 and later. Instead, open System
|
||
Preferences, go to "Dock & Menu Bar", select "Battery", and toggle
|
||
the checkbox labeled "Show Percentage."
|
||
|
||
Whether to show battery percentage in the menu bar.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or one of "YES", "NO"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"NO"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.googlecode.iterm2.AddNewTabAtEndOfTabs"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.googlecode.iterm2.AddNewTabAtEndOfTabs"><code class="option">targets.darwin.defaults.com.googlecode.iterm2.AddNewTabAtEndOfTabs</code></a></span></dt><dd><p>Whether to enable placement of new tabs at the end of the tab bar.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.googlecode.iterm2.AlternateMouseScroll"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.googlecode.iterm2.AlternateMouseScroll"><code class="option">targets.darwin.defaults.com.googlecode.iterm2.AlternateMouseScroll</code></a></span></dt><dd><p>Whether to enable arrow keys when scrolling in alternate screen mode.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.googlecode.iterm2.CopySelection"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.googlecode.iterm2.CopySelection"><code class="option">targets.darwin.defaults.com.googlecode.iterm2.CopySelection</code></a></span></dt><dd><p>Whether to enable copy to clipboard upon selecting text.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.googlecode.iterm2.ExperimentalKeyHandling"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.googlecode.iterm2.ExperimentalKeyHandling"><code class="option">targets.darwin.defaults.com.googlecode.iterm2.ExperimentalKeyHandling</code></a></span></dt><dd><p>Whether to enable experimental key handling for AquaSKK compatibility.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.defaults.com.googlecode.iterm2.OpenTmuxWindowsIn"></a><a class="term" href="options.html#opt-targets.darwin.defaults.com.googlecode.iterm2.OpenTmuxWindowsIn"><code class="option">targets.darwin.defaults.com.googlecode.iterm2.OpenTmuxWindowsIn</code></a></span></dt><dd><p>Configures how to restore tmux windows when attaching to a session.
|
||
|
||
</p><div class="variablelist"><p class="title"><strong>Possible Values</strong></p><dl class="variablelist"><dt><span class="term"><code class="literal">0</code></span></dt><dd><p>Native windows</p></dd><dt><span class="term"><code class="literal">1</code></span></dt><dd><p>Native tabs in a new window</p></dd><dt><span class="term"><code class="literal">2</code></span></dt><dd><p>Tabs in the attaching window</p></dd></dl></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/options.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/options.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.keybindings"></a><a class="term" href="options.html#opt-targets.darwin.keybindings"><code class="option">targets.darwin.keybindings</code></a></span></dt><dd><p>This will configure the default keybindings for text fields in macOS
|
||
applications. See
|
||
<a class="link" href="https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/EventOverview/TextDefaultsBindings/TextDefaultsBindings.html" target="_top">Apple's documentation</a>
|
||
for more details.
|
||
|
||
</p><div class="warning"><h3 class="title">Warning</h3><p>
|
||
Existing keybinding configuration will be wiped when using this
|
||
option.
|
||
</p></div><p>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of anything</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
^u = "deleteToBeginningOfLine:"; ^w = "deleteWordBackward:";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/keybindings.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/keybindings.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.darwin.search"></a><a class="term" href="options.html#opt-targets.darwin.search"><code class="option">targets.darwin.search</code></a></span></dt><dd><p>Default search engine.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "Bing", "DuckDuckGo", "Ecosia", "Google", "Yahoo"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/darwin/search.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/darwin/search.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-targets.genericLinux.enable"></a><a class="term" href="options.html#opt-targets.genericLinux.enable"><code class="option">targets.genericLinux.enable</code></a></span></dt><dd><p>Whether to enable settings that make Home Manager work better on
|
||
GNU/Linux distributions other than NixOS.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/targets/generic-linux.nix#blob-path" target="_top">
|
||
<home-manager/modules/targets/generic-linux.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.enable"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.enable"><code class="option">wayland.windowManager.sway.enable</code></a></span></dt><dd><p>Whether to enable sway wayland compositor.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.package"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.package"><code class="option">wayland.windowManager.sway.package</code></a></span></dt><dd><p>Sway package to use. Will override the options
|
||
'wrapperFeatures', 'extraSessionCommands', and 'extraOptions'.
|
||
Set to <code class="code">null</code> to not add any Sway package to your
|
||
path. This should be done if you want to use the NixOS Sway
|
||
module to install Sway.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">${pkgs.sway}</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config"><code class="option">wayland.windowManager.sway.config</code></a></span></dt><dd><p>Sway configuration options.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.assigns"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.assigns"><code class="option">wayland.windowManager.sway.config.assigns</code></a></span></dt><dd><p>An attribute set that assigns applications to workspaces based
|
||
on criteria.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of list of attribute set of string or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"1: web" = [{ class = "^Firefox$"; }];
|
||
"0: extra" = [{ class = "^Firefox$"; window_role = "About"; }];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars"><code class="option">wayland.windowManager.sway.config.bars</code></a></span></dt><dd><p>Sway bars settings blocks. Set to empty list to remove bars completely.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">see code</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors"><code class="option">wayland.windowManager.sway.config.bars.*.colors</code></a></span></dt><dd><p>Bar color settings. All color classes can be specified using submodules
|
||
with 'border', 'background', 'text', fields and RGB color hex-codes as values.
|
||
See default values for the reference.
|
||
Note that 'background', 'status', and 'separator' parameters take a single RGB value.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_colors" target="_top">https://i3wm.org/docs/userguide.html#_colors</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.activeWorkspace"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.activeWorkspace"><code class="option">wayland.windowManager.sway.config.bars.*.colors.activeWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace is active.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#5f676a"; border = "#333333"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.background"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.background"><code class="option">wayland.windowManager.sway.config.bars.*.colors.background</code></a></span></dt><dd><p>Background color of the bar.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#000000"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.bindingMode"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.bindingMode"><code class="option">wayland.windowManager.sway.config.bars.*.colors.bindingMode</code></a></span></dt><dd><p>Border, background and text color for the binding mode indicator</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#900000"; border = "#2f343a"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.focusedBackground"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.focusedBackground"><code class="option">wayland.windowManager.sway.config.bars.*.colors.focusedBackground</code></a></span></dt><dd><p>Background color of the bar on the currently focused monitor output.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#000000"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.focusedSeparator"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.focusedSeparator"><code class="option">wayland.windowManager.sway.config.bars.*.colors.focusedSeparator</code></a></span></dt><dd><p>Text color to be used for the separator on the currently focused monitor output.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#666666"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.focusedStatusline"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.focusedStatusline"><code class="option">wayland.windowManager.sway.config.bars.*.colors.focusedStatusline</code></a></span></dt><dd><p>Text color to be used for the statusline on the currently focused monitor output.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.focusedWorkspace"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.focusedWorkspace"><code class="option">wayland.windowManager.sway.config.bars.*.colors.focusedWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace has focus.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#285577"; border = "#4c7899"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.inactiveWorkspace"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.inactiveWorkspace"><code class="option">wayland.windowManager.sway.config.bars.*.colors.inactiveWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace does not
|
||
have focus and is not active.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#222222"; border = "#333333"; text = "#888888";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.separator"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.separator"><code class="option">wayland.windowManager.sway.config.bars.*.colors.separator</code></a></span></dt><dd><p>Text color to be used for the separator.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#666666"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.statusline"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.statusline"><code class="option">wayland.windowManager.sway.config.bars.*.colors.statusline</code></a></span></dt><dd><p>Text color to be used for the statusline.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.colors.urgentWorkspace"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.colors.urgentWorkspace"><code class="option">wayland.windowManager.sway.config.bars.*.colors.urgentWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace contains
|
||
a window with the urgency hint set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#900000"; border = "#2f343a"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.command"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.command"><code class="option">wayland.windowManager.sway.config.bars.*.command</code></a></span></dt><dd><p>Command that will be used to start a bar.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"i3bar"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.waybar}/bin/waybar"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.extraConfig"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.extraConfig"><code class="option">wayland.windowManager.sway.config.bars.*.extraConfig</code></a></span></dt><dd><p>Extra configuration lines for this bar.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.fonts"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.fonts"><code class="option">wayland.windowManager.sway.config.bars.*.fonts</code></a></span></dt><dd><p>Font configuration for this bar.</p><p><span class="emphasis"><em>Type:</em></span> list of string or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
|
||
style = "Bold Semi-Condensed";
|
||
size = 11.0;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.hiddenState"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.hiddenState"><code class="option">wayland.windowManager.sway.config.bars.*.hiddenState</code></a></span></dt><dd><p>The default bar mode when 'bar.mode' == 'hide'.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "hide", "show"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"hide"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.id"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.id"><code class="option">wayland.windowManager.sway.config.bars.*.id</code></a></span></dt><dd><p>Specifies the bar ID for the configured bar instance.
|
||
If this option is missing, the ID is set to bar-x, where x corresponds
|
||
to the position of the embedding bar block in the config file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.mode"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.mode"><code class="option">wayland.windowManager.sway.config.bars.*.mode</code></a></span></dt><dd><p>Bar visibility mode.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "dock", "hide", "invisible"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"dock"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.position"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.position"><code class="option">wayland.windowManager.sway.config.bars.*.position</code></a></span></dt><dd><p>The edge of the screen swaybar should show up.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "top", "bottom"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"bottom"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.statusCommand"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.statusCommand"><code class="option">wayland.windowManager.sway.config.bars.*.statusCommand</code></a></span></dt><dd><p>Command that will be used to get status lines.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.i3status}/bin/i3status"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.trayOutput"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.trayOutput"><code class="option">wayland.windowManager.sway.config.bars.*.trayOutput</code></a></span></dt><dd><p>Where to output tray.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"primary"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.workspaceButtons"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.workspaceButtons"><code class="option">wayland.windowManager.sway.config.bars.*.workspaceButtons</code></a></span></dt><dd><p>Whether workspace buttons should be shown or not.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bars._.workspaceNumbers"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bars._.workspaceNumbers"><code class="option">wayland.windowManager.sway.config.bars.*.workspaceNumbers</code></a></span></dt><dd><p>Whether workspace numbers should be displayed within the workspace buttons.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.bindkeysToCode"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.bindkeysToCode"><code class="option">wayland.windowManager.sway.config.bindkeysToCode</code></a></span></dt><dd><p>Whether to make use of <code class="option">--to-code</code> in keybindings.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors"><code class="option">wayland.windowManager.sway.config.colors</code></a></span></dt><dd><p>Color settings. All color classes can be specified using submodules
|
||
with 'border', 'background', 'text', 'indicator' and 'childBorder' fields
|
||
and RGB color hex-codes as values. See default values for the reference.
|
||
Note that 'sway.config.colors.background' parameter takes a single RGB value.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_changing_colors" target="_top">https://i3wm.org/docs/userguide.html#_changing_colors</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors.background"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors.background"><code class="option">wayland.windowManager.sway.config.colors.background</code></a></span></dt><dd><p>Background color of the window. Only applications which do not cover
|
||
the whole area expose the color.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors.focused"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors.focused"><code class="option">wayland.windowManager.sway.config.colors.focused</code></a></span></dt><dd><p>A window which currently has the focus.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#285577"; border = "#4c7899"; childBorder = "#285577"; indicator = "#2e9ef4"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors.focusedInactive"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors.focusedInactive"><code class="option">wayland.windowManager.sway.config.colors.focusedInactive</code></a></span></dt><dd><p>A window which is the focused one of its container,
|
||
but it does not have the focus at the moment.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#5f676a"; border = "#333333"; childBorder = "#5f676a"; indicator = "#484e50"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors.placeholder"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors.placeholder"><code class="option">wayland.windowManager.sway.config.colors.placeholder</code></a></span></dt><dd><p>Background and text color are used to draw placeholder window
|
||
contents (when restoring layouts). Border and indicator are ignored.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#0c0c0c"; border = "#000000"; childBorder = "#0c0c0c"; indicator = "#000000"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors.unfocused"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors.unfocused"><code class="option">wayland.windowManager.sway.config.colors.unfocused</code></a></span></dt><dd><p>A window which is not focused.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#222222"; border = "#333333"; childBorder = "#222222"; indicator = "#292d2e"; text = "#888888";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.colors.urgent"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.colors.urgent"><code class="option">wayland.windowManager.sway.config.colors.urgent</code></a></span></dt><dd><p>A window which has its urgency hint activated.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#900000"; border = "#2f343a"; childBorder = "#900000"; indicator = "#900000"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.defaultWorkspace"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.defaultWorkspace"><code class="option">wayland.windowManager.sway.config.defaultWorkspace</code></a></span></dt><dd><p>The default workspace to show when sway is launched.
|
||
This must to correspond to the value of the keybinding of the default workspace.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"workspace number 9"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.down"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.down"><code class="option">wayland.windowManager.sway.config.down</code></a></span></dt><dd><p>Home row direction key for moving down.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"j"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.floating"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.floating"><code class="option">wayland.windowManager.sway.config.floating</code></a></span></dt><dd><p>Floating window settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.floating.border"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.floating.border"><code class="option">wayland.windowManager.sway.config.floating.border</code></a></span></dt><dd><p>Floating windows border width.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.floating.criteria"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.floating.criteria"><code class="option">wayland.windowManager.sway.config.floating.criteria</code></a></span></dt><dd><p>List of criteria for windows that should be opened in a floating mode.</p><p><span class="emphasis"><em>Type:</em></span> list of attribute set of string or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
title = "Steam - Update News";
|
||
}
|
||
|
||
{
|
||
class = "Pavucontrol";
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.floating.modifier"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.floating.modifier"><code class="option">wayland.windowManager.sway.config.floating.modifier</code></a></span></dt><dd><p>Modifier key that can be used to drag floating windows.</p><p><span class="emphasis"><em>Type:</em></span> one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"sway.config.modifier"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Mod4"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.floating.titlebar"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.floating.titlebar"><code class="option">wayland.windowManager.sway.config.floating.titlebar</code></a></span></dt><dd><p>Whether to show floating window titlebars.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"false"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.focus"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.focus"><code class="option">wayland.windowManager.sway.config.focus</code></a></span></dt><dd><p>Focus related settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.focus.followMouse"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.focus.followMouse"><code class="option">wayland.windowManager.sway.config.focus.followMouse</code></a></span></dt><dd><p>Whether focus should follow the mouse.</p><p><span class="emphasis"><em>Type:</em></span> one of "yes", "no", "always" or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"yes"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.focus.forceWrapping"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.focus.forceWrapping"><code class="option">wayland.windowManager.sway.config.focus.forceWrapping</code></a></span></dt><dd><p>Whether to force focus wrapping in tabbed or stacked container.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_focus_wrapping" target="_top">https://i3wm.org/docs/userguide.html#_focus_wrapping</a>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.focus.mouseWarping"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.focus.mouseWarping"><code class="option">wayland.windowManager.sway.config.focus.mouseWarping</code></a></span></dt><dd><p>Whether mouse cursor should be warped to the center of the window when switching focus
|
||
to a window on a different output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.focus.newWindow"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.focus.newWindow"><code class="option">wayland.windowManager.sway.config.focus.newWindow</code></a></span></dt><dd><p>This option modifies focus behavior on new window activation.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#focus_on_window_activation" target="_top">https://i3wm.org/docs/userguide.html#focus_on_window_activation</a>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "smart", "urgent", "focus", "none"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"smart"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.fonts"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.fonts"><code class="option">wayland.windowManager.sway.config.fonts</code></a></span></dt><dd><p>Font configuration for window titles, nagbar...</p><p><span class="emphasis"><em>Type:</em></span> list of string or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
|
||
style = "Bold Semi-Condensed";
|
||
size = 11.0;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps"><code class="option">wayland.windowManager.sway.config.gaps</code></a></span></dt><dd><p>Gaps related settings.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.bottom"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.bottom"><code class="option">wayland.windowManager.sway.config.gaps.bottom</code></a></span></dt><dd><p>Bottom gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.horizontal"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.horizontal"><code class="option">wayland.windowManager.sway.config.gaps.horizontal</code></a></span></dt><dd><p>Horizontal gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.inner"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.inner"><code class="option">wayland.windowManager.sway.config.gaps.inner</code></a></span></dt><dd><p>Inner gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">12</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.left"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.left"><code class="option">wayland.windowManager.sway.config.gaps.left</code></a></span></dt><dd><p>Left gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.outer"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.outer"><code class="option">wayland.windowManager.sway.config.gaps.outer</code></a></span></dt><dd><p>Outer gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.right"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.right"><code class="option">wayland.windowManager.sway.config.gaps.right</code></a></span></dt><dd><p>Right gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.smartBorders"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.smartBorders"><code class="option">wayland.windowManager.sway.config.gaps.smartBorders</code></a></span></dt><dd><p>This option controls whether to disable container borders on
|
||
workspace with a single container.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "on", "off", "no_gaps"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"off"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.smartGaps"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.smartGaps"><code class="option">wayland.windowManager.sway.config.gaps.smartGaps</code></a></span></dt><dd><p>This option controls whether to disable all gaps (outer and inner)
|
||
on workspace with a single container.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.top"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.top"><code class="option">wayland.windowManager.sway.config.gaps.top</code></a></span></dt><dd><p>Top gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.gaps.vertical"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.gaps.vertical"><code class="option">wayland.windowManager.sway.config.gaps.vertical</code></a></span></dt><dd><p>Vertical gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.input"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.input"><code class="option">wayland.windowManager.sway.config.input</code></a></span></dt><dd><p>An attribute set that defines input modules. See
|
||
<span class="citerefentry"><span class="refentrytitle">sway-input</span>(5)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
* =
|
||
{
|
||
xkb_variant = "dvorak";
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.keybindings"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.keybindings"><code class="option">wayland.windowManager.sway.config.keybindings</code></a></span></dt><dd><p>An attribute set that assigns a key press to an action using a key symbol.
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#keybindings" target="_top">https://i3wm.org/docs/userguide.html#keybindings</a>.
|
||
</p><p>
|
||
Consider to use <code class="code">lib.mkOptionDefault</code> function to extend or override
|
||
default keybindings instead of specifying all of them from scratch.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Default sway keybindings."</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">let
|
||
modifier = config.wayland.windowManager.sway.config.modifier;
|
||
in lib.mkOptionDefault {
|
||
"${modifier}+Return" = "exec ${pkgs.rxvt-unicode-unwrapped}/bin/urxvt";
|
||
"${modifier}+Shift+q" = "kill";
|
||
"${modifier}+d" = "exec ${pkgs.dmenu}/bin/dmenu_path | ${pkgs.dmenu}/bin/dmenu | ${pkgs.findutils}/bin/xargs swaymsg exec --";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.keycodebindings"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.keycodebindings"><code class="option">wayland.windowManager.sway.config.keycodebindings</code></a></span></dt><dd><p>An attribute set that assigns keypress to an action using key code.
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#keybindings" target="_top">https://i3wm.org/docs/userguide.html#keybindings</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
214 = "exec /bin/script.sh";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.left"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.left"><code class="option">wayland.windowManager.sway.config.left</code></a></span></dt><dd><p>Home row direction key for moving left.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"h"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.menu"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.menu"><code class="option">wayland.windowManager.sway.config.menu</code></a></span></dt><dd><p>Default launcher to use.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.dmenu}/bin/dmenu_path | \${pkgs.dmenu}/bin/dmenu | \${pkgs.findutils}/bin/xargs swaymsg exec --"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"bemenu-run"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.modes"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.modes"><code class="option">wayland.windowManager.sway.config.modes</code></a></span></dt><dd><p>An attribute set that defines binding modes and keybindings
|
||
inside them
|
||
|
||
Only basic keybinding is supported (bindsym keycomb action),
|
||
for more advanced setup use 'sway.extraConfig'.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
resize =
|
||
{
|
||
Down = "resize grow height 10 px"; Escape = "mode default"; Left = "resize shrink width 10 px"; Return = "mode default"; Right = "resize grow width 10 px"; Up = "resize shrink height 10 px"; h = "resize shrink width 10 px"; j = "resize grow height 10 px"; k = "resize shrink height 10 px"; l = "resize grow width 10 px";
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.modifier"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.modifier"><code class="option">wayland.windowManager.sway.config.modifier</code></a></span></dt><dd><p>Modifier key that is used for all default keybindings.</p><p><span class="emphasis"><em>Type:</em></span> one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Mod1"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Mod4"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.output"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.output"><code class="option">wayland.windowManager.sway.config.output</code></a></span></dt><dd><p>An attribute set that defines output modules. See
|
||
<span class="citerefentry"><span class="refentrytitle">sway-output</span>(5)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
HDMI-A-2 =
|
||
{
|
||
bg = "~/path/to/background.png fill";
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.right"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.right"><code class="option">wayland.windowManager.sway.config.right</code></a></span></dt><dd><p>Home row direction key for moving right.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"l"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.seat"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.seat"><code class="option">wayland.windowManager.sway.config.seat</code></a></span></dt><dd><p>An attribute set that defines seat modules. See
|
||
<span class="citerefentry"><span class="refentrytitle">sway-input</span>(5)</span>
|
||
for options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
* =
|
||
{
|
||
hide_cursor = "when-typing enable";
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.startup"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.startup"><code class="option">wayland.windowManager.sway.config.startup</code></a></span></dt><dd><p>Commands that should be executed at startup.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup" target="_top">https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ command = "systemctl --user restart waybar"; always = true; }
|
||
{ command = "dropbox start"; }
|
||
{ command = "firefox"; }
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.startup._.always"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.startup._.always"><code class="option">wayland.windowManager.sway.config.startup.*.always</code></a></span></dt><dd><p>Whether to run command on each sway restart.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.startup._.command"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.startup._.command"><code class="option">wayland.windowManager.sway.config.startup.*.command</code></a></span></dt><dd><p>Command that will be executed on startup.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.terminal"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.terminal"><code class="option">wayland.windowManager.sway.config.terminal</code></a></span></dt><dd><p>Default terminal to run.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.rxvt-unicode-unwrapped}/bin/urxvt"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"alacritty"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.up"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.up"><code class="option">wayland.windowManager.sway.config.up</code></a></span></dt><dd><p>Home row direction key for moving up.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"k"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window"><code class="option">wayland.windowManager.sway.config.window</code></a></span></dt><dd><p>Window titlebar and border settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window.border"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window.border"><code class="option">wayland.windowManager.sway.config.window.border</code></a></span></dt><dd><p>Window border width.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window.commands"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window.commands"><code class="option">wayland.windowManager.sway.config.window.commands</code></a></span></dt><dd><p>List of commands that should be executed on specific windows.
|
||
See <code class="option">for_window</code> swaywm option documentation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
command = "border pixel 1"; criteria =
|
||
{
|
||
class = "XTerm";
|
||
}
|
||
;
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window.commands._.command"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window.commands._.command"><code class="option">wayland.windowManager.sway.config.window.commands.*.command</code></a></span></dt><dd><p>Swaywm command to execute.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"border pixel 1"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window.commands._.criteria"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window.commands._.criteria"><code class="option">wayland.windowManager.sway.config.window.commands.*.criteria</code></a></span></dt><dd><p>Criteria of the windows on which command should be executed.
|
||
</p><p>
|
||
A value of <code class="literal">true</code> is equivalent to using an empty
|
||
criteria (which is different from an empty string criteria).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
title = "x200: ~/work";
|
||
floating = true;
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window.hideEdgeBorders"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window.hideEdgeBorders"><code class="option">wayland.windowManager.sway.config.window.hideEdgeBorders</code></a></span></dt><dd><p>Hide window borders adjacent to the screen edges.</p><p><span class="emphasis"><em>Type:</em></span> one of "none", "vertical", "horizontal", "both", "smart"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.window.titlebar"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.window.titlebar"><code class="option">wayland.windowManager.sway.config.window.titlebar</code></a></span></dt><dd><p>Whether to show window titlebars.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"false"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.workspaceAutoBackAndForth"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.workspaceAutoBackAndForth"><code class="option">wayland.windowManager.sway.config.workspaceAutoBackAndForth</code></a></span></dt><dd><p>Assume you are on workspace "1: www" and switch to "2: IM" using
|
||
mod+2 because somebody sent you a message. You don’t need to remember
|
||
where you came from now, you can just press $mod+2 again to switch
|
||
back to "1: www".
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.workspaceLayout"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.workspaceLayout"><code class="option">wayland.windowManager.sway.config.workspaceLayout</code></a></span></dt><dd><p>The mode in which new containers on workspace level will
|
||
start.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "default", "stacking", "tabbed"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"default"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"tabbed"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.workspaceOutputAssign"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.workspaceOutputAssign"><code class="option">wayland.windowManager.sway.config.workspaceOutputAssign</code></a></span></dt><dd><p>Assign workspaces to outputs.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.workspaceOutputAssign._.output"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.workspaceOutputAssign._.output"><code class="option">wayland.windowManager.sway.config.workspaceOutputAssign.*.output</code></a></span></dt><dd><p>Name of the output from <span class="command"><strong>
|
||
swaymsg -t get_outputs
|
||
</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"eDP"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.config.workspaceOutputAssign._.workspace"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.config.workspaceOutputAssign._.workspace"><code class="option">wayland.windowManager.sway.config.workspaceOutputAssign.*.workspace</code></a></span></dt><dd><p>Name of the workspace to assign.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Web"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.extraConfig"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.extraConfig"><code class="option">wayland.windowManager.sway.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to ~/.config/sway/config.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.extraOptions"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.extraOptions"><code class="option">wayland.windowManager.sway.extraOptions</code></a></span></dt><dd><p>Command line arguments passed to launch Sway. Please DO NOT report
|
||
issues if you use an unsupported GPU (proprietary drivers).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"--verbose" "--debug" "--unsupported-gpu" "--my-next-gpu-wont-be-nvidia"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.extraSessionCommands"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.extraSessionCommands"><code class="option">wayland.windowManager.sway.extraSessionCommands</code></a></span></dt><dd><p>Shell commands executed just before Sway is started.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
export SDL_VIDEODRIVER=wayland
|
||
# needs qt5.qtwayland in systemPackages
|
||
export QT_QPA_PLATFORM=wayland
|
||
export QT_WAYLAND_DISABLE_WINDOWDECORATION="1"
|
||
# Fix for some Java AWT applications (e.g. Android Studio),
|
||
# use this if they aren't displayed properly:
|
||
export _JAVA_AWT_WM_NONREPARENTING=1
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.swaynag.enable"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.swaynag.enable"><code class="option">wayland.windowManager.sway.swaynag.enable</code></a></span></dt><dd><p>Whether to enable configuration of swaynag, a lightweight error bar for sway.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/swaynag.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/swaynag.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.swaynag.settings"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.swaynag.settings"><code class="option">wayland.windowManager.sway.swaynag.settings</code></a></span></dt><dd><p>Configuration written to
|
||
<code class="filename">$XDG_CONFIG_HOME/swaynag/config</code>.
|
||
</p><p>
|
||
See
|
||
<span class="citerefentry"><span class="refentrytitle">swaynag</span>(5)</span>
|
||
for a list of avaliable options and an example configuration.
|
||
Note, configurations declared under <code class="literal"><config></code>
|
||
will override the default type values of swaynag.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of Swaynag config atom (null, bool, int, float, str)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"<config>" = {
|
||
edge = "bottom";
|
||
font = "Dina 12";
|
||
};
|
||
|
||
green = {
|
||
edge = "top";
|
||
background = "00AA00";
|
||
text = "FFFFFF";
|
||
button-background = "00CC00";
|
||
message-padding = 10;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/swaynag.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/swaynag.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.systemdIntegration"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.systemdIntegration"><code class="option">wayland.windowManager.sway.systemdIntegration</code></a></span></dt><dd><p>Whether to enable <code class="filename">sway-session.target</code> on
|
||
sway startup. This links to
|
||
<code class="filename">graphical-session.target</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.wrapperFeatures"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.wrapperFeatures"><code class="option">wayland.windowManager.sway.wrapperFeatures</code></a></span></dt><dd><p>Attribute set of features to enable in the wrapper.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
gtk = true;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.wrapperFeatures.base"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.wrapperFeatures.base"><code class="option">wayland.windowManager.sway.wrapperFeatures.base</code></a></span></dt><dd><p>Whether to make use of the base wrapper to execute extra session commands and prepend a
|
||
dbus-run-session to the sway command.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.wrapperFeatures.gtk"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.wrapperFeatures.gtk"><code class="option">wayland.windowManager.sway.wrapperFeatures.gtk</code></a></span></dt><dd><p>Whether to make use of the wrapGAppsHook wrapper to execute sway with required environment
|
||
variables for GTK applications.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-wayland.windowManager.sway.xwayland"></a><a class="term" href="options.html#opt-wayland.windowManager.sway.xwayland"><code class="option">wayland.windowManager.sway.xwayland</code></a></span></dt><dd><p>Enable xwayland, which is needed for the default configuration of sway.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/sway.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/sway.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.enable"></a><a class="term" href="options.html#opt-xdg.enable"><code class="option">xdg.enable</code></a></span></dt><dd><p>Whether to enable management of XDG base directories.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.cacheHome"></a><a class="term" href="options.html#opt-xdg.cacheHome"><code class="option">xdg.cacheHome</code></a></span></dt><dd><p>Absolute path to directory holding application caches.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.cache"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile"></a><a class="term" href="options.html#opt-xdg.configFile"><code class="option">xdg.configFile</code></a></span></dt><dd><p>Attribute set of files to link into the user's XDG
|
||
configuration home.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.executable"></a><a class="term" href="options.html#opt-xdg.configFile._name_.executable"><code class="option">xdg.configFile.<name>.executable</code></a></span></dt><dd><p>Set the execute bit. If <code class="literal">null</code>, defaults to the mode
|
||
of the <code class="varname">source</code> file or to <code class="literal">false</code>
|
||
for files created through the <code class="varname">text</code> option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.onChange"></a><a class="term" href="options.html#opt-xdg.configFile._name_.onChange"><code class="option">xdg.configFile.<name>.onChange</code></a></span></dt><dd><p>Shell commands to run when file has changed between
|
||
generations. The script will be run
|
||
<span class="emphasis"><em>after</em></span> the new files have been linked
|
||
into place.
|
||
</p><p>
|
||
Note, this code is always run when <code class="literal">recursive</code> is
|
||
enabled.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.recursive"></a><a class="term" href="options.html#opt-xdg.configFile._name_.recursive"><code class="option">xdg.configFile.<name>.recursive</code></a></span></dt><dd><p>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.
|
||
</p><p>
|
||
If <code class="literal">false</code> (the default) then the target
|
||
will be a symbolic link to the source directory. If
|
||
<code class="literal">true</code> 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.source"></a><a class="term" href="options.html#opt-xdg.configFile._name_.source"><code class="option">xdg.configFile.<name>.source</code></a></span></dt><dd><p>Path of the source file or directory. If
|
||
<a class="link" href="options.html#opt-home.file._name_.text">home.file.<name?>.text</a>
|
||
is non-null then this option will automatically point to a file
|
||
containing that text.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.target"></a><a class="term" href="options.html#opt-xdg.configFile._name_.target"><code class="option">xdg.configFile.<name>.target</code></a></span></dt><dd><p>Path to target file relative to <code class="varname">xdg.configHome</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><name></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.text"></a><a class="term" href="options.html#opt-xdg.configFile._name_.text"><code class="option">xdg.configFile.<name>.text</code></a></span></dt><dd><p>Text of the file. If this option is null then
|
||
<a class="link" href="options.html#opt-home.file._name_.source">home.file.<name?>.source</a>
|
||
must be set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configHome"></a><a class="term" href="options.html#opt-xdg.configHome"><code class="option">xdg.configHome</code></a></span></dt><dd><p>Absolute path to directory holding application configurations.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.config"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile"></a><a class="term" href="options.html#opt-xdg.dataFile"><code class="option">xdg.dataFile</code></a></span></dt><dd><p>Attribute set of files to link into the user's XDG
|
||
data home.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.executable"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.executable"><code class="option">xdg.dataFile.<name>.executable</code></a></span></dt><dd><p>Set the execute bit. If <code class="literal">null</code>, defaults to the mode
|
||
of the <code class="varname">source</code> file or to <code class="literal">false</code>
|
||
for files created through the <code class="varname">text</code> option.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.onChange"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.onChange"><code class="option">xdg.dataFile.<name>.onChange</code></a></span></dt><dd><p>Shell commands to run when file has changed between
|
||
generations. The script will be run
|
||
<span class="emphasis"><em>after</em></span> the new files have been linked
|
||
into place.
|
||
</p><p>
|
||
Note, this code is always run when <code class="literal">recursive</code> is
|
||
enabled.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.recursive"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.recursive"><code class="option">xdg.dataFile.<name>.recursive</code></a></span></dt><dd><p>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.
|
||
</p><p>
|
||
If <code class="literal">false</code> (the default) then the target
|
||
will be a symbolic link to the source directory. If
|
||
<code class="literal">true</code> 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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.source"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.source"><code class="option">xdg.dataFile.<name>.source</code></a></span></dt><dd><p>Path of the source file or directory. If
|
||
<a class="link" href="options.html#opt-home.file._name_.text">home.file.<name?>.text</a>
|
||
is non-null then this option will automatically point to a file
|
||
containing that text.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.target"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.target"><code class="option">xdg.dataFile.<name>.target</code></a></span></dt><dd><p>Path to target file relative to <code class="varname">xdg.dataHome</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><name></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.text"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.text"><code class="option">xdg.dataFile.<name>.text</code></a></span></dt><dd><p>Text of the file. If this option is null then
|
||
<a class="link" href="options.html#opt-home.file._name_.source">home.file.<name?>.source</a>
|
||
must be set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataHome"></a><a class="term" href="options.html#opt-xdg.dataHome"><code class="option">xdg.dataHome</code></a></span></dt><dd><p>Absolute path to directory holding application data.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.local/share"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries"></a><a class="term" href="options.html#opt-xdg.desktopEntries"><code class="option">xdg.desktopEntries</code></a></span></dt><dd><p>Desktop Entries allow applications to be shown in your desktop environment's app launcher. </p><p>
|
||
You can define entries for programs without entries or override existing entries. </p><p>
|
||
See <a class="link" href="https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys" target="_top">https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys</a> for more information on options.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
firefox = {
|
||
name = "Firefox";
|
||
genericName = "Web Browser";
|
||
exec = "firefox %U";
|
||
terminal = false;
|
||
categories = [ "Application" "Network" "WebBrowser" ];
|
||
mimeType = [ "text/html" "text/xml" ];
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.actions"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.actions"><code class="option">xdg.desktopEntries.<name>.actions</code></a></span></dt><dd><p>The set of actions made available to application launchers.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"New Window" = {
|
||
exec = "${pkgs.firefox}/bin/firefox --new-window %u";
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.actions._name_.exec"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.actions._name_.exec"><code class="option">xdg.desktopEntries.<name>.actions.<name>.exec</code></a></span></dt><dd><p>Program to execute, possibly with arguments.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.actions._name_.icon"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.actions._name_.icon"><code class="option">xdg.desktopEntries.<name>.actions.<name>.icon</code></a></span></dt><dd><p>Icon to display in file manager, menus, etc.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.actions._name_.name"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.actions._name_.name"><code class="option">xdg.desktopEntries.<name>.actions.<name>.name</code></a></span></dt><dd><p>Name of the action.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"><name></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.categories"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.categories"><code class="option">xdg.desktopEntries.<name>.categories</code></a></span></dt><dd><p>Categories in which the entry should be shown in a menu.</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.comment"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.comment"><code class="option">xdg.desktopEntries.<name>.comment</code></a></span></dt><dd><p>Tooltip for the entry.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.exec"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.exec"><code class="option">xdg.desktopEntries.<name>.exec</code></a></span></dt><dd><p>Program to execute, possibly with arguments.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.genericName"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.genericName"><code class="option">xdg.desktopEntries.<name>.genericName</code></a></span></dt><dd><p>Generic name of the application.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.icon"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.icon"><code class="option">xdg.desktopEntries.<name>.icon</code></a></span></dt><dd><p>Icon to display in file manager, menus, etc.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.mimeType"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.mimeType"><code class="option">xdg.desktopEntries.<name>.mimeType</code></a></span></dt><dd><p>The MIME type(s) supported by this application.</p><p><span class="emphasis"><em>Type:</em></span> null or list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.name"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.name"><code class="option">xdg.desktopEntries.<name>.name</code></a></span></dt><dd><p>Specific name of the application.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.noDisplay"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.noDisplay"><code class="option">xdg.desktopEntries.<name>.noDisplay</code></a></span></dt><dd><p>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.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.prefersNonDefaultGPU"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.prefersNonDefaultGPU"><code class="option">xdg.desktopEntries.<name>.prefersNonDefaultGPU</code></a></span></dt><dd><p>If true, the application prefers to be run on a more powerful discrete GPU if available.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.settings"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.settings"><code class="option">xdg.desktopEntries.<name>.settings</code></a></span></dt><dd><p>Extra key-value pairs to add to the <code class="literal">[Desktop Entry]</code> section.
|
||
This may override other values.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of Concatenated string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
Keywords = "calc;math";
|
||
DBusActivatable = "false";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.startupNotify"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.startupNotify"><code class="option">xdg.desktopEntries.<name>.startupNotify</code></a></span></dt><dd><p>If true, it is KNOWN that the application will send a "remove"
|
||
message when started with the <code class="literal">DESKTOP_STARTUP_ID</code>
|
||
environment variable set. If false, it is KNOWN that the application
|
||
does not work with startup notification at all.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.terminal"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.terminal"><code class="option">xdg.desktopEntries.<name>.terminal</code></a></span></dt><dd><p>Whether the program runs in a terminal window.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.desktopEntries._name_.type"></a><a class="term" href="options.html#opt-xdg.desktopEntries._name_.type"><code class="option">xdg.desktopEntries.<name>.type</code></a></span></dt><dd><p>The type of the desktop entry.</p><p><span class="emphasis"><em>Type:</em></span> one of "Application", "Link", "Directory"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Application"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-desktop-entries.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-desktop-entries.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.mime.enable"></a><a class="term" href="options.html#opt-xdg.mime.enable"><code class="option">xdg.mime.enable</code></a></span></dt><dd><p>Whether to install programs and files to support the
|
||
XDG Shared MIME-info specification and XDG MIME Applications
|
||
specification at
|
||
<a class="link" href="https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html" target="_top">https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html</a>
|
||
and
|
||
<a class="link" href="https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html" target="_top">https://specifications.freedesktop.org/mime-apps-spec/mime-apps-spec-latest.html</a>,
|
||
respectively.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true if host platform is Linux, false otherwise</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-mime.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-mime.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.mimeApps.enable"></a><a class="term" href="options.html#opt-xdg.mimeApps.enable"><code class="option">xdg.mimeApps.enable</code></a></span></dt><dd><p>Whether to manage <code class="filename">$XDG_CONFIG_HOME/mimeapps.list</code>.
|
||
</p><p>
|
||
The generated file is read-only.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-mime-apps.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-mime-apps.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.mimeApps.associations.added"></a><a class="term" href="options.html#opt-xdg.mimeApps.associations.added"><code class="option">xdg.mimeApps.associations.added</code></a></span></dt><dd><p>Defines additional associations of applications with
|
||
mimetypes, as if the .desktop file was listing this mimetype
|
||
in the first place.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of list of string or list of string or string convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"mimetype1" = [ "foo1.desktop" "foo2.desktop" "foo3.desktop" ];
|
||
"mimetype2" = "foo4.desktop";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-mime-apps.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-mime-apps.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.mimeApps.associations.removed"></a><a class="term" href="options.html#opt-xdg.mimeApps.associations.removed"><code class="option">xdg.mimeApps.associations.removed</code></a></span></dt><dd><p>Removes associations of applications with mimetypes, as if the
|
||
.desktop file was <span class="emphasis"><em>not</em></span> listing this
|
||
mimetype in the first place.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of list of string or list of string or string convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
mimetype1 = "foo5.desktop";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-mime-apps.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-mime-apps.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.mimeApps.defaultApplications"></a><a class="term" href="options.html#opt-xdg.mimeApps.defaultApplications"><code class="option">xdg.mimeApps.defaultApplications</code></a></span></dt><dd><p>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
|
||
application is no longer installed, the next application in
|
||
the list is attempted, and so on.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of list of string or list of string or string convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"mimetype1" = [ "default1.desktop" "default2.desktop" ];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-mime-apps.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-mime-apps.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.stateHome"></a><a class="term" href="options.html#opt-xdg.stateHome"><code class="option">xdg.stateHome</code></a></span></dt><dd><p>Absolute path to directory holding application states.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"~/.local/state"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.systemDirs.config"></a><a class="term" href="options.html#opt-xdg.systemDirs.config"><code class="option">xdg.systemDirs.config</code></a></span></dt><dd><p>Directory names to add to <code class="envar">XDG_CONFIG_DIRS</code>
|
||
in the user session.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ "/etc/xdg" ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-system-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-system-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.systemDirs.data"></a><a class="term" href="options.html#opt-xdg.systemDirs.data"><code class="option">xdg.systemDirs.data</code></a></span></dt><dd><p>Directory names to add to <code class="envar">XDG_DATA_DIRS</code>
|
||
in the user session.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ "/usr/share" "/usr/local/share" ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-system-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-system-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.enable"></a><a class="term" href="options.html#opt-xdg.userDirs.enable"><code class="option">xdg.userDirs.enable</code></a></span></dt><dd><p>Whether to manage <code class="filename">$XDG_CONFIG_HOME/user-dirs.dirs</code>.
|
||
</p><p>
|
||
The generated file is read-only.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.createDirectories"></a><a class="term" href="options.html#opt-xdg.userDirs.createDirectories"><code class="option">xdg.userDirs.createDirectories</code></a></span></dt><dd><p>Whether to enable automatic creation of the XDG user directories.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.desktop"></a><a class="term" href="options.html#opt-xdg.userDirs.desktop"><code class="option">xdg.userDirs.desktop</code></a></span></dt><dd><p>The Desktop directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Desktop"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.documents"></a><a class="term" href="options.html#opt-xdg.userDirs.documents"><code class="option">xdg.userDirs.documents</code></a></span></dt><dd><p>The Documents directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Documents"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.download"></a><a class="term" href="options.html#opt-xdg.userDirs.download"><code class="option">xdg.userDirs.download</code></a></span></dt><dd><p>The Downloads directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Downloads"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.extraConfig"></a><a class="term" href="options.html#opt-xdg.userDirs.extraConfig"><code class="option">xdg.userDirs.extraConfig</code></a></span></dt><dd><p>Other user directories.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
XDG_MISC_DIR = "$HOME/Misc";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.music"></a><a class="term" href="options.html#opt-xdg.userDirs.music"><code class="option">xdg.userDirs.music</code></a></span></dt><dd><p>The Music directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Music"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.pictures"></a><a class="term" href="options.html#opt-xdg.userDirs.pictures"><code class="option">xdg.userDirs.pictures</code></a></span></dt><dd><p>The Pictures directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Pictures"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.publicShare"></a><a class="term" href="options.html#opt-xdg.userDirs.publicShare"><code class="option">xdg.userDirs.publicShare</code></a></span></dt><dd><p>The Public share directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Public"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.templates"></a><a class="term" href="options.html#opt-xdg.userDirs.templates"><code class="option">xdg.userDirs.templates</code></a></span></dt><dd><p>The Templates directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Templates"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.userDirs.videos"></a><a class="term" href="options.html#opt-xdg.userDirs.videos"><code class="option">xdg.userDirs.videos</code></a></span></dt><dd><p>The Videos directory.</p><p><span class="emphasis"><em>Type:</em></span> string or path convertible to it</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/Videos"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/xdg-user-dirs.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/xdg-user-dirs.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xresources.extraConfig"></a><a class="term" href="options.html#opt-xresources.extraConfig"><code class="option">xresources.extraConfig</code></a></span></dt><dd><p>Additional X server resources contents.
|
||
If this and all other xresources options are
|
||
<code class="code">null</code>, then this feature is disabled and no
|
||
<code class="filename">~/.Xresources</code> link is produced.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">builtins.readFile (
|
||
pkgs.fetchFromGitHub {
|
||
owner = "solarized";
|
||
repo = "xresources";
|
||
rev = "025ceddbddf55f2eb4ab40b05889148aab9699fc";
|
||
sha256 = "0lxv37gmh38y9d3l8nbnsm1mskcv10g3i83j0kac0a2qmypv1k9f";
|
||
} + "/Xresources.dark"
|
||
)
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xresources.nix#blob-path" target="_top">
|
||
<home-manager/modules/xresources.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xresources.path"></a><a class="term" href="options.html#opt-xresources.path"><code class="option">xresources.path</code></a></span></dt><dd><p>Path where Home Manager should link the <code class="filename">.Xresources</code> file.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$HOME/.Xresources"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xresources.nix#blob-path" target="_top">
|
||
<home-manager/modules/xresources.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xresources.properties"></a><a class="term" href="options.html#opt-xresources.properties"><code class="option">xresources.properties</code></a></span></dt><dd><p>X server resources that should be set.
|
||
Booleans are formatted as "true" or "false" respectively.
|
||
List elements are recursively formatted as a string and joined by commas.
|
||
All other values are directly formatted using builtins.toString.
|
||
Note, that 2-dimensional lists are not supported and specifying one will throw an exception.
|
||
If this and all other xresources options are
|
||
<code class="code">null</code>, then this feature is disabled and no
|
||
<code class="filename">~/.Xresources</code> link is produced.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of boolean or signed integer or string or list of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"Emacs*toolBar" = 0;
|
||
"XTerm*faceName" = "dejavu sans mono";
|
||
"XTerm*charClass" = [ "37:48" "45-47:48" "58:48" "64:48" "126:48" ];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xresources.nix#blob-path" target="_top">
|
||
<home-manager/modules/xresources.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.enable"></a><a class="term" href="options.html#opt-xsession.enable"><code class="option">xsession.enable</code></a></span></dt><dd><p>Whether to enable X Session.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.initExtra"></a><a class="term" href="options.html#opt-xsession.initExtra"><code class="option">xsession.initExtra</code></a></span></dt><dd><p>Extra shell commands to run during initialization.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.numlock.enable"></a><a class="term" href="options.html#opt-xsession.numlock.enable"><code class="option">xsession.numlock.enable</code></a></span></dt><dd><p>Whether to enable Num Lock.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/misc/numlock.nix#blob-path" target="_top">
|
||
<home-manager/modules/misc/numlock.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.pointerCursor.package"></a><a class="term" href="options.html#opt-xsession.pointerCursor.package"><code class="option">xsession.pointerCursor.package</code></a></span></dt><dd><p>Alias of <code class="option">home.pointerCursor.package</code>.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.pointerCursor.defaultCursor"></a><a class="term" href="options.html#opt-xsession.pointerCursor.defaultCursor"><code class="option">xsession.pointerCursor.defaultCursor</code></a></span></dt><dd><p>Alias of <code class="option">home.pointerCursor.x11.defaultCursor</code>.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.pointerCursor.name"></a><a class="term" href="options.html#opt-xsession.pointerCursor.name"><code class="option">xsession.pointerCursor.name</code></a></span></dt><dd><p>Alias of <code class="option">home.pointerCursor.name</code>.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.pointerCursor.size"></a><a class="term" href="options.html#opt-xsession.pointerCursor.size"><code class="option">xsession.pointerCursor.size</code></a></span></dt><dd><p>Alias of <code class="option">home.pointerCursor.size</code>.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/config/home-cursor.nix#blob-path" target="_top">
|
||
<home-manager/modules/config/home-cursor.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.preferStatusNotifierItems"></a><a class="term" href="options.html#opt-xsession.preferStatusNotifierItems"><code class="option">xsession.preferStatusNotifierItems</code></a></span></dt><dd><p>Whether tray applets should prefer using the Status Notifier
|
||
Items (SNI) protocol, commonly called App Indicators. Note,
|
||
not all tray applets or status bars support SNI.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.profileExtra"></a><a class="term" href="options.html#opt-xsession.profileExtra"><code class="option">xsession.profileExtra</code></a></span></dt><dd><p>Extra shell commands to run before session start.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.profilePath"></a><a class="term" href="options.html#opt-xsession.profilePath"><code class="option">xsession.profilePath</code></a></span></dt><dd><p>Path, relative to <code class="envar">HOME</code>, where Home Manager
|
||
should write the X profile script.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">".xprofile"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">".xprofile-hm"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.scriptPath"></a><a class="term" href="options.html#opt-xsession.scriptPath"><code class="option">xsession.scriptPath</code></a></span></dt><dd><p>Path, relative to <code class="envar">HOME</code>, where Home Manager
|
||
should write the X session script.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">".xsession"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">".xsession-hm"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.awesome.enable"></a><a class="term" href="options.html#opt-xsession.windowManager.awesome.enable"><code class="option">xsession.windowManager.awesome.enable</code></a></span></dt><dd><p>Whether to enable Awesome window manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/awesome.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/awesome.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.awesome.package"></a><a class="term" href="options.html#opt-xsession.windowManager.awesome.package"><code class="option">xsession.windowManager.awesome.package</code></a></span></dt><dd><p>Package to use for running the Awesome WM.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.awesome</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/awesome.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/awesome.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.awesome.luaModules"></a><a class="term" href="options.html#opt-xsession.windowManager.awesome.luaModules"><code class="option">xsession.windowManager.awesome.luaModules</code></a></span></dt><dd><p>List of lua packages available for being
|
||
used in the Awesome configuration.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[ pkgs.luaPackages.vicious ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/awesome.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/awesome.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.awesome.noArgb"></a><a class="term" href="options.html#opt-xsession.windowManager.awesome.noArgb"><code class="option">xsession.windowManager.awesome.noArgb</code></a></span></dt><dd><p>Disable client transparency support, which can be greatly
|
||
detrimental to performance in some setups
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/awesome.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/awesome.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.enable"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.enable"><code class="option">xsession.windowManager.bspwm.enable</code></a></span></dt><dd><p>Whether to enable bspwm window manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.package"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.package"><code class="option">xsession.windowManager.bspwm.package</code></a></span></dt><dd><p>The bspwm package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.bspwm</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.bspwm-unstable</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.alwaysResetDesktops"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.alwaysResetDesktops"><code class="option">xsession.windowManager.bspwm.alwaysResetDesktops</code></a></span></dt><dd><p>If set to <code class="literal">true</code>, desktops configured in <code class="option">monitors</code> will be reset
|
||
every time the config is run.
|
||
|
||
If set to <code class="literal">false</code>, desktops will only be configured the first time the config is run.
|
||
This is useful if you want to dynamically add desktops and you don't want them to be destroyed if you
|
||
re-run <code class="literal">bspwmrc</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.extraConfig"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.extraConfig"><code class="option">xsession.windowManager.bspwm.extraConfig</code></a></span></dt><dd><p>Additional shell commands to be run at the end of the config file.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
bspc subscribe all > ~/bspc-report.log &
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.monitors"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.monitors"><code class="option">xsession.windowManager.bspwm.monitors</code></a></span></dt><dd><p>Specifies the names of desktops to create on each monitor.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
HDMI-0 =
|
||
[
|
||
"web" "terminal" "III" "IV"
|
||
]
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules"><code class="option">xsession.windowManager.bspwm.rules</code></a></span></dt><dd><p>Rule configuration. The keys of the attribute set are the targets of the rules.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"Gimp" = {
|
||
desktop = "^8";
|
||
state = "floating";
|
||
follow = true;
|
||
};
|
||
"Kupfer.py" = {
|
||
focus = true;
|
||
};
|
||
"Screenkey" = {
|
||
manage = false;
|
||
};
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.border"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.border"><code class="option">xsession.windowManager.bspwm.rules.<name>.border</code></a></span></dt><dd><p>Whether the node should have border.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.center"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.center"><code class="option">xsession.windowManager.bspwm.rules.<name>.center</code></a></span></dt><dd><p>Whether the node will be put in the center, in floating mode.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.desktop"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.desktop"><code class="option">xsession.windowManager.bspwm.rules.<name>.desktop</code></a></span></dt><dd><p>The desktop where the rule should be applied.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"^8"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.focus"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.focus"><code class="option">xsession.windowManager.bspwm.rules.<name>.focus</code></a></span></dt><dd><p>Whether the node should gain focus on creation.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.follow"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.follow"><code class="option">xsession.windowManager.bspwm.rules.<name>.follow</code></a></span></dt><dd><p>Whether focus should follow the node when it is moved.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.hidden"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.hidden"><code class="option">xsession.windowManager.bspwm.rules.<name>.hidden</code></a></span></dt><dd><p>Whether the node should occupy any space.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.layer"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.layer"><code class="option">xsession.windowManager.bspwm.rules.<name>.layer</code></a></span></dt><dd><p>The layer where a new window should spawn.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "below", "normal", "above"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"above"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.locked"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.locked"><code class="option">xsession.windowManager.bspwm.rules.<name>.locked</code></a></span></dt><dd><p>Whether the node should ignore <span class="command"><strong>node --close</strong></span>
|
||
messages.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.manage"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.manage"><code class="option">xsession.windowManager.bspwm.rules.<name>.manage</code></a></span></dt><dd><p>Whether the window should be managed by bspwm. If false, the window
|
||
will be ignored by bspwm entirely. This is useful for overlay apps,
|
||
e.g. screenshot tools.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.marked"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.marked"><code class="option">xsession.windowManager.bspwm.rules.<name>.marked</code></a></span></dt><dd><p>Whether the node will be marked for deferred actions.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.monitor"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.monitor"><code class="option">xsession.windowManager.bspwm.rules.<name>.monitor</code></a></span></dt><dd><p>The monitor where the rule should be applied.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"HDMI-0"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.node"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.node"><code class="option">xsession.windowManager.bspwm.rules.<name>.node</code></a></span></dt><dd><p>The node where the rule should be applied.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"1"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.private"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.private"><code class="option">xsession.windowManager.bspwm.rules.<name>.private</code></a></span></dt><dd><p>Whether the node should stay in the same tiling position and size.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.splitDir"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.splitDir"><code class="option">xsession.windowManager.bspwm.rules.<name>.splitDir</code></a></span></dt><dd><p>The direction where the container is going to be split.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "north", "west", "south", "east"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"south"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.splitRatio"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.splitRatio"><code class="option">xsession.windowManager.bspwm.rules.<name>.splitRatio</code></a></span></dt><dd><p>The ratio between the new window and the previous existing window in
|
||
the desktop.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or floating point number</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal"></code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.state"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.state"><code class="option">xsession.windowManager.bspwm.rules.<name>.state</code></a></span></dt><dd><p>The state in which a new window should spawn.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "tiled", "pseudo_tiled", "floating", "fullscreen"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"floating"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.rules._name_.sticky"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.rules._name_.sticky"><code class="option">xsession.windowManager.bspwm.rules.<name>.sticky</code></a></span></dt><dd><p>Whether the node should stay on the focused desktop.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.settings"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.settings"><code class="option">xsession.windowManager.bspwm.settings</code></a></span></dt><dd><p>General settings given to <code class="literal">bspc config</code>.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or floating point number or string or list of boolean or signed integer or floating point number or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
border_width = 2; gapless_monocle = true; split_ratio = ;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.bspwm.startupPrograms"></a><a class="term" href="options.html#opt-xsession.windowManager.bspwm.startupPrograms"><code class="option">xsession.windowManager.bspwm.startupPrograms</code></a></span></dt><dd><p>Programs to be executed during startup.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
"numlockx on" "tilda"
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/bspwm/default.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/bspwm/default.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.command"></a><a class="term" href="options.html#opt-xsession.windowManager.command"><code class="option">xsession.windowManager.command</code></a></span></dt><dd><p>Command to use to start the window manager.
|
||
</p><p>
|
||
The default value allows integration with NixOS' generated xserver configuration.
|
||
</p><p>
|
||
Extra actions and commands can be specified in <code class="option">xsession.initExtra</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">''test -n "$1" && eval "$@"''</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">let
|
||
xmonad = pkgs.xmonad-with-packages.override {
|
||
packages = self: [ self.xmonad-contrib self.taffybar ];
|
||
};
|
||
in
|
||
"${xmonad}/bin/xmonad";
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/xsession.nix#blob-path" target="_top">
|
||
<home-manager/modules/xsession.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.enable"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.enable"><code class="option">xsession.windowManager.herbstluftwm.enable</code></a></span></dt><dd><p>Whether to enable herbstluftwm window manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.package"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.package"><code class="option">xsession.windowManager.herbstluftwm.package</code></a></span></dt><dd><p>Package providing the <span class="command"><strong>herbstluftwm</strong></span> and
|
||
<span class="command"><strong>herbstclient</strong></span> commands.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.herbstluftwm</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.extraConfig"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.extraConfig"><code class="option">xsession.windowManager.herbstluftwm.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add verbatim to
|
||
<code class="filename">$XDG_CONFIG_HOME/herbstluftwm/autostart</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
|
||
herbstclient set_layout max
|
||
herbstclient detect_monitors
|
||
''</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.keybinds"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.keybinds"><code class="option">xsession.windowManager.herbstluftwm.keybinds</code></a></span></dt><dd><p>Herbstluftwm keybinds.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
Mod4-o = "split right";
|
||
Mod4-u = "split bottom";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.mousebinds"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.mousebinds"><code class="option">xsession.windowManager.herbstluftwm.mousebinds</code></a></span></dt><dd><p>Herbstluftwm mousebinds.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
Mod4-B1 = "move";
|
||
Mod4-B3 = "resize";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.rules"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.rules"><code class="option">xsession.windowManager.herbstluftwm.rules</code></a></span></dt><dd><p>Herbstluftwm rules.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
"windowtype~'_NET_WM_WINDOW_TYPE_(DIALOG|UTILITY|SPLASH)' focus=on pseudotile=on"
|
||
"windowtype~'_NET_WM_WINDOW_TYPE_(NOTIFICATION|DOCK|DESKTOP)' manage=off"
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.settings"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.settings"><code class="option">xsession.windowManager.herbstluftwm.settings</code></a></span></dt><dd><p>Herbstluftwm settings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of boolean or signed integer or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
gapless_grid = false;
|
||
window_border_width = 1;
|
||
window_border_active_color = "#FF0000";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.herbstluftwm.tags"></a><a class="term" href="options.html#opt-xsession.windowManager.herbstluftwm.tags"><code class="option">xsession.windowManager.herbstluftwm.tags</code></a></span></dt><dd><p>Tags to create on startup.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[ "work" "browser" "music" "gaming" ]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/herbstluftwm.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/herbstluftwm.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.enable"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.enable"><code class="option">xsession.windowManager.i3.enable</code></a></span></dt><dd><p>Whether to enable i3 window manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.package"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.package"><code class="option">xsession.windowManager.i3.package</code></a></span></dt><dd><p>i3 package to use.
|
||
If 'i3.config.gaps' settings are specified, 'pkgs.i3-gaps' will be set as a default package.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.i3</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.i3-gaps</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config"><code class="option">xsession.windowManager.i3.config</code></a></span></dt><dd><p>i3 configuration options.</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.assigns"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.assigns"><code class="option">xsession.windowManager.i3.config.assigns</code></a></span></dt><dd><p>An attribute set that assigns applications to workspaces based
|
||
on criteria.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of list of attribute set of string or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"1: web" = [{ class = "^Firefox$"; }];
|
||
"0: extra" = [{ class = "^Firefox$"; window_role = "About"; }];
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars"><code class="option">xsession.windowManager.i3.config.bars</code></a></span></dt><dd><p>i3 bars settings blocks. Set to empty list to remove bars completely.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">see code</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors"><code class="option">xsession.windowManager.i3.config.bars.*.colors</code></a></span></dt><dd><p>Bar color settings. All color classes can be specified using submodules
|
||
with 'border', 'background', 'text', fields and RGB color hex-codes as values.
|
||
See default values for the reference.
|
||
Note that 'background', 'status', and 'separator' parameters take a single RGB value.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_colors" target="_top">https://i3wm.org/docs/userguide.html#_colors</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.activeWorkspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.activeWorkspace"><code class="option">xsession.windowManager.i3.config.bars.*.colors.activeWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace is active.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#5f676a"; border = "#333333"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.background"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.background"><code class="option">xsession.windowManager.i3.config.bars.*.colors.background</code></a></span></dt><dd><p>Background color of the bar.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#000000"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.bindingMode"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.bindingMode"><code class="option">xsession.windowManager.i3.config.bars.*.colors.bindingMode</code></a></span></dt><dd><p>Border, background and text color for the binding mode indicator</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#900000"; border = "#2f343a"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.focusedBackground"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.focusedBackground"><code class="option">xsession.windowManager.i3.config.bars.*.colors.focusedBackground</code></a></span></dt><dd><p>Background color of the bar on the currently focused monitor output.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#000000"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.focusedSeparator"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.focusedSeparator"><code class="option">xsession.windowManager.i3.config.bars.*.colors.focusedSeparator</code></a></span></dt><dd><p>Text color to be used for the separator on the currently focused monitor output.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#666666"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.focusedStatusline"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.focusedStatusline"><code class="option">xsession.windowManager.i3.config.bars.*.colors.focusedStatusline</code></a></span></dt><dd><p>Text color to be used for the statusline on the currently focused monitor output.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.focusedWorkspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.focusedWorkspace"><code class="option">xsession.windowManager.i3.config.bars.*.colors.focusedWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace has focus.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#285577"; border = "#4c7899"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.inactiveWorkspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.inactiveWorkspace"><code class="option">xsession.windowManager.i3.config.bars.*.colors.inactiveWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace does not
|
||
have focus and is not active.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#222222"; border = "#333333"; text = "#888888";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.separator"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.separator"><code class="option">xsession.windowManager.i3.config.bars.*.colors.separator</code></a></span></dt><dd><p>Text color to be used for the separator.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#666666"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.statusline"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.statusline"><code class="option">xsession.windowManager.i3.config.bars.*.colors.statusline</code></a></span></dt><dd><p>Text color to be used for the statusline.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.colors.urgentWorkspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.colors.urgentWorkspace"><code class="option">xsession.windowManager.i3.config.bars.*.colors.urgentWorkspace</code></a></span></dt><dd><p>Border, background and text color for a workspace button when the workspace contains
|
||
a window with the urgency hint set.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
background = "#900000"; border = "#2f343a"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.command"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.command"><code class="option">xsession.windowManager.i3.config.bars.*.command</code></a></span></dt><dd><p>Command that will be used to start a bar.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"i3bar"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.i3-gaps}/bin/i3bar -t"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.extraConfig"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.extraConfig"><code class="option">xsession.windowManager.i3.config.bars.*.extraConfig</code></a></span></dt><dd><p>Extra configuration lines for this bar.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.fonts"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.fonts"><code class="option">xsession.windowManager.i3.config.bars.*.fonts</code></a></span></dt><dd><p>Font configuration for this bar.</p><p><span class="emphasis"><em>Type:</em></span> list of string or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
|
||
style = "Bold Semi-Condensed";
|
||
size = 11.0;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.hiddenState"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.hiddenState"><code class="option">xsession.windowManager.i3.config.bars.*.hiddenState</code></a></span></dt><dd><p>The default bar mode when 'bar.mode' == 'hide'.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "hide", "show"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"hide"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.id"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.id"><code class="option">xsession.windowManager.i3.config.bars.*.id</code></a></span></dt><dd><p>Specifies the bar ID for the configured bar instance.
|
||
If this option is missing, the ID is set to bar-x, where x corresponds
|
||
to the position of the embedding bar block in the config file.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.mode"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.mode"><code class="option">xsession.windowManager.i3.config.bars.*.mode</code></a></span></dt><dd><p>Bar visibility mode.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "dock", "hide", "invisible"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"dock"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.position"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.position"><code class="option">xsession.windowManager.i3.config.bars.*.position</code></a></span></dt><dd><p>The edge of the screen i3bar should show up.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "top", "bottom"</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"bottom"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.statusCommand"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.statusCommand"><code class="option">xsession.windowManager.i3.config.bars.*.statusCommand</code></a></span></dt><dd><p>Command that will be used to get status lines.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"\${pkgs.i3status}/bin/i3status"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.trayOutput"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.trayOutput"><code class="option">xsession.windowManager.i3.config.bars.*.trayOutput</code></a></span></dt><dd><p>Where to output tray.</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"primary"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.workspaceButtons"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.workspaceButtons"><code class="option">xsession.windowManager.i3.config.bars.*.workspaceButtons</code></a></span></dt><dd><p>Whether workspace buttons should be shown or not.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.bars._.workspaceNumbers"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.bars._.workspaceNumbers"><code class="option">xsession.windowManager.i3.config.bars.*.workspaceNumbers</code></a></span></dt><dd><p>Whether workspace numbers should be displayed within the workspace buttons.</p><p><span class="emphasis"><em>Type:</em></span> null or boolean</p><p><span class="emphasis"><em>Default:</em></span> </p><pre class="programlisting">null for state version ≥ 20.09, as example otherwise
|
||
</pre><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors"><code class="option">xsession.windowManager.i3.config.colors</code></a></span></dt><dd><p>Color settings. All color classes can be specified using submodules
|
||
with 'border', 'background', 'text', 'indicator' and 'childBorder' fields
|
||
and RGB color hex-codes as values. See default values for the reference.
|
||
Note that 'i3.config.colors.background' parameter takes a single RGB value.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_changing_colors" target="_top">https://i3wm.org/docs/userguide.html#_changing_colors</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors.background"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors.background"><code class="option">xsession.windowManager.i3.config.colors.background</code></a></span></dt><dd><p>Background color of the window. Only applications which do not cover
|
||
the whole area expose the color.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"#ffffff"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors.focused"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors.focused"><code class="option">xsession.windowManager.i3.config.colors.focused</code></a></span></dt><dd><p>A window which currently has the focus.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#285577"; border = "#4c7899"; childBorder = "#285577"; indicator = "#2e9ef4"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors.focusedInactive"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors.focusedInactive"><code class="option">xsession.windowManager.i3.config.colors.focusedInactive</code></a></span></dt><dd><p>A window which is the focused one of its container,
|
||
but it does not have the focus at the moment.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#5f676a"; border = "#333333"; childBorder = "#5f676a"; indicator = "#484e50"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors.placeholder"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors.placeholder"><code class="option">xsession.windowManager.i3.config.colors.placeholder</code></a></span></dt><dd><p>Background and text color are used to draw placeholder window
|
||
contents (when restoring layouts). Border and indicator are ignored.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#0c0c0c"; border = "#000000"; childBorder = "#0c0c0c"; indicator = "#000000"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors.unfocused"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors.unfocused"><code class="option">xsession.windowManager.i3.config.colors.unfocused</code></a></span></dt><dd><p>A window which is not focused.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#222222"; border = "#333333"; childBorder = "#222222"; indicator = "#292d2e"; text = "#888888";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.colors.urgent"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.colors.urgent"><code class="option">xsession.windowManager.i3.config.colors.urgent</code></a></span></dt><dd><p>A window which has its urgency hint activated.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
background = "#900000"; border = "#2f343a"; childBorder = "#900000"; indicator = "#900000"; text = "#ffffff";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.defaultWorkspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.defaultWorkspace"><code class="option">xsession.windowManager.i3.config.defaultWorkspace</code></a></span></dt><dd><p>The default workspace to show when i3 is launched.
|
||
This must to correspond to the value of the keybinding of the default workspace.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"workspace number 9"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.floating"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.floating"><code class="option">xsession.windowManager.i3.config.floating</code></a></span></dt><dd><p>Floating window settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.floating.border"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.floating.border"><code class="option">xsession.windowManager.i3.config.floating.border</code></a></span></dt><dd><p>Floating windows border width.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.floating.criteria"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.floating.criteria"><code class="option">xsession.windowManager.i3.config.floating.criteria</code></a></span></dt><dd><p>List of criteria for windows that should be opened in a floating mode.</p><p><span class="emphasis"><em>Type:</em></span> list of attribute set of string or boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
title = "Steam - Update News";
|
||
}
|
||
|
||
{
|
||
class = "Pavucontrol";
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.floating.modifier"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.floating.modifier"><code class="option">xsession.windowManager.i3.config.floating.modifier</code></a></span></dt><dd><p>Modifier key that can be used to drag floating windows.</p><p><span class="emphasis"><em>Type:</em></span> one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"i3.config.modifier"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Mod4"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.floating.titlebar"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.floating.titlebar"><code class="option">xsession.windowManager.i3.config.floating.titlebar</code></a></span></dt><dd><p>Whether to show floating window titlebars.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"xsession.windowManager.i3.package != nixpkgs.i3-gaps (titlebar should be disabled for i3-gaps)"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.focus"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.focus"><code class="option">xsession.windowManager.i3.config.focus</code></a></span></dt><dd><p>Focus related settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.focus.followMouse"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.focus.followMouse"><code class="option">xsession.windowManager.i3.config.focus.followMouse</code></a></span></dt><dd><p>Whether focus should follow the mouse.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.focus.forceWrapping"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.focus.forceWrapping"><code class="option">xsession.windowManager.i3.config.focus.forceWrapping</code></a></span></dt><dd><p>Whether to force focus wrapping in tabbed or stacked container.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_focus_wrapping" target="_top">https://i3wm.org/docs/userguide.html#_focus_wrapping</a>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.focus.mouseWarping"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.focus.mouseWarping"><code class="option">xsession.windowManager.i3.config.focus.mouseWarping</code></a></span></dt><dd><p>Whether mouse cursor should be warped to the center of the window when switching focus
|
||
to a window on a different output.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.focus.newWindow"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.focus.newWindow"><code class="option">xsession.windowManager.i3.config.focus.newWindow</code></a></span></dt><dd><p>This option modifies focus behavior on new window activation.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#focus_on_window_activation" target="_top">https://i3wm.org/docs/userguide.html#focus_on_window_activation</a>
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "smart", "urgent", "focus", "none"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"smart"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.fonts"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.fonts"><code class="option">xsession.windowManager.i3.config.fonts</code></a></span></dt><dd><p>Font configuration for window titles, nagbar...</p><p><span class="emphasis"><em>Type:</em></span> list of string or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
|
||
style = "Bold Semi-Condensed";
|
||
size = 11.0;
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps"><code class="option">xsession.windowManager.i3.config.gaps</code></a></span></dt><dd><p>i3Gaps related settings. The i3-gaps package must be used for these features to work.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.bottom"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.bottom"><code class="option">xsession.windowManager.i3.config.gaps.bottom</code></a></span></dt><dd><p>Bottom gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.horizontal"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.horizontal"><code class="option">xsession.windowManager.i3.config.gaps.horizontal</code></a></span></dt><dd><p>Horizontal gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.inner"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.inner"><code class="option">xsession.windowManager.i3.config.gaps.inner</code></a></span></dt><dd><p>Inner gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">12</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.left"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.left"><code class="option">xsession.windowManager.i3.config.gaps.left</code></a></span></dt><dd><p>Left gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.outer"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.outer"><code class="option">xsession.windowManager.i3.config.gaps.outer</code></a></span></dt><dd><p>Outer gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.right"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.right"><code class="option">xsession.windowManager.i3.config.gaps.right</code></a></span></dt><dd><p>Right gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.smartBorders"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.smartBorders"><code class="option">xsession.windowManager.i3.config.gaps.smartBorders</code></a></span></dt><dd><p>This option controls whether to disable container borders on
|
||
workspace with a single container.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "on", "off", "no_gaps"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"off"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.smartGaps"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.smartGaps"><code class="option">xsession.windowManager.i3.config.gaps.smartGaps</code></a></span></dt><dd><p>This option controls whether to disable all gaps (outer and inner)
|
||
on workspace with a single container.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.top"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.top"><code class="option">xsession.windowManager.i3.config.gaps.top</code></a></span></dt><dd><p>Top gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.gaps.vertical"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.gaps.vertical"><code class="option">xsession.windowManager.i3.config.gaps.vertical</code></a></span></dt><dd><p>Vertical gaps value.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.keybindings"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.keybindings"><code class="option">xsession.windowManager.i3.config.keybindings</code></a></span></dt><dd><p>An attribute set that assigns a key press to an action using a key symbol.
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#keybindings" target="_top">https://i3wm.org/docs/userguide.html#keybindings</a>.
|
||
</p><p>
|
||
Consider to use <code class="code">lib.mkOptionDefault</code> function to extend or override
|
||
default keybindings instead of specifying all of them from scratch.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Default i3 keybindings."</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">let
|
||
modifier = config.xsession.windowManager.i3.config.modifier;
|
||
in lib.mkOptionDefault {
|
||
"${modifier}+Return" = "exec i3-sensible-terminal";
|
||
"${modifier}+Shift+q" = "kill";
|
||
"${modifier}+d" = "exec \${pkgs.dmenu}/bin/dmenu_run";
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.keycodebindings"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.keycodebindings"><code class="option">xsession.windowManager.i3.config.keycodebindings</code></a></span></dt><dd><p>An attribute set that assigns keypress to an action using key code.
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#keybindings" target="_top">https://i3wm.org/docs/userguide.html#keybindings</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
{
|
||
214 = "exec /bin/script.sh";
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.menu"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.menu"><code class="option">xsession.windowManager.i3.config.menu</code></a></span></dt><dd><p>Default launcher to use.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.dmenu}/bin/dmenu_run"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"bemenu-run"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.modes"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.modes"><code class="option">xsession.windowManager.i3.config.modes</code></a></span></dt><dd><p>An attribute set that defines binding modes and keybindings
|
||
inside them
|
||
|
||
Only basic keybinding is supported (bindsym keycomb action),
|
||
for more advanced setup use 'i3.extraConfig'.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
resize =
|
||
{
|
||
Down = "resize grow height 10 px or 10 ppt"; Escape = "mode default"; Left = "resize shrink width 10 px or 10 ppt"; Return = "mode default"; Right = "resize grow width 10 px or 10 ppt"; Up = "resize shrink height 10 px or 10 ppt";
|
||
}
|
||
;
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.modifier"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.modifier"><code class="option">xsession.windowManager.i3.config.modifier</code></a></span></dt><dd><p>Modifier key that is used for all default keybindings.</p><p><span class="emphasis"><em>Type:</em></span> one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"Mod1"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Mod4"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.startup"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.startup"><code class="option">xsession.windowManager.i3.config.startup</code></a></span></dt><dd><p>Commands that should be executed at startup.
|
||
|
||
See <a class="link" href="https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup" target="_top">https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||
{ command = "systemctl --user restart polybar"; always = true; notification = false; }
|
||
{ command = "dropbox start"; notification = false; }
|
||
{ command = "firefox"; workspace = "1: web"; }
|
||
];
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.startup._.always"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.startup._.always"><code class="option">xsession.windowManager.i3.config.startup.*.always</code></a></span></dt><dd><p>Whether to run command on each i3 restart.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.startup._.command"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.startup._.command"><code class="option">xsession.windowManager.i3.config.startup.*.command</code></a></span></dt><dd><p>Command that will be executed on startup.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.startup._.notification"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.startup._.notification"><code class="option">xsession.windowManager.i3.config.startup.*.notification</code></a></span></dt><dd><p>Whether to enable startup-notification support for the command.
|
||
See <code class="option">--no-startup-id</code> option description in the i3 user guide.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.startup._.workspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.startup._.workspace"><code class="option">xsession.windowManager.i3.config.startup.*.workspace</code></a></span></dt><dd><p>Launch application on a particular workspace. DEPRECATED:
|
||
Use <code class="varname"><a class="link" href="options.html#opt-xsession.windowManager.i3.config.assigns">xsession.windowManager.i3.config.assigns</a></code>
|
||
instead. See <a class="link" href="https://github.com/nix-community/home-manager/issues/265" target="_top">https://github.com/nix-community/home-manager/issues/265</a>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.terminal"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.terminal"><code class="option">xsession.windowManager.i3.config.terminal</code></a></span></dt><dd><p>Default terminal to run.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"i3-sensible-terminal"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"alacritty"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window"><code class="option">xsession.windowManager.i3.config.window</code></a></span></dt><dd><p>Window titlebar and border settings.</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window.border"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window.border"><code class="option">xsession.windowManager.i3.config.window.border</code></a></span></dt><dd><p>Window border width.</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">2</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window.commands"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window.commands"><code class="option">xsession.windowManager.i3.config.window.commands</code></a></span></dt><dd><p>List of commands that should be executed on specific windows.
|
||
See <code class="option">for_window</code> i3wm option documentation.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
|
||
[
|
||
|
||
{
|
||
command = "border pixel 1"; criteria =
|
||
{
|
||
class = "XTerm";
|
||
}
|
||
;
|
||
}
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window.commands._.command"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window.commands._.command"><code class="option">xsession.windowManager.i3.config.window.commands.*.command</code></a></span></dt><dd><p>i3wm command to execute.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"border pixel 1"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window.commands._.criteria"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window.commands._.criteria"><code class="option">xsession.windowManager.i3.config.window.commands.*.criteria</code></a></span></dt><dd><p>Criteria of the windows on which command should be executed.
|
||
</p><p>
|
||
A value of <code class="literal">true</code> is equivalent to using an empty
|
||
criteria (which is different from an empty string criteria).
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string or boolean</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
title = "x200: ~/work";
|
||
floating = true;
|
||
};
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window.hideEdgeBorders"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window.hideEdgeBorders"><code class="option">xsession.windowManager.i3.config.window.hideEdgeBorders</code></a></span></dt><dd><p>Hide window borders adjacent to the screen edges.</p><p><span class="emphasis"><em>Type:</em></span> one of "none", "vertical", "horizontal", "both", "smart"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"none"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.window.titlebar"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.window.titlebar"><code class="option">xsession.windowManager.i3.config.window.titlebar</code></a></span></dt><dd><p>Whether to show window titlebars.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"xsession.windowManager.i3.package != nixpkgs.i3-gaps (titlebar should be disabled for i3-gaps)"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.workspaceAutoBackAndForth"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.workspaceAutoBackAndForth"><code class="option">xsession.windowManager.i3.config.workspaceAutoBackAndForth</code></a></span></dt><dd><p>Assume you are on workspace "1: www" and switch to "2: IM" using
|
||
mod+2 because somebody sent you a message. You don’t need to remember
|
||
where you came from now, you can just press $mod+2 again to switch
|
||
back to "1: www".
|
||
</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.workspaceLayout"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.workspaceLayout"><code class="option">xsession.windowManager.i3.config.workspaceLayout</code></a></span></dt><dd><p>The mode in which new containers on workspace level will
|
||
start.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> one of "default", "stacking", "tabbed"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"default"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"tabbed"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.workspaceOutputAssign"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.workspaceOutputAssign"><code class="option">xsession.windowManager.i3.config.workspaceOutputAssign</code></a></span></dt><dd><p>Assign workspaces to outputs.</p><p><span class="emphasis"><em>Type:</em></span> list of submodule</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
[
|
||
|
||
]
|
||
</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.workspaceOutputAssign._.output"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.workspaceOutputAssign._.output"><code class="option">xsession.windowManager.i3.config.workspaceOutputAssign.*.output</code></a></span></dt><dd><p>Name of the output from <span class="command"><strong>
|
||
i3-msg -t get_outputs
|
||
</strong></span>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"eDP"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.workspaceOutputAssign._.workspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.workspaceOutputAssign._.workspace"><code class="option">xsession.windowManager.i3.config.workspaceOutputAssign.*.workspace</code></a></span></dt><dd><p>Name of the workspace to assign.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Web"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.extraConfig"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.extraConfig"><code class="option">xsession.windowManager.i3.extraConfig</code></a></span></dt><dd><p>Extra configuration lines to add to ~/.config/i3/config.</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/i3-sway/i3.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.xmonad.enable"></a><a class="term" href="options.html#opt-xsession.windowManager.xmonad.enable"><code class="option">xsession.windowManager.xmonad.enable</code></a></span></dt><dd><p>Whether to enable xmonad window manager.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/xmonad.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/xmonad.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.xmonad.enableContribAndExtras"></a><a class="term" href="options.html#opt-xsession.windowManager.xmonad.enableContribAndExtras"><code class="option">xsession.windowManager.xmonad.enableContribAndExtras</code></a></span></dt><dd><p>Enable xmonad-{contrib,extras} in xmonad.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/xmonad.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/xmonad.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.xmonad.config"></a><a class="term" href="options.html#opt-xsession.windowManager.xmonad.config"><code class="option">xsession.windowManager.xmonad.config</code></a></span></dt><dd><p>The configuration file to be used for xmonad. This must be
|
||
an absolute path or <code class="literal">null</code> in which case
|
||
<code class="filename">~/.xmonad/xmonad.hs</code> will not be managed
|
||
by Home Manager.
|
||
</p><p>
|
||
If this option is set to a non-<code class="literal">null</code> value,
|
||
recompilation of xmonad outside of Home Manager (e.g. via
|
||
<span class="command"><strong>xmonad --recompile</strong></span>) will fail.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">pkgs.writeText "xmonad.hs" ''
|
||
import XMonad
|
||
main = xmonad defaultConfig
|
||
{ terminal = "urxvt"
|
||
, modMask = mod4Mask
|
||
, borderWidth = 3
|
||
}
|
||
''
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/xmonad.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/xmonad.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.xmonad.extraPackages"></a><a class="term" href="options.html#opt-xsession.windowManager.xmonad.extraPackages"><code class="option">xsession.windowManager.xmonad.extraPackages</code></a></span></dt><dd><p>Extra packages available to GHC when rebuilding xmonad. The
|
||
value must be a function which receives the attribute set
|
||
defined in <code class="varname">haskellPackages</code> as the sole
|
||
argument.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"self: []"</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">haskellPackages: [
|
||
haskellPackages.xmonad-contrib
|
||
haskellPackages.monad-logger
|
||
]
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/xmonad.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/xmonad.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.xmonad.haskellPackages"></a><a class="term" href="options.html#opt-xsession.windowManager.xmonad.haskellPackages"><code class="option">xsession.windowManager.xmonad.haskellPackages</code></a></span></dt><dd><p>The <code class="varname">haskellPackages</code> used to build xmonad
|
||
and other packages. This can be used to change the GHC
|
||
version used to build xmonad and the packages listed in
|
||
<code class="varname">extraPackages</code>.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> unspecified</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.haskellPackages</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.haskell.packages.ghc784</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/xmonad.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/xmonad.nix>
|
||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.xmonad.libFiles"></a><a class="term" href="options.html#opt-xsession.windowManager.xmonad.libFiles"><code class="option">xsession.windowManager.xmonad.libFiles</code></a></span></dt><dd><p>Additional files that will be saved in
|
||
<code class="filename">~/.xmonad/lib/</code> and included in the configuration
|
||
build. The keys are the file names while the values are paths to the
|
||
contents of the files.
|
||
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||
{
|
||
|
||
}
|
||
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||
"Tools.hs" = pkgs.writeText "Tools.hs" ''
|
||
module Tools where
|
||
screenshot = "scrot"
|
||
'';
|
||
}
|
||
</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/services/window-managers/xmonad.nix#blob-path" target="_top">
|
||
<home-manager/modules/services/window-managers/xmonad.nix>
|
||
</a></code></td></tr></table></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="nixos-options.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Home Manager Manual </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix B. NixOS Module Options</td></tr></table></div></body></html> |