diff --git a/Documentation/cli/README.md b/Documentation/cli/README.md index 6c9e1736..367bce00 100644 --- a/Documentation/cli/README.md +++ b/Documentation/cli/README.md @@ -2,47 +2,46 @@ Command | Description --------|------------ -[help](#help) | Prints the help message. +[args](#args) | Print function arguments. [break](#break) | Sets a breakpoint. -[trace](#trace) | Set tracepoint. -[restart](#restart) | Restart process. -[continue](#continue) | Run until breakpoint or program termination. -[step](#step) | Single step through program. -[step-instruction](#step-instruction) | Single step a single cpu instruction. -[next](#next) | Step over to next source line. -[threads](#threads) | Print out info for every traced thread. -[thread](#thread) | Switch to the specified thread. +[breakpoints](#breakpoints) | Print out info for active breakpoints. [clear](#clear) | Deletes breakpoint. [clearall](#clearall) | Deletes multiple breakpoints. -[goroutines](#goroutines) | List program goroutines. -[goroutine](#goroutine) | Shows or changes current goroutine -[breakpoints](#breakpoints) | Print out info for active breakpoints. -[print](#print) | Evaluate an expression. -[set](#set) | Changes the value of a variable. -[sources](#sources) | Print list of source files. -[funcs](#funcs) | Print list of functions. -[types](#types) | Print list of types -[args](#args) | Print function arguments. -[locals](#locals) | Print local variables. -[vars](#vars) | Print package variables. -[regs](#regs) | Print contents of CPU registers. -[exit](#exit) | Exit the debugger. -[list](#list) | Show source code. -[stack](#stack) | Print stack trace. -[frame](#frame) | Executes command on a different frame. -[source](#source) | Executes a file containing a list of delve commands -[disassemble](#disassemble) | Disassembler. -[on](#on) | Executes a command when a breakpoint is hit. [condition](#condition) | Set breakpoint condition. +[continue](#continue) | Run until breakpoint or program termination. +[disassemble](#disassemble) | Disassembler. +[exit](#exit) | Exit the debugger. +[frame](#frame) | Executes command on a different frame. +[funcs](#funcs) | Print list of functions. +[goroutine](#goroutine) | Shows or changes current goroutine +[goroutines](#goroutines) | List program goroutines. +[help](#help) | Prints the help message. +[list](#list) | Show source code. +[locals](#locals) | Print local variables. +[next](#next) | Step over to next source line. +[on](#on) | Executes a command when a breakpoint is hit. +[print](#print) | Evaluate an expression. +[regs](#regs) | Print contents of CPU registers. +[restart](#restart) | Restart process. +[set](#set) | Changes the value of a variable. +[source](#source) | Executes a file containing a list of delve commands +[sources](#sources) | Print list of source files. +[stack](#stack) | Print stack trace. +[step](#step) | Single step through program. +[step-instruction](#step-instruction) | Single step a single cpu instruction. +[thread](#thread) | Switch to the specified thread. +[threads](#threads) | Print out info for every traced thread. +[trace](#trace) | Set tracepoint. +[types](#types) | Print list of types +[vars](#vars) | Print package variables. -## help -Prints the help message. +## args +Print function arguments. - help [command] - -Type "help" followed by the name of a command for more information about it. + [goroutine ] [frame ] args [-v] [] + +If regex is specified only function arguments with a name matching it will be returned. If -v is specified more information about each function argument will be shown. -Aliases: h ## break Sets a breakpoint. @@ -55,52 +54,10 @@ See also: "help on", "help cond" and "help clear" Aliases: b -## trace -Set tracepoint. +## breakpoints +Print out info for active breakpoints. - trace [name] - -A tracepoint is a breakpoint that does not stop the execution of the program, instead when the tracepoint is hit a notification is displayed. See [Documentation/cli/locspec.md](//github.com/derekparker/delve/tree/master/Documentation/cli/locspec.md) for the syntax of linespec. - -See also: "help on", "help cond" and "help clear" - -Aliases: t - -## restart -Restart process. - -Aliases: r - -## continue -Run until breakpoint or program termination. - -Aliases: c - -## step -Single step through program. - -Aliases: s - -## step-instruction -Single step a single cpu instruction. - -Aliases: si - -## next -Step over to next source line. - -Aliases: n - -## threads -Print out info for every traced thread. - - -## thread -Switch to the specified thread. - - thread - -Aliases: tr +Aliases: bp ## clear Deletes breakpoint. @@ -116,6 +73,63 @@ Deletes multiple breakpoints. If called with the linespec argument it will delete all the breakpoints matching the linespec. If linespec is omitted all breakpoints are deleted. +## condition +Set breakpoint condition. + + condition . + +Specifies that the breakpoint or tracepoint should break only if the boolean expression is true. + +Aliases: cond + +## continue +Run until breakpoint or program termination. + +Aliases: c + +## disassemble +Disassembler. + + [goroutine ] [frame ] disassemble [-a ] [-l ] + +If no argument is specified the function being executed in the selected stack frame will be executed. + + -a disassembles the specified address range + -l disassembles the specified function + +Aliases: disass + +## exit +Exit the debugger. + +Aliases: quit q + +## frame +Executes command on a different frame. + + frame . + + +## funcs +Print list of functions. + + funcs [] + +If regex is specified only the functions matching it will be returned. + + +## goroutine +Shows or changes current goroutine + + goroutine + goroutine + goroutine + +Called without arguments it will show information about the current goroutine. +Called with a single argument it will switch to the specified goroutine. +Called with more arguments it will execute a command on the specified goroutine. + + ## goroutines List program goroutines. @@ -130,96 +144,14 @@ Print out info for every goroutine. The flag controls what information is shown If no flag is specified the default is -u. -## goroutine -Shows or changes current goroutine +## help +Prints the help message. - goroutine - goroutine - goroutine + help [command] + +Type "help" followed by the name of a command for more information about it. -Called without arguments it will show information about the current goroutine. -Called with a single argument it will switch to the specified goroutine. -Called with more arguments it will execute a command on the specified goroutine. - - -## breakpoints -Print out info for active breakpoints. - -Aliases: bp - -## print -Evaluate an expression. - - [goroutine ] [frame ] print - -See [Documentation/cli/expr.md](//github.com/derekparker/delve/tree/master/Documentation/cli/expr.md) for a description of supported expressions. - -Aliases: p - -## set -Changes the value of a variable. - - [goroutine ] [frame ] set = - -See [Documentation/cli/expr.md](//github.com/derekparker/delve/tree/master/Documentation/cli/expr.md) for a description of supported expressions. Only numerical variables and pointers can be changed. - - -## sources -Print list of source files. - - sources [] - -If regex is specified only the source files matching it will be returned. - - -## funcs -Print list of functions. - - funcs [] - -If regex is specified only the functions matching it will be returned. - - -## types -Print list of types - - types [] - -If regex is specified only the functions matching it will be returned. - - -## args -Print function arguments. - - [goroutine ] [frame ] args [-v] [] - -If regex is specified only function arguments with a name matching it will be returned. If -v is specified more information about each function argument will be shown. - - -## locals -Print local variables. - - [goroutine ] [frame ] locals [-v] [] - -If regex is specified only local variables with a name matching it will be returned. If -v is specified more information about each local variable will be shown. - - -## vars -Print package variables. - - vars [-v] [] - -If regex is specified only package variables with a name matching it will be returned. If -v is specified more information about each package variable will be shown. - - -## regs -Print contents of CPU registers. - - -## exit -Exit the debugger. - -Aliases: quit q +Aliases: h ## list Show source code. @@ -230,38 +162,18 @@ Show source around current point or provided linespec. Aliases: ls -## stack -Print stack trace. +## locals +Print local variables. - [goroutine ] [frame ] stack [] [-full] + [goroutine ] [frame ] locals [-v] [] -If -full is specified every stackframe will be decorated by the value of its local variables and function arguments. - -Aliases: bt - -## frame -Executes command on a different frame. - - frame . +If regex is specified only local variables with a name matching it will be returned. If -v is specified more information about each local variable will be shown. -## source -Executes a file containing a list of delve commands +## next +Step over to next source line. - source - - -## disassemble -Disassembler. - - [goroutine ] [frame ] disassemble [-a ] [-l ] - -If no argument is specified the function being executed in the selected stack frame will be executed. - - -a disassembles the specified address range - -l disassembles the specified function - -Aliases: disass +Aliases: n ## on Executes a command when a breakpoint is hit. @@ -271,12 +183,98 @@ Executes a command when a breakpoint is hit. Supported commands: print, stack and goroutine) -## condition -Set breakpoint condition. +## print +Evaluate an expression. - condition . + [goroutine ] [frame ] print + +See [Documentation/cli/expr.md](//github.com/derekparker/delve/tree/master/Documentation/cli/expr.md) for a description of supported expressions. + +Aliases: p + +## regs +Print contents of CPU registers. + + +## restart +Restart process. + +Aliases: r + +## set +Changes the value of a variable. + + [goroutine ] [frame ] set = + +See [Documentation/cli/expr.md](//github.com/derekparker/delve/tree/master/Documentation/cli/expr.md) for a description of supported expressions. Only numerical variables and pointers can be changed. + + +## source +Executes a file containing a list of delve commands + + source + + +## sources +Print list of source files. + + sources [] + +If regex is specified only the source files matching it will be returned. + + +## stack +Print stack trace. + + [goroutine ] [frame ] stack [] [-full] + +If -full is specified every stackframe will be decorated by the value of its local variables and function arguments. + +Aliases: bt + +## step +Single step through program. + +Aliases: s + +## step-instruction +Single step a single cpu instruction. + +Aliases: si + +## thread +Switch to the specified thread. + + thread + +Aliases: tr + +## threads +Print out info for every traced thread. + + +## trace +Set tracepoint. + + trace [name] -Specifies that the breakpoint or tracepoint should break only if the boolean expression is true. +A tracepoint is a breakpoint that does not stop the execution of the program, instead when the tracepoint is hit a notification is displayed. See [Documentation/cli/locspec.md](//github.com/derekparker/delve/tree/master/Documentation/cli/locspec.md) for the syntax of linespec. -Aliases: cond +See also: "help on", "help cond" and "help clear" +Aliases: t + +## types +Print list of types + + types [] + +If regex is specified only the functions matching it will be returned. + + +## vars +Print package variables. + + vars [-v] [] + +If regex is specified only package variables with a name matching it will be returned. If -v is specified more information about each package variable will be shown.