1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-11 05:39:44 +01:00
This commit is contained in:
rycee 2022-02-26 11:36:46 +00:00
parent 9d9a34d1ab
commit 452aec530a
4 changed files with 422 additions and 10 deletions

File diff suppressed because one or more lines are too long

View file

@ -1087,6 +1087,415 @@ for details on supported values.
</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">
&lt;home-manager/modules/i18n/input-method/uim.nix&gt;
</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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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 submodules</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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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 strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.config.Sockets.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 submodules</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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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 paths</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" 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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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.&lt;name&gt;.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">
&lt;home-manager/modules/launchd/default.nix&gt;
</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 sets</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">

View file

@ -8,7 +8,10 @@ Note, the support is quite limited at the moment.
Specifically, it only applies to parts of the system written in the Bash language,
such as the <code class="literal">home-manager</code> command line tool and the activation script.
</p><p class="simpara">If you would like to contribute to the translation effort
then you can do so through the <a class="link" href="https://hosted.weblate.org/projects/home-manager/" target="_top">Home Manager Weblate project</a>.</p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-22.05-state-version-changes"></a>E.1.2. State Version Changes</h3></div></div></div><p>The state version in this release includes the changes below.
then you can do so through the <a class="link" href="https://hosted.weblate.org/projects/home-manager/" target="_top">Home Manager Weblate project</a>.</p></li><li class="listitem">
A new module, <code class="literal">launchd.agents</code> was added.
Use this to enable services based on macOS LaunchAgents.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-22.05-state-version-changes"></a>E.1.2. State Version Changes</h3></div></div></div><p>The state version in this release includes the changes below.
These changes are only active if the <code class="literal">home.stateVersion</code> option is set to "22.05" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a> option now allows defining modules directly under <a class="xref" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a>.
Defining modules under <code class="literal">programs.waybar.settings.modules</code> will now be an error.

View file

@ -1,6 +1,6 @@
<?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 D. Tools</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="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /><link rel="next" href="release-notes.html" title="Appendix E. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nix-darwin-options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-tools"></a>Appendix D. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737309366528"><span class="command"><strong>home-manager</strong></span>
</a></span><span class="refpurpose"> — reconfigure a user environment</span></dt></dl></div><div class="refentry"><a id="idm140737309366528"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><span class="command"><strong>home-manager</strong></span>
<!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 D. Tools</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="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /><link rel="next" href="release-notes.html" title="Appendix E. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nix-darwin-options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-tools"></a>Appendix D. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737308924192"><span class="command"><strong>home-manager</strong></span>
</a></span><span class="refpurpose"> — reconfigure a user environment</span></dt></dl></div><div class="refentry"><a id="idm140737308924192"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><span class="command"><strong>home-manager</strong></span>
— reconfigure a user environment</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">home-manager</code> {
build
|
@ -84,7 +84,7 @@
|
--verbose
}
]</p></div></div><div class="refsection"><a id="idm140737309329232"></a><h2>Description</h2><p>
]</p></div></div><div class="refsection"><a id="idm140737308886752"></a><h2>Description</h2><p>
This command updates the user environment so that it corresponds to the
configuration specified in <code class="filename">~/.config/nixpkgs/home.nix</code> or <code class="filename">~/.config/nixpkgs/flake.nix</code>.
</p><p>
@ -153,7 +153,7 @@
available for immediate garbage collection.
</p></li></ul></div><p>
</p></dd></dl></div><p>
</p></div><div class="refsection"><a id="idm140737309291488"></a><h2>Options</h2><p>
</p></div><div class="refsection"><a id="idm140737308849104"></a><h2>Options</h2><p>
The tool accepts the options
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<code class="option">-A <em class="replaceable"><code>attrPath</code></em></code>
@ -265,15 +265,15 @@
<code class="option">--verbose</code>
</span></dt><dd><p>
Activates verbose output.
</p></dd></dl></div></div><div class="refsection"><a id="idm140737309225360"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
</p></dd></dl></div></div><div class="refsection"><a id="idm140737308782976"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<code class="filename">$XDG_DATA_HOME/home-manager/news-read-ids</code>
</span></dt><dd><p>
Identifiers of news items that have been shown. Can be deleted to reset
the read news indicator.
</p></dd></dl></div></div><div class="refsection"><a id="idm140737309222064"></a><h2>Bugs</h2><p>
</p></dd></dl></div></div><div class="refsection"><a id="idm140737308779680"></a><h2>Bugs</h2><p>
Please report any bugs on the
<a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">project
issue tracker</a>.
</p></div><div class="refsection"><a id="idm140737309220064"></a><h2>See also</h2><p>
</p></div><div class="refsection"><a id="idm140737308777680"></a><h2>See also</h2><p>
<span class="citerefentry"><span class="refentrytitle">home-configuration.nix</span>(5)</span>
</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="nix-darwin-options.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix C. nix-darwin Module Options </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix E. Release Notes</td></tr></table></div></body></html>