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

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