| 1 | ---
|
| 2 | css_files: web/base.css web/release-index.css
|
| 3 | all_docs_url: -
|
| 4 | version_url: -
|
| 5 | ---
|
| 6 |
|
| 7 | Oils 0.21.0
|
| 8 | ===========
|
| 9 |
|
| 10 | <!-- NOTE: This file is published to /release/$VERSION/index.html -->
|
| 11 |
|
| 12 | <span class="date">
|
| 13 | <!-- REPLACE_WITH_DATE -->
|
| 14 | </span>
|
| 15 |
|
| 16 | This is the home page for version 0.21.0 of Oils, a Unix shell. To use it,
|
| 17 |
|
| 18 | 1. Download a source tarball.
|
| 19 | 2. Build it and do a "smoke test", as described in [INSTALL][].
|
| 20 |
|
| 21 | These steps take 30 to 60 seconds on most machines. After installation, see
|
| 22 | [Getting Started](doc/getting-started.html).
|
| 23 |
|
| 24 | The associated **[quality page](quality.html)** shows test results, metrics,
|
| 25 | and benchmarks.
|
| 26 |
|
| 27 | [INSTALL]: doc/INSTALL.html
|
| 28 |
|
| 29 | ## Download
|
| 30 |
|
| 31 | <!-- REPLACE_WITH_DOWNLOAD_LINKS -->
|
| 32 |
|
| 33 | **[Oils Packaging Guidelines]($wiki)**:
|
| 34 |
|
| 35 | - The `oils-for-unix` tarball is the fast shell in C++, completed in
|
| 36 | 2024. The distro package should be called `oils-for-unix`.
|
| 37 | - The `oil` tarball is the slow reference interpreter based on CPython.
|
| 38 | - Don't rename old distro packages. They can remain `oil`.
|
| 39 | - It's not worth packaging `oil` in new distros. It may be removed at some
|
| 40 | point.
|
| 41 | - The project is now called **Oils**, or [Oils for
|
| 42 | Unix](https://www.oilshell.org/blog/2023/03/rename.html). There is no more
|
| 43 | `oil`!
|
| 44 |
|
| 45 | ## What's New
|
| 46 |
|
| 47 | - Details are in the [raw git change log](changelog.html). Not all changes
|
| 48 | affect the release tarball.
|
| 49 | - I sometimes write a [release announcement](announcement.html) with a
|
| 50 | high-level description of changes.
|
| 51 |
|
| 52 | ## Documentation
|
| 53 |
|
| 54 | - The [**Oils Reference**](doc/ref/index.html) (in progress)
|
| 55 | - Table of contents for [OSH](doc/ref/toc-osh.html) | [YSH](doc/ref/toc-ysh.html)
|
| 56 | | [Data Languages](doc/ref/toc-data.html)
|
| 57 | - [**All Docs**](doc/) about Oils (in progress).
|
| 58 |
|
| 59 | These docs are **ready to read**:
|
| 60 |
|
| 61 | - [Getting Started](doc/getting-started.html)
|
| 62 | - [FAQ on Documentation](doc/faq-doc.html). **Look here if you can't find
|
| 63 | something.**
|
| 64 | - OSH:
|
| 65 | - [Known Differences Between OSH and Other Shells](doc/known-differences.html)
|
| 66 | | [Quirks](doc/quirks.html)
|
| 67 | | [Tracing Execution](doc/xtrace.html)
|
| 68 | | [Headless Mode](doc/headless.html)
|
| 69 | - YSH:
|
| 70 | - Intro: [A Tour of YSH](doc/ysh-tour.html)
|
| 71 | | [A Feel For YSH Syntax](doc/syntax-feelings.html)
|
| 72 | | [YSH Style Guide](doc/style-guide.html)
|
| 73 | | [YSH vs. Shell Idioms](doc/idioms.html) and [Shell Idioms](doc/shell-idioms.html)
|
| 74 | | [What Breaks When You Upgrade to YSH](doc/upgrade-breakage.html)
|
| 75 | | [YSH Language FAQ](doc/ysh-faq.html)
|
| 76 | - Comparisons: [YSH vs. Shell](doc/ysh-vs-shell.html) | [YSH Expressions vs.
|
| 77 | Python](doc/ysh-vs-python.html)
|
| 78 | - Features: [Egg Expressions (YSH Regexes)](doc/eggex.html)
|
| 79 | | [YSH Regex API](doc/ysh-regex-api.html)
|
| 80 | | [Guide to Procs and Funcs](doc/proc-func.html)
|
| 81 | | [YSH Fixes Shell's Error Handling](doc/error-handling.html)
|
| 82 | | [Simple Word Evaluation](doc/simple-word-eval.html)
|
| 83 | | [Variable Declaration, Mutation, and Scope](doc/variables.html)
|
| 84 | | [Hay - Custom Languages for Unix Systems](doc/hay.html)
|
| 85 | - Data Languages:
|
| 86 | - [JSON](doc/json.html) | [J8 Notation](doc/j8-notation.html)
|
| 87 | - Language Design:
|
| 88 | - [Syntactic Concepts](doc/syntactic-concepts.html)
|
| 89 | | [Command vs. Expression Mode](doc/command-vs-expression-mode.html)
|
| 90 | | [Language Influences](doc/language-influences.html)
|
| 91 | - Notes: [Novelties in OSH and YSH](doc/novelties.html) | [Warts](doc/warts.html)
|
| 92 | - Reference:
|
| 93 | - [Oils Error Catalog, With Hints](doc/error-catalog.html)
|
| 94 |
|
| 95 | More:
|
| 96 |
|
| 97 | - [Github Wiki for oilshell/oil](https://github.com/oilshell/oil/wiki). The
|
| 98 | [Oil Deployments](https://github.com/oilshell/oil/wiki/Oil-Deployments) wiki
|
| 99 | page has other ways of getting Oils. These versions may not be up-to-date.
|
| 100 |
|