@@ -14,7 +14,7 @@ This guide assumes that you have an Urbit ID, or that you have found someone to
15To connect to Bridge, go to [https://bridge.urbit.org](https://bridge.urbit.org) into your browser, and enter your identity's credentials in the appropriate fields. If you were invited to claim an Urbit ID, it's very likely that you received an email that would direct you to Bridge, and you can simply follow the hyperlink in that email.
15To connect to Bridge, go to [https://bridge.urbit.org](https://bridge.urbit.org) into your browser, and enter your identity's credentials in the appropriate fields. If you were invited to claim an Urbit ID, it's very likely that you received an email that would direct you to Bridge, and you can simply follow the hyperlink in that email.
17−Once you arrive proceed through the steps presented. You'll eventually arrive at a page with a few choices: `Invite`, `Admin`, and `Boot Arvo`. `Admin` is the only option that you're interested in right now; click on it. On the `Admin` page, click the `Download Arvo Keyfile` button. Once you have downloaded the keyfile, you can exit Bridge and proceed to [install the Urbit binary](@/install.md).
17+Once you arrive, proceed through the steps presented. You'll eventually arrive at a page with a few choices: `Invite`, `Admin`, and `Boot Arvo`. `Admin` is the only option that you're interested in right now; click on it. On the `Admin` page, click the `Download Arvo Keyfile` button. Once you have downloaded the keyfile, you can exit Bridge and proceed to [install the Urbit binary](@/install.md).
19### Offline Bridge
19### Offline Bridge
@@ -66,11 +66,11 @@ With that keyfile in hand, you can now exit Bridge and continue to the guide to
67## Using your ship {#urbit-administration}
67## Using your ship {#urbit-administration}
69−Your urbit (also called your _ship_) is a persistent Unix process that you mainly control from the console.
69+Your urbit (also called your _ship_) is a persistent Unix process that you mainly control from the console.
71### Shutdown
71### Shutdown
73−You can turn your urbit off with `Ctrl-d` from the Talk or Dojo prompts.
73+You can turn your urbit off with `Ctrl-d` from the Chat or Dojo prompts.
75You can force-quit your urbit with `Ctrl-z` from anywhere.
75You can force-quit your urbit with `Ctrl-z` from anywhere.
@@ -134,7 +134,7 @@ In the CLI, Urbit apps can process your input before you hit return. To see this
134`Ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack
134`Ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack
137−`Ctrl-d` - From Talk or Dojo, stops your Urbit process.
137+`Ctrl-d` - From Chat or Dojo, stops your Urbit process.
139`Ctrl-z` - Stops the Urbit process from _anywhere_.
139`Ctrl-z` - Stops the Urbit process from _anywhere_.
@@ -274,7 +274,7 @@ Stars and planets follow the same process DNS proxying process, and galaxies hav
275For a planet or star's DNS proxying request to be made and fulfilled, they must be hosting their ship someplace with a public IP address, and its HTTP server must be listening on port 80.
275For a planet or star's DNS proxying request to be made and fulfilled, they must be hosting their ship someplace with a public IP address, and its HTTP server must be listening on port 80.
277−To get `ship.arvo.network` on a planet or star, you must set up DNS routing with its parent ship by starting the `:dns` app.
277+To get `ship.arvo.network` on a planet or star, you must set up DNS routing with its parent ship by starting the `:dns` app.
279To do so, simply run this command in your ship's Dojo:
279To do so, simply run this command in your ship's Dojo:
@@ -288,7 +288,7 @@ You'll then be prompted to enter the public IP address of your ship. You can als
288> :dns|request .1.2.3.4
288> :dns|request .1.2.3.4
291−`:dns`, running locally, will make an HTTP request to that IP address on port 80 to confirm that it is itself available at that IP and port. If that fails, you'll receive a `%bail-early` message in `:talk`; this request will retry a few times. If the self-check is successful, the request is relayed to `~zod`, and you'll receive a message saying, `request for DNS sent to ~zod`. Once `~zod` has acknowledged receipt of the request, your local `:dns` app will send a `:talk` message saying `awaiting response from ~zod`.
291+`:dns`, running locally, will make an HTTP request to that IP address on port 80 to confirm that it is itself available at that IP and port. If that fails, you'll receive a `%bail-early` message in `:chat-cli`; this request will retry a few times. If the self-check is successful, the request is relayed to `~zod`, and you'll receive a message saying, `request for DNS sent to ~zod`. Once `~zod` has acknowledged receipt of the request, your local `:dns` app will send a `:chat-cli` message saying `awaiting response from ~zod`.
293The request will be picked up shortly, and the `ship.arvo.network` DNS record will be set to the given IP address. Once that's set up, `~zod` will be notified and `~zod` will, in turn, notify your ship. That ship will now try to verify that it can reach itself on `ship.arvo.network` over port 80. If it can't, it'll send a message saying, `unable to access via ship.arvo.network`. If it can, it will configure itself with that domain and say `confirmed access via ship.arvo.network`.
293The request will be picked up shortly, and the `ship.arvo.network` DNS record will be set to the given IP address. Once that's set up, `~zod` will be notified and `~zod` will, in turn, notify your ship. That ship will now try to verify that it can reach itself on `ship.arvo.network` over port 80. If it can't, it'll send a message saying, `unable to access via ship.arvo.network`. If it can, it will configure itself with that domain and say `confirmed access via ship.arvo.network`.
@@ -306,358 +306,145 @@ There is a command for galaxies that will try to re-use their already-necessary
307This will make HTTP-requests to self-check availability over `galaxy.$AMES-DOMAIN` (currently galaxy.urbit.org), where `galaxy` is the galaxy's name minus the `~`.
307This will make HTTP-requests to self-check availability over `galaxy.$AMES-DOMAIN` (currently galaxy.urbit.org), where `galaxy` is the galaxy's name minus the `~`.
309−Otherwise, `:dns|auto` works the same as `:dns|ip` does with stars and planets: if it's available or unavailable, talk messages, and so on.
309+Otherwise, `:dns|auto` works the same as `:dns|ip` does with stars and planets: if it's available or unavailable, Chat messages, and so on.
311### More information
311### More information
313−Configuring a ship's domain causes the `:acme` app to request an HTTPS certificate for that domain from LetsEncrypt. Note that LetsEncrypt also requires that the HTTP server be listening on port 80. If the certificate request fails, `:acme` will send a `:talk` message with an explanation. Once the certificate is successfully retrieved, `:acme` will install it, causing the HTTP servers to restart. A secure server will be started on port 443 (the HTTPS default) if it's available. Otherwise, it will try 8443, and then increment to the next port until it can successfully bind one.
313+Configuring a ship's domain causes the `:acme` app to request an HTTPS certificate for that domain from LetsEncrypt. Note that LetsEncrypt also requires that the HTTP server be listening on port 80. If the certificate request fails, `:acme` will send a `:chat-cli` message with an explanation. Once the certificate is successfully retrieved, `:acme` will install it, causing the HTTP servers to restart. A secure server will be started on port 443 (the HTTPS default) if it's available. Otherwise, it will try 8443, and then increment to the next port until it can successfully bind one.
315The built-in logic for listening on port 80 is similar. Urbit tries to bind port 80; if it cannot, it tries 8080, then increments until it can bind a port. Port 80 is available to unprivileged process on recent version of macOS. Otherwise, the process needs to either be run as root, or be given special permission (CAP\_NET_BIND on Linux).
315The built-in logic for listening on port 80 is similar. Urbit tries to bind port 80; if it cannot, it tries 8080, then increments until it can bind a port. Port 80 is available to unprivileged process on recent version of macOS. Otherwise, the process needs to either be run as root, or be given special permission (CAP\_NET_BIND on Linux).
317## Messaging {#messaging}
317## Messaging {#messaging}
319−Let’s get started using the :talk application from the command line.
319+Let’s get started using the `:chat-cli` application, also known more simply as _Chat_. It's the simplest way to talk to people using the command line interface.
321### Quickstart
321### Quickstart
323−The most common uses of :talk right now are communicating over a public chat channel on `~dopzod/urbit-help`, and sending direct messages. Everyone is more than welcome in `~dopzod/urbit-help`. It's the place to get help, ask questions and chat about Urbit in general.
323+The most common uses of `:chat-cli` right now are communicating over a public chat channel on `~dopzod/urbit-help`, and sending direct messages. Everyone is more than welcome in `~dopzod/urbit-help`. It's the place to get help, ask questions and chat about Urbit in general.
325−There are two ways of using :talk: from the terminal running the Urbit process, or through the Landscape web UI available from your ship’s URL address.
325+There are two ways of using `:chat-cli`: from the terminal running the Urbit process, or through the Landscape web UI available from your ship’s URL address, mentioned earlier in this guide.
327−If you're using Landscape for the first time, you'll need to enter a code to gain access. You can obtain this code by running `+code` from the Dojo.
327+### Joining a chat
329−### Joining a channel
329+In `:chat-cli`, any kind of medium for a message is called a _chat_. There are four types of chats: the _channel_ (public with blacklist), _village_ (private with whitelist), the _journal_ (publicly readable, privately writable), and the _mailbox_ (privately readable, publicly writable). But for now we'll be dealing with the _channel_, a publicly accessible chatroom for general use. We'll discuss the other three kinds in the [manual](#messaging-manual) section later on.
331−Hall is the Arvo vane on the back-end that manages :talk. In Hall, a medium for a message is called a _circle_. There are four types of circles, but for now we'll be dealing with the _channel_: a publicly accessible chatroom for general use. We'll discuss the other three kinds in the [manual](#messaging-manual) section later on.
333−Let's join the `~dopzod/urbit-help` channel. Use `ctrl-x` to switch from Dojo to Talk.
331+Let's join the `~dopzod/urbit-help` channel. Use `ctrl-x` to switch from the Dojo prompt to the Chat prompt.
338−~your-urbit:talk> ;join ~dopzod/urbit-help
336+~your-urbit:chat-cli> ;join ~dopzod/urbit-help
341−Scrolling down your terminal window, you'll probably see a playback of previous `~dopzod/urbit-help` messages that you missed.
339+Scrolling down your terminal window, you'll probably see a playback of previous `~dopzod/urbit-help` messages that you missed. You c
343Post a line to `~dopzod/urbit-help:`
341Post a line to `~dopzod/urbit-help:`
346−~your-urbit:talk= Hello, world!
349−You'll see your message printed below messages from others that came before it:
352−~your-urbit= Hello, world!
344+~your-urbit:chat-cli= Hello, world!
357−To send a direct message to someone, first set your audience:
360−~your-urbit:talk= ;~talsur-todres
363−You'll see your prompt change:
366−~your-urbit:talk[~talsur-todres]
369−Now you and `~talsur-todres` can exchange messages directly.
347+You'll see your message printed below messages from others that came before it. You can always type `;chats` in the `chat-cli` prompt to list all the chats you're in:
372−~your-urbit:talk[~talsur-todres] Hey buddy!
375−To set your audience back to `~dopzod/urbit-help`:
378−~your-urbit:talk[~talsur-todres] ;~dopzod/urbit-help
381−You'll see your prompt change back:
387−You can also use the ASCII "glyph" assigned to your `~dopzod/urbit-help` circle as a shortcut:
351+Glyphs will be automatically assigned to channels, but have the option of binding a glyph (single non-alphanumeric character) to the channel you're joining; the syntax is in the form of `;join ~dopzod/books +`. The chosen glyph will be the symbol that ends your prompt, and it will be what you use as a shortcut to switch to this channel.
390−~your-urbit:talk[~talsur-todres] ;=
354+~your-urbit:chat-cli= ;+
391−~your-urbit:talk=
355+~your-urbit:chat-cli+
394−(Your ship may have a different glyph than `=` for your circle)
396Use `;leave` to unsubscribe from a channel:
358Use `;leave` to unsubscribe from a channel:
399−~your-urbit:talk= ;leave ~dopzod/urbit-help
361+~your-urbit:chat-cli= ;leave ~dopzod/urbit-help
402−Last, let's create a channel we can invite some friends to:
364+Now, let's create a channel we can invite some friends to:
405−~your-urbit:talk= ;create channel %my-channel 'Some description.'
367+~your-urbit:chat-cli= ;create channel /my-channel
408Now you can tell your friends to `;join ~your-urbit/my-channel`.
370Now you can tell your friends to `;join ~your-urbit/my-channel`.
410−---
372+### Direct messaging
412−### Messaging manual {#messaging-manual}
414−Hall, the back-end Arvo vane that provides the messaging for :talk, has a design that is similar in spirit to [NNTP](https://en.wikipedia.org/wiki/Network_News_Transfer_Protocol), the underlying protocol for Usenet.
416−The design is pretty simple: Hall messages are called _posts_. Posts go to _circles_. Any urbit can host or subscribe to any number of circles.
418−There are four kinds of circles: a write-only `%mailbox` for direct messages, an invite-only %village` for private conversation, a read-only `%journal` for curated content, and a public-access `%channel` for general use.
422−A post can be a variety of different data structures. Let's look at the ones you can use from within Talk: lines, URLs, Hoon, and replies.
426−A line is simply a string of text. Depending on the filtering rules set by the circle's host, these may or may not include uppercase and Unicode characters (see [filter](#filter)).
428−If the line starts with `@`, it's an action (like `/me` in IRC).
374+To send a direct message to someone, first set your audience:
431−~your-urbit:talk= @sends a message.
377+~your-urbit:chat-cli= ;~talsur-todres
434−will print as
380+You'll see your prompt change:
437−~your-urbit sends a message.
383+~your-urbit:chat-cli[~talsur-todres]
440−#### URLs
386+Now you and `~talsur-todres` can exchange messages directly.
442−A URL is any valid URL.
445−~your-urbit:talk= https://example.com/
389+~your-urbit:chat-cli[~talsur-todres] Hey buddy!
448−#### Hoon
392+To set your audience back to `~dopzod/urbit-help`:
450−You can use Talk to evaluate Hoon code and share the results with everyone in a Hall circle. To do so, preface your Hoon with `#`.
453−~your-urbit:talk= #(add 2 2)
395+~your-urbit:chat-cli[~talsur-todres] ;~dopzod/urbit-help
456−will print as
398+You'll see your prompt change back:
459−~your-urbit# (add 2 2)
401+~your-urbit:chat-cli=
463−#### Replies
404+#### Hoon
465−To indicate what you're saying is in direct response to a specific message, select the message (see Activating Lines below) and type your response.
406+You can use Chat to evaluate Hoon code and share the results with everyone in a chat. To do so, preface your Hoon with `#`.
468−~some-urbit= Hello! How are you?
469−~your-urbit:talk= ; Well, thanks!
409+~your-urbit:chat-cli= #(add 2 2)
472will print as
412will print as
475−~your-urbit=^ Well, thanks!
478−#### Activating lines
480−A line number identifying the **subsequent** line is displayed every 5 lines.
484−~your-urbit= This is my message.
485−~your-urbit= This is another message.
486−~your-urbit sends a message.
487−~your-urbit/ http://example.com/
488~your-urbit# (add 2 2)
415~your-urbit# (add 2 2)
491−~your-urbit=^ That's my message!
494−You can use a line number to **activate** a line:
500−which prints the number, line identifier, timestamp, sender, audience,
505−0v3.hl51p.jhege.amhec.vb37r.3rejr at ~2016.6.24..04.48.21..a235
506−~your-urbit to ~another-urbit
507−in reply to: ~your-urbit:
508−> This is my message.
512−If information got truncated – like what happens for long URLs or expressions,
513−or if there's additional information available – as is the case with replies and attachments (e.g. stack traces) – activating the message will show you all the details.
515−You can also activate the most recent line with `;`, the second-most recent with `;;`, and so on.
517−### Creating and managing circles
419+### Creating and managing chats
519−As mentioned before, any urbit can host any number of circles. Existing circles can be deleted or modified with various commands. All commands in this section should be sent from the `talk>` prompt.
421+As mentioned before, any urbit can host any number of chats. Existing chats can be deleted or modified with various commands. All commands in this section should be sent from the `chat-cli>` prompt.
521#### Create
423#### Create
523−Syntax: `;create [type] %name 'description'`
425+Syntax: `;create [type] /name +`, where `+` represents an optional glyph.
525−Creates and joins a circle, where `[type]` is any of the following:
427+Creates and joins a chat, where `[type]` is any of the following:
526−- `channel`: public circle. Has a blacklist for write control.
428+- `channel`: public chat. Has a blacklist for write control.
527−- `village`: invite-only circle.
429+- `village`: invite-only chat.
528- `journal`: publicly readable, invite-only for writing.
430- `journal`: publicly readable, invite-only for writing.
529- `mailbox`: publicly writeable, can only be read by its host.
431- `mailbox`: publicly writeable, can only be read by its host.
531Let's create an example mailbox:
433Let's create an example mailbox:
534−sampel-palnet:talk> ;create mailbox %coolbox 'cool messages only'
436+sampel-palnet:chat-cli> ;create mailbox /coolbox ^
537−Something like this should print:
540−--------------| ;create mailbox %coolbox 'cool messages only'
541−--------------| :: onn %coolbox
542−--------------| bound '>' {[hos=~sampel-palnet nom=%coolbox]}
543−--------------| %coolbox: see ~sampel-palnet hear
544−--------------| new > %coolbox
545−--------------| %coolbox: cap: cool messages only
546−--------------| %coolbox: fit: caps:Y unic:â
549#### Delete
439#### Delete
551−Syntax: `;delete %name 'optional reason'`
441+Syntax: `;delete /name`
553−Deletes a circle. If a reason is specified, that gets sent to all
554−subscribers before the circle gets deleted.
556−To delete our example above:
559−sampel-palnet:talk> ;delete %coolbox 'people sent uncool messages'
562−#### Change description
564−Syntax: `;depict %name 'description'`
566−Changes the description of an existing circle `%name`.
571−sampel-palnet:talk> ;depict %coolbox 'cool messages only. NO EXCEPTIONS.'
577−Syntax: `;filter %name [capitals] [unicode]`
579−Configures the message filter for circle `%name`: whether to allow
580−capital and/or unicode characters. `y`/`&`/`true` for allowed,
581−`n`/`|`/`false` for disallowed.
583−So, to allow capital letters and disallow unicode in the circle `%coolbox`:
585−```
443+Deletes a chat.
586−sampel-palnet:talk> ;filter %coolbox & |
590−sampel-palnet:talk> ;filter %coolbox y n
593−And we get the output:
596−--------------| ;filter %coolbox & |
597−--------------| %coolbox: fit: caps:Y unic:n
602−Syntax: `;invite %name ~someone`
604−Invites someone into your circle `%name`. If they were previously banished, removes them from the blacklist. Can also invite multiple ships at once, `~comma, ~separated`.
609−~sampel-palnet:talk> ;invite %coolbox ~lodleb-ritrul
614−Syntax: `;banish %name ~someone`
616−Removes someone from your circle `%name`. If they were previously invited, removes them from the whitelist. Can also banish multiple ships at once, `~comma, ~separated`.
620−Syntax: `;source %name ~other/circle`
622−Adds `~other/circle` as a source for circle `%name`. This causes all messages sent to `~other/circle` to also appear in `%name`.
627−~sampel-palnet:talk> ;source %coolbox ~marzod/urbit-help
632−Syntax: `;unsource %name ~other/circle`
634−Removes `~other/circle` as a source for circle `%name`.
639−~sampel-palnet:talk> ;unsource %coolbox ~marzod/urbit-help
642−#### Circle membership
644−If you have joined a circle, you can make this information publicly available to help others find that circle as well.
648−Syntax: `;show ~some/circle`
650−Adds a circle to your public membership list on your Hall profile. Hall profiles are not used yet.
654−Syntax: `;hide ~some/circle`
656−Removes a circle from your public membership list on your Hall profile. Hall profiles are not used yet.
658### Status
445### Status
660−You'll see status notifications when people enter or leave circles you're subscribed to.
447+You'll see status notifications when people enter or leave chats you're subscribed to.
662#### Notifications off
449#### Notifications off
@@ -671,58 +458,12 @@ Syntax: `;unset quiet`
672Turn on status (and config) notifications.
459Turn on status (and config) notifications.
678−List everyone in all your subscribed circles. Optionally specify a
679−specific circle to list members of just those: `;who ~some/circle`
684−~sampel-palnet:talk> ;who ~marzod/urbit-help
689−Syntax: `;attend ~some/circle [presence]`
691−Manually set your presence to show up as one of the following. (In the
692−future, a sufficiently advanced client can automatically set these for
698−- `gone` - not present
703−~sampel-palnet:talk> ;attend ~marzod/urbit-help idle
706−#### Set display name
708−Syntax: `;name ~some/circle 'my handle'`
710−Set a handle ("name") for yourself in a specific circle. It will display
711−to users who have done `;set nicks`, but gets truncated if it's longer
716−An audience consists of one or more messaging targets. These can be
717−circles or ships. (In the latter case, it's secretly the `~ship/inbox`
720−#### Circle glyphs
461+#### Chat glyphs
722Glyphs are found at the end of your prompt to as a quick indicator of where
463Glyphs are found at the end of your prompt to as a quick indicator of where
723your messages will be sent.
464your messages will be sent.
725−Glyphs are assigned by circle hash out of the following list:
466+Glyphs are assigned by chat hash out of the following list:
728> = + - } ) , . " ' ^ $ % & @
469> = + - } ) , . " ' ^ $ % & @
@@ -732,25 +473,25 @@ Alphanumeric characters and `|#;:*~_` are reserved; all others (the
732above list, and `\/!?({<`) can be manually assigned.
473above list, and `\/!?({<`) can be manually assigned.
734For example, `-` the glyph at the end of the prompt below might indicates that
475For example, `-` the glyph at the end of the prompt below might indicates that
735−messages sent from this prompt will go to some circle with that glyph:
476+messages sent from this prompt will go to some chat with that glyph:
738−~sampel-palnet:talk-
479+~sampel-palnet:chat-cli-
741−To see what circle is bound to a glyph, use the `;what` command followed by the
482+To see what chat is bound to a glyph, use the `;what` command followed by the
742−glyph in question, or use `;what` without specifying a glyph to see all of your
483+glyph in question, or use `;what` without specifying a glyph to see all of your
743subscriptions which are bound to glyphs. For example, to see `=`:
484subscriptions which are bound to glyphs. For example, to see `=`:
746−~sampel-palnet:talk> ;what =
487+~sampel-palnet:chat-cli> ;what =
747~dopzod/urbit-help
488~dopzod/urbit-help
750To see all of your glyph-bound subscriptions:
491To see all of your glyph-bound subscriptions:
753−~sampel-palnet:talk> ;what
494+~sampel-palnet:chat-cli> ;what
754> ~paldev/numismatic-forum
495> ~paldev/numismatic-forum
755. ~middev/ny-martians
496. ~middev/ny-martians
756= ~dopzod/urbit-help
497= ~dopzod/urbit-help
@@ -761,31 +502,31 @@ such as in the case of direct-messaging a ship, we see their name at the end of
761the prompt instead. Here we're talking directly to `~dannum-mitryl`:
502the prompt instead. Here we're talking directly to `~dannum-mitryl`:
764−~sampel-palnet:talk[~dannum-mitryl]
505+~sampel-palnet:chat-cli[~dannum-mitryl]
769−Syntax: `;bind [glyph] /circle-name`
510+Syntax: `;bind [glyph] /chat-name`
771−Assigns the chosen glyph to a circle owned by your ship.
512+Assigns the chosen glyph to a chat owned by your ship.
773For example:
514For example:
776−~sampel-palnet:talk> ;bind + /my-circle
517+~sampel-palnet:chat-cli> ;bind + /my-chat
779#### Unbind
520#### Unbind
781−Syntax: `;unbind [glyph] /circle-name`
522+Syntax: `;unbind [glyph] /chat-name`
783−Unassigns the chosen glyph from a circle owned by your ship.
524+Unassigns the chosen glyph from a chat owned by your ship.
785For example:
526For example:
788−~sampel-palnet:talk> ;unbind + /my-circle
529+~sampel-palnet:chat-cli> ;unbind + /my-chat
791#### Prefixes
532#### Prefixes
@@ -806,15 +547,15 @@ There are a few special-purpose glyphs:
807#### Set audience
548#### Set audience
809−`;~ship/circle`
550+`;~ship/chat`
811−Set audience to `~ship/circle`.
552+Set audience to `~ship/chat`.
813#### Set audience by glyph
554#### Set audience by glyph
815Syntax: `;[glyph]`
556Syntax: `;[glyph]`
817−Set audience to the circle previously bound to the chosen glyph.
558+Set audience to the chat previously bound to the chosen glyph.
819#### Set audience to ship
560#### Set audience to ship
@@ -822,11 +563,11 @@ syntax `;~ship`
823Set audience to another ship.
564Set audience to another ship.
825−#### Set audience to own circle
566+#### Set audience to own chat
827−Syntax: `;%circle`
568+Syntax: `;%chat`
829−Set audience to a circle on your own ship.
570+Set audience to a chat on your own ship.
831#### Set audience and send message
572#### Set audience and send message
@@ -841,62 +582,13 @@ Your audience is configured with regard to the following rules (in order):
841- if you activated a post, the post you activated.
582- if you activated a post, the post you activated.
842- audience of the last post sent.
583- audience of the last post sent.
850−List all local nicknames.
854−Syntax: `;nick ~some-urbit`
856−Look up a nickname using the known ship-name.
858−#### Reverse-find nickname
860−syntax: `;nick plato`
862−Find a ship's name using its nickname.
866−Syntax: `;nick ~some-urbit plato`
868−Create a new nickname.
872−Syntax: `;nick ~some-urbit ~`
874−Clear an assigned nickname.
876−#### Display nicknames, not ship names
880−Show nicknames instead of ship-names. If no local nickname is set, uses
881−that user's handle. If the user has no handle, just the urbit name.
883−#### Display ship names, not nicknames
885−Syntax: `;unset nicks`
887−Show ship-names instead of nicknames.
889−Nicknames and handles longer than 14 characters will be truncated in
890−output. Nicknames are strictly local – like the names on entries in a
893### Miscellaneous configuration
585### Miscellaneous configuration
895#### Show timestamps
587#### Show timestamps
897Syntax: `;set showtime`
589Syntax: `;set showtime`
899−Show the timestamp for each message.
591+Show the timestamp for each message. This is set by default.
901#### Hide timestamps
593#### Hide timestamps
@@ -915,7 +607,7 @@ Adjust the display of timestamps to a specific timezone. Relative to UTC.
915Syntax: `;set notify`
607Syntax: `;set notify`
917Emit a terminal bell sound if your six-syllable ship name is mentioned in
609Emit a terminal bell sound if your six-syllable ship name is mentioned in
918−a message.
610+a message. This is set by default.
920#### Sound notification off
612#### Sound notification off
@@ -927,7 +619,7 @@ Do not notify when your ship name is mentioned.
928Syntax: `;set width [number]`
620Syntax: `;set width [number]`
930−Set the rendering width of `:talk` to a specific number of characters.
622+Set the rendering width of `:chat-cli` to a specific number of characters.
931(Minimum of 30.)
623(Minimum of 30.)
@@ -978,7 +670,7 @@ face in a `.hoon` file in this way.
978Use `=dir` to set the current working directory:
670Use `=dir` to set the current working directory:
981−~your-urbit:dojo> =dir %/web
673+~your-urbit:dojo> =dir %/gen
984(`%` represents your current directory. For a complete explanation on urbit
676(`%` represents your current directory. For a complete explanation on urbit
@@ -1046,8 +738,8 @@ Just prints the argument. Accepts a `@ta`.
1046Similar to Unix `ls`. Accepts a path.
738Similar to Unix `ls`. Accepts a path.
1049−~your-urbit:dojo> +ls %/web
741+~your-urbit:dojo> +ls %/gen
1050−~your-urbit:dojo> +ls /~talsur-todres/home/2/web/notes
742+~your-urbit:dojo> +ls /~talsur-todres/home/2/gen/program
1053#### `+moon`
745#### `+moon`
@@ -1090,7 +782,7 @@ Generate a ticket for an urbit ship. Takes an urbit name (`@p`).
1090Generate a recursive directory listing. Takes a path.
782Generate a recursive directory listing. Takes a path.
1093−~your-urbit:dojo> +tree %/web
785+~your-urbit:dojo> +tree %/sys
@@ -1185,10 +877,10 @@ Apps usually expect marked data, so `&` is often used here.
1186#### `*` - Save in `%clay`
878#### `*` - Save in `%clay`
1188−Save a new `.udon` ([Udon](@/docs/arvo/sail-and-udon.md)) file in `web`:
880+Save a new `.hoon` file in `gen`:
1191−~your-urbit:dojo> *%/web/foo/udon '# hello'
883+~your-urbit:dojo> *%/gen/foo/hoon '# hello'
1194The last component of the path is expected to be the mark (or mime
886The last component of the path is expected to be the mark (or mime
@@ -1292,7 +984,7 @@ Current working `%clay` desk and revision. Read / write.
1292**Examples:**
984**Examples:**
1295−~your-urbit:dojo> =dir %/web
987+~your-urbit:dojo> =dir %/gen
1296~your-urbit:dojo> +ls %
988~your-urbit:dojo> +ls %
1297404/hoon docs/ dojo/hoon lib/ listen/hoon md static/udon talk/ testing/udon tree/main/ unmark/ womb/
989404/hoon docs/ dojo/hoon lib/ listen/hoon md static/udon talk/ testing/udon tree/main/ unmark/ womb/
@@ -1383,6 +1075,10 @@ This quick-start guide will walk you through some common commands. Follow along
1383using your Dojo. When you get a `>=` message after entering a command, this means
1075using your Dojo. When you get a `>=` message after entering a command, this means
1384that the command was successful.
1076that the command was successful.
1078+It's important to note that whenever you want to sync changes from your Unix
1079+directory to your ship, you must use the `|commit %desk` command, where `%desk`
1080+is the desk that you'd like to sync to.
1386When developing it's a good idea to use a separate desk. Create a `%sandbox`
1082When developing it's a good idea to use a separate desk. Create a `%sandbox`
1387desk based on the `%home` desk:
1083desk based on the `%home` desk:
@@ -1419,37 +1115,6 @@ is just like using `ls` in a Unix terminal.
1419Notice how `+cat %` does the same thing. That's because everything in Clay,
1115Notice how `+cat %` does the same thing. That's because everything in Clay,
1420including directories, is a file.
1116including directories, is a file.
1422−Let's explore the `/web` directory of the `%sandbox` desk.
1425−~your-urbit:dojo> +ls /=sandbox=/web
1428−Let's see the contents of `/=sandbox=/web/404/hoon`:
1431−~your-urbit:dojo> +cat /=sandbox=/web/404/hoon
1434−Now let's navigate to `/web` on `%sandbox` using `=dir`, which is like `cd` in Unix.
1437−~your-urbit:dojo> =dir /=sandbox=/web
1440−You'll notice that your prompt is now
1441−`~your-urbit:dojo/=/sandbox/~2018.10.2..00.35.44..d7e8/web>`.
1444−~your-urbit:dojo/=/sandbox/~2018.10.2..00.35.44..d7e8/web> +ls %
1447−To change back to our home directory, we use `=dir` without any path.
1450−~your-urbit:dojo/=/sandbox/~2018.10.2..00.35.44..d7e8/web> =dir
1453Sync from your friend `~some-ship`'s `%experiment` desk to your
1118Sync from your friend `~some-ship`'s `%experiment` desk to your
1454`%sandbox` desk:
1119`%sandbox` desk:
@@ -1637,12 +1302,6 @@ Mount the `clay-path` at the Unix mount point `Unix-name`.
1638**Examples:**
1303**Examples:**
1644−Mounts `%/web` to `/web` inside your pier directory.
1647|mount %/gen generators
1306|mount %/gen generators
@@ -1660,10 +1319,10 @@ Unmount the path or name from Unix.
1660**Examples:**
1319**Examples:**
1663−|unmount %/web
1322+|unmount %/gen
1666−Unmounts the path `%/web` from whatever name it was mounted as.
1325+Unmounts the Clay path `%/gen` from whatever name it was mounted as.
1669|unmount %generators
1328|unmount %generators
@@ -1835,4 +1494,4 @@ Syntax: `|mv to from`
1835Move the file at `from` into the path `to`.
1494Move the file at `from` into the path `to`.
1837In Clay, `|mv` is just a shorthand for `|cp` then `|rm`. The `|rm`
1496In Clay, `|mv` is just a shorthand for `|cp` then `|rm`. The `|rm`
1838−doesn't happen unless the `|cp` succeeds.
1497+doesn't happen unless the `|cp` succeeds.