Show differences in debuggers in the documentation (#2996)

* cleanly handle parameter differences

* cleanly handle command differences

* cleanly handle function differences

* add note about supported debuggers for commands and parameters

* reduce h1 bottom margin

* make it more obvious we only support functions in gdb

* autogen docs

* fixup buddydump

* uppercase debugger name in supported debuggers message

* update docs
pull/3002/head
k4lizen 7 months ago committed by GitHub
parent f49a43aaa2
commit cb2ae6753a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# break-if-not-taken
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: break-if-not-taken [-h] branch
@ -24,6 +20,5 @@ Breaks on a branch if it is not taken.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# break-if-taken
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: break-if-taken [-h] branch
@ -24,6 +20,5 @@ Breaks on a branch if it is taken.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# breakrva
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: breakrva [-h] [offset] [module]
@ -27,6 +23,5 @@ Break at RVA from PIE base.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# ignore
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: ignore [-h] [N] COUNT
@ -29,6 +25,5 @@ By default, if `N' is ommitted, the last breakpoint (i.e. greatest breakpoint nu
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# context
```text
usage: context [-h] [--on] [--off] [subcontext ...]
@ -28,6 +23,5 @@ Print out the current register, instruction, and stack context.
||--on|Show the section(s) in subsequent context commands again. The section(s) have to be in the 'context-sections' list.|
||--off|Do not show the section(s) in subsequent context commands even though they might be in the 'context-sections' list.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# contextnext
```text
usage: contextnext [-h] [count]
@ -26,6 +21,5 @@ Select next entry in context history.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# contextoutput
```text
usage: contextoutput [-h] section path clearing [banner] [width]
@ -30,6 +25,5 @@ Sets the output of a context section.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# contextprev
```text
usage: contextprev [-h] [count]
@ -26,6 +21,5 @@ Select previous entry in context history.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# contextsearch
```text
usage: contextsearch [-h] needle [section]
@ -27,6 +22,5 @@ Search for a string in the context history and select that entry.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# contextunwatch
```text
usage: contextunwatch [-h] num
@ -26,6 +21,5 @@ Removes an expression previously added to be watched.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# contextwatch
```text
usage: contextwatch [-h] [{eval,execute}] expression
@ -29,6 +24,5 @@ To remove an expression, see `cunwatch`.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# regs
```text
usage: regs [-h] [regs ...]
@ -24,6 +19,5 @@ Print out all registers and enhance the information.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# dev-dump-instruction
```text
usage: dev-dump-instruction [-h] [-e] [-n] [address]
@ -26,6 +21,5 @@ Dump internal PwndbgInstruction attributes.
|-e|--emulate|Force the use of emulation when enhancing the instruction, regardless of global 'emulate' setting.|
|-n|--no-emulate|Disable the use of emulation when enhancing the instruction, regardless of global 'emulate' setting.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# log-level
```text
usage: log-level [-h] [{debug,info,warning,error,critical}]
@ -24,6 +19,5 @@ Set the log level.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# emulate
```text
usage: emulate [-h] [pc] [lines]
@ -25,6 +20,5 @@ Like nearpc, but will emulate instructions from the current $PC forward.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# nearpc
```text
usage: nearpc [-h] [-e] [pc] [lines]
@ -28,6 +23,5 @@ Disassemble near a specified address.
|-h|--help|show this help message and exit|
|-e|--emulate|Whether to emulate instructions to find the next ones or just linearly disassemble.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# arena
```text
usage: arena [-h] [addr]
@ -26,6 +21,5 @@ Default to the current thread's arena.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# arenas
```text
usage: arenas [-h]
@ -18,6 +13,5 @@ List this process's arenas.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# bins
```text
usage: bins [-h] [addr] [tcache_addr]
@ -27,6 +22,5 @@ Default to the current thread's arena and tcache.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# fastbins
```text
usage: fastbins [-h] [-v] [addr]
@ -27,6 +22,5 @@ Default to the current thread's arena.
|-h|--help|show this help message and exit|
|-v|--verbose|Show all fastbins, including empty ones|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# find-fake-fast
```text
usage: find-fake-fast [-h] [--align] [--glibc-fastbin-bug]
[--partial-overwrite]
@ -30,6 +25,5 @@ Find candidate fake fast or tcache chunks overlapping the specified address.
|-b|--glibc-fastbin-bug|Does the GLIBC fastbin size field bug affect the candidate size field width?|
|-p|--partial-overwrite|Consider partial overwrite candidates, default behavior only shows word-size overwrites.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# heap
```text
usage: heap [-h] [-v] [-s] [addr]
@ -28,6 +23,5 @@ Default to the current thread's active heap.
|-v|--verbose|Print all chunk fields, even unused ones.|
|-s|--simple|Simply print malloc_chunk struct's contents.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# hi
```text
usage: hi [-h] [-v] [-s] [-f] addr
@ -27,6 +22,5 @@ Searches all heaps to find if an address belongs to a chunk. If yes, prints the
|-s|--simple|Simply print malloc_chunk struct's contents.|
|-f|--fake|Allow fake chunks. If set, displays any memory as a heap chunk (even if its not a real chunk).|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# largebins
```text
usage: largebins [-h] [-v] [addr]
@ -27,6 +22,5 @@ Default to the current thread's arena.
|-h|--help|show this help message and exit|
|-v|--verbose|Show all largebins, including empty ones|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# malloc-chunk
```text
usage: malloc-chunk [-h] [-f] [-v] [-s] [-d] [-n NEXT] addr
@ -29,6 +24,5 @@ Print a chunk.
|-d|--dump|Print a hexdump of the chunk.|
|-n|--next|Print the next N chunks after the specified address. (default: 0)|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# mp
```text
usage: mp [-h]
@ -18,6 +13,5 @@ Print the mp_ struct's contents.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# smallbins
```text
usage: smallbins [-h] [-v] [addr]
@ -27,6 +22,5 @@ Default to the current thread's arena.
|-h|--help|show this help message and exit|
|-v|--verbose|Show all smallbins, including empty ones|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# tcache
```text
usage: tcache [-h] [addr]
@ -26,6 +21,5 @@ Default to the current thread's tcache.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# tcachebins
```text
usage: tcachebins [-h] [-v] [addr]
@ -27,6 +22,5 @@ Default to the current thread's tcache.
|-h|--help|show this help message and exit|
|-v|--verbose|Show all tcachebins, including empty ones|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# top-chunk
```text
usage: top-chunk [-h] [addr]
@ -26,6 +21,5 @@ Default to current thread's arena.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# try-free
```text
usage: try-free [-h] addr
@ -24,6 +19,5 @@ Check what would happen if free was called with given address.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# unsortedbin
```text
usage: unsortedbin [-h] [-v] [addr]
@ -27,6 +22,5 @@ Default to the current thread's arena.
|-h|--help|show this help message and exit|
|-v|--verbose|Show the "all" bin even if it's empty|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# vis-heap-chunks
```text
usage: vis-heap-chunks [-h] [--beyond_top] [--no_truncate] [--all_chunks]
[count] [addr]
@ -33,6 +28,5 @@ Default to the current arena's active heap.
|-n|--no_truncate|Display all the chunk contents (Ignore the `max-visualize-chunk-size` configuration).|
|-a|--all_chunks| Display all chunks (Ignore the default-visualize-chunk-number configuration).|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# ai
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: ai [-h] [-M MODEL] [-t TEMPERATURE] [-m MAX_TOKENS] [-v] [-L]
@ -32,6 +28,5 @@ Ask GPT-3 a question about the current debugging context.
|-L|--list-models|List the available models.|
|-c|--command|Run a command in the GDB debugger and ask a question about the output.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# bn-sync
```text
usage: bn-sync [-h]
@ -20,6 +15,5 @@ Synchronize Binary Ninja's cursor with GDB.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# decomp
```text
usage: decomp [-h] [addr] [lines]
@ -25,6 +20,5 @@ Use the current integration to decompile code near an address.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# j
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: j [-h]
@ -18,6 +14,5 @@ Synchronize IDA's cursor with GDB.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# r2
```text
usage: r2 [-h] [--no-seek] [--no-rebase] [arguments ...]

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# r2pipe
```text
usage: r2pipe [-h] arguments [arguments ...]

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# rop
```text
usage: rop [-h] [--grep GREP] [--memlimit MEMLIMIT] [argument ...]

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# ropper
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: ropper [-h] [argument ...]

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# rz
```text
usage: rz [-h] [--no-seek] [--no-rebase] [arguments ...]

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# rzpipe
```text
usage: rzpipe [-h] arguments [arguments ...]

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# save-ida
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: save-ida [-h]
@ -18,6 +14,5 @@ Save the ida database.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# jemalloc-extent-info
```text
usage: jemalloc-extent-info [-h] [-v] addr
@ -25,6 +20,5 @@ Prints extent information for the given address
|-h|--help|show this help message and exit|
|-v|--verbose|Print all chunk fields, even unused ones.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# jemalloc-find-extent
```text
usage: jemalloc-find-extent [-h] addr
@ -24,6 +19,5 @@ Returns extent information for pointer address allocated by jemalloc
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# jemalloc-heap
```text
usage: jemalloc-heap [-h]
@ -18,6 +13,5 @@ Prints all extents information
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# binder
```text
usage: binder [-h]
@ -18,6 +13,5 @@ Show Android Binder information
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# buddydump
```text
usage: buddydump [-h] [-z {DMA,DMA32,Normal,HighMem,Movable,Device}]
[-o ORDER]
@ -28,6 +23,5 @@ Displays metadata and freelists of the buddy allocator.
|-n|--node| (default: 0)|
|-f|--find|The address to find in page free lists.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# kbase
```text
usage: kbase [-h] [-r]
@ -19,6 +14,5 @@ Finds the kernel virtual base address.
|-h|--help|show this help message and exit|
|-r|--rebase|rebase loaded symbol file|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# kchecksec
```text
usage: kchecksec [-h]
@ -18,6 +13,5 @@ Checks for kernel hardening configuration options.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# kcmdline
```text
usage: kcmdline [-h]
@ -18,6 +13,5 @@ Return the kernel commandline (/proc/cmdline).
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# kconfig
```text
usage: kconfig [-h] [config_name]
@ -24,6 +19,5 @@ Outputs the kernel config (requires CONFIG_IKCONFIG).
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# klookup
```text
usage: klookup [-h] symbol
@ -24,6 +19,5 @@ Lookup kernel symbols
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-dump
```text
usage: knft-dump [-h] [nsid]
@ -24,6 +19,5 @@ Dump all nftables: tables, chains, rules, expressions
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-chains
```text
usage: knft-list-chains [-h] [--nsid NSID] [table_family] [table_name]
@ -26,6 +21,5 @@ Dump netfilter chains form a specific table
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-exprs
```text
usage: knft-list-exprs [-h] [--nsid NSID]
[table_family] [table_name] [chain_name] [rule_id]
@ -29,6 +24,5 @@ Dump only expressions from specific rule
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-flowtables
```text
usage: knft-list-flowtables [-h] [--nsid NSID] [table_family] [table_name]
@ -26,6 +21,5 @@ Dump netfilter flowtables from a specific table
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-objects
```text
usage: knft-list-objects [-h] [--nsid NSID] [table_family] [table_name]
@ -26,6 +21,5 @@ Dump netfilter objects from a specific table
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-rules
```text
usage: knft-list-rules [-h] [--nsid NSID]
[table_family] [table_name] [chain_name]
@ -28,6 +23,5 @@ Dump netfilter rules form a specific chain
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-sets
```text
usage: knft-list-sets [-h] [--nsid NSID] [table_family] [table_name]
@ -26,6 +21,5 @@ Dump netfilter sets from a specific table
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# knft-list-tables
```text
usage: knft-list-tables [-h] [--nsid NSID]
@ -19,6 +14,5 @@ Dump netfliter tables from a specific network namespace
|-h|--help|show this help message and exit|
|-n|--nsid|Network Namespace ID|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# kversion
```text
usage: kversion [-h]
@ -18,6 +13,5 @@ Outputs the kernel version (/proc/version).
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# msr
```text
usage: msr [-h] [-w [write_value]] [-l] [-r [MSR_RANGE]] [msr]
@ -27,6 +22,5 @@ Read or write to Model Specific Register (MSR)
|-l|--list|list common MSRs for the current arch|
|-r|--range|dash separated range of MSRs to read (eg. --range=1-10 where 10 is included)|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# slab
```text
usage: slab [-h] {list,info,contains} ...
@ -24,6 +19,5 @@ Prints information about the slab allocator
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# argc
```text
usage: argc [-h]
@ -18,6 +13,5 @@ Prints out the number of arguments.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# argv
```text
usage: argv [-h] [i]
@ -24,6 +19,5 @@ Prints out the contents of argv.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# aslr
```text
usage: aslr [-h] [{on,off}]
@ -26,6 +21,5 @@ Does not take effect until the program is restarted.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# auxv-explore
```text
usage: auxv-explore [-h]
@ -18,6 +13,5 @@ Explore and print information from the Auxiliary ELF Vector.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# auxv
```text
usage: auxv [-h]
@ -18,6 +13,5 @@ Print information from the Auxiliary ELF Vector.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# elfsections
```text
usage: elfsections [-h]
@ -18,6 +13,5 @@ Prints the section mappings contained in the ELF header.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# envp
```text
usage: envp [-h] [name]
@ -26,6 +21,5 @@ Prints out the contents of the environment.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# errno
```text
usage: errno [-h] [err]
@ -24,6 +19,5 @@ Converts errno (or argument) to its string representation.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# got
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: got [-h] [-p PATH_FILTER | -a] [-r] [symbol_filter]
@ -33,6 +29,5 @@ Examples:
|-a|--all|Process all libs/obfjiles including the target executable.|
|-r|--show-readonly|Also display read-only entries (which are filtered out by default).|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# gotplt
```text
usage: gotplt [-h]
@ -18,6 +13,5 @@ Prints any symbols found in the .got.plt section if it exists.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# libcinfo
```text
usage: libcinfo [-h]
@ -18,6 +13,5 @@ Show libc version and link to its sources
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# linkmap
```text
usage: linkmap [-h]
@ -18,6 +13,5 @@ Show the state of the Link Map
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# onegadget
```text
usage: onegadget [-h] [--show-unsat] [--no-unknown] [-v]
@ -23,6 +18,5 @@ Uses the onegadget tool by david942j.
||--no-unknown|Do not show unknown gadgets.|
|-v|--verbose|Show verbose output.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# piebase
```text
usage: piebase [-h] [offset] [module]
@ -25,6 +20,5 @@ Calculate VA of RVA from PIE base.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# plt
```text
usage: plt [-h]
@ -18,6 +13,5 @@ Prints any symbols found in Procedure Linkage Table sections if any exist.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# strings
```text
usage: strings [-h] [-n N] [--save-as SAVE_AS] [page_names ...]
@ -26,6 +21,5 @@ Extracts and displays ASCII strings from readable memory pages of the debugged p
|-n||Minimum length of ASCII strings to include (default: 4)|
||--save-as|Sets the filename for the output of this command [e.g. --save-as='out.txt']|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# threads
```text
usage: threads [-h] [-c] [num_threads]
@ -25,6 +20,5 @@ List all threads belonging to the selected inferior.
|-h|--help|show this help message and exit|
|-c|--config|Respect context-max-threads config to limit number of threads displayed.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# tls
```text
usage: tls [-h] [-p] [-a]
@ -20,6 +15,5 @@ Print out base address of the current Thread Local Storage (TLS).
|-p|--pthread-self|Try to get the address of TLS by calling pthread_self().|
|-a|--all|Do not truncate the dump output.|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# track-got
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: track-got [-h] {enable,disable,info,query} ...
@ -18,6 +14,5 @@ Controls GOT tracking
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,10 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# track-heap
<small style="color: lightgray;">(only in GDB)</small>
```text
usage: track-heap [-h] {enable,disable,toggle-break} ...
@ -24,6 +20,5 @@ Currently, the following errors can be detected:
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# distance
```text
usage: distance [-h] a [b]
@ -25,6 +20,5 @@ Print the distance between the two arguments, or print the offset to the address
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# dump-register-frame
```text
usage: dump-register-frame [-h] [-p]
{armcm-exception,armcm-exception2} [address]
@ -27,6 +22,5 @@ Display the registers saved to memory for a certain frame type
|-h|--help|show this help message and exit|
|-p|--print|Show addresses of frame values|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# gdt
```text
usage: gdt [-h] address [count]
@ -32,6 +27,5 @@ In 64-bit mode, the Base and Limit values are ignored, each descriptor covers th
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# go-dump
```text
usage: go-dump [-h] [-x] [-f [DECIMALS]] [-d] [-p] ty address
@ -31,6 +26,5 @@ Dumps a Go value of a given type at a specified address.
|-d|--debug|Shows debug info, like addresses for slice/map elements, slice capacity, etc.|
|-p|--pretty|Enables pretty printing|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# go-type
```text
usage: go-type [-h] address
@ -26,6 +21,5 @@ Dumps a Go runtime reflection type at a specified address.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# hexdump
```text
usage: hexdump [-h] [address] [count]
@ -25,6 +20,5 @@ Hexdumps data at the specified address or module name.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# leakfind
```text
usage: leakfind [-h] [-p [PAGE_NAME]] [-o [MAX_OFFSET]] [-d [MAX_DEPTH]]
[-s [STEP]] [--negative_offset [NEGATIVE_OFFSET]]
@ -34,6 +29,5 @@ Example: leakfind $rsp --page_name=filename --max_offset=0x48 --max_depth=6. Thi
|-s|--step|Step to add between pointers so they are considered. For example, if this is 4 it would only consider pointers at an offset divisible by 4 from the starting pointer (default: 1)|
||--negative_offset|Max negative offset to search before an address when looking for a leak (default: 0)|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# memfrob
```text
usage: memfrob [-h] address count
@ -25,6 +20,5 @@ Memfrobs a region of memory (xor with '*').
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# mmap
```text
usage: mmap [-h] [--quiet] [--force] addr length [prot] [flags] [fd] [offset]
@ -56,6 +51,5 @@ Examples:
|-q|--quiet|Disable address validity warnings and hints|
|-f|--force|Force potentially unsafe actions to happen|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# mprotect
```text
usage: mprotect [-h] addr length prot
@ -36,6 +31,5 @@ Examples:
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# p2p
```text
usage: p2p [-h] mapping_names [mapping_names ...]
@ -26,6 +21,5 @@ Any chain length greater than 0 is valid. If only one mapping is given it just l
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# probeleak
```text
usage: probeleak [-h] [--max-distance MAX_DISTANCE] [--point-to POINT_TO]
[--max-ptrs MAX_PTRS] [--flags FLAGS]
@ -35,6 +30,5 @@ Examples:
||--max-ptrs|Stop search after find n pointers, default 0 (default: 0)|
||--flags|flags of the page that you want the pointers point to. [e.g. rwx]|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# search
```text
usage: search [-h] [-t {byte,short,word,dword,qword,pointer,string,bytes,asm}]
[-1] [-2] [-4] [-8] [-p] [--asm]
@ -51,6 +46,5 @@ By default search results are cached. If you want to cache all results, but only
|-n|--next|Search only locations returned by previous search with --save|
||--trunc-out|Truncate the output to 20 results. Differs from --limit in that it will first save all search results|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# telescope
```text
usage: telescope [-h] [-r] [-f] [-i] [address] [count]
@ -28,6 +23,5 @@ Recursively dereferences pointers starting at the specified address.
|-f|--frame|Show the stack frame, from rsp to rbp|
|-i|--inverse|Show the stack reverse growth|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

@ -1,11 +1,6 @@
<!-- THIS PART OF THIS FILE IS AUTOGENERATED. DO NOT MODIFY IT. See scripts/generate-docs.sh -->
# vmmap-add
```text
usage: vmmap-add [-h] start size [flags] [offset]
@ -27,6 +22,5 @@ Add virtual memory map page.
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
<!-- END OF AUTOGENERATED PART. Do not modify this line or the line below, they mark the end of the auto-generated part of the file. If you want to extend the documentation in a way which cannot easily be done by adding to the command help description, write below the following line. -->
<!-- ------------\>8---- ----\>8---- ----\>8------------ -->

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save