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

troff man pages show wrong dash style for options #746

Closed
reox opened this issue Nov 19, 2018 · 3 comments · Fixed by #747
Closed

troff man pages show wrong dash style for options #746

reox opened this issue Nov 19, 2018 · 3 comments · Fixed by #747

Comments

@reox
Copy link

reox commented Nov 19, 2018

Some options in the man pages of st-info and partially st-util use a single dash instead of a double dash.
For example, st-info has the option --probe (shown in the examples section
correctly), but the man pages says -probe.
When using st-info -probe, the tool just exists with a status code of 0.
The man page of st-util contains in the description hints to the options
-listen_port and -stlinkv1 which seems to be also replaced by the double
dash variants.

The options are correctly written in the markdown files, but it seems that pandoc does this automatically. I'm no expert at pandoc but it seems it is this package causing it: https://pandoc.org/MANUAL.html#typography

See also Debian bug report: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=914103

@xor-gate
Copy link
Member

Hi @reox,

I have looked into the generation and seems we did not as pandoc expectation. Could you have a look?

screenshot 2018-11-19 at 19 10 02

There is only a very small issue left where something is not bold.

Let me know.

Kind regards,
Jerry

@reox
Copy link
Author

reox commented Nov 19, 2018

@xor-gate yep, that looks good! thank you!

@xor-gate
Copy link
Member

Fixed in latest master now! Thanks for reporting.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.