From e06e478cbf83d013feb9da7234576bd69fad5b81 Mon Sep 17 00:00:00 2001
From: Paul Brossier <piem@altern.org>
Date: Sun, 21 Aug 2005 16:43:10 +0000
Subject: [PATCH] updated manpages

---
 doc/aubionotes.sgml | 44 ++++++++++++++++++++++----------
 doc/aubioonset.sgml | 62 ++++++++++++++++++++++++++-------------------
 2 files changed, 67 insertions(+), 39 deletions(-)

diff --git a/doc/aubionotes.sgml b/doc/aubionotes.sgml
index ba23ddc6..84226cc1 100644
--- a/doc/aubionotes.sgml
+++ b/doc/aubionotes.sgml
@@ -26,7 +26,7 @@ manpage.1: manpage.sgml
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
   <!ENTITY dhemail     "<email>piem@altern.org</email>">
   <!ENTITY dhusername  "Paul Brossier">
-  <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
+  <!ENTITY dhucpackage "<refentrytitle>AUBIONOTES</refentrytitle>">
   <!ENTITY dhpackage   "aubionotes">
 
   <!ENTITY debian      "<productname>Debian</productname>">
@@ -102,29 +102,47 @@ supported.</para>
   <term><option>-o</option>
   <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>-t</option>
-  <option>--threshold value</option></term>
+  <term><option>-P</option>
+  <option>--pitch mode</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>
+
+  <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 value</option></term>
+  <option>--onset mode</option></term>
   <listitem>
 
-  <para>The onset detection function to run. Can be one of
+  <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>. By default (<emphasis>fixme</emphasis>), both
-  complex domain and HFC are used in parallel.</para>
+  <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>
+  <varlistentry>
+  <term><option>-t</option>
+  <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>
@@ -156,7 +174,7 @@ sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</pa
   <refsect1>
     <title>SEE ALSO</title>
 
-    <para><emphasis>aubioonset</emphasis> (1)</para>
+    <para><command>aubioonset</command> (1)</para>
 
   </refsect1>
 
diff --git a/doc/aubioonset.sgml b/doc/aubioonset.sgml
index ba05e3c5..92f62719 100644
--- a/doc/aubioonset.sgml
+++ b/doc/aubioonset.sgml
@@ -26,7 +26,7 @@ manpage.1: manpage.sgml
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
   <!ENTITY dhemail     "<email>piem@altern.org</email>">
   <!ENTITY dhusername  "Paul Brossier">
-  <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
+  <!ENTITY dhucpackage "<refentrytitle>AUBIOONSET</refentrytitle>">
   <!ENTITY dhpackage   "aubioonset">
 
   <!ENTITY debian      "<productname>Debian</productname>">
@@ -57,7 +57,8 @@ manpage.1: manpage.sgml
   <refnamediv>
     <refname>&dhpackage;</refname>
 
-    <refpurpose>an sound file onset detector</refpurpose>
+    <refpurpose>a command line tool for real time onset extraction</refpurpose>
+
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
@@ -69,22 +70,24 @@ manpage.1: manpage.sgml
 
     <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
 
-<para>The library <emphasis remap='B'>aubio</emphasis> provides a small set of functions to extract events and
-objects from audio, from live streams or still files. Onsets are used to label
-the beginning of notes, pitches to label their height.</para>
+<para>The library <emphasis>aubio</emphasis> provides a small set of functions
+to extract events and objects from audio, from live streams or still files.
+Onsets are used to label the beginning of notes, pitches to label their
+height.</para>
 
-<para><command>aubionotes</command> is still in an experimental state. Its aim is to segment notes
-with onsets, and label them with their detected pitch. When started without an
-input file argument (<option>-i</option>), aubionotes creates a jack input and a midi
-output. When an input file is given, it outputs the results on the console.</para>
+<para><command>aubionotes</command> is still in an experimental state. Its aim
+is to segment notes with onsets, and label them with their detected pitch. When
+started without an input file argument (<option>-i</option>), aubionotes
+creates a jack input and a midi output. When an input file is given, it outputs
+the results on the console.</para>
 
   </refsect1>
   <refsect1>
     <title>OPTIONS</title>
 
-<para>This program follows the usual GNU command line syntax, with long
-options starting with two dashes (`-').
-A summary of options is included below.</para>
+<para>This program follows the usual GNU command line syntax, with long options
+starting with two dashes (`-').  A summary of options is included below.</para>
+
 <variablelist>
   <varlistentry>
   <term><option>-i</option>
@@ -98,29 +101,36 @@ supported.</para>
   <term><option>-o</option>
   <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>-t</option>
-  <option>--threshold value</option></term>
+  <term><option>-O</option>
+  <option>--onset mode</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 remap='B'>lower</emphasis> the <emphasis remap='B'>more
-sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
+
+  <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>
   <varlistentry>
-  <term><option>-O</option>
-  <option>--onset value</option></term>
+  <term><option>-t</option>
+  <option>--threshold 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>
   </varlistentry>
-- 
2.26.2