pkg icon indicating copy to clipboard operation
pkg copied to clipboard

Proposal for removal of long options from synopsis sections in the manual pages

Open 0mp opened this issue 3 years ago • 6 comments

Hey,

I was wondering, do we actually need to have long options described in the synopsis sections in the manual pages? They add a lot of noise and aren't very readable. E.g.:

 pkg install [--{automatic,force,no-scripts,ignore-missing}]

0mp avatar Mar 01 '22 11:03 0mp

I have no opinion there, but people seems to want the long option documented so I don't know

bapt avatar May 27 '22 08:05 bapt

having them documented is a must putting them in the synopsis is questionable.

igalic avatar May 27 '22 14:05 igalic

So what's the consensus? Remove long options from the synopsis, leaving only the short options there, but keep both in the description? Asking so I have a clear notion of how to revise my pkg-set(8) patch in #2076 and proceed with the rest of the manual pages.

pauamma avatar Oct 09 '22 02:10 pauamma

I would really love to see long options removed from synopsis.

ghost avatar Sep 21 '23 20:09 ghost