.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PDLDOC 1p"
.TH PDLDOC 1p 2024-02-05 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
pdldoc \- shell interface to PDL documentation
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpdldoc\fR <text>
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The aim of \fBpdldoc\fR is to provide the same functionality
as the \f(CW\*(C`apropos\*(C'\fR, \f(CW\*(C`help\*(C'\fR, \f(CW\*(C`sig\*(C'\fR, \f(CW\*(C`badinfo\*(C'\fR,
and \f(CW\*(C`usage\*(C'\fR commands available in the perldl
and pdl2 shells.
.PP
Think of it as the PDL equivalent of \f(CW\*(C`perldoc \-f\*(C'\fR.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-h\fR help" 5
.IX Item "-h help"
print documentation about a PDL function or module or show a PDL manual.
This is the default option.
.IP "\fB\-a\fR apropos" 5
.IX Item "-a apropos"
Regex search PDL documentation database.
.IP "\fB\-b\fR badinfo" 5
.IX Item "-b badinfo"
Information on the support for bad values provided by the function.
.IP "\fB\-s\fR sig" 5
.IX Item "-s sig"
prints signature of PDL function.
.IP "\fB\-u\fR usage" 5
.IX Item "-u usage"
Prints usage information for a PDL function.
.ie n .IP $PDL::Config{PDLDOC_IGNORE_AUTOLOADER} 5
.el .IP \f(CW$PDL::Config{PDLDOC_IGNORE_AUTOLOADER}\fR 5
.IX Item "$PDL::Config{PDLDOC_IGNORE_AUTOLOADER}"
This PDL configuration variable may be set in the perldl.conf
file to disable runtime search for documentation in
PDL::AutoLoader files.
.SH VERSION
.IX Header "VERSION"
This is pdldoc version 0.3.
.SH AUTHOR
.IX Header "AUTHOR"
Doug Burke <burke at ifa dot hawaii dot edu>.
Chris Marshall <chm at cpan dot org>.