utils/vim-lldb/doc/lldb.txt

   1 *lldb.txt* A plugin that enables debugging from your favourite editor
   2
   3 Author:   Daniel Malea <daniel.malea@intel.com>
   4 License:  Same terms as Vim itself (see |license|)
   5
   6 INTRODUCTION                                    *lldb*
   7
   8 Installing this plugin enables a set of commands in Vim to control the
   9 LLDB (http://lldb.llvm.org) debugger.
  10
  11 COMMANDS                                        *lldb-commands*
  12
  13 The LLDB command interpreter is exposed to Vim's command mode using the
  14 ':L' prefix. Tab-completion is available and will cycle through commands.
  15 Some commands have modified behaviour in Vim; for example, :Lbreakpoint
  16 with no arguments will set a breakpoint at the current cursor, rather than
  17 printing the standard help information for the LLDB command 'breakpoint'.
  18
  19                                                 *lldb-windows*
  20
  21 In addition to the standard commands available under the LLDB interpreter,
  22 there are also commands to display or hide informational debugger panes.
  23
  24 Windows can be shown or hidden using the ':Lhide <name>' or ':Lshow <name>'
  25 commands.
  26                                                 *lldb-:Lhide*
  27 :Lhide [windowname]     Hide informational debugger pane named 'windowname'.
  28
  29                                                 *lldb-:Lshow*
  30 :Lshow [windowname]     Show informational debugger pane named 'windowname'.
  31
  32 Possible window name arguments to the Lhide and Lshow commands include:
  33
  34     * backtrace
  35     * breakpoints
  36     * disassembly
  37     * locals
  38     * registers
  39     * threads
  40                                                 *lldb-:Lattach*
  41 :Lattach <process-name> Attach to a process by name.
  42
  43                                                 *lldb-:Ldetach*
  44 :Ldetach                Detach from the current process.
  45
  46                                                 *lldb-:Ltarget*
  47 :Ltarget [[create] executable]
  48                         Create a target with the specified executable. If
  49                         run with a single argument, that argument is assumed
  50                         to be a path to the executable to be debugged.
  51                         Otherwise, all arguments are passed into LLDB's command
  52                         interpreter.
  53
  54                                                 *lldb-:Lstart*
  55 :Lstart                 Create a process by executing the current target
  56                         and wait for LLDB to attach.
  57
  58                                                 *lldb-:Lrun*
  59 :Lrun                   Create a process by executing the current target
  60                         without waiting for LLDB to attach.
  61
  62                                                 *lldb-:Lcontinue*
  63 :Lcontinue              Continue execution of the process until the next
  64                         breakpoint is hit or the process exits.
  65
  66                                                 *lldb-:Lthread*
  67 :Lthread <args>         Passes through to LLDB. See :Lhelp thread.
  68
  69                                                 *lldb-:Lstep*
  70 :Lstep                  Step into the current function call.
  71
  72                                                 *lldb-:Lstepin*
  73 :Lstepin                Step into the current function call.
  74
  75                                                 *lldb-:Lstepinst*
  76 :Lstepinst              Step one instruction.
  77
  78                                                 *lldb-:Lstepinstover*
  79 :Lstepinstover          Step one instruction, but skip over jump or call
  80                         instructions.
  81
  82                                                 *lldb-:Lnext*
  83 :Lnext                  Step to the next line.
  84
  85                                                 *lldb-:Lfinish*
  86 :Lfinish                Step out of the current function.
  87
  88                                                 *lldb-:Lbreakpoint*
  89 :Lbreakpoint [args]     When arguments are provided, the lldb breakpoint
  90                         command is invoked. If no arguments are provided,
  91                         a breakpoint at the location under the cursor.
  92
  93                                                 *lldb-:Lprint*
  94                                                 *lldb-:Lpo*
  95                                                 *lldb-:LpO*
  96 :Lprint <expr>          Aliases to the lldb print and po commands. Cursor
  97 :Lpo <expr>             word (cursor WORD for LpO) will be used when
  98 :LpO <expr>             expression omitted.
  99
 100 MAPPINGS                                        *lldb-mappings*
 101
 102 On Mac OS X (under MacVim) , the following key mappings are available:
 103
 104 <Command-B>             Insert a breakpoint at the line under cursor
 105
 106
 107 ABOUT                                           *lldb-about*
 108
 109 Grab the latest version of this plugin (and LLDB sources) with:
 110   git clone http://llvm.org/git/lldb
 111
 112 File any bugs at:
 113   http://llvm.org/bugs/enter_bug.cgi?product=lldb
 114
 115  vim:tw=78:et:ft=help:norl: