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

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