diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | man/odr-dabmux.1 | 22 | ||||
| -rw-r--r-- | man/odr-zmq2edi.1 | 66 |
3 files changed, 90 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am index 5055d95..196e4e6 100644 --- a/Makefile.am +++ b/Makefile.am @@ -235,6 +235,8 @@ odr_zmq2edi_LDADD = $(ZMQ_LIBS) $(PTHREAD_CFLAGS) $(PTHREAD_LIBS) $(BOOST_SYS odr_zmq2edi_CFLAGS = -Wall $(ZMQ_CPPFLAGS) $(PTHREAD_CFLAGS) $(GITVERSION_FLAGS) $(INCLUDE) odr_zmq2edi_CXXFLAGS = -Wall -std=c++11 $(PTHREAD_LIBS) $(ZMQ_CPPFLAGS) $(GITVERSION_FLAGS) $(INCLUDE) +man_MANS = man/odr-dabmux.1 \ + man/odr-zmq2edi.1 EXTRA_DIST = COPYING NEWS README.md INSTALL.md LICENCE AUTHORS ChangeLog TODO doc \ lib/fec/README.md lib/fec/LICENSE \ diff --git a/man/odr-dabmux.1 b/man/odr-dabmux.1 new file mode 100644 index 0000000..2bf6dc4 --- /dev/null +++ b/man/odr-dabmux.1 @@ -0,0 +1,22 @@ +.TH ODR-DABMUX "1" "April 2022" "odr-dabmux 4.1.0" "User Commands" +.SH NAME +\fBodr\-dabmux\fR \- A software DAB multiplexer +.SH SYNOPSIS +odr\-dabmux <configuration_file> +.PP +This software requires a configuration file. See doc/example.config for an example format for the configuration file +.SH DESCRIPTION +odr\-dabmux implements a DAB multiplexer that combines all audio and data +inputs into an ETI output. It can be used off-line (i.e. not real-time) to generate +ETI data for later processing, or in a real-time streaming scenario (e.g. in a +transmitter). +.PP +odr\-dabmux can read input audio or data from files (“.mp2” for DAB, “.dabp” +for DAB+), FIFOs (also called “named pipes”), or from a network connection. This +network connection can use UDP (STI-D) or EDI. +.PP +The configuration of the multiplexer is given in a configuration file, whose +format is defined in the example files in the doc/ folder inside the ODR-DabMux +repository. +.SH SEE ALSO +odr\-audioenc(1), odr\-audioenc(1), odr\-dabmod(1) diff --git a/man/odr-zmq2edi.1 b/man/odr-zmq2edi.1 new file mode 100644 index 0000000..91e8888 --- /dev/null +++ b/man/odr-zmq2edi.1 @@ -0,0 +1,66 @@ +.TH ODR-ZMQ2EDI "1" "April 2022" "" "User Commands" +.SH NAME +\fBodr-zmq2edi\fR \- Convert an ZeroMQ stream to EDI +.SH SYNOPSIS +odr\-zmq2edi [options] <source> +.PP +<source> is a ZMQ URL that points to a ODR\-DabMux ZMQ output. +.SH DESCRIPTION +zmq2edi can receive a ZMQ ETI stream from ODR-DabMux and generate an EDI stream. +This is quite useful if your modulator wants EDI input, and your network is not +good enough making you want to use something based on TCP. +.PP +The input socket will be reset if no data is received for 10 seconds. +It is best practice to run this tool under a process supervisor that will restart it automatically. +.SH OPTIONS +.SS "The following options can be given only once:" +.TP +\fB\-w\fR <delay> +Keep every ETI frame until TIST is <delay> milliseconds after current system time. +Negative delay values are also allowed. +.TP +\fB\-C\fR <path to script> +Before starting, run the given script, and only start if it returns 0. +This is useful for checking that NTP is properly synchronised +.TP +\fB\-x\fR +Drop frames where for which the wait time would be negative, i.e. frames that arrived too late. +.TP +\fB\-P\fR +Disable PFT and send AFPackets. +.TP +\fB\-f\fR <fec> +Set the FEC. +.TP +\fB\-i\fR <spread> +Configure the UDP packet spread/interleaver with given percentage: 0% send all fragments +at once, 100% spread over 24ms, >100% spread and interleave. Default 95% +.TP +\fB\-D\fR +Dump the EDI to edi.debug file. +.TP +\fB\-v\fR +Enables verbose mode. +.TP +\fB\-a\fR <alignement> +Set the alignment of the TAG Packet (default 8). +.TP +\fB\-b\fR <backoff> +Number of milliseconds to backoff after an input reset (default 5000). +.SS +The following options can be given several times, when more than one UDP destination is desired: +.TP +\fB\-d\fR <destination ip> +Set the destination ip. +.TP +\fB\-p\fR <destination port> +Set the destination port. +.TP +\fB\-s\fR <source port> +Set the source port. +.TP +\fB\-S\fR <source ip> +Select the source IP in case we want to use multicast. +.TP +\fB\-t\fR <ttl> +Set the packet's TTL. |