Skip to content

Commit

Permalink
Improve man page markup
Browse files Browse the repository at this point in the history
Patch by Baptiste Daroussin

Differential Revision: http://reviews.llvm.org/D11561

llvm-svn: 243749
  • Loading branch information
emaste committed Jul 31, 2015
1 parent 343ad62 commit 8b559ec
Showing 1 changed file with 43 additions and 18 deletions.
61 changes: 43 additions & 18 deletions lldb/docs/lldb.1
@@ -1,6 +1,6 @@
.Dd June 7, 2012 \" DATE
.Dt LLDB 1 \" Program name and manual section number
.Os Darwin \" Operating System
.Os
.Sh NAME \" Section Header - required - don't modify
.Nm lldb
.Nd The debugger
Expand All @@ -24,7 +24,9 @@ The following options are available:
.It Fl h, -help
Prints out the usage information for the
.Nm
debugger. The \fB\-\-help\fR text may be more up-to-date and
debugger. The
.Fl -help
text may be more up-to-date and
authoritative than the command line options described in this man
page.
.It Fl v, -version
Expand All @@ -42,9 +44,13 @@ 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 \fB\-w\fR is used.)
(or the name of a process to wait for if
.Fl w
is used.)
.It Fl w, -wait-for
When used in concert with \&\fB\-n process-name\-E\fR, indicates that
When used in concert with
.Fl n Ar process-name ,
indicates that
.Nm
should wait for a new process of that name to be started -- and attach
to it as early in the process-launch as possible.
Expand All @@ -62,8 +68,9 @@ Tells the debugger to print out extra information for debugging itself.
.It Fl s, -source Ar filename
Tells
.Nm
to read in and execute the file "\fBfilename\fR", which
should contain
to read in and execute the file
.Qq Ar filename ,
which should contain
.Nm
commands.
.It Fl e, -editor
Expand All @@ -80,32 +87,50 @@ Remember to end the options with "--" if any of your arguments have a "-" in the
.Sh USING LLDB
In
.Nm
there is a \fBhelp\fR command which can be used to find descriptions and examples of
all
there is a
.Cm help
command which can be used to find descriptions and examples of all
.Nm
commands. To get help on "\fBbreakpoint set\fR" you would type "\fBhelp breakpoint set\fR".
commands. To get help on
.Qq Cm breakpoint set
you would type
.Qq Cm help breakpoint set .
.Pp
There is also an \fBapropos\fR 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, "\fBapropos breakpoint\fR"
will list any command that has the word \fBbreakpoint\fR in its help text.
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.
.Sh FILES
.Nm
will read settings/aliases/commands from three files at startup, if they exist.
.Pp
First, it will read a \fB~/.lldbinit-\fIdebugger\fR command file. If you are using the
First, it will read a
.Pa ~/.lldbinit-debugger
command file. If you are using the
.Nm
command line interface, this is \fB~/.lldbinit-lldb\fR. If you are using
command line interface, this is
.Pa ~/.lldbinit-lldb .
If you are using
.Nm
inside a GUI debugger like
.Nm Xcode
this will be \fB~/.lldbinit-Xcode\fR. This is a useful place to put settings that you
want to apply only when a given
this will be
.Pa ~/.lldbinit-Xcode .
This is a useful place to put settings that you want to apply only when a given
.Nm
command interpreter is used.
.Pp
Second, \fB~/.lldbinit\fR is read.
Second,
.Pa ~/.lldbinit
is read.
.Pp
Third, an \fR.lldbinit\fR file in the current working directory (where
Third, an
.Pa .lldbinit
file in the current working directory (where
.Nm
is started) will be read.
.Sh SEE ALSO
Expand Down

0 comments on commit 8b559ec

Please sign in to comment.