chicken-hackers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Chicken-hackers] Using mandoc for chicken manual pages?


From: Timo Myyrä
Subject: [Chicken-hackers] Using mandoc for chicken manual pages?
Date: Tue, 19 Jul 2016 10:53:07 +0300

Hi,

Chicken manuals are currently little sparse and use older man(7) format.
Would it make sense to update the manual pages and switch to using mdoc(7)
format in them? Mdoc(7) format is easier to work on and the manual pages need
attention in any case. Currently they just recommend to run the command with
`-h' flag to get the information.

On chickens user side this wouldn't cause anything new, better manuals I hope. I
think most platforms can view mdoc(7) pages just fine.

On build side it would make mandoc a build dependency. It would also require a
check in build scripts so that platforms which are not able to view mdoc(7)
files would be able to generate man(7) formatted manuals out of the mdoc(7)
using mandoc command.

What do you think?

Timo

-- 
Shut up and hack!



reply via email to

[Prev in Thread] Current Thread [Next in Thread]