Re: man page, usage text and filter expression formatting

[Francois via tcpdump-workers <tcpdump-workers () lists tcpdump org>]

> --- Begin Message ---
>
>
> From: Francois <devel.fx.lebail () orange fr>
>
> Date: Sun, 26 Oct 2025 11:45:17 +0100
>
> On 24/10/2025 00:44, Denis Ovsienko wrote:
> > On Mon, 20 Oct 2025 15:30:01 -0700
> > Guy Harris <gharris () sonic net> wrote:
> >
> > > So, not surprisingly, no consistency, given that commands come from
> > > various projects.
> >
> > Here is a couple more examples:
> >
> > Linux iproute2 uses mostly uppercase for usage message, and the man
> > pages, the man pages use mostly uppercase and a mix of italic and
> > <arg>, the HTML/PDF command reference looks no longer maintained, but
> > its version from 1999 uses just uppercase where it certainly could have
> > used italic.
> >
> > Perl uses italic for its command-line options in the man pages and the
> > online manual, and plain lowercase in the usage message.  However, the
> > language-specific man pages use plain uppercase in all formats, for
> > example, perlfunc(1) says:
> >
> >        chdir EXPR
> >        chdir FILEHANDLE
> >        chdir DIRHANDLE
> >        chdir
>
> Some more search in many Linux man pages about angle-bracket convention:
>
> $ man -K '<.*>'|grep '<.*>'
> Shows:
> 1) Very few <argument> use.
> 2) Some '<' '>' pairs not used as placeholder:
>   a) To show symbols as in: <CR>, <LF>, <CR><LF>.
>   b) literally as: #include <xxx.h>, <user () example com>.
> Thus ambiguity.
>
> --- End Message ---
_______________________________________________
tcpdump-workers mailing list -- tcpdump-workers () lists tcpdump org
To unsubscribe send an email to tcpdump-workers-leave () lists tcpdump org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s