add usefull usage information to the documentation
[frida/doc.git] / source / using.rst
1 Usage
2 -----
3
4 Adding and renaming functions
5 =============================
6
7 Functions can be added by entering an address -- this functionality is
8 available from the contextmenu on the functionlist widget as well as
9 the f hotkey. Frida will the recursively disassembler all functions
10 directly reachable from this entrypoint.
11
12 To rename the currently selected function use the r Hotkey. You can
13 also rename functions from the contextmenu of the individual items in
14 the function list (by default located on the left side).
15
16 Adding comments
17 ===============
18
19 You have the choice of adding "local" and "global" comments. Global
20 comments add information intended for human observers to an address
21 and are displayed at that address. Local comments are supposed to be
22 meaningfull only in the context of the specific function but not when
23 the same address appears within different functions. However, local
24 functions are not completely implemented yet.
25
26 Saving progress
27 ===============
28
29 Files saved by frida are standalone. They can be opened and used by
30 frida on the same or a different computer and do *not* require the
31 original binary to be available on that machine. Function names as
32 well as the CFG are preserved, however the textual representation and
33 the graph layout are reconstructed when opening the saved file.
34
35 Hotkeys
36 =======
37
38 +---+--------------------------------------------------------+
39 | r | Rename currently active function |
40 +---+--------------------------------------------------------+
41 | f | Ask for an address and disassembles the function there |
42 +---+--------------------------------------------------------+