@@ -8,21 +8,7 @@ This document details all the `task`s you may wish to send Jael, as well as the
88
99You may also wish to reference the [Data Types](@/docs/arvo/jael/data-types.md) document for details of the types referenced here, and the [Examples](@/docs/arvo/jael/examples.md) document for practical examples of using these `task`s.
1010
11−# Contents
12−
13−- [%dawn](#dawn) - _(Internal only)_ - Boot from keys.
14−- [%fake](#fake) - _(Internal only)_ - Boot fake ship.
15−- [%listen](#listen) - _(Usually internal)_ - Set Ethereum Source.
16−- [%meet](#meet) - _Deprecated._
17−- [%moon](#moon) - Register moon keys or otherwise administer a moon.
18−- [%nuke](#nuke) - Cancel subscription to public or private key updates.
19−- [%private-keys](#private-keys) - Subscribe to private key updates.
20−- [%public-keys](#public-keys) - Subscribe to public key (and related) updates from Jael.
21−- [%rekey](#rekey)- Update private keys.
22−- [%turf](#turf) - View domains.
23−- [%step](#step) - Reset web login code.
24−
25−# `%dawn`
11+## `%dawn`
2612
2713```hoon
2814[%dawn dawn-event]
@@ -48,11 +34,11 @@ This `task` takes a [$dawn-event](@/docs/arvo/jael/data-types.md#dawn-event) as
4834
4935You would not use this `task` manually.
5036
51−## Returns
37+### Returns
5238
5339Jael `%give`s an `%init` `gift` to Unix. This occurs after the Dill `%slip` init.
5440
55−# `%fake`
41+## `%fake`
5642
5743```hoon
5844[%fake =ship]
@@ -68,11 +54,11 @@ The `ship` field specifies the `@p` of the fake ship being created.
6854
6955You would not use this `task` manually.
7056
71−## Returns
57+### Returns
7258
7359Jael `%give`s a `%init` `gift` to Unix.
7460
75−# `%listen`
61+## `%listen`
7662
7763```hoon
7864[%listen whos=(set ship) =source]
@@ -86,11 +72,11 @@ Sets the source that the public keys for a set of `ship`s should be obtained fro
8672
8773You are unlikely to use this `task` manually.
8874
89−## Returns
75+### Returns
9076
9177Jael will not return any `gift`s in response to a `%listen` `task`.
9278
93−# `%meet`
79+## `%meet`
9480
9581```hoon
9682[%meet =ship =life =pass]
@@ -98,7 +84,7 @@ Jael will not return any `gift`s in response to a `%listen` `task`.
9884
9985This `task` is deprecated and does not perform any actions.
10086
101−# `%moon`
87+## `%moon`
10288
10389```hoon
10490[%moon =ship =udiff:point]
@@ -108,11 +94,11 @@ Register moon keys or otherwise administer a moon.
10894
10995This is what is sent to Jael by `%hood` behind the scenes when you run `|moon`, `|moon-breach` or `|moon-cycle-keys`. The `ship` field is the moon's `@p`. The [$udiff:point](@/docs/arvo/jael/data-types.md#udiff-point) will contain the bunt of an [$id:block](@/docs/arvo/jael/data-types.md#id-block) (since moons aren't registered in Azimuth) and one of the `udiff` actions depending on what you want to do.
11096
111−## Returns
97+### Returns
11298
11399Jael does not return any `gift`s in response to a `%moon` `task`.
114100
115−# `%nuke`
101+## `%nuke`
116102
117103```hoon
118104[%nuke whos=(set ship)]
@@ -124,15 +110,15 @@ If you've subscribed to public or private key updates from Jael with a [%private
124110
125111To cancel a subscription to the ship's private keys you must leave `whos` empty like `[%nuke ~]`.
126112
127−## Returns
113+### Returns
128114
129115Jael does not return a `gift` in response to a `%nuke` `task`.
130116
131−## Examples
117+### Examples
132118
133119See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#public-keys-and-nuke) section of the Examples document for an example of using `%nuke` to cancel a `%public-keys` subscription. See the thread in the [%private-keys](@/docs/arvo/jael/examples.md#private-keys) example for cancelling a `%private-keys` subscription.
134120
135−# `%private-keys`
121+## `%private-keys`
136122
137123```hoon
138124[%private-keys ~]
@@ -142,7 +128,7 @@ Subscribe to private key updates.
142128
143129Subscribe to be notified of private key updates for the local ship. The subscription will continue until Jael receives a [%nuke](#nuke) `task` to cancel it.
144130
145−## Returns
131+### Returns
146132
147133Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which looks like:
148134
@@ -152,11 +138,11 @@ Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which lo
152138
153139The `life` is the current life of the ship and the `vein` `map` contains the private key for each life up to (and including) the current one. Upon first subscribing, Jael will immediately respond with a `%private-keys` `gift`. Then, whenever the ship's private keys are changed, it'll send a new and updated `%private-keys` `gift`.
154140
155−## Example
141+### Example
156142
157143See the [%private-keys](@/docs/arvo/jael/examples.md#private-keys) section of the Examples document for a practical example.
158144
159−# `%public-keys`
145+## `%public-keys`
160146
161147```hoon
162148[%public-keys ships=(set ship)]
@@ -166,7 +152,7 @@ Subscribe to public key (and related) updates from Jael.
166152
167153An agent or thread can subscribe to be notified of public key updates, sponsorship changes and continuity breaches for the `set` of `ship`s specified in the `ships` field. The subscription will continue until Jael receives a [%nuke](#nuke) `task` to cancel it.
168154
169−## Returns
155+### Returns
170156
171157Jael responds to a `%public-keys` `task` with `%public-keys` `gift`s which look like:
172158
@@ -178,11 +164,11 @@ The [$public-keys-result](@/docs/arvo/jael/data-types.md#public-keys-result) con
178164
179165Upon subscription, Jael will immeditely respond with a `%public-keys` `gift` containing a `%full` `public-keys-result` with the public key for each `life` up until the current one for each `ship` specified in the original `task`. After than, Jael will send a `%public-keys` `gift` with either a `%diff` or `%breach` `public-keys-result` each time a change occurs for any of the `ship`s to which you're subscribed.
180166
181−## Example
167+### Example
182168
183169See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#public-keys-and-nuke) section of the Examples document for a practical example.
184170
185−# `%rekey`
171+## `%rekey`
186172
187173```hoon
188174[%rekey =life =ring]
@@ -192,11 +178,11 @@ Update private keys.
192178
193179This is what is sent to Jael by `%hood` when you run `|rekey`, as you must after setting new Azimuth keys or running `|cycle-moon-keys` on a moon's parent. It will update your `life` (key revision number) and private keys. The `life` field is the new `life` (typically an increment of the current `life`) and the `ring` is a private key `@`.
194180
195−## Returns
181+### Returns
196182
197183Jael does not return any `gift` in response to a `%rekey` `task`.
198184
199−# `%turf`
185+## `%turf`
200186
201187```hoon
202188[%turf ~]
@@ -206,7 +192,7 @@ View domains.
206192
207193The domains returned by a `%turf` `task` are used as the base for individual galaxy domain names (e.g. from `urbit.org` you get `zod.urbit.org`, `bus.urbit.org`, etc). Jael gets these from Azimuth, then Ames gets them from Jael and passes them to the runtime, which will perform the DNS lookups and give Ames back the galaxy IP addresses. A `%turf` task takes no additional arguments. You're unlikely to use this manually - if you want the current `turf`s you'd likely want to do a [turf scry](@/docs/arvo/jael/scry.md#turf) instead.
208194
209−## Returns
195+### Returns
210196
211197Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:
212198
@@ -216,11 +202,11 @@ Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:
216202
217203The `turf` in the `(list turf)` is a domain as a `(list @t)`, TLD-first. The current default is `[['org' 'urbit' ~] ~]`.
218204
219−## Example
205+### Example
220206
221207See the [%turf section of the Examples document](@/docs/arvo/jael/examples.md#turf) for a practical example.
222208
223−# `%step`
209+## `%step`
224210
225211```hoon
226212[%step ~]
@@ -230,10 +216,10 @@ Reset web login code.
230216
231217Jael maintains a `step` value that represents the web login code revision number, and uses it to derive the code itself. It begins at `0` and is incremented each time the code is changed. When Jael updates the web login code, it sends Eyre a `%code-changed` `task:eyre` so that Eyre can throw away all of its current cookies and sessions. A `%step` task takes no additional argument.
232218
233−## Returns
219+### Returns
234220
235221Jael does not return a `gift` in response to a `%step` `task`.
236222
237−## Example
223+### Example
238224
239225See the [%step](@/docs/arvo/jael/examples.md#step) section of the Examples document for a practical example.