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

50 lines
2.4 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
```
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
--accept-multiclient Allows a headless server to accept multiple client connections.
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--api-version int Selects API version when headless. (default 1)
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
--backend string Backend selection (see 'dlv help backend'). (default "default")
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--build-flags string Build flags, to be passed to the compiler.
cmd/dlv: add Go version check (#1533) Before doing anything check that the version of Go is compatible with the current version of Delve. This will improve the error message in the case that another change as disruptive as Go1.11 dwarf compression, happens.
2019-04-26 17:24:21 +00:00
--check-go-version Checks that the version of Go in use is compatible with Delve. (default true)
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--headless Run debug server only, in headless mode.
--init string Init file, executed by the terminal client.
*: Add .cirrus.yml for FreeBSD testing (#1639) * *: Add .cirrus.yml for FreeBSD testing * *: run go mod tidy * service/test: prefer 127.0.0.1 over localhost * dwarf/line: fix TestDebugLinePrologueParser * vendor: rerun go mod vendor
2019-07-30 15:38:25 +00:00
-l, --listen string Debugging server listen address. (default "127.0.0.1:0")
cmd/dlv: Revert 4e177b, use new flag name for debug logging options Previously to 4e177bb99acc511897f9cdbfc6cbc50d92ae4725 it was possible to use --log without arguments to enable logging, this commit reenables that use case. The new functionality of the --log flag moved to a new flag name --logx. Fixes #1188
2018-04-19 08:43:23 +00:00
--log Enable debugging server logging.
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
--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')
proc/gdbserial: mozilla rr support (#804) Implements #727
2017-05-05 22:17:52 +00:00
--wd string Working directory for running the program. (default ".")
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
* [dlv attach](dlv_attach.md) - Attach to running process and begin debugging.
* [dlv connect](dlv_connect.md) - Connect to a headless debug server.
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.
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