In message <20190628202903.j1...@besplex.bde.org>, Bruce Evans writes:
> On Fri, 28 Jun 2019, Cy Schubert wrote:
>
> > Log:
> > Document the -B, binary logfile, and the -C config file options.
> > Reference the ipmon.5 man page and ipmon.conf.
> >
> > PR:238816
> > MFC after: 1 week
> >
> > Modified:
> > head/contrib/ipfilter/man/ipmon.8
> >
> > Modified: head/contrib/ipfilter/man/ipmon.8
> > ===
> ===
> > --- head/contrib/ipfilter/man/ipmon.8 Fri Jun 28 04:18:10 2019
> (r349502)
> > +++ head/contrib/ipfilter/man/ipmon.8 Fri Jun 28 04:28:32 2019
> (r349503)
> > @@ -7,6 +7,10 @@ ipmon \- monitors /dev/ipl for logged packets
> > [
> > .B \-abBDFhnpstvxX
>
> -B was misdocumented as a flag here, and still is.
>
> > ] [
> > +.B "\-B "
> > +] [
>
> This file isn't written in mdoc. This gives errors starting with
> misformatting the SYNOPIS. The most obvious ones are:
> - split lines are not properly indented
> - splitting is done in bad places (after '[' for [ ]
> - unusual quoting. mdoc would not put angle brackets and spaces around
>'filename. These brackets and spaces seem to be mostly hard-coded
>using .B and literals.
> - bad rendering or for square brackets around NSI. These square brackets
>mean optional options as usual, but are not rendered normally. The .B
>macro apparently gives normal rendering for outer square brackets, but
>the inner square brackets around NSI use the same rendering as the letters
> .
> - various misorderings: -N before -L, -f after -[NLoOPS; NSI randomly
>ordered.
>
> The recent fixes to the usage message have the correct order for [-NLf],
> and different misformatting for split lines, so are hard to compare with
> the man page.
>
> This commit makes the usage message out of date again.
Agreed, the ipfilter man pages should be rewritten into mandoc and
synced with usage(). I considered doing that but as PR grew and no one
suggested it, rewriting the man page is out of scope for the PR. It is
something I considered but best left for after more important bugs are
fixed. So yes, these issues are in my queue.
--
Cheers,
Cy Schubert
FreeBSD UNIX: Web: http://www.FreeBSD.org
The need of the many outweighs the greed of the few.
>
> Bruce
___
svn-src-head@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-head
To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
