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

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