|Keep It Simple, Stupid|
docs for CPANby cmac (Monk)
|on Feb 09, 2009 at 02:51 UTC||Need Help??|
cmac has asked for the
wisdom of the Perl Monks concerning the following question:
I have a new module pretty much ready to submit to CPAN, and I'm writing documentation. So far a file called ABC.pod is close to done, and the following questions occur:
1. When I do "sudo make install" on my module, it seems to post a 'man' page:
but a 'man XYZ::ABC' command on my FreeBSD 6.3 doesn't find it. Any ideas what's wrong?
2. ABC.pod has gotten about as big as anyone should want to look at, but there's still more stuff to describe. (Arrays are involved, which makes for lots of methods.) I want to make two subsidiary POD documents, one for the more esoteric methods and one to describe compatibility features with a module that mine replaces.
Q2: are there any guidelines for naming subsidiary .pod files? The L<> description in perlpod is clear enough, but doesn't include much about where/how it will recognize a page.
Q3: can anyone give me a link to a page or pages about the 'man' system? (I admit I haven't Googled for this yet but hopefully y'all are feeling indulgent toward dumb newbies...)