ref: 36bc60c5a92cf0bd9da6075dfd9d6fa4c9aaee26
parent: b073447b9d4e5b415e4c84b4b19d41a5f98fbf12
author: Paul Brossier <piem@altern.org>
date: Tue Nov 30 22:37:05 EST 2004
updated manpages
--- a/TODO
+++ b/TODO
@@ -1,12 +1,6 @@
TODO
====
-Doc
----
-
-- update doc
-- complete manpages
-
Library
-------
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,7 +1,8 @@
# install the man pages and include in distribution
#man_MANS = fluidsynth.1
#EXTRA_DIST = $(man_MANS) devel.cfg fluidsynth.1
-EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css
+EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \
+ aubionotes.sgml aubioonset.sgml
#docbook_docs = aubio-devdoc.xml
#DOCBOOK_STYLESHEET ?= http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -155,7 +155,9 @@
# install the man pages and include in distribution
#man_MANS = fluidsynth.1
#EXTRA_DIST = $(man_MANS) devel.cfg fluidsynth.1
-EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css
+EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \
+ aubionotes.sgml aubioonset.sgml
+
subdir = doc
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
--- a/doc/aubionotes.sgml
+++ b/doc/aubionotes.sgml
@@ -69,22 +69,24 @@
<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,8 +100,8 @@
<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>
@@ -109,6 +111,19 @@
<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>
+
</listitem>
</varlistentry>
<varlistentry>
--- a/doc/aubioonset.sgml
+++ b/doc/aubioonset.sgml
@@ -112,6 +112,19 @@
</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>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-j</option>
<option>--jack</option></term>
<listitem>