summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2017-08-21 20:58:14 -0500
committerJordan Wiens <jordan@psifertex.com>2017-08-21 20:58:14 -0500
commitd38a8d23d331c464e6d5089000ebf641ef855110 (patch)
tree0b3fea486f4a1ba219cba0ec9f074a450a2eeae8 /docs
parent7f0c8ccbf937a11e0b912c16209ccc2d7fee93f0 (diff)
new troubleshooting tips
Diffstat (limited to 'docs')
-rw-r--r--docs/guide/troubleshooting.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
index d8930d41..a640d47e 100644
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@ -9,17 +9,31 @@
## Bug Reproduction
Running Binary Ninja with debug logging will make your bug report more useful.
+
```
./binaryninja --debug --stderr-log
```
+Alternatively, it might be easier to save debug logs to a file instead:
+
+```
+./binaryninja -d -l logfile.txt
+```
+
+(note that both long and short-form of the command-line arguments are demonstrated in the above examples)
+
## Plugin Troubleshooting
-While third party plugins are not officially supported, there are a number of troubleshooting tips that can help identify the cause. The most importat is to enable debug logging as suggested in the previous section. This will often highlight problems with python paths or any other issues that prevent plugins from running.
+While third party plugins are not officially supported, there are a number of troubleshooting tips that can help identify the cause. The most important is to enable debug logging as suggested in the previous section. This will often highlight problems with python paths or any other issues that prevent plugins from running.
+
+Additionally, if you're having trouble running a plugin in headless mode (without a GUI calling directly into the core), make sure you'er running the Commercial version of Binary Ninja as the Student/Non-Commercial edition does not support headless processing.
+
+Next, if running a python plugin, make sure the python requirements are met by your existing installation. Note that on windows, the bundled python is used and python requirements should be installed either by manually copying the modules to the `plugins` [folder](/getting-started/#directories).
+
## License Problems
-- 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 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/#license).
- If you need to change the email address on your license, contact [support].
## Linux