fork/home-manager
git clone https://git.julia.blue/fork/home-manager
75790441
master
1# launchd option type from nix-darwin 2# 3# Original Source: 4# https://github.com/LnL7/nix-darwin/blob/14a12e9/modules/launchd/launchd.nix 5 6# Copyright 2017 Daiderd Jordan 7# 8# Permission is hereby granted, free of charge, to any person obtaining 9# a copy of this software and associated documentation files (the "Software"), 10# to deal in the Software without restriction, including without limitation 11# the rights to use, copy, modify, merge, publish, distribute, sublicense, 12# and/or sell copies of the Software, and to permit persons to whom the 13# Software is furnished to do so, subject to the following conditions: 14# 15# The above copyright notice and this permission notice shall be included 16# in all copies or substantial portions of the Software. 17# 18# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 19# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 20# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 21# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 22# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 24# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 26{ config , lib , ...} : 27 28with lib ; 29 30{ 31freeformType = with types ; attrsOf anything ; # added by Home Manager 32 33options = { 34Label = mkOption { 35type = types . str ; 36description = "This required key uniquely identifies the job to launchd." ; 37}; 38 39Disabled = mkOption { 40type = types . nullOr types . bool ; 41default = null ; 42description = '' 43This optional key is used as a hint to `launchctl(1)` that it should not submit this job to launchd when 44loading a job or jobs. The value of this key does NOT reflect the current state of the job on the running 45system. If you wish to know whether a job is loaded in launchd, reading this key from a configuration 46file yourself is not a sufficient test. You should query launchd for the presence of the job using 47the `launchctl(1)` list subcommand or use the ServiceManagement framework's 48`SMJobCopyDictionary()` method. 49 50Note that as of Mac OS X v10.6, this key's value in a configuration file conveys a default value, which 51is changed with the [-w] option of the `launchctl(1)` load and unload subcommands. These subcommands no 52longer modify the configuration file, so the value displayed in the configuration file is not necessarily 53the value that `launchctl(1)` will apply. See `launchctl(1)` for more information. 54 55Please also be mindful that you should only use this key if the provided on-demand and KeepAlive criteria 56are insufficient to describe the conditions under which your job needs to run. The cost to have a 57job loaded in launchd is negligible, so there is no harm in loading a job which only runs once or very 58rarely. 59'' ; 60}; 61 62UserName = mkOption { 63type = types . nullOr types . str ; 64default = null ; 65description = '' 66This optional key specifies the user to run the job as. This key is only applicable when launchd is 67running as root. 68'' ; 69}; 70 71GroupName = mkOption { 72type = types . nullOr types . str ; 73default = null ; 74description = '' 75This optional key specifies the group to run the job as. This key is only applicable when launchd is 76running as root. If UserName is set and GroupName is not, the the group will be set to the default 77group of the user. 78'' ; 79}; 80 81inetdCompatibility = mkOption { 82default = null ; 83example = { Wait = true ; }; 84description = '' 85The presence of this key specifies that the daemon expects to be run as if it were launched from inetd. 86'' ; 87type = types . nullOr ( types . submodule { 88options = { 89Wait = mkOption { 90type = types . nullOr ( types . either types . bool types . str ); 91default = null ; 92description = '' 93This flag corresponds to the "wait" or "nowait" option of inetd. If true, then the listening 94socket is passed via the standard in/out/error file descriptors. If false, then `accept(2)` is 95called on behalf of the job, and the result is passed via the standard in/out/error descriptors. 96'' ; 97}; 98}; 99}); 100}; 101 102LimitLoadToHosts = mkOption { 103type = types . nullOr ( types . listOf types . str ); 104default = null ; 105description = '' 106This configuration file only applies to the hosts listed with this key. Note: One should set kern.hostname 107in `sysctl.conf(5)` for this feature to work reliably. 108'' ; 109}; 110 111LimitLoadFromHosts = mkOption { 112type = types . nullOr ( types . listOf types . str ); 113default = null ; 114description = '' 115This configuration file only applies to hosts NOT listed with this key. Note: One should set kern.hostname 116in `sysctl.conf(5)` for this feature to work reliably. 117'' ; 118}; 119 120LimitLoadToSessionType = mkOption { 121type = types . nullOr types . str ; 122default = null ; 123description = '' 124This configuration file only applies to sessions of the type specified. This key is used in concert 125with the -S flag to {command}`launchctl`. 126'' ; 127}; 128 129Program = mkOption { 130type = types . nullOr types . path ; 131default = null ; 132description = '' 133This key maps to the first argument of `execvp(3)`. If this key is missing, then the first element of 134the array of strings provided to the ProgramArguments will be used instead. This key is required in 135the absence of the ProgramArguments key. 136'' ; 137}; 138 139ProgramArguments = mkOption { 140type = types . nullOr ( types . listOf types . str ); 141default = null ; 142description = '' 143This key maps to the second argument of `execvp(3)`. This key is required in the absence of the Program 144key. Please note: many people are confused by this key. Please read `execvp(3)` very carefully! 145'' ; 146}; 147 148EnableGlobbing = mkOption { 149type = types . nullOr types . bool ; 150default = null ; 151description = '' 152This flag causes launchd to use the `glob(3)` mechanism to update the program arguments before invocation. 153'' ; 154}; 155 156EnableTransactions = mkOption { 157type = types . nullOr types . bool ; 158default = null ; 159description = '' 160This flag instructs launchd that the job promises to use `vproc_transaction_begin(3)` and 161`vproc_transaction_end(3)` to track outstanding transactions that need to be reconciled before the 162process can safely terminate. If no outstanding transactions are in progress, then launchd is free to 163send the SIGKILL signal. 164'' ; 165}; 166 167OnDemand = mkOption { 168type = types . nullOr types . bool ; 169default = null ; 170description = '' 171This key was used in Mac OS X 10.4 to control whether a job was kept alive or not. The default was 172true. This key has been deprecated and replaced in Mac OS X 10.5 and later with the more powerful 173KeepAlive option. 174'' ; 175}; 176 177KeepAlive = mkOption { 178type = types . nullOr ( types . either types . bool ( types . submodule { 179options = { 180 181SuccessfulExit = mkOption { 182type = types . nullOr types . bool ; 183default = null ; 184description = '' 185If true, the job will be restarted as long as the program exits and with an exit status of zero. 186If false, the job will be restarted in the inverse condition. This key implies that "RunAtLoad" 187is set to true, since the job needs to run at least once before we can get an exit status. 188'' ; 189}; 190 191NetworkState = mkOption { 192type = types . nullOr types . bool ; 193default = null ; 194description = '' 195If true, the job will be kept alive as long as the network is up, where up is defined as at least 196one non-loopback interface being up and having IPv4 or IPv6 addresses assigned to them. If 197false, the job will be kept alive in the inverse condition. 198'' ; 199}; 200 201PathState = mkOption { 202type = types . nullOr ( types . attrsOf types . bool ); 203default = null ; 204description = '' 205Each key in this dictionary is a file-system path. If the value of the key is true, then the job 206will be kept alive as long as the path exists. If false, the job will be kept alive in the 207inverse condition. The intent of this feature is that two or more jobs may create semaphores in 208the file-system namespace. 209'' ; 210}; 211 212OtherJobEnabled = mkOption { 213type = types . nullOr ( types . attrsOf types . bool ); 214default = null ; 215description = '' 216Each key in this dictionary is the label of another job. If the value of the key is true, then 217this job is kept alive as long as that other job is enabled. Otherwise, if the value is false, 218then this job is kept alive as long as the other job is disabled. This feature should not be 219considered a substitute for the use of IPC. 220'' ; 221}; 222 223Crashed = mkOption { 224type = types . nullOr types . bool ; 225default = null ; 226description = '' 227If true, the the job will be restarted as long as it exited due to a signal which is typically 228associated with a crash (SIGILL, SIGSEGV, etc.). If false, the job will be restarted in the 229inverse condition. 230'' ; 231}; 232 233AfterInitialDemand = mkOption { 234type = types . nullOr types . bool ; 235default = null ; 236}; 237 238}; 239})); 240default = null ; 241description = '' 242This optional key is used to control whether your job is to be kept continuously running or to let 243demand and conditions control the invocation. The default is false and therefore only demand will start 244the job. The value may be set to true to unconditionally keep the job alive. Alternatively, a dictionary 245of conditions may be specified to selectively control whether launchd keeps a job alive or not. If 246multiple keys are provided, launchd ORs them, thus providing maximum flexibility to the job to refine 247the logic and stall if necessary. If launchd finds no reason to restart the job, it falls back on 248demand based invocation. Jobs that exit quickly and frequently when configured to be kept alive will 249be throttled to converve system resources. 250'' ; 251}; 252 253RunAtLoad = mkOption { 254type = types . nullOr types . bool ; 255default = null ; 256description = '' 257This optional key is used to control whether your job is launched once at the time the job is loaded. 258The default is false. 259'' ; 260}; 261 262RootDirectory = mkOption { 263type = types . nullOr types . str ; 264default = null ; 265description = '' 266This optional key is used to specify a directory to `chroot(2)` to before running the job. 267'' ; 268}; 269 270WorkingDirectory = mkOption { 271type = types . nullOr types . str ; 272default = null ; 273description = '' 274This optional key is used to specify a directory to `chdir(2)` to before running the job. 275'' ; 276}; 277 278EnvironmentVariables = mkOption { 279type = types . nullOr ( types . attrsOf types . str ); 280default = null ; 281description = '' 282This optional key is used to specify additional environment variables to be set before running the 283job. 284'' ; 285}; 286 287Umask = mkOption { 288type = types . nullOr types . int ; 289default = null ; 290description = '' 291This optional key specifies what value should be passed to `umask(2)` before running the job. Known bug: 292Property lists don't support octal, so please convert the value to decimal. 293'' ; 294}; 295 296TimeOut = mkOption { 297type = types . nullOr types . int ; 298default = null ; 299description = '' 300The recommended idle time out (in seconds) to pass to the job. If no value is specified, a default time 301out will be supplied by launchd for use by the job at check in time. 302'' ; 303}; 304 305ExitTimeOut = mkOption { 306type = types . nullOr types . int ; 307default = null ; 308description = '' 309The amount of time launchd waits before sending a SIGKILL signal. The default value is 20 seconds. The 310value zero is interpreted as infinity. 311'' ; 312}; 313 314ThrottleInterval = mkOption { 315type = types . nullOr types . int ; 316default = null ; 317description = '' 318This key lets one override the default throttling policy imposed on jobs by launchd. The value is in 319seconds, and by default, jobs will not be spawned more than once every 10 seconds. The principle 320behind this is that jobs should linger around just in case they are needed again in the near future. 321This not only reduces the latency of responses, but it encourages developers to amortize the cost of 322program invocation. 323'' ; 324}; 325 326InitGroups = mkOption { 327type = types . nullOr types . bool ; 328default = null ; 329description = '' 330This optional key specifies whether `initgroups(3)` should be called before running the job. The default 331is true in 10.5 and false in 10.4. This key will be ignored if the UserName key is not set. 332'' ; 333}; 334 335WatchPaths = mkOption { 336type = types . nullOr ( types . listOf types . path ); 337default = null ; 338description = '' 339This optional key causes the job to be started if any one of the listed paths are modified. 340'' ; 341}; 342 343QueueDirectories = mkOption { 344type = types . nullOr ( types . listOf types . str ); 345default = null ; 346description = '' 347Much like the WatchPaths option, this key will watch the paths for modifications. The difference being 348that the job will only be started if the path is a directory and the directory is not empty. 349'' ; 350}; 351 352StartOnMount = mkOption { 353type = types . nullOr types . bool ; 354default = null ; 355description = '' 356This optional key causes the job to be started every time a filesystem is mounted. 357'' ; 358}; 359 360StartInterval = mkOption { 361type = types . nullOr types . int ; 362default = null ; 363description = '' 364This optional key causes the job to be started every N seconds. If the system is asleep, the job will 365be started the next time the computer wakes up. If multiple intervals transpire before the computer is 366woken, those events will be coalesced into one event upon wake from sleep. 367'' ; 368}; 369 370StartCalendarInterval = mkOption { 371default = null ; 372example = { 373Hour = 2 ; 374Minute = 30 ; 375}; 376description = '' 377This optional key causes the job to be started every calendar interval as specified. Missing arguments 378are considered to be wildcard. The semantics are much like `crontab(5)`. Unlike cron which skips job 379invocations when the computer is asleep, launchd will start the job the next time the computer wakes 380up. If multiple intervals transpire before the computer is woken, those events will be coalesced into 381one event upon wake from sleep. 382'' ; 383type = types . nullOr ( types . listOf ( types . submodule { 384options = { 385Minute = mkOption { 386type = types . nullOr types . int ; 387default = null ; 388description = '' 389The minute on which this job will be run. 390'' ; 391}; 392 393Hour = mkOption { 394type = types . nullOr types . int ; 395default = null ; 396description = '' 397The hour on which this job will be run. 398'' ; 399}; 400 401Day = mkOption { 402type = types . nullOr types . int ; 403default = null ; 404description = '' 405The day on which this job will be run. 406'' ; 407}; 408 409Weekday = mkOption { 410type = types . nullOr types . int ; 411default = null ; 412description = '' 413The weekday on which this job will be run (0 and 7 are Sunday). 414'' ; 415}; 416 417Month = mkOption { 418type = types . nullOr types . int ; 419default = null ; 420description = '' 421The month on which this job will be run. 422'' ; 423}; 424}; 425})); 426}; 427 428StandardInPath = mkOption { 429type = types . nullOr types . path ; 430default = null ; 431description = '' 432This optional key specifies what file should be used for data being supplied to stdin when using 433`stdio(3)`. 434'' ; 435}; 436 437StandardOutPath = mkOption { 438type = types . nullOr types . path ; 439default = null ; 440description = '' 441This optional key specifies what file should be used for data being sent to stdout when using `stdio(3)`. 442'' ; 443}; 444 445StandardErrorPath = mkOption { 446type = types . nullOr types . path ; 447default = null ; 448description = '' 449This optional key specifies what file should be used for data being sent to stderr when using `stdio(3)`. 450'' ; 451}; 452 453Debug = mkOption { 454type = types . nullOr types . bool ; 455default = null ; 456description = '' 457This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while 458dealing with this job. 459'' ; 460}; 461 462WaitForDebugger = mkOption { 463type = types . nullOr types . bool ; 464default = null ; 465description = '' 466This optional key specifies that launchd should instruct the kernel to have the job wait for a debugger 467to attach before any code in the job is executed. 468'' ; 469}; 470 471SoftResourceLimits = mkOption { 472default = null ; 473description = '' 474Resource limits to be imposed on the job. These adjust variables set with `setrlimit(2)`. The following 475keys apply: 476'' ; 477type = types . nullOr ( types . submodule { 478options = { 479Core = mkOption { 480type = types . nullOr types . int ; 481default = null ; 482description = '' 483The largest size (in bytes) core file that may be created. 484'' ; 485}; 486 487CPU = mkOption { 488type = types . nullOr types . int ; 489default = null ; 490description = '' 491The maximum amount of cpu time (in seconds) to be used by each process. 492'' ; 493}; 494 495Data = mkOption { 496type = types . nullOr types . int ; 497default = null ; 498description = '' 499The maximum size (in bytes) of the data segment for a process; this defines how far a program may 500extend its break with the `sbrk(2)` system call. 501'' ; 502}; 503 504FileSize = mkOption { 505type = types . nullOr types . int ; 506default = null ; 507description = '' 508The largest size (in bytes) file that may be created. 509'' ; 510}; 511 512MemoryLock = mkOption { 513type = types . nullOr types . int ; 514default = null ; 515description = '' 516The maximum size (in bytes) which a process may lock into memory using the mlock(2) function. 517'' ; 518}; 519 520NumberOfFiles = mkOption { 521type = types . nullOr types . int ; 522default = null ; 523description = '' 524The maximum number of open files for this process. Setting this value in a system wide daemon 525will set the `sysctl(3)` kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits) 526value in addition to the `setrlimit(2)` values. 527'' ; 528}; 529 530NumberOfProcesses = mkOption { 531type = types . nullOr types . int ; 532default = null ; 533description = '' 534The maximum number of simultaneous processes for this user id. Setting this value in a system 535wide daemon will set the `sysctl(3)` kern.maxproc (SoftResourceLimits) or kern.maxprocperuid 536(HardResourceLimits) value in addition to the `setrlimit(2)` values. 537'' ; 538}; 539 540ResidentSetSize = mkOption { 541type = types . nullOr types . int ; 542default = null ; 543description = '' 544The maximum size (in bytes) to which a process's resident set size may grow. This imposes a 545limit on the amount of physical memory to be given to a process; if memory is tight, the system 546will prefer to take memory from processes that are exceeding their declared resident set size. 547'' ; 548}; 549 550Stack = mkOption { 551type = types . nullOr types . int ; 552default = null ; 553description = '' 554The maximum size (in bytes) of the stack segment for a process; this defines how far a program's 555stack segment may be extended. Stack extension is performed automatically by the system. 556'' ; 557}; 558}; 559}); 560}; 561 562HardResourceLimits = mkOption { 563default = null ; 564example = { NumberOfFiles = 4096 ; }; 565description = '' 566Resource limits to be imposed on the job. These adjust variables set with `setrlimit(2)`. The following 567keys apply: 568'' ; 569type = types . nullOr ( types . submodule { 570options = { 571Core = mkOption { 572type = types . nullOr types . int ; 573default = null ; 574description = '' 575The largest size (in bytes) core file that may be created. 576'' ; 577}; 578 579CPU = mkOption { 580type = types . nullOr types . int ; 581default = null ; 582description = '' 583The maximum amount of cpu time (in seconds) to be used by each process. 584'' ; 585}; 586 587Data = mkOption { 588type = types . nullOr types . int ; 589default = null ; 590description = '' 591The maximum size (in bytes) of the data segment for a process; this defines how far a program may 592extend its break with the `sbrk(2)` system call. 593'' ; 594}; 595 596FileSize = mkOption { 597type = types . nullOr types . int ; 598default = null ; 599description = '' 600The largest size (in bytes) file that may be created. 601'' ; 602}; 603 604MemoryLock = mkOption { 605type = types . nullOr types . int ; 606default = null ; 607description = '' 608The maximum size (in bytes) which a process may lock into memory using the `mlock(2)` function. 609'' ; 610}; 611 612NumberOfFiles = mkOption { 613type = types . nullOr types . int ; 614default = null ; 615description = '' 616The maximum number of open files for this process. Setting this value in a system wide daemon 617will set the `sysctl(3)` kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits) 618value in addition to the `setrlimit(2)` values. 619'' ; 620}; 621 622NumberOfProcesses = mkOption { 623type = types . nullOr types . int ; 624default = null ; 625description = '' 626The maximum number of simultaneous processes for this user id. Setting this value in a system 627wide daemon will set the `sysctl(3)` kern.maxproc (SoftResourceLimits) or kern.maxprocperuid 628(HardResourceLimits) value in addition to the `setrlimit(2)` values. 629'' ; 630}; 631 632ResidentSetSize = mkOption { 633type = types . nullOr types . int ; 634default = null ; 635description = '' 636The maximum size (in bytes) to which a process's resident set size may grow. This imposes a 637limit on the amount of physical memory to be given to a process; if memory is tight, the system 638will prefer to take memory from processes that are exceeding their declared resident set size. 639'' ; 640}; 641 642Stack = mkOption { 643type = types . nullOr types . int ; 644default = null ; 645description = '' 646The maximum size (in bytes) of the stack segment for a process; this defines how far a program's 647stack segment may be extended. Stack extension is performed automatically by the system. 648'' ; 649}; 650}; 651}); 652}; 653 654Nice = mkOption { 655type = types . nullOr types . int ; 656default = null ; 657description = '' 658This optional key specifies what nice(3) value should be applied to the daemon. 659'' ; 660}; 661 662ProcessType = mkOption { 663type = types . nullOr 664( types . enum [ "Background" "Standard" "Adaptive" "Interactive" ]); 665default = null ; 666example = "Background" ; 667description = '' 668This optional key describes, at a high level, the intended purpose of the job. The system will apply 669resource limits based on what kind of job it is. If left unspecified, the system will apply light 670resource limits to the job, throttling its CPU usage and I/O bandwidth. The following are valid values: 671 672Background 673: Background jobs are generally processes that do work that was not directly requested by the user. 674The resource limits applied to Background jobs are intended to prevent them from disrupting the 675user experience. 676 677Standard 678: Standard jobs are equivalent to no ProcessType being set. 679 680Adaptive 681: Adaptive jobs move between the Background and Interactive classifications based on activity over 682XPC connections. See {manpage}`xpc_transaction_begin(3)` for details. 683 684Interactive 685: Interactive jobs run with the same resource limitations as apps, that is to say, none. Interactive 686jobs are critical to maintaining a responsive user experience, and this key should only be 687used if an app's ability to be responsive depends on it, and cannot be made Adaptive. 688'' ; 689}; 690 691AbandonProcessGroup = mkOption { 692type = types . nullOr types . bool ; 693default = null ; 694description = '' 695When a job dies, launchd kills any remaining processes with the same process group ID as the job. Setting 696this key to true disables that behavior. 697'' ; 698}; 699 700LowPriorityIO = mkOption { 701type = types . nullOr types . bool ; 702default = null ; 703description = '' 704This optional key specifies whether the kernel should consider this daemon to be low priority when 705doing file system I/O. 706'' ; 707}; 708 709LaunchOnlyOnce = mkOption { 710type = types . nullOr types . bool ; 711default = null ; 712description = '' 713This optional key specifies whether the job can only be run once and only once. In other words, if the 714job cannot be safely respawned without a full machine reboot, then set this key to be true. 715'' ; 716}; 717 718MachServices = mkOption { 719default = null ; 720example = { ResetAtClose = true ; }; 721description = '' 722This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system. 723Each key in this dictionary should be the name of service to be advertised. The value of the key must 724be a boolean and set to true. Alternatively, a dictionary can be used instead of a simple true value. 725 726Finally, for the job itself, the values will be replaced with Mach ports at the time of check-in with 727launchd. 728'' ; 729type = types . nullOr ( types . submodule { 730options = { 731ResetAtClose = mkOption { 732type = types . nullOr types . bool ; 733default = null ; 734description = '' 735If this boolean is false, the port is recycled, thus leaving clients to remain oblivious to the 736demand nature of job. If the value is set to true, clients receive port death notifications when 737the job lets go of the receive right. The port will be recreated atomically with respect to bootstrap_look_up() 738calls, so that clients can trust that after receiving a port death notification, 739the new port will have already been recreated. Setting the value to true should be done with 740care. Not all clients may be able to handle this behavior. The default value is false. 741'' ; 742}; 743 744HideUntilCheckIn = mkOption { 745type = types . nullOr types . bool ; 746default = null ; 747description = '' 748Reserve the name in the namespace, but cause bootstrap_look_up() to fail until the job has 749checked in with launchd. 750'' ; 751}; 752}; 753}); 754}; 755 756LaunchEvents = mkOption { 757type = types . nullOr ( types . attrs ); 758default = null ; 759description = '' 760Specifies higher-level event types to be used as launch-on-demand event 761sources. Each sub-dictionary defines events for a particular event 762subsystem, such as "com.apple.iokit.matching", which can be used to 763launch jobs based on the appearance of nodes in the IORegistry. Each 764dictionary within the sub-dictionary specifies an event descriptor that 765is specified to each event subsystem. With this key, the job promises to 766use the xpc_set_event_stream_handler(3) API to consume events. See 767xpc_events(3) for more details on event sources. 768'' ; 769example = { 770"com.apple.iokit.matching" = { 771"com.apple.usb.device" = { 772IOMatchLaunchStream = true ; 773IOProviderClass = "IOUSBDevice" ; 774idProduct = "*" ; 775idVendor = "*" ; 776}; 777}; 778}; 779}; 780 781Sockets = mkOption { 782default = null ; 783description = '' 784This optional key is used to specify launch on demand sockets that can be used to let launchd know when 785to run the job. The job must check-in to get a copy of the file descriptors using APIs outlined in 786launch(3). The keys of the top level Sockets dictionary can be anything. They are meant for the application 787developer to use to differentiate which descriptors correspond to which application level protocols 788(e.g. http vs. ftp vs. DNS...). At check-in time, the value of each Sockets dictionary key will 789be an array of descriptors. Daemon/Agent writers should consider all descriptors of a given key to be 790to be effectively equivalent, even though each file descriptor likely represents a different networking 791protocol which conforms to the criteria specified in the job configuration file. 792 793The parameters below are used as inputs to call `getaddrinfo(3)`. 794'' ; 795type = types . nullOr ( types . attrsOf ( types . submodule { 796options = { 797SockType = mkOption { 798type = types . nullOr ( types . enum [ "stream" "dgram" "seqpacket" ]); 799default = null ; 800description = '' 801This optional key tells launchctl what type of socket to create. The default is "stream" and 802other valid values for this key are "dgram" and "seqpacket" respectively. 803'' ; 804}; 805 806SockPassive = mkOption { 807type = types . nullOr types . bool ; 808default = null ; 809description = '' 810This optional key specifies whether `listen(2)` or `connect(2)` should be called on the created file 811descriptor. The default is true ("to listen"). 812'' ; 813}; 814 815SockNodeName = mkOption { 816type = types . nullOr types . str ; 817default = null ; 818description = '' 819This optional key specifies the node to `connect(2)` or `bind(2)` to. 820'' ; 821}; 822 823SockServiceName = mkOption { 824type = types . nullOr types . str ; 825default = null ; 826description = '' 827This optional key specifies the service on the node to `connect(2)` or `bind(2)` to. 828'' ; 829}; 830 831SockFamily = mkOption { 832type = types . nullOr ( types . enum [ "IPv4" "IPv6" ]); 833default = null ; 834description = '' 835This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created. 836'' ; 837}; 838 839SockProtocol = mkOption { 840type = types . nullOr ( types . enum [ "TCP" ]); 841default = null ; 842description = '' 843This optional key specifies the protocol to be passed to `socket(2)`. The only value understood by 844this key at the moment is "TCP". 845'' ; 846}; 847 848SockPathName = mkOption { 849type = types . nullOr types . path ; 850default = null ; 851description = '' 852This optional key implies SockFamily is set to "Unix". It specifies the path to `connect(2)` or 853`bind(2)` to. 854'' ; 855}; 856 857SecureSocketWithKey = mkOption { 858type = types . nullOr types . str ; 859default = null ; 860description = '' 861This optional key is a variant of SockPathName. Instead of binding to a known path, a securely 862generated socket is created and the path is assigned to the environment variable that is inherited 863by all jobs spawned by launchd. 864'' ; 865}; 866 867SockPathMode = mkOption { 868type = types . nullOr types . int ; 869default = null ; 870description = '' 871This optional key specifies the mode of the socket. Known bug: Property lists don't support 872octal, so please convert the value to decimal. 873'' ; 874}; 875 876Bonjour = mkOption { 877type = 878types . nullOr ( types . either types . bool ( types . listOf types . str )); 879default = null ; 880description = '' 881This optional key can be used to request that the service be registered with the 882`mDNSResponder(8)`. If the value is boolean, the service name is inferred from the SockServiceName. 883'' ; 884}; 885 886MulticastGroup = mkOption { 887type = types . nullOr types . str ; 888default = null ; 889description = '' 890This optional key can be used to request that the datagram socket join a multicast group. If the 891value is a hostname, then `getaddrinfo(3)` will be used to join the correct multicast address for a 892given socket family. If an explicit IPv4 or IPv6 address is given, it is required that the SockFamily 893family also be set, otherwise the results are undefined. 894'' ; 895}; 896}; 897})); 898}; 899}; 900 901config = { }; 902}