doc/: rewrite manpages, use txt2man, add aubioquiet.txt, change rule in wscript

[aubio.git] / doc / aubiocut.txt

diff --git a/doc/aubiocut.txt b/doc/aubiocut.txt
new file mode 100644 (file)
index 0000000..eb7916c
--- /dev/null
+++ b/doc/aubiocut.txt
@@ -0,0 +1,74 @@
+NAME
+  aubiocut - a command line tool to slice sound files at onset or beat timestamps
+
+SYNOPSIS
+
+  aubiocut source
+  aubiocut [[-i] source]
+           [-r rate] [-B win] [-H hop]
+           [-O method] [-t thres]
+           [-b] [-c]
+           [-v] [-q] [-h]
+
+OPTIONS
+
+  This program follows the usual GNU command line syntax, with long options
+  starting with two dashes (--). A summary of options is included below.
+
+  -i, --input source  Run analysis on this audio file. Most uncompressed and
+  compressed are supported, depending on how aubio was built.
+
+  -r, --samplerate rate  Fetch the input source, resampled at the given
+  sampling rate. The rate should be specified in Hertz as an integer. If 0,
+  the sampling rate of the original source will be used. Defaults to 0.
+
+  -B, --bufsize win  The size of the buffer to analyze, that is the length
+  of the window used for spectral and temporal computations. Defaults to 512.
+
+  -H, --hopsize hop  The number of samples between two consecutive analysis.
+  Defaults to 256.
+
+  -O, --onset method  The onset detection method to use. See ONSET METHODS
+  below. Defaults to 'default'.
+
+  -b, --beat  Use beat locations instead of onset locations.
+
+  -t, --onset-threshold thres  Set the threshold value for the onset peak
+  picking. Typical values are typically within 0.001 and 0.900. Defaults to
+  0.1. Lower threshold values imply more onsets detected. Try 0.5 in case of
+  over-detections. Defaults to 0.3.
+
+  -c, --cut  Cut input sound file at detected labels. A new sound files for
+  each slice will be created in the current directory. 
+
+  -h, --help  Print a short help message and exit.
+
+  -v, --verbose  Be verbose.
+
+  -q, --quiet  Be quiet.
+
+
+ONSET METHODS
+
+  Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl,
+  specflux.
+
+  See aubioonset(1) for details about these methods.
+
+
+SEE ALSO
+
+  aubioonset(1),
+  aubiopitch(1),
+  aubiotrack(1),
+  aubionotes(1),
+  aubioquiet(1),
+  and
+  aubiomfcc(1).
+
+AUTHOR
+
+  This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
+  granted to copy, distribute and/or modify this document under the terms of
+  the GNU General Public License as published by the Free Software Foundation,
+  either version 3 of the License, or (at your option) any later version.