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:
Installing /usr/local/share/man/man3/XYZ::ABC.3
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...)
Thanks,
cmac
www.animalhead.com
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.