lyc
/
pwndbg
mirror of https://github.com/pwndbg/pwndbg.git
1
0
Fork 0
Code Releases Activity

Visually spruce up command/function docs (#2959)

Browse Source 
* visually spruce up docs a bit

* autogen docs
pull/2967/head
k4lizen 7 months ago committed by GitHub
parent d19367083f
commit eac203cf10
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
191 changed files with 949 additions and 1715 deletions
Show Stats Download Patch File Download Diff File

14
docs/commands/breakpoint/break-if-not-taken.md
Unescape View File

@ -5,24 +5,20 @@
# break-if-not-taken
## Description
Breaks on a branch if it is not taken.
## Usage
```bash
```text
usage: break-if-not-taken [-h] branch
```
## Positional Arguments
Breaks on a branch if it is not taken.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|branch|The branch instruction to break on.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/breakpoint/break-if-taken.md
Unescape View File

@ -5,24 +5,20 @@
# break-if-taken
## Description
Breaks on a branch if it is taken.
## Usage
```bash
```text
usage: break-if-taken [-h] branch
```
## Positional Arguments
Breaks on a branch if it is taken.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|branch|The branch instruction to break on.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/breakpoint/breakrva.md
Unescape View File

@ -5,25 +5,21 @@
# breakrva
## Description
Break at RVA from PIE base.
## Usage
```bash
```text
usage: breakrva [-h] [offset] [module]
```
## Positional Arguments
Break at RVA from PIE base.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|offset|Offset to add. (default: 0)|
|module|Module to choose as base. Defaults to the target executable. (default: '')|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/breakpoint/ignore.md
Unescape View File

@ -5,29 +5,25 @@
# ignore
## Description
```text
usage: ignore [-h] [N] COUNT
```
Set ignore-count of breakpoint number N to COUNT.
While the ignore count is positive, execution will not stop on the breakpoint.
By default, if `N' is ommitted, the last breakpoint (i.e. greatest breakpoint number) will be used.
## Usage
```bash
usage: ignore [-h] [N] COUNT
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|bpnum|The breakpoint number N.|
|count|The number to set COUNT.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/context.md
Unescape View File

@ -5,24 +5,20 @@
# context
## Description
Print out the current register, instruction, and stack context.
## Usage
```bash
```text
usage: context [-h] [--on] [--off] [subcontext ...]
```
## Positional Arguments
Print out the current register, instruction, and stack context.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|subcontext|Submenu to display: 'regs', 'disasm', 'code', 'stack', 'backtrace', 'ghidra', 'args', 'threads', 'heap_tracker', 'expressions', and/or 'last_signal'|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/contextnext.md
Unescape View File

@ -5,24 +5,20 @@
# contextnext
## Description
Select next entry in context history.
## Usage
```bash
```text
usage: contextnext [-h] [count]
```
## Positional Arguments
Select next entry in context history.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|count|The number of entries to go forward in history (default: 1)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/contextoutput.md
Unescape View File

@ -5,18 +5,14 @@
# contextoutput
## Description
Sets the output of a context section.
## Usage
```bash
```text
usage: contextoutput [-h] section path clearing [banner] [width]
```
## Positional Arguments
Sets the output of a context section.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
@ -26,7 +22,7 @@ usage: contextoutput [-h] section path clearing [banner] [width]
|banner|Where a banner should be placed: both, top , bottom, none (default: 'both')|
|width|Sets a fixed width (used for banner). Set to None for auto|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/contextprev.md
Unescape View File

@ -5,24 +5,20 @@
# contextprev
## Description
Select previous entry in context history.
## Usage
```bash
```text
usage: contextprev [-h] [count]
```
## Positional Arguments
Select previous entry in context history.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|count|The number of entries to go back in history (default: 1)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/contextsearch.md
Unescape View File

@ -5,25 +5,21 @@
# contextsearch
## Description
Search for a string in the context history and select that entry.
## Usage
```bash
```text
usage: contextsearch [-h] needle [section]
```
## Positional Arguments
Search for a string in the context history and select that entry.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|needle|The string to search for in the context history|
|section|The section to search in. If not provided, search in all sections|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/contextunwatch.md
Unescape View File

@ -5,24 +5,20 @@
# contextunwatch
## Description
Removes an expression previously added to be watched.
## Usage
```bash
```text
usage: contextunwatch [-h] num
```
## Positional Arguments
Removes an expression previously added to be watched.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|num|The expression number to be removed from context|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/context/contextwatch.md
Unescape View File

@ -5,27 +5,23 @@
# contextwatch
## Description
```text
usage: contextwatch [-h] [{eval,execute}] expression
```
Adds an expression to be shown on context.
To remove an expression, see `cunwatch`.
## Usage
```bash
usage: contextwatch [-h] [{eval,execute}] expression
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|cmd|Command to be used with the expression. - eval: the expression is parsed and evaluated as in the debugged language. - execute: the expression is executed as a GDB command. (default: 'eval')|
|expression|The expression to be evaluated and shown in context|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/context/regs.md
Unescape View File

@ -5,24 +5,20 @@
# regs
## Description
Print out all registers and enhance the information.
## Usage
```bash
```text
usage: regs [-h] [regs ...]
```
## Positional Arguments
Print out all registers and enhance the information.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|regs|Registers to be shown|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/developer/dev-dump-instruction.md
Unescape View File

@ -5,24 +5,20 @@
# dev-dump-instruction
## Description
Dump internal PwndbgInstruction attributes.
## Usage
```bash
```text
usage: dev-dump-instruction [-h] [-e] [-n] [address]
```
## Positional Arguments
Dump internal PwndbgInstruction attributes.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|The address to get the enhanced instruction from - must be in cache.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/developer/log-level.md
Unescape View File

@ -5,24 +5,20 @@
# log-level
## Description
Set the log level.
## Usage
```bash
```text
usage: log-level [-h] [{debug,info,warning,error,critical}]
```
## Positional Arguments
Set the log level.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|level|The log level to set. (default: 'warning')|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/disassemble/emulate.md
Unescape View File

@ -5,25 +5,21 @@
# emulate
## Description
Like nearpc, but will emulate instructions from the current $PC forward.
## Usage
```bash
```text
usage: emulate [-h] [pc] [lines]
```
## Positional Arguments
Like nearpc, but will emulate instructions from the current $PC forward.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|pc|Address to emulate near.|
|lines|Number of lines to show on either side of the address.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/disassemble/nearpc.md
Unescape View File

@ -5,25 +5,21 @@
# nearpc
## Description
Disassemble near a specified address.
## Usage
```bash
```text
usage: nearpc [-h] [-e] [pc] [lines]
```
## Positional Arguments
Disassemble near a specified address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|pc|Address to disassemble near. If this is the only argument and the value provided is small enough, it is interpreted as lines instead.|
|lines|Number of lines to show on either side of the address.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/arena.md
Unescape View File

@ -5,26 +5,22 @@
# arena
## Description
```text
usage: arena [-h] [addr]
```
Print the contents of an arena.
Default to the current thread's arena.
## Usage
```bash
usage: arena [-h] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/glibc_ptmalloc2_heap/arenas.md
Unescape View File

@ -5,18 +5,14 @@
# arenas
## Description
List this process's arenas.
## Usage
```bash
```text
usage: arenas [-h]
```
## Optional Arguments
List this process's arenas.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/bins.md
Unescape View File

@ -5,27 +5,23 @@
# bins
## Description
```text
usage: bins [-h] [addr] [tcache_addr]
```
Print the contents of all an arena's bins and a thread's tcache.
Default to the current thread's arena and tcache.
## Usage
```bash
usage: bins [-h] [addr] [tcache_addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
|tcache_addr|Address of the tcache.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/fastbins.md
Unescape View File

@ -5,26 +5,22 @@
# fastbins
## Description
```text
usage: fastbins [-h] [-v] [addr]
```
Print the contents of an arena's fastbins.
Default to the current thread's arena.
## Usage
```bash
usage: fastbins [-h] [-v] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/glibc_ptmalloc2_heap/find-fake-fast.md
Unescape View File

@ -5,27 +5,23 @@
# find-fake-fast
## Description
Find candidate fake fast or tcache chunks overlapping the specified address.
## Usage
```bash
```text
usage: find-fake-fast [-h] [--align] [--glibc-fastbin-bug]
[--partial-overwrite]
target_address [max_candidate_size]
```
## Positional Arguments
Find candidate fake fast or tcache chunks overlapping the specified address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|target_address|Address of the word-sized value to overlap.|
|max_candidate_size|Maximum size of fake chunks to find.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/heap.md
Unescape View File

@ -5,26 +5,22 @@
# heap
## Description
```text
usage: heap [-h] [-v] [-s] [addr]
```
Iteratively print chunks on a heap.
Default to the current thread's active heap.
## Usage
```bash
usage: heap [-h] [-v] [-s] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the first chunk (malloc_chunk struct start, prev_size field).|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/glibc_ptmalloc2_heap/hi.md
Unescape View File

@ -5,24 +5,20 @@
# hi
## Description
Searches all heaps to find if an address belongs to a chunk. If yes, prints the chunk.
## Usage
```bash
```text
usage: hi [-h] [-v] [-s] [-f] addr
```
## Positional Arguments
Searches all heaps to find if an address belongs to a chunk. If yes, prints the chunk.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the interest.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/largebins.md
Unescape View File

@ -5,26 +5,22 @@
# largebins
## Description
```text
usage: largebins [-h] [-v] [addr]
```
Print the contents of an arena's largebins.
Default to the current thread's arena.
## Usage
```bash
usage: largebins [-h] [-v] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/glibc_ptmalloc2_heap/malloc-chunk.md
Unescape View File

@ -5,24 +5,20 @@
# malloc-chunk
## Description
Print a chunk.
## Usage
```bash
```text
usage: malloc-chunk [-h] [-f] [-v] [-s] [-d] [-n NEXT] addr
```
## Positional Arguments
Print a chunk.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the chunk (malloc_chunk struct start, prev_size field).|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/glibc_ptmalloc2_heap/mp.md
Unescape View File

@ -5,18 +5,14 @@
# mp
## Description
Print the mp_ struct's contents.
## Usage
```bash
```text
usage: mp [-h]
```
## Optional Arguments
Print the mp_ struct's contents.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/smallbins.md
Unescape View File

@ -5,26 +5,22 @@
# smallbins
## Description
```text
usage: smallbins [-h] [-v] [addr]
```
Print the contents of an arena's smallbins.
Default to the current thread's arena.
## Usage
```bash
usage: smallbins [-h] [-v] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/tcache.md
Unescape View File

@ -5,26 +5,22 @@
# tcache
## Description
```text
usage: tcache [-h] [addr]
```
Print a thread's tcache contents.
Default to the current thread's tcache.
## Usage
```bash
usage: tcache [-h] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the tcache.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/tcachebins.md
Unescape View File

@ -5,26 +5,22 @@
# tcachebins
## Description
```text
usage: tcachebins [-h] [-v] [addr]
```
Print the contents of a tcache.
Default to the current thread's tcache.
## Usage
```bash
usage: tcachebins [-h] [-v] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|The address of the tcache bins.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/top-chunk.md
Unescape View File

@ -5,26 +5,22 @@
# top-chunk
## Description
```text
usage: top-chunk [-h] [addr]
```
Print relevant information about an arena's top chunk.
Default to current thread's arena.
## Usage
```bash
usage: top-chunk [-h] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/glibc_ptmalloc2_heap/try-free.md
Unescape View File

@ -5,24 +5,20 @@
# try-free
## Description
Check what would happen if free was called with given address.
## Usage
```bash
```text
usage: try-free [-h] addr
```
## Positional Arguments
Check what would happen if free was called with given address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address passed to free|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/glibc_ptmalloc2_heap/unsortedbin.md
Unescape View File

@ -5,26 +5,22 @@
# unsortedbin
## Description
```text
usage: unsortedbin [-h] [-v] [addr]
```
Print the contents of an arena's unsortedbin.
Default to the current thread's arena.
## Usage
```bash
usage: unsortedbin [-h] [-v] [addr]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the arena.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

18
docs/commands/glibc_ptmalloc2_heap/vis-heap-chunks.md
Unescape View File

@ -5,28 +5,24 @@
# vis-heap-chunks
## Description
Visualize chunks on a heap.
Default to the current arena's active heap.
## Usage
```bash
```text
usage: vis-heap-chunks [-h] [--beyond_top] [--no_truncate] [--all_chunks]
[count] [addr]
```
## Positional Arguments
Visualize chunks on a heap.
Default to the current arena's active heap.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|count|Number of chunks to visualize. If the value is big enough and addr isn't provided, this is interpreted as addr instead. (default: 10)|
|addr|Address of the first chunk.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/integrations/ai.md
Unescape View File

@ -5,26 +5,22 @@
# ai
## Description
Ask GPT-3 a question about the current debugging context.
## Usage
```bash
```text
usage: ai [-h] [-M MODEL] [-t TEMPERATURE] [-m MAX_TOKENS] [-v] [-L]
[-c COMMAND]
[question ...]
```
## Positional Arguments
Ask GPT-3 a question about the current debugging context.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|question|The question to ask.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/integrations/bn-sync.md
Unescape View File

@ -5,18 +5,14 @@
# bn-sync
## Description
Synchronize Binary Ninja's cursor with GDB.
## Usage
```bash
```text
usage: bn-sync [-h]
```
## Optional Arguments
Synchronize Binary Ninja's cursor with GDB.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/integrations/decomp.md
Unescape View File

@ -5,25 +5,21 @@
# decomp
## Description
Use the current integration to decompile code near an address.
## Usage
```bash
```text
usage: decomp [-h] [addr] [lines]
```
## Positional Arguments
Use the current integration to decompile code near an address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address to decompile near.|
|lines|Number of lines of decompilation to show.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/integrations/j.md
Unescape View File

@ -5,18 +5,14 @@
# j
## Description
Synchronize IDA's cursor with GDB.
## Usage
```bash
```text
usage: j [-h]
```
## Optional Arguments
Synchronize IDA's cursor with GDB.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/integrations/r2.md
Unescape View File

@ -5,24 +5,20 @@
# r2
## Description
Launches radare2.
## Usage
```bash
```text
usage: r2 [-h] [--no-seek] [--no-rebase] [arguments ...]
```
## Positional Arguments
Launches radare2.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|arguments|Arguments to pass to radare|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |
@ -30,7 +26,7 @@ usage: r2 [-h] [--no-seek] [--no-rebase] [arguments ...]
||--no-seek|Do not seek to current pc|
||--no-rebase|Do not set the base address for PIE according to the current mapping|
## Examples
### Examples
```text
pwndbg> r2 -- -S -AA
WARN: Relocs has not been applied. Please use `-e bin.relocs.apply=true` or `-e bin.cache=true` next time

16
docs/commands/integrations/r2pipe.md
Unescape View File

@ -5,30 +5,26 @@
# r2pipe
## Description
Execute stateful radare2 commands through r2pipe.
## Usage
```bash
```text
usage: r2pipe [-h] arguments [arguments ...]
```
## Positional Arguments
Execute stateful radare2 commands through r2pipe.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|arguments|Arguments to pass to r2pipe|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
## Examples
### Examples
```text
pwndbg> r2pipe pdf @ sym.main
; ICOD XREF from entry0 @ 0x1d3e8(r)

16
docs/commands/integrations/rop.md
Unescape View File

@ -5,24 +5,20 @@
# rop
## Description
Dump ROP gadgets with Jon Salwan's ROPgadget tool.
## Usage
```bash
```text
usage: rop [-h] [--grep GREP] [--memlimit MEMLIMIT] [argument ...]
```
## Positional Arguments
Dump ROP gadgets with Jon Salwan's ROPgadget tool.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|argument|Arguments to pass to ROPgadget|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |
@ -30,7 +26,7 @@ usage: rop [-h] [--grep GREP] [--memlimit MEMLIMIT] [argument ...]
||--grep|String to grep the output for|
||--memlimit|String to grep the output for (default: '50MB')|
## Examples
### Examples
```text
pwndbg> rop --grep 'pop rdi' -- --nojop
Gadgets information

16
docs/commands/integrations/ropper.md
Unescape View File

@ -5,30 +5,26 @@
# ropper
## Description
ROP gadget search with ropper.
## Usage
```bash
```text
usage: ropper [-h] [argument ...]
```
## Positional Arguments
ROP gadget search with ropper.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|argument|Arguments to pass to ropper|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
## Examples
### Examples
```text
pwndbg> ropper -- --console
[INFO] Load gadgets from cache

16
docs/commands/integrations/rz.md
Unescape View File

@ -5,24 +5,20 @@
# rz
## Description
Launches rizin.
## Usage
```bash
```text
usage: rz [-h] [--no-seek] [--no-rebase] [arguments ...]
```
## Positional Arguments
Launches rizin.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|arguments|Arguments to pass to rizin|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |
@ -30,7 +26,7 @@ usage: rz [-h] [--no-seek] [--no-rebase] [arguments ...]
||--no-seek|Do not seek to current pc|
||--no-rebase|Do not set the base address for PIE according to the current mapping|
## Examples
### Examples
```text
pwndbg> rz -- -AA
[x] Analyze all flags starting with sym. and entry0 (aa)

16
docs/commands/integrations/rzpipe.md
Unescape View File

@ -5,30 +5,26 @@
# rzpipe
## Description
Execute stateful rizin commands through rzpipe.
## Usage
```bash
```text
usage: rzpipe [-h] arguments [arguments ...]
```
## Positional Arguments
Execute stateful rizin commands through rzpipe.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|arguments|Arguments to pass to rzpipe|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |
|-h|--help|show this help message and exit|
## Examples
### Examples
```text
pwndbg> rzpipe pdf @ sym.main
; DATA XREF from entry0 @ 0x1d3e8

12
docs/commands/integrations/save-ida.md
Unescape View File

@ -5,18 +5,14 @@
# save-ida
## Description
Save the ida database.
## Usage
```bash
```text
usage: save-ida [-h]
```
## Optional Arguments
Save the ida database.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/jemalloc_heap/jemalloc-extent-info.md
Unescape View File

@ -5,24 +5,20 @@
# jemalloc-extent-info
## Description
Prints extent information for the given address
## Usage
```bash
```text
usage: jemalloc-extent-info [-h] [-v] addr
```
## Positional Arguments
Prints extent information for the given address
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the extent metadata|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/jemalloc_heap/jemalloc-find-extent.md
Unescape View File

@ -5,24 +5,20 @@
# jemalloc-find-extent
## Description
Returns extent information for pointer address allocated by jemalloc
## Usage
```bash
```text
usage: jemalloc-find-extent [-h] addr
```
## Positional Arguments
Returns extent information for pointer address allocated by jemalloc
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|addr|Address of the allocated memory location|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/jemalloc_heap/jemalloc-heap.md
Unescape View File

@ -5,18 +5,14 @@
# jemalloc-heap
## Description
Prints all extents information
## Usage
```bash
```text
usage: jemalloc-heap [-h]
```
## Optional Arguments
Prints all extents information
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/kernel/binder.md
Unescape View File

@ -5,18 +5,14 @@
# binder
## Description
Show Android Binder information
## Usage
```bash
```text
usage: binder [-h]
```
## Optional Arguments
Show Android Binder information
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/kernel/kbase.md
Unescape View File

@ -5,18 +5,14 @@
# kbase
## Description
Finds the kernel virtual base address.
## Usage
```bash
```text
usage: kbase [-h] [-r]
```
## Optional Arguments
Finds the kernel virtual base address.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/kernel/kchecksec.md
Unescape View File

@ -5,18 +5,14 @@
# kchecksec
## Description
Checks for kernel hardening configuration options.
## Usage
```bash
```text
usage: kchecksec [-h]
```
## Optional Arguments
Checks for kernel hardening configuration options.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/kernel/kcmdline.md
Unescape View File

@ -5,18 +5,14 @@
# kcmdline
## Description
Return the kernel commandline (/proc/cmdline).
## Usage
```bash
```text
usage: kcmdline [-h]
```
## Optional Arguments
Return the kernel commandline (/proc/cmdline).
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/kconfig.md
Unescape View File

@ -5,24 +5,20 @@
# kconfig
## Description
Outputs the kernel config (requires CONFIG_IKCONFIG).
## Usage
```bash
```text
usage: kconfig [-h] [config_name]
```
## Positional Arguments
Outputs the kernel config (requires CONFIG_IKCONFIG).
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|config_name|A config name to search for|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/klookup.md
Unescape View File

@ -5,24 +5,20 @@
# klookup
## Description
Lookup kernel symbols
## Usage
```bash
```text
usage: klookup [-h] symbol
```
## Positional Arguments
Lookup kernel symbols
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|symbol|Address or symbol name to lookup|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-dump.md
Unescape View File

@ -5,24 +5,20 @@
# knft-dump
## Description
Dump all nftables: tables, chains, rules, expressions
## Usage
```bash
```text
usage: knft-dump [-h] [nsid]
```
## Positional Arguments
Dump all nftables: tables, chains, rules, expressions
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|nsid|Network Namespace ID|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-list-chains.md
Unescape View File

@ -5,25 +5,21 @@
# knft-list-chains
## Description
Dump netfilter chains form a specific table
## Usage
```bash
```text
usage: knft-list-chains [-h] [--nsid NSID] [table_family] [table_name]
```
## Positional Arguments
Dump netfilter chains form a specific table
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|table_family|Netfilter table family (inet, ip, ip6, netdev, bridge, arp)|
|table_name|Table name|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-list-exprs.md
Unescape View File

@ -5,19 +5,15 @@
# knft-list-exprs
## Description
Dump only expressions from specific rule
## Usage
```bash
```text
usage: knft-list-exprs [-h] [--nsid NSID]
[table_family] [table_name] [chain_name] [rule_id]
```
## Positional Arguments
Dump only expressions from specific rule
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
@ -26,7 +22,7 @@ usage: knft-list-exprs [-h] [--nsid NSID]
|chain_name|Chain name|
|rule_id|Rule Handle ID|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-list-flowtables.md
Unescape View File

@ -5,25 +5,21 @@
# knft-list-flowtables
## Description
Dump netfilter flowtables from a specific table
## Usage
```bash
```text
usage: knft-list-flowtables [-h] [--nsid NSID] [table_family] [table_name]
```
## Positional Arguments
Dump netfilter flowtables from a specific table
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|table_family|Netfilter table family (inet, ip, ip6, netdev, bridge, arp)|
|table_name|Table name|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-list-objects.md
Unescape View File

@ -5,25 +5,21 @@
# knft-list-objects
## Description
Dump netfilter objects from a specific table
## Usage
```bash
```text
usage: knft-list-objects [-h] [--nsid NSID] [table_family] [table_name]
```
## Positional Arguments
Dump netfilter objects from a specific table
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|table_family|Table family, eg: inet, ip, ip6, netdev, bridge, arp|
|table_name|Table name|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-list-rules.md
Unescape View File

@ -5,19 +5,15 @@
# knft-list-rules
## Description
Dump netfilter rules form a specific chain
## Usage
```bash
```text
usage: knft-list-rules [-h] [--nsid NSID]
[table_family] [table_name] [chain_name]
```
## Positional Arguments
Dump netfilter rules form a specific chain
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
@ -25,7 +21,7 @@ usage: knft-list-rules [-h] [--nsid NSID]
|table_name|Table name|
|chain_name|Chain name|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/knft-list-sets.md
Unescape View File

@ -5,25 +5,21 @@
# knft-list-sets
## Description
Dump netfilter sets from a specific table
## Usage
```bash
```text
usage: knft-list-sets [-h] [--nsid NSID] [table_family] [table_name]
```
## Positional Arguments
Dump netfilter sets from a specific table
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|table_family|Table family, eg: inet, ip, ip6, netdev, bridge, arp|
|table_name|Table name|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/kernel/knft-list-tables.md
Unescape View File

@ -5,18 +5,14 @@
# knft-list-tables
## Description
Dump netfliter tables from a specific network namespace
## Usage
```bash
```text
usage: knft-list-tables [-h] [--nsid NSID]
```
## Optional Arguments
Dump netfliter tables from a specific network namespace
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/kernel/kversion.md
Unescape View File

@ -5,18 +5,14 @@
# kversion
## Description
Outputs the kernel version (/proc/version).
## Usage
```bash
```text
usage: kversion [-h]
```
## Optional Arguments
Outputs the kernel version (/proc/version).
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/pcplist.md
Unescape View File

@ -5,24 +5,20 @@
# pcplist
## Description
Print Per-CPU page list
## Usage
```bash
```text
usage: pcplist [-h] [zone]
```
## Positional Arguments
Print Per-CPU page list
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|zone||
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/kernel/slab.md
Unescape View File

@ -5,24 +5,20 @@
# slab
## Description
Prints information about the slab allocator
## Usage
```bash
```text
usage: slab [-h] {list,info,contains} ...
```
## Positional Arguments
Prints information about the slab allocator
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|command||
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/argc.md
Unescape View File

@ -5,18 +5,14 @@
# argc
## Description
Prints out the number of arguments.
## Usage
```bash
```text
usage: argc [-h]
```
## Optional Arguments
Prints out the number of arguments.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/argv.md
Unescape View File

@ -5,24 +5,20 @@
# argv
## Description
Prints out the contents of argv.
## Usage
```bash
```text
usage: argv [-h] [i]
```
## Positional Arguments
Prints out the contents of argv.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|i|Index of the argument to print out.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/linux_libc_elf/aslr.md
Unescape View File

@ -5,26 +5,22 @@
# aslr
## Description
```text
usage: aslr [-h] [{on,off}]
```
Check the current ASLR status, or turn it on/off.
Does not take effect until the program is restarted.
## Usage
```bash
usage: aslr [-h] [{on,off}]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|state|Turn ASLR on or off (takes effect when target is started)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/auxv-explore.md
Unescape View File

@ -5,18 +5,14 @@
# auxv-explore
## Description
Explore and print information from the Auxiliary ELF Vector.
## Usage
```bash
```text
usage: auxv-explore [-h]
```
## Optional Arguments
Explore and print information from the Auxiliary ELF Vector.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/auxv.md
Unescape View File

@ -5,18 +5,14 @@
# auxv
## Description
Print information from the Auxiliary ELF Vector.
## Usage
```bash
```text
usage: auxv [-h]
```
## Optional Arguments
Print information from the Auxiliary ELF Vector.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/elfsections.md
Unescape View File

@ -5,18 +5,14 @@
# elfsections
## Description
Prints the section mappings contained in the ELF header.
## Usage
```bash
```text
usage: elfsections [-h]
```
## Optional Arguments
Prints the section mappings contained in the ELF header.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/envp.md
Unescape View File

@ -5,24 +5,20 @@
# envp
## Description
Prints out the contents of the environment.
## Usage
```bash
```text
usage: envp [-h] [name]
```
## Positional Arguments
Prints out the contents of the environment.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|name|Name of the environment variable to see.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/errno.md
Unescape View File

@ -5,24 +5,20 @@
# errno
## Description
Converts errno (or argument) to its string representation.
## Usage
```bash
```text
usage: errno [-h] [err]
```
## Positional Arguments
Converts errno (or argument) to its string representation.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|err|Errno; if not passed, it is retrieved from __errno_location|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/linux_libc_elf/got.md
Unescape View File

@ -5,8 +5,11 @@
# got
## Description
```text
usage: got [-h] [-p PATH_FILTER | -a] [-r] [symbol_filter]
```
Show the state of the Global Offset Table.
@ -15,20 +18,13 @@ Examples:
got puts
got -p libc
got -a
## Usage
```bash
usage: got [-h] [-p PATH_FILTER | -a] [-r] [symbol_filter]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|symbol_filter|Filter results by symbol name. (default: '')|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/gotplt.md
Unescape View File

@ -5,18 +5,14 @@
# gotplt
## Description
Prints any symbols found in the .got.plt section if it exists.
## Usage
```bash
```text
usage: gotplt [-h]
```
## Optional Arguments
Prints any symbols found in the .got.plt section if it exists.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/libcinfo.md
Unescape View File

@ -5,18 +5,14 @@
# libcinfo
## Description
Show libc version and link to its sources
## Usage
```bash
```text
usage: libcinfo [-h]
```
## Optional Arguments
Show libc version and link to its sources
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/linkmap.md
Unescape View File

@ -5,18 +5,14 @@
# linkmap
## Description
Show the state of the Link Map
## Usage
```bash
```text
usage: linkmap [-h]
```
## Optional Arguments
Show the state of the Link Map
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/onegadget.md
Unescape View File

@ -5,20 +5,16 @@
# onegadget
## Description
```text
usage: onegadget [-h] [--show-unsat] [--no-unknown] [-v]
```
Find gadgets which single-handedly give code execution.
Uses the onegadget tool by david942j.
## Usage
```bash
usage: onegadget [-h] [--show-unsat] [--no-unknown] [-v]
```
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/piebase.md
Unescape View File

@ -5,25 +5,21 @@
# piebase
## Description
Calculate VA of RVA from PIE base.
## Usage
```bash
```text
usage: piebase [-h] [offset] [module]
```
## Positional Arguments
Calculate VA of RVA from PIE base.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|offset|Offset from PIE base. (default: 0)|
|module|Module to choose as base. Defaults to the target executable. (default: '')|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/plt.md
Unescape View File

@ -5,18 +5,14 @@
# plt
## Description
Prints any symbols found in the .plt section if it exists.
## Usage
```bash
```text
usage: plt [-h]
```
## Optional Arguments
Prints any symbols found in the .plt section if it exists.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/strings.md
Unescape View File

@ -5,24 +5,20 @@
# strings
## Description
Extracts and displays ASCII strings from readable memory pages of the debugged process.
## Usage
```bash
```text
usage: strings [-h] [-n N] [--save-as SAVE_AS] [page_names ...]
```
## Positional Arguments
Extracts and displays ASCII strings from readable memory pages of the debugged process.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|page_names|Mapping to search [e.g. libc]. Can be used with multiple mappings [e.g libc heap stack] (default: '[]')|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/threads.md
Unescape View File

@ -5,24 +5,20 @@
# threads
## Description
List all threads belonging to the selected inferior.
## Usage
```bash
```text
usage: threads [-h] [-c] [num_threads]
```
## Positional Arguments
List all threads belonging to the selected inferior.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|num_threads|Number of threads to display. Omit to display all threads.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/tls.md
Unescape View File

@ -5,18 +5,14 @@
# tls
## Description
Print out base address of the current Thread Local Storage (TLS).
## Usage
```bash
```text
usage: tls [-h] [-p] [-a]
```
## Optional Arguments
Print out base address of the current Thread Local Storage (TLS).
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/linux_libc_elf/track-got.md
Unescape View File

@ -5,18 +5,14 @@
# track-got
## Description
Controls GOT tracking
## Usage
```bash
```text
usage: track-got [-h] {enable,disable,info,query} ...
```
## Optional Arguments
Controls GOT tracking
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/linux_libc_elf/track-heap.md
Unescape View File

@ -5,8 +5,11 @@
# track-heap
## Description
```text
usage: track-heap [-h] {enable,disable,toggle-break} ...
```
Manages the heap tracker.
@ -15,14 +18,7 @@ user errors such as double frees and use after frees.
Currently, the following errors can be detected:
- Use After Free
## Usage
```bash
usage: track-heap [-h] {enable,disable,toggle-break} ...
```
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/distance.md
Unescape View File

@ -5,25 +5,21 @@
# distance
## Description
Print the distance between the two arguments, or print the offset to the address's page base.
## Usage
```bash
```text
usage: distance [-h] a [b]
```
## Positional Arguments
Print the distance between the two arguments, or print the offset to the address's page base.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|a|The first address.|
|b|The second address.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/dump-register-frame.md
Unescape View File

@ -5,26 +5,22 @@
# dump-register-frame
## Description
Display the registers saved to memory for a certain frame type
## Usage
```bash
```text
usage: dump-register-frame [-h] [-p]
{armcm-exception,armcm-exception2} [address]
```
## Positional Arguments
Display the registers saved to memory for a certain frame type
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|frame_type|The type of frame to print|
|address|The address to read the frame from|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/memory/gdt.md
Unescape View File

@ -5,8 +5,11 @@
# gdt
## Description
```text
usage: gdt [-h] address [count]
```
Decode X86-64 GDT entries at address
@ -16,21 +19,14 @@ See also:
Note:
In 64-bit mode, the Base and Limit values are ignored, each descriptor covers the entire linear address space regardless of what they are set to.
## Usage
```bash
usage: gdt [-h] address [count]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|x86-64 GDTR base address (e.g. read from sgdt instruction from [16:79] bits)|
|count|Number of entries to dump (should be (GDTR.size+1)/8) (default: 8)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/go-dump.md
Unescape View File

@ -5,25 +5,21 @@
# go-dump
## Description
Dumps a Go value of a given type at a specified address.
## Usage
```bash
```text
usage: go-dump [-h] [-x] [-f [DECIMALS]] [-d] [-p] ty address
```
## Positional Arguments
Dumps a Go value of a given type at a specified address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|ty|Go type of value to dump, e.g. map[int]string, or the address of a type to resolve at runtime, e.g. 0x408860|
|address|Address to dump|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/go-type.md
Unescape View File

@ -5,24 +5,20 @@
# go-type
## Description
Dumps a Go runtime reflection type at a specified address.
## Usage
```bash
```text
usage: go-type [-h] address
```
## Positional Arguments
Dumps a Go runtime reflection type at a specified address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|Address to dump|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/hexdump.md
Unescape View File

@ -5,25 +5,21 @@
# hexdump
## Description
Hexdumps data at the specified address or module name.
## Usage
```bash
```text
usage: hexdump [-h] [address] [count]
```
## Positional Arguments
Hexdumps data at the specified address or module name.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|Address or module name to dump (default: $sp)|
|count|Number of bytes to dump (default: 64)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

20
docs/commands/memory/leakfind.md
Unescape View File

@ -5,29 +5,25 @@
# leakfind
## Description
Attempt to find a leak chain given a starting address.
Scans memory near the given address, looks for pointers, and continues that process to attempt to find leaks.
Example: leakfind $rsp --page_name=filename --max_offset=0x48 --max_depth=6. This would look for any chains of leaks that point to a section in filename which begin near $rsp, are never 0x48 bytes further from a known pointer, and are a maximum length of 6.
## Usage
```bash
```text
usage: leakfind [-h] [-p [PAGE_NAME]] [-o [MAX_OFFSET]] [-d [MAX_DEPTH]]
[-s [STEP]] [--negative_offset [NEGATIVE_OFFSET]]
[address]
```
## Positional Arguments
Attempt to find a leak chain given a starting address.
Scans memory near the given address, looks for pointers, and continues that process to attempt to find leaks.
Example: leakfind $rsp --page_name=filename --max_offset=0x48 --max_depth=6. This would look for any chains of leaks that point to a section in filename which begin near $rsp, are never 0x48 bytes further from a known pointer, and are a maximum length of 6.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|Starting address to find a leak chain from (default: $sp)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/memfrob.md
Unescape View File

@ -5,25 +5,21 @@
# memfrob
## Description
Memfrobs a region of memory (xor with '*').
## Usage
```bash
```text
usage: memfrob [-h] address count
```
## Positional Arguments
Memfrobs a region of memory (xor with '*').
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|The address to start xoring at.|
|count|The number of bytes to xor.|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/memory/mmap.md
Unescape View File

@ -5,8 +5,11 @@
# mmap
## Description
```text
usage: mmap [-h] [--quiet] [--force] addr length [prot] [flags] [fd] [offset]
```
Calls the mmap syscall and prints its resulting address.
@ -34,14 +37,7 @@ Examples:
mmap 0xdeadbeef 0x1000
- Maps a new private+anonymous page with RWX permissions at a page boundary
near 0xdeadbeef.
## Usage
```bash
usage: mmap [-h] [--quiet] [--force] addr length [prot] [flags] [fd] [offset]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
@ -52,7 +48,7 @@ usage: mmap [-h] [--quiet] [--force] addr length [prot] [flags] [fd] [offset]
|fd|File descriptor of the file to be mapped, or -1 if using MAP_ANONYMOUS. (default: -1)|
|offset|Offset from the start of the file, in bytes, if using file based mapping. (default: 0)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/memory/mprotect.md
Unescape View File

@ -5,8 +5,11 @@
# mprotect
## Description
```text
usage: mprotect [-h] addr length prot
```
Calls the mprotect syscall and prints its result value.
@ -19,14 +22,7 @@ Examples:
mprotect $rsp 4096 rwx
mprotect $rsp 4096 7
mprotect some_symbol 0x1000 PROT_NONE
## Usage
```bash
usage: mprotect [-h] addr length prot
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
@ -34,7 +30,7 @@ usage: mprotect [-h] addr length prot
|length|Count of bytes to call mprotect on. Needs to be multiple of page size.|
|prot|Prot string as in mprotect(2). Eg. "PROT_READ\|PROT_EXEC", "rx", or "5"|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

16
docs/commands/memory/p2p.md
Unescape View File

@ -5,26 +5,22 @@
# p2p
## Description
```text
usage: p2p [-h] mapping_names [mapping_names ...]
```
Pointer to pointer chain search. Searches given mapping for all pointers that point to specified mapping.
Any chain length greater than 0 is valid. If only one mapping is given it just looks for any pointers in that mapping.
## Usage
```bash
usage: p2p [-h] mapping_names [mapping_names ...]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|mapping_names|Mapping name |
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

20
docs/commands/memory/probeleak.md
Unescape View File

@ -5,31 +5,27 @@
# probeleak
## Description
```text
usage: probeleak [-h] [--max-distance MAX_DISTANCE] [--point-to POINT_TO]
[--max-ptrs MAX_PTRS] [--flags FLAGS]
[address] [count]
```
Pointer scan for possible offset leaks.
Examples:
probeleak $rsp 0x64 - leaks 0x64 bytes starting at stack pointer and search for valid pointers
probeleak $rsp 0x64 --max-dist 0x10 - as above, but pointers may point 0x10 bytes outside of memory page
probeleak $rsp 0x64 --point-to libc --max-ptrs 1 --flags rwx - leaks 0x64 bytes starting at stack pointer and search for one valid pointer which points to a libc rwx page
## Usage
```bash
usage: probeleak [-h] [--max-distance MAX_DISTANCE] [--point-to POINT_TO]
[--max-ptrs MAX_PTRS] [--flags FLAGS]
[address] [count]
```
## Positional Arguments
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|Leak memory address (default: $sp)|
|count|Leak size in bytes (default: 64)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

18
docs/commands/memory/search.md
Unescape View File

@ -5,16 +5,8 @@
# search
## Description
Search memory for byte sequences, strings, pointers, and integer values.
By default search results are cached. If you want to cache all results, but only print a subset, use --trunc-out. If you want to cache only a subset of results, and print the results immediately, use --limit. The latter is specially useful if you're searching a huge section of memory.
## Usage
```bash
```text
usage: search [-h] [-t {byte,short,word,dword,qword,pointer,string,bytes,asm}]
[-1] [-2] [-4] [-8] [-p] [--asm]
[--arch {powerpc64,aarch64,powerpc,riscv32,riscv64,sparc64,mips64,msp430,alpha,amd64,sparc,thumb,cris,i386,ia64,m68k,mips,s390,none,avr,arm,vax}]
@ -23,14 +15,18 @@ usage: search [-h] [-t {byte,short,word,dword,qword,pointer,string,bytes,asm}]
value [mapping_name]
```
## Positional Arguments
Search memory for byte sequences, strings, pointers, and integer values.
By default search results are cached. If you want to cache all results, but only print a subset, use --trunc-out. If you want to cache only a subset of results, and print the results immediately, use --limit. The latter is specially useful if you're searching a huge section of memory.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|value|Value to search for|
|mapping_name|Mapping to search [e.g. libc]|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/telescope.md
Unescape View File

@ -5,25 +5,21 @@
# telescope
## Description
Recursively dereferences pointers starting at the specified address.
## Usage
```bash
```text
usage: telescope [-h] [-r] [-f] [-i] [address] [count]
```
## Positional Arguments
Recursively dereferences pointers starting at the specified address.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
|address|The address to telescope at. (default: $sp)|
|count|The number of lines to show. (default: 8)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

14
docs/commands/memory/vmmap-add.md
Unescape View File

@ -5,18 +5,14 @@
# vmmap-add
## Description
Add virtual memory map page.
## Usage
```bash
```text
usage: vmmap-add [-h] start size [flags] [offset]
```
## Positional Arguments
Add virtual memory map page.
### Positional arguments
|Positional Argument|Help|
| :--- | :--- |
@ -25,7 +21,7 @@ usage: vmmap-add [-h] start size [flags] [offset]
|flags|Flags set by the ELF file (r - read, w - write, x - executable) (default: '')|
|offset|Offset into the original ELF file that the data is loaded from (default: 0)|
## Optional Arguments
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

12
docs/commands/memory/vmmap-clear.md
Unescape View File

@ -5,18 +5,14 @@
# vmmap-clear
## Description
Clear the vmmap cache.
## Usage
```bash
```text
usage: vmmap-clear [-h]
```
## Optional Arguments
Clear the vmmap cache.
### Optional arguments
|Short|Long|Help|
| :--- | :--- | :--- |

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

Write Preview
Loading…
Cancel
Save