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

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