Skip to content

Latest commit

 

History

History
 
 

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
old-rfc
old-rfc
 
 
README.md
README.md
 
 
architecture-notes.md
architecture-notes.md
 
 
command-vs-expression-mode.md
command-vs-expression-mode.md
 
 
deprecations.md
deprecations.md
 
 
doc-plugins.md
doc-plugins.md
 
 
doc-toolchain.md
doc-toolchain.md
 
 
eggex.md
eggex.md
 
 
errexit.md
errexit.md
 
 
errors.md
errors.md
 
 
expression-language.md
expression-language.md
 
 
framing.md
framing.md
 
 
future.md
future.md
 
 
headless.md
headless.md
 
 
help-deferred.md
help-deferred.md
 
 
idioms.md
idioms.md
 
 
index.md
index.md
 
 
interpreter-state.md
interpreter-state.md
 
 
io-builtins.md
io-builtins.md
 
 
json.md
json.md
 
 
known-differences.md
known-differences.md
 
 
language-influences.md
language-influences.md
 
 
legacy-array.md
legacy-array.md
 
 
modules.md
modules.md
 
 
oil-builtins.md
oil-builtins.md
 
 
oil-help-topics.md
oil-help-topics.md
 
 
oil-help.md
oil-help.md
 
 
oil-keywords.md
oil-keywords.md
 
 
oil-language-faq.md
oil-language-faq.md
 
 
oil-language-tour.md
oil-language-tour.md
 
 
oil-special-vars.md
oil-special-vars.md
 
 
oil-vs-python.md
oil-vs-python.md
 
 
oil-vs-shell.md
oil-vs-shell.md
 
 
old-quick-ref.txt
old-quick-ref.txt
 
 
options.md
options.md
 
 
osh-help-topics.md
osh-help-topics.md
 
 
osh-help.md
osh-help.md
 
 
osh-manual.md
osh-manual.md
 
 
osh.1
osh.1
 
 
parser-architecture.md
parser-architecture.md
 
 
process-model.md
process-model.md
 
 
project-tour.md
project-tour.md
 
 
qsn.md
qsn.md
 
 
qtt.md
qtt.md
 
 
quirks.md
quirks.md
 
 
regex-manual.md
regex-manual.md
 
 
release-index.md
release-index.md
 
 
shell-idioms.md
shell-idioms.md
 
 
simple-word-eval.md
simple-word-eval.md
 
 
strings.md
strings.md
 
 
syntactic-concepts.md
syntactic-concepts.md
 
 
syntax-feelings.md
syntax-feelings.md
 
 
tea-help-topics.md
tea-help-topics.md
 
 
toil.md
toil.md
 
 
unicode.md
unicode.md
 
 
variable-scope.md
variable-scope.md
 
 
variables.md
variables.md
 
 
warts.md
warts.md
 
 
what-is-oil.md
what-is-oil.md
 
 
word-eval.txt
word-eval.txt
 
 
word-language.md
word-language.md
 
 
xtrace.md
xtrace.md
 
 

README.md

Documentation

HTML Docs

I build these with a wrapper around CommonMark. Try:

devtools/cmark.sh download
devtools/cmark.sh build
devtools/cmark.sh run-tests

And then:

build/doc.sh all-markdown

The output HTML shows up in _release/VERSION/doc.

See doc-toolchain.md for details.

Man pages

osh.1 is a man page written using the mdoc macro language for the troff (groff) formatter.

You can view it with man doc/osh.1.