--- Begin Message ---
https://pubs.opengroup.org/onlinepubs/9799919799.2024edition/basedefs/V1_chap12.html#tag_12_01
is the canonical source for how to write your command synopses in a
man page...
On Sun, Oct 19, 2025 at 9:34 AM Francois via tcpdump-workers
<[email protected]> wrote:
>
>
>
>
> ---------- Forwarded message ----------
> From: Francois <[email protected]>
> To: [email protected]
> Cc:
> Bcc:
> Date: Sun, 19 Oct 2025 15:33:55 +0200
> Subject: [tcpdump-workers] Re: man page, usage text and filter expression
> formatting
> On 17/10/2025 23:14, Denis Ovsienko wrote:
> > One way to solve this problem would be using "keyword <arg>" or
> > "keyword ARG" or even "keyword <ARG>" syntax for all filter primitives.
>
> In pcap-filter.manmisc.in, we have some keywords with optional argument as:
> vlan [vlan_id]
> mpls [label_num]
> pppoes [session_id]
> geneve [vni]
> vxlan [vni]
>
> If we choose <argument>, we will have:
> vlan [<vlan_id>]
> mpls [<label_num>]
> pppoes [<session_id>]
> geneve [<vni>]
> vxlan [<vni>]
>
> If we choose ARGUMENT, we will have:
> vlan [VLAN_ID]
> mpls [LABEL_NUM]
> pppoes [SESSION_ID]
> geneve [VNI]
> vxlan [VNI]
>
> The latter is easier to read, in my opinion, with fewer characters.
>
>
>
>
> ---------- Forwarded message ----------
> From: Francois via tcpdump-workers <[email protected]>
> To: [email protected]
> Cc:
> Bcc:
> Date: Sun, 19 Oct 2025 15:33:55 +0200
> Subject: [tcpdump-workers] Re: man page, usage text and filter expression
> formatting
> _______________________________________________
> tcpdump-workers mailing list -- [email protected]
> To unsubscribe send an email to [email protected]
> %(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
--- End Message ---
_______________________________________________
tcpdump-workers mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
