[man] document aubiocut --create-first

[aubio.git] / doc / aubiocut.txt

diff --git a/doc/aubiocut.txt b/doc/aubiocut.txt
index eb7916c..c578133 100644 (file)
--- a/doc/aubiocut.txt
+++ b/doc/aubiocut.txt
@@ -19,8 +19,8 @@ OPTIONS
   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.
+  sampling rate. The rate should be specified in Hertz as an integer. If set
+  to 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.
@@ -34,12 +34,23 @@ OPTIONS
   -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.
+  picking. Values are typically in the range [0.001, 0.900]. Lower threshold
+  values imply more onsets detected. Increasing this threshold should reduce
+  the number of incorrect 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. 
+  each slice will be created in the current directory.
+
+  -o, --output directory  Specify the directory path where slices of the
+  original source should be created.
+
+  --cut-until-nsamples n  How many extra samples should be added at the end of
+  each slice (default 0).
+
+  --cut-until-nslices n  How many extra slices should be added at the end of
+  each slice (default 0).
+
+  --create-first  Alway create first slice.
 
   -h, --help  Print a short help message and exit.