From e3c83bb9ae7139092f76a19397adeeb7ec392bc3 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Fri, 24 Mar 2017 20:07:04 +0100 Subject: [PATCH] doc/cli.rst: revamp --- doc/cli.rst | 30 ++++++++++++++++++++++-------- doc/cli_features.rst | 2 +- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/doc/cli.rst b/doc/cli.rst index 2dc2f070..5df3b537 100644 --- a/doc/cli.rst +++ b/doc/cli.rst @@ -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 diff --git a/doc/cli_features.rst b/doc/cli_features.rst index ab77c3a1..770a0272 100644 --- 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 | -- 2.11.0