CODEWITHSUNDEEP
macosbashunixmanpage
Léo Léopold Hertz 준영
Léo Léopold Hertz 준영

Reputation: 141120

Providing Documentation for an Unix command?

I made an Unix command called macmac2unix, which converts a Word file from Mac to Unix.

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

$man macmac2unix

Upvotes: 3

Views: 271

Answers (2)

Léo Léopold Hertz 준영
Léo Léopold Hertz 준영

Reputation: 141120

You can apparently use also DocBook to provide Documentation for an Unix command.

Upvotes: 0

Dave Dribin
Dave Dribin

Reputation: 5662

I recommend Perl's POD format. Despite the name, you can use it outside of Perl scripts, and the pod2man command ships with OS X. It's a lot more sensible that troff. Reminds me of Markdown.

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

Upvotes: 3

Related Questions