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