summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan Snyder <ryan@vector35.com>2018-07-09 22:58:18 -0400
committerRyan Snyder <ryan@vector35.com>2018-07-09 23:00:18 -0400
commit838cb56a8505fc78d09befedd58dd632eeb2ee62 (patch)
tree797da072919ae25e8d26a90663c0760e9ef29707 /docs
parent69743572b93f2e29583751d1ec9656fbb34b9411 (diff)
parent4f1a7824357ab58d868dbd675af9b152fc3694e9 (diff)
Merge branch 'dev'
Diffstat (limited to 'docs')
-rw-r--r--docs/about/open-source.md10
-rw-r--r--docs/getting-started.md28
2 files changed, 18 insertions, 20 deletions
diff --git a/docs/about/open-source.md b/docs/about/open-source.md
index a25fb24e..be9725d0 100644
--- a/docs/about/open-source.md
+++ b/docs/about/open-source.md
@@ -22,13 +22,11 @@ The previous tools are used in the generation of our documentation, but are not
* Core
- [discount] ([discount license] - BSD)
- - [libcurl] ([libcurl license] - MIT/X derivative)
- [libgit2] ([libgit2 license] - GPLv2 with linking exception)
- [libmspack] ([libmspack license] - LGPL, v2)
- [llvm] ([llvm license] - BSD-style)
- [lzf] ([lzf license] - BSD)
- [jemalloc] ([jemalloc license] - BSD)
- - [openssl] ([openssl license] - openssl license)
- [sqlite] ([sqlite license] - public domain)
- [zlib] ([zlib license] - zlib license)
@@ -47,7 +45,7 @@ Binary Ninja uses [Qt 5.10] under an LGPLv3 license which requires that we host
Please note that we offer no support for running Binary Ninja with modified Qt libraries.
1. Follow the installation requirements on the [Building Qt 5 from Git] page.
-2. Download the Qt 5.10.0 [tarball] from binary.ninja. (Note this is an unmodified 5.10 identical to that available from Qt's source control, but must be hosted locally according to the [Qt 5.10] terms.)
+2. Download the Qt 5.10.1 [tarball] from binary.ninja. (Note this is an unmodified 5.10 identical to that available from Qt's source control, but must be hosted locally according to the [Qt 5.10] terms.)
3. Next, build QT using the aforementioned instructions.
4. On OS X, you will need to disable the code-signing signature since it would otherwise prevent changes to binaries or shared libraries. We recommend a tool such as [unsign].
5. Finally, replace the built libraries:
@@ -69,8 +67,6 @@ Please note that we offer no support for running Binary Ninja with modified Qt l
[discount]: http://www.pell.portland.or.us/~orc/Code/discount/
[doxygen license]: https://github.com/doxygen/doxygen/blob/master/LICENSE
[doxygen]: http://www.stack.nl/~dimitri/doxygen/
-[libcurl]: https://curl.haxx.se/
-[libcurl license]: https://curl.haxx.se/docs/copyright.html
[libgit2]: https://libgit2.github.com/
[libgit2 license]: https://github.com/libgit2/libgit2/blob/master/COPYING
[libmspack]: https://www.cabextract.org.uk/libmspack/
@@ -87,8 +83,6 @@ Please note that we offer no support for running Binary Ninja with modified Qt l
[mkdocs]: http://www.mkdocs.org/
[opensans license]: http://www.apache.org/licenses/LICENSE-2.0.html
[opensans]: https://www.google.com/fonts/specimen/Open+Sans
-[openssl license]: https://www.openssl.org/source/license.html
-[openssl]: https://www.openssl.org/
[qt license]: https://www.qt.io/qt-licensing-terms/
[qt]: https://www.qt.io/download/
[sourcecodepro license]: https://github.com/adobe-fonts/source-code-pro/blob/master/LICENSE.txt
@@ -97,7 +91,7 @@ Please note that we offer no support for running Binary Ninja with modified Qt l
[sphinx]: http://www.sphinx-doc.org/en/stable/index.html
[sqlite license]: https://www.sqlite.org/copyright.html
[sqlite]: https://www.sqlite.org/index.html
-[tarball]: https://binary.ninja/qt5.10.0.tar.xz
+[tarball]: https://binary.ninja/qt5.10.1.tar.xz
[tomcrypt license]: https://github.com/libtom/libtomcrypt/blob/develop/LICENSE
[tomcrypt]: https://github.com/libtom/libtomcrypt
[unsign]: https://github.com/steakknife/unsign
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 922a7b7f..7e7e4acb 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -96,7 +96,7 @@ Switching views happens multiple ways. In some instances, it's automatic (clicki
- `e` : Edits an instruction (by modifying the original binary -- currently only enabled for x86, and x64)
- `x` : Focuses the cross-reference pane
- `;` : Adds a comment
- - `i` : Switches between disassembly and low-level il in graph view
+ - `i` : Cycles between disassembly, low-level il, and medium-level il in graph view
- `y` : Change type
- `a` : Change the data type to an ASCII string
- [1248] : Change type directly to a data variable of the indicated widths
@@ -257,17 +257,20 @@ On windows, this is achieved through a separate launcher that loads first and re
Settings are stored in the _user_ directory in the file `settings.json`. Each top level object in this file is represents a different plugin. As of build 860 the following settings are available:
-|Plugin | Setting | Type | Default | Description |
-|------:|-------------------------:|-------------:|-----------------------------------------------:|:----------------------------------------------------------------------------------------------|
-| core | linux\_ca\_bundle | string | "" | Certificate authority (.pem or .crt) file to be used for secure downloads |
-| core | linux\_ca\_dir | string | "" | Certificate authority directory (for distributions without a CA bundle) |
-| ui | activeContent | boolean | True | Allow Binary Ninja to connect to the web to check for updates |
-| ui | colorblind | boolean | True | Choose colors that are visible to those with red/green colorblind |
-| ui | debug | boolean | False | Enable developer debugging features (Additional views: Lifted IL, and SSA forms) |
-| pdb | local-store-absolute | string | "" | Absolute path specifying where the pdb symbol store exists on this machine, overrides relative path |
-| pdb | local-store-relative | string | "symbols" | Path *relative* to the binaryninja _user_ directory, sepcifying the pdb symbol store |
-| pdb | auto-download-pdb | boolean | True | Automatically download pdb files from specified symbol servers |
-| pdb | symbol-server-list | list(string) | ["http://msdl.microsoft.com/download/symbols"] | List of servers to query for pdb symbols. |
+|Plugin | Setting | Type | Default | Description |
+|----------:|-------------------------:|-------------:|-----------------------------------------------:|:----------------------------------------------------------------------------------------------|
+| analysis | max-function-size | integer | 65536 | Any functions over this size will not be automatically analyzed and require manual override |
+| core | linux\_ca\_bundle | string | "" | Certificate authority (.pem or .crt) file to be used for secure downloads |
+| core | linux\_ca\_dir | string | "" | Certificate authority directory (for distributions without a CA bundle) |
+| ui | activeContent | boolean | True | Allow Binary Ninja to connect to the web to check for updates |
+| ui | colorblind | boolean | True | Choose colors that are visible to those with red/green colorblind |
+| ui | debug | boolean | False | Enable developer debugging features (Additional views: Lifted IL, and SSA forms) |
+| ui | recent-file-limit | integer | 10 | Specify limit for number of recent files |
+| pdb | local-store-absolute | string | "" | Absolute path specifying where the pdb symbol store exists on this machine, overrides relative path |
+| pdb | local-store-relative | string | "symbols" | Path *relative* to the binaryninja _user_ directory, sepcifying the pdb symbol store |
+| pdb | auto-download-pdb | boolean | True | Automatically download pdb files from specified symbol servers |
+| pdb | symbol-server-list | list(string) | ["http://msdl.microsoft.com/download/symbols"] | List of servers to query for pdb symbols. |
+| python | interpreter | string | "python27.{dylib,dll,so.1}" | Python interpreter to load if one is not already present when plugins are loaded |
Below is an example `settings.json` setting various options:
```
@@ -277,6 +280,7 @@ Below is an example `settings.json` setting various options:
"activeContent" : false,
"colorblind" : false,
"debug" : true
+ "recent-file-limit" : 10
}
"pdb" :
{