on master help sign in
fix #42 "aspirational" argument structure, examples
commit8579bb8d3110f3a8e218002807cbaa9b73aa2f2f authorAnton Dyudin <ohAitch@gmail.com> dateWed 15 Jun 2016, 11:26 (10 years ago) parent598a706
2 files changed+29−31
docs/using/filesystem.md+17−25 docs/using/shell.md+12−6
docs/using/filesystem.md+17−25
@@ -108,28 +108,27 @@ Unmounts the path `%/web` from whatever name it was mounted as.
108108
109109Unmounts the Unix path `/generators`.
110110
111−### `|merge desk beak [strategy]`
111+### `|merge desk beak[, =gem strategy]`
112112
113113Merges a `beak` into a `desk` using an optional merge `strategy`.
114114
115−A `beak` is either a desk (`%home`), a plot-desk cell (`[~doznec
116−%home]`), or a plot-desk-case (`/~doznec/home/2/web/md`)
115+A `beak` is a ship-desk-case triple, encoded as a path(`/~doznec/home/2`)
117116
118117**Examples:**
119118
120− |merge %home-work /=home= %fine
119+ |merge %home-work /=home=, =gem %fine
121120
122121Merge `/=home=` into `%home-work` using merge strategy `%fine`.
123122
124− |merge %examples [~wacbex-ribmex %examples]
123+ |merge %examples ~wacbex-ribmex %examples
125124
126125Merge the `%examples` desk from `~waxbex-ribmex`
127126
128127### `|sync desk plot [plot-desk]`
129128
130129Subscribe to continuous updates from remote `plot` on local `desk`.
131−`plot-desk` can specify the remote `desk` name. When omitted it's
132−assumed to be the same as `desk`. Moons have `|sync %home ~parent
130+`plot-desk` can specify the remote `desk` name. When omitted it is
131+defaulted to being the same as `desk`. Ships have `|sync %home ~parent
133132%kids` automatically set up (where `~parent` is the planet that issued
134133the moon).
135134
@@ -140,8 +139,7 @@ the moon).
140139### `|unsync desk plot [plot-desk]`
141140
142141Unsubscribe from updates from remote `plot` on local `desk` with
143−optional `plot-desk`. Arguments must match original `|sync` command
144−exactly.
142+optional `plot-desk`. Arguments must match original `|sync` command.
145143
146144Example:
147145
@@ -160,7 +158,7 @@ Example:
160158`%init` - Used if it's the first commit to a desk. Also can be
161159used to "reinitialize" a desk -- revision numbers keep going up,
162160but the new revision isn't necessarily a descendent of the
163−previously-numbered version.
161+previously-numbered version, allowing merges to be rerun.
164162
165163`%this` - Keep what's in Bob's desk, but join the ancestry.
166164
@@ -209,32 +207,26 @@ Finally, we annotate any conflicts, if we know how.
209207Remove the data at `path`. `path` must be a path to actual node, not
210208a 'directory'
211209
212−### `|cp to from how`
210+### `|cp to from`
213211
214−Copy the subtree `from` into the subtree `to`, committing it with the
215−specified merge strategy `how`.
212+Copy the file at `from` into the path `to`.
216213
217−#### `|mv to from how`
214+#### `|mv to from`
218215
219−Move the subtree `from` into the subtree `to`, committing it with the
220−specified merge strategy `how`.
216+Move the file at `from` into the path `to`.
221217
222218In `%clay`, `|mv` is just a shorthand for `|cp` then `|rm`. The `|rm`
223219doesn't happen unless the `|cp` succeeds.
224220
225221### Generators
226222
227−<h3 class="first child"><code>+cat path</code> / <code>+cal [path
228−...]</code></h3>
223+<h3 class="first child"><code>+cat path [path ...]</code></h3>
229224
230−Similar to Unix `cat`. `+cat` takes a single `path`, `+cal` a list of
231−paths.
225+Similar to Unix `cat`. `+cat` takes one or more `path`s, and prints
226+their contents.
232227
233−Produces the contents of the file at the given `path`.
228+### `+ls path`
234229
235−### `+ls path` / `+ll [path ...]`
236−
237−Similar to Unix `ls`. `+ls` takes a single `path`, `+ll` a list of
238−paths.
230+Similar to Unix `ls`. `+ls` takes a single `path`.
239231
240232Produces a list of names at the `path`.
docs/using/shell.md+12−6
@@ -28,7 +28,7 @@ Evaluate a hoon expression:
2828Tall form Hoon may require multiple lines:
2929
3030 ~your-urbit:dojo> %+ add
31− ~your-urbit:dojo< 2
31+ ~your-urbit:dojo< 2
3232 ~your-urbit:dojo< 2
3333
3434Use `=var` to save a shell variable:
@@ -74,6 +74,8 @@ Run system commands from `:hood`, like `reload`, using `|`:
7474
7575**`+moon`** - Generate a random moon from a planet. No arguments.
7676
77+ ~your-urbit:dojo> +moon
78+
7779**`+solid`** - Compile the current state of the kernel and output a noun. Usually downloaded to a file in unix. No arguments.
7880
7981 ~your-urbit:dojo> .urbit/pill +solid
@@ -100,11 +102,15 @@ The hood is the system daemon. See `gen/hood` and `app/hood`.
100102
101103**`|mass`** - Prints the current memory usage of all the kernel modules. No arguments.
102104
105+ ~your-urbit:dojo> |mass
106+
103107**`|reload`** - Reloads a kernel module (vane) from source. Accepts any number of vane names.
104108
105109 ~your-urbit:dojo> |reload %clay %eyre
106110
107−**`|reset`** - Reloads `hoon.hoon`. No arguments.
111+**`|reset`** - Reloads `hoon.hoon` and all modules. No arguments.
112+
113+ ~your-urbit:dojo> |reset
108114
109115**`|start`** - Starts an app. Accepts an app name.
110116
@@ -129,7 +135,7 @@ Set any envronment variable:
129135
130136 44
131137
132−(There are a few special variables that the dojo expects. See below.)
138+(There are a few special variables that the dojo maintains. See below.)
133139
134140#### `:` - Send to app
135141
@@ -149,9 +155,9 @@ Save a new `md` file in `web`:
149155
150156The last component of the path is expected to be the mark (or mime type).
151157
152−#### `.` - Download to Unix
158+#### `.` - Export to Unix
153159
154−Download a noun to Unix with `.`:
160+Export a noun to Unix with `.`:
155161
156162 ~your-urbit:dojo> .foo/bar/baz (add 2 2)
157163
@@ -181,7 +187,7 @@ Use `_` to run a gate (or function):
181187 ~your-urbit:dojo> _|=({a/@} (mul a 3)) 3
182188 :: produces
183189 9
184− :: assign an arbitrary function to get the status code from an http request
190+ :: use a function to get the status code from an http request
185191 ~your-urbit:dojo> _|=({p/@ud q/* r/*} p) +http://google.com
186192 :: produces
187193 301