doc/cli.rst: revamp
authorPaul Brossier <piem@piem.org>
Fri, 24 Mar 2017 19:07:04 +0000 (20:07 +0100)
committerPaul Brossier <piem@piem.org>
Fri, 24 Mar 2017 19:07:04 +0000 (20:07 +0100)
doc/cli.rst
doc/cli_features.rst

index 2dc2f07..5df3b53 100644 (file)
@@ -3,7 +3,12 @@
 Command line tools
 ==================
 
-A few simple command line tools are included along with the library.
+The python module comes with the following tools:
+
+ - ``aubio`` estimate and extract descriptors from sound files
+ - ``aubiocut`` slices sound files at onset or beat timestamps
+
+More command line tools are included along with the library.
 
  - ``aubioonset`` outputs the time stamp of detected note onsets
  - ``aubiopitch`` attempts to identify a fundamental frequency, or pitch, for
@@ -13,47 +18,56 @@ A few simple command line tools are included along with the library.
  - ``aubionotes`` emits midi-like notes, with an onset, a pitch, and a duration
  - ``aubioquiet`` extracts quiet and loud regions
 
-Additionally, the python module comes with the following script:
 
- - ``aubiocut`` slices sound files at onset or beat timestamps
+``aubio``
+---------
 
+.. literalinclude:: aubio.txt
+   :language: text
 
-.. toctree::
 
-   cli_features
+``aubiocut``
+--------------
+
+.. literalinclude:: aubiocut.txt
+   :language: text
 
 
 ``aubioonset``
 --------------
 
 .. literalinclude:: aubioonset.txt
+   :language: text
 
 ``aubiopitch``
 --------------
 
 .. literalinclude:: aubiopitch.txt
+   :language: text
 
 ``aubiomfcc``
 --------------
 
 .. literalinclude:: aubiomfcc.txt
+   :language: text
 
 ``aubiotrack``
 --------------
 
 .. literalinclude:: aubiotrack.txt
+   :language: text
 
 ``aubionotes``
 --------------
 
 .. literalinclude:: aubionotes.txt
+   :language: text
 
 ``aubioquiet``
 --------------
 
 .. literalinclude:: aubioquiet.txt
+   :language: text
 
-``aubiocut``
---------------
 
-.. literalinclude:: aubiocut.txt
+.. include:: cli_features.rst
index ab77c3a..770a027 100644 (file)
@@ -1,5 +1,5 @@
 Command line features
-=====================
+---------------------
 
 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
 | feat vs. prg | onset | pitch | mfcc | track | notes | quiet | cut1 | short options    |