Not bad, but 2 things come to mind:

Something like but a bit more markdown formatted. But there need to the description for all the gef sub-commands, save, restore, config, etc.
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 |

Uh oh!

Missing documentation for gef command #643

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

Missing documentation for `gef` command #643