fboender / multi-git-status

Show uncommitted, untracked and unpushed changes for multiple Git repos
MIT License
470 stars 73 forks source link

Fix manpage dash #40

Closed lyknode closed 4 years ago

lyknode commented 4 years ago

There are two issues with the dash in the man page.

First of all, in the NAME section, there is a non-ascii dash. This make stricter groff parsers such as lexgrog fail. Simply replacing by the ascii dash fixes the issue.

Secondly, --, used by the options, can have a special meaning in markdown. The issue here is that when building with pandoc 2.~, it will convert it to a non-ascci single dash (--version to -version for instance).

To preserve the correct meaning of the dashes and for it to work with any version of pandoc, -- must be escaped to \--.

See this pandoc issue for more info.

fboender commented 4 years ago

Makes sense. Thanks!