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

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