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

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