diff options
| author | Rusty Wagner <rusty@vector35.com> | 2016-10-10 18:24:38 -0400 |
|---|---|---|
| committer | Rusty Wagner <rusty@vector35.com> | 2016-10-10 18:24:38 -0400 |
| commit | 98d187d9d86506ea915731266b8faaaa2dc0c9d6 (patch) | |
| tree | fa1ee82d342c12ed5d42e7caf9397312edf7cf63 /docs | |
| parent | 4598adb7ae961e69fb6ed3e594c0244c49eef511 (diff) | |
| parent | 55ac7a184b7956c0c2e2ca41d512e7c4a81267d9 (diff) | |
Merge commit '55ac7a184b7956c0c2e2ca41d512e7c4a81267d9'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about/license.md | 6 | ||||
| -rw-r--r-- | docs/about/open-source.md | 19 | ||||
| -rw-r--r-- | docs/getting-started.md | 38 | ||||
| -rw-r--r-- | docs/guide/troubleshooting.md | 4 | ||||
| -rw-r--r-- | docs/images/view-choices.png | bin | 0 -> 69839 bytes |
5 files changed, 46 insertions, 21 deletions
diff --git a/docs/about/license.md b/docs/about/license.md index 99a70606..fe1e65c6 100644 --- a/docs/about/license.md +++ b/docs/about/license.md @@ -22,7 +22,7 @@ We will license Binary Ninja™, a software application (the “Software”), to 4. Modification and Upgrades. We may, from time to time, and in certain cases for a fee, replace, modify or upgrade the Software. The license fee includes one year of free upgrades. When accepted by you, any such replacement or modified Software code or upgrade to the Software will be considered part of the Software and subject to the terms of this License (unless this License is superseded by a further License accompanying such replacement or modified version of or upgrade to the Software). -5. Restrictions. Subject to applicable copyright, trade secret and other laws, you are permitted under this License to reverse engineer or de-compile the Software but you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from or provide others with the Software in whole or part, or transmit or communicate the any of the Software over a network in order to share it with others. These restrictions include prohibitions on the use the Software for service bureau or time-sharing purposes or in any other way allow third parties to exploit the Software Time-sharing means sharing the Software with customers or other third parties and permitting their use of the Software. Service bureau involves your use of the Software on behalf of third parties, instead of your own use. It is your responsibility to determine if your use of the Software is in compliance with applicable laws. +5. Restrictions. Subject to applicable copyright, trade secret and other laws, you are permitted under this License to reverse engineer or de-compile the Software but you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from or provide others with the Software in whole or part, or transmit or communicate any of the Software over a network in order to share it with others. These restrictions include prohibitions on the use the Software for service bureau or time-sharing purposes or in any other way allow third parties to exploit the Software. Time-sharing means sharing the Software with customers or other third parties and permitting their use of the Software. Service bureau involves your use of the Software on behalf of third parties, instead of your own use. It is your responsibility to determine if your use of the Software is in compliance with applicable laws. 6. Export Restrictions. You must use the Software in accordance with export laws and this means that you may not export, ship, transmit or re-export the Software, in whole or in part, in violation of any applicable law or regulation including but not limited to applicable export administration regulations issued by the U.S. Department of Commerce. @@ -60,7 +60,7 @@ We will license Binary Ninja™, a software application (the "Software"), to you 4. Modification and Upgrades. We may, from time to time, and in certain cases for a fee, replace, modify or upgrade the Software. The license fee includes one year of free upgrades. When accepted by you, any such replacement or modified Software code or upgrade to the Software will be considered part of the Software and subject to the terms of this License (unless this License is superseded by a further License accompanying such replacement or modified version of or upgrade to the Software). -5. Restrictions. Subject to applicable copyright, trade secret and other laws, you are permitted under this License to reverse engineer or de-compile the Software but you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from or provide others with the Software in whole or part, or transmit or communicate the any of the Software over a network in order to share it with others. These restrictions include prohibitions on the use the Software for service bureau or time-sharing purposes or in any other way allow third parties to exploit the Software Time-sharing means sharing the Software with customers or other third parties and permitting their use of the Software. Service bureau involves your use of the Software on behalf of third parties, instead of your own use. It is your responsibility to determine if your use of the Software is in compliance with applicable laws. +5. Restrictions. Subject to applicable copyright, trade secret and other laws, you are permitted under this License to reverse engineer or de-compile the Software but you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from or provide others with the Software in whole or part, or transmit or communicate any of the Software over a network in order to share it with others. These restrictions include prohibitions on the use the Software for service bureau or time-sharing purposes or in any other way allow third parties to exploit the Software. Time-sharing means sharing the Software with customers or other third parties and permitting their use of the Software. Service bureau involves your use of the Software on behalf of third parties, instead of your own use. It is your responsibility to determine if your use of the Software is in compliance with applicable laws. 6. Export Restrictions. You must use the Software in accordance with export laws and this means that you may not export, ship, transmit or re-export the Software, in whole or in part, in violation of any applicable law or regulation including but not limited to applicable export administration regulations issued by the U.S. Department of Commerce. @@ -98,7 +98,7 @@ We will license a “free to use” demonstration version of Binary Ninja™, a 4. Modification and Upgrades. We may, from time to time replace, modify or upgrade the Demonstration Software. When accepted by you, any such replacement or modified Demonstration Software code or upgrade to the Demonstration Software will be considered part of the Demonstration Software and subject to the terms of this Demonstration License (unless this Demonstration License is superseded by a further Demonstration License accompanying such replacement or modified version of or upgrade to the Demonstration Software). -5. Restrictions. Unlike the licenses for our full versions of Binary Ninja™, you may not decompile, decrypt, reverse engineer, disassemble or otherwise reduce the Demonstration Software to human-readable form under this Demonstration License, or permit third parties to do the same. Further, you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from, or provide others with the Demonstration Software in whole or part, or transmit or communicate the any of the Demonstration Software over a network in order to share the Demonstration Software with others. These restrictions include prohibitions on the use the Demonstration Software for service bureau or time-sharing purposes or in any other way allow third parties to exploit the Demonstration Software. Time-sharing means sharing the Demonstration Software with customers or other third parties and permitting their use of the Demonstration Software. Service bureau involves your use of the Demonstration Software on behalf of third parties, instead of your own use. It is your responsibility to determine if your use of the Demonstration Software is in compliance with applicable laws. +5. Restrictions. Unlike the licenses for our full versions of Binary Ninja™, you may not decompile, decrypt, reverse engineer, disassemble or otherwise reduce the Demonstration Software to human-readable form under this Demonstration License, or permit third parties to do the same. Further, you may not alter, duplicate, modify, rent, lease, loan, sublicense, create derivative works from, or provide others with the Demonstration Software in whole or part, or transmit or communicate any of the Demonstration Software over a network in order to share the Demonstration Software with others. These restrictions include prohibitions on the use the Demonstration Software for service bureau or time-sharing purposes or in any other way allow third parties to exploit the Demonstration Software. Time-sharing means sharing the Demonstration Software with customers or other third parties and permitting their use of the Demonstration Software. Service bureau involves your use of the Demonstration Software on behalf of third parties, instead of your own use. It is your responsibility to determine if your use of the Demonstration Software is in compliance with applicable laws. 6. Export Restrictions. You must use the Demonstration Software in accordance with export laws and this means that you may not export, ship, transmit or re-export the Demonstration Software, in whole or in part, in violation of any applicable law or regulation including but not limited to applicable export administration regulations issued by the U.S. Department of Commerce. diff --git a/docs/about/open-source.md b/docs/about/open-source.md index 8f649608..dcebbfa5 100644 --- a/docs/about/open-source.md +++ b/docs/about/open-source.md @@ -18,11 +18,18 @@ The previous tools are used in the generation of our documentation, but are not - [qt] ([qt license] - LGPLv3 / note, please see our [qt build instructions below](open-source.md#building-qt)) - [sourcecodepro] ([sourcecodepro license] - SIL open font license) - [opensans] ([opensans license] - Apache 2.0) + - [dejavusanscode] ([dejavusanscode license] - multiple open licenses) * Core - [lzf] ([lzf license] - BSD) - [zlib] ([zlib license] - zlib license) - [openssl] ([openssl license] - openssl license) + - [discount] ([discount license] - BSD) + - [sqlite] ([sqlite license] - public domain) + - [llvm] ([llvm license] - BSD-style) + +* Other + - [yasm] ([yasm license] - 2-clause BSD) * Upvector update Library - [tomcrypt] ([tomcrypt license] - public domain) @@ -58,7 +65,15 @@ Please note that we offer no support for running Binary Ninja with modified Qt l [qt]: https://www.qt.io/download/ [qt license]: https://www.qt.io/qt-licensing-terms/ [lzf]: http://oldhome.schmorp.de/marc/liblzf.html -[lzf license]: http://oldhome.schmorp.de/marc/liblzf.html) +[lzf license]: http://oldhome.schmorp.de/marc/liblzf.html +[discount]: http://www.pell.portland.or.us/~orc/Code/discount/ +[discount license]: http://www.pell.portland.or.us/~orc/Code/discount/COPYRIGHT.html +[sqlite]: https://www.sqlite.org/index.html +[sqlite license]: https://www.sqlite.org/copyright.html +[llvm]: http://llvm.org/releases/3.8.1/ +[llvm license]: http://llvm.org/releases/3.8.1/LICENSE.TXT +[yasm]: http://yasm.tortall.net/ +[yasm license]: https://github.com/yasm/yasm/blob/master/BSD.txt [zlib]: http://www.zlib.net/ [zlib license]: http://www.zlib.net/zlib_license.html [openssl]: https://www.openssl.org/ @@ -69,6 +84,8 @@ Please note that we offer no support for running Binary Ninja with modified Qt l [sourcecodepro license]: https://github.com/adobe-fonts/source-code-pro/blob/master/LICENSE.txt [opensans]: https://www.google.com/fonts/specimen/Open+Sans [opensans license]: http://www.apache.org/licenses/LICENSE-2.0.html +[dejavusanscode]: https://github.com/SSNikolaevich/DejaVuSansCode +[dejavusanscode license]: https://github.com/SSNikolaevich/DejaVuSansCode/blob/master/LICENSE [Qt 5.6]: https://www.qt.io/qt-licensing-terms/ [Building Qt 5 from Git]: https://wiki.qt.io/Building-Qt-5-from-Git [tarball]: https://binary.ninja/qt5.6.0.tar.xz diff --git a/docs/getting-started.md b/docs/getting-started.md index 5bd9d135..b7ffda4a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -40,24 +40,32 @@ Errors or warnings during the load of the binary are also shown in the status ba ## Interacting +### Navigating + +Navigating code in Binary Ninja is usually a case of just double-clicking where you want to go. Addresses, references, functions, jmp edges, etc, can all be double-clicked to navigate. Additionally, The `g` hotkey can navigate to a specific address in the current view. + + + +Switching views happens multiple ways. In some instances, it's automatic (clicking a data reference from graph view will navigate to linear view as data is not shown in the graph view), and there are multiple ways to manually change views as well. While navigating, you can use the view hotkeys (see below) to switch to a specific view at the same location as the current selection. Alternatively, the view menu in the bottom-right can be used to change views without navigating to any given location. + ### Hotkeys - - "h" : Switch to hex view - - "p" : Create a function - - <ESC> : Navigate backward - - <SPACE> : Toggle between linear view and graph view - - "g" : Go To Address dialog - - "n" : Name a symbol - - "u" : Undefine a symbol - - "e" : Edits an instruction (by modifying the original binary -- currently only enabled for x86, and x64) - - "x" : Focuses the cross-reference pane - - ";" : Adds a comment - - "i" : Switches between disassembly and low-level il in graph view - - "y" : Change type + - `h` : Switch to hex view + - `p` : Create a function + - `<ESC>` : Navigate backward + - `<SPACE>` : Toggle between linear view and graph view + - `g` : Go To Address dialog + - `n` : Name a symbol + - `u` : Undefine a symbol + - `e` : Edits an instruction (by modifying the original binary -- currently only enabled for x86, and x64) + - `x` : Focuses the cross-reference pane + - `;` : Adds a comment + - `i` : Switches between disassembly and low-level il in graph view + - `y` : Change type - [1248] : Change type directly to a data variable of the indicated widths - - "d" : Switches between data variables of various widths - - "r" : Change the data type to single ASCII character - - "o" : Create a pointer data type + - `d` : Switches between data variables of various widths + - `r` : Change the data type to single ASCII character + - `o` : Create a pointer data type ### Graph View diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index d6fbff1b..68a4d328 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -2,7 +2,7 @@ ## Basics - - Have you searched [known issues][issues]? + - Have you searched [known issues]? - Is your computer powered on? - Did you read all the items on this page? - Then you should contact [support]! @@ -23,7 +23,7 @@ Arch Linux is not an officially supported operating system, but many of our user - If the GUI launches but the license file is not valid, check that you're using the right version of Python. Only a 64-bit Python 2.7 is supported at this time. -[known issues]: https://github.com/steakknife/unsign +[known issues]: https://github.com/Vector35/binaryninja-api/issues?q=is%3Aissue [libcurl-compat]: https://aur.archlinux.org/packages/libcurl-compat/ [archrepo]: https://wiki.archlinux.org/index.php/Official_repositories [recover]: https://binary.ninja/recover.html diff --git a/docs/images/view-choices.png b/docs/images/view-choices.png Binary files differnew file mode 100644 index 00000000..9ea16dcf --- /dev/null +++ b/docs/images/view-choices.png |
