summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorVasile Vilvoiu <vasi@vilvoiu.ro>2021-07-15 22:53:30 +0300
committerVasile Vilvoiu <vasi@vilvoiu.ro>2021-07-15 22:53:30 +0300
commit82c81858c65c80fb667e73ffdcc4ff69007cfa17 (patch)
tree455bdf7a85f99c770f97d05d53c8ce340c3f7fa0 /man
parent3938ba31f633d48bb6f4471a3f49ab696a453aee (diff)
Support "-" for input/output files as stdin/stdout.
Support dumping output file to stdout. Switch logger to stderr, make it multithreaded. Log input/output files. Closes #8, closes #10, closes #13.
Diffstat (limited to 'man')
-rw-r--r--man/specgram.110
-rw-r--r--man/specgram.1.html17
-rw-r--r--man/specgram.1.pdfbin36426 -> 37118 bytes
3 files changed, 24 insertions, 3 deletions
diff --git a/man/specgram.1 b/man/specgram.1
index 8df7812..971af9d 100644
--- a/man/specgram.1
+++ b/man/specgram.1
@@ -56,6 +56,8 @@ See \fBEXAMPLES\fR for common use cases.
.BR \fIoutfile\fR
Optional output image file. Check \fISFML\fR documentation for supported file types, but PNG files are recommended.
+If "\fB-\fR" is provided then the resulting image is written to stdout in PNG format.
+
Either \fIoutfile\fR must be specified, \fB\-l, \-\-live\fR must be set, or both.
.TP
@@ -75,7 +77,7 @@ Input file name.
If option is provided, \fIINFILE\fR is handled as a raw dump of values (i.e. input file format is not considered).
The program will stop when EOF is encountered.
-If option is not provided, data will be read indefinitely from stdin.
+If option is not provided or "\fB-\fR" is provided, data will be read indefinitely from stdin.
.TP
.BR \-r ", " \-\-rate =\fIRATE\fR
@@ -325,6 +327,12 @@ Render a crisp output with a transparent background, so it can be embedded in a
.IP
\fBspecgram\fR -qe --bg-color=00000000 -i \fIinfile\fR \fIoutfile.png\fR
+.LP
+Generating from a file to stdout and displaying the output with \fBimagemagick\fR:
+
+.IP
+\fBspecgram\fR -i \fIinfile\fR - | \fBdisplay\fR
+
.SH BUGS
Frequency bounds (\fB\-x, \-\-fmin\fR and \fB\-y, \-\-fmax\fR) may exceed FFT window frequency limits when resampling is enabled (i.e. default behaviour), but may not do so when resampling is disabled (\fB\-q, \-\-no_resampling\fR).
diff --git a/man/specgram.1.html b/man/specgram.1.html
index 1559b4c..41cce87 100644
--- a/man/specgram.1.html
+++ b/man/specgram.1.html
@@ -1,5 +1,5 @@
<!-- Creator : groff version 1.22.4 -->
-<!-- CreationDate: Thu Jul 15 15:26:09 2021 -->
+<!-- CreationDate: Thu Jul 15 19:45:50 2021 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
@@ -128,6 +128,10 @@ forcefully quit.</p>
Check <i>SFML</i> documentation for supported file types,
but PNG files are recommended.</p>
+<p style="margin-left:22%; margin-top: 1em">If
+&quot;<b>-</b>&quot; is provided then the resulting image is
+written to stdout in PNG format.</p>
+
<p style="margin-left:22%; margin-top: 1em">Either
<i>outfile</i> must be specified, <b>&minus;l,
&minus;&minus;live</b> must be set, or both.</p>
@@ -151,7 +155,8 @@ provided, <i>INFILE</i> is handled as a raw dump of values
stop when EOF is encountered.</p>
<p style="margin-left:22%; margin-top: 1em">If option is
-not provided, data will be read indefinitely from stdin.</p>
+not provided or &quot;<b>-</b>&quot; is provided, data will
+be read indefinitely from stdin.</p>
<p style="margin-left:11%;"><b>&minus;r</b>,
<b>&minus;&minus;rate</b>=<i>RATE</i></p>
@@ -536,6 +541,14 @@ in a document:</p>
<p style="margin-left:22%; margin-top: 1em"><b>specgram</b>
-qe --bg-color=00000000 -i <i>infile outfile.png</i></p>
+<p style="margin-left:11%; margin-top: 1em">Generating from
+a file to stdout and displaying the output with
+<b>imagemagick</b>:</p>
+
+
+<p style="margin-left:22%; margin-top: 1em"><b>specgram</b>
+-i <i>infile</i> - | <b>display</b></p>
+
<h2>BUGS
<a name="BUGS"></a>
</h2>
diff --git a/man/specgram.1.pdf b/man/specgram.1.pdf
index 7c6de03..4b9db2d 100644
--- a/man/specgram.1.pdf
+++ b/man/specgram.1.pdf
Binary files differ