NAME
pdldoc - shell interface to PDL documentation
SYNOPSIS
pdldoc <text>
!NO!SUBS!
if ( $bvalflag ) {
print $fh <<'!NO!SUBS!';
B<pdldoc> [B<-a>] [B<-b>] [B<-h>] [B<-s>] [B<-u>] <text>
!NO!SUBS!
} else {
print $fh <<'!NO!SUBS!';
B<pdldoc> [B<-a>] [B<-h>] [B<-s>] [B<-u>] <text>
!NO!SUBS!
}
print $fh <<'!NO!SUBS!';
DESCRIPTION
The aim of pdldoc is to provide the same functionality as the apropos
, help
, sig
, !NO!SUBS!
print $fh "C<badinfo>, \n" if $bvalflag;
print $fh <<'!NO!SUBS!'; and usage
commands available in the perldl shell.
Think of it as the PDL equivalent of perldoc -f
.
OPTIONS
- -h help
-
print documentation about a PDL function or module or show a PDL manual. This is the default option.
- -a apropos
-
Regex search PDL documentation database.
!NO!SUBS!
print $fh <<'!NO!SUBS!' if $bvalflag; =item -b badinfo
Information on the support for bad values provided by the function.
!NO!SUBS!
print $fh <<'!NO!SUBS!'; =item -s sig
prints signature of PDL function.
- -u usage
-
Prints usage information for a PDL function.
VERSION
This is pdldoc v0.2.
AUTHOR
Doug Burke <burke@ifa.hawaii.edu>.