Network Tools tcpdump and dig Get Crucial Man Page Updates with Beginner-Friendly Examples

Latest Updates

Major updates to the official man pages for two widely used network diagnostic tools, tcpdump and dig, have been released, adding comprehensive example sections aimed at beginners and infrequent users.

The updates were spearheaded by a developer who noted that many users find traditional man pages difficult to navigate. “The goal was to give the absolute most basic examples for people who use these tools infrequently or have never used them before,” the developer explained. “It’s been working really well, and maintainers seem to find it compelling.”

The new examples cover common commands and flags, such as saving packets with tcpdump -w out.pcap. A key insight from the revision: the developer discovered that adding the -v flag when saving to a file prints a live summary of packets captured, a feature not widely known. “That’s really useful and I never would have noticed it on my own,” they added.

Background

Man pages have long been the primary documentation for Unix-like systems, but their dense format often drives users to blogs or Stack Overflow. The project to enhance the tcpdump and dig man pages began after a prior blog post highlighted the value of examples. “Man pages can actually have close to 100% accurate information,” the developer said, stressing the importance of official documentation.

To avoid the complexity of writing in the roff language native to man pages, the developer created a custom script to convert Markdown to roff. “The roff language is kind of hard to use, and I really did not feel like learning it,” they noted. The approach echoes the success of the Django documentation, which the developer praised for its clarity and correctness.

Contributors to the updates include Denis Ovsienko, Guy Harris, and Ondřej Surý, who provided review and feedback. “It was a good experience and left me motivated to do more work on man pages,” the developer said.

What This Means

For network administrators, security analysts, and developers, the improved man pages lower the barrier to effective use of these critical tools. “Even with basic questions like ‘what are the most commonly used tcpdump flags?’, maintainers are aware of useful features that I’m not,” the developer observed. This update ensures that official documentation can rival the best blog posts in readability, while retaining the advantage of authoritative accuracy.

The community behind tcpdump.org and isc.org (maintainer of dig) will likely see fewer misconfigurations and faster troubleshooting. As the developer put it, “Maybe the documentation doesn’t have to be bad? Maybe it could be just as good as reading a really great blog post, but with the benefit of also being actually correct.”

Users can view the updated dig man page here and the tcpdump man page here.