From 0d526b92d13dc3708adf8427da4df59f8b090009 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Wed, 24 Feb 2021 01:25:56 -0500 Subject: cleanup settings formatting and update for 2.3 --- docs/getting-started.md | 265 +++++++++++++++++++++++++++--------------------- 1 file changed, 147 insertions(+), 118 deletions(-) (limited to 'docs') diff --git a/docs/getting-started.md b/docs/getting-started.md index 58bdc2ad..313f144d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -356,8 +356,9 @@ Here's a list of all settings currently available from the UI: |analysis|Suppress Reanalysis|Disable function reanalysis on database load when the product version or analysis settings change.|`boolean`|`False`|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`|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`|analysis.experimental.correlatedMemoryValuePropagation| +|analysis|Heuristic Value Range Clamping|Use DataVariable state inferencing to help determine the possible size of a lookup table.|`boolean`|`True`|analysis.experimental.heuristicRangeClamp| |analysis|Always Analyze Indirect Branches|When using faster analysis modes, perform full analysis of functions containing indirect branches.|`boolean`|`True`|analysis.forceIndirectBranches| -|analysis|Advanced Analysis Cache Size|Controls the number of functions for which the most recent generated advanced analysis is cached. Large values are may result in very high memory utilization.|`number`|`64`|analysis.limits.cacheSize| +|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`|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`|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`|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`|analysis.limits.maxFunctionUpdateCount| @@ -371,25 +372,25 @@ Here's a list of all settings currently available from the UI: |analysis|Entropy Heuristics for Linear Sweep|Enable the application of entropy based heuristics to the function search space for linear sweep.|`boolean`|`True`|analysis.linearSweep.entropyHeuristics| |analysis|Max Linear Sweep Work Queues|The number of binary regions under concurrent analysis.|`number`|`64`|analysis.linearSweep.maxWorkQueues| |analysis|Analysis Mode|Controls the amount of analysis performed on functions.|`string`|`full`|analysis.mode| -| | | enum: Only perform control flow analysis on the binary. Cross references are valid only for direct function calls. [Disassembly Only]|`enum`|`controlFlow`|analysis.mode| -| | | 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`|analysis.mode| -| | | enum: Perform analysis which includes type propagation and data flow. [MLIL and Equivalents]|`enum`|`intermediate`|analysis.mode| -| | | enum: Perform full analysis of the binary.|`enum`|`full`|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`|analysis.signatureMatcher.autorun| |analysis|Auto Function Analysis Suppression|Enable suppressing analysis of automatically discovered functions.|`boolean`|`False`|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`|analysis.tailCallHeuristics| |analysis|Tail Call Translation|Performs tail call translation for jump instructions where the target is an existing function start.|`boolean`|`True`|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`|analysis.types.TemplateSimplifier| -|analysis|Unicode Blocks|Defines which unicode blocks to consider when searching for strings.|`array`|`[]`|analysis.unicode.blocks| +|analysis|Unicode Blocks|Defines which unicode blocks to consider when searching for strings.|`array`|[]|analysis.unicode.blocks| |analysis|UTF-16 Encoding|Whether or not to consider UTF-16 code points when searching for strings.|`boolean`|`True`|analysis.unicode.utf16| |analysis|UTF-32 Encoding|Whether or not to consider UTF-32 code points when searching for strings.|`boolean`|`True`|analysis.unicode.utf32| |analysis|UTF-8 Encoding|Whether or not to consider UTF-8 code points when searching for strings.|`boolean`|`True`|analysis.unicode.utf8| |arch|x86 Disassembly Case|Specify the case for opcodes, operands, and registers.|`boolean`|`True`|arch.x86.disassembly.lowercase| |arch|x86 Disassembly Separator|Specify the token separator between operands.|`string`|`, `|arch.x86.disassembly.separator| |arch|x86 Disassembly Syntax|Specify disassembly syntax for the x86/x86_64 architectures.|`string`|`BN_INTEL`|arch.x86.disassembly.syntax| -| | | enum: Sets the disassembly syntax to a simplified Intel format. (TBD) |`enum`|`BN_INTEL`|arch.x86.disassembly.syntax| -| | | enum: Sets the disassembly syntax to Intel format. (Destination on the left) |`enum`|`INTEL`|arch.x86.disassembly.syntax| -| | | enum: Sets the disassembly syntax to AT&T format. (Destination on the right) |`enum`|`AT&T`|arch.x86.disassembly.syntax| +| | | enum: Sets the disassembly syntax to a simplified Intel format. (TBD) |`enum`|`BN_INTEL`| | +| | | enum: Sets the disassembly syntax to Intel format. (Destination on the left) |`enum`|`INTEL`| | +| | | enum: Sets the disassembly syntax to AT&T format. (Destination on the right) |`enum`|`AT&T`| | |corePlugins|Aarch64 Architecture|Enable the built-in Aarch64 architecture module.|`boolean`|`True`|corePlugins.architectures.aarch64| |corePlugins|ARMv7 Architecture|Enable the built-in ARMv7 architecture module.|`boolean`|`True`|corePlugins.architectures.armv7| |corePlugins|MIPS Architecture|Enable the built-in MIPS architecture module.|`boolean`|`True`|corePlugins.architectures.mips| @@ -403,58 +404,56 @@ Here's a list of all settings currently available from the UI: |corePlugins|macOS Platform|Enable the built-in macOS platform module.|`boolean`|`True`|corePlugins.platforms.mac| |corePlugins|Windows Platform|Enable the built-in Windows platform module.|`boolean`|`True`|corePlugins.platforms.windows| |corePlugins|Triage Plugin|Enable the built-in triage plugin.|`boolean`|`True`|corePlugins.triage| -|debugger|Debugger Function Start Annotations|Enables automatic additional annotations to be added to the start of functions that will persist after the debugger has moved away. Must break or step across the start of a function to trigger. Currently uses comments but will be migrated to ephemeral comments when that system is finished.|`boolean`|`False`|debugger.extra_annotations| -|downloadClient|HTTPS Proxy|Override default HTTPS proxy settings. By default, HTTPS Proxy settings are detected and used automatically via environment variables (e.g., https_proxy). Alternatively, proxy settings are obtained from the Internet Settings section of the Windows registry, or the Mac OS X System Configuration Framework.|`string`||downloadClient.httpsProxy| +|downloadClient|HTTPS Proxy|Override default HTTPS proxy settings. By default, HTTPS Proxy settings are detected and used automatically via environment variables (e.g., https_proxy). Alternatively, proxy settings are obtained from the Internet Settings section of the Windows registry, or the Mac OS X System Configuration Framework.|`string`| |downloadClient.httpsProxy| |downloadClient|Download Provider|Specify the registered DownloadProvider which enables resource fetching over HTTPS.|`string`|`CoreDownloadProvider`|downloadClient.providerName| -| | | |`enum`|`QtDownloadProvider`|downloadClient.providerName| -| | | |`enum`|`CoreDownloadProvider`|downloadClient.providerName| -| | | |`enum`|`PythonDownloadProvider`|downloadClient.providerName| -|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`|`[]`|files.universal.architecturePreference| -| | | |`enum`|`alpha`|files.universal.architecturePreference| -| | | |`enum`|`arm`|files.universal.architecturePreference| -| | | |`enum`|`arm64`|files.universal.architecturePreference| -| | | |`enum`|`arm64_32`|files.universal.architecturePreference| -| | | |`enum`|`hppa`|files.universal.architecturePreference| -| | | |`enum`|`i860`|files.universal.architecturePreference| -| | | |`enum`|`mc680x0`|files.universal.architecturePreference| -| | | |`enum`|`mc88000`|files.universal.architecturePreference| -| | | |`enum`|`mc98000`|files.universal.architecturePreference| -| | | |`enum`|`mips`|files.universal.architecturePreference| -| | | |`enum`|`ppc`|files.universal.architecturePreference| -| | | |`enum`|`ppc64`|files.universal.architecturePreference| -| | | |`enum`|`sparc`|files.universal.architecturePreference| -| | | |`enum`|`vax`|files.universal.architecturePreference| -| | | |`enum`|`x86`|files.universal.architecturePreference| -| | | |`enum`|`x86_64`|files.universal.architecturePreference| -|format_string_finder|Should Enable Tests Plugin|Enable the tests plugin. Only for development.|`boolean`|`False`|format_string_finder.should_enable_tests_plugin| -|format_string_finder|Should Highlight Variable Trace|Highlight instructions that are used in the trace of the format parameter origin.|`boolean`|`False`|format_string_finder.should_highlight_variable_trace| +| | | |`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`|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`|[]|files.universal.architecturePreference| +| | | |`enum`|`alpha`| | +| | | |`enum`|`arm`| | +| | | |`enum`|`arm64`| | +| | | |`enum`|`arm64_32`| | +| | | |`enum`|`hppa`| | +| | | |`enum`|`i860`| | +| | | |`enum`|`mc680x0`| | +| | | |`enum`|`mc88000`| | +| | | |`enum`|`mc98000`| | +| | | |`enum`|`mips`| | +| | | |`enum`|`ppc`| | +| | | |`enum`|`ppc64`| | +| | | |`enum`|`sparc`| | +| | | |`enum`|`vax`| | +| | | |`enum`|`x86`| | +| | | |`enum`|`x86_64`| | |pdb|Auto Download PDBs|Automatically download pdb files from specified symbol servers.|`boolean`|`True`|pdb.autoDownload| -|pdb|Absolute PDB Symbol Store Path|Absolute path specifying where the PDB symbol store exists on this machine, overrides relative path.|`string`||pdb.localStoreAbsolute| +|pdb|Absolute PDB Symbol Store Path|Absolute path specifying where the PDB symbol store exists on this machine, overrides relative path.|`string`| |pdb.localStoreAbsolute| |pdb|Relative PDB Symbol Store Path|Path *relative* to the binaryninja _user_ directory, specifying the pdb symbol store.|`string`|`symbols`|pdb.localStoreRelative| -|pdb|Symbol Server List|List of servers to query for pdb symbols.|`array`|`['https://msdl.microsoft.com/download/symbols']`|pdb.symbolServerList| +|pdb|Symbol Server List|List of servers to query for pdb symbols.|`array`|[`https://msdl.microsoft.com/download/symbols`]|pdb.symbolServerList| |pluginManager|Community Plugin Manager Update Channel|Specify which community update channel the Plugin Manager should update plugins from.|`string`|`master`|pluginManager.communityUpdateChannel| -| | | enum: The default channel. This setting should be used unless you are testing the Plugin Manager.|`enum`|`master`|pluginManager.communityUpdateChannel| -| | | enum: Plugin Manager test channel.|`enum`|`test`|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`|pluginManager.officialUpdateChannel| -| | | enum: The default channel. This setting should be used unless you are testing the Plugin Manager.|`enum`|`master`|pluginManager.officialUpdateChannel| -| | | enum: Plugin Manager test channel.|`enum`|`test`|pluginManager.officialUpdateChannel| -|python|Python Interpreter|Python interpreter library(dylib/dll/so.1) to load if one is not already present when plugins are loaded.|`string`||python.interpreter| +| | | 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`| | +|python|Python Interpreter|Python interpreter library(dylib/dll/so.1) to load if one is not already present when plugins are loaded.|`string`| |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`|python.log.minLevel| -| | | enum: Print Debug, Info, Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`DebugLog`|python.log.minLevel| -| | | enum: Print Info, Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`InfoLog`|python.log.minLevel| -| | | enum: Print Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`WarningLog`|python.log.minLevel| -| | | enum: Print Error and Alert messages to stderr on the terminal device.|`enum`|`ErrorLog`|python.log.minLevel| -| | | enum: Print Alert messages to stderr on the terminal device.|`enum`|`AlertLog`|python.log.minLevel| -| | | enum: Disable all logging in headless operation.|`enum`|`Disabled`|python.log.minLevel| +| | | enum: Print Debug, Info, Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`DebugLog`| | +| | | enum: Print Info, Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`InfoLog`| | +| | | enum: Print Warning, Error, and Alert messages to stderr on the terminal device.|`enum`|`WarningLog`| | +| | | 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`|triage.analysisMode| -| | | enum: Only perform control flow analysis on the binary. Cross references are valid only for direct function calls.|`enum`|`controlFlow`|triage.analysisMode| -| | | enum: Perform fast initial analysis of the binary. This mode does not analyze types or data flow through stack variables.|`enum`|`basic`|triage.analysisMode| -| | | enum: Perform full analysis of the binary.|`enum`|`full`|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`|triage.hiddenFiles| |triage|Triage Linear Sweep Mode|Controls the level of linear sweep performed when opening for triage.|`string`|`partial`|triage.linearSweep| -| | | enum: Do not perform linear sweep of the binary.|`enum`|`none`|triage.linearSweep| -| | | enum: Perform linear sweep on the binary, but skip the control flow graph analysis phase.|`enum`|`partial`|triage.linearSweep| -| | | enum: Perform full linear sweep on the binary.|`enum`|`full`|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`|triage.preferSummaryView| |triage|Prefer Triage Summary View for Raw Files|Prefer opening raw files in Triage Summary view.|`boolean`|`False`|triage.preferSummaryViewForRaw| |ui|Color Blind|Choose colors that are visible to those with red/green color blindness.|`boolean`|`False`|ui.colorBlind| @@ -463,94 +462,124 @@ Here's a list of all settings currently available from the UI: |ui|Feature Map Auto-Rotate|Automatically rotate the feature map orientation based on the current layout and dimensions.|`boolean`|`True`|ui.featureMap.autoRotate| |ui|Feature Map|Enable the feature map which displays a visual overview of the BinaryView.|`boolean`|`True`|ui.featureMap.enable| |ui|Feature Map File-Backed Only Mode|Exclude mapped regions that are not backed by a load file.|`boolean`|`False`|ui.featureMap.fileBackedOnly| -|ui|Auto Open with Options|Specify the file types which automatically open with the options dialog.|`array`|`['Mapped', 'Universal']`|ui.files.openWithOptions| -| | | |`enum`|`Mapped`|ui.files.openWithOptions| -| | | |`enum`|`ELF`|ui.files.openWithOptions| -| | | |`enum`|`Mach-O`|ui.files.openWithOptions| -| | | |`enum`|`PE`|ui.files.openWithOptions| -| | | |`enum`|`Universal`|ui.files.openWithOptions| +|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`|ui.fileContentsLock| +|ui|Auto Open with Options|Specify the file types which automatically open with the options dialog.|`array`|[`Mapped`, `Universal`]|ui.files.openWithOptions| +| | | |`enum`|`Mapped`| | +| | | |`enum`|`ELF`| | +| | | |`enum`|`Mach-O`| | +| | | |`enum`|`PE`| | +| | | |`enum`|`Universal`| | |ui|Antialiasing|Select font antialiasing style.|`string`|`subpixel`|ui.font.antialiasing| -| | | enum: Perform subpixel antialiasing on fonts.|`enum`|`subpixel`|ui.font.antialiasing| -| | | enum: Avoid subpixel antialiasing on fonts if possible.|`enum`|`grayscale`|ui.font.antialiasing| -| | | enum: No subpixel antialiasing at High DPI.|`enum`|`hidpi`|ui.font.antialiasing| -| | | enum: No font antialiasing.|`enum`|`none`|ui.font.antialiasing| +| | | enum: Perform subpixel antialiasing on fonts.|`enum`|`subpixel`| | +| | | enum: Avoid subpixel antialiasing on fonts if possible.|`enum`|`grayscale`| | +| | | enum: No subpixel antialiasing at High DPI.|`enum`|`hidpi`| | +| | | enum: No font antialiasing.|`enum`|`none`| | |ui|Bold Fonts|Allow bold fonts.|`boolean`|`True`|ui.font.bold| |ui|Font Name|Font family selection.|`string`|`Source Code Pro`|ui.font.name| |ui|Font Size|Font point size selection.|`number`|`12`|ui.font.size| |ui|Line Spacing|Specify an additional distance between adjacent baselines.|`number`|`1`|ui.font.spacing| -|ui|Font Style|Font Style selection.|`string`||ui.font.style| +|ui|Font Style|Font Style selection.|`string`| |ui.font.style| |ui|Number of history entries to store.|Controls the number of history entries to store for input dialogs.|`number`|`50`|ui.inputHistoryCount| +|ui|Maximum UI Log Size|Set the maximum number of lines for the UI log.|`number`|`10000`|ui.log.maxSize| |ui|Minimum UI Log Level|Set the minimum log level for the UI log.|`string`|`InfoLog`|ui.log.minLevel| -| | | enum: Display Debug, Info, Warning, Error, and Alert messages to log console.|`enum`|`DebugLog`|ui.log.minLevel| -| | | enum: Display Info, Warning, Error, and Alert messages to log console.|`enum`|`InfoLog`|ui.log.minLevel| -| | | enum: Display Warning, Error, and Alert messages to log console.|`enum`|`WarningLog`|ui.log.minLevel| -| | | enum: Display Error and Alert messages to log console.|`enum`|`ErrorLog`|ui.log.minLevel| -| | | enum: Display Alert messages to log console.|`enum`|`AlertLog`|ui.log.minLevel| +| | | enum: Display Debug, Info, Warning, Error, and Alert messages to log console.|`enum`|`DebugLog`| | +| | | enum: Display Info, Warning, Error, and Alert messages to log console.|`enum`|`InfoLog`| | +| | | enum: Display Warning, Error, and Alert messages to log console.|`enum`|`WarningLog`| | +| | | enum: Display Error and Alert messages to log console.|`enum`|`ErrorLog`| | +| | | enum: Display Alert messages to log console.|`enum`|`AlertLog`| | |ui|Manual Tooltip|Enable to prevent tooltips from showing without <ctrl> being held.|`boolean`|`False`|ui.manualTooltip| |ui|Recent Command Limit|Specify a limit for the recent command palette history.|`number`|`5`|ui.recentCommandLimit| |ui|Recent File Limit|Specify a limit for the recent file history in the new tab window.|`number`|`10`|ui.recentFileLimit| |ui|Show Indentation Guides|Show indentation markers in linear high-level IL|`boolean`|`True`|ui.renderIndentGuides| -|ui|Scripting Provider|Specify the registered ScriptingProvider for the default scripting console in the UI|`string`|`Python`|ui.scriptingProvider| -| | | |`enum`|`Python`|ui.scriptingProvider| +|ui|Default Scripting Provider|Specify the registered ScriptingProvider for the default scripting console in the UI.|`string`|`Python`|ui.scripting.defaultProvider| +| | | |`enum`|`Python`| | +|ui|Scripting Provider History Size|Specify the maximum number of lines contained in the scripting history.|`number`|`1000`|ui.scripting.historySize| |ui|Display Settings Identifiers|Display setting identifiers in the UI settings view.|`boolean`|`False`|ui.settings.displayIdentifiers| +|ui|HLIL Scoping Style|Controls the display of new scopes in HLIL.|`string`|`default`|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`|ui.symbolList.showExportedDataVars| |ui|Show Exported Functions|Show exported functions in the symbol list.|`boolean`|`True`|ui.symbolList.showExportedFunctions| |ui|Show Imports|Show imports in the symbol list.|`boolean`|`True`|ui.symbolList.showImports| |ui|Show Local Data Variables|Show local data variables in the symbol list.|`boolean`|`False`|ui.symbolList.showLocalDataVars| |ui|Show Local Functions|Show local functions in the symbol list.|`boolean`|`True`|ui.symbolList.showLocalFunctions| |ui|Theme|Customize the appearance and style of Binary Ninja.|`string`|`Dark`|ui.theme| -|ui|Linear View IL Carousel|Specify the IL view types and order for use with the 'Cycle IL' actions in Linear view.|`array`|`['Disassembly', 'LowLevelIL', 'MediumLevelIL', 'HighLevelIL']`|ui.view.linear.carousel| -| | | |`enum`|`Disassembly`|ui.view.linear.carousel| -| | | |`enum`|`LowLevelIL`|ui.view.linear.carousel| -| | | |`enum`|`LiftedIL`|ui.view.linear.carousel| -| | | |`enum`|`LowLevelILSSAForm`|ui.view.linear.carousel| -| | | |`enum`|`MediumLevelIL`|ui.view.linear.carousel| -| | | |`enum`|`MediumLevelILSSAForm`|ui.view.linear.carousel| -| | | |`enum`|`MappedMediumLevelIL`|ui.view.linear.carousel| -| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.view.linear.carousel| -| | | |`enum`|`HighLevelIL`|ui.view.linear.carousel| -| | | |`enum`|`HighLevelILSSAForm`|ui.view.linear.carousel| -|ui|Gutter Width|Disassembly view gutter and tags width, in characters.|`number`|`5`|ui.view.linear.gutterWidth| -|ui|Default Linear View Type|Default linear view type to display on startup.|`string`|`HighLevelIL`|ui.view.graph.il| -| | | |`enum`|`Disassembly`|ui.view.graph.il| -| | | |`enum`|`LowLevelIL`|ui.view.graph.il| -| | | |`enum`|`LiftedIL`|ui.view.graph.il| -| | | |`enum`|`LowLevelILSSAForm`|ui.view.graph.il| -| | | |`enum`|`MediumLevelIL`|ui.view.graph.il| -| | | |`enum`|`MediumLevelILSSAForm`|ui.view.graph.il| -| | | |`enum`|`MappedMediumLevelIL`|ui.view.graph.il| -| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.view.graph.il| -| | | |`enum`|`HighLevelIL`|ui.view.graph.il| -| | | |`enum`|`HighLevelILSSAForm`|ui.view.graph.il| -|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']`|ui.view.graph.carousel| -| | | |`enum`|`Disassembly`|ui.view.graph.carousel| -| | | |`enum`|`LowLevelIL`|ui.view.graph.carousel| -| | | |`enum`|`LiftedIL`|ui.view.graph.carousel| -| | | |`enum`|`LowLevelILSSAForm`|ui.view.graph.carousel| -| | | |`enum`|`MediumLevelIL`|ui.view.graph.carousel| -| | | |`enum`|`MediumLevelILSSAForm`|ui.view.graph.carousel| -| | | |`enum`|`MappedMediumLevelIL`|ui.view.graph.carousel| -| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.view.graph.carousel| -| | | |`enum`|`HighLevelIL`|ui.view.graph.carousel| -| | | |`enum`|`HighLevelILSSAForm`|ui.view.graph.carousel| -|ui|Default Disassembly Graph|Default disassembly graph to display on startup.|`string`|`Disassembly`|ui.view.graph.il| -| | | |`enum`|`Disassembly`|ui.view.graph.il| -| | | |`enum`|`LowLevelIL`|ui.view.graph.il| -| | | |`enum`|`LiftedIL`|ui.view.graph.il| -| | | |`enum`|`LowLevelILSSAForm`|ui.view.graph.il| -| | | |`enum`|`MediumLevelIL`|ui.view.graph.il| -| | | |`enum`|`MediumLevelILSSAForm`|ui.view.graph.il| -| | | |`enum`|`MappedMediumLevelIL`|ui.view.graph.il| -| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.view.graph.il| -| | | |`enum`|`HighLevelIL`|ui.view.graph.il| -| | | |`enum`|`HighLevelILSSAForm`|ui.view.graph.il| -|ui|Prefer Disassembly Graph|Prefer disassembly graph over linear view on startup.|`boolean`|`False`|ui.view.graph.preferred| +|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`]|ui.view.graph.carousel| +| | | |`enum`|`Disassembly`| | +| | | |`enum`|`LowLevelIL`| | +| | | |`enum`|`LiftedIL`| | +| | | |`enum`|`LowLevelILSSAForm`| | +| | | |`enum`|`MediumLevelIL`| | +| | | |`enum`|`MediumLevelILSSAForm`| | +| | | |`enum`|`MappedMediumLevelIL`| | +| | | |`enum`|`MappedMediumLevelILSSAForm`| | +| | | |`enum`|`HighLevelIL`| | +| | | |`enum`|`HighLevelILSSAForm`| | +|ui|Default IL for Graph View|Default IL for graph view on startup.|`string`|`Disassembly`|ui.view.graph.il| +| | | |`enum`|`Disassembly`| | +| | | |`enum`|`LowLevelIL`| | +| | | |`enum`|`LiftedIL`| | +| | | |`enum`|`LowLevelILSSAForm`| | +| | | |`enum`|`MediumLevelIL`| | +| | | |`enum`|`MediumLevelILSSAForm`| | +| | | |`enum`|`MappedMediumLevelIL`| | +| | | |`enum`|`MappedMediumLevelILSSAForm`| | +| | | |`enum`|`HighLevelIL`| | +| | | |`enum`|`HighLevelILSSAForm`| | +|ui|Prefer Disassembly Graph|Prefer graph view over linear view on startup.|`boolean`|`False`|ui.view.graph.preferred| +|ui|Linear View IL Carousel|Specify the IL view types and order for use with the 'Cycle IL' actions in Linear view.|`array`|[`Disassembly`, `LowLevelIL`, `MediumLevelIL`, `HighLevelIL`]|ui.view.linear.carousel| +| | | |`enum`|`Disassembly`| | +| | | |`enum`|`LowLevelIL`| | +| | | |`enum`|`LiftedIL`| | +| | | |`enum`|`LowLevelILSSAForm`| | +| | | |`enum`|`MediumLevelIL`| | +| | | |`enum`|`MediumLevelILSSAForm`| | +| | | |`enum`|`MappedMediumLevelIL`| | +| | | |`enum`|`MappedMediumLevelILSSAForm`| | +| | | |`enum`|`HighLevelIL`| | +| | | |`enum`|`HighLevelILSSAForm`| | +|ui|Linear View Gutter Width|Linear view gutter and tags width, in characters.|`number`|`5`|ui.view.linear.gutterWidth| +|ui|Default IL for Linear View|Default linear view type to display on startup.|`string`|`HighLevelIL`|ui.view.linear.il| +| | | |`enum`|`Disassembly`| | +| | | |`enum`|`LowLevelIL`| | +| | | |`enum`|`LiftedIL`| | +| | | |`enum`|`LowLevelILSSAForm`| | +| | | |`enum`|`MediumLevelIL`| | +| | | |`enum`|`MediumLevelILSSAForm`| | +| | | |`enum`|`MappedMediumLevelIL`| | +| | | |`enum`|`MappedMediumLevelILSSAForm`| | +| | | |`enum`|`HighLevelIL`| | +| | | |`enum`|`HighLevelILSSAForm`| | +|ui|Default IL for Reflection View|Default IL for reflection view on startup.|`string`|`Disassembly`|ui.view.reflection.il| +| | | |`enum`|`Disassembly`| | +| | | |`enum`|`LowLevelIL`| | +| | | |`enum`|`LiftedIL`| | +| | | |`enum`|`LowLevelILSSAForm`| | +| | | |`enum`|`MediumLevelIL`| | +| | | |`enum`|`MediumLevelILSSAForm`| | +| | | |`enum`|`MappedMediumLevelIL`| | +| | | |`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`]|ui.view.reflection.ilMap| +| | | |`enum`|`Disassembly`| | +| | | |`enum`|`LowLevelIL`| | +| | | |`enum`|`LiftedIL`| | +| | | |`enum`|`LowLevelILSSAForm`| | +| | | |`enum`|`MediumLevelIL`| | +| | | |`enum`|`MediumLevelILSSAForm`| | +| | | |`enum`|`MappedMediumLevelIL`| | +| | | |`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`|ui.view.reflection.ilSync| +|ui|Reflection View Location Synchronization|Reflection view follows navigation actions in the main view.|`boolean`|`True`|ui.view.reflection.locationSync| |ui|TypeView Line Numbers|Controls the display of line numbers in the types view.|`boolean`|`True`|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`|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`|updates.activeContent| |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`|updates.showAllVersions| -|user|Email|The email that will be shown when collaborating with other users.|`string`||user.email| -|user|Name|The name that will be shown when collaborating with other users.|`string`||user.name| ## Updates -- cgit v1.3.1