Providing documentation for a Unix team?

I made a Unix command called macmac2unix that converts a Word file from Mac to Unix.

How can I provide documentation for my team? I want to read about my team with a man

$man macmac2unix
+3
source share
2 answers

I recommend Perl POD format . Despite the name, you can use it outside of Perl scripts, and the pod2man command comes with OS X. It is much more reasonable that TROFF. Reminds me of Markdown.

Here's an example pod document and a conversion script .

+3
source

DocBook, Unix.

0

Source: https://habr.com/ru/post/1704344/


All Articles