From fed4a230aab3b689b57ce02edd8948691f94baee Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Thu, 21 May 2020 16:44:34 -0400 Subject: correct list of settings in getting starte docs, removing plugins and adding enum description values --- docs/getting-started.md | 74 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 69 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/getting-started.md b/docs/getting-started.md index 50d9201f..02edf838 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -359,6 +359,10 @@ 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| |analysis|Never Save Undo Data|Never save previous user actions to the database.|`boolean`|`False`|analysis.neverSaveUndoData| |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| @@ -368,26 +372,36 @@ Here's a list of all settings currently available from the UI: |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|M16C RAM Size|Specify the amount of address space allocated for internal RAM.|`number`|`31`|arch.m16c.ramSize| -|arch|M16C Disassembly Suffix|Whether or not to display the :G/:Q/:S/:Z suffix.|`boolean`|`True`|arch.m16c.showSuffix| |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| -|bnil-graph|Show Common ILs|Show common forms (non-SSA, non-mapped) in the output.|`boolean`|`True`|bnil-graph.showCommon| -|bnil-graph|Include MMLIL|Show the MappedMediumLevelIL form in the output.|`boolean`|`False`|bnil-graph.showMapped| -|bnil-graph|Include SSA|Include SSA forms in the output.|`boolean`|`True`|bnil-graph.showSSA| +| | | 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| |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`|`PythonDownloadProvider`|downloadClient.providerName| +| | | |`enum`|`QtDownloadProvider`|downloadClient.providerName| +| | | |`enum`|`PythonDownloadProvider`|downloadClient.providerName| |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|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| |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| |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`|`libpython2.7.dylib`|python.interpreter| |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| |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| |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| @@ -397,23 +411,73 @@ Here's a list of all settings currently available from the UI: |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|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| |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|Graph Carousel|Graphs and order of graphs to display for 'i' keystroke|`array`|`['Disassembly', 'LowLevelIL', 'MediumLevelIL', 'HighLevelIL']`|ui.graph.carousel| +| | | |`enum`|`Disassembly`|ui.graph.carousel| +| | | |`enum`|`LowLevelIL`|ui.graph.carousel| +| | | |`enum`|`LiftedIL`|ui.graph.carousel| +| | | |`enum`|`LowLevelILSSAForm`|ui.graph.carousel| +| | | |`enum`|`MediumLevelIL`|ui.graph.carousel| +| | | |`enum`|`MediumLevelILSSAForm`|ui.graph.carousel| +| | | |`enum`|`MappedMediumLevelIL`|ui.graph.carousel| +| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.graph.carousel| +| | | |`enum`|`HighLevelIL`|ui.graph.carousel| +| | | |`enum`|`HighLevelILSSAForm`|ui.graph.carousel| |ui|Default Disassembly Graph|Default disassembly graph to display on startup.|`string`|`Disassembly`|ui.graph.default| +| | | |`enum`|`Disassembly`|ui.graph.default| +| | | |`enum`|`LowLevelIL`|ui.graph.default| +| | | |`enum`|`LiftedIL`|ui.graph.default| +| | | |`enum`|`LowLevelILSSAForm`|ui.graph.default| +| | | |`enum`|`MediumLevelIL`|ui.graph.default| +| | | |`enum`|`MediumLevelILSSAForm`|ui.graph.default| +| | | |`enum`|`MappedMediumLevelIL`|ui.graph.default| +| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.graph.default| +| | | |`enum`|`HighLevelIL`|ui.graph.default| +| | | |`enum`|`HighLevelILSSAForm`|ui.graph.default| |ui|Perfer Disassembly Graph|Prefer disassembly graph over linear view on startup.|`boolean`|`False`|ui.graph.preferred| |ui|Number of history entries to store.|Controls the number of history entries to store for input dialogs.|`number`|`50`|ui.inputHistoryCount| |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| |ui|Manual Tooltip|Enable to prevent tooltips from showing without <ctrl> being held.|`boolean`|`False`|ui.manualTooltip| |ui|Recent File Limit|Specify a limit for the recent file history.|`number`|`10`|ui.recentFileLimit| |ui|Scripting Provider|Specify the registered ScriptingProvider for the default scripting console in the UI|`string`|`Python`|ui.scriptingProvider| +| | | |`enum`|`Python`|ui.scriptingProvider| |ui|Display Settings Identifiers|Display setting identifiers in the UI settings view.|`boolean`|`False`|ui.settings.displayIdentifiers| |ui|Theme|Customize the appearance and style of Binary Ninja.|`string`|`Dark`|ui.theme| |ui|Linear View Carousel|Views and order of views to display for 'i' keystroke|`array`|`['Disassembly', 'LowLevelIL', 'MediumLevelIL', 'HighLevelIL']`|ui.view.disassembly.carousel| +| | | |`enum`|`Disassembly`|ui.view.disassembly.carousel| +| | | |`enum`|`LowLevelIL`|ui.view.disassembly.carousel| +| | | |`enum`|`LiftedIL`|ui.view.disassembly.carousel| +| | | |`enum`|`LowLevelILSSAForm`|ui.view.disassembly.carousel| +| | | |`enum`|`MediumLevelIL`|ui.view.disassembly.carousel| +| | | |`enum`|`MediumLevelILSSAForm`|ui.view.disassembly.carousel| +| | | |`enum`|`MappedMediumLevelIL`|ui.view.disassembly.carousel| +| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.view.disassembly.carousel| +| | | |`enum`|`HighLevelIL`|ui.view.disassembly.carousel| +| | | |`enum`|`HighLevelILSSAForm`|ui.view.disassembly.carousel| |ui|Gutter Width|Disassembly view gutter and tags width, in characters.|`number`|`5`|ui.view.disassembly.gutterWidth| |ui|Default Linear View Type|Default linear view type to display on startup.|`string`|`HighLevelIL`|ui.view.disassembly.type| +| | | |`enum`|`Disassembly`|ui.view.disassembly.type| +| | | |`enum`|`LowLevelIL`|ui.view.disassembly.type| +| | | |`enum`|`LiftedIL`|ui.view.disassembly.type| +| | | |`enum`|`LowLevelILSSAForm`|ui.view.disassembly.type| +| | | |`enum`|`MediumLevelIL`|ui.view.disassembly.type| +| | | |`enum`|`MediumLevelILSSAForm`|ui.view.disassembly.type| +| | | |`enum`|`MappedMediumLevelIL`|ui.view.disassembly.type| +| | | |`enum`|`MappedMediumLevelILSSAForm`|ui.view.disassembly.type| +| | | |`enum`|`HighLevelIL`|ui.view.disassembly.type| +| | | |`enum`|`HighLevelILSSAForm`|ui.view.disassembly.type| |ui|TypeView Line Numbers|Controls the display of line numbers in the types view.|`boolean`|`True`|ui.view.types.lineNumbers| |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| -- cgit v1.3.1