ref: e3c83bb9ae7139092f76a19397adeeb7ec392bc3
parent: 4e2173e742478d46b11dbec9d2cdf30e505b5d5d
author: Paul Brossier <piem@piem.org>
date: Fri Mar 24 16:07:04 EDT 2017
doc/cli.rst: revamp
--- a/doc/cli.rst
+++ b/doc/cli.rst
@@ -3,8 +3,13 @@
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
each frame of the input sound
@@ -13,47 +18,56 @@
- ``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
--- a/doc/cli_features.rst
+++ b/doc/cli_features.rst
@@ -1,5 +1,5 @@
Command line features
-=====================
+---------------------
+--------------+-------+-------+------+-------+-------+-------+------+------------------+
| feat vs. prg | onset | pitch | mfcc | track | notes | quiet | cut1 | short options |