PDLA::Doc::Perldl - commands for accessing PDLA doc database from 'perldla' shell
This module provides a simple set of functions to access the PDLA documentation of database, for use from the perldla or pdla2 shells as well as the pdladoc command-line program.
Autoload files are also matched, via a search of the PDLALIB autoloader tree. That behavior can be switched off with the variable $PERLDL::STRICT_DOCS (true: don't search autoload tree; false: search the autoload tree.)
$PERLDL::STRICT_DOCS
Currently, multiple matches are not handled very well.
use PDLA::Doc::Perldl; # Load all documentation functions
The description contains the misleading word "simple".
Regex search PDLA documentation database
apropos 'text'
pdla> apropos 'pic' rpic Read images in many formats with automatic format detection. rpiccan Test which image formats can be read/written wmpeg Write an image sequence ((x,y,n) piddle) as an MPEG animation. wpic Write images in many formats with automatic format selection. wpiccan Test which image formats can be read/written
To find all the manuals that come with PDLA, try
apropos 'manual:'
and to get quick info about PDLA modules say
apropos 'module:'
You get more detailed info about a PDLA function/module/manual with the help function
help
Internal routine to search docs database and autoload files
Internal interface to the PDLA documentation searcher
Internal helper routine that finds and returns documentation in the autoloader path, if it exists. You feed in a topic and it searches for the file "${topic}.pdl". If that exists, then the filename gets returned in a match structure appropriate for the rest of finddoc.
Prints usage information for a PDLA function
Usage: usage 'func'
pdla> usage 'inner' inner inner prodcuct over one dimension (Module PDLA::Primitive) Signature: inner(a(n); b(n); [o]c(); )
prints signature of PDLA function
sig 'func'
The signature is the normal dimensionality of the function's arguments. Calling with different dimensions doesn't break -- it causes threading. See PDLA::PP for details.
pdla> sig 'outer' Signature: outer(a(n); b(m); [o]c(n,m); )
Describe a perl and/or PDLA variable or expression. Useful for determining the type of an expression, identifying the keys in a hash or a data structure, or examining WTF an unknown object is.
Usage: whatis $var whatis <expression>
print documentation about a PDLA function or module or show a PDLA manual
In the case of multiple matches, the first command found is printed out, and the remaining commands listed, along with the names of their modules.
Usage: help 'func'
pdla> help 'PDLA::Tutorials' # show the guide to PDLA tutorials pdla> help 'PDLA::Slices' # show the docs in the PDLA::Slices module pdla> help 'slice' # show docs on the 'slice' function
provides information on the bad-value support of a function
And has a horrible name.
badinfo 'func'
To install PDLA::Core, copy and paste the appropriate command in to your terminal.
cpanm
cpanm PDLA::Core
CPAN shell
perl -MCPAN -e shell install PDLA::Core
For more information on module installation, please visit the detailed CPAN module installation guide.