Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation for gef command #643

Closed
hugsy opened this issue Apr 22, 2021 · 2 comments · Fixed by #662
Closed

Missing documentation for gef command #643

hugsy opened this issue Apr 22, 2021 · 2 comments · Fixed by #662

Comments

@hugsy
Copy link
Owner

hugsy commented Apr 22, 2021

Reported by @khaoticdude on Discord

@hoefler02
Copy link
Contributor

Something like this?

@hugsy
Copy link
Owner Author

hugsy commented Jun 14, 2021

Not bad, but 2 things come to mind:

  1. Something like but a bit more markdown formatted. But there need to the description for all the gef sub-commands, save, restore, config, etc.

  2. Also ideally, we could imagine a bash script that generates docs/commands.md like

$ printf "| Command | Description |\n|--|--|\n" && \
gdb -ex gef -ex quit | grep -- '--' | awk '{ sub(/[ \t]+/, " "); print }' | awk 'FS="--" {print "| `" $1 "` | " $2 " | " }' | head
| Command | Description |
|--|--|
| `$` | SmartEval: Smart eval (vague approach to mimic WinDBG `?`).|
| `aliases ` |  Base command to add, remove, or list aliases. |
| `aslr ` |  View/modify the ASLR setting of GDB. By default, GDB will disable ASLR when it starts the process. (i.e. not |
| `assemble ` |  Inline code assemble. Architecture can be set in GEF runtime config.  (alias: asm) |
| `bincompare ` |  BincompareCommand: compare an binary file with the memory position looking for badchars. |
| `bytearray ` |  BytearrayCommand: Generate a bytearray to be compared with possible badchars. |
| `canary ` |  Shows the canary value of the current process. Apply the techique detailed in |
| `capstone-disassemble ` |  Use capstone disassembly framework to disassemble code. (alias: cs-dis) |
| `checksec ` |  Checksec the security properties of the current executable or passed as argument. The |

@hoefler02 hoefler02 mentioned this issue Jun 15, 2021
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants