Changeset 8d0b707 for doc

Timestamp:

Sep 27, 2005, 9:21:51 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:

6f7aad0

Parents:

06156a6

Message:

added and updated manpages
added and updated manpages

Location:

doc

Files:

• Makefile.am (modified) (1 diff)
• aubiocut.sgml (added)
• aubionotes.sgml (modified) (3 diffs)
• aubioonset.sgml (modified) (2 diffs)
• aubiopitch.sgml (added)
• aubiotrack.sgml (added)

doc/Makefile.am

@@ -1 +1 @@
 EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \
         aubionotes.sgml aubioonset.sgml \
-        aubioonset.1 aubionotes.1
+        aubiocut.sgml aubiopitch.sgml aubiotrack.sgml \
+        aubioonset.1 aubionotes.1 \
+        aubiocut.1 aubiopitch.1 aubiotrack.1
 
-man_MANS = aubionotes.1 aubioonset.1
+man_MANS = aubionotes.1 aubioonset.1 \
+        aubiocut.1 aubiopitch.1 aubiotrack.1
 CLEANFILES = $(man_MANS)
 

doc/aubionotes.sgml

@@ -72 +72 @@
     <para>This manual page documents briefly the <command>&dhpackage;</command> command.</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>&dhpackage;</command> is still in an experimental state.
+    Its aim is to extract the melody and output it as a midi stream with a
+    minimal deleay. Pitch candidates are selected at each frame, onset and
+    silences are used to segment the notes.</para>
+
+    <para>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>
@@ -87 +86 @@
     <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>
@@ -175 +175 @@
     <title>SEE ALSO</title>
 
-    <para><command>aubioonset</command> (1)</para>
+    <para>
+    <command>aubioonset</command>(1)
+    <command>aubiotrack</command>(1)
+    <command>aubionotes</command>(1)
+    <command>aubiopitch</command>(1)
+    </para>
 
   </refsect1>

doc/aubioonset.sgml

@@ -160 +160 @@
 
   </refsect1>
-  <refsect1>
-    <title>SEE ALSO</title>
-
-    <para><command>aubionotes</command> (1)</para>
-
-  </refsect1>
-
 <refsect1>
 <title>BUGS</title>
@@ -174 +167 @@
 
 </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+        <para>
+        <command>aubiocut</command>(1)
+        <command>aubiotrack</command>(1)
+        <command>aubionotes</command>(1)
+        <command>aubiopitch</command>(1)
+        </para>
+
+
+  </refsect1>
 
   <refsect1>