Changeset e06e478 for doc/aubionotes.sgml

Timestamp:

Aug 21, 2005, 6:43:10 PM (19 years ago)

Author:

Paul Brossier <piem@altern.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:

66834b6

Parents:

2ebf76c

Message:

updated manpages

File:

• doc/aubionotes.sgml (modified) (4 diffs)

doc/aubionotes.sgml

@@ -27 +27 @@
   <!ENTITY dhemail     "<email>piem@altern.org</email>">
   <!ENTITY dhusername  "Paul Brossier">
-  <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
+  <!ENTITY dhucpackage "<refentrytitle>AUBIONOTES</refentrytitle>">
   <!ENTITY dhpackage   "aubionotes">
 
@@ -103 +103 @@
   <option>--output fileout</option></term>
   <listitem>
-<para>Save results in this file. The file will be created on the model of the
-input file. Results are marked by a very short wood-block sample.</para>
+
+  <para>Save results in this file. The file will be created on the model of the
+  input file. Results are marked by a very short wood-block sample.</para>
+
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>-P</option>
+  <option>--pitch mode</option></term>
+  <listitem>
+
+  <para>The pitch detection function to run. Available functions are
+  <emphasis>mcomb</emphasis>, <emphasis>yin</emphasis>,
+  <emphasis>fcomb</emphasis> and <emphasis>schmitt</emphasis>.</para>
+
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>-O</option>
+  <option>--onset mode</option></term>
+  <listitem>
+
+  <para>The onset detection function to run. Available functions are
+  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
+  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
+  <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
+  <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
+  domain are used in parallel.</para>
+
   </listitem>
   </varlistentry>
@@ -111 +138 @@
   <option>--threshold value</option></term>
   <listitem>
-<para>Set the threshold value for the onset peak picking. Typical values are within
-<literal>0.001</literal> and <literal>0.900</literal>. Default is <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
-sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
-  </listitem>
-  </varlistentry>
-  <varlistentry>
-  <term><option>-O</option>
-  <option>--onset value</option></term>
-  <listitem>
-
-  <para>The onset detection function to run. Can be one of
-  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
-  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
-  <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
-  complex domain and HFC are used in parallel.</para>
+
+  <para>Set the threshold value for the onset peak picking. Typical values are
+  within <literal>0.001</literal> and <literal>0.900</literal>. Default is
+  <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
+  sensible</emphasis>.  Try <literal>0.3</literal> in case of
+  over-detections.</para>
 
   </listitem>
@@ -157 +175 @@
     <title>SEE ALSO</title>
 
-    <para><emphasis>aubioonset</emphasis> (1)</para>
+    <para><command>aubioonset</command> (1)</para>
 
   </refsect1>