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

Re: How to write a good manpage ?



On Thu, Aug 17, 2006 at 08:13:32AM -0700, Russ Allbery wrote:
> Just to add one more opinion, I always write new man pages in POD and make
> Perl do the hard work of converting them to *roff for me.  (Of course, I'm
> biased since I maintain Pod::Man.)

I also tend to like the POD syntax for writing manpages.

> It means a build dependency on Perl, but the POD syntax is very simple
> and quick to learn.

Not necessarily, you can store in the package the already built version
of the manpage and document in debian/README.Debian-source what is
needed to re-generate the manpage.

Cheers.

-- 
Stefano Zacchiroli -*- Computer Science PhD student @ Uny Bologna, Italy
zack@{cs.unibo.it,debian.org,bononia.it} -%- http://www.bononia.it/zack/
If there's any real truth it's that the entire multidimensional infinity
of the Universe is almost certainly being run by a bunch of maniacs. -!-

Attachment: signature.asc
Description: Digital signature


Reply to: