From bba9f5f11b056f2ad8b10463a5030631e88496ea Mon Sep 17 00:00:00 2001 From: Douile Date: Mon, 22 Jan 2024 22:02:34 +0000 Subject: [PATCH] cli: Improve capture help string --- crates/cli/src/main.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/crates/cli/src/main.rs b/crates/cli/src/main.rs index 2bafb77..fc44180 100644 --- a/crates/cli/src/main.rs +++ b/crates/cli/src/main.rs @@ -62,6 +62,13 @@ enum Action { output_mode: OutputMode, /// Optional file path for packet capture file writer + /// + /// When set a PCAP file will be written to the location. This file can + /// be read with a tool like wireshark. The PCAP contains a log of the + /// TCP and UDP data sent/recieved by the gamedig library, it does not + /// contain an accurate representation of the real packets sent on the + /// wire as some information has to be hallucinated in order for it to + /// display nicely. #[cfg(feature = "packet_capture")] #[arg(short, long)] capture: Option,