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.  The token 'current' resolves to the current thread's ID.">;
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 to make 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 to make 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,3]>,
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  def frame_recognizer_first_instruction_only : Option<"first-instruction-only", "f">, Arg<"Boolean">,
408    Desc<"If true, only apply this recognizer to frames whose PC currently points to the "
409    "first instruction of the specified function. If false, the recognizer "
410    "will always be applied, regardless of the current position within the specified function. The "
411    "implementor should keep in mind that some features, e.g. accessing function argument "
412    "values via $arg<N>, are not guaranteed to work reliably in this case, so extra care must "
413    "be taken to make the recognizer operate correctly. Defaults to true.">;
414}
415
416let Command = "history" in {
417  def history_count : Option<"count", "c">, Group<1>, Arg<"UnsignedInteger">,
418    Desc<"How many history commands to print.">;
419  def history_start_index : Option<"start-index", "s">, Group<1>,
420    Arg<"UnsignedInteger">, Desc<"Index at which to start printing history "
421    "commands (or end to mean tail mode).">;
422  def history_end_index : Option<"end-index", "e">, Group<1>,
423    Arg<"UnsignedInteger">,
424    Desc<"Index at which to stop printing history commands.">;
425  def history_clear : Option<"clear", "C">, Group<2>,
426    Desc<"Clears the current command history.">;
427}
428
429let Command = "log" in {
430  def log_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
431    Desc<"Set the destination file to log to.">;
432  def log_threadsafe : Option<"threadsafe", "t">, Group<1>,
433    Desc<"Enable thread safe logging to avoid interweaved log lines.">;
434  def log_verbose : Option<"verbose", "v">, Group<1>,
435    Desc<"Enable verbose logging.">;
436  def log_sequence : Option<"sequence", "s">, Group<1>,
437    Desc<"Prepend all log lines with an increasing integer sequence id.">;
438  def log_timestamp : Option<"timestamp", "T">, Group<1>,
439    Desc<"Prepend all log lines with a timestamp.">;
440  def log_pid_tid : Option<"pid-tid", "p">, Group<1>,
441    Desc<"Prepend all log lines with the process and thread ID that generates "
442    "the log line.">;
443  def log_thread_name : Option<"thread-name", "n">, Group<1>,
444    Desc<"Prepend all log lines with the thread name for the thread that "
445    "generates the log line.">;
446
447  def log_stack : Option<"stack", "S">, Group<1>,
448    Desc<"Append a stack backtrace to each log line.">;
449  def log_append : Option<"append", "a">, Group<1>,
450    Desc<"Append to the log file instead of overwriting.">;
451  def log_file_function : Option<"file-function", "F">, Group<1>,
452    Desc<"Prepend the names of files and function that generate the logs.">;
453}
454
455let Command = "reproducer dump" in {
456  def reproducer_provider : Option<"provider", "p">, Group<1>,
457    EnumArg<"None", "ReproducerProviderType()">,
458    Required, Desc<"The reproducer provider to dump.">;
459  def reproducer_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
460    Desc<"The reproducer path. If a reproducer is replayed and no path is "
461    "provided, that reproducer is dumped.">;
462}
463
464let Command = "reproducer verify" in {
465  def reproducer_verify_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
466    Desc<"The reproducer path. If a reproducer is replayed and no path is "
467    "provided, that reproducer is dumped.">;
468}
469
470let Command = "reproducer xcrash" in {
471  def reproducer_signal : Option<"signal", "s">, Group<1>,
472    EnumArg<"None", "ReproducerSignalType()">,
473    Required, Desc<"The signal to crash the debugger.">;
474}
475
476let Command = "memory read" in {
477  def memory_read_num_per_line : Option<"num-per-line", "l">, Group<1>,
478    Arg<"NumberPerLine">, Desc<"The number of items per line to display.">;
479  def memory_read_binary : Option<"binary", "b">, Group<2>,
480    Desc<"If true, memory will be saved as binary. If false, the memory is "
481    "saved save as an ASCII dump that uses the format, size, count and number "
482    "per line settings.">;
483  def memory_read_type : Option<"type", "t">, Groups<[3,4]>, Arg<"Name">,
484    Required, Desc<"The name of a type to view memory as.">;
485  def memory_read_language : Option<"language", "x">, Group<4>, Arg<"Language">,
486    Desc<"The language of the type to view memory as.">;
487  def memory_read_offset : Option<"offset", "E">, Group<3>, Arg<"Count">,
488    Desc<"How many elements of the specified type to skip before starting to "
489    "display data.">;
490  def memory_read_force : Option<"force", "r">, Groups<[1,2,3]>,
491    Desc<"Necessary if reading over target.max-memory-read-size bytes.">;
492}
493
494let Command = "memory find" in {
495  def memory_find_expression : Option<"expression", "e">, Group<1>,
496    Arg<"Expression">, Required,
497    Desc<"Evaluate an expression to obtain a byte pattern.">;
498  def memory_find_string : Option<"string", "s">, Group<2>, Arg<"Name">,
499    Required, Desc<"Use text to find a byte pattern.">;
500  def memory_find_count : Option<"count", "c">, Arg<"Count">,
501    Desc<"How many times to perform the search.">;
502  def memory_find_dump_offset : Option<"dump-offset", "o">, Arg<"Offset">,
503    Desc<"When dumping memory for a match, an offset from the match location to"
504    " start dumping from.">;
505}
506
507let Command = "memory write" in {
508  def memory_write_infile : Option<"infile", "i">, Group<1>, Arg<"Filename">,
509    Required, Desc<"Write memory using the contents of a file.">;
510  def memory_write_offset : Option<"offset", "o">, Group<1>, Arg<"Offset">,
511    Desc<"Start writing bytes from an offset within the input file.">;
512}
513
514let Command = "memory tag write" in {
515  def memory_write_end_addr : Option<"end-addr", "e">, Group<1>,
516  Arg<"AddressOrExpression">, Desc<
517    "Set tags for start address to end-addr, repeating tags as needed"
518    " to cover the range. (instead of calculating the range from the"
519    " number of tags given)">;
520}
521
522let Command = "register read" in {
523  def register_read_alternate : Option<"alternate", "A">,
524    Desc<"Display register names using the alternate register name if there "
525    "is one.">;
526  def register_read_set : Option<"set", "s">, Group<1>, Arg<"Index">,
527    Desc<"Specify which register sets to dump by index.">;
528  def register_read_all : Option<"all", "a">, Group<2>,
529    Desc<"Show all register sets.">;
530}
531
532let Command = "source" in {
533  def source_stop_on_error : Option<"stop-on-error", "e">, Arg<"Boolean">,
534    Desc<"If true, stop executing commands on error.">;
535  def source_stop_on_continue : Option<"stop-on-continue", "c">, Arg<"Boolean">,
536    Desc<"If true, stop executing commands on continue.">;
537  def source_silent_run : Option<"silent-run", "s">, Arg<"Boolean">,
538    Desc<"If true don't echo commands while executing.">;
539  def cmd_relative_to_command_file : Option<"relative-to-command-file", "C">,
540    Desc<"Resolve non-absolute paths relative to the location of the "
541    "current command file. This argument can only be used when the command is "
542    "being sourced from a file.">;
543}
544
545let Command = "alias" in {
546  def alias_help : Option<"help", "h">, Arg<"HelpText">,
547    Desc<"Help text for this command">;
548  def alias_long_help : Option<"long-help", "H">, Arg<"HelpText">,
549    Desc<"Long help text for this command">;
550}
551
552let Command = "regex" in {
553  def regex_help : Option<"help", "h">, Group<1>, Arg<"None">,
554    Desc<"The help text to display for this command.">;
555  def regex_syntax : Option<"syntax", "s">, Group<1>, Arg<"None">,
556    Desc<"A syntax string showing the typical usage syntax.">;
557}
558
559let Command = "permissions" in {
560  def permissions_permissions_value : Option<"permissions-value", "v">,
561    Arg<"PermissionsNumber">,
562    Desc<"Give out the numeric value for permissions (e.g. 757)">;
563  def permissions_permissions_string : Option<"permissions-string", "s">,
564    Arg<"PermissionsString">,
565    Desc<"Give out the string value for permissions (e.g. rwxr-xr--).">;
566  def permissions_user_read : Option<"user-read", "r">,
567    Desc<"Allow user to read.">;
568  def permissions_user_write : Option<"user-write", "w">,
569    Desc<"Allow user to write.">;
570  def permissions_user_exec : Option<"user-exec", "x">,
571    Desc<"Allow user to execute.">;
572  def permissions_group_read : Option<"group-read", "R">,
573    Desc<"Allow group to read.">;
574  def permissions_group_write : Option<"group-write", "W">,
575    Desc<"Allow group to write.">;
576  def permissions_group_exec : Option<"group-exec", "X">,
577    Desc<"Allow group to execute.">;
578  def permissions_world_read : Option<"world-read", "d">,
579    Desc<"Allow world to read.">;
580  def permissions_world_write : Option<"world-write", "t">,
581    Desc<"Allow world to write.">;
582  def permissions_world_exec : Option<"world-exec", "e">,
583    Desc<"Allow world to execute.">;
584}
585
586let Command = "platform fread" in {
587  def platform_fread_offset : Option<"offset", "o">, Group<1>, Arg<"Index">,
588    Desc<"Offset into the file at which to start reading.">;
589  def platform_fread_count : Option<"count", "c">, Group<1>, Arg<"Count">,
590    Desc<"Number of bytes to read from the file.">;
591}
592
593let Command = "platform fwrite" in {
594  def platform_fwrite_offset : Option<"offset", "o">, Group<1>, Arg<"Index">,
595    Desc<"Offset into the file at which to start reading.">;
596  def platform_fwrite_data : Option<"data", "d">, Group<1>, Arg<"Value">,
597    Desc<"Text to write to the file.">;
598}
599
600let Command = "platform process list" in {
601  def platform_process_list_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">,
602    Desc<"List the process info for a specific process ID.">;
603  def platform_process_list_name : Option<"name", "n">, Group<2>,
604    Arg<"ProcessName">, Required,
605    Desc<"Find processes with executable basenames that match a string.">;
606  def platform_process_list_ends_with : Option<"ends-with", "e">, Group<3>,
607  Arg<"ProcessName">, Required,
608    Desc<"Find processes with executable basenames that end with a string.">;
609  def platform_process_list_starts_with : Option<"starts-with", "s">, Group<4>,
610    Arg<"ProcessName">, Required,
611    Desc<"Find processes with executable basenames that start with a string.">;
612  def platform_process_list_contains : Option<"contains", "c">, Group<5>,
613    Arg<"ProcessName">, Required,
614    Desc<"Find processes with executable basenames that contain a string.">;
615  def platform_process_list_regex : Option<"regex", "r">, Group<6>,
616    Arg<"RegularExpression">, Required,
617    Desc<"Find processes with executable basenames that match a regular "
618    "expression.">;
619  def platform_process_list_parent : Option<"parent", "P">, GroupRange<2, 6>,
620    Arg<"Pid">, Desc<"Find processes that have a matching parent process ID.">;
621  def platform_process_list_uid : Option<"uid", "u">, GroupRange<2, 6>,
622    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
623    Desc<"Find processes that have a matching user ID.">;
624  def platform_process_list_euid : Option<"euid", "U">, GroupRange<2, 6>,
625    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
626    Desc<"Find processes that have a matching effective user ID.">;
627  def platform_process_list_gid : Option<"gid", "g">, GroupRange<2, 6>,
628    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
629    Desc<"Find processes that have a matching group ID.">;
630  def platform_process_list_egid : Option<"egid", "G">, GroupRange<2, 6>,
631    Arg<"UnsignedInteger">, Validator<"&posix_validator">,
632    Desc<"Find processes that have a matching effective group ID.">;
633  def platform_process_list_arch : Option<"arch", "a">, GroupRange<2, 6>,
634    Arg<"Architecture">,
635    Desc<"Find processes that have a matching architecture.">;
636  def platform_process_list_show_args : Option<"show-args", "A">,
637    GroupRange<1, 6>,
638    Desc<"Show process arguments instead of the process executable basename.">;
639  def platform_process_list_all_users: Option<"all-users", "x">,
640    GroupRange<1,6>,
641    Desc<"Show processes matching all user IDs.">;
642  def platform_process_list_verbose : Option<"verbose", "v">, GroupRange<1, 6>,
643    Desc<"Enable verbose output.">;
644}
645
646let Command = "platform process attach" in {
647  def platform_process_attach_plugin : Option<"plugin", "P">, Arg<"Plugin">,
648    Desc<"Name of the process plugin you want to use.">;
649  def platform_process_attach_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">,
650    Desc<"The process ID of an existing process to attach to.">;
651  def platform_process_attach_name : Option<"name", "n">, Group<2>,
652    Arg<"ProcessName">, Desc<"The name of the process to attach to.">;
653  def platform_process_attach_waitfor : Option<"waitfor", "w">, Group<2>,
654    Desc<"Wait for the process with <process-name> to launch.">;
655}
656
657let Command = "platform shell" in {
658  def platform_shell_host : Option<"host", "h">,
659    Desc<"Run the commands on the host shell when enabled.">;
660  def platform_shell_timeout : Option<"timeout", "t">, Arg<"Value">,
661    Desc<"Seconds to wait for the remote host to finish running the command.">;
662  def platform_shell_interpreter : Option<"shell", "s">, Arg<"Path">,
663    Desc<"Shell interpreter path. This is the binary used to run the command.">;
664}
665
666let Command = "process launch" in {
667  def process_launch_stop_at_entry : Option<"stop-at-entry", "s">,
668    Desc<"Stop at the entry point of the program when launching a process.">;
669  def process_launch_disable_aslr : Option<"disable-aslr", "A">, Arg<"Boolean">,
670    Desc<"Set whether to disable address space layout randomization when launching a process.">;
671  def process_launch_plugin : Option<"plugin", "P">, Arg<"Plugin">,
672    Desc<"Name of the process plugin you want to use.">;
673  def process_launch_working_dir : Option<"working-dir", "w">, Arg<"DirectoryName">,
674    Desc<"Set the current working directory to <path> when running the inferior.">;
675  def process_launch_arch : Option<"arch", "a">, Arg<"Architecture">,
676    Desc<"Set the architecture for the process to launch when ambiguous.">;
677  def process_launch_environment : Option<"environment", "E">,
678    Arg<"None">, Desc<"Specify an environment variable name/value string "
679    "(--environment NAME=VALUE). Can be specified multiple times for subsequent "
680    "environment entries.">;
681  def process_launch_shell : Option<"shell", "c">, GroupRange<1,3>,
682    OptionalArg<"Filename">, Desc<"Run the process in a shell (not supported on all platforms).">;
683  def process_launch_stdin : Option<"stdin", "i">, Group<1>,
684    Arg<"Filename">, Desc<"Redirect stdin for the process to <filename>.">;
685  def process_launch_stdout : Option<"stdout", "o">, Group<1>,
686    Arg<"Filename">, Desc<"Redirect stdout for the process to <filename>.">;
687  def process_launch_stderr : Option<"stderr", "e">, Group<1>,
688    Arg<"Filename">, Desc<"Redirect stderr for the process to <filename>.">;
689  def process_launch_tty : Option<"tty", "t">, Group<2>,
690    Desc<"Start the process in a terminal (not supported on all platforms).">;
691  def process_launch_no_stdio : Option<"no-stdio", "n">, Group<3>,
692    Desc<"Do not set up for terminal I/O to go to running process.">;
693  def process_launch_shell_expand_args : Option<"shell-expand-args", "X">, Group<4>,
694    Arg<"Boolean">, Desc<"Set whether to shell expand arguments to the process when launching.">;
695}
696
697let Command = "process attach" in {
698  def process_attach_continue : Option<"continue", "c">,
699    Desc<"Immediately continue the process once attached.">;
700  def process_attach_plugin : Option<"plugin", "P">, Arg<"Plugin">,
701    Desc<"Name of the process plugin you want to use.">;
702  def process_attach_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">,
703    Desc<"The process ID of an existing process to attach to.">;
704  def process_attach_name : Option<"name", "n">, Group<2>, Arg<"ProcessName">,
705    Desc<"The name of the process to attach to.">;
706  def process_attach_include_existing : Option<"include-existing", "i">,
707    Group<2>, Desc<"Include existing processes when doing attach -w.">;
708  def process_attach_waitfor : Option<"waitfor", "w">, Group<2>,
709    Desc<"Wait for the process with <process-name> to launch.">;
710}
711
712let Command = "process continue" in {
713  def process_continue_ignore_count : Option<"ignore-count", "i">,
714    Arg<"UnsignedInteger">, Desc<"Ignore <N> crossings of the breakpoint (if it"
715    " exists) for the currently selected thread.">;
716}
717
718let Command = "process detach" in {
719  def process_detach_keep_stopped : Option<"keep-stopped", "s">, Group<1>,
720    Arg<"Boolean">, Desc<"Whether or not the process should be kept stopped on"
721    " detach (if possible).">;
722}
723
724let Command = "process connect" in {
725  def process_connect_plugin : Option<"plugin", "p">, Arg<"Plugin">,
726    Desc<"Name of the process plugin you want to use.">;
727}
728
729let Command = "process load" in {
730  def process_load_install : Option<"install", "i">, OptionalArg<"Path">,
731    Desc<"Install the shared library to the target. If specified without an "
732    "argument then the library will installed in the current working "
733    "directory.">;
734}
735
736let Command = "process handle" in {
737  def process_handle_stop : Option<"stop", "s">, Group<1>, Arg<"Boolean">,
738    Desc<"Whether or not the process should be stopped if the signal is "
739    "received.">;
740  def process_handle_notify : Option<"notify", "n">, Group<1>, Arg<"Boolean">,
741    Desc<"Whether or not the debugger should notify the user if the signal is "
742    "received.">;
743  def process_handle_pass : Option<"pass", "p">, Group<1>, Arg<"Boolean">,
744    Desc<"Whether or not the signal should be passed to the process.">;
745}
746
747let Command = "process status" in {
748  def process_status_verbose : Option<"verbose", "v">, Group<1>,
749    Desc<"Show verbose process status including extended crash information.">;
750}
751
752let Command = "process save_core" in {
753  def process_save_core_style : Option<"style", "s">, Group<1>,
754    EnumArg<"SaveCoreStyle", "SaveCoreStyles()">, Desc<"Request a specific style "
755    "of corefile to be saved.">;
756  def process_save_core_plugin_name : Option<"plugin-name", "p">,
757    OptionalArg<"Plugin">, Desc<"Specify a plugin name to create the core file."
758    "This allows core files to be saved in different formats.">;
759}
760
761let Command = "process trace save" in {
762  def process_trace_save_directory: Option<"directory", "d">,
763    Group<1>,
764    Arg<"Value">, Required,
765    Desc<"The directory where the trace will be saved."
766        "It will be created if it does not exist.">;
767}
768
769let Command = "script import" in {
770  def script_import_allow_reload : Option<"allow-reload", "r">, Group<1>,
771    Desc<"Allow the script to be loaded even if it was already loaded before. "
772    "This argument exists for backwards compatibility, but reloading is always "
773    "allowed, whether you specify it or not.">;
774  def relative_to_command_file : Option<"relative-to-command-file", "c">,
775    Group<1>, Desc<"Resolve non-absolute paths relative to the location of the "
776    "current command file. This argument can only be used when the command is "
777    "being sourced from a file.">;
778  def silent : Option<"silent", "s">, Group<1>,
779    Desc<"If true don't print any script output while importing.">;
780}
781
782let Command = "script add" in {
783  def script_add_function : Option<"function", "f">, Group<1>,
784    Arg<"PythonFunction">,
785    Desc<"Name of the Python function to bind to this command name.">;
786  def script_add_class : Option<"class", "c">, Group<2>, Arg<"PythonClass">,
787  Desc<"Name of the Python class to bind to this command name.">;
788  def script_add_help : Option<"help", "h">, Group<1>, Arg<"HelpText">,
789  Desc<"The help text to display for this command.">;
790  def script_add_overwrite : Option<"overwrite", "o">, Groups<[1,2]>,
791  Desc<"Overwrite an existing command at this node.">;
792  def script_add_synchronicity : Option<"synchronicity", "s">,
793    EnumArg<"ScriptedCommandSynchronicity", "ScriptSynchroType()">,
794    Desc<"Set the synchronicity of this command's executions with regard to "
795    "LLDB event system.">;
796}
797
798let Command = "container add" in {
799  def container_add_help : Option<"help", "h">, Arg<"HelpText">,
800    Desc<"Help text for this command">;
801  def container_add_long_help : Option<"long-help", "H">, Arg<"HelpText">,
802    Desc<"Long help text for this command">;
803  def container_add_overwrite : Option<"overwrite", "o">, Group<1>,
804  Desc<"Overwrite an existing command at this node.">;
805}
806
807let Command = "script" in {
808  def script_language : Option<"language", "l">,
809    EnumArg<"ScriptLang", "ScriptOptionEnum()">, Desc<"Specify the scripting "
810    " language. If none is specific the default scripting language is used.">;
811}
812
813let Command = "source info" in {
814  def source_info_count : Option<"count", "c">, Arg<"Count">,
815    Desc<"The number of line entries to display.">;
816  def source_info_shlib : Option<"shlib", "s">, Groups<[1,2]>, Arg<"ShlibName">,
817    Completion<"Module">, Desc<"Look up the source in the given module or "
818    "shared library (can be specified more than once).">;
819  def source_info_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
820    Completion<"SourceFile">, Desc<"The file from which to display source.">;
821  def source_info_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
822    Desc<"The line number at which to start the displaying lines.">;
823  def source_info_end_line : Option<"end-line", "e">, Group<1>, Arg<"LineNum">,
824    Desc<"The line number at which to stop displaying lines.">;
825  def source_info_name : Option<"name", "n">, Group<2>, Arg<"Symbol">,
826    Completion<"Symbol">,
827    Desc<"The name of a function whose source to display.">;
828  def source_info_address : Option<"address", "a">, Group<3>,
829    Arg<"AddressOrExpression">, Desc<"Lookup the address and display the source"
830    " information for the corresponding file and line.">;
831}
832
833let Command = "source list" in {
834  def source_list_count : Option<"count", "c">, Arg<"Count">,
835    Desc<"The number of source lines to display.">;
836  def source_list_shlib : Option<"shlib", "s">, Groups<[1,2,5]>, Arg<"ShlibName">,
837    Completion<"Module">,
838    Desc<"Look up the source file in the given shared library.">;
839  def source_list_show_breakpoints : Option<"show-breakpoints", "b">,
840    Desc<"Show the line table locations from the debug information that "
841    "indicate valid places to set source level breakpoints.">;
842  def source_list_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
843    Completion<"SourceFile">, Desc<"The file from which to display source.">;
844  def source_list_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
845    Desc<"The line number at which to start the display source.">;
846  def source_list_name : Option<"name", "n">, Group<2>, Arg<"Symbol">,
847    Completion<"Symbol">,
848    Desc<"The name of a function whose source to display.">;
849  def source_list_address : Option<"address", "a">, Group<3>,
850    Arg<"AddressOrExpression">, Desc<"Lookup the address and display the source"
851    " information for the corresponding file and line.">;
852  def source_list_reverse : Option<"reverse", "r">, Group<4>, Desc<"Reverse the"
853    " listing to look backwards from the last displayed block of source.">;
854  def source_list_file_colon_line : Option<"joint-specifier", "y">, Group<5>,
855    Arg<"FileLineColumn">, Completion<"SourceFile">,
856    Desc<"A specifier in the form filename:line[:column] from which to display"
857         " source.">;
858}
859
860let Command = "target dependents" in {
861  def dependents_no_dependents : Option<"no-dependents", "d">, Group<1>,
862    OptionalEnumArg<"Value", "OptionEnumValues(g_dependents_enumaration)">,
863    Desc<"Whether or not to load dependents when creating a target. If the "
864         "option is not specified, the value is implicitly 'default'. If the "
865         "option is specified but without a value, the value is implicitly "
866         "'true'.">;
867}
868
869let Command = "target modules dump" in {
870  def target_modules_dump_verbose : Option<"verbose", "v">,
871    Desc<"Enable verbose dump.">;
872}
873
874let Command = "target modules list" in {
875  def target_modules_list_address : Option<"address", "a">, Group<1>,
876    Arg<"AddressOrExpression">, Desc<"Display the image at this address.">;
877  def target_modules_list_arch : Option<"arch", "A">, Group<1>,
878    OptionalArg<"Width">, Desc<"Display the architecture when listing images.">;
879  def target_modules_list_triple : Option<"triple", "t">, Group<1>,
880    OptionalArg<"Width">, Desc<"Display the triple when listing images.">;
881  def target_modules_list_header : Option<"header", "h">, Group<1>,
882    Desc<"Display the image base address as a load address if debugging, a file"
883    " address otherwise.">;
884  def target_modules_list_offset : Option<"offset", "o">, Group<1>,
885    Desc<"Display the image load address offset from the base file address "
886    "(the slide amount).">;
887  def target_modules_list_uuid : Option<"uuid", "u">, Group<1>,
888    Desc<"Display the UUID when listing images.">;
889  def target_modules_list_fullpath : Option<"fullpath", "f">, Group<1>,
890    OptionalArg<"Width">,
891    Desc<"Display the fullpath to the image object file.">;
892  def target_modules_list_directory : Option<"directory", "d">, Group<1>,
893    OptionalArg<"Width">, Desc<"Display the directory with optional width for "
894    "the image object file.">;
895  def target_modules_list_basename : Option<"basename", "b">, Group<1>,
896    OptionalArg<"Width">, Desc<"Display the basename with optional width for "
897    "the image object file.">;
898  def target_modules_list_symfile : Option<"symfile", "s">, Group<1>,
899    OptionalArg<"Width">, Desc<"Display the fullpath to the image symbol file "
900    "with optional width.">;
901  def target_modules_list_symfile_unique : Option<"symfile-unique", "S">,
902    Group<1>, OptionalArg<"Width">, Desc<"Display the symbol file with optional"
903    " width only if it is different from the executable object file.">;
904  def target_modules_list_mod_time : Option<"mod-time", "m">, Group<1>,
905    OptionalArg<"Width">, Desc<"Display the modification time with optional "
906    "width of the module.">;
907  def target_modules_list_ref_count : Option<"ref-count", "r">, Group<1>,
908    OptionalArg<"Width">, Desc<"Display the reference count if the module is "
909    "still in the shared module cache.">;
910  def target_modules_list_pointer : Option<"pointer", "p">, Group<1>,
911    OptionalArg<"None">, Desc<"Display the module pointer.">;
912  def target_modules_list_global : Option<"global", "g">, Group<1>,
913    Desc<"Display the modules from the global module list, not just the "
914    "current target.">;
915}
916
917let Command = "target modules show unwind" in {
918  def target_modules_show_unwind_name : Option<"name", "n">, Group<1>,
919    Arg<"FunctionName">,
920    Desc<"Show unwind instructions for a function or symbol name.">;
921  def target_modules_show_unwind_address : Option<"address", "a">, Group<2>,
922    Arg<"AddressOrExpression">, Desc<"Show unwind instructions for a function "
923    "or symbol containing an address">;
924}
925
926let Command = "target modules lookup" in {
927  def target_modules_lookup_address : Option<"address", "a">, Group<1>,
928    Arg<"AddressOrExpression">, Required, Desc<"Lookup an address in one or "
929    "more target modules.">;
930  def target_modules_lookup_offset : Option<"offset", "o">, Group<1>,
931    Arg<"Offset">, Desc<"When looking up an address subtract <offset> from any "
932    "addresses before doing the lookup.">;
933  // FIXME: re-enable regex for types when the LookupTypeInModule actually uses
934  // the regex option by adding to group 6.
935  def target_modules_lookup_regex : Option<"regex", "r">, Groups<[2,4,5]>,
936    Desc<"The <name> argument for name lookups are regular expressions.">;
937  def target_modules_lookup_symbol : Option<"symbol", "s">, Group<2>,
938    Arg<"Symbol">, Required, Desc<"Lookup a symbol by name in the symbol tables"
939    " in one or more target modules.">;
940  def target_modules_lookup_file : Option<"file", "f">, Group<3>,
941    Arg<"Filename">, Required, Desc<"Lookup a file by fullpath or basename in "
942    "one or more target modules.">;
943  def target_modules_lookup_line : Option<"line", "l">, Group<3>,
944    Arg<"LineNum">, Desc<"Lookup a line number in a file (must be used in "
945    "conjunction with --file).">;
946  def target_modules_lookup_no_inlines : Option<"no-inlines", "i">,
947    GroupRange<3,5>,
948    Desc<"Ignore inline entries (must be used in conjunction with --file or "
949    "--function).">;
950  def target_modules_lookup_function : Option<"function", "F">, Group<4>,
951    Arg<"FunctionName">, Required, Desc<"Lookup a function by name in the debug"
952    " symbols in one or more target modules.">;
953  def target_modules_lookup_name : Option<"name", "n">, Group<5>,
954    Arg<"FunctionOrSymbol">, Required, Desc<"Lookup a function or symbol by "
955    "name in one or more target modules.">;
956  def target_modules_lookup_type : Option<"type", "t">, Group<6>, Arg<"Name">,
957    Required, Desc<"Lookup a type by name in the debug symbols in one or more "
958    "target modules.">;
959  def target_modules_lookup_verbose : Option<"verbose", "v">,
960    Desc<"Enable verbose lookup information.">;
961  def target_modules_lookup_all : Option<"all", "A">, Desc<"Print all matches, "
962    "not just the best match, if a best match is available.">;
963}
964
965let Command = "target stop hook add" in {
966  def target_stop_hook_add_one_liner : Option<"one-liner", "o">, GroupRange<1,3>,
967    Arg<"OneLiner">, Desc<"Add a command for the stop hook.  Can be specified "
968    "more than once, and commands will be run in the order they appear.">;
969  def target_stop_hook_add_shlib : Option<"shlib", "s">, Arg<"ShlibName">,
970    Completion<"Module">,
971    Desc<"Set the module within which the stop-hook is to be run.">;
972  def target_stop_hook_add_thread_index : Option<"thread-index", "x">,
973    Arg<"ThreadIndex">, Desc<"The stop hook is run only for the thread whose "
974    "index matches this argument.">;
975  def target_stop_hook_add_thread_id : Option<"thread-id", "t">,
976    Arg<"ThreadID">, Desc<"The stop hook is run only for the thread whose TID "
977    "matches this argument.">;
978  def target_stop_hook_add_thread_name : Option<"thread-name", "T">,
979    Arg<"ThreadName">, Desc<"The stop hook is run only for the thread whose "
980    "thread name matches this argument.">;
981  def target_stop_hook_add_queue_name : Option<"queue-name", "q">,
982    Arg<"QueueName">, Desc<"The stop hook is run only for threads in the queue "
983    "whose name is given by this argument.">;
984  def target_stop_hook_add_file : Option<"file", "f">, Groups<[1,4]>,
985    Arg<"Filename">, Desc<"Specify the source file within which the stop-hook "
986    "is to be run.">, Completion<"SourceFile">;
987  def target_stop_hook_add_start_line : Option<"start-line", "l">, Groups<[1,4]>,
988    Arg<"LineNum">, Desc<"Set the start of the line range for which the "
989    "stop-hook is to be run.">;
990  def target_stop_hook_add_end_line : Option<"end-line", "e">, Groups<[1,4]>,
991    Arg<"LineNum">, Desc<"Set the end of the line range for which the stop-hook"
992    " is to be run.">;
993  def target_stop_hook_add_classname : Option<"classname", "c">, Groups<[2,5]>,
994    Arg<"ClassName">,
995    Desc<"Specify the class within which the stop-hook is to be run.">;
996  def target_stop_hook_add_name : Option<"name", "n">, Groups<[3,6]>,
997    Arg<"FunctionName">, Desc<"Set the function name within which the stop hook"
998    " will be run.">, Completion<"Symbol">;
999  def target_stop_hook_add_auto_continue : Option<"auto-continue", "G">,
1000    Arg<"Boolean">, Desc<"The breakpoint will auto-continue after running its"
1001    " commands.">;
1002}
1003
1004let Command = "thread backtrace" in {
1005  def thread_backtrace_count : Option<"count", "c">, Group<1>, Arg<"Count">,
1006  Desc<"How many frames to display (-1 for all)">;
1007  def thread_backtrace_start : Option<"start", "s">, Group<1>,
1008  Arg<"FrameIndex">, Desc<"Frame in which to start the backtrace">;
1009  def thread_backtrace_extended : Option<"extended", "e">, Group<1>,
1010  Arg<"Boolean">, Desc<"Show the extended backtrace, if available">;
1011}
1012
1013let Command = "thread step scope" in {
1014  def thread_step_scope_step_in_avoids_no_debug :
1015    Option<"step-in-avoids-no-debug", "a">, Group<1>, Arg<"Boolean">,
1016    Desc<"A boolean value that sets whether stepping into functions will step "
1017    "over functions with no debug information.">;
1018  def thread_step_scope_step_out_avoids_no_debug :
1019    Option<"step-out-avoids-no-debug", "A">, Group<1>, Arg<"Boolean">,
1020    Desc<"A boolean value, if true stepping out of functions will continue to"
1021    " step out till it hits a function with debug information.">;
1022  def thread_step_scope_count : Option<"count", "c">, Group<1>, Arg<"Count">,
1023    Desc<"How many times to perform the stepping operation - currently only "
1024    "supported for step-inst and next-inst.">;
1025  def thread_step_scope_end_linenumber : Option<"end-linenumber", "e">,
1026    Group<1>, Arg<"LineNum">, Desc<"The line at which to stop stepping - "
1027      "defaults to the next line and only supported for step-in and step-over."
1028      "  You can also pass the string 'block' to step to the end of the current"
1029      " block.  This is particularly use  in conjunction with --step-target to"
1030      " step through a complex calling sequence.">;
1031  def thread_step_scope_run_mode : Option<"run-mode", "m">, Group<1>,
1032    EnumArg<"RunMode", "TriRunningModes()">, Desc<"Determine how to run other "
1033    "threads while stepping the current thread.">;
1034  def thread_step_scope_step_over_regexp : Option<"step-over-regexp", "r">,
1035    Group<1>, Arg<"RegularExpression">, Desc<"A regular expression that defines "
1036    "function names to not to stop at when stepping in.">;
1037  def thread_step_scope_step_in_target : Option<"step-in-target", "t">,
1038    Group<1>, Arg<"FunctionName">, Desc<"The name of the directly called "
1039    "function step in should stop at when stepping into.">;
1040}
1041
1042let Command = "thread until" in {
1043  def thread_until_frame : Option<"frame", "f">, Group<1>, Arg<"FrameIndex">,
1044    Desc<"Frame index for until operation - defaults to 0">;
1045  def thread_until_thread : Option<"thread", "t">, Group<1>, Arg<"ThreadIndex">,
1046    Desc<"Thread index for the thread for until operation">;
1047  def thread_until_run_mode : Option<"run-mode", "m">, Group<1>,
1048    EnumArg<"RunMode", "DuoRunningModes()">, Desc<"Determine how to run other "
1049    "threads while stepping this one">;
1050  def thread_until_address : Option<"address", "a">, Group<1>,
1051    Arg<"AddressOrExpression">, Desc<"Run until we reach the specified address, "
1052    "or leave the function - can be specified multiple times.">;
1053}
1054
1055let Command = "thread info" in {
1056  def thread_info_json : Option<"json", "j">, Desc<"Display the thread info in"
1057    " JSON format.">;
1058  def thread_info_stop_info : Option<"stop-info", "s">, Desc<"Display the "
1059    "extended stop info in JSON format.">;
1060}
1061
1062let Command = "thread return" in {
1063  def thread_return_from_expression : Option<"from-expression", "x">,
1064    Desc<"Return from the innermost expression evaluation.">;
1065}
1066
1067let Command = "thread jump" in {
1068  def thread_jump_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
1069    Completion<"SourceFile">, Desc<"Specifies the source file to jump to.">;
1070  def thread_jump_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
1071    Required, Desc<"Specifies the line number to jump to.">;
1072  def thread_jump_by : Option<"by", "b">, Group<2>, Arg<"Offset">, Required,
1073    Desc<"Jumps by a relative line offset from the current line.">;
1074  def thread_jump_address : Option<"address", "a">, Group<3>,
1075    Arg<"AddressOrExpression">, Required, Desc<"Jumps to a specific address.">;
1076  def thread_jump_force : Option<"force", "r">, Groups<[1,2,3]>,
1077    Desc<"Allows the PC to leave the current function.">;
1078}
1079
1080let Command = "thread plan list" in {
1081  def thread_plan_list_verbose : Option<"verbose", "v">, Group<1>,
1082    Desc<"Display more information about the thread plans">;
1083  def thread_plan_list_internal : Option<"internal", "i">, Group<1>,
1084    Desc<"Display internal as well as user thread plans">;
1085  def thread_plan_list_thread_id : Option<"thread-id", "t">, Group<1>,
1086    Arg<"ThreadID">, Desc<"List the thread plans for this TID, can be "
1087    "specified more than once.">;
1088  def thread_plan_list_unreported : Option<"unreported", "u">, Group<1>,
1089    Desc<"Display thread plans for unreported threads">;
1090}
1091
1092let Command = "thread trace dump instructions" in {
1093  def thread_trace_dump_instructions_forwards: Option<"forwards", "f">, Group<1>,
1094    Desc<"If specified, the trace is traversed forwards chronologically "
1095    "starting at the oldest instruction. Otherwise, it starts at the most "
1096    "recent one and the traversal is backwards.">;
1097  def thread_trace_dump_instructions_count : Option<"count", "c">, Group<1>,
1098    Arg<"Count">,
1099    Desc<"The number of instructions to display starting at the most recent "
1100    "instruction, or the oldest if --forwards is provided.">;
1101  def thread_trace_dump_instructions_skip: Option<"skip", "s">,
1102    Group<1>,
1103    Arg<"Index">,
1104    Desc<"How many instruction to skip from the end of the trace to start "
1105    "dumping instructions, or from the beginning if --forwards is provided">;
1106  def thread_trace_dump_instructions_raw : Option<"raw", "r">,
1107    Group<1>,
1108    Desc<"Dump only instruction address without disassembly nor symbol information.">;
1109  def thread_trace_dump_instructions_show_tsc : Option<"tsc", "t">,
1110    Group<1>,
1111    Desc<"For each instruction, print the corresponding timestamp counter if available.">;
1112}
1113
1114let Command = "thread trace dump info" in {
1115  def thread_trace_dump_info_verbose : Option<"verbose", "v">, Group<1>,
1116    Desc<"show verbose thread trace dump info">;
1117}
1118
1119let Command = "type summary add" in {
1120  def type_summary_add_category : Option<"category", "w">, Arg<"Name">,
1121    Desc<"Add this to the given category instead of the default one.">;
1122  def type_summary_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1123    Desc<"If true, cascade through typedef chains.">;
1124  def type_summary_add_no_value : Option<"no-value", "v">,
1125    Desc<"Don't show the value, just show the summary, for this type.">;
1126  def type_summary_add_skip_pointers : Option<"skip-pointers", "p">,
1127    Desc<"Don't use this format for pointers-to-type objects.">;
1128  def type_summary_add_skip_references : Option<"skip-references", "r">,
1129    Desc<"Don't use this format for references-to-type objects.">;
1130  def type_summary_add_regex : Option<"regex", "x">,
1131    Desc<"Type names are actually regular expressions.">;
1132  def type_summary_add_inline_children : Option<"inline-children", "c">,
1133    Group<1>, Required,
1134    Desc<"If true, inline all child values into summary string.">;
1135  def type_summary_add_omit_names : Option<"omit-names", "O">, Group<1>,
1136    Desc<"If true, omit value names in the summary display.">;
1137  def type_summary_add_summary_string : Option<"summary-string", "s">, Group<2>,
1138    Arg<"SummaryString">, Required,
1139    Desc<"Summary string used to display text and object contents.">;
1140  def type_summary_add_python_script : Option<"python-script", "o">, Group<3>,
1141    Arg<"PythonScript">,
1142    Desc<"Give a one-liner Python script as part of the command.">;
1143  def type_summary_add_python_function : Option<"python-function", "F">,
1144    Group<3>, Arg<"PythonFunction">,
1145    Desc<"Give the name of a Python function to use for this type.">;
1146  def type_summary_add_input_python : Option<"input-python", "P">, Group<3>,
1147    Desc<"Input Python code to use for this type manually.">;
1148  def type_summary_add_expand : Option<"expand", "e">, Groups<[2,3]>,
1149    Desc<"Expand aggregate data types to show children on separate lines.">;
1150  def type_summary_add_hide_empty : Option<"hide-empty", "h">, Groups<[2,3]>,
1151    Desc<"Do not expand aggregate data types with no children.">;
1152  def type_summary_add_name : Option<"name", "n">, Groups<[2,3]>, Arg<"Name">,
1153    Desc<"A name for this summary string.">;
1154}
1155
1156let Command = "type synth add" in {
1157  def type_synth_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1158    Desc<"If true, cascade through typedef chains.">;
1159  def type_synth_add_skip_pointers : Option<"skip-pointers", "p">,
1160    Desc<"Don't use this format for pointers-to-type objects.">;
1161  def type_synth_add_skip_references : Option<"skip-references", "r">,
1162    Desc<"Don't use this format for references-to-type objects.">;
1163  def type_synth_add_category : Option<"category", "w">, Arg<"Name">,
1164    Desc<"Add this to the given category instead of the default one.">;
1165  def type_synth_add_python_class : Option<"python-class", "l">, Group<2>,
1166    Arg<"PythonClass">,
1167    Desc<"Use this Python class to produce synthetic children.">;
1168  def type_synth_add_input_python : Option<"input-python", "P">, Group<3>,
1169    Desc<"Type Python code to generate a class that provides synthetic "
1170    "children.">;
1171  def type_synth_add_regex : Option<"regex", "x">,
1172    Desc<"Type names are actually regular expressions.">;
1173}
1174
1175let Command = "type format add" in {
1176  def type_format_add_category : Option<"category", "w">, Arg<"Name">,
1177    Desc<"Add this to the given category instead of the default one.">;
1178  def type_format_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1179    Desc<"If true, cascade through typedef chains.">;
1180  def type_format_add_skip_pointers : Option<"skip-pointers", "p">,
1181    Desc<"Don't use this format for pointers-to-type objects.">;
1182  def type_format_add_skip_references : Option<"skip-references", "r">,
1183    Desc<"Don't use this format for references-to-type objects.">;
1184  def type_format_add_regex : Option<"regex", "x">,
1185    Desc<"Type names are actually regular expressions.">;
1186  def type_format_add_type : Option<"type", "t">, Group<2>, Arg<"Name">,
1187    Desc<"Format variables as if they were of this type.">;
1188}
1189
1190let Command = "type formatter delete" in {
1191  def type_formatter_delete_all : Option<"all", "a">, Group<1>,
1192    Desc<"Delete from every category.">;
1193  def type_formatter_delete_category : Option<"category", "w">, Group<2>,
1194    Arg<"Name">, Desc<"Delete from given category.">;
1195  def type_formatter_delete_language : Option<"language", "l">, Group<3>,
1196    Arg<"Language">, Desc<"Delete from given language's category.">;
1197}
1198
1199let Command = "type formatter clear" in {
1200  def type_formatter_clear_all : Option<"all", "a">,
1201    Desc<"Clear every category.">;
1202}
1203
1204let Command = "type formatter list" in {
1205  def type_formatter_list_category_regex : Option<"category-regex", "w">,
1206    Group<1>, Arg<"Name">, Desc<"Only show categories matching this filter.">;
1207  def type_formatter_list_language : Option<"language", "l">, Group<2>,
1208    Arg<"Language">, Desc<"Only show the category for a specific language.">;
1209}
1210
1211let Command = "type category define" in {
1212  def type_category_define_enabled : Option<"enabled", "e">,
1213    Desc<"If specified, this category will be created enabled.">;
1214  def type_category_define_language : Option<"language", "l">, Arg<"Language">,
1215    Desc<"Specify the language that this category is supported for.">;
1216}
1217
1218let Command = "type category enable" in {
1219  def type_category_enable_language : Option<"language", "l">, Arg<"Language">,
1220    Desc<"Enable the category for this language.">;
1221}
1222
1223let Command = "type category disable" in {
1224  def type_category_disable_language : Option<"language", "l">, Arg<"Language">,
1225    Desc<"Enable the category for this language.">;
1226}
1227
1228let Command = "type filter add" in {
1229  def type_filter_add_cascade : Option<"cascade", "C">, Arg<"Boolean">,
1230    Desc<"If true, cascade through typedef chains.">;
1231  def type_filter_add_skip_pointers : Option<"skip-pointers", "p">,
1232    Desc<"Don't use this format for pointers-to-type objects.">;
1233  def type_filter_add_skip_references : Option<"skip-references", "r">,
1234    Desc<"Don't use this format for references-to-type objects.">;
1235  def type_filter_add_category : Option<"category", "w">, Arg<"Name">,
1236    Desc<"Add this to the given category instead of the default one.">;
1237  def type_filter_add_child : Option<"child", "c">, Arg<"ExpressionPath">,
1238    Desc<"Include this expression path in the synthetic view.">;
1239  def type_filter_add_regex : Option<"regex", "x">,
1240    Desc<"Type names are actually regular expressions.">;
1241}
1242
1243let Command = "type lookup" in {
1244  def type_lookup_show_help : Option<"show-help", "h">,
1245    Desc<"Display available help for types">;
1246  def type_lookup_language : Option<"language", "l">, Arg<"Language">,
1247    Desc<"Which language's types should the search scope be">;
1248}
1249
1250let Command = "watchpoint list" in {
1251  def watchpoint_list_brief : Option<"brief", "b">, Group<1>, Desc<"Give a "
1252    "brief description of the watchpoint (no location info).">;
1253  def watchpoint_list_full : Option<"full", "f">, Group<2>, Desc<"Give a full "
1254    "description of the watchpoint and its locations.">;
1255  def watchpoint_list_verbose : Option<"verbose", "v">, Group<3>, Desc<"Explain "
1256    "everything we know about the watchpoint (for debugging debugger bugs).">;
1257}
1258
1259let Command = "watchpoint ignore" in {
1260  def watchpoint_ignore_ignore_count : Option<"ignore-count", "i">,
1261    Arg<"Count">, Required, Desc<"Set the number of times this watchpoint is"
1262    " skipped before stopping.">;
1263}
1264
1265let Command = "watchpoint modify" in {
1266  def watchpoint_modify_condition : Option<"condition", "c">, Arg<"Expression">,
1267    Desc<"The watchpoint stops only if this condition expression evaluates "
1268    "to true.">;
1269}
1270
1271let Command = "watchpoint command add" in {
1272  def watchpoint_command_add_one_liner : Option<"one-liner", "o">, Group<1>,
1273    Arg<"OneLiner">, Desc<"Specify a one-line watchpoint command inline. Be "
1274    "sure to surround it with quotes.">;
1275  def watchpoint_command_add_stop_on_error : Option<"stop-on-error", "e">,
1276    Arg<"Boolean">, Desc<"Specify whether watchpoint command execution should "
1277    "terminate on error.">;
1278  def watchpoint_command_add_script_type : Option<"script-type", "s">,
1279    EnumArg<"None", "ScriptOptionEnum()">, Desc<"Specify the language for the"
1280    " commands - if none is specified, the lldb command interpreter will be "
1281    "used.">;
1282  def watchpoint_command_add_python_function : Option<"python-function", "F">,
1283    Group<2>, Arg<"PythonFunction">, Desc<"Give the name of a Python function "
1284    "to run as command for this watchpoint. Be sure to give a module name if "
1285    "appropriate.">;
1286}
1287
1288let Command = "watchpoint delete" in {
1289  def watchpoint_delete_force : Option<"force", "f">, Group<1>,
1290    Desc<"Delete all watchpoints without querying for confirmation.">;
1291}
1292
1293let Command = "trace load" in {
1294  def trace_load_verbose : Option<"verbose", "v">, Group<1>,
1295    Desc<"Show verbose trace load logging for debugging the plug-in "
1296    "implementation.">;
1297}
1298
1299let Command = "trace dump" in {
1300  def trace_dump_verbose : Option<"verbose", "v">, Group<1>,
1301    Desc<"Show verbose trace information.">;
1302}
1303
1304let Command = "trace schema" in {
1305  def trace_schema_verbose : Option<"verbose", "v">, Group<1>,
1306    Desc<"Show verbose trace schema logging for debugging the plug-in.">;
1307}
1308
1309let Command = "statistics dump" in {
1310  def statistics_dump_all: Option<"all-targets", "a">, Group<1>,
1311    Desc<"Include statistics for all targets.">;
1312}
1313