diff options
| author | Galen Williamson <galen@vector35.com> | 2022-01-27 13:54:10 -0500 |
|---|---|---|
| committer | Galen Williamson <galen@vector35.com> | 2022-01-27 13:54:10 -0500 |
| commit | 77156d6c65296f6790e05937d904eea85247c408 (patch) | |
| tree | 98ee959e7f2ff9216d26293a3ba431f6c760d43e /docs | |
| parent | 724fafee1c75698d551a658fc5d9e3400dfd8513 (diff) | |
fixed all the OS X/MacOS to macOS
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about/open-source.md | 4 | ||||
| -rw-r--r-- | docs/dev/batch.md | 2 | ||||
| -rw-r--r-- | docs/getting-started.md | 2 | ||||
| -rw-r--r-- | docs/guide/plugins.md | 12 | ||||
| -rw-r--r-- | docs/guide/troubleshooting.md | 14 | ||||
| -rw-r--r-- | docs/guide/type.md | 2 |
6 files changed, 18 insertions, 18 deletions
diff --git a/docs/about/open-source.md b/docs/about/open-source.md index b9b6b7ec..798593b1 100644 --- a/docs/about/open-source.md +++ b/docs/about/open-source.md @@ -59,9 +59,9 @@ Please note that we offer no support for running Binary Ninja with modified Qt l 1. Follow the installation requirements on the [Building Qt 6 from Git] page. 2. Download the Qt 6.1.3 [tarball] from binary.ninja. The Qt code has a [patch] applied but is ABI compatible with the official Qt release. 3. Next, build QT using the aforementioned instructions. -4. On OS X, you will need to disable the code-signing signature since it would otherwise prevent changes to binaries or shared libraries. We recommend a tool such as [unsign]. +4. On macOS, you will need to disable the code-signing signature since it would otherwise prevent changes to binaries or shared libraries. We recommend a tool such as [unsign]. 5. Finally, replace the built libraries: - - On OS X, replace the `QtCore.framework`, `QtDBus.framework`, `QtGui.framework`, `QtNetwork.framework`, `QtPrintSupport.framework`, `QtWidgets.framework` folders inside of `/Applications/Binary Ninja.app/Contents/Frameworks` + - On macOS, replace the `QtCore.framework`, `QtDBus.framework`, `QtGui.framework`, `QtNetwork.framework`, `QtPrintSupport.framework`, `QtWidgets.framework` folders inside of `/Applications/Binary Ninja.app/Contents/Frameworks` - On Windows, replace the `Qt6Core.dll`, `Qt6Gui.dll`, `Qt6Network.dll`, and `Qt6Widgets.dll` files in `C:\Program Files\Vector35\BinaryNinja\`. - On Linux, replace the `libQt6Core.so.6`, `libQt6DBus.so.6`, `libQt6Gui.so.6`, `libQt6Network.so.6`, `libQt6Widgets.so.6`, `libQt6XcbQpa.so.6` files wherever Binary Ninja was extracted. diff --git a/docs/dev/batch.md b/docs/dev/batch.md index 044be8ac..5e13e0ad 100644 --- a/docs/dev/batch.md +++ b/docs/dev/batch.md @@ -16,7 +16,7 @@ This script adds appropriate `.pth` files so that your Python can find the Binar ## Our First Script -Let's try a simple example script (note that this script will work identically on MacOS and Linux, but Windows users will want to adjust paths accordingly): +Let's try a simple example script (note that this script will work identically on macOS and Linux, but Windows users will want to adjust paths accordingly): ```python #!/usr/bin/env python3 diff --git a/docs/getting-started.md b/docs/getting-started.md index b3b120de..3dee507e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -747,7 +747,7 @@ Here's a list of all built-in settings currently available from the UI: |network|Enable Release Notes|Allow Binary Ninja to connect to the update server to display release notes on new tabs.|`boolean`|`True`|[`SettingsUserScope`]|<a id='network.enableReleaseNotes'>network.enableReleaseNotes</a>| |network|Enable Update Channel List|Allow Binary Ninja to connect to the update server to determine which update channels are available.|`boolean`|`True`|[`SettingsUserScope`]|<a id='network.enableUpdateChannelList'>network.enableUpdateChannelList</a>| |network|Enable Updates|Allow Binary Ninja to connect to the update server to check for updates.|`boolean`|`True`|[`SettingsUserScope`]|<a id='network.enableUpdates'>network.enableUpdates</a>| -|network|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`| |[`SettingsUserScope`]|<a id='network.httpsProxy'>network.httpsProxy</a>| +|network|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 macOS System Configuration Framework.|`string`| |[`SettingsUserScope`]|<a id='network.httpsProxy'>network.httpsProxy</a>| |network|Websocket Provider|Specify the registered WebsocketProvider which enables communication over HTTPS.|`string`|`CoreWebsocketProvider`|[`SettingsUserScope`]|<a id='network.websocketProviderName'>network.websocketProviderName</a>| | | | |`enum`|`CoreWebsocketProvider`| | | |pdb|Auto Download PDBs|Automatically download pdb files from specified symbol servers.|`boolean`|`True`|[`SettingsProjectScope`, `SettingsUserScope`]|<a id='pdb.autoDownload'>pdb.autoDownload</a>| diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md index c3615629..d98f6011 100644 --- a/docs/guide/plugins.md +++ b/docs/guide/plugins.md @@ -4,7 +4,7 @@ The most common Binary Ninja plugins are Python which we are covering here. That Plugins are loaded from the user's plugin folder: -- OS X: `~/Library/Application Support/Binary Ninja/plugins/` +- macOS: `~/Library/Application Support/Binary Ninja/plugins/` - Linux: `~/.binaryninja/plugins/` - Windows: `%APPDATA%\Binary Ninja\plugins` @@ -17,17 +17,17 @@ Note that plugins installed via the [PluginManager API](https://api.binary.ninja Plugins can now be installed directly via the GUI from Binary Ninja. You can launch the plugin manager via any of the following methods: - (Linux/Windows) `[CTRL-SHIFT-M]` - - (MacOS) `[CMD-SHIFT-M]` + - (macOS) `[CMD-SHIFT-M]` Or: - (Linux/Windows) `Edit` / `Preferences` / `Manage Plugins` - - (MacOS) `Binary Ninja` / `Preferences` / `Manage Plugins` + - (macOS) `Binary Ninja` / `Preferences` / `Manage Plugins` Or: - (Linux/Windows) `[CTRL-P]` / `Plugin Manager` / `[ENTER]` - - (MacOS) `[CMD-P]` / `Plugin Manager` / `[ENTER]` + - (macOS) `[CMD-P]` / `Plugin Manager` / `[ENTER]` Note that some plugins may show `Force Install` instead of the normal `Install` button. If that's the case, it means the plugin does not specifically advertise support for your platform or version of python. Often times the plugin will still work, but you must override a warning to confirm installation and be aware that the plugin may not be compatible. @@ -88,7 +88,7 @@ Then just restart and your plugin will be loaded. Binary Ninja can now automatically install pip requirements for python plugins when the plugin was installed using the plugin manager. If the plugin author has included a `requirements.txt` file, the plugin manager will automatically install those dependencies. -Because Windows and MacOS ship with an embedded version of Python, if you want to install plugins inside that Python, we recommend instead installing an official [python.org](https://www.python.org/downloads/windows/) (NOTE: ensure you do not accidentally install a 32-bit build) version, or a [homebrew](https://docs.brew.sh/Homebrew-and-Python) Python 3.x build. +Because Windows and macOS ship with an embedded version of Python, if you want to install plugins inside that Python, we recommend instead installing an official [python.org](https://www.python.org/downloads/windows/) (NOTE: ensure you do not accidentally install a 32-bit build) version, or a [homebrew](https://docs.brew.sh/Homebrew-and-Python) Python 3.x build. Then you can adjust your [python.interpreter setting](../getting-started.md#python.interpreter) to point to the appropriate install location. Note that the file being pointed to should be a `.dll` or `.dylib` though homebrew will often install libraries without any extension. For example: @@ -102,7 +102,7 @@ $ file /usr/local/Cellar/python@3.8/3.8.5/Frameworks/Python.framework/Versions/3 Troubleshooting many Binary Ninja problems is enhanced by enabling debug logs and logging the output to a file. Just launch Binary Ninja with: ``` text -/Applications/Binary\ Ninja.app/Contents/MacOS/binaryninja -d -l /tmp/bnlog.txt +/Applications/Binary\ Ninja.app/Contents/macOS/binaryninja -d -l /tmp/bnlog.txt ``` And check `/tmp/bnlog.txt` when you're done. diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index 3dcb5b69..7b832fbb 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -43,7 +43,7 @@ Next, if running a python plugin, make sure the python requirements are met by y ## Running as Root -Binary Ninja will refuse to run as root on Linux and MacOS platforms (this is partially enforced by the usage of an embedded QWebEngine which will not run as root). You can work-around this issue by either running as a regular user, or forcing BN to launch but you will need to also disable [active content](/getting-started/#updates.activeContent). If you try to use su or another similar tool, make sure that user has permission to the X11 session. +Binary Ninja will refuse to run as root on Linux and macOS platforms (this is partially enforced by the usage of an embedded QWebEngine which will not run as root). You can work-around this issue by either running as a regular user, or forcing BN to launch but you will need to also disable [active content](/getting-started/#updates.activeContent). If you try to use su or another similar tool, make sure that user has permission to the X11 session. ## API @@ -81,11 +81,11 @@ You may also manually create a `settings.json` file in your [user folder](../get } ``` -### MacOS +### macOS #### Xcode Installed Python 3 -If you're running Catlina MacOS with the Python 3 installed by XCode and wish to use that version of Python with Binary Ninja, you'll need to do the following: +If you're running Catlina macOS with the Python 3 installed by XCode and wish to use that version of Python with Binary Ninja, you'll need to do the following: 1. Set the PYTHONHOME environment variable for your user to the following: `PYTHONHOME=/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.7` 1. If you have an existing `settings.json` in `~/Library/Application Support/Binary Ninja/` merge the below, or create it with these contents if it does not exist: @@ -103,19 +103,19 @@ If you're running Catlina MacOS with the Python 3 installed by XCode and wish to } ``` -#### Old MacOS +#### Old macOS -While OS X is generally the most trouble-free environment for Binary Ninja, very old versions may have problems with the RPATH for our binaries and libraries. There are two solutions. First, run Binary Ninja with: +While macOS is generally the most trouble-free environment for Binary Ninja, very old versions may have problems with the RPATH for our binaries and libraries. There are two solutions. First, run Binary Ninja with: ``` bash -DYLD_LIBRARY_PATH="/Applications/Binary Ninja.app/Contents/MacOS" /Applications/Binary\ Ninja.app/Contents/MacOS/binaryninja +DYLD_LIBRARY_PATH="/Applications/Binary Ninja.app/Contents/macOS" /Applications/Binary\ Ninja.app/Contents/macOS/binaryninja ``` Or second, modify the binary itself using the [install_name_tool](https://blogs.oracle.com/dipol/dynamic-libraries,-rpath,-and-mac-os). #### Non-brew installed Python 3 -One potential issue for installed Python 3.x versions on MacOS is that the bundled certificates do not align with the native certificate store. This results in an error while attempting to download updates using the python provider. One of the following may fix this: +One potential issue for installed Python 3.x versions on macOS is that the bundled certificates do not align with the native certificate store. This results in an error while attempting to download updates using the python provider. One of the following may fix this: ``` bash pip install --upgrade certifi diff --git a/docs/guide/type.md b/docs/guide/type.md index eea64e23..cacc6060 100644 --- a/docs/guide/type.md +++ b/docs/guide/type.md @@ -525,7 +525,7 @@ current_function.parameter_vars[0].type = Type.pointer(bv.arch, Type.char()) Type Libraries are collections of type information (structs, enums, function types, etc.) stored in a file with the extension `.bntl`. -Relative to the binaryninja executable, the default type library location is `../Resources/typelib` on MacOS and `./typelib` on Linux and Windows. Individual .bntl files are organized in subdirectories named for the supported architecture. Users may include their own type libraries +Relative to the binaryninja executable, the default type library location is `../Resources/typelib` on macOS and `./typelib` on Linux and Windows. Individual .bntl files are organized in subdirectories named for the supported architecture. Users may include their own type libraries The information in a type library is contained in two key-value stores: |
