OILS / _devbuild / gen / help_meta.py View on Github | oils.pub

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