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

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