Re: [MacPerl] Q: documentation how to

[John Mignault <mignault@nytimes.com>]

On 10/14/98 at 5:44 AM, Xah Lee <xah@best.com> shipped these bits:
>In unix, one can do "perldoc -f xxx" to get the docs for xxx.
>Similarly, with cmd-l in Shuck on the mac.
>
>I'm writing a module with docs embeded. What is the standard practice
>so that users can also do -f or cmd-l to lookup my functions?
>
They won't be able to use perldoc -f to look up your functions. From perldoc help:

[ jbm@jbm ~ 513 ] $ perldoc -h
perldoc [options] PageName|ModuleName|ProgramName...
perldoc [options] -f BuiltinFunction
                  ^^^^^^^^^^^^^^^^^^^   
perldoc [options] -q FAQRegex

<less relevant info snipped>

BuiltinFunction
         is the name of a perl function.  Will extract documentation from
         `perlfunc'.

As far as I can tell, Shuck seems to work under the same limitations; at least it wouldn't find docs for stuff I had installed in my site_lib directory.

j

>Web resource pointers welcome. Thanks.
>
> Xah, xah@best.com
> http://www.best.com/~xah/PageTwo_dir/more.html
> >They fight! They bite! They fight and bite and fight!
> >Fight fight fight! Bite bite bite!
> >The Itchy and Scratchy Show!
--
#!/usr/bin/perl
$dot="\x2e";$lt="\x3c";$gt="\x3e";$at="\x40";
print "J Mignault ${lt}mignault${at}nytimes${dot}com${gt}\n";
$yow = qq(What's the MATTER Sid?.. Is your BEVERAGE unsatisfactory?);



***** Want to unsubscribe from this list?
***** Send mail with body "unsubscribe" to mac-perl-request@iis.ee.ethz.ch