diff options
Diffstat (limited to 'doc/README.windows.md')
| -rw-r--r-- | doc/README.windows.md | 175 |
1 files changed, 128 insertions, 47 deletions
diff --git a/doc/README.windows.md b/doc/README.windows.md index 018796517ddf..f224a6ed81d2 100644 --- a/doc/README.windows.md +++ b/doc/README.windows.md @@ -26,48 +26,43 @@ only if there is some other requirement to use it rather than Npcap, such as a requirement to support versions of Windows earlier than Windows Vista, which is the earliest version supported by Npcap. -Npcap and its SDK can be downloaded from its home page: - - https://npcap.com - -The SDK is a ZIP archive; create a folder on your C: drive, e.g. -C:\npcap-sdk, and put the contents of the ZIP archive into that folder. +Npcap and its SDK can be downloaded from its [home page](https://npcap.com). +The SDK is a ZIP archive; create a folder on your `C:` drive, e.g. +`C:\npcap-sdk`, and put the contents of the ZIP archive into that folder. The WinPcap installer can be downloaded from - - https://www.winpcap.org/install/default.htm - +[here](https://www.winpcap.org/install/default.htm) and the WinPcap Developer's Kit can be downloaded from - - https://www.winpcap.org/devel.htm +[here](https://www.winpcap.org/devel.htm). Required build tools -------------------- The Developer's Kit is a ZIP archive; it contains a folder named -WpdPack, which you should place on your C: drive, e.g. C:\WpdPack. +`WpdPack`, which you should place on your `C:` drive, e.g. `C:\WpdPack`. Building libpcap on Windows requires Visual Studio 2015 or later. The Community Edition of Visual Studio can be downloaded at no cost from - - https://visualstudio.microsoft.com +[here](https://visualstudio.microsoft.com). Additional tools are also required. Chocolatey is a package manager for Windows with which those tools, and other tools, can be installed; it -can be downloaded from - - https://chocolatey.org +can be downloaded from [here](https://chocolatey.org). It is a command-line tool; a GUI tool, Chocolatey GUI, is provided as a Chocolatey package, which can be installed from the command line: - choco install chocolateygui +``` +choco install chocolateygui +``` -For convenience, the "choco install" command can be run with the "-y" +For convenience, the `choco install` command can be run with the `-y` flag, forcing it to automatically answer all questions asked of the user with "yes": - choco install -y chocolateygui +``` +choco install -y chocolateygui +``` The required tools are: @@ -77,31 +72,31 @@ libpcap does not provide supported project files for Visual Studio (there are currently unsupported project files provided, but we do not guarantee that they will work or that we will continue to provide them). It does provide files for CMake, which is a cross-platform tool that -runs on UN*Xes and on Windows and that can generate project files for -UN*X Make, the Ninja build system, and Visual Studio, among other build +runs on UN\*Xes and on Windows and that can generate project files for +UN\*X Make, the Ninja build system, and Visual Studio, among other build systems. Visual Studio 2015 does not provide CMake; an installer can be -downloaded from - - https://cmake.org/download/ +downloaded from [here](https://cmake.org/download/). When you run the installer, you should choose to add CMake to the system -PATH for all users and to create the desktop icon. - -CMake can also be installed as the Chocolatey package "cmake": +`PATH` for all users and to create the desktop icon. - choco install -y cmake +Visual Studio 2017, 2019, and 2022 provide CMake, so you will not need +to install CMake if you have installed one of those versions of Visual +Studio or later. They include built-in support for CMake-based projects +as described +[here](https://devblogs.microsoft.com/cppblog/cmake-support-in-visual-studio/). -Visual Studio 2017 and later provide CMake, so you will not need to -install CMake if you have installed Visual Studio 2017 or later. They -include built-in support for CMake-based projects: +For Visual Studio 2017, make sure "Visual C++ tools for CMake" is +installed; for Visual Studio 2019 and 2022, make sure "C++ CMake tools +for Windows" is installed. - https://devblogs.microsoft.com/cppblog/cmake-support-in-visual-studio/ +CMake can also be installed as the Chocolatey package `cmake`: -For Visual Studio 2017, make sure "Visual C++ tools for CMake" is -installed; for Visual Studio 2019, make sure "C++ CMake tools for -Windows" is installed. +``` +choco install -y cmake +``` ### winflexbison ### @@ -140,19 +135,21 @@ Debug build. In the CMakeSettings.json tab, change cmakeCommandArgs to include - -DPacket_ROOT={path-to-sdk} +``` +-DPacket_ROOT={path-to-sdk} +``` -where {path-to-sdk} is the path of the directory containing the Npcap or +where `{path-to-sdk}` is the path of the directory containing the Npcap or WinPcap SDK. Note that backslashes in the path must be specified as two backslashes. Save the configuration changes with File > "Save CMakeSettings.json" or -with control-S. +with Control-S. Visual Studio will then re-run CMake. If that completes without errors, you can build with CMake > "Build All". -### Visual Studio 2019 ### +### Visual Studio 2019 and 2022 ### Open the folder containing the libpcap source with Open > Folder. Visual Studio will run CMake; however, you will need to indicate where @@ -169,7 +166,7 @@ the directory containing the Npcap or WinPcap SDK or use the "Browse..." button to browse for that directory. Save the configuration changes with File > "Save CMakeSettings.json" or -with control-S. +with Control-S. Visual Studio will then re-run CMake. If that completes without errors, you can build with Build > "Build All". @@ -177,6 +174,8 @@ you can build with Build > "Build All". Building from the command line ------------------------------ +### Visual Studio 2017 ### + Start the appropriate Native Tools command line prompt. Change to the directory into which you want to build libpcap, possibly @@ -185,14 +184,96 @@ of the libpcap source directory. Run the command - cmake "-DPacket_ROOT={path-to-sdk}" {path-to-libpcap-source} +``` +cmake "-DPacket_ROOT={path-to-sdk}" -G {generator} {path-to-libpcap-source} +``` -where {path-to-sdk} is the path of the directory containing the Npcap or -WinPcap SDK and {path-to-libpcap-source} is the pathname of the -top-level source directory for libpcap. +`{path-to-sdk}` is the path of the directory containing the Npcap or +WinPcap SDK. + +`{generator}` is the string "Visual Studio 15 2017" to build a 32-bit +version of libpcap or the string "Visual Studio 15 2017 Win64" to build +a 64-bit version of libpcap. + +`{path-to-libpcap-source}` is the pathname of the top-level source +directory for libpcap. + +Run the command + +``` +msbuild /m /nologo /p:Configuration={configuration} pcap.sln +``` + +where `{configuration}` can be "Release", "Debug", or "RelWithDebInfo". + +### Visual Studio 2019 ### + +Start the appropriate Native Tools command line prompt. + +Change to the directory into which you want to build libpcap, possibly +after creating it first. One choice is to create it as a subdirectory +of the libpcap source directory. Run the command - msbuild/m pcap.sln +``` +cmake "-DPacket_ROOT={path-to-sdk}" -G "Visual Studio 16 2019" {platform} {path-to-libpcap-source} +``` + +`{path-to-sdk}` is the path of the directory containing the Npcap or +WinPcap SDK. + +`{platform}` is `-A Win32` to build a 32-bit version of libpcap or `-A +x64` to build a 64-bit version of libpcap. + +`{path-to-libpcap-source}` is the pathname of the top-level source +directory for libpcap. + +Run the command + +``` +msbuild /m /nologo /p:Configuration={configuration} pcap.sln +``` + +where `{configuration}` can be "Release", "Debug", or "RelWithDebInfo". + +### Visual Studio 2022 ### + +Start the appropriate Native Tools command line prompt. + +Change to the directory into which you want to build libpcap, possibly +after creating it first. One choice is to create it as a subdirectory +of the libpcap source directory. + +Run the command + +``` +cmake "-DPacket_ROOT={path-to-sdk}" -G "Visual Studio 17 2022" {platform} {path-to-libpcap-source} +``` + +`{path-to-sdk}` is the path of the directory containing the Npcap or +WinPcap SDK. + +`{platform}` is `-A Win32` to build a 32-bit version of libpcap or `-A +x64` to build a 64-bit version of libpcap. + +`{path-to-libpcap-source}` is the pathname of the top-level source +directory for libpcap. + +Run the command + +``` +msbuild /m /nologo /p:Configuration={configuration} pcap.sln +``` + +where `{configuration}` can be "Release", "Debug", or "RelWithDebInfo". + +Building with MinGW +------------------- + +MinGW is not supported because its snprintf(3) implementation is not suitable. + +Building with SSL/TLS support +----------------------------- -to compile libpcap. +This is currently not implemented on Windows. |