FAQ on Documentation

Start here if you can't find something!

Table of Contents
How are the docs organized?
Where do I find ...
A list of all shell builtins?
A list of all YSH functions?
A list of all operators?
I still can't find what I'm looking for.

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:
  2. All Docs shows all docs.

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

Outside of the release tree:

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:

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

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

Generated on Sun, 28 Jul 2024 05:44:54 +0000