Why Sponsor Oils? | source | all docs for version 0.19.0 | all versions | oilshell.org

FAQ on Documentation

Start here if you can't find something!

How are the docs organized?

Start at one of these pages:

1. The release home page at /release/$VERSION/ lists the docs that are ready to read, below the downloads.
2. All Docs at /release/$VERSION/doc/ shows all docs, some of which are in progress. Examples:
   • Simple Word Evaluation in Unix Shell
   • YSH Fixes Shell's Error Handling
3. The Oils Reference at /release/$VERSION/doc/ref/ has three indexes:
   • Index of OSH Topics
   • Index of YSH Topics
   • Index of Data Topics

Outside of the release tree:

• The blog has useful background information, although older posts are more likely to have incorrect information.
• The home page has links to docs for new users.

Where do I find ...

A list of all shell builtins?

See the Chapter on Builtin Commands in the reference.

A list of all YSH functions?

See the Chapter on Builtin Functions in the reference.

A list of all operators?

They are split between the "sublanguages" of OSH and YSH:

• Expression Language for the YSH expression language
• Word Language for ${x} and so forth
• Mini Languages for other shell sublanguages.

I still can't find what I'm looking for.

Please send feedback on Github or Zulip: Where To Send Feedback.