diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2020-05-21 16:44:34 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2020-05-21 16:44:34 -0400 |
| commit | fed4a230aab3b689b57ce02edd8948691f94baee (patch) | |
| tree | 849dbdc4bdc63e61dfc8a6b6f190554e9772ca3b /docs | |
| parent | b2d30f40d1209f3bd51b5d4db91550aa77328dce (diff) | |
correct list of settings in getting starte docs, removing plugins and adding enum description values
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting-started.md | 74 |
1 files changed, 69 insertions, 5 deletions
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`|<a id='analysis.linearSweep.entropyHeuristics'>analysis.linearSweep.entropyHeuristics</a>| |analysis|Max Linear Sweep Work Queues|The number of binary regions under concurrent analysis.|`number`|`64`|<a id='analysis.linearSweep.maxWorkQueues'>analysis.linearSweep.maxWorkQueues</a>| |analysis|Analysis Mode|Controls the amount of analysis performed on functions.|`string`|`full`|<a id='analysis.mode'>analysis.mode</a>| +| | | enum: Only perform control flow analysis on the binary. Cross references are valid only for direct function calls. [Disassembly Only]|`enum`|`controlFlow`|<a id='analysis.mode'>analysis.mode</a>| +| | | 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`|<a id='analysis.mode'>analysis.mode</a>| +| | | enum: Perform analysis which includes type propagation and data flow. [MLIL and Equivalents]|`enum`|`intermediate`|<a id='analysis.mode'>analysis.mode</a>| +| | | enum: Perform full analysis of the binary.|`enum`|`full`|<a id='analysis.mode'>analysis.mode</a>| |analysis|Never Save Undo Data|Never save previous user actions to the database.|`boolean`|`False`|<a id='analysis.neverSaveUndoData'>analysis.neverSaveUndoData</a>| |analysis|Autorun Function Signature Matcher|Automatically run the function signature matcher when opening a binary for analysis.|`boolean`|`True`|<a id='analysis.signatureMatcher.autorun'>analysis.signatureMatcher.autorun</a>| |analysis|Auto Function Analysis Suppression|Enable suppressing analysis of automatically discovered functions.|`boolean`|`False`|<a id='analysis.suppressNewAutoFunctionAnalysis'>analysis.suppressNewAutoFunctionAnalysis</a>| @@ -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`|<a id='analysis.unicode.utf16'>analysis.unicode.utf16</a>| |analysis|UTF-32 Encoding|Whether or not to consider UTF-32 code points when searching for strings.|`boolean`|`True`|<a id='analysis.unicode.utf32'>analysis.unicode.utf32</a>| |analysis|UTF-8 Encoding|Whether or not to consider UTF-8 code points when searching for strings.|`boolean`|`True`|<a id='analysis.unicode.utf8'>analysis.unicode.utf8</a>| -|arch|M16C RAM Size|Specify the amount of address space allocated for internal RAM.|`number`|`31`|<a id='arch.m16c.ramSize'>arch.m16c.ramSize</a>| -|arch|M16C Disassembly Suffix|Whether or not to display the :G/:Q/:S/:Z suffix.|`boolean`|`True`|<a id='arch.m16c.showSuffix'>arch.m16c.showSuffix</a>| |arch|x86 Disassembly Case|Specify the case for opcodes, operands, and registers.|`boolean`|`True`|<a id='arch.x86.disassembly.lowercase'>arch.x86.disassembly.lowercase</a>| |arch|x86 Disassembly Separator|Specify the token separator between operands.|`string`|`, `|<a id='arch.x86.disassembly.separator'>arch.x86.disassembly.separator</a>| |arch|x86 Disassembly Syntax|Specify disassembly syntax for the x86/x86_64 architectures.|`string`|`BN_INTEL`|<a id='arch.x86.disassembly.syntax'>arch.x86.disassembly.syntax</a>| -|bnil-graph|Show Common ILs|Show common forms (non-SSA, non-mapped) in the output.|`boolean`|`True`|<a id='bnil-graph.showCommon'>bnil-graph.showCommon</a>| -|bnil-graph|Include MMLIL|Show the MappedMediumLevelIL form in the output.|`boolean`|`False`|<a id='bnil-graph.showMapped'>bnil-graph.showMapped</a>| -|bnil-graph|Include SSA|Include SSA forms in the output.|`boolean`|`True`|<a id='bnil-graph.showSSA'>bnil-graph.showSSA</a>| +| | | enum: Sets the disassembly syntax to a simplified Intel format. (TBD) |`enum`|`BN_INTEL`|<a id='arch.x86.disassembly.syntax'>arch.x86.disassembly.syntax</a>| +| | | enum: Sets the disassembly syntax to Intel format. (Destination on the left) |`enum`|`INTEL`|<a id='arch.x86.disassembly.syntax'>arch.x86.disassembly.syntax</a>| +| | | enum: Sets the disassembly syntax to AT&T format. (Destination on the right) |`enum`|`AT&T`|<a id='arch.x86.disassembly.syntax'>arch.x86.disassembly.syntax</a>| |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`||<a id='downloadClient.httpsProxy'>downloadClient.httpsProxy</a>| |downloadClient|Download Provider|Specify the registered DownloadProvider which enables resource fetching over HTTPS.|`string`|`PythonDownloadProvider`|<a id='downloadClient.providerName'>downloadClient.providerName</a>| +| | | |`enum`|`QtDownloadProvider`|<a id='downloadClient.providerName'>downloadClient.providerName</a>| +| | | |`enum`|`PythonDownloadProvider`|<a id='downloadClient.providerName'>downloadClient.providerName</a>| |pdb|Auto Download PDBs|Automatically download pdb files from specified symbol servers.|`boolean`|`True`|<a id='pdb.autoDownload'>pdb.autoDownload</a>| |pdb|Absolute PDB Symbol Store Path|Absolute path specifying where the PDB symbol store exists on this machine, overrides relative path.|`string`||<a id='pdb.localStoreAbsolute'>pdb.localStoreAbsolute</a>| |pdb|Relative PDB Symbol Store Path|Path *relative* to the binaryninja _user_ directory, specifying the pdb symbol store.|`string`|`symbols`|<a id='pdb.localStoreRelative'>pdb.localStoreRelative</a>| |pdb|Symbol Server List|List of servers to query for pdb symbols.|`array`|`['https://msdl.microsoft.com/download/symbols']`|<a id='pdb.symbolServerList'>pdb.symbolServerList</a>| |pluginManager|Community Plugin Manager Update Channel|Specify which community update channel the Plugin Manager should update plugins from.|`string`|`master`|<a id='pluginManager.communityUpdateChannel'>pluginManager.communityUpdateChannel</a>| +| | | enum: The default channel. This setting should be used unless you are testing the Plugin Manager.|`enum`|`master`|<a id='pluginManager.communityUpdateChannel'>pluginManager.communityUpdateChannel</a>| +| | | enum: Plugin Manager test channel.|`enum`|`test`|<a id='pluginManager.communityUpdateChannel'>pluginManager.communityUpdateChannel</a>| |pluginManager|Official Plugin Manager Update Channel|Specify which official update channel the Plugin Manager should update plugins from.|`string`|`master`|<a id='pluginManager.officialUpdateChannel'>pluginManager.officialUpdateChannel</a>| +| | | enum: The default channel. This setting should be used unless you are testing the Plugin Manager.|`enum`|`master`|<a id='pluginManager.officialUpdateChannel'>pluginManager.officialUpdateChannel</a>| +| | | enum: Plugin Manager test channel.|`enum`|`test`|<a id='pluginManager.officialUpdateChannel'>pluginManager.officialUpdateChannel</a>| |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`|<a id='python.interpreter'>python.interpreter</a>| |triage|Triage Analysis Mode|Controls the amount of analysis performed on functions when opening for triage.|`string`|`basic`|<a id='triage.analysisMode'>triage.analysisMode</a>| +| | | enum: Only perform control flow analysis on the binary. Cross references are valid only for direct function calls.|`enum`|`controlFlow`|<a id='triage.analysisMode'>triage.analysisMode</a>| +| | | enum: Perform fast initial analysis of the binary. This mode does not analyze types or data flow through stack variables.|`enum`|`basic`|<a id='triage.analysisMode'>triage.analysisMode</a>| +| | | enum: Perform full analysis of the binary.|`enum`|`full`|<a id='triage.analysisMode'>triage.analysisMode</a>| |triage|Triage Shows Hidden Files|Whether the Triage file picker shows hidden files.|`boolean`|`False`|<a id='triage.hiddenFiles'>triage.hiddenFiles</a>| |triage|Triage Linear Sweep Mode|Controls the level of linear sweep performed when opening for triage.|`string`|`partial`|<a id='triage.linearSweep'>triage.linearSweep</a>| +| | | enum: Do not perform linear sweep of the binary.|`enum`|`none`|<a id='triage.linearSweep'>triage.linearSweep</a>| +| | | enum: Perform linear sweep on the binary, but skip the control flow graph analysis phase.|`enum`|`partial`|<a id='triage.linearSweep'>triage.linearSweep</a>| +| | | enum: Perform full linear sweep on the binary.|`enum`|`full`|<a id='triage.linearSweep'>triage.linearSweep</a>| |triage|Always Prefer Triage Summary View|Always prefer opening binaries in Triage Summary view, even when performing full analysis.|`boolean`|`False`|<a id='triage.preferSummaryView'>triage.preferSummaryView</a>| |triage|Prefer Triage Summary View for Raw Files|Prefer opening raw files in Triage Summary view.|`boolean`|`False`|<a id='triage.preferSummaryViewForRaw'>triage.preferSummaryViewForRaw</a>| |ui|Color Blind|Choose colors that are visible to those with red/green color blindness.|`boolean`|`False`|<a id='ui.colorBlind'>ui.colorBlind</a>| @@ -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`|<a id='ui.featureMap.enable'>ui.featureMap.enable</a>| |ui|Feature Map File-Backed Only Mode|Exclude mapped regions that are not backed by a load file.|`boolean`|`False`|<a id='ui.featureMap.fileBackedOnly'>ui.featureMap.fileBackedOnly</a>| |ui|Antialiasing|Select font antialiasing style.|`string`|`subpixel`|<a id='ui.font.antialiasing'>ui.font.antialiasing</a>| +| | | enum: Perform subpixel antialiasing on fonts.|`enum`|`subpixel`|<a id='ui.font.antialiasing'>ui.font.antialiasing</a>| +| | | enum: Avoid subpixel antialiasing on fonts if possible.|`enum`|`grayscale`|<a id='ui.font.antialiasing'>ui.font.antialiasing</a>| +| | | enum: No subpixel antialiasing at High DPI.|`enum`|`hidpi`|<a id='ui.font.antialiasing'>ui.font.antialiasing</a>| +| | | enum: No font antialiasing.|`enum`|`none`|<a id='ui.font.antialiasing'>ui.font.antialiasing</a>| |ui|Bold Fonts|Allow bold fonts.|`boolean`|`True`|<a id='ui.font.bold'>ui.font.bold</a>| |ui|Font Name|Font family selection.|`string`|`Source Code Pro`|<a id='ui.font.name'>ui.font.name</a>| |ui|Font Size|Font point size selection.|`number`|`12`|<a id='ui.font.size'>ui.font.size</a>| |ui|Line Spacing|Specify an additional distance between adjacent baselines.|`number`|`1`|<a id='ui.font.spacing'>ui.font.spacing</a>| |ui|Graph Carousel|Graphs and order of graphs to display for 'i' keystroke|`array`|`['Disassembly', 'LowLevelIL', 'MediumLevelIL', 'HighLevelIL']`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`Disassembly`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`LowLevelIL`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`LiftedIL`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`LowLevelILSSAForm`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`MediumLevelIL`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`MediumLevelILSSAForm`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`MappedMediumLevelIL`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`MappedMediumLevelILSSAForm`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`HighLevelIL`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| +| | | |`enum`|`HighLevelILSSAForm`|<a id='ui.graph.carousel'>ui.graph.carousel</a>| |ui|Default Disassembly Graph|Default disassembly graph to display on startup.|`string`|`Disassembly`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`Disassembly`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`LowLevelIL`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`LiftedIL`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`LowLevelILSSAForm`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`MediumLevelIL`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`MediumLevelILSSAForm`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`MappedMediumLevelIL`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`MappedMediumLevelILSSAForm`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`HighLevelIL`|<a id='ui.graph.default'>ui.graph.default</a>| +| | | |`enum`|`HighLevelILSSAForm`|<a id='ui.graph.default'>ui.graph.default</a>| |ui|Perfer Disassembly Graph|Prefer disassembly graph over linear view on startup.|`boolean`|`False`|<a id='ui.graph.preferred'>ui.graph.preferred</a>| |ui|Number of history entries to store.|Controls the number of history entries to store for input dialogs.|`number`|`50`|<a id='ui.inputHistoryCount'>ui.inputHistoryCount</a>| |ui|Minimum UI Log Level|Set the minimum log level for the UI log.|`string`|`InfoLog`|<a id='ui.log.minLevel'>ui.log.minLevel</a>| +| | | enum: Display Debug, Info, Warning, Error, and Alert messages to log console.|`enum`|`DebugLog`|<a id='ui.log.minLevel'>ui.log.minLevel</a>| +| | | enum: Display Info, Warning, Error, and Alert messages to log console.|`enum`|`InfoLog`|<a id='ui.log.minLevel'>ui.log.minLevel</a>| +| | | enum: Display Warning, Error, and Alert messages to log console.|`enum`|`WarningLog`|<a id='ui.log.minLevel'>ui.log.minLevel</a>| +| | | enum: Display Error and Alert messages to log console.|`enum`|`ErrorLog`|<a id='ui.log.minLevel'>ui.log.minLevel</a>| +| | | enum: Display Alert messages to log console.|`enum`|`AlertLog`|<a id='ui.log.minLevel'>ui.log.minLevel</a>| |ui|Manual Tooltip|Enable to prevent tooltips from showing without <ctrl> being held.|`boolean`|`False`|<a id='ui.manualTooltip'>ui.manualTooltip</a>| |ui|Recent File Limit|Specify a limit for the recent file history.|`number`|`10`|<a id='ui.recentFileLimit'>ui.recentFileLimit</a>| |ui|Scripting Provider|Specify the registered ScriptingProvider for the default scripting console in the UI|`string`|`Python`|<a id='ui.scriptingProvider'>ui.scriptingProvider</a>| +| | | |`enum`|`Python`|<a id='ui.scriptingProvider'>ui.scriptingProvider</a>| |ui|Display Settings Identifiers|Display setting identifiers in the UI settings view.|`boolean`|`False`|<a id='ui.settings.displayIdentifiers'>ui.settings.displayIdentifiers</a>| |ui|Theme|Customize the appearance and style of Binary Ninja.|`string`|`Dark`|<a id='ui.theme'>ui.theme</a>| |ui|Linear View Carousel|Views and order of views to display for 'i' keystroke|`array`|`['Disassembly', 'LowLevelIL', 'MediumLevelIL', 'HighLevelIL']`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`Disassembly`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`LowLevelIL`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`LiftedIL`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`LowLevelILSSAForm`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`MediumLevelIL`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`MediumLevelILSSAForm`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`MappedMediumLevelIL`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`MappedMediumLevelILSSAForm`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`HighLevelIL`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| +| | | |`enum`|`HighLevelILSSAForm`|<a id='ui.view.disassembly.carousel'>ui.view.disassembly.carousel</a>| |ui|Gutter Width|Disassembly view gutter and tags width, in characters.|`number`|`5`|<a id='ui.view.disassembly.gutterWidth'>ui.view.disassembly.gutterWidth</a>| |ui|Default Linear View Type|Default linear view type to display on startup.|`string`|`HighLevelIL`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`Disassembly`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`LowLevelIL`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`LiftedIL`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`LowLevelILSSAForm`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`MediumLevelIL`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`MediumLevelILSSAForm`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`MappedMediumLevelIL`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`MappedMediumLevelILSSAForm`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`HighLevelIL`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| +| | | |`enum`|`HighLevelILSSAForm`|<a id='ui.view.disassembly.type'>ui.view.disassembly.type</a>| |ui|TypeView Line Numbers|Controls the display of line numbers in the types view.|`boolean`|`True`|<a id='ui.view.types.lineNumbers'>ui.view.types.lineNumbers</a>| |updates|Active Content|Allow Binary Ninja to connect to the update server to check for updates and release notes.|`boolean`|`True`|<a id='updates.activeContent'>updates.activeContent</a>| |updates|Update Channel Preferences|Select update channel and version.|`string`|`None`|<a id='updates.channelPreferences'>updates.channelPreferences</a>| |
