forked from FFTW/fftw3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html says: By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as minus signs (U+002D). Since options to programs use minus signs (U+002D), this means for example in UTF-8 locales that you cannot cut and paste options, nor search for them easily. Thanks Julian Taylor for the patch.
- Loading branch information
1 parent
715c7ea
commit 553849f
Showing
2 changed files
with
40 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,13 +18,13 @@ | |
.\" | ||
.TH FFTW-WISDOM-TO-CONF 1 "February, 2003" "fftw" "fftw" | ||
.SH NAME | ||
fftw-wisdom-to-conf \- generate FFTW wisdom (pre-planned transforms) | ||
fftw\-wisdom\-to\-conf \- generate FFTW wisdom (pre-planned transforms) | ||
.SH SYNOPSIS | ||
\fBfftw-wisdom-to-conf\fR [< \fIINPUT\fR] [> \fIOUTPUT\fR] | ||
\fBfftw\-wisdom\-to\-conf\fR [< \fIINPUT\fR] [> \fIOUTPUT\fR] | ||
.SH DESCRIPTION | ||
.PP | ||
." Add any additional description here | ||
.I fftw-wisdom-to-conf | ||
.\" Add any additional description here | ||
.I fftw\-wisdom\-to\-conf | ||
is a utility to generate C | ||
.B configuration | ||
routines from FFTW | ||
|
@@ -48,15 +48,15 @@ data, among other related operations. More information on FFTW can be | |
found at the FFTW home page: | ||
.I http://www.fftw.org | ||
|
||
.I fftw-wisdom-to-conf | ||
.I fftw\-wisdom\-to\-conf | ||
reads wisdom from standard input and writes the configuration to | ||
standard output. It can easily be combined with the | ||
.I fftw-wisdom | ||
.I fftw\-wisdom | ||
tool, for example: | ||
|
||
fftw-wisdom -n cof1024 cob1024 -o wisdom | ||
fftw\-wisdom \-n cof1024 cob1024 \-o wisdom | ||
.br | ||
fftw-wisdom-to-conf < wisdom > conf.c | ||
fftw\-wisdom\-to\-conf < wisdom > conf.c | ||
|
||
will create a configuration "conf.c" containing only those parts of | ||
FFTW needed for the optimized complex forwards and backwards | ||
|
@@ -65,7 +65,7 @@ out-of-place transforms of size 1024 (also saving the wisdom itself in | |
|
||
Alternatively, you can run your actual program, export wisdom for all | ||
plans that were created (ideally in FFTW_PATIENT or FFTW_EXHAUSTIVE | ||
mode), use this as input for \fIfftw-wisdom-to-conf\fR, | ||
mode), use this as input for \fIfftw\-wisdom\-to\-conf\fR, | ||
and then re-link your program with the resulting configuration routine. | ||
|
||
Note that the configuration routine does not contain the wisdom, only | ||
|
@@ -74,10 +74,10 @@ also import the wisdom in order to benefit from the pre-optimized | |
plans. | ||
.SH OPTIONS | ||
.TP | ||
\fB\-h\fR, \fB\--help\fR | ||
\fB\-h\fR, \fB\-\-help\fR | ||
Display help on the command-line options and usage. | ||
.TP | ||
\fB\-V\fR, \fB\--version\fR | ||
\fB\-V\fR, \fB\-\-version\fR | ||
Print the version number and copyright information. | ||
.SH BUGS | ||
Send bug reports to [email protected]. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,14 +18,14 @@ | |
.\" | ||
.TH FFTW-WISDOM 1 "February, 2003" "fftw" "fftw" | ||
.SH NAME | ||
fftw@PREC_SUFFIX@-wisdom \- create wisdom (pre-optimized FFTs) | ||
fftw@PREC_SUFFIX@\-wisdom \- create wisdom (pre-optimized FFTs) | ||
.SH SYNOPSIS | ||
.B fftw@PREC_SUFFIX@-wisdom | ||
.B fftw@PREC_SUFFIX@\-wisdom | ||
[\fIOPTION\fR]... [\fISIZE\fR]... | ||
.SH DESCRIPTION | ||
.PP | ||
." Add any additional description here | ||
.I fftw@PREC_SUFFIX@-wisdom | ||
.\" Add any additional description here | ||
.I fftw@PREC_SUFFIX@\-wisdom | ||
is a utility to generate FFTW | ||
.B wisdom | ||
files, which contain saved information about how to optimally compute | ||
|
@@ -41,50 +41,50 @@ string, or other source. Moreover, it is likely that many FFTW-using | |
programs will load the \fBsystem wisdom\fR file, which is stored in | ||
.I /etc/fftw/wisdom@PREC_SUFFIX@ | ||
by default. | ||
.I fftw@PREC_SUFFIX@-wisdom | ||
.I fftw@PREC_SUFFIX@\-wisdom | ||
can be used to create or add to such wisdom files. In its most | ||
typical usage, the wisdom file can be created to pre-plan a canonical | ||
set of sizes (see below) via: | ||
|
||
.ce | ||
fftw@PREC_SUFFIX@-wisdom -v -c -o wisdom@PREC_SUFFIX@ | ||
fftw@PREC_SUFFIX@\-wisdom \-v \-c \-o wisdom@PREC_SUFFIX@ | ||
|
||
(this will take many hours, which can be limited by the | ||
.B -t | ||
.B \-t | ||
option) and the output | ||
.I wisdom@PREC_SUFFIX@ | ||
file can then be copied (as root) to | ||
.I /etc/fftw/ | ||
or whatever. | ||
|
||
The | ||
.I fftw@PREC_SUFFIX@-wisdom | ||
.I fftw@PREC_SUFFIX@\-wisdom | ||
program normally writes the wisdom directly to standard output, but this | ||
can be changed via the | ||
.B -o | ||
.B \-o | ||
option, as in the example above. | ||
|
||
If the system wisdom file | ||
.I /etc/fftw/wisdom@PREC_SUFFIX@ | ||
already exists, then | ||
.I fftw@PREC_SUFFIX@-wisdom | ||
.I fftw@PREC_SUFFIX@\-wisdom | ||
reads this existing wisdom (unless the | ||
.B -n | ||
.B \-n | ||
option is specified) and outputs both the old wisdom and any | ||
newly created wisdom. In this way, it can be used to add new transform | ||
sizes to the existing system wisdom (or other wisdom file, with the | ||
.B -w | ||
.B \-w | ||
option). | ||
.SH SPECIFYING SIZES | ||
Although a canonical set of sizes to optimize is specified by the | ||
.B -c | ||
.B \-c | ||
option, the user can also specify zero or more non-canonical transform | ||
sizes and types to optimize, via the | ||
.I SIZE | ||
arguments following the option flags. Alternatively, the sizes to | ||
optimize can be read from standard input (whitespace-separated), if a | ||
.I SIZE | ||
argument of "-" is supplied. | ||
argument of "\-" is supplied. | ||
|
||
Sizes are specified by the syntax: | ||
|
||
|
@@ -117,41 +117,41 @@ DHT and the second dimension is an REDFT01 (DCT-III). | |
|
||
.SH OPTIONS | ||
.TP | ||
\fB\-h\fR, \fB\--help\fR | ||
\fB\-h\fR, \fB\-\-help\fR | ||
Display help on the command-line options and usage. | ||
.TP | ||
\fB\-V\fR, \fB\--version\fR | ||
\fB\-V\fR, \fB\-\-version\fR | ||
Print the version number and copyright information. | ||
.TP | ||
\fB\-v\fR, \fB\--verbose\fR | ||
\fB\-v\fR, \fB\-\-verbose\fR | ||
Verbose output. (You can specify this multiple times, or supply a numeric | ||
argument greater than 1, to increase the verbosity level.) Note that the | ||
verbose output will be mixed with the wisdom output (making it impossible | ||
to import), unless you write the wisdom to a file via the | ||
.B -o | ||
.B \-o | ||
option. | ||
.TP | ||
\fB\-c\fR, \fB\--canonical\fR | ||
\fB\-c\fR, \fB\-\-canonical\fR | ||
Optimize/pre-plan a canonical set of sizes: all powers of two and ten | ||
up to 2^20 (1048576), including both real and complex, forward and | ||
backwards, in-place and out-of-place transforms. Also includes two- | ||
and three-dimensional transforms of equal-size dimensions | ||
(e.g. 16x16x16). | ||
.TP | ||
\fB\-t\fR \fIhours\fR, \fB\--time-limit\fR=\fIhours\fR | ||
\fB\-t\fR \fIhours\fR, \fB\-\-time\-limit\fR=\fIhours\fR | ||
Stop after a time of | ||
.I hours | ||
(hours) has elapsed, outputting accumulated wisdom. (The problems are planned | ||
in increasing order of size.) Defaults to 0, indicating no time limit. | ||
.TP | ||
\fB\-o\fR \fIfile\fR, \fB\--output-file\fR=\fIfile\fR | ||
\fB\-o\fR \fIfile\fR, \fB\-\-output-file\fR=\fIfile\fR | ||
Send wisdom output to | ||
.I file | ||
rather than to standard output (the default). | ||
.TP | ||
\fB\-m\fR, \fB\--measure\fR; \fB\-e\fR, \fB\--estimate\fR; \fB\-x\fR, \fB\--exhaustive\fR | ||
\fB\-m\fR, \fB\-\-measure\fR; \fB\-e\fR, \fB\-\-estimate\fR; \fB\-x\fR, \fB\-\-exhaustive\fR | ||
Normally, | ||
.I fftw@PREC_SUFFIX@-wisdom | ||
.I fftw@PREC_SUFFIX@\-wisdom | ||
creates plans in FFTW_PATIENT mode, but with these options you can instead | ||
use FFTW_MEASURE, FFTW_ESTIMATE, or FFTW_EXHAUSTIVE modes, respectively, | ||
as described in more detail by the FFTW manual. | ||
|
@@ -160,24 +160,24 @@ Note that wisdom is tagged with the planning patience level, and a | |
single file can mix different levels of wisdom (e.g. you can mostly | ||
use the patient default, but plan a few sizes that you especially care | ||
about in | ||
.B --exhaustive | ||
.B \-\-exhaustive | ||
mode). | ||
.TP | ||
\fB\-n\fR, \fB\--no-system-wisdom\fR | ||
\fB\-n\fR, \fB\-\-no\-system\-wisdom\fR | ||
Do not import the system wisdom from | ||
.I /etc/fftw/wisdom@PREC_SUFFIX@ | ||
(which is normally read by default). | ||
.TP | ||
\fB\-w\fR \fIfile\fR, \fB\--wisdom-file\fR=\fIfile\fR | ||
\fB\-w\fR \fIfile\fR, \fB\-\-wisdom\-file\fR=\fIfile\fR | ||
Import wisdom from | ||
.I file | ||
(in addition to the system wisdom, unless | ||
.B -n | ||
.B \-n | ||
is specified). Multiple wisdom files can be read via multiple | ||
.B -w | ||
.B \-w | ||
options. If | ||
.I file | ||
is "-", then read wisdom from standard input. | ||
is "\-", then read wisdom from standard input. | ||
.SH BUGS | ||
Send bug reports to [email protected]. | ||
.SH AUTHORS | ||
|