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

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