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

53 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

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 backend
Help about the --backend flag.
### Synopsis
The --backend flag specifies which backend should be used, possible values
are:
default Uses lldb on macOS, native everywhere else.
native Native backend.
lldb Uses lldb-server or debugserver.
rr Uses mozilla rr (https://github.com/mozilla/rr).
proc/gdbserial: add environment variables to configure rr invocation (#3726) Adds two environment variables to configure rr invocations. Fixes #3670
2024-05-24 18:33:23 +00:00
Some backends can be configured using environment variables:
* DELVE_DEBUGSERVER_PATH specifies the path of the debugserver executable for the lldb backend
* DELVE_RR_RECORD_FLAGS specifies additional flags used when calling 'rr record'
* DELVE_RR_REPLAY_FLAGS specifies additional flags used when calling 'rr replay'
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
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
### Options
```
-h, --help help for backend
```
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
### Options inherited from parent commands
```
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.
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.
cmd/dlv: support unix domain sockets (#3655) Add support for listening on a unix domain socket in headless mode and in the 'connect' command. Fixes #3654
2024-02-07 19:04:45 +00:00
-l, --listen string Debugging server listen address. Prefix with 'unix:' to use a unix domain socket. (default "127.0.0.1:0")
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
--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.
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
```
### 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
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](dlv.md) - Delve is a debugger for the Go programming language.
Reference in New Issue Copy Permalink