aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuy Harris <gharris@sonic.net>2024-03-28 22:52:18 -0700
committerGuy Harris <gharris@sonic.net>2024-03-28 23:03:48 -0700
commit9341e49c353ffa45a691cf2492f7025b7a69734d (patch)
tree10daca12a1feedd079c9fbef9c9fcef7163e7581
parentfd42316d094b9930f7f7a57ea63fbd1c7ec04ccf (diff)
downloadlibpcap-9341e49c353ffa45a691cf2492f7025b7a69734d.tar.gz
README.windows.md: pick up some improvements from the tcpdump file. [skip ci]
The tcpdump file has formatting improvements and fixes to the command-line section, and also has a stub MinGW section.
-rw-r--r--doc/README.windows.md128
1 files changed, 86 insertions, 42 deletions
diff --git a/doc/README.windows.md b/doc/README.windows.md
index 01879651..95894dcb 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
+Building tcpdump 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,27 +72,26 @@ 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.
+`PATH` for all users and to create the desktop icon.
-CMake can also be installed as the Chocolatey package "cmake":
+CMake can also be installed as the Chocolatey package `cmake`:
- choco install -y cmake
+```
+choco install -y cmake
+```
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:
-
- https://devblogs.microsoft.com/cppblog/cmake-support-in-visual-studio/
+include built-in support for CMake-based projects as described
+[here](https://devblogs.microsoft.com/cppblog/cmake-support-in-visual-studio/).
For Visual Studio 2017, make sure "Visual C++ tools for CMake" is
installed; for Visual Studio 2019, make sure "C++ CMake tools for
@@ -140,14 +134,16 @@ 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".
@@ -169,7 +165,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 +173,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 +183,60 @@ 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}
+```
+
+`{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.
-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-libpcap-source}` is the pathname of the top-level source
+directory for libpcap.
Run the command
- msbuild/m pcap.sln
+```
+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
+
+```
+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".
+
+Building with MinGW
+-------------------
-to compile libpcap.
+(XXX - this should be added)