epan/dissectors/packet-xml.c try to decrypt data, but the data doesn't look correct yet
[metze/wireshark/wip.git] / README.md
index 7c283ffe07d68bac51600c4ecce098aa92fa6296..a1d5305a7b25aae71b83f52d465cd1de4834b2d4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Unix-like operating systems.  It uses Qt, a graphical user interface
 library, and libpcap, a packet capture and filtering library.
 
 The Wireshark distribution also comes with TShark, which is a
-line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
+line-oriented sniffer (similar to Sun's snoop or tcpdump) that uses the
 same dissection, capture-file reading and writing, and packet filtering
 code as Wireshark, and with editcap, which is a program to read capture
 files and write the packets from that capture file, possibly in a
@@ -68,13 +68,13 @@ Usage
 -----
 
 In order to capture packets from the network, you need to make the
-dumpcap program set-UID to root, or you need to have access to the
+dumpcap program set-UID to root or you need to have access to the
 appropriate entry under `/dev` if your system is so inclined (BSD-derived
 systems, and systems such as Solaris and HP-UX that support DLPI,
 typically fall into this category).  Although it might be tempting to
 make the Wireshark and TShark executables setuid root, or to run them as
 root please don't.  The capture process has been isolated in dumpcap;
-this simple program is less likely to contain security holes, and thus
+this simple program is less likely to contain security holes and is thus
 safer to run as root.
 
 Please consult the man page for a description of each command-line
@@ -84,21 +84,14 @@ option and interface feature.
 Multiple File Types
 -------------------
 
-The wiretap library is a packet-capture library currently under
-development parallel to wireshark.  In the future it is hoped that
-wiretap will have more features than libpcap, but wiretap is still in
-its infancy. However, wiretap is used in wireshark for its ability
-to read multiple file types.  See the Wireshark man page or the
-Wireshark User's Guide for a list of supported file formats.
-
-In addition, it can read gzipped versions of any of those files
-automatically, if you have the zlib library available when compiling
-Wireshark. Wireshark needs a modern version of zlib to be able to use
-zlib to read gzipped files; version 1.1.3 is known to work.  Versions
-prior to 1.0.9 are missing some functions that Wireshark needs and won't
-work.  `./configure` should detect if you have the proper zlib version
-available and, if you don't, should disable zlib support. You can always
-use `./configure --disable-zlib` to explicitly disable zlib support.
+Wireshark can read packets from a number of different file types.  See
+the Wireshark man page or the Wireshark User's Guide for a list of
+supported file formats.
+
+Wireshark can transparently read gzipped versions of any of those files if
+zlib was available when Wireshark was compiled.  CMake will automatically
+use zlib if it is found on your system.  You can disable zlib support by
+running `cmake -DENABLE_ZLIB=OFF`.
 
 Although Wireshark can read AIX iptrace files, the documentation on
 AIX's iptrace packet-trace command is sparse.  The `iptrace` command
@@ -108,12 +101,12 @@ daemon causes a graceful shutdown and a complete packet is written
 to the trace file. If a partial packet is saved at the end, Wireshark
 will complain when reading that file, but you will be able to read all
 other packets.  If this occurs, please let the Wireshark developers know
-at wireshark-dev@wireshark.org, and be sure to send us a copy of that trace
+at wireshark-dev@wireshark.org; be sure to send us a copy of that trace
 file if it's small and contains non-sensitive data.
 
 Support for Lucent/Ascend products is limited to the debug trace output
 generated by the MAX and Pipline series of products.  Wireshark can read
-the output of the `wandsession` `wandisplay`, `wannext`, and `wdd`
+the output of the `wandsession`, `wandisplay`, `wannext`, and `wdd`
 commands.
 
 Wireshark can also read dump trace output from the Toshiba "Compact Router"
@@ -121,7 +114,7 @@ line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 and start a dump session with `snoop dump`.
 
 CoSine L2 debug output can also be read by Wireshark. To get the L2
-debug output, get in the diags mode first and then use
+debug output first enter the diags mode and then use
 `create-pkt-log-profile` and `apply-pkt-lozg-profile` commands under
 layer-2 category. For more detail how to use these commands, you
 should examine the help command by `layer-2 create ?` or `layer-2 apply ?`.
@@ -131,8 +124,8 @@ capture the trace output to a file on disk.  The trace is happening inside
 the router and the router has no way of saving the trace to a file for you.
 An easy way of doing this under Unix is to run `telnet <ascend> | tee <outfile>`.
 Or, if your system has the "script" command installed, you can save
-a shell session, including telnet to a file. For example, to a file named
-tracefile.out:
+a shell session, including telnet, to a file. For example to log to a file
+named tracefile.out:
 
 ~~~
 $ script tracefile.out
@@ -152,27 +145,25 @@ when decoding IPv4 and IPv6 packets.
 
 If you want to turn off name resolution while using Wireshark, start
 Wireshark with the `-n` option to turn off all name resolution (including
-resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
+resolution of MAC addresses and TCP/UDP/SMTP port numbers to names) or
 with the `-N mt` option to turn off name resolution for all
 network-layer addresses (IPv4, IPv6, IPX).
 
 You can make that the default setting by opening the Preferences dialog
-box using the Preferences item in the Edit menu, selecting "Name
-resolution", turning off the appropriate name resolution options,
-clicking "Save", and clicking "OK".
+using the Preferences item in the Edit menu, selecting "Name resolution",
+turning off the appropriate name resolution options, and clicking "OK".
 
 
 SNMP
 ----
 
 Wireshark can do some basic decoding of SNMP packets; it can also use
-the libsmi library to do more sophisticated decoding, by reading MIB
+the libsmi library to do more sophisticated decoding by reading MIB
 files and using the information in those files to display OIDs and
-variable binding values in a friendlier fashion.  The configure script
-will automatically determine whether you have the libsmi library on
-your system.  If you have the libsmi library but _do not_ want to have
-Wireshark use it, you can run configure with the `--without-libsmi`
-option.
+variable binding values in a friendlier fashion.  CMake  will automatically
+determine whether you have the libsmi library on your system.  If you
+have the libsmi library but _do not_ want Wireshark to use it, you can run
+cmake with the `-DENABLE_SMI=OFF` option.
 
 How to Report a Bug
 -------------------