diff options
| author | Rusty Wagner <rusty@vector35.com> | 2018-12-20 22:53:20 -0500 |
|---|---|---|
| committer | Rusty Wagner <rusty@vector35.com> | 2018-12-20 22:53:20 -0500 |
| commit | 8ba8f85ba69854db55a27608ef193af54df047cf (patch) | |
| tree | 0e226e4ea9ceac1384a0bf30ccdd23788c24cb11 /docs | |
| parent | bbab2f853e4221310450bb45ce13ae11f867f870 (diff) | |
Add documentation for the keybindings file
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting-started.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index a7a6870d..0a787073 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -32,6 +32,7 @@ Contents of the user folder includes: - `plugins/`: Folder containing all manually installed user plugins - `repositories/`: Folder containing files and plugins managed by the [Plugin Manager API](https://api.binary.ninja/binaryninja.pluginmanager-module.html) - `settings.json`: Advanced settings (see [settings](#settings)) +- `keybindings.json`: Custom keybindings (see [keybindings](#custom-keybindings))  @@ -305,6 +306,21 @@ Below is an example `settings.json` setting various options: } ``` +## Custom Keybindings + +Custom keybindings can be stored in the [_user_ directory](#user-folder) in the file `keybindings.json`. Actions can be referenced for keybindings using the name that appears in the menu. If the desired action is in a submenu, use the full path to the item separated by `\\` (for example, `"New\\Binary Data"`). Below is an example keybindings file: + +``` +{ + "Reanalyze" : "Ctrl+Shift+R", + "Log" : "Ctrl+L" +} +``` + +Note +!!! Tip "Note" + On Mac OS X, `Ctrl` refers to the Command key, while `Meta` refers to the Control key. This is a remapping performed by Qt to make cross-platform keybindings easier to define. + ## Unicode Support Currently, Unicode support for Big Endian strings is very limited. Also, UTF-16 only supports Basic Latin code points. |