1
0
mirror of https://github.com/mfontanini/libtins synced 2026-01-23 02:35:57 +01:00

Added README.md and updated README.

This commit is contained in:
matias
2013-11-24 11:07:39 -03:00
parent 295ebb679c
commit ca4912ded4
2 changed files with 87 additions and 2 deletions

4
README
View File

@@ -15,7 +15,7 @@ send, receive and manipulate specially crafted packets.
In order to read tutorials, examples and checkout some benchmarks of the
library, please visit:
http://libtins.sourceforge.net/
http://libtins.github.io/
------------------------------- Compiling ------------------------------
@@ -70,4 +70,4 @@ ldconfig
You might want to have a look at the examples located in the "examples"
directory. The same samples can be found online at:
http://libtins.sourceforge.net/examples/
http://libtins.github.io/examples/

85
README.md Normal file
View File

@@ -0,0 +1,85 @@
libtins
=======
libtins is a high-level, multiplatform C++ network packet sniffing and
crafting library.
Its main purpose is to provide the C++ developer an easy, efficient,
platform and endianess-independent way to create tools which need to
send, receive and manipulate specially crafted packets.
In order to read tutorials, examples and checkout some benchmarks of the
library, please visit:
http://libtins.github.io/
## Compiling ##
---------------
libtins depends on libpcap and openssl, although the latter is not
necessary if some features of the library are disabled.
In order to compile, execute:
```Shell
./configure
make
```
Note that by default, only the shared object is compiled. If you would
like to generate a static library file as well, run:
```Shell
./configure --enable-static
```
The generated static/shared library files will be located in the .libs
directory.
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 --enable-c++11 switch:
```Shell
./configure --enable-c++11
```
If you want to disable WPA2 decryption support, which will remove
openssl as a dependency for compilation, use the --disable-wpa2 switch:
```Shell
./configure --disable-wpa2
```
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 --disable-dot11 switch:
```Shell
./configure --disable-dot11
```
## Installing ##
----------------
Once you're done, if you want to install the header files and the
shared object, execute as root:
```Shell
make install
```
This will install the shared object typically in /usr/local/lib. Note
that you might have to update ldconfig's cache before using it, so
in order to invalidate it, you should run(as root):
```Shell
ldconfig
```
## Examples ##
You might want to have a look at the examples located in the "examples"
directory. The same samples can be found online at:
http://libtins.github.io/examples/