From d9c13fab517557fd0f4c1f824db0a5e2218c96b1 Mon Sep 17 00:00:00 2001 From: Jeff Morriss Date: Wed, 27 May 2015 10:40:38 -0400 Subject: Document the subnets file in the man pages. Text adapted from that in the WSUG documentation of the same. Ping-Bug: 1445 Ping-Bug: 11227 Change-Id: I4d07cba437e70324d19c5ae23e44b86c47b749a8 Reviewed-on: https://code.wireshark.org/review/8662 Reviewed-by: Anders Broman --- doc/rawshark.pod | 20 ++++++++++++++++++++ doc/tshark.pod | 20 ++++++++++++++++++++ doc/wireshark.pod.template | 20 ++++++++++++++++++++ 3 files changed, 60 insertions(+) diff --git a/doc/rawshark.pod b/doc/rawshark.pod index 8a8a5083a7..0bf43b5edb 100644 --- a/doc/rawshark.pod +++ b/doc/rawshark.pod @@ -337,6 +337,26 @@ Capture filter name resolution is handled by libpcap on UNIX-compatible systems and WinPcap on Windows. As such the Wireshark personal F file will not be consulted for capture filter name resolution. +=item Name Resolution (subnets) + +If the an IPv4 address cannot be translated via name resolution (no exact +match is found) then a partial match is attempted via the F file. + +Each line of this file consists of an IPv4 address, a subnet mask length +separated only by a / and a name separated by whitespace. While the address +must be a full IPv4 address, any values beyond the mask length are subsequently +ignored. + +An example is: + +# Comments must be prepended by the # sign! +192.168.0.0/24 ws_test_network + +A partially matched name will be printed as "subnet-name.remaining-address". +For example, "192.168.0.1" under the subnet above would be printed as +"ws_test_network.1"; if the mask length above had been 16 rather than 24, the +printed address would be ``ws_test_network.0.1". + =item Name Resolution (ethers) The F files are consulted to correlate 6-byte hardware addresses to diff --git a/doc/tshark.pod b/doc/tshark.pod index f93e8b4576..baa8a468eb 100644 --- a/doc/tshark.pod +++ b/doc/tshark.pod @@ -1606,6 +1606,26 @@ Capture filter name resolution is handled by libpcap on UNIX-compatible systems and WinPcap on Windows. As such the Wireshark personal F file will not be consulted for capture filter name resolution. +=item Name Resolution (subnets) + +If the an IPv4 address cannot be translated via name resolution (no exact +match is found) then a partial match is attempted via the F file. + +Each line of this file consists of an IPv4 address, a subnet mask length +separated only by a / and a name separated by whitespace. While the address +must be a full IPv4 address, any values beyond the mask length are subsequently +ignored. + +An example is: + +# Comments must be prepended by the # sign! +192.168.0.0/24 ws_test_network + +A partially matched name will be printed as "subnet-name.remaining-address". +For example, "192.168.0.1" under the subnet above would be printed as +"ws_test_network.1"; if the mask length above had been 16 rather than 24, the +printed address would be ``ws_test_network.0.1". + =item Name Resolution (ethers) The F files are consulted to correlate 6-byte hardware addresses to diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template index f4ec17f38d..d6493e51d7 100644 --- a/doc/wireshark.pod.template +++ b/doc/wireshark.pod.template @@ -2581,6 +2581,26 @@ Capture filter name resolution is handled by libpcap on UNIX-compatible systems and WinPcap on Windows. As such the Wireshark personal F file will not be consulted for capture filter name resolution. +=item Name Resolution (subnets) + +If the an IPv4 address cannot be translated via name resolution (no exact +match is found) then a partial match is attempted via the F file. + +Each line of this file consists of an IPv4 address, a subnet mask length +separated only by a / and a name separated by whitespace. While the address +must be a full IPv4 address, any values beyond the mask length are subsequently +ignored. + +An example is: + +# Comments must be prepended by the # sign! +192.168.0.0/24 ws_test_network + +A partially matched name will be printed as "subnet-name.remaining-address". +For example, "192.168.0.1" under the subnet above would be printed as +"ws_test_network.1"; if the mask length above had been 16 rather than 24, the +printed address would be ``ws_test_network.0.1". + =item Name Resolution (ethers) The F files are consulted to correlate 6-byte hardware addresses to -- cgit v1.2.3