Bug 695656

Summary:	manpages in mdoc(7)
Product:	MuPDF	Reporter:	hans
Component:	mupdf	Assignee:	MuPDF bugs <mupdf-bugs>
Status:	RESOLVED WONTFIX
Severity:	enhancement	CC:	tor.andersson
Priority:	P4
Version:	master
Hardware:	All
OS:	All
Customer:		Word Size:	---
Attachments:	a rewrite of mupdf(1) into the mdoc(7) markup. a rewrite of mudraw(1) into the mdoc(7) markup. a rewrite of mutool(1) into the mdoc(7) markup. a revised rewrite of mupdf(1) into the mdoc(7) markup. a rewrite of mupdf.1 in the mdoc(7) format

Description hans 2014-11-01 01:20:03 UTC

Created attachment 11296 [details]
a rewrite of mupdf(1) into the mdoc(7) markup.

Currently, the manpages of mupdf(1), mudraw(1) and mutool(1)
are written in the man(7) language. Attached please see a proposed rewrite
of the mupdf(1) manpage into the _semantic_ mdoc(7) language. 

Using mdoc(7) has the advantage of expressing things like
"this is a command line argument", as opposed to the physical markup
like "put this in bold" in man(7). See http://mdocml.bsd.lv/
for an elaborate discussion of why this is a good thing.

Both the man(7) and mdoc(7) languages are well supported
by groff (mostly linuxes) and mandoc (BSDs).

If there is interest in this, please let me know.
I also have mudraw(1) and mutool(1) in the works.

Sincerely,
your happy MuPDF user,

Jan

Comment 1 hans 2014-11-02 01:01:33 UTC

Attached please see also mutool.1 and mudraw.1,
and a revised version of mupdf.1

Rewriting the markup, I tried to minimize changes to
the actual content. However, while there:

- fixed some obvious typos and punctuation mistakes.
- reordered commandline option alphabetically,
- rewrote the SYNOPSIS to actually name the options
  (instead of saying [options])

A separate issue I think is the AUTHORS section.
This section is supposed to name the authors,
and possible spell their emails, not state copyright.
The software comes with a license - isn't that a better place?
Also, is it on purpose that the actual authors are not named?

Needless to say, these comments are only relevant
if there is even an interest in accepting the rewrite.

Comment 2 hans 2014-11-02 01:02:35 UTC

Created attachment 11300 [details]
a rewrite of mudraw(1) into the mdoc(7) markup.

Comment 3 hans 2014-11-02 01:03:03 UTC

Created attachment 11301 [details]
a rewrite of mutool(1) into the mdoc(7) markup.

Comment 4 hans 2014-11-02 01:03:57 UTC

Created attachment 11302 [details]
a revised rewrite of mupdf(1) into the mdoc(7) markup.

Comment 5 hans 2016-10-05 01:01:31 UTC

Now that mudraw has been incorporated into mutool,
this needs to be rewritten. See the new attached mupdf(1)
as an example of what I am proposing.

Is there any interest in this?

Comment 6 hans 2016-10-05 01:02:36 UTC

Created attachment 12992 [details]
a rewrite of mupdf.1 in the mdoc(7) format