search

redacted / XKCD-password-generator

Generate secure multiword passwords/passphrases, inspired by XKCD
BSD 3-Clause "New" or "Revised" License
1.32k stars 185 forks source link

Man page not rendering properly #134

Closed benkohler closed 2 years ago

benkohler commented 3 years ago

The man page doesn't render properly here, I'm using man-db. Maybe it works on some other man implementations but it seems to be conspicuously missing a .TH line at the top.

If I add ".TH xkcdpass 1" as line 1, then it mostly renders ok. There are still some various quirks, including "Author |authorname| |authoremail|", and what looks like some vim metadata at the end:

^L^H^L Local variables: mode: rst coding: utf-8 time-stamp-format: "%:y-%02m-%02d" time-stamp-start: "^:Date:[ ]+" time-stamp-end: "$" time-stamp-line-limit: 20 End: vim: filetype=rst fileencoding=utf-8 :

benkohler commented 3 years ago

I've added a patch to gentoo for now to clean it up a bit: https://gitweb.gentoo.org/repo/gentoo.git/plain/app-admin/xkcdpass/files/xkcdpass-manpage-fix.patch

redacted commented 3 years ago

Thank you for the patch. I have merged it in the most recent releases - could you confirm that it is working as expected? There is certainly more to be done to bring the manpage into sync with the current README and feature set, but I'd like to check that the code works as is before continuing with changes

benkohler commented 3 years ago

I just bumped gentoo to latest release 1.19.2 and the man page is looking good without any additional patches. Thanks!