PenaDevops/delve
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
34104fb65d
delve/Documentation/usage/dlv.md

56 lines
3.5 KiB
Markdown
Raw Normal View History

docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
## dlv
Delve is a debugger for the Go programming language.
### Synopsis
Delve is a source level debugger for Go programs.
Delve enables you to interact with your program by controlling the execution of the process,
evaluating variables, and providing information of thread / goroutine state, CPU register state and more.
The goal of this tool is to provide a simple yet powerful interface for debugging Go programs.
Add flag support documentation (#740)
2017-02-16 19:05:48 +00:00
Pass flags to the program you are debugging using `--`, for example:
`dlv exec ./hello -- server --config conf/config.toml`
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
### Options
```
commmands: update DAP overview in help (#2850) Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:40 +00:00
--accept-multiclient Allows a headless server to accept multiple client connections via JSON-RPC or DAP.
cmd,proc,terminal,debugger: Support default file descriptor redirects Adds features to support default file descriptor redirects for the target process: 1. A new command line flag '--redirect' and '-r' are added to specify file redirects for the target process 2. New syntax is added to the 'restart' command to specify file redirects. 3. Interactive instances will check if stdin/stdout and stderr are terminals and print a helpful error message if they aren't.
2020-08-21 14:14:02 +00:00
--allow-non-terminal-interactive Allows interactive sessions of Delve that don't have a terminal as stdin, stdout and stderr
commmands: update DAP overview in help (#2850) Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:40 +00:00
--api-version int Selects JSON-RPC API version when headless. New clients should use v2. Can be reset via RPCServer.SetApiVersion. See Documentation/api/json-rpc/README.md. (default 1)
cmd,proc,terminal,debugger: Support default file descriptor redirects Adds features to support default file descriptor redirects for the target process: 1. A new command line flag '--redirect' and '-r' are added to specify file redirects for the target process 2. New syntax is added to the 'restart' command to specify file redirects. 3. Interactive instances will check if stdin/stdout and stderr are terminals and print a helpful error message if they aren't.
2020-08-21 14:14:02 +00:00
--backend string Backend selection (see 'dlv help backend'). (default "default")
*: Expand --build-flags= description in the document (#2273) add example for multiple --build-flags add example description to --build-flags
2021-01-05 18:57:30 +00:00
--build-flags string Build flags, to be passed to the compiler. For example: --build-flags="-tags=integration -mod=vendor -cover -v"
pkg/goversion: visibly warn the user with --check-go-version=false (#2684) Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2021-09-25 15:41:00 +00:00
--check-go-version Exits if the version of Go in use is not compatible (too old or too new) with the version of Delve. (default true)
proc/*: add launch option to disable ASLR (#2202) Fixes #1847
2020-10-21 19:50:52 +00:00
--disable-aslr Disables address space randomization
commmands: update DAP overview in help (#2850) Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:40 +00:00
--headless Run debug server only, in headless mode. Server will accept both JSON-RPC or DAP client connections.
all: update github.com/spf13/cobra to v1.1.3 (#2572) This removes indirect dependencies from go.mod, and includes the fix for the missing -help flag info. The latest cobra release is v1.2.1. Given that there were minor security-related dependency cleanup during v1.2 release, I was tempted to pick up the latest version, but that caused dependency updates in golang.org/x/sys and golang.org/x/tools which may be too recent (golang.org/x/* follow the go's release support policy, so recent versions may not be compatible with go versions beyond go's official version support policy). Verified that dlv still builds with go1.12.x. (go1.12 is the oldest version of go that can build the latest delve already). $ go get -d github.com/spf13/cobra@v1.1.3 $ go mod tidy $ go mod vendor $ go run _scripts/gen-usage-docs.go
2021-07-22 18:05:37 +00:00
-h, --help help for dlv
cmd,proc,terminal,debugger: Support default file descriptor redirects Adds features to support default file descriptor redirects for the target process: 1. A new command line flag '--redirect' and '-r' are added to specify file redirects for the target process 2. New syntax is added to the 'restart' command to specify file redirects. 3. Interactive instances will check if stdin/stdout and stderr are terminals and print a helpful error message if they aren't.
2020-08-21 14:14:02 +00:00
--init string Init file, executed by the terminal client.
-l, --listen string Debugging server listen address. (default "127.0.0.1:0")
--log Enable debugging server logging.
--log-dest string Writes logs to the specified file or file descriptor (see 'dlv help log').
--log-output string Comma separated list of components that should produce debug output (see 'dlv help log')
--only-same-user Only connections from the same user that started this instance of Delve are allowed to connect. (default true)
-r, --redirect stringArray Specifies redirect rules for target process (see 'dlv help redirect')
--wd string Working directory for running the program.
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
```
### SEE ALSO
all: update github.com/spf13/cobra to v1.1.3 (#2572) This removes indirect dependencies from go.mod, and includes the fix for the missing -help flag info. The latest cobra release is v1.2.1. Given that there were minor security-related dependency cleanup during v1.2 release, I was tempted to pick up the latest version, but that caused dependency updates in golang.org/x/sys and golang.org/x/tools which may be too recent (golang.org/x/* follow the go's release support policy, so recent versions may not be compatible with go versions beyond go's official version support policy). Verified that dlv still builds with go1.12.x. (go1.12 is the oldest version of go that can build the latest delve already). $ go get -d github.com/spf13/cobra@v1.1.3 $ go mod tidy $ go mod vendor $ go run _scripts/gen-usage-docs.go
2021-07-22 18:05:37 +00:00
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
* [dlv attach](dlv_attach.md) - Attach to running process and begin debugging.
commmands: update DAP overview in help (#2850) Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:40 +00:00
* [dlv connect](dlv_connect.md) - Connect to a headless debug server with a terminal client.
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
* [dlv core](dlv_core.md) - Examine a core dump.
commmands: update DAP overview in help (#2850) Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:40 +00:00
* [dlv dap](dlv_dap.md) - Starts a headless TCP server communicating via Debug Adaptor Protocol (DAP).
Add flag support documentation (#740)
2017-02-16 19:05:48 +00:00
* [dlv debug](dlv_debug.md) - Compile and begin debugging main package in current directory, or the package specified.
dlv/cmds: Improve subcommand help output
2016-05-20 17:51:23 +00:00
* [dlv exec](dlv_exec.md) - Execute a precompiled binary, and begin a debug session.
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
* [dlv replay](dlv_replay.md) - Replays a rr trace.
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
* [dlv run](dlv_run.md) - Deprecated command. Use 'debug' instead.
* [dlv test](dlv_test.md) - Compile test binary and begin debugging program.
* [dlv trace](dlv_trace.md) - Compile and begin tracing program.
* [dlv version](dlv_version.md) - Prints version.
Documentation,cmd/dlv: tidy up --help output (#1649) * scripts: use relative path in gen-cli-docs.go Makes gen-cli-docs.go work outside GOPATH. * Documentation,cmd/dlv: tidy up --help output The description of --log-dest, --log-output and --backend is very verbose and messes up the output of --help, move it to two "additional help" subcommands.
2019-08-01 23:28:38 +00:00
* [dlv log](dlv_log.md) - Help about logging flags
* [dlv backend](dlv_backend.md) - Help about the `--backend` flag
Reference in New Issue Copy Permalink