From 7cde074b0149edc4d5dd7fae8308150652a34454 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Wed, 24 Mar 2021 15:20:43 -0400 Subject: update settings, remove qtdownload provider from troubleshooting --- docs/getting-started.md | 112 ++++++++++++++++++++++-------------------- docs/guide/troubleshooting.md | 2 +- 2 files changed, 59 insertions(+), 55 deletions(-) (limited to 'docs') diff --git a/docs/getting-started.md b/docs/getting-started.md index 51a031e6..053e66f0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -498,40 +498,40 @@ Here's a list of all settings currently available from the UI: |Category|Setting|Description|Type|Default|Scope|Key| |---|---|---|---|---|---|---| -|analysis|Disallow Branch to String|Enable the ability to halt analysis of branch targets that fall within a string reference. This setting may be useful for malformed binaries.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.conservative.disallowBranchToString| -|analysis|Never Save Undo Data|Never save previous user actions to the database.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.database.neverSaveUndoData| -|analysis|Suppress Reanalysis|Disable function reanalysis on database load when the product version or analysis settings change.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.database.suppressReanalysis| -|analysis|Alternate Type Propagation|Enable an alternate approach for function type propagation. This setting is experimental and may be useful for some binaries.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.experimental.alternateTypePropagation| -|analysis|Correlated Memory Value Propagation|Attempt to propagate the value of an expression from a memory definition to a usage. Currently this feature is simplistic and the scope is a single basic block. This setting is experimental and may be useful for some binaries.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.experimental.correlatedMemoryValuePropagation| -|analysis|Heuristic Value Range Clamping|Use DataVariable state inferencing to help determine the possible size of a lookup table.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.experimental.heuristicRangeClamp| -|analysis|Always Analyze Indirect Branches|When using faster analysis modes, perform full analysis of functions containing indirect branches.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.forceIndirectBranches| -|analysis|Advanced Analysis Cache Size|Controls the number of functions for which the most recent generated advanced analysis is cached. Large values may result in very high memory utilization.|`number`|`64`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.cacheSize| -|analysis|Max Function Analysis Time|Any functions that exceed this analysis time are deferred. A value of 0 disables this feature. The default value is 20 seconds. Time is specified in milliseconds.|`number`|`20000`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.maxFunctionAnalysisTime| -|analysis|Max Function Size|Any functions over this size will not be automatically analyzed. A value of 0 disables analysis of functions and suppresses the related log warning. To override see FunctionAnalysisSkipOverride. Size is specified in bytes.|`number`|`65536`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.maxFunctionSize| -|analysis|Max Function Update Count|Any functions that exceed this incremental update count are deferred. A value of 0 disables this feature.|`number`|`100`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.maxFunctionUpdateCount| -|analysis|Max Lookup Table Size|Limits the maximum number of entries for a lookup table.|`number`|`4095`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.maxLookupTableSize| -|analysis|Maximum String Annotation Length|The maximum substring length that will be shown in string annotations.|`number`|`32`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.maxStringAnnotationLength| -|analysis|Minimum String Length|The minimum length for strings created during auto-analysis|`number`|`4`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.minStringLength| -|analysis|Worker Thread Count|The number of worker threads available for concurrent analysis activities.|`number`|`15`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.limits.workerThreadCount| -|analysis|Autorun Linear Sweep|Automatically run linear sweep when opening a binary for analysis.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.linearSweep.autorun| -|analysis|Control Flow Graph Analysis|Enable the control flow graph analysis (Analysis Phase 3) portion of linear sweep.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.linearSweep.controlFlowGraph| -|analysis|Detailed Linear Sweep Log Information|Linear sweep generates additional log information at the InfoLog level.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.linearSweep.detailedLogInfo| -|analysis|Entropy Heuristics for Linear Sweep|Enable the application of entropy based heuristics to the function search space for linear sweep.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.linearSweep.entropyHeuristics| -|analysis|Max Linear Sweep Work Queues|The number of binary regions under concurrent analysis.|`number`|`64`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.linearSweep.maxWorkQueues| -|analysis|Analysis Mode|Controls the amount of analysis performed on functions.|`string`|`full`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.mode| +|analysis|Disallow Branch to String|Enable the ability to halt analysis of branch targets that fall within a string reference. This setting may be useful for malformed binaries.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.conservative.disallowBranchToString| +|analysis|Never Save Undo Data|Never save previous user actions to the database.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.database.neverSaveUndoData| +|analysis|Suppress Reanalysis|Disable function reanalysis on database load when the product version or analysis settings change.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.database.suppressReanalysis| +|analysis|Alternate Type Propagation|Enable an alternate approach for function type propagation. This setting is experimental and may be useful for some binaries.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.experimental.alternateTypePropagation| +|analysis|Correlated Memory Value Propagation|Attempt to propagate the value of an expression from a memory definition to a usage. Currently this feature is simplistic and the scope is a single basic block. This setting is experimental and may be useful for some binaries.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.experimental.correlatedMemoryValuePropagation| +|analysis|Heuristic Value Range Clamping|Use DataVariable state inferencing to help determine the possible size of a lookup table.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.experimental.heuristicRangeClamp| +|analysis|Always Analyze Indirect Branches|When using faster analysis modes, perform full analysis of functions containing indirect branches.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.forceIndirectBranches| +|analysis|Advanced Analysis Cache Size|Controls the number of functions for which the most recent generated advanced analysis is cached. Large values may result in very high memory utilization.|`number`|`64`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.cacheSize| +|analysis|Max Function Analysis Time|Any functions that exceed this analysis time are deferred. A value of 0 disables this feature. The default value is 20 seconds. Time is specified in milliseconds.|`number`|`20000`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.maxFunctionAnalysisTime| +|analysis|Max Function Size|Any functions over this size will not be automatically analyzed. A value of 0 disables analysis of functions and suppresses the related log warning. To override see FunctionAnalysisSkipOverride. Size is specified in bytes.|`number`|`65536`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.maxFunctionSize| +|analysis|Max Function Update Count|Any functions that exceed this incremental update count are deferred. A value of 0 disables this feature.|`number`|`100`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.maxFunctionUpdateCount| +|analysis|Max Lookup Table Size|Limits the maximum number of entries for a lookup table.|`number`|`4095`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.maxLookupTableSize| +|analysis|Maximum String Annotation Length|The maximum substring length that will be shown in string annotations.|`number`|`32`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.maxStringAnnotationLength| +|analysis|Minimum String Length|The minimum length for strings created during auto-analysis|`number`|`4`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.minStringLength| +|analysis|Worker Thread Count|The number of worker threads available for concurrent analysis activities.|`number`|`15`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.limits.workerThreadCount| +|analysis|Autorun Linear Sweep|Automatically run linear sweep when opening a binary for analysis.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.linearSweep.autorun| +|analysis|Control Flow Graph Analysis|Enable the control flow graph analysis (Analysis Phase 3) portion of linear sweep.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.linearSweep.controlFlowGraph| +|analysis|Detailed Linear Sweep Log Information|Linear sweep generates additional log information at the InfoLog level.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.linearSweep.detailedLogInfo| +|analysis|Entropy Heuristics for Linear Sweep|Enable the application of entropy based heuristics to the function search space for linear sweep.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.linearSweep.entropyHeuristics| +|analysis|Max Linear Sweep Work Queues|The number of binary regions under concurrent analysis.|`number`|`64`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.linearSweep.maxWorkQueues| +|analysis|Analysis Mode|Controls the amount of analysis performed on functions.|`string`|`full`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.mode| | | | enum: Only perform control flow analysis on the binary. Cross references are valid only for direct function calls. [Disassembly Only]|`enum`|`controlFlow`| | | | | | enum: Perform fast initial analysis of the binary. This mode does not analyze types or data flow through stack variables. [LLIL and Equivalents]|`enum`|`basic`| | | | | | enum: Perform analysis which includes type propagation and data flow. [MLIL and Equivalents]|`enum`|`intermediate`| | | | | | enum: Perform full analysis of the binary.|`enum`|`full`| | | -|analysis|Autorun Function Signature Matcher|Automatically run the function signature matcher when opening a binary for analysis.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.signatureMatcher.autorun| -|analysis|Auto Function Analysis Suppression|Enable suppressing analysis of automatically discovered functions.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.suppressNewAutoFunctionAnalysis| -|analysis|Tail Call Heuristics|Attempts to recover function starts that may be obscured by tail call optimization (TCO). Specifically, branch targets within a function are analyzed as potential function starts.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.tailCallHeuristics| -|analysis|Tail Call Translation|Performs tail call translation for jump instructions where the target is an existing function start.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.tailCallTranslation| -|analysis|Simplify Templates|Simplify common C++ templates that are expanded with default arguments at compile time (eg. `std::__cxx11::basic_string, std::allocator >` to `std::wstring`).|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.types.TemplateSimplifier| -|analysis|Unicode Blocks|Defines which unicode blocks to consider when searching for strings.|`array`|[]|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.unicode.blocks| -|analysis|UTF-16 Encoding|Whether or not to consider UTF-16 code points when searching for strings.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.unicode.utf16| -|analysis|UTF-32 Encoding|Whether or not to consider UTF-32 code points when searching for strings.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.unicode.utf32| -|analysis|UTF-8 Encoding|Whether or not to consider UTF-8 code points when searching for strings.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|analysis.unicode.utf8| +|analysis|Autorun Function Signature Matcher|Automatically run the function signature matcher when opening a binary for analysis.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.signatureMatcher.autorun| +|analysis|Auto Function Analysis Suppression|Enable suppressing analysis of automatically discovered functions.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.suppressNewAutoFunctionAnalysis| +|analysis|Tail Call Heuristics|Attempts to recover function starts that may be obscured by tail call optimization (TCO). Specifically, branch targets within a function are analyzed as potential function starts.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.tailCallHeuristics| +|analysis|Tail Call Translation|Performs tail call translation for jump instructions where the target is an existing function start.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.tailCallTranslation| +|analysis|Simplify Templates|Simplify common C++ templates that are expanded with default arguments at compile time (eg. `std::__cxx11::basic_string, std::allocator >` to `std::wstring`).|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.types.TemplateSimplifier| +|analysis|Unicode Blocks|Defines which unicode blocks to consider when searching for strings.|`array`|[]|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.unicode.blocks| +|analysis|UTF-16 Encoding|Whether or not to consider UTF-16 code points when searching for strings.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.unicode.utf16| +|analysis|UTF-32 Encoding|Whether or not to consider UTF-32 code points when searching for strings.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.unicode.utf32| +|analysis|UTF-8 Encoding|Whether or not to consider UTF-8 code points when searching for strings.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|analysis.unicode.utf8| |arch|x86 Disassembly Case|Specify the case for opcodes, operands, and registers.|`boolean`|`True`|[`SettingsUserScope`]|arch.x86.disassembly.lowercase| |arch|x86 Disassembly Separator|Specify the token separator between operands.|`string`|`, `|[`SettingsUserScope`]|arch.x86.disassembly.separator| |arch|x86 Disassembly Syntax|Specify disassembly syntax for the x86/x86_64 architectures.|`string`|`BN_INTEL`|[`SettingsUserScope`]|arch.x86.disassembly.syntax| @@ -556,7 +556,7 @@ Here's a list of all settings currently available from the UI: | | | |`enum`|`QtDownloadProvider`| | | | | | |`enum`|`CoreDownloadProvider`| | | | | | |`enum`|`PythonDownloadProvider`| | | -|files|Auto Rebase Load File|When opening a file with options, automatically rebase an image which has a default load address of zero to 4MB for 64-bit binaries, or 64KB for 32-bit binaries.|`boolean`|`False`|[`SettingsUserScope`, `SettingsProjectScope`]|files.pic.autoRebase| +|files|Auto Rebase Load File|When opening a file with options, automatically rebase an image which has a default load address of zero to 4MB for 64-bit binaries, or 64KB for 32-bit binaries.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`]|files.pic.autoRebase| |files|Universal Mach-O Architecture Preference|Specify an architecture preference for automatic loading of a Mach-O file from a Universal archive. By default, the first object file in the listing is loaded.|`array`|[]|[`SettingsUserScope`]|files.universal.architecturePreference| | | | |`enum`|`alpha`| | | | | | |`enum`|`arm`| | | @@ -574,16 +574,19 @@ Here's a list of all settings currently available from the UI: | | | |`enum`|`vax`| | | | | | |`enum`|`x86`| | | | | | |`enum`|`x86_64`| | | -|pdb|Auto Download PDBs|Automatically download pdb files from specified symbol servers.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|pdb.autoDownload| -|pdb|Absolute PDB Symbol Store Path|Absolute path specifying where the PDB symbol store exists on this machine, overrides relative path.|`string`| |[`SettingsUserScope`, `SettingsProjectScope`]|pdb.localStoreAbsolute| -|pdb|Relative PDB Symbol Store Path|Path *relative* to the binaryninja _user_ directory, specifying the pdb symbol store.|`string`|`symbols`|[`SettingsUserScope`, `SettingsProjectScope`]|pdb.localStoreRelative| -|pdb|Symbol Server List|List of servers to query for pdb symbols.|`array`|[`https://msdl.microsoft.com/download/symbols`]|[`SettingsUserScope`, `SettingsProjectScope`]|pdb.symbolServerList| +|pdb|Auto Download PDBs|Automatically download pdb files from specified symbol servers.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|pdb.autoDownload| +|pdb|Absolute PDB Symbol Store Path|Absolute path specifying where the PDB symbol store exists on this machine, overrides relative path.|`string`| |[`SettingsProjectScope`, `SettingsUserScope`]|pdb.localStoreAbsolute| +|pdb|Relative PDB Symbol Store Path|Path *relative* to the binaryninja _user_ directory, specifying the pdb symbol store.|`string`|`symbols`|[`SettingsProjectScope`, `SettingsUserScope`]|pdb.localStoreRelative| +|pdb|Symbol Server List|List of servers to query for pdb symbols.|`array`|[`https://msdl.microsoft.com/download/symbols`]|[`SettingsProjectScope`, `SettingsUserScope`]|pdb.symbolServerList| |pluginManager|Community Plugin Manager Update Channel|Specify which community update channel the Plugin Manager should update plugins from.|`string`|`master`|[`SettingsUserScope`]|pluginManager.communityUpdateChannel| | | | enum: The default channel. This setting should be used unless you are testing the Plugin Manager.|`enum`|`master`| | | | | | enum: Plugin Manager test channel.|`enum`|`test`| | | |pluginManager|Official Plugin Manager Update Channel|Specify which official update channel the Plugin Manager should update plugins from.|`string`|`master`|[`SettingsUserScope`]|pluginManager.officialUpdateChannel| | | | enum: The default channel. This setting should be used unless you are testing the Plugin Manager.|`enum`|`master`| | | | | | enum: Plugin Manager test channel.|`enum`|`test`| | | +|pluginManager|Unofficial 3rd Party Plugin Repository Display Name|Specify display name of 3rd party plugin repository.|`string`| |[`SettingsUserScope`]|pluginManager.unofficialName| +|pluginManager|Unofficial 3rd Party Plugin Repository URL|Specify URL of 3rd party plugin|`string`| |[`SettingsUserScope`]|pluginManager.unofficialUrl| +|python|Python Path Override|Python interpreter binary which may be necessary to install plugin dependencies. Should be the same version as the one specified in the 'Python Interpreter' setting|`string`| |[`SettingsUserScope`]|python.binaryOverride| |python|Python Interpreter|Python interpreter library(dylib/dll/so.1) to load if one is not already present when plugins are loaded.|`string`| |[`SettingsUserScope`]|python.interpreter| |python|Minimum Python Log Level|Set the minimum Python log level which applies in headless operation only. The log is connected to stderr. Additionally, stderr must be associated with a terminal device.|`string`|`WarningLog`|[`SettingsUserScope`]|python.log.minLevel| | | | enum: Print Debug, Info, Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`DebugLog`| | | @@ -592,23 +595,24 @@ Here's a list of all settings currently available from the UI: | | | enum: Print Error and Alert messages to stderr on the terminal device.|`enum`|`ErrorLog`| | | | | | enum: Print Alert messages to stderr on the terminal device.|`enum`|`AlertLog`| | | | | | enum: Disable all logging in headless operation.|`enum`|`Disabled`| | | -|triage|Triage Analysis Mode|Controls the amount of analysis performed on functions when opening for triage.|`string`|`basic`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|triage.analysisMode| +|python|Python Virtual Environment Site-Packages|The 'site-packages' directory for your python virtual environment.|`string`| |[`SettingsUserScope`]|python.virtualenv| +|triage|Triage Analysis Mode|Controls the amount of analysis performed on functions when opening for triage.|`string`|`basic`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|triage.analysisMode| | | | enum: Only perform control flow analysis on the binary. Cross references are valid only for direct function calls.|`enum`|`controlFlow`| | | | | | enum: Perform fast initial analysis of the binary. This mode does not analyze types or data flow through stack variables.|`enum`|`basic`| | | | | | enum: Perform full analysis of the binary.|`enum`|`full`| | | -|triage|Triage Shows Hidden Files|Whether the Triage file picker shows hidden files.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|triage.hiddenFiles| -|triage|Triage Linear Sweep Mode|Controls the level of linear sweep performed when opening for triage.|`string`|`partial`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|triage.linearSweep| +|triage|Triage Shows Hidden Files|Whether the Triage file picker shows hidden files.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|triage.hiddenFiles| +|triage|Triage Linear Sweep Mode|Controls the level of linear sweep performed when opening for triage.|`string`|`partial`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|triage.linearSweep| | | | enum: Do not perform linear sweep of the binary.|`enum`|`none`| | | | | | enum: Perform linear sweep on the binary, but skip the control flow graph analysis phase.|`enum`|`partial`| | | | | | enum: Perform full linear sweep on the binary.|`enum`|`full`| | | -|triage|Always Prefer Triage Summary View|Always prefer opening binaries in Triage Summary view, even when performing full analysis.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|triage.preferSummaryView| -|triage|Prefer Triage Summary View for Raw Files|Prefer opening raw files in Triage Summary view.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|triage.preferSummaryViewForRaw| +|triage|Always Prefer Triage Summary View|Always prefer opening binaries in Triage Summary view, even when performing full analysis.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|triage.preferSummaryView| +|triage|Prefer Triage Summary View for Raw Files|Prefer opening raw files in Triage Summary view.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|triage.preferSummaryViewForRaw| |ui|Color Blind|Choose colors that are visible to those with red/green color blindness.|`boolean`|`False`|[`SettingsUserScope`]|ui.colorBlind| |ui|Debug Mode|Enable developer debugging features (Additional views: Lifted IL, and IL SSA forms).|`boolean`|`False`|[`SettingsUserScope`]|ui.debugMode| |ui|Dock Window Title Bars|Enable to display title bars for dockable windows attached to a main window.|`boolean`|`True`|[`SettingsUserScope`]|ui.docks.titleBars| -|ui|Feature Map Auto-Rotate|Automatically rotate the feature map orientation based on the current layout and dimensions.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.featureMap.autoRotate| -|ui|Feature Map|Enable the feature map which displays a visual overview of the BinaryView.|`boolean`|`True`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|ui.featureMap.enable| -|ui|Feature Map File-Backed Only Mode|Exclude mapped regions that are not backed by a load file.|`boolean`|`False`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|ui.featureMap.fileBackedOnly| +|ui|Feature Map Auto-Rotate|Automatically rotate the feature map orientation based on the current layout and dimensions.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.featureMap.autoRotate| +|ui|Feature Map|Enable the feature map which displays a visual overview of the BinaryView.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|ui.featureMap.enable| +|ui|Feature Map File-Backed Only Mode|Exclude mapped regions that are not backed by a load file.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|ui.featureMap.fileBackedOnly| |ui|File Contents Lock|Lock the file contents to prevent accidental edits from the UI. File modification via API and menu based patching is explicitly allowed while the lock is enabled.|`boolean`|`True`|[`SettingsUserScope`]|ui.fileContentsLock| |ui|Auto Open with Options|Specify the file types which automatically open with the options dialog.|`array`|[`Mapped`, `Universal`]|[`SettingsUserScope`]|ui.files.openWithOptions| | | | |`enum`|`Mapped`| | | @@ -642,15 +646,15 @@ Here's a list of all settings currently available from the UI: | | | |`enum`|`Python`| | | |ui|Scripting Provider History Size|Specify the maximum number of lines contained in the scripting history.|`number`|`1000`|[`SettingsUserScope`]|ui.scripting.historySize| |ui|Display Settings Identifiers|Display setting identifiers in the UI settings view.|`boolean`|`False`|[`SettingsUserScope`]|ui.settings.displayIdentifiers| -|ui|HLIL Scoping Style|Controls the display of new scopes in HLIL.|`string`|`default`|[`SettingsResourceScope`, `SettingsUserScope`, `SettingsProjectScope`]|ui.style.hlil.scoping| +|ui|HLIL Scoping Style|Controls the display of new scopes in HLIL.|`string`|`default`|[`SettingsProjectScope`, `SettingsUserScope`, `SettingsResourceScope`]|ui.style.hlil.scoping| | | | enum: Default BNIL scoping style.|`enum`|`default`| | | | | | enum: Braces around scopes, same line.|`enum`|`braces`| | | | | | enum: Braces around scopes, new line.|`enum`|`bracesNewLine`| | | -|ui|Show Exported Data Variables|Show exported data variables in the symbol list.|`boolean`|`False`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.symbolList.showExportedDataVars| -|ui|Show Exported Functions|Show exported functions in the symbol list.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.symbolList.showExportedFunctions| -|ui|Show Imports|Show imports in the symbol list.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.symbolList.showImports| -|ui|Show Local Data Variables|Show local data variables in the symbol list.|`boolean`|`False`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.symbolList.showLocalDataVars| -|ui|Show Local Functions|Show local functions in the symbol list.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.symbolList.showLocalFunctions| +|ui|Show Exported Data Variables|Show exported data variables in the symbol list.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.symbolList.showExportedDataVars| +|ui|Show Exported Functions|Show exported functions in the symbol list.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.symbolList.showExportedFunctions| +|ui|Show Imports|Show imports in the symbol list.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.symbolList.showImports| +|ui|Show Local Data Variables|Show local data variables in the symbol list.|`boolean`|`False`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.symbolList.showLocalDataVars| +|ui|Show Local Functions|Show local functions in the symbol list.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.symbolList.showLocalFunctions| |ui|Theme|Customize the appearance and style of Binary Ninja.|`string`|`Dark`|[`SettingsUserScope`]|ui.theme| |ui|Graph View IL Carousel|Specify the IL view types and order for use with the 'Cycle IL' actions in Graph view.|`array`|[`Disassembly`, `LowLevelIL`, `MediumLevelIL`, `HighLevelIL`]|[`SettingsUserScope`]|ui.view.graph.carousel| | | | |`enum`|`Disassembly`| | | @@ -698,7 +702,7 @@ Here's a list of all settings currently available from the UI: | | | |`enum`|`MappedMediumLevelILSSAForm`| | | | | | |`enum`|`HighLevelIL`| | | | | | |`enum`|`HighLevelILSSAForm`| | | -|ui|Default IL for Reflection View|Default IL for reflection view on startup.|`string`|`Disassembly`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.view.reflection.il| +|ui|Default IL for Reflection View|Default IL for reflection view on startup.|`string`|`Disassembly`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.view.reflection.il| | | | |`enum`|`Disassembly`| | | | | | |`enum`|`LowLevelIL`| | | | | | |`enum`|`LiftedIL`| | | @@ -709,7 +713,7 @@ Here's a list of all settings currently available from the UI: | | | |`enum`|`MappedMediumLevelILSSAForm`| | | | | | |`enum`|`HighLevelIL`| | | | | | |`enum`|`HighLevelILSSAForm`| | | -|ui|Reflection View IL Map|Specify the IL view to display based on a given source IL view. The source IL view is encoded as the index of this array and corresponds to the values defined in BNFunctionGraphType.|`array`|[`LowLevelIL`, `Disassembly`, `Disassembly`, `Disassembly`, `LowLevelIL`, `LowLevelILSSAForm`, `LowLevelIL`, `LowLevelILSSAForm`, `MediumLevelIL`, `MediumLevelILSSAForm`]|[`SettingsUserScope`, `SettingsProjectScope`]|ui.view.reflection.ilMap| +|ui|Reflection View IL Map|Specify the IL view to display based on a given source IL view. The source IL view is encoded as the index of this array and corresponds to the values defined in BNFunctionGraphType.|`array`|[`LowLevelIL`, `Disassembly`, `Disassembly`, `Disassembly`, `LowLevelIL`, `LowLevelILSSAForm`, `LowLevelIL`, `LowLevelILSSAForm`, `MediumLevelIL`, `MediumLevelILSSAForm`]|[`SettingsProjectScope`, `SettingsUserScope`]|ui.view.reflection.ilMap| | | | |`enum`|`Disassembly`| | | | | | |`enum`|`LowLevelIL`| | | | | | |`enum`|`LiftedIL`| | | @@ -720,12 +724,12 @@ Here's a list of all settings currently available from the UI: | | | |`enum`|`MappedMediumLevelILSSAForm`| | | | | | |`enum`|`HighLevelIL`| | | | | | |`enum`|`HighLevelILSSAForm`| | | -|ui|Reflection View IL Synchronization|Reflection view follows main view IL changes according to the Reflection View IL Map.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.view.reflection.ilSync| -|ui|Reflection View Location Synchronization|Reflection view follows navigation actions in the main view.|`boolean`|`True`|[`SettingsUserScope`, `SettingsProjectScope`]|ui.view.reflection.locationSync| +|ui|Reflection View IL Synchronization|Reflection view follows main view IL changes according to the Reflection View IL Map.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.view.reflection.ilSync| +|ui|Reflection View Location Synchronization|Reflection view follows navigation actions in the main view.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|ui.view.reflection.locationSync| |ui|TypeView Line Numbers|Controls the display of line numbers in the types view.|`boolean`|`True`|[`SettingsUserScope`]|ui.view.types.lineNumbers| |ui|File Path in Window Title|Controls whether the window title includes the full file path for the current file.|`boolean`|`False`|[`SettingsUserScope`]|ui.window.title.showPath| |updates|Active Content|Allow Binary Ninja to connect to the update server to check for updates and release notes.|`boolean`|`True`|[`SettingsUserScope`]|updates.activeContent| -|updates|Update Channel Preferences|Select update channel and version.|`string`|`2.3.2660`|[]|updates.channelPreferences| +|updates|Update Channel Preferences|Select update channel and version.|`string`|`None`|[]|updates.channelPreferences| |updates|Show All Versions|Show all versions that are available for the current update channel in the UI.|`boolean`|`False`|[`SettingsUserScope`]|updates.showAllVersions| |user|Email|The email that will be shown when collaborating with other users.|`string`| |[`SettingsUserScope`]|user.email| |user|Name|The name that will be shown when collaborating with other users.|`string`| |[`SettingsUserScope`]|user.name| diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index d6f6c22d..a4cad084 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -98,7 +98,7 @@ If you're running Catlina MacOS with the Python 3 installed by XCode and wish to { "downloadClient" : { - "providerName" : "QtDownloadProvider" + "providerName" : "PythonDownloadProvider" }, "python" : { -- cgit v1.3.1