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

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