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
[download]

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

---

---

• Are you posting in the right place? Check out Where do I post X? to know for sure.
• Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:

  <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>

• Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
• Want more info? How to link or How to display code and escape characters are good places to start.