aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2016-02-13 00:38:36 +0100
committerMatthias P. Braendli <matthias.braendli@mpb.li>2016-02-13 00:38:36 +0100
commit1d63f100caa732cb3d15c3c4e8b7f467b109dc39 (patch)
treea68c2a6173e53c264bd82ef56749717b7924394f
parent3ae00acf8f6bc443f78216d6dfc81b33e33dd262 (diff)
downloaddab-scripts-1d63f100caa732cb3d15c3c4e8b7f467b109dc39.tar.gz
dab-scripts-1d63f100caa732cb3d15c3c4e8b7f467b109dc39.tar.bz2
dab-scripts-1d63f100caa732cb3d15c3c4e8b7f467b109dc39.zip
Cosmetic changes to README
-rw-r--r--README.md47
1 files changed, 33 insertions, 14 deletions
diff --git a/README.md b/README.md
index b4af718..35a5fc9 100644
--- a/README.md
+++ b/README.md
@@ -5,43 +5,55 @@ version : radioHack2016
Prerequisites
-------------
-You need to have a working ODR-DabMux, ODR-DabMod, fdk-aac-dabplus and/or toolame-dab configuration to
-use these scripts. Also supervisor is now needed. (apt-get install supervisor)
+You need to have a working ODR-DabMux, ODR-DabMod, FDK-AAC-DABplus and/or
+Toolame-DAB configuration to use these scripts. Also
+[supervisor](http://supervisord.org/) is needed. (apt-get install supervisor)
+The tools are expected to be installed in their usual place in /usr/local.
Folder structure
----------------
-The 'config' folder contains all needed configuration file and needed to be moved into /home/odr/ folder.
+The 'config' folder contains all needed configuration file and needed to be
+moved into /home/odr/ folder.
- * config/mod.conf : contains mod configuration
- * config/mux.conf : contains mux configuration
- * config/supervisor/ : contains all supervisor configuration file.
- * config/mot/ : contains all dls and sls file. You need to create FIFO FILE with mkfifo for eatch radio (mkfifo /home/odr/config/mot/f3.pad)
+ * config/mod.conf : contains ODR-DabMod configuration
+ * config/mux.conf : contains ODR-DabMux configuration
+ * config/supervisor/ : contains all supervisor configuration files
+ * config/mot/ : contains all dls and slide files. You need to create fifo
+ with mkfifo for each radio (e.g. mkfifo /home/odr/config/mot/f3.pad)
About encoder and mot-encoder
------------------
+-----------------------------
-Encoder (toolame-dab or dabplus-enc) write ICY-text into a text file. You need to create this file at first for each radio :
+The encoder (toolame-dab or dabplus-enc) writes ICY-Text into a text file. You
+need to create this file at first for each radio :
* touch /home/odr/config/mot/f3.txt
-mot-encoder read ICY-text information from previous text file and write into pad file. This pad file need to be a FIFO and you need to create it for each radio :
+mot-encoder reads ICY-Text information from previous text file and writes into
+the pad file. This pad file need to be a FIFO and you need to create it for
+each radio :
* mkfifo /home/odr/config/mot/f3.pad
-If you use Slide Show, you can put your image into the directory under mot folder corresponding to the radio (example: /home/odr/config/mot/f3/)
+If you use Slide Show, you can put your images into the directory under mot
+folder corresponding to the radio (example: /home/odr/config/mot/f3/)
About supervisor
----------------
-You need to create sym link into /etc/supervisor/conf.d/ for eatch radio configuration file and call supervisorctl to reread and update configuration.
+You need to create sym link into /etc/supervisor/conf.d/ for each radio
+configuration file and call supervisorctl to reread and update configuration.
+Please refer to the official [supervisor](http://supervisord.org/)
+documentation for details.
+
Example :
* sudo ln -s /home/odr/config/supervisor/f3.conf /etc/supervisor/conf.d/f3.conf
* sudo supervisorctl reread
* sudo supervisorctl update
-All services are launch from supervisor.
+All services are launched from supervisor.
To show status of all services :
* sudo supervisorctl status
@@ -49,6 +61,13 @@ To show status of all services :
To [stop|start|restart] a service :
* sudo supervisorctl [stop|start|restart] service-name
-To apply change after change anything in /home/odr/config/supervisor/ file you need to call supervisor to reread and update configuration.
+To apply change after change anything in /home/odr/config/supervisor/ file you
+need to call supervisor to reread and update configuration.
* sudo supervisorctl reread
* sudo supervisorctl update
+
+Supervisor redirects all logs from the tools to files in /var/log/supervisor/
+You may need to ensure yourself that this directory exists. The logs will get
+rotated according to the policy defined by your distribution. More details in
+the [child logging](http://supervisord.org/logging.html#child-process-logs)
+section of the documentation.