Page MenuHomeFreeBSD

netstat(1): Add EXAMPLES section
ClosedPublic

Authored by fernape on Jun 10 2020, 4:33 PM.

Details

Summary
  • Add small EXAMPLES section
  • Fix warning reported by mandoc (./netstat.1:747:2: WARNING: skipping paragraph macro: Pp before Ss)
Test Plan
  • mandoc -Tlint clean
  • aspell happy
  • man ./netstat.1 renders the page properly

Diff Detail

Repository
rS FreeBSD src repository
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 31632
Build 29213: arc lint + arc unit

Event Timeline

A fix and another example to add.

netstat/netstat.1
806

s/icmp/ICMP/

813

Good one, I'd add an example for "netstat -rn" (it also works on Windows). It can be a short description like: "Same as above, but without resolving numeric addresses and port numbers to names:"

allanjude added inline comments.
netstat/netstat.1
800

Might be better to state "what" information. There are so many different modes in netstat, it would be better to be more specific

  • Add -nr example (bcr@)
  • Use upper case letters for protocol names (bcr@)
  • Explicit the information shown in first example (allanjude@)
fernape added inline comments.
netstat/netstat.1
800

Thanks Allan. I hope this is explicit enough despite the fact that it is not an exhaustive list (I omitted the information is for input as well as for output for being obvious, for example).

How does this look?

gbe added a subscriber: gbe.

I verified the examples and in general, LGTM.

This revision is now accepted and ready to land.Jul 12 2020, 9:02 AM
This revision was automatically updated to reflect the committed changes.
In D25212#567173, @gbe wrote:

I verified the examples and in general, LGTM.

Thanks for reviewing this!