summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRusty Wagner <rusty@vector35.com>2016-12-01 18:13:54 -0500
committerRusty Wagner <rusty@vector35.com>2016-12-01 18:13:54 -0500
commit8c42dabe92340b4d342f3b4e7594fb70f1890e41 (patch)
tree406a4a0e0486b00a71b3d0bb65a3dd15cdf91981 /docs
parentf69430aedd957f5e8f221488cd6acb9031d3c1c1 (diff)
parent3b719e990e3e01242918bf66d5a1fb6032517641 (diff)
Merge branch 'dev'
Diffstat (limited to 'docs')
-rw-r--r--docs/.s3_website.yaml3
-rw-r--r--docs/getting-started.md9
-rw-r--r--docs/guide/troubleshooting.md22
3 files changed, 28 insertions, 6 deletions
diff --git a/docs/.s3_website.yaml b/docs/.s3_website.yaml
new file mode 100644
index 00000000..02c4a996
--- /dev/null
+++ b/docs/.s3_website.yaml
@@ -0,0 +1,3 @@
+s3_bucket: docs.binary.ninja
+site: ../site
+s3_reduced_redundancy: True
diff --git a/docs/getting-started.md b/docs/getting-started.md
index b7ffda4a..72c4796c 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -52,8 +52,8 @@ Switching views happens multiple ways. In some instances, it's automatic (clicki
- `h` : Switch to hex view
- `p` : Create a function
- - `&lt;ESC&gt;` : Navigate backward
- - `&lt;SPACE&gt;` : Toggle between linear view and graph view
+ - `[ESC]` : Navigate backward
+ - `[SPACE]` : Toggle between linear view and graph view
- `g` : Go To Address dialog
- `n` : Name a symbol
- `u` : Undefine a symbol
@@ -63,9 +63,14 @@ Switching views happens multiple ways. In some instances, it's automatic (clicki
- `i` : Switches between disassembly and low-level il in graph view
- `y` : Change type
- [1248] : Change type directly to a data variable of the indicated widths
+ - `a` : Change the data type to an ASCII string
- `d` : Switches between data variables of various widths
- `r` : Change the data type to single ASCII character
- `o` : Create a pointer data type
+ - `[CMD-SHIFT] +` (OS X) : Graph view zoom in
+ - `[CMD-SHIFT] -` (OS X) : Graph view zoom out
+ - `[CTRL-SHIFT] +` (Windows/Linux) : Graph view zoom in
+ - `[CTRL-SHIFT] -` (Windows/Linux) : Graph view zoom out
### Graph View
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
index a521ab1f..af91f6f1 100644
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@ -15,22 +15,36 @@ Running Binary Ninja with debug logging will make your bug report more useful.
## License Problems
-- If experiencing problems with Windows UAC permissions during an update, the easiest fix is to completely un-install and re-download the latest installer. Preferences are saved outside the installation folder and are preserved, though you might want to remove your [license](/getting-started/index.html#license).
+- If experiencing problems with Windows UAC permissions during an update, the easiest fix is to completely un-install and [recover][recover] the latest installer and license. Preferences are saved outside the installation folder and are preserved, though you might want to remove your [license](/getting-started/index.html#license).
- If you need to change the email address on your license, contact [support].
-## Arch Linux
+## Linux
-Arch Linux is not an officially supported operating system, but many of our users have run it, and there are a few pitfalls to watch out for.
+Given the diversity of Linux distributions, some work-arounds are required to run Binary Ninja on platforms that are not [officially supported][faq].
+
+### Arch Linux
- Install python2 from the [official repositories][archrepo]
- Install the [libcurl-compat] library from AUR, and run Binary Ninja via `LD_PRELOAD=libcurl.so.3 ~/binaryninja/binaryninja`
+### KDE
+
+To run Binary Ninja in a KDE based environment, set the `QT_PLUGIN_PATH` to the `QT` sub-folder:
+
+```
+cd ~/binaryninja
+QT_PLUGIN_PATH=./qt ./binaryninja
+```
+
+
## API
- - If the GUI launches but the license file is not valid, check that you're using the right version of Python. Only a 64-bit Python 2.7 is supported at this time.
+ - If the GUI launches but the license file is not valid when launched from the command-line, check that you're using the right version of Python. Only a 64-bit Python 2.7 is supported at this time. Additionally, the [personal][purchase] edition does not support headless operation.
[known issues]: https://github.com/Vector35/binaryninja-api/issues?q=is%3Aissue
[libcurl-compat]: https://aur.archlinux.org/packages/libcurl-compat/
[archrepo]: https://wiki.archlinux.org/index.php/Official_repositories
[recover]: https://binary.ninja/recover.html
[support]: https://binary.ninja/support.html
+[faq]: https://binary.ninja/faq.html
+[purchase]: https://binary.ninja/purchase.html