OILS / _devbuild / gen / help_meta.py View on Github | oilshell.org

409 lines, 405 significant
1TOPICS = {'ARGV': 'special-var',
2 'BASHOPTS': 'special-var',
3 'BASHPID': 'special-var',
4 'BASH_LINENO': 'special-var',
5 'BASH_REMATCH': 'special-var',
6 'BASH_SOURCE': 'special-var',
7 'BashArray': 'type-method',
8 'BashAssoc': 'type-method',
9 'Bool': 'type-method',
10 'BoundFunc': 'type-method',
11 'BuiltinFunc': 'type-method',
12 'CDPATH': 'special-var',
13 'COMPREPLY': 'special-var',
14 'COMP_ARGV': 'special-var',
15 'COMP_CWORD': 'special-var',
16 'COMP_LINE': 'special-var',
17 'COMP_POINT': 'special-var',
18 'COMP_WORDBREAKS': 'special-var',
19 'COMP_WORDS': 'special-var',
20 'Command': 'type-method',
21 'DEBUG': 'plugin',
22 'ENV': 'special-var',
23 'ERR': 'plugin',
24 'EUID': 'special-var',
25 'EXIT': 'plugin',
26 'Expr': 'type-method',
27 'FUNCNAME': 'special-var',
28 'Float': 'type-method',
29 'GLOBIGNORE': 'special-var',
30 'HISTFILE': 'special-var',
31 'HOME': 'special-var',
32 'HOSTNAME': 'special-var',
33 'IFS': 'special-var',
34 'Int': 'type-method',
35 'LANG': 'special-var',
36 'LINENO': 'special-var',
37 'List/append': 'type-method',
38 'Null': 'type-method',
39 'OILS_GC_ON_EXIT': 'special-var',
40 'OILS_GC_STATS': 'special-var',
41 'OILS_GC_STATS_FD': 'special-var',
42 'OILS_GC_THRESHOLD': 'special-var',
43 'OILS_VERSION': 'special-var',
44 'OLDPWD': 'special-var',
45 'OPTARG': 'special-var',
46 'OPTERR': 'special-var',
47 'OPTIND': 'special-var',
48 'OSTYPE': 'special-var',
49 'PATH': 'special-var',
50 'PIPESTATUS': 'special-var',
51 'PPID': 'special-var',
52 'PROMPT_COMMAND': 'plugin',
53 'PS1': 'plugin',
54 'PS2': 'plugin',
55 'PS3': 'plugin',
56 'PS4': 'plugin',
57 'PWD': 'special-var',
58 'RANDOM': 'special-var',
59 'REPLY': 'special-var',
60 'RETURN': 'plugin',
61 'SECONDS': 'special-var',
62 'SHELLOPTS': 'special-var',
63 'SHX_indent': 'special-var',
64 'SHX_pid_str': 'special-var',
65 'SHX_punct': 'special-var',
66 'SIGINT': 'plugin',
67 'SIGQUIT': 'plugin',
68 'SIGTERM': 'plugin',
69 'SIGTTIN': 'plugin',
70 'SIGTTOU': 'plugin',
71 'SIGWINCH': 'plugin',
72 'UID': 'special-var',
73 'YSH_HISTFILE': 'special-var',
74 '_end': 'builtin-func',
75 '_error': 'special-var',
76 '_group': 'builtin-func',
77 '_pipeline_status': 'special-var',
78 '_process_sub_status': 'special-var',
79 '_reply': 'special-var',
80 '_start': 'builtin-func',
81 '_status': 'special-var',
82 '_this_dir': 'special-var',
83 'abs': 'builtin-func',
84 'accum': 'type-method',
85 'alias': 'builtin-cmd',
86 'all': 'builtin-func',
87 'ampersand': 'cmd-lang',
88 'and': 'cmd-lang',
89 'any': 'builtin-func',
90 'append': 'index',
91 'arith-context': 'mini-lang',
92 'arith-sub': 'word-lang',
93 'ascii-control-chars': 'front-end',
94 'ascii-whitespace': 'front-end',
95 'assign': 'expr-lang',
96 'atom-literal': 'expr-lang',
97 'aug-assign': 'expr-lang',
98 'b-prefix': 'j8',
99 'bang': 'cmd-lang',
100 'block-arg': 'cmd-lang',
101 'block-expr': 'expr-lang',
102 'bool': 'builtin-func',
103 'bool-expr': 'mini-lang',
104 'bool-infix': 'mini-lang',
105 'bool-other': 'mini-lang',
106 'bool-path': 'mini-lang',
107 'bool-str': 'mini-lang',
108 'boolstatus': 'builtin-cmd',
109 'braces': 'mini-lang',
110 'break': 'cmd-lang',
111 'builtin': 'builtin-cmd',
112 'bytes': 'builtin-func',
113 'call': 'ysh-cmd',
114 'captureStdout': 'type-method',
115 'case': 'cmd-lang',
116 'cat-em': 'front-end',
117 'cd': 'builtin-cmd',
118 'char-escapes': 'mini-lang',
119 'class-literal': 'expr-lang',
120 'cmd/append': 'builtin-cmd',
121 'cmd/type': 'builtin-cmd',
122 'colon': 'cmd-lang',
123 'column-attrs': 'j8',
124 'column-types': 'j8',
125 'command': 'builtin-cmd',
126 'command-sub': 'word-lang',
127 'comment': 'front-end',
128 'compadjust': 'builtin-cmd',
129 'compexport': 'builtin-cmd',
130 'compgen': 'builtin-cmd',
131 'complete': 'plugin',
132 'compopt': 'builtin-cmd',
133 'concat': 'expr-lang',
134 'config': 'front-end',
135 'const': 'ysh-cmd',
136 'continue': 'cmd-lang',
137 'ctx': 'builtin-cmd',
138 'dashglob': 'option',
139 'dbracket': 'cmd-lang',
140 'declare': 'osh-assign',
141 'dict': 'builtin-func',
142 'dict-literal': 'expr-lang',
143 'dirs': 'builtin-cmd',
144 'doc-comment': 'front-end',
145 'dparen': 'cmd-lang',
146 'echo': 'builtin-cmd',
147 'enable': 'builtin-cmd',
148 'encodeBytes': 'builtin-func',
149 'encodeRunes': 'builtin-func',
150 'end': 'type-method',
151 'endsWith': 'type-method',
152 'equal': 'ysh-cmd',
153 'erase': 'type-method',
154 'err-j8-lines-decode': 'errors',
155 'err-j8-lines-encode': 'errors',
156 'err-j8-str-decode': 'errors',
157 'err-j8-str-encode': 'errors',
158 'err-json-decode': 'errors',
159 'err-json-encode': 'errors',
160 'err-json8-decode': 'errors',
161 'err-json8-encode': 'errors',
162 'err-utf8-decode': 'errors',
163 'err-utf8-encode': 'errors',
164 'error': 'builtin-cmd',
165 'eval': 'type-method',
166 'evalExpr': 'builtin-func',
167 'evalHay': 'builtin-func',
168 'eval_unsafe_arith': 'option',
169 'exec': 'builtin-cmd',
170 'exit': 'cmd-lang',
171 'exit-codes': 'front-end',
172 'export': 'osh-assign',
173 'expr-literal': 'expr-lang',
174 'expr-splice': 'word-lang',
175 'expr-sub': 'word-lang',
176 'extend': 'type-method',
177 'extglob': 'mini-lang',
178 'failed': 'builtin-cmd',
179 'false': 'cmd-lang',
180 'fat-arrow': 'expr-lang',
181 'fg': 'builtin-cmd',
182 'find': 'type-method',
183 'float': 'builtin-func',
184 'float-lit': 'expr-lang',
185 'fopen': 'builtin-cmd',
186 'for': 'cmd-lang',
187 'for-expr-sh': 'cmd-lang',
188 'fork': 'builtin-cmd',
189 'forkwait': 'builtin-cmd',
190 'fromJson': 'builtin-func',
191 'fromJson8': 'builtin-func',
192 'func': 'ysh-cmd',
193 'func-call': 'expr-lang',
194 'func/type': 'builtin-func',
195 'get': 'type-method',
196 'getVar': 'builtin-func',
197 'getopts': 'builtin-cmd',
198 'glob': 'type-method',
199 'glob-pat': 'mini-lang',
200 'group': 'type-method',
201 'hash': 'builtin-cmd',
202 'hay': 'builtin-cmd',
203 'haynode': 'builtin-cmd',
204 'help': None,
205 'here-doc': 'cmd-lang',
206 'history': 'builtin-cmd',
207 'histsub': 'mini-lang',
208 'if': 'cmd-lang',
209 'ignore_flags_not_impl': 'option',
210 'inc': 'type-method',
211 'indexOf': 'type-method',
212 'insert': 'type-method',
213 'int': 'builtin-func',
214 'int-literal': 'expr-lang',
215 'is-main': 'builtin-cmd',
216 'j8-escape': 'j8',
217 'jobs': 'builtin-cmd',
218 'join': 'builtin-func',
219 'json': 'builtin-cmd',
220 'json-escape': 'j8',
221 'json-string': 'j8',
222 'json8': 'builtin-cmd',
223 'json8-comment': 'j8',
224 'json8-dict': 'j8',
225 'json8-list': 'j8',
226 'json8-num': 'j8',
227 'json8-str': 'j8',
228 'keys': 'type-method',
229 'kill': 'builtin-cmd',
230 'lazy-expr-arg': 'cmd-lang',
231 'leftMatch': 'type-method',
232 'len': 'builtin-func',
233 'line-continuation': 'front-end',
234 'line-editing': 'front-end',
235 'list': 'builtin-func',
236 'list-literal': 'expr-lang',
237 'local': 'osh-assign',
238 'lower': 'type-method',
239 'mapfile': 'builtin-cmd',
240 'match-ops': 'expr-lang',
241 'max': 'builtin-func',
242 'maybe': 'builtin-func',
243 'min': 'builtin-func',
244 'module': 'builtin-cmd',
245 'multiline-command': 'front-end',
246 'named-class': 'expr-lang',
247 'no-prefix': 'j8',
248 'nullglob': 'option',
249 'oils-usage': None,
250 'op-format': 'word-lang',
251 'op-index': 'word-lang',
252 'op-precedence': 'expr-lang',
253 'op-replace': 'word-lang',
254 'op-slice': 'word-lang',
255 'op-strip': 'word-lang',
256 'op-test': 'word-lang',
257 'opts-internal': 'option',
258 'opts-redefine': 'option',
259 'or': 'cmd-lang',
260 'osh-chapters': None,
261 'osh-string': 'word-lang',
262 'osh-usage': None,
263 'parseHay': 'builtin-func',
264 'parse_ignored': 'option',
265 'parse_triple_quote': 'option',
266 'parse_ysh_string': 'option',
267 'pipe': 'cmd-lang',
268 'pop': 'type-method',
269 'popd': 'builtin-cmd',
270 'pp': 'builtin-cmd',
271 'printf': 'builtin-cmd',
272 'proc': 'ysh-cmd',
273 'proc-sub': 'word-lang',
274 'promptVal': 'type-method',
275 'push-registers': 'builtin-cmd',
276 'pushd': 'builtin-cmd',
277 'pwd': 'builtin-cmd',
278 'range': 'expr-lang',
279 're-capture': 'expr-lang',
280 're-compound': 'expr-lang',
281 're-flags': 'expr-lang',
282 're-literal': 'expr-lang',
283 're-multiline': 'expr-lang',
284 're-primitive': 'expr-lang',
285 're-repeat': 'expr-lang',
286 're-splice': 'expr-lang',
287 'read': 'builtin-cmd',
288 'readarray': 'builtin-cmd',
289 'readonly': 'osh-assign',
290 'redir-desc': 'cmd-lang',
291 'redir-file': 'cmd-lang',
292 'regex': 'mini-lang',
293 'remove': 'type-method',
294 'renderPrompt': 'plugin',
295 'repeat': 'builtin-func',
296 'replace': 'type-method',
297 'return': 'cmd-lang',
298 'reverse': 'type-method',
299 'round': 'builtin-func',
300 'runes': 'builtin-func',
301 'runproc': 'builtin-cmd',
302 'search': 'type-method',
303 'semicolon': 'cmd-lang',
304 'set': 'builtin-cmd',
305 'setValue': 'type-method',
306 'setglobal': 'ysh-cmd',
307 'setvar': 'ysh-cmd',
308 'sh-append': 'osh-assign',
309 'sh-arith': 'mini-lang',
310 'sh-array': 'osh-assign',
311 'sh-assign': 'osh-assign',
312 'sh-assoc': 'osh-assign',
313 'sh-bitwise': 'mini-lang',
314 'sh-block': 'cmd-lang',
315 'sh-func': 'cmd-lang',
316 'sh-logical': 'mini-lang',
317 'sh-numbers': 'mini-lang',
318 'shSplit': 'builtin-func',
319 'sha1dc': 'builtin-func',
320 'sha256': 'builtin-func',
321 'shift': 'osh-assign',
322 'shopt': 'builtin-cmd',
323 'shvar': 'builtin-cmd',
324 'shvarGet': 'builtin-func',
325 'sigpipe_status_ok': 'option',
326 'simple-command': 'cmd-lang',
327 'source': 'builtin-cmd',
328 'split': 'builtin-func',
329 'start': 'type-method',
330 'startsWith': 'type-method',
331 'startup': 'front-end',
332 'str': 'builtin-func',
333 'str-template': 'expr-lang',
334 'strcmp': 'builtin-func',
335 'strftime': 'type-method',
336 'strict:all': 'option',
337 'strict_control_flow': 'option',
338 'strict_nameref': 'option',
339 'strict_tilde': 'option',
340 'subshell': 'cmd-lang',
341 'sum': 'builtin-func',
342 'surrogate-pair': 'j8',
343 'tagged-str': 'word-lang',
344 'test': 'builtin-cmd',
345 'thin-arrow': 'expr-lang',
346 'tilde-sub': 'word-lang',
347 'time': 'type-method',
348 'times': 'builtin-cmd',
349 'toJson': 'builtin-func',
350 'toJson8': 'builtin-func',
351 'trap': 'builtin-cmd',
352 'trim': 'type-method',
353 'trimEnd': 'type-method',
354 'trimStart': 'type-method',
355 'triple-quoted': 'word-lang',
356 'true': 'cmd-lang',
357 'try': 'builtin-cmd',
358 'type': 'index',
359 'typed-arg': 'cmd-lang',
360 'typeset': 'osh-assign',
361 'u-prefix': 'j8',
362 'ulimit': 'builtin-cmd',
363 'umask': 'builtin-cmd',
364 'unalias': 'builtin-cmd',
365 'unquoted-line': 'j8',
366 'unset': 'osh-assign',
367 'until': 'cmd-lang',
368 'upper': 'type-method',
369 'use': 'builtin-cmd',
370 'values': 'type-method',
371 'var': 'ysh-cmd',
372 'var-splice': 'word-lang',
373 'var-sub': 'word-lang',
374 'wait': 'builtin-cmd',
375 'while': 'cmd-lang',
376 'write': 'builtin-cmd',
377 'ysh-arith': 'expr-lang',
378 'ysh-attr': 'expr-lang',
379 'ysh-bitwise': 'expr-lang',
380 'ysh-case': 'cmd-lang',
381 'ysh-cd': 'builtin-cmd',
382 'ysh-chapters': None,
383 'ysh-compare': 'expr-lang',
384 'ysh-echo': 'builtin-cmd',
385 'ysh-equals': 'expr-lang',
386 'ysh-for': 'cmd-lang',
387 'ysh-format': 'word-lang',
388 'ysh-if': 'cmd-lang',
389 'ysh-in': 'expr-lang',
390 'ysh-index': 'expr-lang',
391 'ysh-logical': 'expr-lang',
392 'ysh-printf': 'word-lang',
393 'ysh-read': 'builtin-cmd',
394 'ysh-return': 'ysh-cmd',
395 'ysh-shopt': 'builtin-cmd',
396 'ysh-slice': 'expr-lang',
397 'ysh-string': 'word-lang',
398 'ysh-ternary': 'expr-lang',
399 'ysh-usage': None,
400 'ysh-while': 'cmd-lang',
401 'ysh:all': 'option',
402 'ysh:upgrade': 'option'}
403
404
405from typing import Dict
406
407def TopicMetadata():
408 # type: () -> Dict[str, str]
409 return TOPICS