Changeset 36bc60c

Timestamp:

Dec 1, 2004, 4:37:05 AM (20 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:

c0ec39c

Parents:

b073447

Message:

updated manpages

Files:

• TODO (modified) (1 diff)
• doc/Makefile.am (modified) (1 diff)
• doc/Makefile.in (modified) (1 diff)
• doc/aubionotes.sgml (modified) (4 diffs)
• doc/aubioonset.sgml (modified) (1 diff)

TODO

@@ -1 +1 @@
 TODO
 ====
-
-Doc
----
-
-- update doc
-- complete manpages
 
 Library 

doc/Makefile.am

@@ -2 +2 @@
 #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

doc/Makefile.in

@@ -156 +156 @@
 #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

doc/aubionotes.sgml

@@ -70 +70 @@
     <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><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>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>
 
   </refsect1>
@@ -83 +85 @@
     <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>
@@ -99 +101 @@
   <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>
@@ -110 +112 @@
 <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>

doc/aubioonset.sgml

@@ -113 +113 @@
   </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>