1 | ---
|
2 | title: OSH Table of Contents
|
3 | all_docs_url: ..
|
4 | css_files: ../../web/base.css ../../web/manual.css ../../web/ref-index.css
|
5 | preserve_anchor_case: yes
|
6 | ---
|
7 |
|
8 | <div class="doc-ref-header">
|
9 |
|
10 | [Oils Reference](index.html) —
|
11 | **OSH Table of Contents** | [YSH](toc-ysh.html) | [Data Notation](toc-data.html)
|
12 |
|
13 | </div>
|
14 |
|
15 | [OSH]($xref) is a POSIX- and [bash]($xref)-compatible shell.
|
16 |
|
17 | <!--
|
18 | <div class="custom-toc">
|
19 |
|
20 | [OSH Types](#type-method) <br/>
|
21 | [Builtin Commands](#builtin-cmd) <br/>
|
22 | [Front End](#front-end) <br/>
|
23 | [Command Language](#cmd-lang) <br/>
|
24 | [OSH Assignment](#osh-assign) <br/>
|
25 | [Word Language](#word-lang) <br/>
|
26 | [Mini Languages](#mini-lang) <br/>
|
27 | [Shell Options](#option) <br/>
|
28 | [Special Variables](#special-var) <br/>
|
29 | [Plugins and Hooks](#plugin) <br/>
|
30 |
|
31 | [type-method](#type-method)
|
32 | [builtin-cmd](#builtin-cmd)
|
33 | [front-end](#front-end)
|
34 | [cmd-lang](#cmd-lang)
|
35 | [osh-assign](#osh-assign)
|
36 | [word-lang](#word-lang)
|
37 | [mini-lang](#mini-lang)
|
38 | [option](#option)
|
39 | [special-var](#special-var)
|
40 | [plugin](#plugin)
|
41 |
|
42 | </div>
|
43 | -->
|
44 |
|
45 | <h2 id="type-method">
|
46 | OSH Types <a class="group-link" href="chap-type-method.html">type-method</a>
|
47 | </h2>
|
48 |
|
49 | ```chapter-links-type-method
|
50 | [OSH] BashArray BashAssoc
|
51 | ```
|
52 |
|
53 | <h2 id="builtin-cmd">
|
54 | Builtin Commands <a class="group-link" href="chap-builtin-cmd.html">builtin-cmd</a>
|
55 | </h2>
|
56 |
|
57 | ```chapter-links-builtin-cmd
|
58 | [I/O] read echo printf
|
59 | readarray mapfile
|
60 | [Run Code] source . eval trap
|
61 | [Set Options] set shopt
|
62 | [Working Dir] cd pwd pushd popd dirs
|
63 | [Completion] complete compgen compopt compadjust compexport
|
64 | [Shell Process] exec X logout
|
65 | umask ulimit times
|
66 | [Child Process] jobs wait
|
67 | fg X bg X kill X disown
|
68 | [External] test [ getopts
|
69 | [Introspection] help hash cmd/type X caller
|
70 | [Word Lookup] command builtin
|
71 | [Interactive] alias unalias history X fc X bind
|
72 | X [Unsupported] enable
|
73 | ```
|
74 |
|
75 | <h2 id="stdlib">
|
76 | Standard Library <a class="group-link" href="chap-stdlib.html">stdlib</a>
|
77 | </h2>
|
78 |
|
79 | ```chapter-links-stdlib
|
80 | [two] log die
|
81 | [no-quotes] nq-assert nq-run
|
82 | nq-capture nq-capture-2
|
83 | nq-redir nq-redir-2
|
84 | [bash-strict]
|
85 | [task-five]
|
86 | ```
|
87 |
|
88 | <h2 id="front-end">
|
89 | Front End <a class="group-link" href="chap-front-end.html">front-end</a>
|
90 | </h2>
|
91 |
|
92 | ```chapter-links-front-end
|
93 | [Usage] oils-usage osh-usage config
|
94 | startup line-editing exit-codes
|
95 | [Lexing] comment # line-continuation \ ascii-whitespace [ \t\r\n]
|
96 | ```
|
97 |
|
98 | <h2 id="cmd-lang">
|
99 | Command Language <a class="group-link" href="chap-cmd-lang.html">cmd-lang</a>
|
100 | </h2>
|
101 |
|
102 | ```chapter-links-cmd-lang
|
103 | [Commands] simple-command semicolon ;
|
104 | [Conditional] case if dbracket [[
|
105 | true false colon :
|
106 | bang ! and && or ||
|
107 | [Iteration] while until for for-expr-sh ((
|
108 | [Control Flow] break continue return exit
|
109 | [Grouping] sh-func sh-block { subshell (
|
110 | [Concurrency] pipe | X pipe-amp |& ampersand &
|
111 | [Redirects] redir-file > >> >| < <> not impl: &>
|
112 | redir-desc >& <&
|
113 | here-doc << <<- <<<
|
114 | [Other Command] dparen (( time X coproc X select
|
115 | ```
|
116 |
|
117 | <h2 id="osh-assign">
|
118 | Assignments and Expressions <a class="group-link" href="chap-osh-assign.html">osh-assign</a>
|
119 | </h2>
|
120 |
|
121 | ```chapter-links-osh-assign
|
122 | [Literals] sh-array array=(a b c) array[1]=B "${a[@]}"
|
123 | sh-assoc assoc=(['a']=1 ['b']=2) assoc['x']=b
|
124 | [Operators] sh-assign str='xyz'
|
125 | sh-append str+='abc'
|
126 | [Builtins] local readonly export unset shift
|
127 | declare typeset X let
|
128 | ```
|
129 |
|
130 | <h2 id="word-lang">
|
131 | Word Language <a class="group-link" href="chap-word-lang.html">word-lang</a>
|
132 | </h2>
|
133 |
|
134 | <!-- linkify_stop_col is 33 -->
|
135 |
|
136 | ```chapter-links-word-lang_33
|
137 | [Quotes] osh-string 'abc' $'line\n' "$var"
|
138 | [Substitutions] command-sub $(command) `command`
|
139 | var-sub ${var} $0 $9
|
140 | arith-sub $((1 + 2))
|
141 | tilde-sub ~/src
|
142 | proc-sub diff <(sort L.txt) <(sort R.txt)
|
143 | [Var Ops] op-test ${x:-default}
|
144 | op-strip ${x%%suffix} etc.
|
145 | op-replace ${x//y/z}
|
146 | op-index ${a[i+1}
|
147 | op-slice ${a[@]:0:1}
|
148 | op-format ${x@P}
|
149 | ```
|
150 |
|
151 | <h2 id="mini-lang">
|
152 | Other Mini Languages <a class="group-link" href="chap-mini-lang.html">mini-lang</a>
|
153 | </h2>
|
154 |
|
155 | <!-- linkify_stop_col is 33 -->
|
156 |
|
157 | ```chapter-links-mini-lang_33
|
158 | [Arithmetic] arith-context Where legacy arithmetic is allowed
|
159 | sh-numbers 0xFF 0755 etc.
|
160 | sh-arith 1 + 2*3 a *= 2
|
161 | sh-logical !a && b
|
162 | sh-bitwise ~a ^ b
|
163 | [Boolean] bool-expr [[ ! $x && $y || $z ]]
|
164 | test ! $x -a $y -o $z
|
165 | bool-infix $a -nt $b $x == $y
|
166 | bool-path -d /etc
|
167 | bool-str -n foo -z ''
|
168 | bool-other -o errexit -v name[index]
|
169 | [Patterns] glob-pat *.py
|
170 | extglob ,(*.py|*.sh)
|
171 | regex [[ foo =~ [a-z]+ ]]
|
172 | [Other Sublang] braces {alice,bob}@example.com
|
173 | histsub !$ !! !n
|
174 | char-escapes \t \c \x00 \u03bc
|
175 | ```
|
176 |
|
177 | <h2 id="option">
|
178 | Global Shell Options <a class="group-link" href="chap-option.html">option</a>
|
179 | </h2>
|
180 |
|
181 | <!-- linkify_stop_col is 20 since we only want section links -->
|
182 |
|
183 | ```chapter-links-option_22
|
184 | [Errors] nounset -u errexit -e inherit_errexit pipefail
|
185 | [Globbing] noglob -f nullglob failglob X dotglob
|
186 | dashglob (true)
|
187 | [Debugging] xtrace X verbose X extdebug
|
188 | [Interactive] emacs vi
|
189 | [Other POSIX] X noclobber
|
190 | [Compat] eval_unsafe_arith ignore_flags_not_impl
|
191 | ```
|
192 |
|
193 | <h2 id="special-var">
|
194 | Special Variables <a class="group-link" href="chap-special-var.html">special-var</a>
|
195 | </h2>
|
196 |
|
197 | ```chapter-links-special-var
|
198 | [POSIX Special] $@ $* $# $? $- $$ $! $0 $9
|
199 | [Shell Vars] IFS X LANG X GLOBIGNORE
|
200 | [Shell Options] SHELLOPTS X BASHOPTS
|
201 | [Other Env] HOME PATH
|
202 | [Other Special] BASH_REMATCH @PIPESTATUS
|
203 | [Platform] HOSTNAME OSTYPE
|
204 | [Call Stack] @BASH_SOURCE @FUNCNAME @BASH_LINENO
|
205 | X @BASH_ARGV X @BASH_ARGC
|
206 | [Tracing] LINENO
|
207 | [Process State] UID EUID PPID X BASHPID
|
208 | X [Process Stack] BASH_SUBSHELL SHLVL
|
209 | X [Shell State] BASH_CMDS @DIRSTACK
|
210 | [Completion] @COMP_WORDS COMP_CWORD COMP_LINE COMP_POINT
|
211 | COMP_WORDBREAKS @COMPREPLY X COMP_KEY
|
212 | X COMP_TYPE COMP_ARGV
|
213 | [History] HISTFILE
|
214 | [cd] PWD OLDPWD X CDPATH
|
215 | [getopts] OPTIND OPTARG X OPTERR
|
216 | [read] REPLY
|
217 | [Functions] X RANDOM SECONDS
|
218 | [Oils VM] OILS_VERSION LIB_OSH
|
219 | ```
|
220 |
|
221 | <h2 id="plugin">
|
222 | Plugins and Hooks <a class="group-link" href="chap-plugin.html">plugin</a>
|
223 | </h2>
|
224 |
|
225 | ```chapter-links-plugin
|
226 | [Signals] SIGTERM SIGINT SIGQUIT
|
227 | SIGTTIN SIGTTOU SIGWINCH
|
228 | [Traps] DEBUG ERR EXIT X RETURN
|
229 | [Words] PS1 X PS2 X PS3 PS4
|
230 | [Completion] complete
|
231 | [Other Plugin] PROMPT_COMMAND X command_not_found
|
232 | ```
|