1include "OptionsBase.td"
2
3let Command = "target modules dump symtab" in {
4  def tm_sort : Option<"sort", "s">, Group<1>,
5    Desc<"Supply a sort order when dumping the symbol table.">,
6    EnumArg<"SortOrder", "OptionEnumValues(g_sort_option_enumeration)">;
7  def tm_smn : Option<"show-mangled-names", "m">, Group<1>,
8    Desc<"Do not demangle symbol names before showing them.">;
9}
10
11let Command = "help" in {
12  def help_hide_aliases : Option<"hide-aliases", "a">,
13    Desc<"Hide aliases in the command list.">;
14  def help_hide_user : Option<"hide-user-commands", "u">,
15    Desc<"Hide user-defined commands from the list.">;
16  def help_show_hidden : Option<"show-hidden-commands", "h">,
17    Desc<"Include commands prefixed with an underscore.">;
18}
19
20let Command = "settings set" in {
21  def setset_global : Option<"global", "g">, Arg<"Filename">,
22    Completion<"DiskFile">,
23    Desc<"Apply the new value to the global default value.">;
24  def setset_force : Option<"force", "f">,
25    Desc<"Force an empty value to be accepted as the default.">;
26}
27
28let Command = "settings write" in {
29  def setwrite_file : Option<"file", "f">, Required, Arg<"Filename">,
30    Completion<"DiskFile">,
31    Desc<"The file into which to write the settings.">;
32  def setwrite_append : Option<"append", "a">,
33    Desc<"Append to saved settings file if it exists.">;
34}
35
36let Command = "settings read" in {
37  def setread_file : Option<"file", "f">, Required, Arg<"Filename">,
38    Completion<"DiskFile">,
39    Desc<"The file from which to read the settings.">;
40}
41
42let Command = "settings clear" in {
43  def setclear_all : Option<"all", "a">,
44    Desc<"Clear all settings.">;
45}
46
47let Command = "breakpoint list" in {
48  // FIXME: We need to add an "internal" command, and then add this sort of
49  // thing to it. But I need to see it for now, and don't want to wait.
50  def blist_internal : Option<"internal", "i">,
51    Desc<"Show debugger internal breakpoints">;
52  def blist_brief : Option<"brief", "b">, Group<1>,
53    Desc<"Give a brief description of the breakpoint (no location info).">;
54  def blist_full : Option<"full", "f">, Group<2>,
55    Desc<"Give a full description of the breakpoint and its locations.">;
56  def blist_verbose : Option<"verbose", "v">, Group<3>,
57    Desc<"Explain everything we know about the breakpoint (for debugging "
58    "debugger bugs).">;
59  def blist_dummy_bp : Option<"dummy-breakpoints", "D">,
60    Desc<"List Dummy breakpoints - i.e. breakpoints set before a file is "
61    "provided, which prime new targets.">;
62}
63
64let Command = "breakpoint modify" in {
65  def breakpoint_modify_ignore_count : Option<"ignore-count", "i">, Group<1>,
66    Arg<"Count">,
67    Desc<"Set the number of times this breakpoint is skipped before stopping.">;
68  def breakpoint_modify_one_shot : Option<"one-shot", "o">, Group<1>,
69    Arg<"Boolean">,
70    Desc<"The breakpoint is deleted the first time it stop causes a stop.">;
71  def breakpoint_modify_thread_index : Option<"thread-index", "x">, Group<1>,
72    Arg<"ThreadIndex">, Desc<"The breakpoint stops only for the thread whose "
73    "index matches this argument.">;
74  def breakpoint_modify_thread_id : Option<"thread-id", "t">, Group<1>,
75    Arg<"ThreadID">, Desc<"The breakpoint stops only for the thread whose TID "
76    "matches this argument.">;
77  def breakpoint_modify_thread_name : Option<"thread-name", "T">, Group<1>,
78    Arg<"ThreadName">, Desc<"The breakpoint stops only for the thread whose "
79    "thread name matches this argument.">;
80  def breakpoint_modify_queue_name : Option<"queue-name", "q">, Group<1>,
81    Arg<"QueueName">, Desc<"The breakpoint stops only for threads in the queue "
82    "whose name is given by this argument.">;
83  def breakpoint_modify_condition : Option<"condition", "c">, Group<1>,
84    Arg<"Expression">, Desc<"The breakpoint stops only if this condition "
85    "expression evaluates to true.">;
86  def breakpoint_modify_auto_continue : Option<"auto-continue", "G">, Group<1>,
87    Arg<"Boolean">,
88    Desc<"The breakpoint will auto-continue after running its commands.">;
89  def breakpoint_modify_enable : Option<"enable", "e">, Group<2>,
90    Desc<"Enable the breakpoint.">;
91  def breakpoint_modify_disable : Option<"disable", "d">, Group<3>,
92    Desc<"Disable the breakpoint.">;
93  def breakpoint_modify_command : Option<"command", "C">, Group<4>,
94    Arg<"Command">,
95    Desc<"A command to run when the breakpoint is hit, can be provided more "
96    "than once, the commands will get run in order left to right.">;
97}
98
99let Command = "breakpoint dummy" in {
100  def breakpoint_dummy_options_dummy_breakpoints :
101    Option<"dummy-breakpoints", "D">, Group<1>,
102    Desc<"Act on Dummy breakpoints - i.e. breakpoints set before a file is "
103    "provided, which prime new targets.">;
104}
105
106let Command = "breakpoint set" in {
107  def breakpoint_set_shlib : Option<"shlib", "s">, Arg<"ShlibName">,
108    Completion<"Module">, Groups<[1,2,3,4,5,6,7,8,9,11,12]>, // *not* in group 10
109    Desc<"Set the breakpoint only in this shared library.  Can repeat this "
110    "option multiple times to specify multiple shared libraries.">;
111  def breakpoint_set_hardware : Option<"hardware", "H">,
112    Desc<"Require the breakpoint to use hardware breakpoints.">;
113  def breakpoint_set_file : Option<"file", "f">, Arg<"Filename">,
114    Completion<"SourceFile">, Groups<[1,3,4,5,6,7,8,9,11]>,
115    Desc<"Specifies the source file in which to set this breakpoint.  Note, by "
116    "default lldb only looks for files that are #included if they use the "
117    "standard include file extensions.  To set breakpoints on .c/.cpp/.m/.mm "
118    "files that are #included, set target.inline-breakpoint-strategy to "
119    "\"always\".">;
120  def breakpoint_set_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
121    Required,
122    Desc<"Specifies the line number on which to set this breakpoint.">;
123  def breakpoint_set_column : Option<"column", "u">, Group<1>, Arg<"ColumnNum">,
124    Desc<"Specifies the column number on which to set this breakpoint.">;
125  def breakpoint_set_address : Option<"address", "a">, Group<2>,
126    Arg<"AddressOrExpression">, Required,
127    Desc<"Set the breakpoint at the specified address.  If the address maps "
128    "uniquely to a particular binary, then the address will be converted to "
129    "a \"file\"address, so that the breakpoint will track that binary+offset "
130    "no matter where the binary eventually loads.  Alternately, if you also "
131    "specify the module - with the -s option - then the address will be "
132    "treated as a file address in that module, and resolved accordingly.  "
133    "Again, this will allow lldb to track that offset on subsequent reloads. "
134    " The module need not have been loaded at the time you specify this "
135    "breakpoint, and will get resolved when the module is loaded.">;
136  def breakpoint_set_name : Option<"name", "n">, Group<3>, Arg<"FunctionName">,
137    Completion<"Symbol">, Required,
138    Desc<"Set the breakpoint by function name.  Can be repeated multiple times "
139    "to makeone breakpoint for multiple names">;
140  def breakpoint_set_source_regexp_function :
141    Option<"source-regexp-function", "X">, Group<9>, Arg<"FunctionName">,
142    Completion<"Symbol">,
143    Desc<"When used with '-p' limits the source regex to source contained in "
144    "the namedfunctions.  Can be repeated multiple times.">;
145  def breakpoint_set_fullname : Option<"fullname", "F">, Group<4>,
146    Arg<"FullName">, Required, Completion<"Symbol">,
147    Desc<"Set the breakpoint by fully qualified function names. For C++ this "
148    "means namespaces and all arguments, and for Objective-C this means a full "
149    "functionprototype with class and selector.  Can be repeated multiple times"
150    " to make one breakpoint for multiple names.">;
151  def breakpoint_set_selector : Option<"selector", "S">, Group<5>,
152    Arg<"Selector">, Required,
153    Desc<"Set the breakpoint by ObjC selector name. Can be repeated multiple "
154    "times tomake one breakpoint for multiple Selectors.">;
155  def breakpoint_set_method : Option<"method", "M">, Group<6>, Arg<"Method">,
156    Required, Desc<"Set the breakpoint by C++ method names.  Can be repeated "
157    "multiple times tomake one breakpoint for multiple methods.">;
158  def breakpoint_set_func_regex : Option<"func-regex", "r">, Group<7>,
159    Arg<"RegularExpression">, Required, Desc<"Set the breakpoint by function "
160    "name, evaluating a regular-expression to find the function name(s).">;
161  def breakpoint_set_basename : Option<"basename", "b">, Group<8>,
162    Arg<"FunctionName">, Required, Completion<"Symbol">,
163    Desc<"Set the breakpoint by function basename (C++ namespaces and arguments"
164    " will beignored).  Can be repeated multiple times to make one breakpoint "
165    "for multiplesymbols.">;
166  def breakpoint_set_source_pattern_regexp :
167    Option<"source-pattern-regexp", "p">, Group<9>, Arg<"RegularExpression">,
168    Required, Desc<"Set the breakpoint by specifying a regular expression which"
169    " is matched against the source text in a source file or files specified "
170    "with the -f can be specified more than once.  If no source files "
171    "are specified, uses the current \"default source file\".  If you want to "
172    "match against all source files, pass the \"--all-files\" option.">;
173  def breakpoint_set_all_files : Option<"all-files", "A">, Group<9>,
174    Desc<"All files are searched for source pattern matches.">;
175  def breakpoint_set_language_exception : Option<"language-exception", "E">,
176    Group<10>, Arg<"Language">, Required,
177    Desc<"Set the breakpoint on exceptions thrown by the specified language "
178    "(without options, on throw but not catch.)">;
179  def breakpoint_set_on_throw : Option<"on-throw", "w">, Group<10>,
180    Arg<"Boolean">, Desc<"Set the breakpoint on exception throW.">;
181  def breakpoint_set_on_catch : Option<"on-catch", "h">, Group<10>,
182    Arg<"Boolean">, Desc<"Set the breakpoint on exception catcH.">;
183  def breakpoint_set_language : Option<"language", "L">, GroupRange<3, 8>,
184    Arg<"Language">,
185    Desc<"Specifies the Language to use when interpreting the breakpoint's "
186    "expression (note: currently only implemented for setting breakpoints on "
187    "identifiers). If not set the target.language setting is used.">;
188  def breakpoint_set_skip_prologue : Option<"skip-prologue", "K">,
189    Arg<"Boolean">, Groups<[1,3,4,5,6,7,8,12]>,
190    Desc<"sKip the prologue if the breakpoint is at the beginning of a "
191    "function. If not set the target.skip-prologue setting is used.">;
192  def breakpoint_set_breakpoint_name : Option<"breakpoint-name", "N">,
193    Arg<"BreakpointName">,
194    Desc<"Adds this to the list of names for this breakpoint.">;
195  def breakpoint_set_address_slide : Option<"address-slide", "R">,
196    Arg<"Address">, Groups<[1,3,4,5,6,7,8,12]>,
197    Desc<"Add the specified offset to whatever address(es) the breakpoint "
198    "resolves to. At present this applies the offset directly as given, and "
199    "doesn't try to align it to instruction boundaries.">;
200  def breakpoint_set_move_to_nearest_code : Option<"move-to-nearest-code", "m">,
201    Groups<[1,9,12]>, Arg<"Boolean">,
202    Desc<"Move breakpoints to nearest code. If not set the "
203    "target.move-to-nearest-code setting is used.">;
204  def breakpoint_set_file_colon_line : Option<"joint-specifier", "y">, Group<12>, Arg<"FileLineColumn">,
205    Required, Completion<"SourceFile">,
206    Desc<"A specifier in the form filename:line[:column] for setting file & line breakpoints.">;
207  /* Don't add this option till it actually does something useful...
208  def breakpoint_set_exception_typename : Option<"exception-typename", "O">,
209    Arg<"TypeName">, Desc<"The breakpoint will only stop if an "
210    "exception Object of this type is thrown.  Can be repeated multiple times "
211    "to stop for multiple object types">;
212   */
213}
214
215let Command = "breakpoint clear" in {
216  def breakpoint_clear_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
217    Completion<"SourceFile">,
218    Desc<"Specify the breakpoint by source location in this particular file.">;
219  def breakpoint_clear_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
220    Required,
221    Desc<"Specify the breakpoint by source location at this particular line.">;
222}
223
224let Command = "breakpoint delete" in {
225  def breakpoint_delete_force : Option<"force", "f">, Group<1>,
226    Desc<"Delete all breakpoints without querying for confirmation.">;
227  def breakpoint_delete_dummy_breakpoints : Option<"dummy-breakpoints", "D">,
228    Group<1>, Desc<"Delete Dummy breakpoints - i.e. breakpoints set before a "
229    "file is provided, which prime new targets.">;
230  def breakpoint_delete_disabled : Option<"disabled", "d">, Group<1>,
231    Desc<"Delete all breakpoints which are currently disabled.  When using the disabled option "
232    "any breakpoints listed on the command line are EXCLUDED from deletion.">;
233}
234
235let Command = "breakpoint name" in {
236  def breakpoint_name_name : Option<"name", "N">, Group<1>,
237    Arg<"BreakpointName">, Desc<"Specifies a breakpoint name to use.">;
238  def breakpoint_name_breakpoint_id : Option<"breakpoint-id", "B">, Group<2>,
239    Arg<"BreakpointID">, Desc<"Specify a breakpoint ID to use.">;
240  def breakpoint_name_dummy_breakpoints : Option<"dummy-breakpoints", "D">,
241    Group<3>, Desc<"Operate on Dummy breakpoints - i.e. breakpoints set before "
242    "a file is provided, which prime new targets.">;
243  def breakpoint_name_help_string : Option<"help-string", "H">, Group<4>,
244    Arg<"None">, Desc<"A help string describing the purpose of this name.">;
245}
246
247let Command = "breakpoint access" in {
248  def breakpoint_access_allow_list : Option<"allow-list", "L">, Group<1>,
249    Arg<"Boolean">, Desc<"Determines whether the breakpoint will show up in "
250    "break list if not referred to explicitly.">;
251  def breakpoint_access_allow_disable : Option<"allow-disable", "A">, Group<2>,
252    Arg<"Boolean">, Desc<"Determines whether the breakpoint can be disabled by "
253    "name or when all breakpoints are disabled.">;
254  def breakpoint_access_allow_delete : Option<"allow-delete", "D">, Group<3>,
255    Arg<"Boolean">, Desc<"Determines whether the breakpoint can be deleted by "
256    "name or when all breakpoints are deleted.">;
257}
258
259let Command = "breakpoint read" in {
260  def breakpoint_read_file : Option<"file", "f">, Arg<"Filename">, Required,
261    Completion<"DiskFile">,
262    Desc<"The file from which to read the breakpoints.">;
263  def breakpoint_read_breakpoint_name : Option<"breakpoint-name", "N">,
264    Arg<"BreakpointName">, Desc<"Only read in breakpoints with this name.">;
265}
266
267let Command = "breakpoint write" in {
268  def breakpoint_write_file : Option<"file", "f">, Arg<"Filename">, Required,
269    Completion<"DiskFile">,
270    Desc<"The file into which to write the breakpoints.">;
271  def breakpoint_write_append : Option<"append", "a">,
272    Desc<"Append to saved breakpoints file if it exists.">;
273}
274
275let Command = "breakpoint command add" in {
276  def breakpoint_add_one_liner : Option<"one-liner", "o">, Group<1>,
277    Arg<"OneLiner">, Desc<"Specify a one-line breakpoint command inline. Be "
278    "sure to surround it with quotes.">;
279  def breakpoint_add_stop_on_error : Option<"stop-on-error", "e">,
280    Arg<"Boolean">, Desc<"Specify whether breakpoint command execution should "
281    "terminate on error.">;
282  def breakpoint_add_script_type : Option<"script-type", "s">,
283    EnumArg<"None", "ScriptOptionEnum()">,
284    Desc<"Specify the language for the commands - if none is specified, the "
285    "lldb command interpreter will be used.">;
286  def breakpoint_add_dummy_breakpoints : Option<"dummy-breakpoints", "D">,
287    Desc<"Sets Dummy breakpoints - i.e. breakpoints set before a file is "
288    "provided, which prime new targets.">;
289}
290
291let Command = "breakpoint command delete" in {
292  def breakpoint_command_delete_dummy_breakpoints :
293    Option<"dummy-breakpoints", "D">, Group<1>,
294    Desc<"Delete commands from Dummy breakpoints - i.e. breakpoints set before "
295    "a file is provided, which prime new targets.">;
296}
297
298let Command = "disassemble" in {
299  def disassemble_options_bytes : Option<"bytes", "b">,
300    Desc<"Show opcode bytes when disassembling.">;
301  def disassemble_options_context : Option<"context", "C">, Arg<"NumLines">,
302    Desc<"Number of context lines of source to show.">;
303  def disassemble_options_mixed : Option<"mixed", "m">,
304    Desc<"Enable mixed source and assembly display.">;
305  def disassemble_options_raw : Option<"raw", "r">,
306    Desc<"Print raw disassembly with no symbol information.">;
307  def disassemble_options_plugin : Option<"plugin", "P">, Arg<"Plugin">,
308    Desc<"Name of the disassembler plugin you want to use.">;
309  def disassemble_options_flavor : Option<"flavor", "F">,
310    Arg<"DisassemblyFlavor">, Desc<"Name of the disassembly flavor you want to "
311    "use. Currently the only valid options are default, and for Intel "
312    "architectures, att and intel.">;
313  def disassemble_options_arch : Option<"arch", "A">, Arg<"Architecture">,
314    Desc<"Specify the architecture to use from cross disassembly.">;
315  def disassemble_options_start_address : Option<"start-address", "s">,
316    Groups<[1,2]>, Arg<"AddressOrExpression">, Required,
317    Desc<"Address at which to start disassembling.">;
318  def disassemble_options_end_address : Option<"end-address", "e">, Group<1>,
319    Arg<"AddressOrExpression">, Desc<"Address at which to end disassembling.">;
320  def disassemble_options_count : Option<"count", "c">, Groups<[2,3,4,5,7]>,
321    Arg<"NumLines">, Desc<"Number of instructions to display.">;
322  def disassemble_options_name : Option<"name", "n">, Group<3>,
323    Arg<"FunctionName">, Completion<"Symbol">,
324    Desc<"Disassemble entire contents of the given function name.">;
325  def disassemble_options_frame : Option<"frame", "f">, Group<4>,
326    Desc<"Disassemble from the start of the current frame's function.">;
327  def disassemble_options_pc : Option<"pc", "p">, Group<5>,
328    Desc<"Disassemble around the current pc.">;
329  def disassemble_options_line : Option<"line", "l">, Group<6>,
330    Desc<"Disassemble the current frame's current source line instructions if "
331    "there is debug line table information, else disassemble around the pc.">;
332  def disassemble_options_address : Option<"address", "a">, Group<7>,
333    Arg<"AddressOrExpression">,
334    Desc<"Disassemble function containing this address.">;
335  def disassemble_options_force : Option<"force", "\\x01">, Groups<[2,3,4,5,7]>,
336    Desc<"Force dissasembly of large functions.">;
337}
338
339let Command = "expression" in {
340  def expression_options_all_threads : Option<"all-threads", "a">,
341    Groups<[1,2]>, Arg<"Boolean">, Desc<"Should we run all threads if the "
342    "execution doesn't complete on one thread.">;
343  def expression_options_ignore_breakpoints : Option<"ignore-breakpoints", "i">,
344    Groups<[1,2]>, Arg<"Boolean">,
345    Desc<"Ignore breakpoint hits while running expressions">;
346  def expression_options_timeout : Option<"timeout", "t">, Groups<[1,2]>,
347    Arg<"UnsignedInteger">,
348    Desc<"Timeout value (in microseconds) for running the expression.">;
349  def expression_options_unwind_on_error : Option<"unwind-on-error", "u">,
350    Groups<[1,2]>, Arg<"Boolean">,
351    Desc<"Clean up program state if the expression causes a crash, or raises a "
352    "signal. Note, unlike gdb hitting a breakpoint is controlled by another "
353    "option (-i).">;
354  def expression_options_debug : Option<"debug", "g">, Groups<[1,2]>,
355    Desc<"When specified, debug the JIT code by setting a breakpoint on the "
356    "first instruction and forcing breakpoints to not be ignored (-i0) and no "
357    "unwinding to happen on error (-u0).">;
358  def expression_options_language : Option<"language", "l">, Groups<[1,2]>,
359    Arg<"Language">, Desc<"Specifies the Language to use when parsing the "
360    "expression.  If not set the target.language setting is used.">;
361  def expression_options_apply_fixits : Option<"apply-fixits", "X">,
362    Groups<[1,2]>, Arg<"Language">, Desc<"If true, simple fix-it hints will be "
363    "automatically applied to the expression.">;
364  def expression_options_description_verbosity :
365    Option<"description-verbosity", "v">, Group<1>,
366    OptionalEnumArg<"DescriptionVerbosity", "DescriptionVerbosityTypes()">,
367    Desc<"How verbose should the output of this expression be, if the object "
368    "description is asked for.">;
369  def expression_options_top_level : Option<"top-level", "p">, Groups<[1,2]>,
370    Desc<"Interpret the expression as a complete translation unit, without "
371    "injecting it into the local context.  Allows declaration of persistent, "
372    "top-level entities without a $ prefix.">;
373  def expression_options_allow_jit : Option<"allow-jit", "j">, Groups<[1,2]>,
374    Arg<"Boolean">,
375    Desc<"Controls whether the expression can fall back to being JITted if it's "
376    "not supported by the interpreter (defaults to true).">;
377}
378
379let Command = "frame diag" in {
380  def frame_diag_register : Option<"register", "r">, Group<1>,
381    Arg<"RegisterName">, Desc<"A register to diagnose.">;
382  def frame_diag_address : Option<"address", "a">, Group<1>, Arg<"Address">,
383    Desc<"An address to diagnose.">;
384  def frame_diag_offset : Option<"offset", "o">, Group<1>, Arg<"Offset">,
385    Desc<"An optional offset.  Requires --register.">;
386}
387
388let Command = "frame select" in {
389  def frame_select_relative : Option<"relative", "r">, Group<1>, Arg<"Offset">,
390    Desc<"A relative frame index offset from the current frame index.">;
391}
392
393let Command = "frame recognizer add" in {
394  def frame_recognizer_shlib : Option<"shlib", "s">, Arg<"ShlibName">,
395    Completion<"Module">,
396    Desc<"Name of the module or shared library that this recognizer applies "
397    "to.">;
398  def frame_recognizer_function : Option<"function", "n">, Arg<"Name">,
399    Completion<"Symbol">,
400    Desc<"Name of the function that this recognizer applies to. "
401         "Can be specified more than once except if -x|--regex is provided.">;
402  def frame_recognizer_python_class : Option<"python-class", "l">, Group<2>,
403    Arg<"PythonClass">,
404    Desc<"Give the name of a Python class to use for this frame recognizer.">;
405  def frame_recognizer_regex : Option<"regex", "x">,
406    Desc<"Function name and module name are actually regular expressions.">;
407}
408
409let Command = "history" in {
410  def history_count : Option<"count", "c">, Group<1>, Arg<"UnsignedInteger">,
411    Desc<"How many history commands to print.">;
412  def history_start_index : Option<"start-index", "s">, Group<1>,
413    Arg<"UnsignedInteger">, Desc<"Index at which to start printing history "
414    "commands (or end to mean tail mode).">;
415  def history_end_index : Option<"end-index", "e">, Group<1>,
416    Arg<"UnsignedInteger">,
417    Desc<"Index at which to stop printing history commands.">;
418  def history_clear : Option<"clear", "C">, Group<2>,
419    Desc<"Clears the current command history.">;
420}
421
422let Command = "log" in {
423  def log_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
424    Desc<"Set the destination file to log to.">;
425  def log_threadsafe : Option<"threadsafe", "t">, Group<1>,
426    Desc<"Enable thread safe logging to avoid interweaved log lines.">;
427  def log_verbose : Option<"verbose", "v">, Group<1>,
428    Desc<"Enable verbose logging.">;
429  def log_sequence : Option<"sequence", "s">, Group<1>,
430    Desc<"Prepend all log lines with an increasing integer sequence id.">;
431  def log_timestamp : Option<"timestamp", "T">, Group<1>,
432    Desc<"Prepend all log lines with a timestamp.">;
433  def log_pid_tid : Option<"pid-tid", "p">, Group<1>,
434    Desc<"Prepend all log lines with the process and thread ID that generates "
435    "the log line.">;
436  def log_thread_name : Option<"thread-name", "n">, Group<1>,
437    Desc<"Prepend all log lines with the thread name for the thread that "
438    "generates the log line.">;
439
440  def log_stack : Option<"stack", "S">, Group<1>,
441    Desc<"Append a stack backtrace to each log line.">;
442  def log_append : Option<"append", "a">, Group<1>,
443    Desc<"Append to the log file instead of overwriting.">;
444  def log_file_function : Option<"file-function", "F">, Group<1>,
445    Desc<"Prepend the names of files and function that generate the logs.">;
446}
447
448let Command = "reproducer dump" in {
449  def reproducer_provider : Option<"provider", "p">, Group<1>,
450    EnumArg<"None", "ReproducerProviderType()">,
451    Required, Desc<"The reproducer provider to dump.">;
452  def reproducer_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
453    Desc<"The reproducer path. If a reproducer is replayed and no path is "
454    "provided, that reproducer is dumped.">;
455}
456
457let Command = "reproducer verify" in {
458  def reproducer_verify_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
459    Desc<"The reproducer path. If a reproducer is replayed and no path is "
460    "provided, that reproducer is dumped.">;
461}
462
463let Command = "reproducer xcrash" in {
464  def reproducer_signal : Option<"signal", "s">, Group<1>,
465    EnumArg<"None", "ReproducerSignalType()">,
466    Required, Desc<"The signal to crash the debugger.">;
467}
468
469let Command = "memory read" in {
470  def memory_read_num_per_line : Option<"num-per-line", "l">, Group<1>,
471    Arg<"NumberPerLine">, Desc<"The number of items per line to display.">;
472  def memory_read_binary : Option<"binary", "b">, Group<2>,
473    Desc<"If true, memory will be saved as binary. If false, the memory is "
474    "saved save as an ASCII dump that uses the format, size, count and number "
475    "per line settings.">;
476  def memory_read_type : Option<"type", "t">, Groups<[3,4]>, Arg<"Name">,
477    Required, Desc<"The name of a type to view memory as.">;
478  def memory_read_language : Option<"language", "x">, Group<4>, Arg<"Language">,
479    Desc<"The language of the type to view memory as.">;
480  def memory_read_offset : Option<"offset", "E">, Group<3>, Arg<"Count">,
481    Desc<"How many elements of the specified type to skip before starting to "
482    "display data.">;
483  def memory_read_force : Option<"force", "r">, Groups<[1,2,3]>,
484    Desc<"Necessary if reading over target.max-memory-read-size bytes.">;
485}
486
487let Command = "memory find" in {
488  def memory_find_expression : Option<"expression", "e">, Group<1>,
489    Arg<"Expression">, Required,
490    Desc<"Evaluate an expression to obtain a byte pattern.">;
491  def memory_find_string : Option<"string", "s">, Group<2>, Arg<"Name">,
492    Required, Desc<"Use text to find a byte pattern.">;
493  def memory_find_count : Option<"count", "c">, Arg<"Count">,
494    Desc<"How many times to perform the search.">;
495  def memory_find_dump_offset : Option<"dump-offset", "o">, Arg<"Offset">,
496    Desc<"When dumping memory for a match, an offset from the match location to"
497    " start dumping from.">;
498}
499
500let Command = "memory write" in {
501  def memory_write_infile : Option<"infile", "i">, Group<1>, Arg<"Filename">,
502    Required, Desc<"Write memory using the contents of a file.">;
503  def memory_write_offset : Option<"offset", "o">, Group<1>, Arg<"Offset">,
504    Desc<"Start writing bytes from an offset within the input file.">;
505}
506
507let Command = "memory tag write" in {
508  def memory_write_end_addr : Option<"end-addr", "e">, Group<1>,
509  Arg<"AddressOrExpression">, Desc<
510    "Set tags for start address to end-addr, repeating tags as needed"
511    " to cover the range. (instead of calculating the range from the"
512    " number of tags given)">;
513}
514
515let Command = "register read" in {
516  def register_read_alternate : Option<"alternate", "A">,
517    Desc<"Display register names using the alternate register name if there "
518    "is one.">;
519  def register_read_set : Option<"set", "s">, Group<1>, Arg<"Index">,
520    Desc<"Specify which register sets to dump by index.">;
521  def register_read_all : Option<"all", "a">, Group<2>,
522    Desc<"Show all register sets.">;
523}
524
525let Command = "source" in {
526  def source_stop_on_error : Option<"stop-on-error", "e">, Arg<"Boolean">,
527    Desc<"If true, stop executing commands on error.">;
528  def source_stop_on_continue : Option<"stop-on-continue", "c">, Arg<"Boolean">,
529    Desc<"If true, stop executing commands on continue.">;
530  def source_silent_run : Option<"silent-run", "s">, Arg<"Boolean">,
531    Desc<"If true don't echo commands while executing.">;
532}
533
534let Command = "alias" in {
535  def alias_help : Option<"help", "h">, Arg<"HelpText">,
536    Desc<"Help text for this command">;
537  def alias_long_help : Option<"long-help", "H">, Arg<"HelpText">,
538    Desc<"Long help text for this command">;
539}
540
541let Command = "regex" in {
542  def regex_help : Option<"help", "h">, Group<1>, Arg<"None">,
543    Desc<"The help text to display for this command.">;
544  def regex_syntax : Option<"syntax", "s">, Group<1>, Arg<"None">,
545    Desc<"A syntax string showing the typical usage syntax.">;
546}
547
548let Command = "permissions" in {
549  def permissions_permissions_value : Option<"permissions-value", "v">,
550    Arg<"PermissionsNumber">,
551    Desc<"Give out the numeric value for permissions (e.g. 757)">;
552  def permissions_permissions_string : Option<"permissions-string", "s">,
553    Arg<"PermissionsString">,
554    Desc<"Give out the string value for permissions (e.g. rwxr-xr--).">;
555  def permissions_user_read : Option<"user-read", "r">,
556    Desc<"Allow user to read.">;
557  def permissions_user_write : Option<"user-write", "w">,
558    Desc<"Allow user to write.">;
559  def permissions_user_exec : Option<"user-exec", "x">,
560    Desc<"Allow user to execute.">;
561  def permissions_group_read : Option<"group-read", "R">,
562    Desc<"Allow group to read.">;
563  def permissions_group_write : Option<"group-write", "W">,
564    Desc<"Allow group to write.">;
565  def permissions_group_exec : Option<"group-exec", "X">,
566    Desc<"Allow group to execute.">;
567  def permissions_world_read : Option<"world-read", "d">,
568    Desc<"Allow world to read.">;
569  def permissions_world_write : Option<"world-write", "t">,
570    Desc<"Allow world to write.">;
571  def permissions_world_exec : Option<"world-exec", "e">,
572    Desc<"Allow world to execute.">;
573}
574
575let Command = "platform fread" in {
576  def platform_fread_offset : Option<"offset", "o">, Group<1>, Arg<"Index">,
577    Desc<"Offset into the file at which to start reading.">;
578  def platform_fread_count : Option<"count", "c">, Group<1>, Arg<"Count">,
579    Desc<"Number of bytes to read from the file.">;
580}
581
582let Command = "platform fwrite" in {
583  def platform_fwrite_offset : Option<"offset", "o">, Group<1>, Arg<"Index">,
584    Desc<"Offset into the file at which to start reading.">;
585  def platform_fwrite_data : Option<"data", "d">, Group<1>, Arg<"Value">,
586    Desc<"Text to write to the file.">;
587}
588
589let Command = "platform process list" in {
590  def platform_process_list_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">,
591    Desc<"List the process info for a specific process ID.">;
592  def platform_process_list_name : Option<"name", "n">, Group<2>,
593    Arg<"ProcessName">, Required,
594    Desc<"Find processes with executable basenames that match a string.">;
595  def platform_process_list_ends_with : Option<"ends-with", "e">, Group<3>,
596  Arg<"ProcessName">, Required,
597    Desc<"Find processes with executable basenames that end with a string.">;
598  def platform_process_list_starts_with : Option<"starts-with", "s">, Group<4>,
599    Arg<"ProcessName">, Required,
600    Desc<"Find processes with executable basenames that start with a string.">;
601  def platform_process_list_contains : Option<"contains", "c">, Group<5>,
602    Arg<"ProcessName">, Required,
603    Desc<"Find processes with executable basenames that contain a string.">;
604  def platform_process_list_regex : Option<"regex", "r">, Group<6>,
605    Arg<"RegularExpression">, Required,
606    Desc<"Find processes with executable basenames that match a regular "
607    "expression.">;
608  def platform_process_list_parent : Option<"parent", "P">, GroupRange<2, 6>,
609    Arg<"Pid">, Desc<"Find processes that have a matching parent process ID.">;
610  def platform_process_list_uid : Option<"uid", "u">, GroupRange<2, 6>,
611    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
612    Desc<"Find processes that have a matching user ID.">;
613  def platform_process_list_euid : Option<"euid", "U">, GroupRange<2, 6>,
614    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
615    Desc<"Find processes that have a matching effective user ID.">;
616  def platform_process_list_gid : Option<"gid", "g">, GroupRange<2, 6>,
617    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
618    Desc<"Find processes that have a matching group ID.">;
619  def platform_process_list_egid : Option<"egid", "G">, GroupRange<2, 6>,
620    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
621    Desc<"Find processes that have a matching effective group ID.">;
622  def platform_process_list_arch : Option<"arch", "a">, GroupRange<2, 6>,
623    Arg<"Architecture">,
624    Desc<"Find processes that have a matching architecture.">;
625  def platform_process_list_show_args : Option<"show-args", "A">,
626    GroupRange<1, 6>,
627    Desc<"Show process arguments instead of the process executable basename.">;
628  def platform_process_list_all_users: Option<"all-users", "x">,
629    GroupRange<1,6>,
630    Desc<"Show processes matching all user IDs.">;
631  def platform_process_list_verbose : Option<"verbose", "v">, GroupRange<1, 6>,
632    Desc<"Enable verbose output.">;
633}
634
635let Command = "platform process attach" in {
636  def platform_process_attach_plugin : Option<"plugin", "P">, Arg<"Plugin">,
637    Desc<"Name of the process plugin you want to use.">;
638  def platform_process_attach_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">,
639    Desc<"The process ID of an existing process to attach to.">;
640  def platform_process_attach_name : Option<"name", "n">, Group<2>,
641    Arg<"ProcessName">, Desc<"The name of the process to attach to.">;
642  def platform_process_attach_waitfor : Option<"waitfor", "w">, Group<2>,
643    Desc<"Wait for the process with <process-name> to launch.">;
644}
645
646let Command = "platform shell" in {
647  def platform_shell_host : Option<"host", "h">,
648    Desc<"Run the commands on the host shell when enabled.">;
649  def platform_shell_timeout : Option<"timeout", "t">, Arg<"Value">,
650    Desc<"Seconds to wait for the remote host to finish running the command.">;
651  def platform_shell_interpreter : Option<"shell", "s">, Arg<"Path">,
652    Desc<"Shell interpreter path. This is the binary used to run the command.">;
653}
654
655let Command = "process launch" in {
656  def process_launch_stop_at_entry : Option<"stop-at-entry", "s">,
657    Desc<"Stop at the entry point of the program when launching a process.">;
658  def process_launch_disable_aslr : Option<"disable-aslr", "A">, Arg<"Boolean">,
659    Desc<"Set whether to disable address space layout randomization when launching a process.">;
660  def process_launch_plugin : Option<"plugin", "P">, Arg<"Plugin">,
661    Desc<"Name of the process plugin you want to use.">;
662  def process_launch_working_dir : Option<"working-dir", "w">, Arg<"DirectoryName">,
663    Desc<"Set the current working directory to <path> when running the inferior.">;
664  def process_launch_arch : Option<"arch", "a">, Arg<"Architecture">,
665    Desc<"Set the architecture for the process to launch when ambiguous.">;
666  def process_launch_environment : Option<"environment", "E">,
667    Arg<"None">, Desc<"Specify an environment variable name/value string "
668    "(--environment NAME=VALUE). Can be specified multiple times for subsequent "
669    "environment entries.">;
670  def process_launch_shell : Option<"shell", "c">, GroupRange<1,3>,
671    OptionalArg<"Filename">, Desc<"Run the process in a shell (not supported on all platforms).">;
672  def process_launch_stdin : Option<"stdin", "i">, Group<1>,
673    Arg<"Filename">, Desc<"Redirect stdin for the process to <filename>.">;
674  def process_launch_stdout : Option<"stdout", "o">, Group<1>,
675    Arg<"Filename">, Desc<"Redirect stdout for the process to <filename>.">;
676  def process_launch_stderr : Option<"stderr", "e">, Group<1>,
677    Arg<"Filename">, Desc<"Redirect stderr for the process to <filename>.">;
678  def process_launch_tty : Option<"tty", "t">, Group<2>,
679    Desc<"Start the process in a terminal (not supported on all platforms).">;
680  def process_launch_no_stdio : Option<"no-stdio", "n">, Group<3>,
681    Desc<"Do not set up for terminal I/O to go to running process.">;
682  def process_launch_shell_expand_args : Option<"shell-expand-args", "X">, Group<4>,
683    Arg<"Boolean">, Desc<"Set whether to shell expand arguments to the process when launching.">;
684}
685
686let Command = "process attach" in {
687  def process_attach_continue : Option<"continue", "c">,
688    Desc<"Immediately continue the process once attached.">;
689  def process_attach_plugin : Option<"plugin", "P">, Arg<"Plugin">,
690    Desc<"Name of the process plugin you want to use.">;
691  def process_attach_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">,
692    Desc<"The process ID of an existing process to attach to.">;
693  def process_attach_name : Option<"name", "n">, Group<2>, Arg<"ProcessName">,
694    Desc<"The name of the process to attach to.">;
695  def process_attach_include_existing : Option<"include-existing", "i">,
696    Group<2>, Desc<"Include existing processes when doing attach -w.">;
697  def process_attach_waitfor : Option<"waitfor", "w">, Group<2>,
698    Desc<"Wait for the process with <process-name> to launch.">;
699}
700
701let Command = "process continue" in {
702  def process_continue_ignore_count : Option<"ignore-count", "i">,
703    Arg<"UnsignedInteger">, Desc<"Ignore <N> crossings of the breakpoint (if it"
704    " exists) for the currently selected thread.">;
705}
706
707let Command = "process detach" in {
708  def process_detach_keep_stopped : Option<"keep-stopped", "s">, Group<1>,
709    Arg<"Boolean">, Desc<"Whether or not the process should be kept stopped on"
710    " detach (if possible).">;
711}
712
713let Command = "process connect" in {
714  def process_connect_plugin : Option<"plugin", "p">, Arg<"Plugin">,
715    Desc<"Name of the process plugin you want to use.">;
716}
717
718let Command = "process load" in {
719  def process_load_install : Option<"install", "i">, OptionalArg<"Path">,
720    Desc<"Install the shared library to the target. If specified without an "
721    "argument then the library will installed in the current working "
722    "directory.">;
723}
724
725let Command = "process handle" in {
726  def process_handle_stop : Option<"stop", "s">, Group<1>, Arg<"Boolean">,
727    Desc<"Whether or not the process should be stopped if the signal is "
728    "received.">;
729  def process_handle_notify : Option<"notify", "n">, Group<1>, Arg<"Boolean">,
730    Desc<"Whether or not the debugger should notify the user if the signal is "
731    "received.">;
732  def process_handle_pass : Option<"pass", "p">, Group<1>, Arg<"Boolean">,
733    Desc<"Whether or not the signal should be passed to the process.">;
734}
735
736let Command = "process status" in {
737  def process_status_verbose : Option<"verbose", "v">, Group<1>,
738    Desc<"Show verbose process status including extended crash information.">;
739}
740
741let Command = "process save_core" in {
742  def process_save_core_style : Option<"style", "s">, Group<1>,
743    EnumArg<"SaveCoreStyle", "SaveCoreStyles()">, Desc<"Request a specific style "
744    "of corefile to be saved.">;
745}
746
747let Command = "script import" in {
748  def script_import_allow_reload : Option<"allow-reload", "r">, Group<1>,
749    Desc<"Allow the script to be loaded even if it was already loaded before. "
750    "This argument exists for backwards compatibility, but reloading is always "
751    "allowed, whether you specify it or not.">;
752  def relative_to_command_file : Option<"relative-to-command-file", "c">,
753    Group<1>, Desc<"Resolve non-absolute paths relative to the location of the "
754    "current command file. This argument can only be used when the command is "
755    "being sourced from a file.">;
756  def silent : Option<"silent", "s">, Group<1>,
757    Desc<"If true don't print any script output while importing.">;
758}
759
760let Command = "script add" in {
761  def script_add_function : Option<"function", "f">, Group<1>,
762    Arg<"PythonFunction">,
763    Desc<"Name of the Python function to bind to this command name.">;
764  def script_add_class : Option<"class", "c">, Group<2>, Arg<"PythonClass">,
765  Desc<"Name of the Python class to bind to this command name.">;
766  def script_add_help : Option<"help", "h">, Group<1>, Arg<"HelpText">,
767  Desc<"The help text to display for this command.">;
768  def script_add_synchronicity : Option<"synchronicity", "s">,
769    EnumArg<"ScriptedCommandSynchronicity", "ScriptSynchroType()">,
770    Desc<"Set the synchronicity of this command's executions with regard to "
771    "LLDB event system.">;
772}
773
774let Command = "script" in {
775  def script_language : Option<"language", "l">,
776    EnumArg<"ScriptLang", "ScriptOptionEnum()">, Desc<"Specify the scripting "
777    " language. If none is specific the default scripting language is used.">;
778}
779
780let Command = "source info" in {
781  def source_info_count : Option<"count", "c">, Arg<"Count">,
782    Desc<"The number of line entries to display.">;
783  def source_info_shlib : Option<"shlib", "s">, Groups<[1,2]>, Arg<"ShlibName">,
784    Completion<"Module">, Desc<"Look up the source in the given module or "
785    "shared library (can be specified more than once).">;
786  def source_info_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
787    Completion<"SourceFile">, Desc<"The file from which to display source.">;
788  def source_info_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
789    Desc<"The line number at which to start the displaying lines.">;
790  def source_info_end_line : Option<"end-line", "e">, Group<1>, Arg<"LineNum">,
791    Desc<"The line number at which to stop displaying lines.">;
792  def source_info_name : Option<"name", "n">, Group<2>, Arg<"Symbol">,
793    Completion<"Symbol">,
794    Desc<"The name of a function whose source to display.">;
795  def source_info_address : Option<"address", "a">, Group<3>,
796    Arg<"AddressOrExpression">, Desc<"Lookup the address and display the source"
797    " information for the corresponding file and line.">;
798}
799
800let Command = "source list" in {
801  def source_list_count : Option<"count", "c">, Arg<"Count">,
802    Desc<"The number of source lines to display.">;
803  def source_list_shlib : Option<"shlib", "s">, Groups<[1,2,5]>, Arg<"ShlibName">,
804    Completion<"Module">,
805    Desc<"Look up the source file in the given shared library.">;
806  def source_list_show_breakpoints : Option<"show-breakpoints", "b">,
807    Desc<"Show the line table locations from the debug information that "
808    "indicate valid places to set source level breakpoints.">;
809  def source_list_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
810    Completion<"SourceFile">, Desc<"The file from which to display source.">;
811  def source_list_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
812    Desc<"The line number at which to start the display source.">;
813  def source_list_name : Option<"name", "n">, Group<2>, Arg<"Symbol">,
814    Completion<"Symbol">,
815    Desc<"The name of a function whose source to display.">;
816  def source_list_address : Option<"address", "a">, Group<3>,
817    Arg<"AddressOrExpression">, Desc<"Lookup the address and display the source"
818    " information for the corresponding file and line.">;
819  def source_list_reverse : Option<"reverse", "r">, Group<4>, Desc<"Reverse the"
820    " listing to look backwards from the last displayed block of source.">;
821  def source_list_file_colon_line : Option<"joint-specifier", "y">, Group<5>,
822    Arg<"FileLineColumn">, Completion<"SourceFile">,
823    Desc<"A specifier in the form filename:line[:column] from which to display"
824         " source.">;
825}
826
827let Command = "target dependents" in {
828  def dependents_no_dependents : Option<"no-dependents", "d">, Group<1>,
829    OptionalEnumArg<"Value", "OptionEnumValues(g_dependents_enumaration)">,
830    Desc<"Whether or not to load dependents when creating a target. If the "
831         "option is not specified, the value is implicitly 'default'. If the "
832         "option is specified but without a value, the value is implicitly "
833         "'true'.">;
834}
835
836let Command = "target modules dump" in {
837  def target_modules_dump_verbose : Option<"verbose", "v">,
838    Desc<"Enable verbose dump.">;
839}
840
841let Command = "target modules list" in {
842  def target_modules_list_address : Option<"address", "a">, Group<1>,
843    Arg<"AddressOrExpression">, Desc<"Display the image at this address.">;
844  def target_modules_list_arch : Option<"arch", "A">, Group<1>,
845    OptionalArg<"Width">, Desc<"Display the architecture when listing images.">;
846  def target_modules_list_triple : Option<"triple", "t">, Group<1>,
847    OptionalArg<"Width">, Desc<"Display the triple when listing images.">;
848  def target_modules_list_header : Option<"header", "h">, Group<1>,
849    Desc<"Display the image base address as a load address if debugging, a file"
850    " address otherwise.">;
851  def target_modules_list_offset : Option<"offset", "o">, Group<1>,
852    Desc<"Display the image load address offset from the base file address "
853    "(the slide amount).">;
854  def target_modules_list_uuid : Option<"uuid", "u">, Group<1>,
855    Desc<"Display the UUID when listing images.">;
856  def target_modules_list_fullpath : Option<"fullpath", "f">, Group<1>,
857    OptionalArg<"Width">,
858    Desc<"Display the fullpath to the image object file.">;
859  def target_modules_list_directory : Option<"directory", "d">, Group<1>,
860    OptionalArg<"Width">, Desc<"Display the directory with optional width for "
861    "the image object file.">;
862  def target_modules_list_basename : Option<"basename", "b">, Group<1>,
863    OptionalArg<"Width">, Desc<"Display the basename with optional width for "
864    "the image object file.">;
865  def target_modules_list_symfile : Option<"symfile", "s">, Group<1>,
866    OptionalArg<"Width">, Desc<"Display the fullpath to the image symbol file "
867    "with optional width.">;
868  def target_modules_list_symfile_unique : Option<"symfile-unique", "S">,
869    Group<1>, OptionalArg<"Width">, Desc<"Display the symbol file with optional"
870    " width only if it is different from the executable object file.">;
871  def target_modules_list_mod_time : Option<"mod-time", "m">, Group<1>,
872    OptionalArg<"Width">, Desc<"Display the modification time with optional "
873    "width of the module.">;
874  def target_modules_list_ref_count : Option<"ref-count", "r">, Group<1>,
875    OptionalArg<"Width">, Desc<"Display the reference count if the module is "
876    "still in the shared module cache.">;
877  def target_modules_list_pointer : Option<"pointer", "p">, Group<1>,
878    OptionalArg<"None">, Desc<"Display the module pointer.">;
879  def target_modules_list_global : Option<"global", "g">, Group<1>,
880    Desc<"Display the modules from the global module list, not just the "
881    "current target.">;
882}
883
884let Command = "target modules show unwind" in {
885  def target_modules_show_unwind_name : Option<"name", "n">, Group<1>,
886    Arg<"FunctionName">,
887    Desc<"Show unwind instructions for a function or symbol name.">;
888  def target_modules_show_unwind_address : Option<"address", "a">, Group<2>,
889    Arg<"AddressOrExpression">, Desc<"Show unwind instructions for a function "
890    "or symbol containing an address">;
891}
892
893let Command = "target modules lookup" in {
894  def target_modules_lookup_address : Option<"address", "a">, Group<1>,
895    Arg<"AddressOrExpression">, Required, Desc<"Lookup an address in one or "
896    "more target modules.">;
897  def target_modules_lookup_offset : Option<"offset", "o">, Group<1>,
898    Arg<"Offset">, Desc<"When looking up an address subtract <offset> from any "
899    "addresses before doing the lookup.">;
900  // FIXME: re-enable regex for types when the LookupTypeInModule actually uses
901  // the regex option by adding to group 6.
902  def target_modules_lookup_regex : Option<"regex", "r">, Groups<[2,4,5]>,
903    Desc<"The <name> argument for name lookups are regular expressions.">;
904  def target_modules_lookup_symbol : Option<"symbol", "s">, Group<2>,
905    Arg<"Symbol">, Required, Desc<"Lookup a symbol by name in the symbol tables"
906    " in one or more target modules.">;
907  def target_modules_lookup_file : Option<"file", "f">, Group<3>,
908    Arg<"Filename">, Required, Desc<"Lookup a file by fullpath or basename in "
909    "one or more target modules.">;
910  def target_modules_lookup_line : Option<"line", "l">, Group<3>,
911    Arg<"LineNum">, Desc<"Lookup a line number in a file (must be used in "
912    "conjunction with --file).">;
913  def target_modules_lookup_no_inlines : Option<"no-inlines", "i">,
914    GroupRange<3,5>,
915    Desc<"Ignore inline entries (must be used in conjunction with --file or "
916    "--function).">;
917  def target_modules_lookup_function : Option<"function", "F">, Group<4>,
918    Arg<"FunctionName">, Required, Desc<"Lookup a function by name in the debug"
919    " symbols in one or more target modules.">;
920  def target_modules_lookup_name : Option<"name", "n">, Group<5>,
921    Arg<"FunctionOrSymbol">, Required, Desc<"Lookup a function or symbol by "
922    "name in one or more target modules.">;
923  def target_modules_lookup_type : Option<"type", "t">, Group<6>, Arg<"Name">,
924    Required, Desc<"Lookup a type by name in the debug symbols in one or more "
925    "target modules.">;
926  def target_modules_lookup_verbose : Option<"verbose", "v">,
927    Desc<"Enable verbose lookup information.">;
928  def target_modules_lookup_all : Option<"all", "A">, Desc<"Print all matches, "
929    "not just the best match, if a best match is available.">;
930}
931
932let Command = "target stop hook add" in {
933  def target_stop_hook_add_one_liner : Option<"one-liner", "o">, GroupRange<1,3>,
934    Arg<"OneLiner">, Desc<"Add a command for the stop hook.  Can be specified "
935    "more than once, and commands will be run in the order they appear.">;
936  def target_stop_hook_add_shlib : Option<"shlib", "s">, Arg<"ShlibName">,
937    Completion<"Module">,
938    Desc<"Set the module within which the stop-hook is to be run.">;
939  def target_stop_hook_add_thread_index : Option<"thread-index", "x">,
940    Arg<"ThreadIndex">, Desc<"The stop hook is run only for the thread whose "
941    "index matches this argument.">;
942  def target_stop_hook_add_thread_id : Option<"thread-id", "t">,
943    Arg<"ThreadID">, Desc<"The stop hook is run only for the thread whose TID "
944    "matches this argument.">;
945  def target_stop_hook_add_thread_name : Option<"thread-name", "T">,
946    Arg<"ThreadName">, Desc<"The stop hook is run only for the thread whose "
947    "thread name matches this argument.">;
948  def target_stop_hook_add_queue_name : Option<"queue-name", "q">,
949    Arg<"QueueName">, Desc<"The stop hook is run only for threads in the queue "
950    "whose name is given by this argument.">;
951  def target_stop_hook_add_file : Option<"file", "f">, Groups<[1,4]>,
952    Arg<"Filename">, Desc<"Specify the source file within which the stop-hook "
953    "is to be run.">, Completion<"SourceFile">;
954  def target_stop_hook_add_start_line : Option<"start-line", "l">, Groups<[1,4]>,
955    Arg<"LineNum">, Desc<"Set the start of the line range for which the "
956    "stop-hook is to be run.">;
957  def target_stop_hook_add_end_line : Option<"end-line", "e">, Groups<[1,4]>,
958    Arg<"LineNum">, Desc<"Set the end of the line range for which the stop-hook"
959    " is to be run.">;
960  def target_stop_hook_add_classname : Option<"classname", "c">, Groups<[2,5]>,
961    Arg<"ClassName">,
962    Desc<"Specify the class within which the stop-hook is to be run.">;
963  def target_stop_hook_add_name : Option<"name", "n">, Groups<[3,6]>,
964    Arg<"FunctionName">, Desc<"Set the function name within which the stop hook"
965    " will be run.">, Completion<"Symbol">;
966  def target_stop_hook_add_auto_continue : Option<"auto-continue", "G">,
967    Arg<"Boolean">, Desc<"The breakpoint will auto-continue after running its"
968    " commands.">;
969}
970
971let Command = "thread backtrace" in {
972  def thread_backtrace_count : Option<"count", "c">, Group<1>, Arg<"Count">,
973  Desc<"How many frames to display (-1 for all)">;
974  def thread_backtrace_start : Option<"start", "s">, Group<1>,
975  Arg<"FrameIndex">, Desc<"Frame in which to start the backtrace">;
976  def thread_backtrace_extended : Option<"extended", "e">, Group<1>,
977  Arg<"Boolean">, Desc<"Show the extended backtrace, if available">;
978}
979
980let Command = "thread step scope" in {
981  def thread_step_scope_step_in_avoids_no_debug :
982    Option<"step-in-avoids-no-debug", "a">, Group<1>, Arg<"Boolean">,
983    Desc<"A boolean value that sets whether stepping into functions will step "
984    "over functions with no debug information.">;
985  def thread_step_scope_step_out_avoids_no_debug :
986    Option<"step-out-avoids-no-debug", "A">, Group<1>, Arg<"Boolean">,
987    Desc<"A boolean value, if true stepping out of functions will continue to"
988    " step out till it hits a function with debug information.">;
989  def thread_step_scope_count : Option<"count", "c">, Group<1>, Arg<"Count">,
990    Desc<"How many times to perform the stepping operation - currently only "
991    "supported for step-inst and next-inst.">;
992  def thread_step_scope_end_linenumber : Option<"end-linenumber", "e">,
993    Group<1>, Arg<"LineNum">, Desc<"The line at which to stop stepping - "
994      "defaults to the next line and only supported for step-in and step-over."
995      "  You can also pass the string 'block' to step to the end of the current"
996      " block.  This is particularly use  in conjunction with --step-target to"
997      " step through a complex calling sequence.">;
998  def thread_step_scope_run_mode : Option<"run-mode", "m">, Group<1>,
999    EnumArg<"RunMode", "TriRunningModes()">, Desc<"Determine how to run other "
1000    "threads while stepping the current thread.">;
1001  def thread_step_scope_step_over_regexp : Option<"step-over-regexp", "r">,
1002    Group<1>, Arg<"RegularExpression">, Desc<"A regular expression that defines "
1003    "function names to not to stop at when stepping in.">;
1004  def thread_step_scope_step_in_target : Option<"step-in-target", "t">,
1005    Group<1>, Arg<"FunctionName">, Desc<"The name of the directly called "
1006    "function step in should stop at when stepping into.">;
1007}
1008
1009let Command = "thread until" in {
1010  def thread_until_frame : Option<"frame", "f">, Group<1>, Arg<"FrameIndex">,
1011    Desc<"Frame index for until operation - defaults to 0">;
1012  def thread_until_thread : Option<"thread", "t">, Group<1>, Arg<"ThreadIndex">,
1013    Desc<"Thread index for the thread for until operation">;
1014  def thread_until_run_mode : Option<"run-mode", "m">, Group<1>,
1015    EnumArg<"RunMode", "DuoRunningModes()">, Desc<"Determine how to run other "
1016    "threads while stepping this one">;
1017  def thread_until_address : Option<"address", "a">, Group<1>,
1018    Arg<"AddressOrExpression">, Desc<"Run until we reach the specified address, "
1019    "or leave the function - can be specified multiple times.">;
1020}
1021
1022let Command = "thread info" in {
1023  def thread_info_json : Option<"json", "j">, Desc<"Display the thread info in"
1024    " JSON format.">;
1025  def thread_info_stop_info : Option<"stop-info", "s">, Desc<"Display the "
1026    "extended stop info in JSON format.">;
1027}
1028
1029let Command = "thread return" in {
1030  def thread_return_from_expression : Option<"from-expression", "x">,
1031    Desc<"Return from the innermost expression evaluation.">;
1032}
1033
1034let Command = "thread jump" in {
1035  def thread_jump_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
1036    Completion<"SourceFile">, Desc<"Specifies the source file to jump to.">;
1037  def thread_jump_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
1038    Required, Desc<"Specifies the line number to jump to.">;
1039  def thread_jump_by : Option<"by", "b">, Group<2>, Arg<"Offset">, Required,
1040    Desc<"Jumps by a relative line offset from the current line.">;
1041  def thread_jump_address : Option<"address", "a">, Group<3>,
1042    Arg<"AddressOrExpression">, Required, Desc<"Jumps to a specific address.">;
1043  def thread_jump_force : Option<"force", "r">, Groups<[1,2,3]>,
1044    Desc<"Allows the PC to leave the current function.">;
1045}
1046
1047let Command = "thread plan list" in {
1048  def thread_plan_list_verbose : Option<"verbose", "v">, Group<1>,
1049    Desc<"Display more information about the thread plans">;
1050  def thread_plan_list_internal : Option<"internal", "i">, Group<1>,
1051    Desc<"Display internal as well as user thread plans">;
1052  def thread_plan_list_thread_id : Option<"thread-id", "t">, Group<1>,
1053    Arg<"ThreadID">, Desc<"List the thread plans for this TID, can be "
1054    "specified more than once.">;
1055  def thread_plan_list_unreported : Option<"unreported", "u">, Group<1>,
1056    Desc<"Display thread plans for unreported threads">;
1057}
1058
1059let Command = "thread trace dump instructions" in {
1060  def thread_trace_dump_instructions_forwards: Option<"forwards", "f">, Group<1>,
1061    Desc<"If specified, the trace is traversed forwards chronologically "
1062    "starting at the oldest instruction. Otherwise, it starts at the most "
1063    "recent one and the traversal is backwards.">;
1064  def thread_trace_dump_instructions_count : Option<"count", "c">, Group<1>,
1065    Arg<"Count">,
1066    Desc<"The number of instructions to display starting at the most recent "
1067    "instruction, or the oldest if --forwards is provided.">;
1068  def thread_trace_dump_instructions_skip: Option<"skip", "s">,
1069    Group<1>,
1070    Arg<"Index">,
1071    Desc<"How many instruction to skip from the end of the trace to start "
1072    "dumping instructions, or from the beginning if --forwards is provided">;
1073  def thread_trace_dump_instructions_raw : Option<"raw", "r">,
1074    Group<1>,
1075    Desc<"Dump only instruction address without disassembly nor symbol information.">;
1076  def thread_trace_dump_instructions_show_tsc : Option<"tsc", "t">,
1077    Group<1>,
1078    Desc<"For each instruction, print the corresponding timestamp counter if available.">;
1079}
1080
1081let Command = "thread trace dump info" in {
1082  def thread_trace_dump_info_verbose : Option<"verbose", "v">, Group<1>,
1083    Desc<"show verbose thread trace dump info">;
1084}
1085
1086let Command = "type summary add" in {
1087  def type_summary_add_category : Option<"category", "w">, Arg<"Name">,
1088    Desc<"Add this to the given category instead of the default one.">;
1089  def type_summary_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1090    Desc<"If true, cascade through typedef chains.">;
1091  def type_summary_add_no_value : Option<"no-value", "v">,
1092    Desc<"Don't show the value, just show the summary, for this type.">;
1093  def type_summary_add_skip_pointers : Option<"skip-pointers", "p">,
1094    Desc<"Don't use this format for pointers-to-type objects.">;
1095  def type_summary_add_skip_references : Option<"skip-references", "r">,
1096    Desc<"Don't use this format for references-to-type objects.">;
1097  def type_summary_add_regex : Option<"regex", "x">,
1098    Desc<"Type names are actually regular expressions.">;
1099  def type_summary_add_inline_children : Option<"inline-children", "c">,
1100    Group<1>, Required,
1101    Desc<"If true, inline all child values into summary string.">;
1102  def type_summary_add_omit_names : Option<"omit-names", "O">, Group<1>,
1103    Desc<"If true, omit value names in the summary display.">;
1104  def type_summary_add_summary_string : Option<"summary-string", "s">, Group<2>,
1105    Arg<"SummaryString">, Required,
1106    Desc<"Summary string used to display text and object contents.">;
1107  def type_summary_add_python_script : Option<"python-script", "o">, Group<3>,
1108    Arg<"PythonScript">,
1109    Desc<"Give a one-liner Python script as part of the command.">;
1110  def type_summary_add_python_function : Option<"python-function", "F">,
1111    Group<3>, Arg<"PythonFunction">,
1112    Desc<"Give the name of a Python function to use for this type.">;
1113  def type_summary_add_input_python : Option<"input-python", "P">, Group<3>,
1114    Desc<"Input Python code to use for this type manually.">;
1115  def type_summary_add_expand : Option<"expand", "e">, Groups<[2,3]>,
1116    Desc<"Expand aggregate data types to show children on separate lines.">;
1117  def type_summary_add_hide_empty : Option<"hide-empty", "h">, Groups<[2,3]>,
1118    Desc<"Do not expand aggregate data types with no children.">;
1119  def type_summary_add_name : Option<"name", "n">, Groups<[2,3]>, Arg<"Name">,
1120    Desc<"A name for this summary string.">;
1121}
1122
1123let Command = "type synth add" in {
1124  def type_synth_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1125    Desc<"If true, cascade through typedef chains.">;
1126  def type_synth_add_skip_pointers : Option<"skip-pointers", "p">,
1127    Desc<"Don't use this format for pointers-to-type objects.">;
1128  def type_synth_add_skip_references : Option<"skip-references", "r">,
1129    Desc<"Don't use this format for references-to-type objects.">;
1130  def type_synth_add_category : Option<"category", "w">, Arg<"Name">,
1131    Desc<"Add this to the given category instead of the default one.">;
1132  def type_synth_add_python_class : Option<"python-class", "l">, Group<2>,
1133    Arg<"PythonClass">,
1134    Desc<"Use this Python class to produce synthetic children.">;
1135  def type_synth_add_input_python : Option<"input-python", "P">, Group<3>,
1136    Desc<"Type Python code to generate a class that provides synthetic "
1137    "children.">;
1138  def type_synth_add_regex : Option<"regex", "x">,
1139    Desc<"Type names are actually regular expressions.">;
1140}
1141
1142let Command = "type format add" in {
1143  def type_format_add_category : Option<"category", "w">, Arg<"Name">,
1144    Desc<"Add this to the given category instead of the default one.">;
1145  def type_format_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1146    Desc<"If true, cascade through typedef chains.">;
1147  def type_format_add_skip_pointers : Option<"skip-pointers", "p">,
1148    Desc<"Don't use this format for pointers-to-type objects.">;
1149  def type_format_add_skip_references : Option<"skip-references", "r">,
1150    Desc<"Don't use this format for references-to-type objects.">;
1151  def type_format_add_regex : Option<"regex", "x">,
1152    Desc<"Type names are actually regular expressions.">;
1153  def type_format_add_type : Option<"type", "t">, Group<2>, Arg<"Name">,
1154    Desc<"Format variables as if they were of this type.">;
1155}
1156
1157let Command = "type formatter delete" in {
1158  def type_formatter_delete_all : Option<"all", "a">, Group<1>,
1159    Desc<"Delete from every category.">;
1160  def type_formatter_delete_category : Option<"category", "w">, Group<2>,
1161    Arg<"Name">, Desc<"Delete from given category.">;
1162  def type_formatter_delete_language : Option<"language", "l">, Group<3>,
1163    Arg<"Language">, Desc<"Delete from given language's category.">;
1164}
1165
1166let Command = "type formatter clear" in {
1167  def type_formatter_clear_all : Option<"all", "a">,
1168    Desc<"Clear every category.">;
1169}
1170
1171let Command = "type formatter list" in {
1172  def type_formatter_list_category_regex : Option<"category-regex", "w">,
1173    Group<1>, Arg<"Name">, Desc<"Only show categories matching this filter.">;
1174  def type_formatter_list_language : Option<"language", "l">, Group<2>,
1175    Arg<"Language">, Desc<"Only show the category for a specific language.">;
1176}
1177
1178let Command = "type category define" in {
1179  def type_category_define_enabled : Option<"enabled", "e">,
1180    Desc<"If specified, this category will be created enabled.">;
1181  def type_category_define_language : Option<"language", "l">, Arg<"Language">,
1182    Desc<"Specify the language that this category is supported for.">;
1183}
1184
1185let Command = "type category enable" in {
1186  def type_category_enable_language : Option<"language", "l">, Arg<"Language">,
1187    Desc<"Enable the category for this language.">;
1188}
1189
1190let Command = "type category disable" in {
1191  def type_category_disable_language : Option<"language", "l">, Arg<"Language">,
1192    Desc<"Enable the category for this language.">;
1193}
1194
1195let Command = "type filter add" in {
1196  def type_filter_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1197    Desc<"If true, cascade through typedef chains.">;
1198  def type_filter_add_skip_pointers : Option<"skip-pointers", "p">,
1199    Desc<"Don't use this format for pointers-to-type objects.">;
1200  def type_filter_add_skip_references : Option<"skip-references", "r">,
1201    Desc<"Don't use this format for references-to-type objects.">;
1202  def type_filter_add_category : Option<"category", "w">, Arg<"Name">,
1203    Desc<"Add this to the given category instead of the default one.">;
1204  def type_filter_add_child : Option<"child", "c">, Arg<"ExpressionPath">,
1205    Desc<"Include this expression path in the synthetic view.">;
1206  def type_filter_add_regex : Option<"regex", "x">,
1207    Desc<"Type names are actually regular expressions.">;
1208}
1209
1210let Command = "type lookup" in {
1211  def type_lookup_show_help : Option<"show-help", "h">,
1212    Desc<"Display available help for types">;
1213  def type_lookup_language : Option<"language", "l">, Arg<"Language">,
1214    Desc<"Which language's types should the search scope be">;
1215}
1216
1217let Command = "watchpoint list" in {
1218  def watchpoint_list_brief : Option<"brief", "b">, Group<1>, Desc<"Give a "
1219    "brief description of the watchpoint (no location info).">;
1220  def watchpoint_list_full : Option<"full", "f">, Group<2>, Desc<"Give a full "
1221    "description of the watchpoint and its locations.">;
1222  def watchpoint_list_verbose : Option<"verbose", "v">, Group<3>, Desc<"Explain "
1223    "everything we know about the watchpoint (for debugging debugger bugs).">;
1224}
1225
1226let Command = "watchpoint ignore" in {
1227  def watchpoint_ignore_ignore_count : Option<"ignore-count", "i">,
1228    Arg<"Count">, Required, Desc<"Set the number of times this watchpoint is"
1229    " skipped before stopping.">;
1230}
1231
1232let Command = "watchpoint modify" in {
1233  def watchpoint_modify_condition : Option<"condition", "c">, Arg<"Expression">,
1234    Desc<"The watchpoint stops only if this condition expression evaluates "
1235    "to true.">;
1236}
1237
1238let Command = "watchpoint command add" in {
1239  def watchpoint_command_add_one_liner : Option<"one-liner", "o">, Group<1>,
1240    Arg<"OneLiner">, Desc<"Specify a one-line watchpoint command inline. Be "
1241    "sure to surround it with quotes.">;
1242  def watchpoint_command_add_stop_on_error : Option<"stop-on-error", "e">,
1243    Arg<"Boolean">, Desc<"Specify whether watchpoint command execution should "
1244    "terminate on error.">;
1245  def watchpoint_command_add_script_type : Option<"script-type", "s">,
1246    EnumArg<"None", "ScriptOptionEnum()">, Desc<"Specify the language for the"
1247    " commands - if none is specified, the lldb command interpreter will be "
1248    "used.">;
1249  def watchpoint_command_add_python_function : Option<"python-function", "F">,
1250    Group<2>, Arg<"PythonFunction">, Desc<"Give the name of a Python function "
1251    "to run as command for this watchpoint. Be sure to give a module name if "
1252    "appropriate.">;
1253}
1254
1255let Command = "watchpoint delete" in {
1256  def watchpoint_delete_force : Option<"force", "f">, Group<1>,
1257    Desc<"Delete all watchpoints without querying for confirmation.">;
1258}
1259
1260let Command = "trace load" in {
1261  def trace_load_verbose : Option<"verbose", "v">, Group<1>,
1262    Desc<"Show verbose trace load logging for debugging the plug-in "
1263    "implementation.">;
1264}
1265
1266let Command = "trace dump" in {
1267  def trace_dump_verbose : Option<"verbose", "v">, Group<1>,
1268    Desc<"Show verbose trace information.">;
1269}
1270
1271let Command = "trace schema" in {
1272  def trace_schema_verbose : Option<"verbose", "v">, Group<1>,
1273    Desc<"Show verbose trace schema logging for debugging the plug-in.">;
1274}
1275