Skip to content

Commit 58b423a

Browse files
seladbseladb
committed
Fx formatting
1 parent a356504 commit 58b423a

2 files changed

Lines changed: 14 additions & 13 deletions

File tree

‎docs/features.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ sudo insmod <PF_RING_LOCATION>/kernel/pf_ring.ko
230230

231231
## WinDivert support
232232

233-
Windows Packet Divert (WinDivert) is a user-mode packet capture-and-divert package for Windows. It allows user-mode applications to capture/modify/drop network packets sent to/from the Windows network stack (taken from [WinDivert documentation](https://reqrypt.org/windivert.html)).
233+
Windows Packet Divert (WinDivert) is a user-mode packet capture-and-divert package for Windows. It allows user-mode applications to capture/modify/drop network packets sent to/from the Windows network stack (taken from [WinDivert documentation](https://reqrypt.org/windivert.html)).
234234

235235
PcapPlusPlus provides support for various features when using WinDivert, including:
236236

@@ -240,6 +240,7 @@ PcapPlusPlus provides support for various features when using WinDivert, includi
240240
- Inspecting and configuring queue parameters (length, time, size)
241241

242242
In order to use PcapPlusPlus with WinDivert support you need to:
243+
243244
- Download WinDivert from [WinDivert's GitHub Repo](https://github.com/basil00/WinDivert/releases)
244245
- Once WinDivert is downloaded and extracted, you need to run PcapPlusPlus build and use the `-DPCAPPP_USE_WINDIVERT=ON` option
245246
- Make sure the WinDivert DLLs are accessible to your application (e.g. in the same directory as your executable or in a directory included in your PATH environment variable)

‎docs/install/mingw.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,18 @@ This process will build the following artifacts:
5858

5959
The following configuration options are available (on top of CMake's built-in options):
6060

61-
| Option | Description |
62-
| :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
63-
| **`-DPCAP_ROOT=<DIR>`** | Npcap SDK or WinPcap developer pack directory (mandatory option) |
64-
| **`-DPCAPPP_BUILD_EXAMPLES=<ON/OFF>`** | Build PcapPlusPlus examples (default value is `ON` if building the project itself, otherwise `OFF`) |
65-
| **`-DPCAPPP_BUILD_TESTS=<ON/OFF>`** | Build PcapPlusPlus tests (default value is `ON` if building the project itself, otherwise `OFF`) |
66-
| **`-DPCAPPP_BUILD_TUTORIALS=<ON/OFF>`** | Build PcapPlusPlus tutorials. This option is only available if `DPCAPPP_BUILD_EXAMPLES=ON`. The tutorials binaries will be under `build\tutorials_bin` (default value is `OFF`) |
67-
| **`-DPCAPPP_INSTALL=<ON/OFF>`** | Install PcapPlusPlus (default value is `ON` if building the project itself, otherwise `OFF`) |
68-
| **`-DPCAPPP_USE_WINDIVERT=<ON/OFF>`** | Setup PcapPlusPlus with WinDivert (default value is `OFF`). When this option is used CMake will look for an installed version of WinDivert on the build machine (by default under `C:\Program Files\WinDivert` or `C:\WinDivert`). If WinDivert is installed in a different directory please use `-DWinDivert_ROOT` |
69-
| **`-DWinDivert_ROOT=<DIR>`** | When setting up PcapPlusPlus with WinDivert and WinDivert is not installed in the default directory (under `C:\Program Files\WinDivert` or `C:\WinDivert`) use this option to indicate WinDivert installation directory |
70-
| **`-DBUILD_SHARED_LIBS=<ON/OFF>`** | Build shared libs (default value is `OFF`) |
71-
| **`-DPCAPPP_BUILD_PCAPPP=<ON/OFF>`** | Build the Pcap++ library (default value is `ON`). Turning it off will only build Common++ and Packet++ and avoid third-party dependencies such as libpcap or WinPcap/Npcap |
72-
| **`-DPCAPPP_LOG_LEVEL=<0/1/2/3>`** | Set compile time log level: Off (`0`), Error (`1`), Info (`2`), Debug (`1`) (Default value is `Debug`) |
61+
| Option | Description |
62+
| :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
63+
| **`-DPCAP_ROOT=<DIR>`** | Npcap SDK or WinPcap developer pack directory (mandatory option) |
64+
| **`-DPCAPPP_BUILD_EXAMPLES=<ON/OFF>`** | Build PcapPlusPlus examples (default value is `ON` if building the project itself, otherwise `OFF`) |
65+
| **`-DPCAPPP_BUILD_TESTS=<ON/OFF>`** | Build PcapPlusPlus tests (default value is `ON` if building the project itself, otherwise `OFF`) |
66+
| **`-DPCAPPP_BUILD_TUTORIALS=<ON/OFF>`** | Build PcapPlusPlus tutorials. This option is only available if `DPCAPPP_BUILD_EXAMPLES=ON`. The tutorials binaries will be under `build\tutorials_bin` (default value is `OFF`) |
67+
| **`-DPCAPPP_INSTALL=<ON/OFF>`** | Install PcapPlusPlus (default value is `ON` if building the project itself, otherwise `OFF`) |
68+
| **`-DPCAPPP_USE_WINDIVERT=<ON/OFF>`** | Setup PcapPlusPlus with WinDivert (default value is `OFF`). When this option is used CMake will look for an installed version of WinDivert on the build machine (by default under `C:\Program Files\WinDivert` or `C:\WinDivert`). If WinDivert is installed in a different directory please use `-DWinDivert_ROOT` |
69+
| **`-DWinDivert_ROOT=<DIR>`** | When setting up PcapPlusPlus with WinDivert and WinDivert is not installed in the default directory (under `C:\Program Files\WinDivert` or `C:\WinDivert`) use this option to indicate WinDivert installation directory |
70+
| **`-DBUILD_SHARED_LIBS=<ON/OFF>`** | Build shared libs (default value is `OFF`) |
71+
| **`-DPCAPPP_BUILD_PCAPPP=<ON/OFF>`** | Build the Pcap++ library (default value is `ON`). Turning it off will only build Common++ and Packet++ and avoid third-party dependencies such as libpcap or WinPcap/Npcap |
72+
| **`-DPCAPPP_LOG_LEVEL=<0/1/2/3>`** | Set compile time log level: Off (`0`), Error (`1`), Info (`2`), Debug (`1`) (Default value is `Debug`) |
7373

7474
## Installation
7575

0 commit comments

Comments
 (0)