Skip to content

Commit f89bf50

Browse files
gs0-pix4dgs0-pix4d
authored
Updated help page (--rr does not exist anymore) (#415)
1 parent 9099fb3 commit f89bf50

File tree

1 file changed

+54
-46
lines changed

1 file changed

+54
-46
lines changed

‎docs/api.md‎

Lines changed: 54 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,86 @@
11
This is the command line help output of gdbgui.
22

33
```
4-
usage: gdbgui [-h] [-g GDB] [--gdb-args GDB_ARGS] [--rr] [-p PORT]
5-
[--host HOST] [-r] [--auth-file AUTH_FILE] [--user USER]
6-
[--password PASSWORD] [--key KEY] [--cert CERT]
7-
[--remap-sources REMAP_SOURCES] [--project PROJECT] [-v]
8-
[-n] [-b BROWSER] [--debug] [--args ...]
9-
[cmd]
4+
usage: gdbgui [-h] [-g GDB_CMD] [-p PORT] [--host HOST] [-r]
5+
[--auth-file AUTH_FILE] [--user USER] [--password PASSWORD]
6+
[--key KEY] [--cert CERT] [--remap-sources REMAP_SOURCES]
7+
[--project PROJECT] [-v] [-n] [-b BROWSER] [--debug]
8+
[--args ...]
9+
[debug_program]
1010
1111
A server that provides a graphical user interface to the gnu debugger (gdb).
1212
https://github.com/cs01/gdbgui
1313
1414
positional arguments:
15-
cmd The executable file and any arguments to pass to it.
16-
To pass flags to the binary, wrap in quotes, or use
17-
--args instead. Example: gdbgui ./mybinary [other-
18-
gdbgui-args...] Example: gdbgui './mybinary myarg
19-
-flag1 -flag2' [other gdbgui args...]
15+
debug_program The executable file you wish to debug, and any
16+
arguments to pass to it. To pass flags to the
17+
binary, wrap in quotes, or use --args instead.
18+
Example: gdbgui ./mybinary [other-gdbgui-args...]
19+
Example: gdbgui './mybinary myarg -flag1 -flag2'
20+
[other gdbgui args...] (default: None)
2021
2122
optional arguments:
2223
-h, --help show this help message and exit
23-
--args ... Specify the executable file and any arguments to pass
24-
to it. All arguments are taken literally, so if used,
25-
this must be the last argument passed to gdbgui.
26-
Example: gdbgui [...] --args ./mybinary myarg -flag1
27-
-flag2
24+
--args ... Specify the executable file you wish to debug and
25+
any arguments to pass to it. All arguments are taken
26+
literally, so if used, this must be the last
27+
argument. This can also be specified later in the
28+
frontend. passed to gdbgui. Example: gdbgui [...]
29+
--args ./mybinary myarg -flag1 -flag2 (default: [])
2830
2931
gdb settings:
30-
-g GDB, --gdb GDB Path to debugger. Default: gdb
31-
--gdb-args GDB_ARGS Arguments passed directly to gdb when gdb is invoked.
32-
For example,--gdb-args="--nx --tty=/dev/ttys002"
33-
--rr Use `rr replay` instead of gdb. Replays last recording
34-
by default. Replay arbitrary recording by passing
35-
recorded directory as an argument. i.e. gdbgui
36-
/recorded/dir --rr. See http://rr-project.org/.
32+
-g GDB_CMD, --gdb-cmd GDB_CMD
33+
gdb binary and arguments to run. If passing
34+
arguments, enclose in quotes. If using rr, it should
35+
be specified here with 'rr replay'. Examples: gdb,
36+
/path/to/gdb, 'gdb --command=FILE -ix', 'rr replay'
37+
(default: gdb)
3738
3839
gdbgui network settings:
39-
-p PORT, --port PORT The port on which gdbgui will be hosted. Default: 5000
40-
--host HOST The host ip address on which gdbgui serve. Default:
41-
127.0.0.1
40+
-p PORT, --port PORT The port on which gdbgui will be hosted (default:
41+
5000)
42+
--host HOST The host ip address on which gdbgui serve (default:
43+
127.0.0.1)
4244
-r, --remote Shortcut to set host to 0.0.0.0 and suppress browser
43-
from opening. This allows remote access to gdbgui and
44-
is useful when running on a remote machine that you
45-
want to view/debug from your local browser, or let
46-
someone else debug your application remotely.
45+
from opening. This allows remote access to gdbgui
46+
and is useful when running on a remote machine that
47+
you want to view/debug from your local browser, or
48+
let someone else debug your application remotely.
49+
(default: False)
4750
4851
security settings:
4952
--auth-file AUTH_FILE
50-
Require authentication before accessing gdbgui in the
51-
browser. Specify a file that contains the HTTP Basic
52-
auth username and password separate by newline.
53-
--user USER Username when authenticating
54-
--password PASSWORD Password when authenticating
53+
Require authentication before accessing gdbgui in
54+
the browser. Specify a file that contains the HTTP
55+
Basic auth username and password separate by
56+
newline. (default: None)
57+
--user USER Username when authenticating (default: None)
58+
--password PASSWORD Password when authenticating (default: None)
5559
--key KEY SSL private key. Generate with:openssl req -newkey
56-
rsa:2048 -nodes -keyout host.key -x509 -days 365 -out
57-
host.cert
60+
rsa:2048 -nodes -keyout host.key -x509 -days 365
61+
-out host.cert (default: None)
5862
--cert CERT SSL certificate. Generate with:openssl req -newkey
59-
rsa:2048 -nodes -keyout host.key -x509 -days 365 -out
60-
host.cert
63+
rsa:2048 -nodes -keyout host.key -x509 -days 365
64+
-out host.cert (default: None)
6165
6266
other settings:
6367
--remap-sources REMAP_SOURCES, -m REMAP_SOURCES
6468
Replace compile-time source paths to local source
6569
paths. Pass valid JSON key/value pairs.i.e. --remap-
66-
sources='{"/buildmachine": "/home/chad"}'
67-
--project PROJECT Set the project directory. When viewing the "folders"
68-
pane, paths are shown relative to this directory.
69-
-v, --version Print version
70+
sources='{"/buildmachine": "/current/machine"}'
71+
(default: None)
72+
--project PROJECT Set the project directory. When viewing the
73+
"folders" pane, paths are shown relative to this
74+
directory. (default: None)
75+
-v, --version Print version (default: False)
7076
-n, --no-browser By default, the browser will open with gdbgui. Pass
71-
this flag so the browser does not open.
77+
this flag so the browser does not open. (default:
78+
False)
7279
-b BROWSER, --browser BROWSER
73-
Use the given browser executable instead of the system
74-
default.
80+
Use the given browser executable instead of the
81+
system default. (default: None)
7582
--debug The debug flag of this Flask application. Pass this
7683
flag when debugging gdbgui itself to automatically
7784
reload the server when changes are detected
85+
(default: False)
7886
```

0 commit comments

Comments
 (0)