on master help sign in
Merge pull request #682 from urbit/knob
b04a0b3rmariani
tutorials/ship-troubleshooting.md+34−7
@@ -19,21 +19,48 @@ Urbit is still in the development stage, so there's a chance that your ship won'
19
19
20An ounce of prevention is worth a pound of cure, so let's first go over some best practices to keep your ship in working order.
20An ounce of prevention is worth a pound of cure, so let's first go over some best practices to keep your ship in working order.
21
21
22−**Only boot with your keyfile once.** Once your ship is booted with your keyfile, you should never use that same keyfile again. If you do boot with the same keyfile twice, any other ship on the network that your ship has communicated with will never be able to talk to it again.
22+### Only boot with your keyfile once.** Once your ship is booted with your keyfile, you should never use that same keyfile again. If you do boot with the same keyfile twice, any other ship on the network that your ship has communicated with will never be able to talk to it again.
23
23
24If you accidentally booted with the same keyfile twice, the only remedy is performing a [personal breach](#personal-breach), which is explained in the next section.
24If you accidentally booted with the same keyfile twice, the only remedy is performing a [personal breach](#personal-breach), which is explained in the next section.
25
25
26−**Do not delete your pier.** Urbit is stateful, meaning that it needs to hold onto all your data. If you delete your pier and start your ship again, you won't be able to talk to any ship you've talked to before. The only solution to this is performing a [personal breach](#personal-breach)
26+### Do not delete your pier
27
27
28−**Keep track of the directory that you put your ship in.** When you first start your ship, you should make sure you put it a place where you can find it again and where it won't get accidentally deleted. Remember that you must perform `|mount %` in your ship's Dojo to make your ship visible as a directory in the Unix file system.
28+Urbit is stateful, meaning that it needs to hold onto all your data. If you delete your pier and start your ship again, you won't be able to talk to any ship you've talked to before. The only solution to this is performing a [personal breach](#personal-breach)
29
29
30−**Avoid killing the Urbit process directly.** The best way to end an urbit process is to use `ctrl-d` from the Dojo. Unix methods to kill the process, such as with `ctrl-z` or with the `kill` Bash command, or simply closing the window, should only be used if `ctrl-d` does not work.
30+### Keep track of the directory that you put your ship in.
31
31
32−**Keep up-to-date builds.** Check for latest Urbit version at https://github.com/urbit/urbit/releases. If you're behind, update using [this guide](/operations/)
32+When you first start your ship, you should make sure you put it a place where you can find it again and where it won't get accidentally deleted. Remember that you must perform `|mount %` in your ship's Dojo to make your ship visible as a directory in the Unix file system.
33
33
34−**`|hi` your star to see if you're connected.** Find out who your star is by running `(sein:title our now our)` in the Dojo. Then, run `|hi ~star`, where `~star` is the star's name, and if things are working properly, you should get the message `hi ~star successful`. It could also be helpful to use `|hi` to check connectivity with `~zod` or another planet that you're in a Talk channel with.
34+### Avoid killing the Urbit process directly.
35+The best way to end an urbit process is to use `ctrl-d` from the Dojo. Unix methods to kill the process, such as with `ctrl-z` or with the `kill` Bash command, or simply closing the window, should only be used if `ctrl-d` does not work.
35
36
37+### Keep up-to-date builds.
38+
39+Check for latest Urbit version at https://github.com/urbit/urbit/releases. If you're behind, update using [this guide](/operations/)
40+
41+### `|hi` your star to see if you're connected.
42+
43+Find out who your star is by running `(sein:title our now our)` in the Dojo. Then, run `|hi ~star`, where `~star` is the star's name, and if things are working properly, you should get the message `hi ~star successful`. It could also be helpful to use `|hi` to check connectivity with `~zod` or another planet that you're in a Talk channel with.
44+
45+### Turn your ship off and on again.
46+
36−**Turn your ship off and on again.** Use `ctrl-d` to gracefully exit your ship, and then start it again. This can solve many issues.
47+Use `ctrl-d` to gracefully exit your ship, and then start it again. This can solve many issues.
48+
49+### Use the `|knob` command to customize your error messages
50+
51+Error messages can be by overwhelming, so the `|knob` command is intended to remedy this. It's used to silence errors that aren't important.
52+
53+The command takes two arguments, and comes in the form of `|knob %error-tag %level`.
54+
55+`%error-tag` is the name of the error in question. It's usually printed at the top of the stack trace, such as in `crud: %hole event failed` -- `%hole` here is an example of an error tag.
56+
57+`%level` determines how much you will see of errors with your chosen `%error-tag`. There are three levels:
58+
59+- `%hush`: no output.
60+- `%soft`: one line of output, just containing the error tag.
61+- `%loud`: full output.
62+
63+So for example, to silence all Ames packet-related errors, try `|knob %hole %hush`.
37
64
38### Perform a personal breach. {#personal-breach}
65### Perform a personal breach. {#personal-breach}
39
66