aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2013-07-28 21:12:07 +0000
committerGuy Harris <guy@alum.mit.edu>2013-07-28 21:12:07 +0000
commita4ad9e9f74d58f3a869ceb27845f74345d7b81be (patch)
tree8232de5a3f542b692b883fcf0f057b0f2a0e7af5 /doc
parent0f13e3c95d571c7000e84d0c1e6f9f76575508b4 (diff)
If a core Wireshark developer repeatedly can't remember that the
argument to the -F flag for pcap format is "libpcap", not "pcap", we have a problem. Make it "pcap", and add a backwards-compatibility hack to support using "libpcap" as well. Update the man pages to refer to it as pcap as well, and fix the capitalization of "WinPcap" (see http://www.winpcap.org) while we're at it. Also, refer to http://www.tcpdump.org/linktypes.html for the list of link-layer header types for pcap and pcap-ng. svn path=/trunk/; revision=50989
Diffstat (limited to 'doc')
-rw-r--r--doc/dumpcap.pod14
-rw-r--r--doc/editcap.pod4
-rw-r--r--doc/mergecap.pod6
-rw-r--r--doc/randpkt.pod2
-rw-r--r--doc/rawshark.pod35
-rw-r--r--doc/text2pcap.pod2
-rw-r--r--doc/tshark.pod10
-rw-r--r--doc/wireshark.pod.template15
8 files changed, 45 insertions, 43 deletions
diff --git a/doc/dumpcap.pod b/doc/dumpcap.pod
index 76c2cac8d6..7b70819826 100644
--- a/doc/dumpcap.pod
+++ b/doc/dumpcap.pod
@@ -39,15 +39,15 @@ B<Dumpcap> is a network traffic dump tool. It lets you capture packet
data from a live network and write the packets to a file. B<Dumpcap>'s
default capture file format is B<pcap-ng> format.
When the B<-P> option is specified, the output file is written in the
-B<libpcap> format.
+B<pcap> format.
-Without any options set it will
-use the pcap library to capture traffic from the first available network
-interface and writes the received raw packet data, along with the packets'
-time stamps into a libpcap file.
+Without any options set it will use the libpcap/WinPcap library to
+capture traffic from the first available network interface and writes
+the received raw packet data, along with the packets' time stamps into a
+pcap file.
If the B<-w> option is not specified, B<Dumpcap> writes to a newly
-created libpcap file with a randomly chosen name.
+created pcap file with a randomly chosen name.
If the B<-w> option is specified, B<Dumpcap> writes to the file
specified by that option.
@@ -214,7 +214,7 @@ B<Dumpcap> reports an error and doesn't start the capture.
Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
read data from the standard input. Data read from pipes must be in
-standard libpcap format.
+standard pcap format.
This option can occur multiple times. When capturing from multiple
interfaces, the capture file will be saved in pcap-ng format.
diff --git a/doc/editcap.pod b/doc/editcap.pod
index b865b2c731..b89ecb51ca 100644
--- a/doc/editcap.pod
+++ b/doc/editcap.pod
@@ -40,7 +40,7 @@ I<infile>, optionally converts them in various ways and writes the
resulting packets to the capture I<outfile> (or outfiles).
By default, it reads all packets from the I<infile> and writes them to the
-I<outfile> in libpcap file format.
+I<outfile> in pcap file format.
An optional list of packet numbers can be specified on the command tail;
individual packet numbers separated by whitespace and/or ranges of packet
@@ -141,7 +141,7 @@ This option is meant to be used for fuzz-testing protocol dissectors.
Sets the file format of the output capture file.
B<Editcap> can write the file in several formats, B<editcap -F>
provides a list of the available output formats. The default
-is the B<libpcap> format.
+is the B<pcap> format.
=item -h
diff --git a/doc/mergecap.pod b/doc/mergecap.pod
index 1376bbcf2c..c19ec6dc98 100644
--- a/doc/mergecap.pod
+++ b/doc/mergecap.pod
@@ -19,10 +19,10 @@ E<lt>I<infile>E<gt> [E<lt>I<infile>E<gt> I<...>]
B<Mergecap> is a program that combines multiple saved capture files into
a single output file specified by the B<-w> argument. B<Mergecap> knows
-how to read B<libpcap> capture files, including those of B<tcpdump>,
+how to read B<pcap> capture files, including those of B<tcpdump>,
B<Wireshark>, and other tools that write captures in that format.
-By default, B<Mergecap> writes the capture file in B<libpcap> format, and writes
+By default, B<Mergecap> writes the capture file in B<pcap> format, and writes
all of the packets from the input capture files to the output file.
B<Mergecap> is able to detect, read and write the same capture files that
@@ -50,7 +50,7 @@ The output file frame encapsulation type is set to the type of the input
files if all input files have the same type. If not all of the input
files have the same frame encapsulation type, the output file type is
set to WTAP_ENCAP_PER_PACKET. Note that some capture file formats, most
-notably B<libpcap>, do not currently support WTAP_ENCAP_PER_PACKET.
+notably B<pcap>, do not currently support WTAP_ENCAP_PER_PACKET.
This combination will cause the output file creation to fail.
=head1 OPTIONS
diff --git a/doc/randpkt.pod b/doc/randpkt.pod
index 7cea935780..29094b088f 100644
--- a/doc/randpkt.pod
+++ b/doc/randpkt.pod
@@ -13,7 +13,7 @@ E<lt>filenameE<gt>
=head1 DESCRIPTION
-B<randpkt> is a small utility that creates a B<libpcap> trace file
+B<randpkt> is a small utility that creates a B<pcap> trace file
full of random packets.
By creating many randomized packets of a certain type, you can
diff --git a/doc/rawshark.pod b/doc/rawshark.pod
index fcf9822055..0514d41efb 100644
--- a/doc/rawshark.pod
+++ b/doc/rawshark.pod
@@ -1,7 +1,7 @@
=head1 NAME
-rawshark - Dump and analyze raw libpcap data
+rawshark - Dump and analyze raw pcap data
=head1 SYNOPSIS
@@ -36,7 +36,7 @@ useful. The other flags listed above follow the same conventions as
B<Wireshark> and B<TShark>.
B<Rawshark> expects input records with the following format by default. This
-matches the format of the packet header and packet data in a libpcap-formatted
+matches the format of the packet header and packet data in a pcap-formatted
file on disk.
struct rawshark_rec_s {
@@ -49,13 +49,13 @@ file on disk.
If B<-p> is supplied B<rawshark> expects the following format. This
matches the I<struct pcap_pkthdr> structure and packet data used in
-libpcap. This structure's format is platform-dependent; the size of the
-I<tv_sec> field in the I<struct timeval> structure could be 32 bits or
-64 bits. For B<rawshark> to work, the layout of the structure in the
-input must match the layout of the structure in B<rawshark>. Note that
-this format will probably be the same as the previous format if
-B<rawshark> is a 32-bit program, but will not necessarily be the same if
-B<rawshark> is a 64-bit program.
+libpcap/WinPcap. This structure's format is platform-dependent; the
+size of the I<tv_sec> field in the I<struct timeval> structure could be
+32 bits or 64 bits. For B<rawshark> to work, the layout of the
+structure in the input must match the layout of the structure in
+B<rawshark>. Note that this format will probably be the same as the
+previous format if B<rawshark> is a 32-bit program, but will not
+necessarily be the same if B<rawshark> is a 64-bit program.
struct rawshark_rec_s {
struct timeval ts; /* Time stamp */
@@ -104,13 +104,14 @@ fields might be displayed.
Specify how the packet data should be dissected. The encapsulation is of the
form I<type>B<:>I<value>, where I<type> is one of:
-B<encap>:I<name> Packet data should be dissected using the libpcap data link
-type (DLT) I<name>, e.g. B<encap:EN10MB> for Ethernet. Names are converted
-using pcap_datalink_name_to_val().
+B<encap>:I<name> Packet data should be dissected using the
+libpcap/WinPcap data link type (DLT) I<name>, e.g. B<encap:EN10MB> for
+Ethernet. Names are converted using pcap_datalink_name_to_val().
+A complete list of DLTs can be found at
+L<http://www.tcpdump.org/linktypes.html>.
-B<encap>:I<number> Packet data should be dissected using the libpcap DLT
-I<number>, e.g. B<encap:105> for raw IEEE 802.11. A complete list of DLTs
-can be found in pcap-bpf.h in the libpcap sources.
+B<encap>:I<number> Packet data should be dissected using the
+libpcap/WinPcap DLT I<number>, e.g. B<encap:105> for raw IEEE 802.11.
B<proto>:I<protocol> Packet data should be passed to the specified Wireshark
protocol dissector, e.g. B<proto:http> for HTTP data.
@@ -312,7 +313,7 @@ whitespace. The same directory as for the personal preferences file is
used.
Capture filter name resolution is handled by libpcap on UNIX-compatible
-systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
+systems and WinPcap on Windows. As such the Wireshark personal F<hosts> file
will not be consulted for capture filter name resolution.
=item Name Resolution (ethers)
@@ -339,7 +340,7 @@ The personal F<ethers> file is looked for in the same directory as the personal
preferences file.
Capture filter name resolution is handled by libpcap on UNIX-compatible
-systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
+systems and WinPcap on Windows. As such the Wireshark personal F<ethers> file
will not be consulted for capture filter name resolution.
=item Name Resolution (manuf)
diff --git a/doc/text2pcap.pod b/doc/text2pcap.pod
index 498e190e14..d2cbdcbd1c 100644
--- a/doc/text2pcap.pod
+++ b/doc/text2pcap.pod
@@ -28,7 +28,7 @@ E<lt>I<outfile>E<gt>|-
=head1 DESCRIPTION
B<Text2pcap> is a program that reads in an ASCII hex dump and writes the
-data described into a B<libpcap> capture file. B<text2pcap> can
+data described into a B<pcap> capture file. B<text2pcap> can
read hexdumps with multiple packets in them, and build a capture file of
multiple packets. B<text2pcap> is also capable of generating dummy
Ethernet, IP and UDP, TCP, or SCTP headers, in order to build fully
diff --git a/doc/tshark.pod b/doc/tshark.pod
index 6e3a81c281..111a1d774b 100644
--- a/doc/tshark.pod
+++ b/doc/tshark.pod
@@ -60,7 +60,7 @@ B<TShark> is a network protocol analyzer. It lets you capture packet
data from a live network, or read packets from a previously saved
capture file, either printing a decoded form of those packets to the
standard output or writing the packets to a file. B<TShark>'s native
-capture file format is B<libpcap> format, which is also the format used
+capture file format is B<pcap> format, which is also the format used
by B<tcpdump> and various other tools.
Without any options set, B<TShark> will work much like B<tcpdump>. It will
@@ -103,7 +103,7 @@ B<TShark> without the B<-w> option, and redirect its standard output to
the file (do I<not> use the B<-w> option).
When writing packets to a file, B<TShark>, by default, writes the
-file in B<libpcap> format, and writes all of the packets it sees to the
+file in B<pcap> format, and writes all of the packets it sees to the
output file. The B<-F> option can be used to specify the format in which
to write the file. This list of available file formats is displayed by
the B<-F> flag without a value. However, you can't specify a file format
@@ -461,7 +461,7 @@ B<TShark> reports an error and doesn't start the capture.
Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
read data from the standard input. Data read from pipes must be in
-standard libpcap format.
+standard pcap format.
This option can occur multiple times. When capturing from multiple
interfaces, the capture file will be saved in pcap-ng format.
@@ -1480,7 +1480,7 @@ whitespace. The same directory as for the personal preferences file is
used.
Capture filter name resolution is handled by libpcap on UNIX-compatible
-systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
+systems and WinPcap on Windows. As such the Wireshark personal F<hosts> file
will not be consulted for capture filter name resolution.
=item Name Resolution (ethers)
@@ -1507,7 +1507,7 @@ The personal F<ethers> file is looked for in the same directory as the personal
preferences file.
Capture filter name resolution is handled by libpcap on UNIX-compatible
-systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
+systems and WinPcap on Windows. As such the Wireshark personal F<ethers> file
will not be consulted for capture filter name resolution.
=item Name Resolution (manuf)
diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template
index a0f8f47354..9f2f2c5478 100644
--- a/doc/wireshark.pod.template
+++ b/doc/wireshark.pod.template
@@ -54,7 +54,7 @@ S<[ E<lt>infileE<gt> ]>
B<Wireshark> is a GUI network protocol analyzer. It lets you
interactively browse packet data from a live network or from a
previously saved capture file. B<Wireshark>'s native capture file format
-is B<libpcap> format, which is also the format used by B<tcpdump> and
+is B<pcap> format, which is also the format used by B<tcpdump> and
various other tools.
B<Wireshark> can read / import the following file formats:
@@ -62,11 +62,12 @@ B<Wireshark> can read / import the following file formats:
=over 4
=item *
-libpcap - captures from B<Wireshark>/B<TShark>/B<dumpcap>, B<tcpdump>,
-and various other tools using libpcap's/tcpdump's capture format
+pcap - captures from B<Wireshark>/B<TShark>/B<dumpcap>, B<tcpdump>,
+and various other tools using libpcap's/WinPcap's/tcpdump's/WinDump's
+capture format
=item *
-pcap-ng - "next-generation" successor to libpcap format
+pcap-ng - "next-generation" successor to pcap format
=item *
B<snoop> and B<atmsnoop> captures
@@ -374,7 +375,7 @@ B<Wireshark> reports an error and doesn't start the capture.
Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
read data from the standard input. On Windows systems, pipe names must be
of the form ``\\pipe\.\B<pipename>''. Data read from pipes must be in
-standard libpcap format.
+standard pcap format.
This option can occur multiple times. When capturing from multiple
interfaces, the capture file will be saved in pcap-ng format.
@@ -2557,7 +2558,7 @@ file syntax; each line contains one IP address and name, separated by
whitespace. The same directory as for the personal preferences file is used.
Capture filter name resolution is handled by libpcap on UNIX-compatible
-systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
+systems and WinPcap on Windows. As such the Wireshark personal F<hosts> file
will not be consulted for capture filter name resolution.
=item Name Resolution (ethers)
@@ -2584,7 +2585,7 @@ The personal F<ethers> file is looked for in the same directory as the personal
preferences file.
Capture filter name resolution is handled by libpcap on UNIX-compatible
-systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
+systems and WinPcap on Windows. As such the Wireshark personal F<ethers> file
will not be consulted for capture filter name resolution.
=item Name Resolution (manuf)