.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH WELLE-CLI "1" "November 2021" "welle-cli 2.4" "User Commands"
.SH NAME
welle-cli \- welle.io command line interface
.SH SYNOPSIS
.B welle-cli
[\fI\,OPTION\/\fR]
.br
.B welle-cli
\fI\,-w <port> \/\fR[\fI\,OPTION\/\fR]
.SH DESCRIPTION
welle\-cli is welle.io's command line interface.
.SH OPTIONS
.SS "Tuning:"
.TP
\fB\-c\fR channel
Tune to <channel> (eg. 10B, 5A, LD...).
.TP
\fB\-p\fR programme
Play <programme> with ALSA (text name of the radio: eg. GRIFF).
.SS "Dumping:"
.TP
\fB\-D\fR
Dump FIC and all programmes to files (cannot be used with \fB\-C\fR).
This generates: dump.fic; <programme_name.msc> files;
<programme_name.wav> files.
.TP
\fB\-d\fR
Dump programme to <programme_name.msc> file.
.SS "Web server mode:"
.TP
\fB\-w\fR port
Enable web server on port <port>.
.TP
\fB\-C\fR number
Number of programmes to decode in a carousel
(to be used with \fB\-w\fR, cannot be used with \fB\-D\fR).
This is useful if your machine cannot decode all programmes
simultaneously, but you still want to get an overview of
the ensemble.
.TP
\fB\-P\fR
Without the \fB\-P\fR option, welle\-cli will switch every 10 seconds.
With the \fB\-P\fR option, welle\-cli will switch once DLS and a
slide were decoded, staying at most 80 seconds on a given
programme.
.SS "Backend and input options:"
.TP
\fB\-f\fR file
Read an IQ file <file> and play with ALSA
IQ file format is u8, unless the file ends with FORMAT.iq
.TP
\fB\-u\fR
Disable coarse corrector, for receivers who have a low
frequency offset.
.TP
\fB\-g\fR gain
Set input gain to <gain> or \fB\-1\fR for auto gain.
.TP
\fB\-F\fR driver
Set input driver and arguments. Default: "auto".
Valid drivers depending on compilation options at build time
are:
airspy, rtl_sdr, android_rtl_sdr, rtl_tcp, soapysdr.
With "rtl_tcp", host IP and port can be specified as
"rtl_tcp,<HOST_IP>:<PORT>".
.TP
\fB\-s\fR args
SoapySDR Driver arguments.
.TP
\fB\-A\fR antenna
Set input antenna to ANT (for SoapySDR input only).
.TP
\fB\-T\fR
Disable TII decoding to reduce CPU usage.
.SS "Other options:"
.TP
\fB\-t\fR test_id
Run test <test_id>.
To understand what the tests do, please see source code.
.TP
\fB\-h\fR
Display this help and exit.
.TP
\fB\-v\fR
Output version information and exit.
.SH EXAMPLES
welle\-cli \-c 10B \-p GRRIF
.IP
Receive 'GRRIF' on channel '10B' using 'auto' driver, and play with ALSA.
.PP
welle\-cli \-f ./ofdm.iq \-p GRRIF
.IP
Read IQ file './ofdm.iq' (in u8 format) and play programme 'GRIFF' with ALSA.
.PP
welle\-cli \-f ./ofdm.iq \-t 1
.IP
Read IQ file './ofdm.iq' (in u8 format), and run test 1.
.PP
welle\-cli \-c 10B \-D
.IP
Dump FIC and all programmes of channel 10B to files.
.PP
welle\-cli \-c 10B \-w 8000
.IP
Enable web server on port 8000, decode programmes on channel 10B on demand
(http://localhost:8000).
.PP
welle\-cli \-c 10B \-Dw 8000
.IP
Enable web server on port 8000, decode all programmes on channel 10B.
.PP
welle\-cli \-c 10B \-C 1 \-w 8000
.IP
Enable web server on port 8000, decode programmes one by one in a carousel
on channel 10B; welle\-cli will switch every 10 seconds.
.PP
welle\-cli \-c 10B \-PC 1 \-w 8000
.IP
Enable web server on port 8000, decode programmes one by one in a carousel
on channel 10B; welle\-cli will switch once DLS and a slide were decoded,
staying at most 80 seconds on a given programme.
.SH AUTHOR
Written by: Albrecht Lohofener & Matthias P. Braendli.
Other contributors: <https://github.com/AlbrechtL/welle.io/blob/master/AUTHORS>
.SH "REPORTING BUGS"
Report bugs to: <https://github.com/AlbrechtL/welle.io/issues>
.SH COPYRIGHT
Copyright \(co 2018 Matthias P. Braendli.
.br
Copyright \(co 2017 Albrecht Lohofener.
License GPL\-2.0\-or\-later: GNU General Public License v2.0 or later
<https://www.gnu.org/licenses/old\-licenses/gpl\-2.0\-standalone.html>