Changeset c18981e for doc

Timestamp:

Jan 29, 2015, 12:41:42 PM (10 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

1ba8e60

Parents:

74dcddb

Message:

doc/aubiocut.txt: improve documentation, adding -o, --cut-until-nsamples, and --cut-until-nslices

File:

• doc/aubiocut.txt (modified) (2 diffs)

doc/aubiocut.txt

@@ -20 +20 @@
 
   -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
@@ -40 +40 @@
 
   -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).
 
   -h, --help  Print a short help message and exit.