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

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