[Bug 254617] ipfw man page synopsis misses nat show form

[bugzilla-noreply at freebsd.org]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=254617

            Bug ID: 254617
           Summary: ipfw man page synopsis misses nat show form
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Many People
          Priority: ---
         Component: Manual Pages
          Assignee: bugs at FreeBSD.org
          Reporter: okiddle at yahoo.co.uk
                CC: doc at FreeBSD.org

Created attachment 223653
  --> https://bugs.freebsd.org/bugzilla/attachment.cgi?id=223653&action=edit
corrections to ipfw.8 man page

Found initially by guessing but confirmed with the source code, it is possible
to do, e.g. "ipfw nat 1 show config" to examine the nat configuration. This is
missing from the man page. I've attached a patch that adds "ipfw nat number
show {config | log}" to the IN-KERNEL NAT subsection of SYNOPSIS.

Furthermore, under RULE ACTIONS, the nat entry could list the "global" special
value which is documented in the later NAT section that this references. Where
it is documented, it could be clearer that these are used in rule actions and
not amongst the config options that are documented immediately before.
"specials value" doesn't really make sense because "specials" is a plural noun
and only "special" is an adjective – "special values" is better. A little
further on, "examples about" should be "examples of". The attached patch also
deals with these.

-- 
You are receiving this mail because:
You are on the CC list for the bug.