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

FAQ on Documentation

Start here if you can't find something!

How are the docs organized?

Every release is published at /release/$VERSION/. As of 2024, it links to 2 starting points:

1. Published Docs shows docs that are ready to read. Examples:
   • Simple Word Evaluation in Unix Shell
   • YSH Fixes Shell's Error Handling
2. All Docs shows all docs.

The Oils Reference at /release/$VERSION/doc/ref/ is still in progress.

Outside of the release tree:

• The blog has useful background info. 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.