Changeset beea3cf for doc/aubiotrack.sgml

Timestamp:

Oct 7, 2006, 11:46:54 PM (18 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:

823fa09

Parents:

042e095

Message:

update the manual pages
update the manual pages

File:

• doc/aubiotrack.sgml (modified) (11 diffs)

doc/aubiotrack.sgml

@@ -63 +63 @@
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>&dhpackage; <parameter>[options]</parameter></command>
+      <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -70 +70 @@
 
     <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
+
+    <para>The <emphasis>aubio</emphasis> library 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>&dhpackage;</command> attempts to tap the beat and detect
     beat locations in musical sounds. When started with an input file argument
     (<option>-i</option>), aubiotrack print the beat locations in second
-    detected in the file. Without an input file is given, aubiotrack will start
-    as a jack client and play a woodblock sound at predicted beat
-    locations.</para>
+    detected in the file.</para>
+    
+    <para>When started without an input file argument
+    (<option>--input</option>), <command>&dhpackage;</command> creates jack
+    input and output ports. When an input file is given, the results are given
+    on the console.</para>
 
   </refsect1>
@@ -82 +90 @@
     <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>
@@ -90 +99 @@
   <option>--input filein</option></term>
   <listitem>
-<para>Run analysis on this audio file. Most common (uncompressed) formats are 
-supported.</para>
+
+  <para>Run analysis on this audio file. Most common uncompressed formats are
+  supported.</para>
+
   </listitem>
   </varlistentry>
@@ -100 +111 @@
 
   <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>
+  input file. Results are marked by a short wood-block sample.</para>
 
   </listitem>
@@ -125 +136 @@
   <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>
+  <literal>0.1</literal>. <emphasis>Lower</emphasis> threshold values imply 
+  <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
+  case of over-detections.</para>
 
   </listitem>
@@ -135 +146 @@
   <option>--jack</option></term>
   <listitem>
-<para>Run in jack mode (default when started without input file) and creates a midi output.</para>
+  <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>-v</option>
+  <option>--verbose</option></term>
+  <listitem>
+  <para>Show results on the console (default).</para>
   </listitem>
   </varlistentry>
@@ -142 +160 @@
   <option>--help</option></term>
   <listitem>
-<para>Show summary of options.</para>
-  </listitem>
-  </varlistentry>
-  <varlistentry>
-  <term><option>-v</option>
-  <option>--verbose</option></term>
-  <listitem>
-<para>Show results on the console.</para>
-
+  <para>Show summary of options.</para>
   </listitem>
   </varlistentry>
@@ -156 +166 @@
 
   </refsect1>
+  <refsect1>
+  <title>BUGS</title>
+
+  <para>For now the program has only been tested on audio signals sampled at
+  44.1&nbsp;kHz.</para>
+
+  </refsect1>
+
   <refsect1>
     <title>SEE ALSO</title>
@@ -161 +179 @@
     <para>
     <command>aubioonset</command>(1)
+    <command>aubionotes</command>(1)
     <command>aubiocut</command>(1)
-    <command>aubionotes</command>(1)
     <command>aubiopitch</command>(1)
     </para>
 
   </refsect1>
-
-<refsect1>
-<title>BUGS</title>
-
-<para>For now the program has been only tested on audio signals sampled at 44.1
-kHz.</para>
-
-</refsect1>
 
   <refsect1>
@@ -208 +218 @@
 
 
-