Why Sponsor Oils? | source | all docs for version 0.22.0 | all versions | oilshell.org
Oils Reference — OSH | YSH | Data Notation
This reference has three tables of contents. They link to topics within 15 chapters.
(in progress)
OSH Table of Contents - Compatible
YSH Table of Contents - New and Powerful
help
commandWhen you type help
in OSH or YSH, it shows a URL to this reference,
or text extracted from it.
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:
This reference has a 3-level structure:
<h2>
heading in a chapter<h3>
heading in a chapter.
doc-comment
, which is used in the
help
builtin.More terminology:
help
builtin "cards". They can be
inline text, or a URL pointer. A card may also link to POSIX or bash docs.