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

This reference has three tables of contents. They link to topics within 15 chapters.

(in progress)

1. JSON / J8 Notation
2. Errors

3. Types and Methods
4. Builtin Functions
5. Builtin Commands
6. Front End
7. Command Language
8. Standard Library
9. OSH Assignment
10. YSH Command Language Keywords
11. Word Language
12. YSH Expression Language
13. Mini Languages
14. Global Shell Options
15. Special Variables
16. Plugins and Hooks

Topics By Feature - topics for modules, env vars, etc.

help command

When you type help in OSH or YSH, it shows a URL to this reference, or text extracted from it.

About

The source files for this reference are in Markdown:

REPO/
  doc/
    release-index.md     # /release/$VERSION/

    index.md             # All Docs on Oils, /release/$VERSION/doc/
    getting-started.md
    ...

    ref/
      index.md           # this page, the Oils Reference
      toc-osh.md         # OSH topics
      toc-ysh.md         # YSH topics
      toc-data.md        # Data language topics

      chap-cmd-lang.md   # chapter on the command language
      chap-front-end.md
      ...

The URLs mirror the source, with minor differences:

/release/$VERSION/
  index.html
  doc/
    index.html
    getting-started.html
    ...

    ref/
      index.html
      toc-osh.html
      toc-ysh.html
      toc-data.html

      chap-cmd-lang.html
      chap-front-end.html
      ...

You can link to topics with internal anchors:

• chap-cmd-lang.html#simple-command
• chap-builtin-cmd.html#compgen

Terminology

This reference has a 3-level structure:

1. Chapter - A big HTML page.
   • A chapter may apply to OSH, YSH, or both.
2. Section - An <h2> heading in a chapter
3. Topic - An <h3> heading in a chapter.
   • It has a globally unique name like doc-comment, which is used in the help builtin.
   • A topic may apply to OSH, YSH, or both.

More terminology:

• Table of Contents - a doc with a dense list of topic links.
• Card - Some topics are exported as help builtin "cards". They can be inline text, or a URL pointer. A card may also link to POSIX or bash docs.