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

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