6d811285c2
* Fix wording, whitespacing and other minor stuff
* cmd.c: ellaborated yy syntax, improved descriptions
- replace "srcoff" with "origin"
* cmd.c(cmd_autocomplete):
- refactor help into function: render autocomplete types with generic
help subsystem;
- "Types" heading now follow the "Usage" style by not being prefixed
by a pipe character;
* cmd_anal.c: fix whitespaces & help text
* cmd_info.c: fix help text capitalization.
* cmd_print.c:
- fix `pf` cmd help;
- TODO: what pz? is doing here?
* cons.c:
- refactor & better document r_cons_cmd_help();
- fix whitespaces;
* visual & panels modes:
- as of commit 46187fe4e14dc465dc6ac03fcc56a362f0b8e335, '!' no longer
launches the r2048 game. The game itself it broken anyway, even when
running from the Help menu in panels mode;
- transitioning from panels to visual is not 'entering' but actually
swapping/replacing visual panels with just panels, thus...
- reword 'enter into the' to 'swap into' or even just 'enter', e.g.:
"enter into the visual panels mode" -> "enter visual panels mode".
- remove the "(dwm style)" words from a fortune tip, because I have no
idea what it is, and it does not appear to be a valid command in any
of the r2 modes.
- update global help text.
* [WIP 2] Fix wording, whitespacing and other minor stuff
* visual.c:
- r_core_visual_append_help(): first steps merging with
r_cons_cmd_help from cons.c; use consistent colors for headers.
* [WIP 3] Fix wording, whitespacing and other minor stuff
* panels.c(__update_help):
- shorten code and titles;
- add comment to clarify that it is not a copy-paste error;
* [WIP 4] Fix wording, whitespacing and other minor stuff
panels.c, visual.c: tweak help text;
* [WIP 5] Fix wording, whitespacing and other minor stuff
* cmd_help.c: update global help text about visual mode -- it was
outdated and overloaded.
* vmenus.c:
- rename stuff, shuffle around static consts to reflect an actual
ordering when viewing as a help text;
- slightly improve help text rendering;
- fix whitespaces;
* [WIP 6] Fix wording, whitespacing and other minor stuff
* lots of help text changed. still working on proper commit message.
____ ___ ___ ___ ____ ___ ____
| _ \/ \| \/ \ _ \/ _ \ (__ \
| ( - | | ) - | ( _/ / __/
|__\__|_|__|___/__|__|_\__|___| |____|
https://www.radare.org
--pancake
| Service | Badge | Badge |
|---|---|---|
| Build&Test |  |
 |
| CodeQuality |  |
 |
| Infrastructure |  |
|
 |
||
Introduction
r2 is a rewrite from scratch of radare in order to provide a set of libraries and tools to work with binary files.
Radare project started as a forensics tool, a scriptable command-line hexadecimal editor able to open disk files, but later added support for analyzing binaries, disassembling code, debugging programs, attaching to remote gdb servers...
Learn More
To learn more you may read the official radare2 book, the source code, or browse the web for blog posts or presentations from r2con.
You may also want to meet other perople in r2land. use the following chats:
Operating Systems
Windows (since XP), GNU/Linux, GNU/Darwin, GNU/Hurd, Apple's {Mac,i,iPad,watch}OS, [Dragonfly|Net|Free|Open]BSD, Android, QNX, Solaris, Haiku, FirefoxOS.
Architectures
i386, x86-64, ARM, MIPS, PowerPC, SPARC, RISC-V, SH, m68k, m680x, AVR, XAP, System Z, XCore, CR16, HPPA, ARC, Blackfin, Z80, H8/300, V810, V850, CRIS, XAP, PIC, LM32, 8051, 6502, i4004, i8080, Propeller, Tricore, CHIP-8, LH5801, T8200, GameBoy, SNES, SPC700, MSP430, Xtensa, NIOS II, Java, Dalvik, WebAssembly, MSIL, EBC, TMS320 (c54x, c55x, c55+, c66), Hexagon, Brainfuck, Malbolge, whitespace, DCPU16, LANAI, MCORE, mcs96, RSP, SuperH-4, VAX, AMD Am29000.
File Formats
ELF, Mach-O, Fatmach-O, PE, PE+, MZ, COFF, OMF, TE, XBE, BIOS/UEFI, Dyldcache, DEX, ART, CGC, Java class, Android boot image, Plan9 executable, ZIMG, MBN/SBL bootloader, ELF coredump, MDMP (Windows minidump), WASM (WebAssembly binary), Commodore VICE emulator, QNX, Game Boy (Advance), Nintendo DS ROMs and Nintendo 3DS FIRMs, various filesystems.
Scripting
Native bindings are supported but the recommended way to interact with r2 from other languages is by using r2pipe
Python, Ruby, JavaScript, Lua, Perl, PHP, Go, Rust, Swift, C#, Java, Shell, OCaml, Haskell, Scheme (Guile), Common Lisp, Clojure, Erlang, D, Vala/Genie, Prolog, Nim, Newlisp...
Install / Update
The recommended way to install or update radare2 from git for single-user systems:
$ sys/install.sh
If you don't have root, or just want to install it in your home use:
$ sys/user.sh
Note that those scripts will install using configure+make using symlinks, so you don't need to reinstall every time you change something in the builddir.
- If you don't like symlinks use
sys/install.sh --install - To use capstone5 use the
--with-capstone5flag.
Alternatively you can also build with meson + ninja:
$ ./sys/meson.py --prefix=/usr --shared --install
Or install in your home with meson + ninja:
$ ./sys/meson.py --prefix=/home/$USER/r2meson --local --shared --install
Uninstall
In case of a polluted filesystem, you can uninstall the current version or remove all previous installations:
$ make uninstall
$ make purge
To remove all stuff including libraries, use
$ make system-purge
Package Manager
Radare2 has its own package manager - r2pm. Its packages repository is on GitHub too. To start to using it for the first time, you need to initialize packages:
$ r2pm init
Refresh the packages database before installing any package:
$ r2pm update
To install a package, use the following command:
$ r2pm install [package name]
Development
Coding Style
Look at CONTRIBUTING.md.
Tests
Running make tests will fetch the test binaries
repository and run all the tests in order to verify that no changes break any functionality.
We run those tests on every commit, and they are also executed with ASAN and valgrind on different platforms to catch other unwanted 'features'.
Community
Website: https://www.radare.org/
Telegram: https://t.me/radare
Twitter: @radareorg
IRC: irc.freenode.net #radare