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

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