summaryrefslogtreecommitdiff
path: root/docs/getting-started.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2018-06-15 13:03:44 -0400
committerJordan Wiens <jordan@psifertex.com>2018-06-15 13:03:44 -0400
commitdcfc1ea5303cfb5963778ef760fd3e6b2f6252f8 (patch)
tree71e84226d1b5c8e62579f7a97b29ebb49e79d936 /docs/getting-started.md
parent89248d9bdcf24e5ba4e49ae9871161648fd2d5a0 (diff)
add max-function-size to advanced settings documentation
Diffstat (limited to 'docs/getting-started.md')
-rw-r--r--docs/getting-started.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md
index e30a07fa..7e7e4acb 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -257,19 +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) |
-| 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 |
+|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:
```