Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / capstone / f5b2ac1c2922ae3995a281176466beeead614c7d / . / docs / README
blob: 15bbeb3cbe87fee790e4a12895cc78028405f367 [file] [log] [blame]
Satoshi Tanda565b6c32016-09-27 07:39:51 -0700[diff] [blame]1Documentation of Capstone disassembly framework.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]2
Nguyen Anh Quynhcc0cb492014-02-28 17:32:17 +0800[diff] [blame]3* Switching to 2.1 engine.
4
5 http://capstone-engine.org/version_2.1_API.html
6
Nguyen Anh Quynh48476dd2014-03-02 00:15:04 +0800[diff] [blame]7* How to compile & install Capstone.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]8
9 http://capstone-engine.org/documentation.html
10
Nguyen Anh Quynh1cbe4c62014-02-25 10:04:07 +0800[diff] [blame]11* Programming with C language.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]12
13 http://capstone-engine.org/lang_c.html
14
Nguyen Anh Quynh1cbe4c62014-02-25 10:04:07 +0800[diff] [blame]15* Programming with Python language.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]16
17 http://capstone-engine.org/lang_python.html
18
Nguyen Anh Quynh1cbe4c62014-02-25 10:04:07 +0800[diff] [blame]19* Programming with Java language.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]20
21 http://capstone-engine.org/lang_java.html
22
Nguyen Anh Quynha76c2ff2015-04-27 16:35:30 +0800[diff] [blame]23* Customize instruction mnemonics at run-time.
24
25 http://capstone-engine.org/mnemonic.html
26
Nguyen Anh Quynh475b9622015-03-26 00:40:44 +0800[diff] [blame]27* Retrieve access information of instruction operands.
28
29 http://capstone-engine.org/op_access.html
30
Nguyen Anh Quynh1cbe4c62014-02-25 10:04:07 +0800[diff] [blame]31* Build compact engine with only selected architectures.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]32
33 http://capstone-engine.org/compile.html
34
Nguyen Anh Quynh1cbe4c62014-02-25 10:04:07 +0800[diff] [blame]35* Build "diet" engine for even smaller libraries.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]36
37 http://capstone-engine.org/diet.html
38
Nguyen Anh Quynh0fce8d72014-03-01 23:32:23 +0800[diff] [blame]39* Build embedded engine for firmware/OS kernel.
Nguyen Anh Quynh35b5eb02014-02-24 17:48:07 +0800[diff] [blame]40
Nguyen Anh Quynh0fce8d72014-03-01 23:32:23 +0800[diff] [blame]41 http://capstone-engine.org/embed.html
Nguyen Anh Quynh1dce9c22014-03-27 11:45:28 +0800[diff] [blame]42
Nguyen Anh Quynhe1245132014-04-11 01:32:48 +0800[diff] [blame]43* SKIPDATA mode to keep disassembling after hitting a broken instruction.
44
45 http://capstone-engine.org/skipdata.html
46
Nguyen Anh Quynha91c1992014-10-13 07:27:16 +0800[diff] [blame]47* Quickly iterate instructions with cs_disasm_iter().
48
49 http://capstone-engine.org/iteration.html
50
Nguyen Anh Quynh1dce9c22014-03-27 11:45:28 +0800[diff] [blame]51* Build X86-reduce engine for firmware/OS kernel.
52
Nguyen Anh Quynh3c5ab992014-03-27 16:05:38 +0800[diff] [blame]53 http://capstone-engine.org/x86reduce.html
Nguyen Anh Quynhaa791a22014-07-11 11:18:15 +0800[diff] [blame]54
tandasat21853c62016-05-26 19:30:37 -0700[diff] [blame]55* Sample applications on how to embed Capstone into Windows kernel driver.
Nguyen Anh Quynhaa791a22014-07-11 11:18:15 +0800[diff] [blame]56
tandasat21853c62016-05-26 19:30:37 -0700[diff] [blame]57 https://github.com/aquynh/capstone/tree/master/contrib/cs_driver (in C, basic)
58 https://github.com/aquynh/KernelProject (in C++)
Nguyen Anh Quynhaa791a22014-07-11 11:18:15 +0800[diff] [blame]59
60* Sample application on how to embed Capstone into Mac OSX Kext (kernel).
61
62 https://github.com/aquynh/CapstoneTest