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
11       documentation of database, for use from the perldl or pdl2 shells as
12       well as the pdldoc 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 documentation functions
23

BUGS

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

FUNCTIONS

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