Doc update

hugsy · Jul 11, 2022 · 2e0115d · 2e0115d
1 parent 4d4e801
commit 2e0115d
Show file tree

Hide file tree

Showing 46 changed files with 51 additions and 51 deletions.
diff --git a/docs/commands/aliases.md b/docs/commands/aliases.md
@@ -1,4 +1,4 @@
-## Command aliases ##
+## Command `aliases`
 
 Base command to add, remove, and list `GEF` defined aliases.
 

diff --git a/docs/commands/aslr.md b/docs/commands/aslr.md
@@ -1,4 +1,4 @@
-## Command aslr ##
+## Command `aslr`
 
 Easily check, enable or disable ASLR on the debugged binary.
 

diff --git a/docs/commands/canary.md b/docs/commands/canary.md
@@ -1,4 +1,4 @@
-## Command canary ##
+## Command `canary`
 
 If the currently debugged process was compiled with the Smash Stack Protector
 (SSP) - i.e. the `-fstack-protector` flag was passed to the compiler, this

diff --git a/docs/commands/checksec.md b/docs/commands/checksec.md
@@ -1,4 +1,4 @@
-## Command checksec ##
+## Command `checksec` ##
 
 The `checksec` command is inspired from
 [`checksec.sh`](https://www.trapkit.de/tools/checksec.html). It provides a

diff --git a/docs/commands/config.md b/docs/commands/config.md
@@ -1,4 +1,4 @@
-## Command config ##
+## Command `gef config` ##
 
 `gef` reads its config from a file which is by default located at `~/.gef.rc`, but which
 can also be specified via the `GEF_RC` environment variable. In addition, `gef` can also

diff --git a/docs/commands/context.md b/docs/commands/context.md
@@ -1,4 +1,4 @@
-## Command context ##
+## Command `context` ##
 
 ![gef-context](https://i.imgur.com/aZiG8Yb.png)
 

diff --git a/docs/commands/dereference.md b/docs/commands/dereference.md
@@ -1,4 +1,4 @@
-## Command dereference
+## Command `dereference`
 
 The `dereference` command (also aliased `telescope` for PEDA former users) aims
 to simplify the dereferencing of an address in GDB to determine the content it

diff --git a/docs/commands/edit-flags.md b/docs/commands/edit-flags.md
@@ -1,4 +1,4 @@
-## Command edit-flags ##
+## Command `edit-flags`
 
 The `edit-flags` command (alias: `flags`) provides a quick and comprehensible
 way to view and edit the flag register for the architectures that support it.

diff --git a/docs/commands/elf-info.md b/docs/commands/elf-info.md
@@ -1,4 +1,4 @@
-## Command elf-info ##
+## Command `elf-info`
 
 `elf-info` (alias `elf`) provides some basic information on the currently
 loaded ELF binary:

diff --git a/docs/commands/entry-break.md b/docs/commands/entry-break.md
@@ -1,4 +1,4 @@
-## Command entry-break ##
+## Command `entry-break`
 
 The `entry-break` (alias `start`) command's goal is to find and break at the
 most obvious entry point available in the binary. Since the binary will start

diff --git a/docs/commands/eval.md b/docs/commands/eval.md
@@ -1,4 +1,4 @@
-## Command $ ##
+## Command `$`
 
 The `$` command attempts to mimic WinDBG `?` command.
 

diff --git a/docs/commands/format-string-helper.md b/docs/commands/format-string-helper.md
@@ -1,4 +1,4 @@
-## Command format-string-helper ##
+## Command `format-string-helper`
 
 The `format-string-helper` command will create a `GEF` specific type of
 breakpoints dedicated to detecting potentially insecure format string when

diff --git a/docs/commands/functions.md b/docs/commands/functions.md
@@ -1,4 +1,4 @@
-## Command functions ##
+## Command `functions`
 
 The `functions` command will list all of
 the [convenience functions](https://sourceware.org/gdb/onlinedocs/gdb/Convenience-Funs.html)

diff --git a/docs/commands/gef.md b/docs/commands/gef.md
@@ -1,4 +1,4 @@
-## Command GEF ##
+## Command `gef`
 
 ### GEF Base Command
 

diff --git a/docs/commands/got.md b/docs/commands/got.md
@@ -1,9 +1,9 @@
-## Command got ##
+## Command `got`
 
 Display the current state of GOT table of the running process.
 
-The `got` command optionally takes function names and filters 
-the output displaying only the matching functions. 
+The `got` command optionally takes function names and filters
+the output displaying only the matching functions.
 ```
 gef➤ got
 ```

diff --git a/docs/commands/heap-analysis-helper.md b/docs/commands/heap-analysis-helper.md
@@ -1,4 +1,4 @@
-## Command heap-analysis-helper ##
+## Command `heap-analysis-helper`
 
 Please note: This feature is still under development, expect bugs and unstability.
 

diff --git a/docs/commands/heap.md b/docs/commands/heap.md
@@ -1,4 +1,4 @@
-## Command heap ##
+## Command `heap`
 
 The `heap` command provides information on the heap chunk specified as argument. For
 the moment, it only supports GlibC heap format (see

diff --git a/docs/commands/help.md b/docs/commands/help.md
@@ -1,4 +1,4 @@
-## Command gef help ##
+## Command `gef help`
 
 Displays the help menu for the loaded GEF commands.
 

diff --git a/docs/commands/hexdump.md b/docs/commands/hexdump.md
@@ -1,4 +1,4 @@
-## Command hexdump ##
+## Command `hexdump`
 
 Imitation of the WinDBG command.
 

diff --git a/docs/commands/highlight.md b/docs/commands/highlight.md
@@ -1,4 +1,4 @@
-## Command highlight ##
+## Command `highlight`
 
 This command sets up custom highlighting for user set strings.
 

diff --git a/docs/commands/hijack-fd.md b/docs/commands/hijack-fd.md
@@ -1,4 +1,4 @@
-## Command hijack-fd ##
+## Command `hijack-fd`
 
 `gef` can be used to modify file descriptors of the debugged process. The new
 file descriptor can point to a file, a pipe, a socket, a device etc.

diff --git a/docs/commands/ksymaddr.md b/docs/commands/ksymaddr.md
@@ -1,4 +1,4 @@
-## Command ksymaddr ##
+## Command `ksymaddr`
 
 `ksymaddr` helps locate a kernel symbol by its name.
 

diff --git a/docs/commands/memory.md b/docs/commands/memory.md
@@ -1,4 +1,4 @@
-## Command memory ##
+## Command `memory`
 
 As long as the 'memory' section is enabled in your context layout (which it is
 by default), you can register addresses, lengths, and grouping size.

diff --git a/docs/commands/name-break.md b/docs/commands/name-break.md
@@ -1,4 +1,4 @@
-## Command name-break ##
+## Command `name-break`
 
 The command `name-break` (alias `nb`) can be used to set a breakpoint on
 a location with a name assigned to it.

diff --git a/docs/commands/nop.md b/docs/commands/nop.md
@@ -1,4 +1,4 @@
-## Command nop ##
+## Command `nop`
 
 The `nop` command allows you to easily skip instructions.
 

diff --git a/docs/commands/patch.md b/docs/commands/patch.md
@@ -1,4 +1,4 @@
-## Command patch ##
+## Command `patch`
 
 `patch` lets you easily patch the specified values to the specified address.
 

diff --git a/docs/commands/pattern.md b/docs/commands/pattern.md
@@ -1,4 +1,4 @@
-## Command pattern ##
+## Command `pattern`
 
 This command will create or search a [De
 Bruijn](https://en.wikipedia.org/wiki/De_Bruijn_sequence) cyclic pattern to
@@ -9,7 +9,7 @@ It should be noted that for better compatibility, the algorithm implemented in
 `GEF` is the same as the one in `pwntools`, and can therefore be used in
 conjunction.
 
-### create ###
+### `pattern create` ###
 
 ```
 pattern create [-h] [-n N] [length]
@@ -34,7 +34,7 @@ from pwn import *
 p = cyclic(128, n=8)
 ```
 
-### search ###
+### `pattern search` ###
 
 ```
 pattern search [-h] [-n N] [--max-length MAX_LENGTH] [pattern]

diff --git a/docs/commands/pcustom.md b/docs/commands/pcustom.md
@@ -1,4 +1,4 @@
-## Command pcustom ##
+## Command `pcustom`
 
 `gef` provides a way to create and apply to the currently debugged environment, any new structure (in the C-struct way). On top of simply displaying known and user-defined structures, it also allows to apply those structures to the current context. It intends to mimic the very useful [WinDBG `dt`](https://msdn.microsoft.com/en-us/library/windows/hardware/ff542772(v=vs.85).aspx) command.
 

diff --git a/docs/commands/pie.md b/docs/commands/pie.md
@@ -1,4 +1,4 @@
-## Command pie ##
+## Command `pie` ##
 
 The `pie` command is handy when working with position-independent executables.
 At runtime, it can automatically resolve addresses for breakpoints that are not

diff --git a/docs/commands/print-format.md b/docs/commands/print-format.md
@@ -1,4 +1,4 @@
-## Command print-format ##
+## Command `print-format`
 
 The command `print-format` (alias `pf`) will dump an arbitrary location as an array of bytes following the format specified. Currently, the output formats supported are
 

diff --git a/docs/commands/process-search.md b/docs/commands/process-search.md
@@ -1,4 +1,4 @@
-## Command process-search ##
+## Command `process-search`
 
 `process-search` (aka `ps`) is a convenience command to list and filter process
 on the host. It is aimed at making the debugging process a little easier when

diff --git a/docs/commands/process-status.md b/docs/commands/process-status.md
@@ -1,4 +1,4 @@
-## Command process-status ##
+## Command `process-status`
 
 > This command replaces the old commands `pid` and `fd`.
 

diff --git a/docs/commands/registers.md b/docs/commands/registers.md
@@ -1,4 +1,4 @@
-## Command registers ##
+## Command `registers`
 
 The `registers` command will print all the registers and dereference any
 pointers.

diff --git a/docs/commands/reset-cache.md b/docs/commands/reset-cache.md
@@ -1,3 +1,3 @@
-## Command reset-cache
+## Command `reset-cache`
 
 This command is only useful for debugging `GEF` itself.
diff --git a/docs/commands/scan.md b/docs/commands/scan.md
@@ -1,4 +1,4 @@
-## Command scan ##
+## Command `scan`
 
 `scan` searches for addresses of one memory region (needle) inside another
 region (haystack) and lists all results.

diff --git a/docs/commands/search-pattern.md b/docs/commands/search-pattern.md
@@ -1,4 +1,4 @@
-## Command search-pattern ##
+## Command `search-pattern`
 
 `gef` allows you to search for a specific pattern at runtime in all the segments
 of your process memory layout. The command `search-pattern`, alias `grep`, aims
@@ -41,6 +41,6 @@ Sometimes, you may need an advanced search using regex. Just use --regex arg.
 Example: how to find null-end-printable(from x20-x7e) C strings (min size >=2 bytes) with a regex:
 
 ```
-gef➤  search-pattern --regex 0x401000 0x401500 ([\\x20-\\x7E]{2,})(?=\\x00)   
+gef➤  search-pattern --regex 0x401000 0x401500 ([\\x20-\\x7E]{2,})(?=\\x00)
 
 ```
diff --git a/docs/commands/shellcode.md b/docs/commands/shellcode.md
@@ -1,4 +1,4 @@
-## Command shellcode ##
+## Command `shellcode`
 
 `shellcode` is a command line client for @JonathanSalwan shellcodes database. It
 can be used to search and download directly via `GEF` the shellcode you're

diff --git a/docs/commands/stub.md b/docs/commands/stub.md
@@ -1,4 +1,4 @@
-## Command stub ##
+## Command `stub`
 
 The `stub` command allows you stub out functions, optionally specifying the
 return value.

diff --git a/docs/commands/theme.md b/docs/commands/theme.md
@@ -1,4 +1,4 @@
-## Command theme
+## Command `theme`
 
 Customize `GEF` by changing its color scheme.
 

diff --git a/docs/commands/tmux-setup.md b/docs/commands/tmux-setup.md
@@ -1,4 +1,4 @@
-## Command tmux-setup ##
+## Command `tmux-setup`
 
 In the purpose of always making debugging sessions easier while being more
 effective, `GEF` integrates two commands:

diff --git a/docs/commands/trace-run.md b/docs/commands/trace-run.md
@@ -1,4 +1,4 @@
-## Command trace-run ##
+## Command `trace-run`
 
 The `trace-run` command is meant to be provide a visual appreciation directly
 in IDA disassembler of the path taken by a specific execution. It should be

diff --git a/docs/commands/version.md b/docs/commands/version.md
@@ -1,4 +1,4 @@
-## Command version ##
+## Command `version`
 
 Print out version information about your current gdb environment.
 

diff --git a/docs/commands/vmmap.md b/docs/commands/vmmap.md
@@ -1,4 +1,4 @@
-## Command vmmap ##
+## Command `vmmap`
 
 `vmmap` displays the target process's entire memory space mapping.
 

diff --git a/docs/commands/xfiles.md b/docs/commands/xfiles.md
@@ -1,4 +1,4 @@
-## Command xfiles ##
+## Command `xfiles`
 
 `xfiles` is a more convenient representation of the GDB native command, `info
 files` allowing you to filter by pattern given in argument. For example, if you

diff --git a/docs/commands/xinfo.md b/docs/commands/xinfo.md
@@ -1,4 +1,4 @@
-## Command xinfo ##
+## Command `xinfo`
 
 `xinfo` displays all the information known to `gef` about the specific address
 given as argument:

diff --git a/docs/commands/xor-memory.md b/docs/commands/xor-memory.md
@@ -1,4 +1,4 @@
-## Command xor-memory
+## Command `xor-memory`
 
 This command is used to XOR a block of memory.