Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
0mp opened this issue Mar 1, 2022 · 4 comments
Open

Comments

@0mp
Copy link
Member

0mp commented Mar 1, 2022

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}]
@bapt
Copy link
Member

bapt commented May 27, 2022

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

@igalic
Copy link

igalic commented May 27, 2022

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

@0mp 0mp mentioned this issue Oct 6, 2022
@pauamma
Copy link
Contributor

pauamma commented Oct 9, 2022

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.

@ghost
Copy link

ghost commented Sep 21, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants