Usage

Issue #1 resolved
Alexander Hanel repo owner created an issue

Need to create a function that displays the usage. I'm sick of going to my blog to read how it works...

Comments (1)

  1. Alexander Hanel reporter

    Added a detailed usage function that describes all the variables and functions. Example of the output can be seen below.

    Python>x.usage()
    
        example:
        select data then execute the below command. The data will be automatically populated. It 
        should be noted that the whole instruction line will be added to the buffer. If the whole
        line is not intended the obj.start or obj.end will need to be manually changed. 
    
        obj = fwrapper()     
        for x in obj.buffer: print hex(ord(x)) // will print each item in thebuffer         
    
        - data -
        obj.start               contains the address of the start of the selected instruction.
        obj.end                 contains the address of the end of the selected instruction. 
        obj.buffer              contains the binary data.   
        obj.ogLen               contains the size of the buffer. 
    
        - function -
        obj.usage()             print this 
        obj.checkBounds()       checks that obj.start and obj.end is valid addresses. 
        obj.getData()           copies the binary data between obj.start and obj.end to obj.buffer
        obj.run()               the selected data is copied to the buffer in a binary format
        obj.patch()             patch the IDB at obj.start with the data in the obj.buffer. 
        obj.patch(d)            patch the IDB at obj.start with the argument data. 
        obj.importb()           opens a file and saves the data in obj.buffer.
        obj.export()            exports the data in obj.buffer to a save as file.
        obj.l()                 print length of the buffer
    
  2. Log in to comment