1Doc::Perldl(3)        User Contributed Perl Documentation       Doc::Perldl(3)
2
3
4

NAME

6       PDL::Doc::Perldl - commands for accessing PDL doc database from
7       'perldl' shell
8

DESCRIPTION

10       This module provides a simple set of functions to access the PDL docu‐
11       mentation of database, for use from the perldl shell and the pdldoc
12       command-line program.
13
14       Autoload files are also matched, via a search of the PDLLIB autoloader
15       tree.  That behavior can be switched off with the variable
16       $PERLDL::STRICT_DOCS (true: don't search autoload tree; false: search
17       the autoload tree.)
18
19       Currently, multiple matches are not handled very well.
20

SYNOPSIS

22        use PDL::Doc::Perldl; # Load all documenation functions
23

BUGS

25       The description contains the misleading word "simple".
26

FUNCTIONS

28       apropos
29
30       Regex search PDL documentation database
31
32        apropos 'text'
33
34        perldl> apropos 'pic'
35        rpic            Read images in many formats with automatic format detection.
36        rpiccan         Test which image formats can be read/written
37        wmpeg           Write an image sequence ((x,y,n) piddle) as an MPEG animation.
38        wpic            Write images in many formats with automatic format selection.
39        wpiccan         Test which image formats can be read/written
40
41       To find all the manuals that come with PDL, try
42
43         apropos 'manual:'
44
45       and to get quick info about PDL modules say
46
47         apropos 'module:'
48
49       You get more detailed info about a PDL function/module/manual with the
50       "help" function
51
52       PDL::Doc::Perldl::search_docs
53
54       Internal routine to search docs database and autoload files
55
56       PDL::Doc::Perldl::finddoc
57
58       Internal interface to the PDL documentation searcher
59
60       find_autodoc
61
62       Internal helper routine that finds and returns documentation in the
63       autoloader path, if it exists.  You feed in a topic and it searches for
64       the file "${topic}.pdl".  If that exists, then the filename gets
65       returned in a match structure appropriate for the rest of finddoc.
66
67       usage
68
69       Prints usage information for a PDL function
70
71        Usage: usage 'func'
72
73          perldl> usage 'inner'
74
75          inner           inner prodcuct over one dimension
76                          (Module PDL::Primitive)
77
78          Signature: inner(a(n); b(n); [o]c(); )
79
80       sig
81
82       prints signature of PDL function
83
84        sig 'func'
85
86       The signature is the normal dimensionality of the function's arguments.
87       Calling with different dimensions doesn't break -- it causes threading.
88       See PDL::PP for details.
89
90         perldl> sig 'outer'
91           Signature: outer(a(n); b(m); [o]c(n,m); )
92
93       whatis
94
95       Describe a perl and/or PDL variable or expression.  Useful for deter‐
96       mining the type of an expression, identifying the keys in a hash or a
97       data structure, or examining WTF an unknown object is.
98
99        Usage: whatis $var
100               whatis <expression>
101
102       help
103
104       print documentation about a PDL function or module or show a PDL manual
105
106       In the case of multiple matches, the first command found is printed
107       out, and the remaining commands listed, along with the names of their
108       modules.
109
110        Usage: help 'func'
111
112        perldl> help 'PDL::Slices'   # show the docs in the PDL::Slices module
113        perldl> help 'PDL::Intro'    # show the PDL::Intro manual
114        perldl> help 'slice'         # show docs on the 'slice' function
115
116       badinfo
117
118       provides information on the bad-value support of a function
119
120       And has a horrible name.
121
122        badinfo 'func'
123
124
125
126perl v5.8.8                       2003-09-15                    Doc::Perldl(3)