Re: man page, usage text and filter expression formatting

[Vadim Goncharov <vadimnuclight () gmail com>]

On Sat, 18 Oct 2025 15:02:28 -0400
Michael Richardson <mcr () sandelman ca> wrote:

> Denis Ovsienko <denis () ovsienko info> wrote:
>     > One way to solve this problem would be using "keyword <arg>" or
>     > "keyword ARG" or even "keyword <ARG>" syntax for all filter primitives.
>     > Note that this would not conflict with the use of italics: for example,
>     > if you consider GNU tar man page, both the "ARCHIVE", the "OPTIONS" and
>     > the "FILE" are in italics (that is, underlined in most cases, unless
>     > the session is cleverly configured to use the capabilities of modern
>     > terminals):  
>
> I'm for:
>     keyword <arg>
>
> with <arg> being italic/underline when it can me as the consistent format.
> I wonder if any of these conventions have names.
> (Like how we have snake_case, and CamelCase)

Probably no, except may be "Tcl-style" (for ?optional? in quiestion marks
instead brackets), though that's not official style, just easy reference.

> I'm okay with: "keyword ARG" (like GNU tar), but I think "keyword <ARG>"
> (which could also be italic) is too much.

+1

-- 
WBR, @nuclight
_______________________________________________
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