IDAPython project for Hex-Ray's IDA Pro
Go to file
gergely.erdelyi d26536abd4 idautils.py: Heads() and Functions() now used inf.minEA and inf.maxEA as default parameters
idautils.py: Heads() will not yield a head at 'start' if there is none
2009-04-27 18:20:02 +00:00
docs Initial SVN commit of version 0.9.54 sources. 2007-10-20 07:03:51 +00:00
examples Added example user init script 2009-01-27 18:09:23 +00:00
python idautils.py: Heads() and Functions() now used inf.minEA and inf.maxEA as default parameters 2009-04-27 18:20:02 +00:00
swig Added support for retrieving large local types 2009-04-27 17:38:17 +00:00
tools Added small script to generate function cross reference with epydoc 2008-06-25 21:03:38 +00:00
basetsd.h Initial SVN commit of version 0.9.54 sources. 2007-10-20 07:03:51 +00:00
build.py build.py: Fix for building under Vista. Thanks to Itai Shaham for the report! 2009-04-26 18:36:35 +00:00
BUILDING.txt More doc updates 2008-09-01 18:55:03 +00:00
CHANGES.txt CHANGES.txt: Updated changes from 1.0 branch 2008-10-01 15:38:47 +00:00
COPYING.txt Updated year in copyright strings 2009-04-26 18:28:59 +00:00
python.cpp Updated year in copyright strings 2009-04-26 18:28:59 +00:00
README.txt README.txt: Updated location of user init script 2009-01-27 18:09:47 +00:00
STATUS.txt More doc updates 2008-09-01 18:55:03 +00:00

----------------------------------------------------------
IDAPython - Python plugin for Interactive Disassembler Pro
----------------------------------------------------------

WHAT IS IDAPTYHON?
------------------

IDAPython is an IDA plugin which makes it possible to write scripts
for IDA in the Python programming language. IDAPython provides full
access to both the IDA API and any installed Python module.

Check the scripts in the examples directory to get an quick glimpse.


AVAILABILITY
------------

Latest stable versions of IDAPython are available from
  http://www.d-dome.net/idapython/

Development builds are available from
  http://code.google.com/p/idapython/


RESOURCES
---------

The full function cross-reference is readable online at
  http://www.d-dome.net/idapython/reference/

Bugs and enhancement requests should be submitted to
  http://code.google.com/p/idapython/issues/list

Mailing list for the project is hosted by Google Groups at
  http://groups.google.com/group/idapython


INSTALLATION FROM BINARIES
--------------------------

1, Install Python 2.5 from http://www.python.org/
2, Copy the directory python\ to the IDA install directory
3. Copy the plugin to the %IDADIR%\plugins\


USAGE
-----

The plugin has three hotkeys: 

 - Run script (Alt-9)
 - Execute Python statement(s) (Alt-8)
 - Run previously executed script again (Alt-7)

Batch mode execution:

Start IDA with the following command line options:

 -A -OIDAPython:yourscript.py file_to_work_on

If you want fully unattended execution mode, make sure your script
exits with a qexit() call.


User init file:

You can place your custom settings to a file called 'idapythonrc.py'
that should be placed to 

${HOME}/.idapro/

or 

C:\Documents and Settings\%USER%\Application Data\Hex-Rays\IDA Pro

The user init file is read and executed at the end of the init process.