| 1 | FAQ on Documentation
|
| 2 | ====================
|
| 3 |
|
| 4 | Start here if you can't find something!
|
| 5 |
|
| 6 | <div id="toc">
|
| 7 | </div>
|
| 8 |
|
| 9 | ## How are the docs organized?
|
| 10 |
|
| 11 | Start at one of these pages:
|
| 12 |
|
| 13 | 1. The release home page at [/release/$VERSION/](../index.html) lists the docs
|
| 14 | that are ready to read, below the downloads.
|
| 15 | 1. **All Docs** at [/release/$VERSION/doc/](index.html) shows all docs, some of
|
| 16 | which are in progress. Examples:
|
| 17 | - [Simple Word Evaluation in Unix Shell](simple-word-eval.html)
|
| 18 | - [YSH Fixes Shell's Error Handling](error-handling.html)
|
| 19 | 1. The **Oils Reference** at [/release/$VERSION/doc/ref/](ref/index.html) has
|
| 20 | three indexes:
|
| 21 | - [Index of OSH Topics](ref/index-osh.html)
|
| 22 | - [Index of YSH Topics](ref/index-ysh.html)
|
| 23 | - [Index of Data Topics](ref/index-data.html)
|
| 24 |
|
| 25 | Outside of the release tree:
|
| 26 |
|
| 27 | - [The blog](https://www.oilshell.org/blog/) has useful background information,
|
| 28 | although older posts are more likely to have incorrect information.
|
| 29 | - [The home page](https://www.oilshell.org/) has links to docs for new users.
|
| 30 |
|
| 31 | ## Where do I find ...
|
| 32 |
|
| 33 | ### A list of all shell builtins?
|
| 34 |
|
| 35 | See the [Chapter on Builtin Commands](ref/chap-builtin-cmd.html) in the reference.
|
| 36 |
|
| 37 | ### A list of all YSH functions?
|
| 38 |
|
| 39 | See the [Chapter on Builtin Functions](ref/chap-builtin-func.html) in the reference.
|
| 40 |
|
| 41 | ### A list of all operators?
|
| 42 |
|
| 43 | They are split between the "sublanguages" of OSH and YSH:
|
| 44 |
|
| 45 | - [Expression Language](ref/chap-expr-lang.html) for the YSH expression
|
| 46 | language
|
| 47 | - [Word Language](ref/chap-word-lang.html) for `${x}` and so forth
|
| 48 | - [Mini Languages](ref/chap-mini-lang.html) for other shell sublanguages.
|
| 49 |
|
| 50 | ## I still can't find what I'm looking for.
|
| 51 |
|
| 52 | Please send feedback on Github or Zulip: [Where To Send
|
| 53 | Feedback](https://github.com/oilshell/oil/wiki/Where-To-Send-Feedback).
|