Bug 254192 - ipfw(8): incorrect nat show log command example
Summary: ipfw(8): incorrect nat show log command example
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Allan Jude
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-03-10 14:43 UTC by Roman Bogorodskiy
Modified: 2021-04-07 15:40 UTC (History)
2 users (show)

See Also:


Attachments
proposed fix (436 bytes, patch)
2021-03-10 14:43 UTC, Roman Bogorodskiy
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Roman Bogorodskiy freebsd_committer 2021-03-10 14:43:00 UTC
Created attachment 223154 [details]
proposed fix

The ipfw(8) manpage has the following text:

     To show logs of all the instances in range 111-999:

           ipfw nat 111-999 show

However, this command is not valid for two reasons:

1. Specifying nat ranges is not supported (apparently was removed by this commit:https://github.com/freebsd/freebsd-src/commit/d6164b77f8b779cd7357387dcfcd3407f1457579)
2. The 'show' command requires an argument: config or log.

So update this example to show logs for all nat instances using this command:

 ipfw nat show log
Comment 1 commit-hook freebsd_committer 2021-04-07 15:40:32 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=066a576c5f1beac1c42370135f6eddf026561430

commit 066a576c5f1beac1c42370135f6eddf026561430
Author:     Roman Bogorodskiy <novel@FreeBSD.org>
AuthorDate: 2021-04-07 15:37:46 +0000
Commit:     Allan Jude <allanjude@FreeBSD.org>
CommitDate: 2021-04-07 15:37:46 +0000

    ipfw: update man page example for nat show log

    In d6164b77f8b779cd7357387dcfcd3407f1457579 the ability to show
    ranges of nat log entries was removed.

    PR:     254192
    Reviewed by:    allanjude

 sbin/ipfw/ipfw.8 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)