SHA256
1
0
forked from pool/clFFT
clFFT/clFFT-client.1

135 lines
3.1 KiB
Groff

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3.
.TH CLFFT "1" "July 2017" "clFFT client API version: 2.12.2" "User Commands"
.SH NAME
clFFT \- manual page for clFFT client API version: 2.12.2
.SH DESCRIPTION
.SS "clFFT client command line options:"
.TP
\fB\-h\fR [ \fB\-\-help\fR ]
produces this help message
.TP
\fB\-v\fR [ \fB\-\-version\fR ]
Print queryable version information from the
clFFT library
.TP
\fB\-i\fR [ \fB\-\-clinfo\fR ]
Print queryable information of all the OpenCL
runtimes and devices
.TP
\fB\-\-printChosen\fR
Print queryable information of the selected
OpenCL runtime and device
.TP
\fB\-g\fR [ \fB\-\-gpu\fR ]
Force selection of OpenCL GPU devices only
.TP
\fB\-c\fR [ \fB\-\-cpu\fR ]
Force selection of OpenCL CPU devices only
.TP
\fB\-a\fR [ \fB\-\-all\fR ]
Force selection of all OpenCL devices (default)
.TP
\fB\-\-platform\fR arg (=0)
Select a specific OpenCL platform id as it is
reported by clinfo
.TP
\fB\-\-device\fR arg (=0)
Select a specific OpenCL device id as it is
reported by clinfo
.TP
\fB\-o\fR [ \fB\-\-outPlace\fR ]
Out of place FFT transform (default: in place)
.TP
\fB\-\-double\fR
Double precision transform (default: single)
.TP
\fB\-\-inv\fR
Backward transform (default: forward)
.TP
\fB\-d\fR [ \fB\-\-dumpKernels\fR ]
FFT engine will dump generated OpenCL FFT kernels
to disk (default: dump off)
.TP
\fB\-x\fR [ \fB\-\-lenX\fR ] arg (=1024)
Specify the length of the 1st dimension of a test
array
.TP
\fB\-y\fR [ \fB\-\-lenY\fR ] arg (=1)
Specify the length of the 2nd dimension of a test
array
.TP
\fB\-z\fR [ \fB\-\-lenZ\fR ] arg (=1)
Specify the length of the 3rd dimension of a test
array
.TP
\fB\-\-isX\fR arg (=1)
Specify the input stride of the 1st dimension of
a test array
.TP
\fB\-\-isY\fR arg (=0)
Specify the input stride of the 2nd dimension of
a test array
.TP
\fB\-\-isZ\fR arg (=0)
Specify the input stride of the 3rd dimension of
a test array
.TP
\fB\-\-iD\fR arg (=0)
input distance between subsequent sets of data
when batch size > 1
.TP
\fB\-\-osX\fR arg (=1)
Specify the output stride of the 1st dimension of
a test array
.TP
\fB\-\-osY\fR arg (=0)
Specify the output stride of the 2nd dimension of
a test array
.TP
\fB\-\-osZ\fR arg (=0)
Specify the output stride of the 3rd dimension of
a test array
.TP
\fB\-\-oD\fR arg (=0)
output distance between subsequent sets of data
when batch size > 1
.TP
\fB\-b\fR [ \fB\-\-batchSize\fR ] arg (=1) If this value is greater than one, arrays will be
used
.TP
\fB\-p\fR [ \fB\-\-profile\fR ] arg (=1)
Time and report the kernel speed of the FFT
(default: profiling off)
.TP
\fB\-\-inLayout\fR arg (=1)
Layout of input data:
1) interleaved
2) planar
3) hermitian interleaved
4) hermitian planar
5) real
.TP
\fB\-\-outLayout\fR arg (=1)
Layout of input data:
1) interleaved
2) planar
3) hermitian interleaved
4) hermitian planar
5) real
.PP
clFFT runtime version: 2.12.2
.IP
Internal Client Test *****PASS*****
.SH "SEE ALSO"
The full documentation for
.B clFFT
is maintained as a Texinfo manual. If the
.B info
and
.B clFFT
programs are properly installed at your site, the command
.IP
.B info clFFT
.PP
should give you access to the complete manual.