Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Minor additions to the documentation #975

Merged
merged 4 commits into from
Aug 1, 2023
Merged

Minor additions to the documentation #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
371c0ea
added more references to gef-extras
hugsy Jul 29, 2023
e0048f8
adding a note about required common bins (issue #973)
hugsy Jul 29, 2023
81b6067
Merge branch 'dev' into minor_doc_additions
hugsy Jul 30, 2023
06cc881
typo
hugsy Jul 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ d more comprehensible layout to GDB Python API.
* Built around an architecture abstraction layer, so all commands work in any GDB-supported
architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
* Suited for real-life apps debugging, exploit development, just as much as CTF
* And a lot more commands contributed by the community available on
[GEF-Extras](https://github.com/hugsy/gef-extras) !!

Check out the [Screenshot page](docs/screenshots.md) for more or [try it
online](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ It requires Python 3, but [`gef-legacy`](https://github.com/hugsy/gef-legacy) ca
* Built around an architecture abstraction layer, so all commands work in any GDB-supported
architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
* Suited for real-life debugging, exploit development, just as much as for CTFs
* And a lot more commands contributed by the community available on [GEF-Extras](https://github.com/hugsy/gef-extras) !!

Check out the [showroom page](https://hugsy.github.io/gef/screenshots/) for more | or [try it online
yourself!](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)
Expand Down
8 changes: 8 additions & 0 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

## Prerequisites

Specific GEF commands rely on commonly used Unix commands to extract additional information. Therefore it requires the following binaries to be present:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems the wrap isn't applied

* `file`
* `readelf`
* `ps`
* `python3`
hugsy marked this conversation as resolved.
Show resolved Hide resolved

Those tools are included by default in many modern distributions. If they're missing, you can use your OS package manager to install them.
hugsy marked this conversation as resolved.
Show resolved Hide resolved

### GDB

Only [GDB 8 and higher](https://www.gnu.org/s/gdb) is required. It must be compiled with Python 3.6
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ theme:

nav:
- Home: index.md
- Coverage: https://hugsy.github.io/gef/coverage/
- Showroom: screenshots.md
- Setup:
- Installation: install.md
Expand All @@ -22,6 +21,7 @@ nav:
- Testing: testing.md
- Write extensions: api.md
- API: api/gef.md
- Coverage: https://hugsy.github.io/gef/coverage/
- Commands:
- aliases: commands/aliases.md
- aslr: commands/aslr.md
Expand Down Expand Up @@ -76,4 +76,5 @@ nav:
- got: functions/got.md
- heap: functions/heap.md
- stack: functions/stack.md
- GEF-Extras: https://hugsy.github.io/gef-extras/
- Deprecated: deprecated.md
Loading