Skip to content

Commit

Permalink
Update README.md for TCP ACK tracker disabling
Browse files Browse the repository at this point in the history
  • Loading branch information
mfontanini committed Feb 16, 2016
1 parent 8e7eb25 commit af6b0fd
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down

0 comments on commit af6b0fd

Please sign in to comment.