[Lldb-commits] [lldb] r243749 - Improve man page markup
emaste at freebsd.org
Fri Jul 31 07:26:15 PDT 2015
Date: Fri Jul 31 09:26:15 2015
New Revision: 243749
Improve man page markup
Patch by Baptiste Daroussin
Differential Revision: http://reviews.llvm.org/D11561
--- lldb/trunk/docs/lldb.1 (original)
+++ lldb/trunk/docs/lldb.1 Fri Jul 31 09:26:15 2015
@@ -1,6 +1,6 @@
.Dd June 7, 2012 \" DATE
.Dt LLDB 1 \" Program name and manual section number
-.Os Darwin \" Operating System
.Sh NAME \" Section Header - required - don't modify
.Nd The debugger
@@ -24,7 +24,9 @@ The following options are available:
.It Fl h, -help
Prints out the usage information for the
-debugger. The \fB\-\-help\fR text may be more up-to-date and
+text may be more up-to-date and
authoritative than the command line options described in this man
.It Fl v, -version
@@ -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
.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 ,
should wait for a new process of that name to be started -- and attach
to it as early in the process-launch as possible.
@@ -62,8 +68,9 @@ Tells the debugger to print out extra in
.It Fl s, -source Ar filename
-to read in and execute the file "\fBfilename\fR", which
+to read in and execute the file
+.Qq Ar filename ,
+which should contain
.It Fl e, -editor
@@ -80,32 +87,50 @@ Remember to end the options with "--" if
.Sh USING LLDB
-there is a \fBhelp\fR command which can be used to find descriptions and examples of
-commands. To get help on "\fBbreakpoint set\fR" you would type "\fBhelp breakpoint set\fR".
-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 a
+command which can be used to find descriptions and examples of all
+commands. To get help on
+.Qq Cm breakpoint set
+you would type
+.Qq Cm help breakpoint set .
+There is also an
+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 \fB~/.lldbinit-\fIdebugger\fR command file. If you are using the
-command line interface, this is \fB~/.lldbinit-lldb\fR. If you are using
+First, it will read a
+command file. If you are using the
+command line interface, this is
+.Pa ~/.lldbinit-lldb .
+If you are using
inside a GUI debugger like
-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
command interpreter is used.
-Second, \fB~/.lldbinit\fR is read.
-Third, an \fR.lldbinit\fR file in the current working directory (where
+file in the current working directory (where
is started) will be read.
.Sh SEE ALSO
More information about the lldb-commits