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 set of functions to access the PDL documentation
11       database, for use from the perldl or pdl2 shells as well as 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       In the interest of brevity, functions that print module names (at the
20       moment just "apropos" and "usage") use some shorthand notation for
21       module names.  Currently-implemented shorthands are
22
23       •  P:: (short for PDL::)
24
25       •  P::G:: (short for PDL::Graphics::)
26
27       To turn this feature off, set the variable $PERLDL::long_mod_names to a
28       true value.  The feature is assumed to be on for the purposes of this
29       documentation.
30

SYNOPSIS

32        use PDL::Doc::Perldl; # Load all documentation functions
33

FUNCTIONS

35   apropos
36       Regex search PDL documentation database
37
38        apropos 'text'
39
40        pdl> apropos 'pic'
41        PDL::IO::Pic    P::IO::Pic  Module: image I/O for PDL
42        grabpic3d       P::G::TriD  Grab a 3D image from the screen.
43        rim             P::IO::Pic  Read images in most formats, with improved RGB handling.
44        rpic            P::IO::Pic  Read images in many formats with automatic format detection.
45        rpiccan         P::IO::Pic  Test which image formats can be read/written
46        wim             P::IO::Pic  Write a pdl to an image file with selected type (or using filename extensions)
47        wmpeg           P::IO::Pic  Write an image sequence (a (3,x,y,n) byte pdl) as an animation.
48        wpic            P::IO::Pic  Write images in many formats with automatic format selection.
49        wpiccan         P::IO::Pic  Test which image formats can be read/written
50
51       To find all the manuals that come with PDL, try
52
53         apropos 'manual:'
54
55       and to get quick info about PDL modules say
56
57         apropos 'module:'
58
59       You get more detailed info about a PDL function/module/manual with the
60       "help" function
61
62   PDL::Doc::Perldl::search_docs
63       Internal routine to search docs database and autoload files
64
65   PDL::Doc::Perldl::finddoc
66       Internal interface to the PDL documentation searcher
67
68   find_autodoc
69       Internal routine that finds and returns documentation in the
70       PDL::AutoLoader path, if it exists.
71
72       You feed in a topic and it searches for the file "${topic}.pdl".  If
73       that exists, then the filename gets returned in a match structure
74       appropriate for the rest of finddoc.
75
76   usage
77       Prints usage information for a PDL function
78
79        Usage: usage 'func'
80
81          pdl> usage 'inner'
82
83          inner           P::Primitive  Inner product over one dimension
84
85          Signature: inner(a(n); b(n); [o]c())
86
87   sig
88       prints signature of PDL function
89
90        sig 'func'
91
92       The signature is the normal dimensionality of the function's arguments.
93       Calling with different dimensions doesn't break -- it causes
94       broadcasting.  See PDL::PP and PDL::Broadcasting for details.
95
96         pdl> sig 'outer'
97           Signature: outer(a(n); b(m); [o]c(n,m))
98
99   whatis
100       Describe a perl and/or PDL variable or expression.  Useful for
101       determining the type of an expression, identifying the keys in a hash
102       or a data structure, or examining WTF an unknown object is.
103
104        Usage: whatis $var
105               whatis <expression>
106
107   help
108       print documentation about a PDL function or module or show a PDL manual
109
110       In the case of multiple matches, the first command found is printed
111       out, and the remaining commands listed, along with the names of their
112       modules.
113
114        Usage: help 'func'
115
116        pdl> help 'PDL::Tutorials' # show the guide to PDL tutorials
117        pdl> help 'PDL::Slices'    # show the docs in the PDL::Slices module
118        pdl> help 'slice'          # show docs on the 'slice' function
119
120   badinfo
121       provides information on the bad-value support of a function
122
123       And has a horrible name.
124
125        badinfo 'func'
126
127         pdl> badinfo 'inner'
128         Bad value support for inner (in module PDL::Primitive)
129             If "a() * b()" contains only bad data, "c()" is set bad. Otherwise "c()"
130             will have its bad flag cleared, as it will not contain any bad values.
131
132
133
134perl v5.38.0                      2023-07-21                    Doc::Perldl(3)