blob: a28cabe7acc09c7fc3ce35c0e553f772ab338979 [file] [log] [blame]
.Dd December 16, 2015 \" DATE
.Dt LLDB 1 \" Program name and manual section number
.Sh NAME \" Section Header - required - do not modify
.Nm lldb
.Nd The debugger
.Sh SYNOPSIS \" Section Header - required - do not modify
.Nm lldb
.Op Fl hvdexw
.Op Fl a Ar arch
.Op Fl c Ar core-file
.Op Fl l Ar script-language
.Op Fl s Ar lldb-commands
.Op Fl n Ar process-name
.Op Fl p Ar pid
.Ar [[--] <PROGRAM-ARG1> <PROGRAM-ARG2> ...]
.Sh DESCRIPTION \" Section Header - required - do not modify
is the command line interface for the LLDB debugger library.
can debug C, C++, Objective-C, and Objective-C++ programs.
The following options are available:
.Bl -tag -width indent
.It Fl h, -help
Prints out the usage information for the
.Fl -help
text may be more up-to-date and
authoritative than the command line options described in this man
.It Fl v, -version
Prints out the version number of the
.It Fl a, -arch Ar arch
Specifies which architecture
will use when launching the specified program (assuming the provided
executable is built for multiple architectures.)
.It Fl f, -file Ar filename
Specifies the executable file that
will be launching / attaching to.
.It Fl n, -attach-name Ar process-name
Specifies the name of a currently-running process to attach to.
(or the name of a process to wait for if
.Fl w
is used.)
.It Fl w, -wait-for
When used in concert with
.Fl n Ar process-name ,
indicates that
should wait for a new process of that name to be started -- and attach
to it as early in the process-launch as possible.
.It Fl p, -attach-pid Ar pid
Specifies a currently running process that
should attach to.
.It Fl c, -core Ar core-file
Specifies the core file to examine.
.It Fl l, -script-language Ar language
Tells the debugger to use the specified scripting language for
user-defined scripts, rather than the default.
Valid scripting
languages that can be specified include Python, Perl, Ruby and Tcl.
Currently only the Python extensions have been implemented.
.It Fl d, -debug
Tells the debugger to print out extra information for debugging itself.
.It Fl s, -source Ar filename
to read in and execute the file
.Qq Ar filename ,
which should contain
.It Fl e, -editor
to open source files using the host's "external editor" mechanism.
.It Fl x, -no-lldbinit
Do not automatically parse any '.lldbinit' files.
(If you do not provide -f then the first argument will be the file to
be debugged
so 'lldb -- <filename> [<ARG1> [<ARG2>]]' also works.
Remember to end the options with "--" if any of your arguments have
a "-" in them.)
there is a
.Cm help
command which can be used to find descriptions and examples of all
To get help on
.Qq Cm breakpoint set
you would type
.Qq Cm help breakpoint set .
There is also an
.Cm apropos
command which will search the help text of all commands
for a given term -- this is useful for locating a command by topic.
For instance,
.Qq Cm apropos breakpoint
will list any command that has the word
.Qq Cm breakpoint
in its help text.
will read settings/aliases/commands from three files at startup, if they exist.
First, it will read a
.Pa ~/.lldbinit-debugger
command file.
If you are using the
command line interface, this is
.Pa ~/.lldbinit-lldb .
If you are using
inside a GUI debugger like
.Nm Xcode
this will be
.Pa ~/.lldbinit-Xcode .
This is a useful place to put settings that you want to apply only when a given
command interpreter is used.
.Pa ~/.lldbinit
is read.
Third, an
.Pa .lldbinit
file in the current working directory (where
is started) will be read.
The LLDB project page has many different resources for
users -- the gdb/lldb command equivalence page can
be especially helpful for users coming from gdb.
To report bugs, please visit
Maintained by the LLDB Team,