Rewrite manpage with mdoc(7)

rrthomas / mmv

Other

52 stars 7 forks source link

Rewrite manpage with mdoc(7) #6

Open Artoria2e5 opened 3 years ago

Artoria2e5 commented 3 years ago

mdoc is a different, not quite new, macro package for writing manual pages. Its main point is to write in a more semantic way that serves search systems and HTML output better.

Among other things, mdoc(7) has you:

use macros instead of manual indents in code samples
use specialized macros for referring to other man pages (turns into hyperlink in PDF/HTML)

(The table should be rewritten with tbl(7) anyways, man or mdoc.)

rrthomas commented 3 years ago

I would be happy to get a pull request for that.

xtaran commented 3 years ago

Speaking with my mmv Debian package maintainer hat on: Not happy. mdoc seems neither very common nor is it packaged for Debian. :-/

Additionally I can't find that system with searching for "mdoc" in the internet.

rrthomas commented 3 years ago

@xtaran, I thought there are plenty of mdoc pages in Debian already; in any case, it's included in groff.

xtaran commented 3 years ago

Ah, ok, I thought it was a separate package. Also I did not find a single file in Debian with mdoc als file name base. I now see that the actual file name for the man page is groff_mdoc which is not matched by my search \bmdoc\b as underscore counts as word-character.

rrthomas commented 3 years ago

Yes, I think this is a remnant of the BSD/System V split which was swept under the carpet many years ago!

xtaran commented 3 years ago

Anyway, if it's part of groff, there's no objection anymore from my side. :-)