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?

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:
  3. The Oils Reference at /release/$VERSION/doc/ref/ has three indexes:

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, 04 Feb 2024 00:32:22 -0500