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

45 lines
3.0 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
# Using Delve
Documentation: add overview usage info for all dlv commands (#2857) * Documentation: add overview usage info for all dlv commands * Separate trace, adjust headless wording * Add headless command note Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:12 +00:00
You can invoke Delve in [multiple ways](dlv.md), depending on your usage needs. Delve makes every attempt to be user-friendly, ensuring the user has to do the least amount of work possible to begin debugging their 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
Documentation: add overview usage info for all dlv commands (#2857) * Documentation: add overview usage info for all dlv commands * Separate trace, adjust headless wording * Add headless command note Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 16:57:12 +00:00
The [available commands](dlv.md) can be grouped into the following categories:
* Specify target and start debugging with the default [terminal interface](../cli/README.md):
* [dlv debug [package]](dlv_debug.md)
* [dlv test [package]](dlv_test.md)
* [dlv exec \<exe\>](dlv_exec.md)
* [dlv attach \<pid\>](dlv_attach.md)
* [dlv core \<exe\> \<core\>](dlv_core.md)
* [dlv replay \<rr trace\> ](dlv_replay.md)
* Trace target program execution
* [dlv trace [package] \<regexp\>](dlv_trace.md)
* Start a headless backend server only and connect with an external [frontend client](../EditorIntegration.md):
* [dlv **--headless** \<command\> \<target\> \<args\> ](../api/ClientHowto.md#spawning-the-backend)
* starts a server, enters a debug session for the specified target and waits to accept a client connection over JSON-RPC or DAP
* `<command>` can be any of `debug`, `test`, `exec`, `attach`, `core` or `replay`
* if `--headless` flag is not specified the default [terminal client](../cli/README.md) will be automatically started instead
* compatible with [dlv connect](dlv_connect.md), [VS Code Go](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#remote-debugging), [GoLand](https://www.jetbrains.com/help/go/attach-to-running-go-processes-with-debugger.html#attach-to-a-process-on-a-remote-machine)
* [dlv dap](dlv_dap.md)
* starts a DAP-only server and waits for a DAP client connection to specify the target and arguments
* compatible with [VS Code Go](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#remote-debugging)
* NOT compatible with [dlv connect](dlv_connect.md), [GoLand](https://www.jetbrains.com/help/go/attach-to-running-go-processes-with-debugger.html#attach-to-a-process-on-a-remote-machine)
* [dlv connect \<addr\>](dlv_connect.md)
* starts a [terminal interface client](../cli/README.md) and connects it to a running headless server over JSON-RPC
* Help information
* [dlv help [command]](dlv.md)
* [dlv log](dlv_log.md)
* [dlv backend](dlv_backend.md)
* [dlv redirect](dlv_redirect.md)
* [dlv version](dlv_version.md)
The above list may be incomplete. Refer to the auto-generated [complete usage document](dlv.md) to further explore all available commands.
terminal: send large output to pager (#3060) For commands that could produce large amounts of output switch to a pager command ($DELVE_PAGER, $PAGER or more) after a certain amount of output is produced. Fixes #919
2022-08-17 07:02:53 +00:00
## Environment variables
Delve also reads the following environment variables:
* `$DELVE_EDITOR` is used by the `edit` command (if it isn't set the `$EDITOR` variable is used instead)
* `$DELVE_PAGER` is used by commands that emit large output (if it isn't set the `$PAGER` variable is used instead, if neither is set `more` is used)
* `$TERM` is used to decide whether or not ANSI escape codes should be used for colorized output
* `$DELVE_DEBUGSERVER_PATH` is used to locate the debugserver executable on macOS
Reference in New Issue Copy Permalink