Why Sponsor Oil? | source | all docs for version 0.15.0 | all versions | oilshell.org

Warning: Work in progress! Leave feedback on Zulip or Github if you'd like this doc to be updated.

FAQ on Documentation

Start here if you can't find something!

How are the docs organized?

While we write the documentation, there are two different starting points:

1. /release/$VERSION/ lists the docs that are ready to read, right below the downloads.
2. /release/$VERSION/doc/ is a tour through all docs, some of which are in progress.

There's also an incomplete reference, separated by compatible features and new features:

• OSH Help Topics links to OSH Help (big doc)
• Oil Help Topics links to Oil Help (big doc)

And there are various design docs, like:

• Simple Word Evaluation in Unix Shell
• Oil Fixes Shell's Error Handling

Outside of /release/$VERSION/:

• 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?

Right now it's split between the OSH and Oil references.

• OSH Help Topics > builtins
• Oil Help Topics > builtins

A list of all Oil funcs?

• Oil Help Topics > lib. This design is not yet done.

A list of all operators?

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

• Oil Help Topics > expr-lang for the new Oil expression language
• OSH Help Topics > word-lang for ${x} and so forth
• OSH Help Topics > sublang 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.