mirror of
https://github.com/nix-community/home-manager
synced 2024-11-10 15:14:26 +00:00
deploy: d9a97e8b33
This commit is contained in:
teto
parent
bf8501459e
commit
acd8c76703
1 changed files with 252 additions and 1 deletions
253
options.html
253
options.html
|
|
@ -1,5 +1,256 @@
|
|||
<?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 name="viewport" content="width=device-width, initial-scale=1.0"><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" /><script src="highlight.min.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-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">
|
||||
<!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 name="viewport" content="width=device-width, initial-scale=1.0"><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" /><script src="highlight.min.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-accounts.calendar.accounts"></a><a class="term" href="options.html#opt-accounts.calendar.accounts"><code class="option">accounts.calendar.accounts</code></a></span></dt><dd><p>List of calendars.</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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.khal.enable"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.khal.enable"><code class="option">accounts.calendar.accounts.<name>.khal.enable</code></a></span></dt><dd><p>Whether to enable khal access.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.khal.color"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.khal.color"><code class="option">accounts.calendar.accounts.<name>.khal.color</code></a></span></dt><dd><p>Color in which events in this calendar are displayed.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "black", "white", "brown", "yellow", "dark gray", "dark green", "dark blue", "light gray", "light green", "light blue", "dark magenta", "dark cyan", "dark red", "light magenta", "light cyan", "light red"</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">"light green"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.khal.glob"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.khal.glob"><code class="option">accounts.calendar.accounts.<name>.khal.glob</code></a></span></dt><dd><p>The glob expansion to be searched for events or birthdays when
|
||||
type is set to discover.</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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.khal.priority"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.khal.priority"><code class="option">accounts.calendar.accounts.<name>.khal.priority</code></a></span></dt><dd><p>Priority of a calendar used for coloring.</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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.khal.readOnly"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.khal.readOnly"><code class="option">accounts.calendar.accounts.<name>.khal.readOnly</code></a></span></dt><dd><p>Keep khal from making any changes to 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>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.khal.type"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.khal.type"><code class="option">accounts.calendar.accounts.<name>.khal.type</code></a></span></dt><dd><p>There is no description of this option.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "calendar", "discover"</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.local"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.local"><code class="option">accounts.calendar.accounts.<name>.local</code></a></span></dt><dd><p>Local configuration for the calendar.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.local.encoding"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.local.encoding"><code class="option">accounts.calendar.accounts.<name>.local.encoding</code></a></span></dt><dd><p>File encoding for items, both content and file name.
|
||||
Defaults to UTF-8.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.local.fileExt"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.local.fileExt"><code class="option">accounts.calendar.accounts.<name>.local.fileExt</code></a></span></dt><dd><p>The file extension 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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.local.path"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.local.path"><code class="option">accounts.calendar.accounts.<name>.local.path</code></a></span></dt><dd><p>The path of the storage.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹accounts.contact.basePath›/‹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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.local.type"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.local.type"><code class="option">accounts.calendar.accounts.<name>.local.type</code></a></span></dt><dd><p>The type of the storage.</p><p><span class="emphasis"><em>Type:</em></span> one of "filesystem", "singlefile"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.name"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.name"><code class="option">accounts.calendar.accounts.<name>.name</code></a></span></dt><dd><p>Unique identifier of the calendar. This is set to the
|
||||
attribute name of the calendar 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.primary"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.primary"><code class="option">accounts.calendar.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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.primaryCollection"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.primaryCollection"><code class="option">accounts.calendar.accounts.<name>.primaryCollection</code></a></span></dt><dd><p>The primary collection of the account. Required when an
|
||||
account has multiple collections.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.remote"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.remote"><code class="option">accounts.calendar.accounts.<name>.remote</code></a></span></dt><dd><p>Remote configuration for the calendar.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.remote.passwordCommand"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.remote.passwordCommand"><code class="option">accounts.calendar.accounts.<name>.remote.passwordCommand</code></a></span></dt><dd><p>A command that prints the password to standard output.</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">[
|
||||
"pass"
|
||||
"caldav"
|
||||
]</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.remote.type"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.remote.type"><code class="option">accounts.calendar.accounts.<name>.remote.type</code></a></span></dt><dd><p>The type of the storage.</p><p><span class="emphasis"><em>Type:</em></span> one of "caldav", "http", "google_calendar"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.remote.url"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.remote.url"><code class="option">accounts.calendar.accounts.<name>.remote.url</code></a></span></dt><dd><p>The URL of the storage.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.remote.userName"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.remote.userName"><code class="option">accounts.calendar.accounts.<name>.remote.userName</code></a></span></dt><dd><p>User name for authentication.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.enable"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.enable"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.enable</code></a></span></dt><dd><p>Whether to enable synchronization using vdirsyncer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.auth"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.auth"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.auth</code></a></span></dt><dd><p>Authentication settings. The default is <code class="literal">basic</code>.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "basic", "digest", "guess"</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.authCert"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.authCert"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.authCert</code></a></span></dt><dd><p>Either a path to a certificate with a client certificate and
|
||||
the key or a list of paths to the files with them.</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>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.clientIdCommand"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.clientIdCommand"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.clientIdCommand</code></a></span></dt><dd><p>A command that prints the OAuth credentials to standard
|
||||
output.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/config.html#google" target="_top">https://vdirsyncer.pimutils.org/en/stable/config.html#google</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">[
|
||||
"pass"
|
||||
"client_id"
|
||||
]</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.clientSecretCommand"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.clientSecretCommand"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.clientSecretCommand</code></a></span></dt><dd><p>A command that prints the OAuth credentials to standard
|
||||
output.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/config.html#google" target="_top">https://vdirsyncer.pimutils.org/en/stable/config.html#google</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">[
|
||||
"pass"
|
||||
"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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.collections"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.collections"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.collections</code></a></span></dt><dd><p>The collections to synchronize between the storages.</p><p><span class="emphasis"><em>Type:</em></span> null or (list of (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>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.conflictResolution"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.conflictResolution"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.conflictResolution</code></a></span></dt><dd><p>What to do in case of a conflict between the storages. Either
|
||||
<code class="literal">remote wins</code> or
|
||||
<code class="literal">local wins</code> or
|
||||
a list that contains a command to run. By default, an error
|
||||
message is printed.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "remote wins", "local wins" 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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.itemTypes"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.itemTypes"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.itemTypes</code></a></span></dt><dd><p>Kinds of items to show. The default is to show everything.
|
||||
This depends on particular features of the server, the results
|
||||
are not validated.</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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.metadata"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.metadata"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.metadata</code></a></span></dt><dd><p>Metadata keys that should be synchronized when vdirsyncer
|
||||
metasync is executed.</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">[
|
||||
"color"
|
||||
"displayname"
|
||||
]</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.partialSync"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.partialSync"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.partialSync</code></a></span></dt><dd><p>What should happen if synchronization in one direction
|
||||
is impossible due to one storage being read-only.
|
||||
Defaults to <code class="literal">revert</code>.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section" target="_top">https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section</a>
|
||||
for more information.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "revert", "error", "ignore"</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.postHook"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.postHook"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.postHook</code></a></span></dt><dd><p>Command to call for each item creation and modification.
|
||||
The command will be called with the path of the new/updated
|
||||
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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.timeRange"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.timeRange"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.timeRange</code></a></span></dt><dd><p>A time range to synchronize. start and end can be any Python
|
||||
expression that returns a <code class="literal">datetime.datetime</code>
|
||||
object.</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">{
|
||||
end = "datetime.now() + timedelta(days=365)";
|
||||
start = "datetime.now() - timedelta(days=365)";
|
||||
}</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.timeRange.end"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.timeRange.end"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.timeRange.end</code></a></span></dt><dd><p>End of time range to show.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.timeRange.start"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.timeRange.start"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.timeRange.start</code></a></span></dt><dd><p>Start of time range to show.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.tokenFile"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.tokenFile"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.tokenFile</code></a></span></dt><dd><p>A file path where access tokens are stored.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.userAgent"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.userAgent"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.userAgent</code></a></span></dt><dd><p>The user agent to report to the server. Defaults to
|
||||
<code class="literal">vdirsyncer</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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.verify"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.verify"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.verify</code></a></span></dt><dd><p>Verify SSL certificate.</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/accounts/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.accounts._name_.vdirsyncer.verifyFingerprint"></a><a class="term" href="options.html#opt-accounts.calendar.accounts._name_.vdirsyncer.verifyFingerprint"><code class="option">accounts.calendar.accounts.<name>.vdirsyncer.verifyFingerprint</code></a></span></dt><dd><p>Optional. SHA1 or MD5 fingerprint of the expected server certificate.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial" target="_top">https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial</a>
|
||||
for more information.</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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.calendar.basePath"></a><a class="term" href="options.html#opt-accounts.calendar.basePath"><code class="option">accounts.calendar.basePath</code></a></span></dt><dd><p>The base directory in which to save calendars. 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>Declared by:</em></span></p><table border="0" 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/calendar.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/calendar.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts"></a><a class="term" href="options.html#opt-accounts.contact.accounts"><code class="option">accounts.contact.accounts</code></a></span></dt><dd><p>List of contacts.</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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.khal.enable"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.khal.enable"><code class="option">accounts.contact.accounts.<name>.khal.enable</code></a></span></dt><dd><p>Whether to enable khal access.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.khal.readOnly"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.khal.readOnly"><code class="option">accounts.contact.accounts.<name>.khal.readOnly</code></a></span></dt><dd><p>Keep khal from making any changes to 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>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.local"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.local"><code class="option">accounts.contact.accounts.<name>.local</code></a></span></dt><dd><p>Local configuration for the contacts.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.local.encoding"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.local.encoding"><code class="option">accounts.contact.accounts.<name>.local.encoding</code></a></span></dt><dd><p>File encoding for items, both content and file name.
|
||||
Defaults to UTF-8.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.local.fileExt"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.local.fileExt"><code class="option">accounts.contact.accounts.<name>.local.fileExt</code></a></span></dt><dd><p>The file extension 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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.local.path"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.local.path"><code class="option">accounts.contact.accounts.<name>.local.path</code></a></span></dt><dd><p>The path of the storage.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"‹accounts.contact.basePath›/‹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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.local.type"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.local.type"><code class="option">accounts.contact.accounts.<name>.local.type</code></a></span></dt><dd><p>The type of the storage.</p><p><span class="emphasis"><em>Type:</em></span> one of "filesystem", "singlefile"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.name"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.name"><code class="option">accounts.contact.accounts.<name>.name</code></a></span></dt><dd><p>Unique identifier of the contact account. This is set to the
|
||||
attribute name of the contact 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.remote"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.remote"><code class="option">accounts.contact.accounts.<name>.remote</code></a></span></dt><dd><p>Remote configuration for the contacts.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.remote.passwordCommand"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.remote.passwordCommand"><code class="option">accounts.contact.accounts.<name>.remote.passwordCommand</code></a></span></dt><dd><p>A command that prints the password to standard output.</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">[
|
||||
"pass"
|
||||
"caldav"
|
||||
]</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.remote.type"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.remote.type"><code class="option">accounts.contact.accounts.<name>.remote.type</code></a></span></dt><dd><p>The type of the storage.</p><p><span class="emphasis"><em>Type:</em></span> one of "carddav", "http", "google_contacts"</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.remote.url"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.remote.url"><code class="option">accounts.contact.accounts.<name>.remote.url</code></a></span></dt><dd><p>The URL of the storage.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.remote.userName"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.remote.userName"><code class="option">accounts.contact.accounts.<name>.remote.userName</code></a></span></dt><dd><p>User name for authentication.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.enable"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.enable"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.enable</code></a></span></dt><dd><p>Whether to enable synchronization using vdirsyncer.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.auth"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.auth"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.auth</code></a></span></dt><dd><p>Authentication settings. The default is <code class="literal">basic</code>.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "basic", "digest", "guess"</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.authCert"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.authCert"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.authCert</code></a></span></dt><dd><p>Either a path to a certificate with a client certificate and
|
||||
the key or a list of paths to the files with them.</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>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.clientIdCommand"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.clientIdCommand"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.clientIdCommand</code></a></span></dt><dd><p>A command that prints the OAuth credentials to standard
|
||||
output.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/config.html#google" target="_top">https://vdirsyncer.pimutils.org/en/stable/config.html#google</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">[
|
||||
"pass"
|
||||
"client_id"
|
||||
]</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.clientSecretCommand"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.clientSecretCommand"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.clientSecretCommand</code></a></span></dt><dd><p>A command that prints the OAuth credentials to standard
|
||||
output.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/config.html#google" target="_top">https://vdirsyncer.pimutils.org/en/stable/config.html#google</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">[
|
||||
"pass"
|
||||
"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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.collections"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.collections"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.collections</code></a></span></dt><dd><p>The collections to synchronize between the storages.</p><p><span class="emphasis"><em>Type:</em></span> null or (list of (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>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.conflictResolution"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.conflictResolution"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.conflictResolution</code></a></span></dt><dd><p>What to do in case of a conflict between the storages. Either
|
||||
<code class="literal">remote wins</code> or
|
||||
<code class="literal">local wins</code> or
|
||||
a list that contains a command to run. By default, an error
|
||||
message is printed.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "remote wins", "local wins" 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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.itemTypes"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.itemTypes"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.itemTypes</code></a></span></dt><dd><p>Kinds of items to show. The default is to show everything.
|
||||
This depends on particular features of the server, the results
|
||||
are not validated.</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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.metadata"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.metadata"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.metadata</code></a></span></dt><dd><p>Metadata keys that should be synchronized when vdirsyncer
|
||||
metasync is executed.</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">[
|
||||
"color"
|
||||
"displayname"
|
||||
]</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.partialSync"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.partialSync"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.partialSync</code></a></span></dt><dd><p>What should happen if synchronization in one direction
|
||||
is impossible due to one storage being read-only.
|
||||
Defaults to <code class="literal">revert</code>.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section" target="_top">https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section</a>
|
||||
for more information.</p><p><span class="emphasis"><em>Type:</em></span> null or one of "revert", "error", "ignore"</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.postHook"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.postHook"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.postHook</code></a></span></dt><dd><p>Command to call for each item creation and modification.
|
||||
The command will be called with the path of the new/updated
|
||||
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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.timeRange"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.timeRange"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.timeRange</code></a></span></dt><dd><p>A time range to synchronize. start and end can be any Python
|
||||
expression that returns a <code class="literal">datetime.datetime</code>
|
||||
object.</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">{
|
||||
end = "datetime.now() + timedelta(days=365)";
|
||||
start = "datetime.now() - timedelta(days=365)";
|
||||
}</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.timeRange.end"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.timeRange.end"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.timeRange.end</code></a></span></dt><dd><p>End of time range to show.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.timeRange.start"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.timeRange.start"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.timeRange.start</code></a></span></dt><dd><p>Start of time range to show.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.tokenFile"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.tokenFile"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.tokenFile</code></a></span></dt><dd><p>A file path where access tokens are stored.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.userAgent"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.userAgent"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.userAgent</code></a></span></dt><dd><p>The user agent to report to the server. Defaults to
|
||||
<code class="literal">vdirsyncer</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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.verify"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.verify"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.verify</code></a></span></dt><dd><p>Verify SSL certificate.</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/accounts/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.accounts._name_.vdirsyncer.verifyFingerprint"></a><a class="term" href="options.html#opt-accounts.contact.accounts._name_.vdirsyncer.verifyFingerprint"><code class="option">accounts.contact.accounts.<name>.vdirsyncer.verifyFingerprint</code></a></span></dt><dd><p>Optional. SHA1 or MD5 fingerprint of the expected server certificate.
|
||||
</p><p>
|
||||
See
|
||||
<a class="link" href="https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial" target="_top">https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial</a>
|
||||
for more information.</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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.nix>
|
||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.contact.basePath"></a><a class="term" href="options.html#opt-accounts.contact.basePath"><code class="option">accounts.contact.basePath</code></a></span></dt><dd><p>The base directory in which to save contacts. 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>Declared by:</em></span></p><table border="0" 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/contacts.nix#blob-path" target="_top">
|
||||
<home-manager/modules/accounts/contacts.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/thunderbird.nix#blob-path" target="_top">
|
||||
<home-manager/modules/programs/thunderbird.nix>
|
||||
|
|
|
|||
Loading…
Reference in a new issue