[Lldb-commits] [lldb] r255769 - Man page whitespace/formatting change to appease igor(1)
Ed Maste via lldb-commits
lldb-commits at lists.llvm.org
Wed Dec 16 06:59:49 PST 2015
Author: emaste
Date: Wed Dec 16 08:59:48 2015
New Revision: 255769
URL: http://llvm.org/viewvc/llvm-project?rev=255769&view=rev
Log:
Man page whitespace/formatting change to appease igor(1)
igor is a tool to detect common problems and style conformance issues in
man pages and other documents. This is a non-content change to address
the items it reported, before making content changes.
See http://www.wonkity.com/~wblock/igor/igor.1.html for more information
about igor(1).
Modified:
lldb/trunk/docs/lldb.1
Modified: lldb/trunk/docs/lldb.1
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/lldb.1?rev=255769&r1=255768&r2=255769&view=diff
==============================================================================
--- lldb/trunk/docs/lldb.1 (original)
+++ lldb/trunk/docs/lldb.1 Wed Dec 16 08:59:48 2015
@@ -1,10 +1,10 @@
.Dd June 7, 2012 \" DATE
.Dt LLDB 1 \" Program name and manual section number
.Os
-.Sh NAME \" Section Header - required - don't modify
+.Sh NAME \" Section Header - required - do not modify
.Nm lldb
.Nd The debugger
-.Sh SYNOPSIS \" Section Header - required - don't modify
+.Sh SYNOPSIS \" Section Header - required - do not modify
.Nm lldb
.Op Fl hvdexw
.Op Fl a Ar arch
@@ -13,7 +13,7 @@
.Op Fl n Ar process-name
.Op Fl p Ar pid
.Ar [[--] <PROGRAM-ARG1> <PROGRAM-ARG2> ...]
-.Sh DESCRIPTION \" Section Header - required - don't modify
+.Sh DESCRIPTION \" Section Header - required - do not modify
.Nm
is the command line interface for the LLDB debugger library.
.Nm
@@ -24,7 +24,8 @@ The following options are available:
.It Fl h, -help
Prints out the usage information for the
.Nm
-debugger. The
+debugger.
+The
.Fl -help
text may be more up-to-date and
authoritative than the command line options described in this man
@@ -60,7 +61,8 @@ Specifies a currently running process th
should attach to.
.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
+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
@@ -80,9 +82,11 @@ to open source files using the host's "e
.It Fl x, -no-lldbinit
Do not automatically parse any '.lldbinit' files.
.Pp
-(If you don't provide -f then the first argument will be the file to be debugged
+(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.)
+Remember to end the options with "--" if any of your arguments have
+a "-" in them.)
.El
.Sh USING LLDB
In
@@ -91,7 +95,8 @@ there is a
.Cm help
command which can be used to find descriptions and examples of all
.Nm
-commands. To get help on
+commands.
+To get help on
.Qq Cm breakpoint set
you would type
.Qq Cm help breakpoint set .
@@ -99,7 +104,8 @@ you would type
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,
+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
@@ -108,9 +114,10 @@ in its help text.
.Nm
will read settings/aliases/commands from three files at startup, if they exist.
.Pp
-First, it will read a
+First, it will read a
.Pa ~/.lldbinit-debugger
-command file. If you are using the
+command file.
+If you are using the
.Nm
command line interface, this is
.Pa ~/.lldbinit-lldb .
More information about the lldb-commits
mailing list