Skip to content

Commit bec8bd4

Browse files
committed
Fix help; Update README.md
1 parent 4a5e59d commit bec8bd4

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Yet Another gdb TUI. Connect remotely with gdb when you don't have a working `gdbserver`, and show a tui inspired by `gef`.
77

8-
* **No gdbserver requirements**: Many vendors ship invalid `gdbserver` binaries, this works on remote targets with just `gdb`, `nc`, and `mkfifo`.
8+
* **No gdbserver requirements**: Many vendors ship invalid `gdbserver` binaries, this works on remote targets with just `gdb`, `nc`, `cat`, and `mkfifo`.
99
* **No python requirements**: Many vendors ship `gdb` without python support.
1010
* **Architecture agnostic**: `heretek` only uses information given by `gdb`, no extra code required!
1111

@@ -26,11 +26,22 @@ Yet Another GDB TUI
2626
Usage: heretek [OPTIONS]
2727

2828
Options:
29-
-l, --local Run gdb as child process from PATH
30-
-r, --remote <REMOTE> Connect to nc session
31-
--32 Switch into 32-bit mode
32-
-h, --help Print help (see more with '--help')
33-
-V, --version Print version
29+
-l, --local
30+
Run gdb as child process from PATH
31+
32+
-r, --remote <REMOTE>
33+
Connect to nc session
34+
35+
`mkfifo gdb_pipe; cat gdb_pipe | gdb --interpreter=mi | nc -l -p 12345 > gdb_pipe`
36+
37+
--32
38+
Switch into 32-bit mode
39+
40+
-h, --help
41+
Print help (see a summary with '-h')
42+
43+
-V, --version
44+
Print version
3445
```
3546

3647
## Info

src/main.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ struct Args {
8181

8282
/// Connect to nc session
8383
///
84-
/// `mkfifo gdb_sock; cat gdb_pipe | gdb --interpreter=mi | nc -l -p 12345 > gdb_pipe`
84+
/// `mkfifo gdb_pipe; cat gdb_pipe | gdb --interpreter=mi | nc -l -p 12345 > gdb_pipe`
8585
#[arg(short, long)]
8686
remote: Option<SocketAddr>,
8787

0 commit comments

Comments
 (0)