From c53c82fd9716c08e00182f0466994e710214ad0f Mon Sep 17 00:00:00 2001 From: rycee Date: Sat, 25 Mar 2023 23:16:27 +0000 Subject: [PATCH] deploy: cf662b6c98a0da81e06066fff0ecf9cbd4627727 --- options.html | 51 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 34 insertions(+), 17 deletions(-) diff --git a/options.html b/options.html index 7ebf1a8d2..8a905606b 100644 --- a/options.html +++ b/options.html @@ -975,7 +975,7 @@ of launchd's LaunchAgents.

Type: bo <home-manager/modules/launchd/default.nix>

launchd.agents.<name>.enable

Whether to enable ‹name›.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/launchd/default.nix> -
launchd.agents.<name>.config

Define a launchd job. See launchd.plist(5) for details.

Type: submodule

Default: { }

Example: 

{
+
launchd.agents.<name>.config

Define a launchd job. See launchd.plist(5) for details.

Type: attribute set of anything

Default: { }

Example: 

{
   ProgramArguments = [ "/usr/bin/say" "Good afternoon" ];
   StartCalendarInterval = [
     {
@@ -986,7 +986,7 @@ of launchd's LaunchAgents.
Type: bo
 }

Declared by:

<home-manager/modules/launchd/default.nix> -
launchd.agents.<name>.config.AbandonProcessGroup

When a job dies, launchd kills any remaining processes with the same process group ID as the job. Setting +

launchd.agents.<name>.config.AbandonProcessGroup

When a job dies, launchd kills any remaining processes with the same process group ID as the job. Setting this key to true disables that behavior.

Type: null or boolean

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.Debug

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while @@ -1043,8 +1043,8 @@ extend its break with the sbrk(2) system call.

<
launchd.agents.<name>.config.HardResourceLimits.MemoryLock

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

Type: null or signed integer

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.HardResourceLimits.NumberOfFiles

The maximum number of open files for this process. Setting this value in a system wide daemon -will set the sysctl(3) kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResource-Limits) (HardResourceLimits) -Limits) value in addition to the setrlimit(2) values.

Type: null or signed integer

Default: null

Declared by:

+will set the sysctl(3) kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits) +value in addition to the setrlimit(2) values.

Type: null or signed integer

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.HardResourceLimits.NumberOfProcesses

The maximum number of simultaneous processes for this user id. Setting this value in a system wide daemon will set the sysctl(3) kern.maxproc (SoftResourceLimits) or kern.maxprocperuid @@ -1067,18 +1067,36 @@ of conditions may be specified to selectively control whether launchd keeps a jo 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 conserve system resources.

Type: null or boolean or (submodule)

Default: null

Declared by:

+be throttled to converve system resources.

Type: null or boolean or (submodule)

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.Label

This required key uniquely identifies the job to launchd.

Type: string

Declared by:

<home-manager/modules/launchd/default.nix> +
launchd.agents.<name>.config.LaunchEvents

Specifies higher-level event types to be used as launch-on-demand event +sources. Each sub-dictionary defines events for a particular event +subsystem, such as "com.apple.iokit.matching", which can be used to +launch jobs based on the appearance of nodes in the IORegistry. Each +dictionary within the sub-dictionary specifies an event descriptor that +is specified to each event subsystem. With this key, the job promises to +use the xpc_set_event_stream_handler(3) API to consume events. See +xpc_events(3) for more details on event sources.

Type: null or (attribute set)

Default: null

Example: 

{
+  "com.apple.iokit.matching" = {
+    "com.apple.usb.device" = {
+      IOMatchLaunchStream = true;
+      IOProviderClass = "IOUSBDevice";
+      idProduct = "*";
+      idVendor = "*";
+    };
+  };
+}

Declared by:

+ <home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.LaunchOnlyOnce

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.

Type: null or boolean

Default: null

Declared by:

<home-manager/modules/launchd/default.nix> -
launchd.agents.<name>.config.LimitLoadFromHosts

This configuration file only applies to hosts NOT listed with this key. Note: One should set kern.host-name kern.hostname -name in sysctl.conf(5) for this feature to work reliably.

Type: null or (list of string)

Default: null

Declared by:

+
launchd.agents.<name>.config.LimitLoadFromHosts

This configuration file only applies to hosts NOT listed with this key. Note: One should set kern.hostname +in sysctl.conf(5) for this feature to work reliably.

Type: null or (list of string)

Default: null

Declared by:

<home-manager/modules/launchd/default.nix> -
launchd.agents.<name>.config.LimitLoadToHosts

This configuration file only applies to the hosts listed with this key. Note: One should set kern.host-name kern.hostname -name in sysctl.conf(5) for this feature to work reliably.

Type: null or (list of string)

Default: null

Declared by:

+
launchd.agents.<name>.config.LimitLoadToHosts

This configuration file only applies to the hosts listed with this key. Note: One should set kern.hostname +in sysctl.conf(5) for this feature to work reliably.

Type: null or (list of string)

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.LimitLoadToSessionType

This configuration file only applies to sessions of the type specified. This key is used in concert with the -S flag to launchctl.

Type: null or string

Default: null

Declared by:

@@ -1100,8 +1118,8 @@ checked in with launchd.

Type: null <home-manager/modules/launchd/default.nix>

launchd.agents.<name>.config.MachServices.ResetAtClose

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 job lets go of the receive right. The port will be recreated atomically with respect to bootstrap_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.

Type: null or boolean

Default: null

Declared by:

<home-manager/modules/launchd/default.nix> @@ -1159,13 +1177,12 @@ protocol which conforms to the criteria specified in the job configuration file. The parameters below are used as inputs to call getaddrinfo(3).

Type: null or (attribute set of (submodule))

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.Sockets.<name>.Bonjour

This optional key can be used to request that the service be registered with the -mDNSResponder(8). If the value is boolean, the service name is inferred from the SockService-Name. SockServiceName. -Name.

Type: null or boolean or list of string

Default: null

Declared by:

+mDNSResponder(8). If the value is boolean, the service name is inferred from the SockServiceName.

Type: null or boolean or list of string

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.Sockets.<name>.MulticastGroup

This optional key can be used to request that the datagram socket join a multicast group. If the value is a hostname, then getaddrinfo(3) will be used to join the correct multicast address for a -given socket family. If an explicit IPv4 or IPv6 address is given, it is required that the Sock-Family SockFamily -Family family also be set, otherwise the results are undefined.

Type: null or string

Default: null

Declared by:

+given socket family. If an explicit IPv4 or IPv6 address is given, it is required that the SockFamily +family also be set, otherwise the results are undefined.

Type: null or string

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.Sockets.<name>.SecureSocketWithKey

This optional key is a variant of SockPathName. Instead of binding to a known path, a securely generated socket is created and the path is assigned to the environment variable that is inherited @@ -1207,8 +1224,8 @@ extend its break with the sbrk(2) system call.

<
launchd.agents.<name>.config.SoftResourceLimits.MemoryLock

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

Type: null or signed integer

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.SoftResourceLimits.NumberOfFiles

The maximum number of open files for this process. Setting this value in a system wide daemon -will set the sysctl(3) kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResource-Limits) (HardResourceLimits) -Limits) value in addition to the setrlimit(2) values.

Type: null or signed integer

Default: null

Declared by:

+will set the sysctl(3) kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits) +value in addition to the setrlimit(2) values.

Type: null or signed integer

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.SoftResourceLimits.NumberOfProcesses

The maximum number of simultaneous processes for this user id. Setting this value in a system wide daemon will set the sysctl(3) kern.maxproc (SoftResourceLimits) or kern.maxprocperuid