Skip to content

Commit 31cbdb9

Browse files
committed
update README for 3.0.4
1 parent 31c7004 commit 31cbdb9

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
```
44
55
Usage:
6-
pktvisord [-b BPF] [-p PORT] [-H HOSTSPEC] [--periods P] [--summary] [--geo-city FILE] [--geo-asn FILE] TARGET
6+
pktvisord [-b BPF] [-p PORT] [-H HOSTSPEC] [--periods P] [--summary] [--geo-city FILE] [--geo-asn FILE]
7+
[--max-deep-sample N]
8+
TARGET
79
pktvisord (-h | --help)
810
pktvisord --version
911
@@ -12,18 +14,19 @@
1214
TARGET is either a network interface, an IP address (4 or 6) or a pcap file (ending in .pcap or .cap)
1315
1416
Options:
15-
-p PORT Run metrics webserver on the given localhost port [default: 10853]
16-
-b BPF Filter packets using the given BPF string
17-
--geo-city FILE GeoLite2 City database to use for IP to Geo mapping (if enabled)
18-
--geo-asn FILE GeoLite2 ASN database to use for IP to ASN mapping (if enabled)
19-
--periods P Hold this many 60 second time periods of history in memory [default: 5]
20-
--summary Instead of a time window with P periods, summarize all packets into one bucket for entire time period.
21-
Useful for executive summary of (and applicable only to) a pcap file. [default: false]
22-
-H HOSTSPEC Specify subnets (comma separated) to consider HOST, in CIDR form. In live capture this /may/ be detected automatically
23-
from capture device but /must/ be specified for pcaps. Example: "10.0.1.0/24,10.0.2.1/32,2001:db8::/64"
24-
Specifying this for live capture will append to any automatic detection.
25-
-h --help Show this screen
26-
--version Show version
17+
-p PORT Run metrics webserver on the given localhost port [default: 10853]
18+
-b BPF Filter packets using the given BPF string
19+
--geo-city FILE GeoLite2 City database to use for IP to Geo mapping (if enabled)
20+
--geo-asn FILE GeoLite2 ASN database to use for IP to ASN mapping (if enabled)
21+
--max-deep-sample N Never deep sample more than N% of packets (an int between 0 and 100) [default: 100]
22+
--periods P Hold this many 60 second time periods of history in memory [default: 5]
23+
--summary Instead of a time window with P periods, summarize all packets into one bucket for entire time period.
24+
Useful for executive summary of (and applicable only to) a pcap file. [default: false]
25+
-H HOSTSPEC Specify subnets (comma separated) to consider HOST, in CIDR form. In live capture this /may/ be detected automatically
26+
from capture device but /must/ be specified for pcaps. Example: "10.0.1.0/24,10.0.2.1/32,2001:db8::/64"
27+
Specifying this for live capture will append to any automatic detection.
28+
-h --help Show this screen
29+
--version Show version
2730
2831
```
2932

0 commit comments

Comments
 (0)