Conversation

Notices

1. Embed this notice
   Ayo (ayo@lonely.town)'s status on Monday, 15-Jan-2024 23:25:19 JST Ayo

   Scanning through a few mdoc-based man pages for inspiration reveals funny inconsistencies in how different projects mention CLI flags in the synopsis. On one side there's the lazy pkg-config approach¹, on the other side there's the fully complete wf-recorder² and in between we have file³, which lists all flags but not their --long-form aliases.

   ¹ https://manned.org/pkg-config.1
   ² https://manned.org/wf-recorder.1
   ³ https://manned.org/file.1

   • Haelwenn /элвэн/ :triskell: likes this.
   • Embed this notice
     Haelwenn /элвэн/ :triskell: (lanodan@queer.hacktivis.me)'s status on Monday, 15-Jan-2024 23:35:09 JST Haelwenn /элвэн/ :triskell:

     in reply to

     @ayo Meanwhile I think the BSD way would be something like ncdu [-012exqrL] [-f file] [-o file] [-X file] [long options …] [path] that said typically BSD tools do not have long options (and definitely don't mention option aliases in the synopsis).

   • Embed this notice
     Ayo (ayo@lonely.town)'s status on Monday, 15-Jan-2024 23:35:14 JST Ayo

     in reply to

     This is what ncdu(1) in full mdoc looks like. Useful for shell autocompletion tools, I suppose, but less so for humans. :blobcatthinking:

   • Embed this notice
     Wolf480pl (wolf480pl@mstdn.io)'s status on Monday, 15-Jan-2024 23:38:14 JST Wolf480pl

     in reply to

     @ayo see also lvs(8) for chaotic evil

     Haelwenn /элвэн/ :triskell: likes this.