From af6b0fdbb2087ee0416b7269f5caf433cc0b7c41 Mon Sep 17 00:00:00 2001 From: Matias Fontanini Date: Mon, 15 Feb 2016 18:19:38 -0800 Subject: [PATCH] Update README.md for TCP ACK tracker disabling --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 13591e6..de4d017 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ cmake ../ make ``` +### Static/shared build Note that by default, only the shared object is compiled. If you would like to generate a static library file, run: @@ -46,6 +47,8 @@ cmake ../ -DLIBTINS_BUILD_SHARED=0 The generated static/shared library files will be located in the _build/lib_ directory. +### C++11 support + libtins is noticeable faster if you enable _C++11_ support. Therefore, if your compiler supports this standard, then you should enable it. In order to do so, use the _LIBTINS_ENABLE_CXX11_ switch: @@ -54,6 +57,22 @@ In order to do so, use the _LIBTINS_ENABLE_CXX11_ switch: cmake ../ -DLIBTINS_ENABLE_CXX11=1 ``` +### TCP ACK tracker + +The TCP ACK tracker feature requires the boost.icl library (header only). +This feature is enabled by default but will be disabled if the boost +headers are not found. You can disable this feature by using: + +```Shell +cmake ../ -DLIBTINS_ENABLE_ACK_TRACKER=0 +``` + +If your boost installation is on some non-standard path, use +the parameters shown on the +[CMake FindBoost help](https://cmake.org/cmake/help/v3.0/module/FindBoost.html) + +### WPA2 decryption + If you want to disable _WPA2_ decryption support, which will remove openssl as a dependency for compilation, use the _LIBTINS_ENABLE_WPA2_ switch: @@ -62,6 +81,8 @@ _LIBTINS_ENABLE_WPA2_ switch: cmake ../ -DLIBTINS_ENABLE_WPA2=0 ``` +### IEEE 802.11 support + If you want to disable IEEE 802.11 support(this will also disable RadioTap and WPA2 decryption), which will reduce the size of the resulting library in around 20%, use the _LIBTINS_ENABLE_DOT11_ switch: