Document magic syntax for comments
[frida/doc.git] / source / using.rst
1 Usage
2 -----
4 Adding and renaming functions
5 =============================
7 Functions can be added by entering an address -- this functionality is
8 available from the context-menu on the function-list widget as well as
9 the f hot-key. Frida will the recursively disassembler all functions
10 directly reachable from this entry point.
12 To rename the currently selected function use the r Hot-key. You can
13 also rename functions from the context-menu of the individual items in
14 the function list (by default located on the left side).
16 Adding comments
17 ===============
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 meaningful 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.
26 Within comments, special placeholders exist. This way functions (and,
27 later, other objects cann be referenced in a way that automatically
28 updates the displayed string inside the comment. The syntax for a
29 function reference is ``#F<0xABCD1234>``.
31 Saving progress
32 ===============
34 Files saved by frida are standalone. They can be opened and used by
35 frida on the same or a different computer and do *not* require the
36 original binary to be available on that machine. Function names as
37 well as the CFG are preserved, however the textual representation and
38 the graph layout are reconstructed when opening the saved file.
40 Hot-keys
41 ========
43 +---+--------------------------------------------------------+
44 | r | Rename currently active function |
45 +---+--------------------------------------------------------+
46 | f | Ask for an address and disassembles the function there |
47 +---+--------------------------------------------------------+