diff options
| author | iphydf <iphydf@users.noreply.github.com> | 2018-08-26 19:22:00 +0000 |
|---|---|---|
| committer | iphydf <iphydf@users.noreply.github.com> | 2018-09-02 21:36:41 +0000 |
| commit | d296490a742b226fc17a71cf96ab73fc16719b20 (patch) | |
| tree | 60d9e1abc788dedf8c9f3f08f3f7aefc68d7ccd3 /INSTALL.md | |
| parent | 1a6e8b908b941890955e1b9b2294917487ec500f (diff) | |
Use `code font` for tool names and flags in INSTALL.md.
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 90 |
1 files changed, 43 insertions, 47 deletions
| @@ -33,25 +33,25 @@ These instructions will guide you through the process of building and installing | |||
| 33 | 33 | ||
| 34 | This repository, although called `toxcore`, in fact contains several libraries besides `toxcore` which complement it, as well as several executables. However, note that although these are separate libraries, at the moment, when building the libraries, they are all merged into a single `toxcore` library. Here is the full list of the main components that can be built using the CMake, their dependencies and descriptions. | 34 | This repository, although called `toxcore`, in fact contains several libraries besides `toxcore` which complement it, as well as several executables. However, note that although these are separate libraries, at the moment, when building the libraries, they are all merged into a single `toxcore` library. Here is the full list of the main components that can be built using the CMake, their dependencies and descriptions. |
| 35 | 35 | ||
| 36 | | Name | Type | Dependencies | Platform | Description | | 36 | | Name | Type | Dependencies | Platform | Description | |
| 37 | |----------------|------------|-----------------------------------------------|----------------|----------------------------------------------------------------------------| | 37 | |------------------|------------|-----------------------------------------------|----------------|----------------------------------------------------------------------------| |
| 38 | | toxcore | Library | libnacl or libsodium, libm, libpthread, librt | Cross-platform | The main Tox library that provides the messenger functionality. | | 38 | | `toxcore` | Library | libnacl or libsodium, libm, libpthread, librt | Cross-platform | The main Tox library that provides the messenger functionality. | |
| 39 | | toxav | Library | libtoxcore, libopus, libvpx | Cross-platform | Provides audio/video functionality. | | 39 | | `toxav` | Library | libtoxcore, libopus, libvpx | Cross-platform | Provides audio/video functionality. | |
| 40 | | toxencryptsave | Library | libtoxcore, libnacl or libsodium | Cross-platform | Provides encryption of Tox profiles (savedata), as well as arbitrary data. | | 40 | | `toxencryptsave` | Library | libtoxcore, libnacl or libsodium | Cross-platform | Provides encryption of Tox profiles (savedata), as well as arbitrary data. | |
| 41 | | DHT_bootstrap | Executable | libtoxcore | Cross-platform | A simple DHT bootstrap node. | | 41 | | `DHT_bootstrap` | Executable | libtoxcore | Cross-platform | A simple DHT bootstrap node. | |
| 42 | | tox-bootstrapd | Executable | libtoxcore, libconfig | Unix-like | Highly configurable DHT bootstrap node daemon (systemd, SysVinit, Docker). | | 42 | | `tox-bootstrapd` | Executable | libtoxcore, libconfig | Unix-like | Highly configurable DHT bootstrap node daemon (systemd, SysVinit, Docker). | |
| 43 | 43 | ||
| 44 | #### Secondary | 44 | #### Secondary |
| 45 | 45 | ||
| 46 | There are some programs that are not plugged into the CMake build system which you might find interesting. You would need to build those programs yourself. These programs reside in [`other/fun`](other/fun) directory. | 46 | There are some programs that are not plugged into the CMake build system which you might find interesting. You would need to build those programs yourself. These programs reside in [`other/fun`](other/fun) directory. |
| 47 | 47 | ||
| 48 | | Name | Type | Dependencies | Platform | Description | | 48 | | Name | Type | Dependencies | Platform | Description | |
| 49 | |---------------------|------------|----------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 49 | |-----------------------|------------|----------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 50 | | bootstrap_node_info | Script | python3 | Cross-platform | Script for getting version and Message Of The Day (MOTD) information from a DHT bootstrap node. | | 50 | | `bootstrap_node_info` | Script | python3 | Cross-platform | Script for getting version and Message Of The Day (MOTD) information from a DHT bootstrap node. | |
| 51 | | cracker | Executable | libnacl or libsodium | Cross-platform | Tries to find a curve25519 key pair, hex representation of the public key of which starts with the specified byte sequence. | | 51 | | `cracker` | Executable | libnacl or libsodium | Cross-platform | Tries to find a curve25519 key pair, hex representation of the public key of which starts with the specified byte sequence. | |
| 52 | | strkey | Executable | libsodium | Cross-platform | Tries to find a curve25519 key pair, hex representation of the public key of which contains a specified byte pattern at the specified position or at any position. | | 52 | | `strkey` | Executable | libsodium | Cross-platform | Tries to find a curve25519 key pair, hex representation of the public key of which contains a specified byte pattern at the specified position or at any position. | |
| 53 | | make-funny-savefile | Script | python | Cross-platform | Generates Tox profile file (savedata file) with provided key pair. Useful for generating Tox profiles from the output of cracker or strkey programs. | | 53 | | `make-funny-savefile` | Script | python | Cross-platform | Generates Tox profile file (savedata file) with provided key pair. Useful for generating Tox profiles from the output of cracker or strkey programs. | |
| 54 | | sign | Executable | libsodium | Cross-platform | Program for ed25519 file signing. | | 54 | | `sign` | Executable | libsodium | Cross-platform | Program for ed25519 file signing. | |
| 55 | 55 | ||
| 56 | ## Building | 56 | ## Building |
| 57 | 57 | ||
| @@ -81,24 +81,20 @@ There is some experimental accommodation for building natively on Windows, i.e. | |||
| 81 | 81 | ||
| 82 | There are some options that are available to configure the build. | 82 | There are some options that are available to configure the build. |
| 83 | 83 | ||
| 84 | | Name | Description | Expected Value | Default Value | | 84 | | Name | Description | Expected Value | Default Value | |
| 85 | |----------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------|---------------------------------------------------| | 85 | |------------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------|---------------------------------------------------| |
| 86 | | ASAN | Enable address-sanitizer to detect invalid memory accesses. | ON or OFF | OFF | | 86 | | `BOOTSTRAP_DAEMON` | Enable building of tox-bootstrapd, the DHT bootstrap node daemon. For Unix-like systems only. | ON or OFF | ON | |
| 87 | | BOOTSTRAP_DAEMON | Enable building of tox-bootstrapd, the DHT bootstrap node daemon. For Unix-like systems only. | ON or OFF | ON | | 87 | | `BUILD_AV_TEST` | Build toxav test. | ON or OFF | ON | |
| 88 | | BUILD_AV_TEST | Build toxav test. | ON or OFF | ON | | 88 | | `BUILD_TOXAV` | Whether to build the tox AV library. | ON or OFF | ON | |
| 89 | | BUILD_TOXAV | Whether to build the tox AV library. | ON or OFF | ON | | 89 | | `CMAKE_INSTALL_PREFIX` | Path to where everything should be installed. | Directory path. | Platform-dependent. Refer to CMake documentation. | |
| 90 | | CMAKE_INSTALL_PREFIX | Path to where everything should be installed. | Directory path. | Platform-dependent. Refer to CMake documentation. | | 90 | | `DEBUG` | Enable assertions and other debugging facilities. | ON or OFF | OFF | |
| 91 | | DEBUG | Enable assertions and other debugging facilities. | ON or OFF | OFF | | 91 | | `DHT_BOOTSTRAP` | Enable building of `DHT_bootstrap` | ON or OFF | ON | |
| 92 | | DHT_BOOTSTRAP | Enable building of DHT_bootstrap | ON or OFF | ON | | 92 | | `ENABLE_SHARED` | Build shared (dynamic) libraries for all modules. | ON or OFF | ON | |
| 93 | | ENABLE_SHARED | Build shared (dynamic) libraries for all modules. | ON or OFF | ON | | 93 | | `ENABLE_STATIC` | Build static libraries for all modules. | ON or OFF | ON | |
| 94 | | ENABLE_STATIC | Build static libraries for all modules. | ON or OFF | ON | | 94 | | `STRICT_ABI` | Enforce strict ABI export in dynamic libraries. | ON or OFF | OFF | |
| 95 | | ERROR_ON_WARNING | Make compilation error on a warning. | ON or OFF | OFF | | 95 | | `TEST_TIMEOUT_SECONDS` | Limit runtime of each test to the number of seconds specified. | Positive number or nothing (empty string). | Empty string. | |
| 96 | | FORMAT_TEST | Require the format_test to be executed; fail cmake if it can't. | ON or OFF | OFF | | 96 | | `TRACE` | Enable TRACE level logging (expensive, for network debugging). | ON or OFF | OFF | |
| 97 | | STRICT_ABI | Enforce strict ABI export in dynamic libraries. | ON or OFF | OFF | | 97 | | `USE_IPV6` | Use IPv6 in tests. | ON or OFF | ON | |
| 98 | | TEST_TIMEOUT_SECONDS | Limit runtime of each test to the number of seconds specified. | Positive number or nothing (empty string). | Empty string. | | ||
| 99 | | TRACE | Enable TRACE level logging (expensive, for network debugging). | ON or OFF | OFF | | ||
| 100 | | USE_IPV6 | Use IPv6 in tests. | ON or OFF | ON | | ||
| 101 | | WARNINGS | Enable additional compiler warnings. | ON or OFF | ON | | ||
| 102 | 98 | ||
| 103 | You can get this list of option using the following commands | 99 | You can get this list of option using the following commands |
| 104 | 100 | ||
| @@ -176,14 +172,14 @@ Get the toxcore source code and navigate to `other/docker/windows`. | |||
| 176 | 172 | ||
| 177 | Build the container image based on the Dockerfile. The following options are available to customize the building of the container image. | 173 | Build the container image based on the Dockerfile. The following options are available to customize the building of the container image. |
| 178 | 174 | ||
| 179 | | Name | Description | Expected Value | Default Value | | 175 | | Name | Description | Expected Value | Default Value | |
| 180 | |---------------------|----------------------------------------------------------------|-------------------------------------|---------------| | 176 | |-----------------------|----------------------------------------------------------------|-------------------------------------|---------------| |
| 181 | | SUPPORT_ARCH_i686 | Support building 32-bit toxcore. | "true" or "false" (case sensitive). | true | | 177 | | `SUPPORT_ARCH_i686` | Support building 32-bit toxcore. | "true" or "false" (case sensitive). | true | |
| 182 | | SUPPORT_ARCH_x86_64 | Support building 64-bit toxcore. | "true" or "false" (case sensitive). | true | | 178 | | `SUPPORT_ARCH_x86_64` | Support building 64-bit toxcore. | "true" or "false" (case sensitive). | true | |
| 183 | | SUPPORT_TEST | Support running toxcore automated tests. | "true" or "false" (case sensitive). | false | | 179 | | `SUPPORT_TEST` | Support running toxcore automated tests. | "true" or "false" (case sensitive). | false | |
| 184 | | VERSION_OPUS | Version of libopus to build toxcore with. | Git branch name. | v1.2.1 | | 180 | | `VERSION_OPUS` | Version of libopus to build toxcore with. | Git branch name. | v1.2.1 | |
| 185 | | VERSION_SODIUM | Version of libsodium to build toxcore with. | Git branch name. | 1.0.16 | | 181 | | `VERSION_SODIUM` | Version of libsodium to build toxcore with. | Git branch name. | 1.0.16 | |
| 186 | | VERSION_VPX | Version of libvpx to build toxcore with. | Git branch name. | v1.6.1 | | 182 | | `VERSION_VPX` | Version of libvpx to build toxcore with. | Git branch name. | v1.6.1 | |
| 187 | 183 | ||
| 188 | Example of building a container image with options | 184 | Example of building a container image with options |
| 189 | 185 | ||
| @@ -197,13 +193,13 @@ docker build \ | |||
| 197 | 193 | ||
| 198 | Run the container to build toxcore. The following options are available to customize the running of the container image. | 194 | Run the container to build toxcore. The following options are available to customize the running of the container image. |
| 199 | 195 | ||
| 200 | | Name | Description | Expected Value | Default Value | | 196 | | Name | Description | Expected Value | Default Value | |
| 201 | |--------------------|------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------------------------------------------| | 197 | |----------------------|--------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------------------------------------------| |
| 202 | | ALLOW_TEST_FAILURE | Don't stop if a test suite fails. | "true" or "false" (case sensitive). | false | | 198 | | `ALLOW_TEST_FAILURE` | Don't stop if a test suite fails. | "true" or "false" (case sensitive). | `false` | |
| 203 | | ENABLE_ARCH_i686 | Build 32-bit toxcore. The image should have been built with SUPPORT_ARCH_i686 enabled. | "true" or "false" (case sensitive). | true | | 199 | | `ENABLE_ARCH_i686` | Build 32-bit toxcore. The image should have been built with `SUPPORT_ARCH_i686` enabled. | "true" or "false" (case sensitive). | `true` | |
| 204 | | ENABLE_ARCH_x86_64 | Build 64-bit toxcore. The image should have been built with SUPPORT_ARCH_x86_64 enabled. | "true" or "false" (case sensitive). | true | | 200 | | `ENABLE_ARCH_x86_64` | Build 64-bit toxcore. The image should have been built with `SUPPORT_ARCH_x86_64` enabled. | "true" or "false" (case sensitive). | `true` | |
| 205 | | ENABLE_TEST | Run the test suite. The image should have been built with SUPPORT_TEST enabled. | "true" or "false" (case sensitive). | false | | 201 | | `ENABLE_TEST` | Run the test suite. The image should have been built with `SUPPORT_TEST` enabled. | "true" or "false" (case sensitive). | `false` | |
| 206 | | EXTRA_CMAKE_FLAGS | Extra arguments to pass to the CMake command when building toxcore. | CMake options. | "-DWARNINGS=OFF -DBOOTSTRAP_DAEMON=OFF -DTEST_TIMEOUT_SECONDS=300" | | 202 | | `EXTRA_CMAKE_FLAGS` | Extra arguments to pass to the CMake command when building toxcore. | CMake options. | `-DWARNINGS=OFF -DBOOTSTRAP_DAEMON=OFF -DTEST_TIMEOUT_SECONDS=300` | |
| 207 | 203 | ||
| 208 | Example of running the container with options | 204 | Example of running the container with options |
| 209 | 205 | ||