add timeside-launch presentation

diff --git a/README.rst b/README.rst
index 09e729f0762f87dc344482cec62229014d575bab..8478073032c9b6fcd888977ff8dfeeb66438a107 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -61,7 +61,7 @@ IGrapher
   * WaveformContourBlack [waveform_contour_black]
   * WaveformContourWhite [waveform_contour_white]
   * SpectrogramLog [spectrogram_log]
-  * SpectrogramLinear [spectrogram_linear]
+  * SpectrogramLinear [spectrogram_lin]
 
 IAnalyzer
 ---------
@@ -86,7 +86,7 @@ News
 
 0.5.2
 
- * Add a general launch script "timeside-launch" (see "User interface")
+ * Add a general launch script "timeside-launch" (see "Shell interface")
  * Add some decorators to filter the inputs of processes (see analyzer.waveform for ex)
  * Add a "stack" option to the FileDecoder to accumulate audio data allowing multipass processes
  * Add beat confidence to aubio_temporal
@@ -263,8 +263,43 @@ MacOS X and Windows versions will soon be explorated.
 The player should work on any modern HTML5 enabled browser.
 Flash is needed for MP3 if the browser doesn't support it.
 
-User Interface
-===============
+Shell Interface
+================
+
+Of course, TimeSide can be used in any python environment. But, a shell script is also provided to enable preset based and recursive processing through your command line interface::
+
+ $ timeside-launch -h
+ Usage: scripts/timeside-launch [options] -c file.conf file1.wav [file2.wav ...]
+  help: scripts/timeside-launch -h
+
+ Options:
+  -h, --help            show this help message and exit
+  -v, --verbose         be verbose
+  -q, --quiet           be quiet
+  -C <config_file>, --conf=<config_file>
+                        configuration file
+  -s <samplerate>, --samplerate=<samplerate>
+                        samplerate at which to run the pipeline
+  -c <channels>, --channels=<channels>
+                        number of channels to run the pipeline with
+  -b <blocksize>, --blocksize=<blocksize>
+                        blocksize at which to run the pipeline
+  -a <analyzers>, --analyzers=<analyzers>
+                        analyzers in the pipeline
+  -g <graphers>, --graphers=<graphers>
+                        graphers in the pipeline
+  -e <encoders>, --encoders=<encoders>
+                        encoders in the pipeline
+  -R <formats>, --results-formats=<formats>
+                        list of results output formats for the analyzers
+                        results
+  -I <formats>, --images-formats=<formats>
+                        list of graph output formats for the analyzers results
+  -o <outputdir>, --ouput-directory=<outputdir>
+                        output directory
+
+Web Interface
+==============
 
 TimeSide comes with a smart and pure **HTML5** audio player.
 

diff --git a/doc/source/news.rst b/doc/source/news.rst
index b7fe12877f24e40aa5ac845ba7a7c5fdfb850c6d..ec159ab2445610ace3a37a16bc396d9da7577ab4 100644 (file)
--- a/doc/source/news.rst
+++ b/doc/source/news.rst
@@ -3,7 +3,7 @@ News
 
 0.5.2
 
- * Add a general launch script "timeside-launch" (see "User interface")
+ * Add a general launch script "timeside-launch" (see "Shell interface")
  * Add some decorators to filter the inputs of processes (see analyzer.waveform for ex)
  * Add a "stack" option to the FileDecoder to accumulate audio data allowing multipass processes
  * Add beat confidence to aubio_temporal

diff --git a/doc/source/ui.rst b/doc/source/ui.rst
index 973deb2b2bde6037e019967ebaa2c626d96a1006..b89a12286bdd228d6683c2d9a61a845cbda19418 100644 (file)
--- a/doc/source/ui.rst
+++ b/doc/source/ui.rst
@@ -1,5 +1,40 @@
-User Interface
-===============
+Shell Interface
+================
+
+Of course, TimeSide can be used in any python environment. But, a shell script is also provided to enable preset based and recursive processing through your command line interface::
+
+ $ timeside-launch -h
+ Usage: scripts/timeside-launch [options] -c file.conf file1.wav [file2.wav ...]
+  help: scripts/timeside-launch -h
+
+ Options:
+  -h, --help            show this help message and exit
+  -v, --verbose         be verbose
+  -q, --quiet           be quiet
+  -C <config_file>, --conf=<config_file>
+                        configuration file
+  -s <samplerate>, --samplerate=<samplerate>
+                        samplerate at which to run the pipeline
+  -c <channels>, --channels=<channels>
+                        number of channels to run the pipeline with
+  -b <blocksize>, --blocksize=<blocksize>
+                        blocksize at which to run the pipeline
+  -a <analyzers>, --analyzers=<analyzers>
+                        analyzers in the pipeline
+  -g <graphers>, --graphers=<graphers>
+                        graphers in the pipeline
+  -e <encoders>, --encoders=<encoders>
+                        encoders in the pipeline
+  -R <formats>, --results-formats=<formats>
+                        list of results output formats for the analyzers
+                        results
+  -I <formats>, --images-formats=<formats>
+                        list of graph output formats for the analyzers results
+  -o <outputdir>, --ouput-directory=<outputdir>
+                        output directory
+
+Web Interface
+==============
 
 TimeSide comes with a smart and pure **HTML5** audio player.