xref: /aosp_15_r20/external/capstone/docs/README (revision 9a0e4156d50a75a99ec4f1653a0e9602a5d45c18)
1*9a0e4156SSadaf EbrahimiDocumentation of Capstone disassembly framework.
2*9a0e4156SSadaf Ebrahimi
3*9a0e4156SSadaf Ebrahimi* Switching to 2.1 engine.
4*9a0e4156SSadaf Ebrahimi
5*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/version_2.1_API.html
6*9a0e4156SSadaf Ebrahimi
7*9a0e4156SSadaf Ebrahimi* How to compile & install Capstone.
8*9a0e4156SSadaf Ebrahimi
9*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/documentation.html
10*9a0e4156SSadaf Ebrahimi
11*9a0e4156SSadaf Ebrahimi* Programming with C language.
12*9a0e4156SSadaf Ebrahimi
13*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/lang_c.html
14*9a0e4156SSadaf Ebrahimi
15*9a0e4156SSadaf Ebrahimi* Programming with Python language.
16*9a0e4156SSadaf Ebrahimi
17*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/lang_python.html
18*9a0e4156SSadaf Ebrahimi
19*9a0e4156SSadaf Ebrahimi* Programming with Java language.
20*9a0e4156SSadaf Ebrahimi
21*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/lang_java.html
22*9a0e4156SSadaf Ebrahimi
23*9a0e4156SSadaf Ebrahimi* Customize instruction mnemonics at run-time.
24*9a0e4156SSadaf Ebrahimi
25*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/mnemonic.html
26*9a0e4156SSadaf Ebrahimi
27*9a0e4156SSadaf Ebrahimi* Retrieve access information of instruction operands.
28*9a0e4156SSadaf Ebrahimi
29*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/op_access.html
30*9a0e4156SSadaf Ebrahimi
31*9a0e4156SSadaf Ebrahimi* Build compact engine with only selected architectures.
32*9a0e4156SSadaf Ebrahimi
33*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/compile.html
34*9a0e4156SSadaf Ebrahimi
35*9a0e4156SSadaf Ebrahimi* Build "diet" engine for even smaller libraries.
36*9a0e4156SSadaf Ebrahimi
37*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/diet.html
38*9a0e4156SSadaf Ebrahimi
39*9a0e4156SSadaf Ebrahimi* Build embedded engine for firmware/OS kernel.
40*9a0e4156SSadaf Ebrahimi
41*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/embed.html
42*9a0e4156SSadaf Ebrahimi
43*9a0e4156SSadaf Ebrahimi* SKIPDATA mode to keep disassembling after hitting a broken instruction.
44*9a0e4156SSadaf Ebrahimi
45*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/skipdata.html
46*9a0e4156SSadaf Ebrahimi
47*9a0e4156SSadaf Ebrahimi* Quickly iterate instructions with cs_disasm_iter().
48*9a0e4156SSadaf Ebrahimi
49*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/iteration.html
50*9a0e4156SSadaf Ebrahimi
51*9a0e4156SSadaf Ebrahimi* Build X86-reduce engine for firmware/OS kernel.
52*9a0e4156SSadaf Ebrahimi
53*9a0e4156SSadaf Ebrahimi	http://capstone-engine.org/x86reduce.html
54*9a0e4156SSadaf Ebrahimi
55*9a0e4156SSadaf Ebrahimi* Sample applications on how to embed Capstone into Windows kernel driver.
56*9a0e4156SSadaf Ebrahimi
57*9a0e4156SSadaf Ebrahimi	https://github.com/aquynh/capstone/tree/master/contrib/cs_driver (in C, basic)
58*9a0e4156SSadaf Ebrahimi	https://github.com/aquynh/KernelProject (in C++)
59*9a0e4156SSadaf Ebrahimi
60*9a0e4156SSadaf Ebrahimi* Sample application on how to embed Capstone into Mac OSX Kext (kernel).
61*9a0e4156SSadaf Ebrahimi
62*9a0e4156SSadaf Ebrahimi	https://github.com/aquynh/CapstoneTest
63*9a0e4156SSadaf Ebrahimi
64*9a0e4156SSadaf Ebrahimi* A Micro Capstone-Engine API Documentation in Chinese
65*9a0e4156SSadaf Ebrahimi
66*9a0e4156SSadaf Ebrahimi        https://github.com/capstone-engine/capstone/blob/master/docs//Capstone-Engine-Documentation
67