OLD | NEW |
(Empty) | |
| 1 <!-- |
| 2 Copyright 2014 The Crashpad Authors. All rights reserved. |
| 3 |
| 4 Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 you may not use this file except in compliance with the License. |
| 6 You may obtain a copy of the License at |
| 7 |
| 8 http://www.apache.org/licenses/LICENSE-2.0 |
| 9 |
| 10 Unless required by applicable law or agreed to in writing, software |
| 11 distributed under the License is distributed on an "AS IS" BASIS, |
| 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 See the License for the specific language governing permissions and |
| 14 limitations under the License. |
| 15 --> |
| 16 |
| 17 # on_demand_service_tool(1) |
| 18 |
| 19 ## Name |
| 20 |
| 21 on_demand_service_tool—Load and unload on-demand Mach services registered with |
| 22 launchd(8) |
| 23 |
| 24 ## Synopsis |
| 25 |
| 26 **on_demand_service_tool** **-L** **-l** _LABEL_ [_OPTION…_] _COMMAND_ |
| 27 [_ARG…_]<br/> |
| 28 **on_demand_service_tool** **-U** **-l** _LABEL_ |
| 29 |
| 30 ## Description |
| 31 |
| 32 On-demand services may be registered with launchd(8) by using the **--load** |
| 33 form. One or more service names may be registered with the bootstrap server by |
| 34 specifying **--mach-service**. When a Mach message is sent to any of these |
| 35 services, launchd(8) will invoke _COMMAND_ along with any arguments specified |
| 36 (_ARG…_). _COMMAND_ must be an absolute pathname. |
| 37 |
| 38 The **--unload** form unregisters jobs registered with launchd(8). |
| 39 |
| 40 ## Options |
| 41 |
| 42 * **-L**, **--load** |
| 43 |
| 44 Registers a job with launchd(8). **--label**=_LABEL_ and _COMMAND_ are |
| 45 required. This operation may also be referred to as “load” or “submit”. |
| 46 |
| 47 * **-U**, **--unload** |
| 48 |
| 49 Unregisters a job with launchd(8). **--label**=_LABEL_ is required. This |
| 50 operation may also be referred to as “unload” or “remove”. |
| 51 |
| 52 * **-l**, **--label**=_LABEL_ |
| 53 |
| 54 _LABEL_ is used as the job label to identify the job to launchd(8). _LABEL_ |
| 55 must be unique within a launchd(8) context. |
| 56 |
| 57 * **-m**, **--mach-service**=_SERVICE_ |
| 58 |
| 59 In conjunction with **--load**, registers _SERVICE_ with the bootstrap |
| 60 server. Clients will be able to obtain a send right by looking up the |
| 61 _SERVICE_ name with the bootstrap server. When a message is sent to such a |
| 62 Mach port, launchd(8) will invoke _COMMAND_ along with any arguments |
| 63 specified (_ARG…_) if it is not running. This forms the “on-demand” nature |
| 64 referenced by this tool’s name. This option may appear zero, one, or more |
| 65 times. _SERVICE_ must be unique within a bootstrap context. |
| 66 |
| 67 * **--help** |
| 68 |
| 69 Display help and exit. |
| 70 |
| 71 * **--version** |
| 72 |
| 73 Output version information and exit. |
| 74 |
| 75 ## Examples |
| 76 |
| 77 Registers an on-demand server that will execute |
| 78 [catch_exception_tool(1)](catch_exception_tool.md) when a Mach message is sent |
| 79 to a Mach port obtained from the bootstrap server by looking up the name `svc`: |
| 80 |
| 81 ``` |
| 82 $ on_demand_service_tool --load --label=catch_exception \ |
| 83 --mach-service=svc \ |
| 84 $(which catch_exception_tool) --mach-service=svc \ |
| 85 --file=/tmp/out --persistent --timeout=0 |
| 86 ``` |
| 87 |
| 88 Unregisters the on-demand server installed above: |
| 89 |
| 90 ``` |
| 91 $ on_demand_service_tool --unload --label=catch_exception |
| 92 ``` |
| 93 |
| 94 ## Exit Status |
| 95 |
| 96 * **0** |
| 97 |
| 98 Success. |
| 99 |
| 100 * **1** |
| 101 |
| 102 Failure, with a message printed to the standard error stream. |
| 103 |
| 104 ## See Also |
| 105 |
| 106 [catch_exception_tool(1)](catch_exception_tool.md), |
| 107 [exception_port_tool(1)](exception_port_tool.md), |
| 108 launchctl(1) |
| 109 |
| 110 ## Resources |
| 111 |
| 112 Crashpad home page: https://crashpad.chromium.org/. |
| 113 |
| 114 Report bugs at https://crashpad.chromium.org/bug/new. |
| 115 |
| 116 ## Copyright |
| 117 |
| 118 Copyright 2014 [The Crashpad |
| 119 Authors](https://chromium.googlesource.com/crashpad/crashpad/+/master/AUTHORS). |
| 120 |
| 121 ## License |
| 122 |
| 123 Licensed under the Apache License, Version 2.0 (the “License”); |
| 124 you may not use this file except in compliance with the License. |
| 125 You may obtain a copy of the License at |
| 126 |
| 127 http://www.apache.org/licenses/LICENSE-2.0 |
| 128 |
| 129 Unless required by applicable law or agreed to in writing, software |
| 130 distributed under the License is distributed on an “AS IS” BASIS, |
| 131 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 132 See the License for the specific language governing permissions and |
| 133 limitations under the License. |
OLD | NEW |