Changeset 36bc60c


Ignore:
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:
5 edited

Legend:

Unmodified
Added
Removed
  • TODO

    rb073447 r36bc60c  
    11TODO
    22====
    3 
    4 Doc
    5 ---
    6 
    7 - update doc
    8 - complete manpages
    93
    104Library
  • doc/Makefile.am

    rb073447 r36bc60c  
    22#man_MANS = fluidsynth.1
    33#EXTRA_DIST = $(man_MANS) devel.cfg fluidsynth.1
    4 EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css
     4EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \
     5        aubionotes.sgml aubioonset.sgml
    56
    67#docbook_docs = aubio-devdoc.xml
  • doc/Makefile.in

    rb073447 r36bc60c  
    156156#man_MANS = fluidsynth.1
    157157#EXTRA_DIST = $(man_MANS) devel.cfg fluidsynth.1
    158 EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css
     158EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \
     159        aubionotes.sgml aubioonset.sgml
     160
    159161subdir = doc
    160162ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
  • doc/aubionotes.sgml

    rb073447 r36bc60c  
    7070    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
    7171
    72 <para>The library <emphasis remap='B'>aubio</emphasis> provides a small set of functions to extract events and
    73 objects from audio, from live streams or still files. Onsets are used to label
    74 the beginning of notes, pitches to label their height.</para>
    75 
    76 <para><command>aubionotes</command> is still in an experimental state. Its aim is to segment notes
    77 with onsets, and label them with their detected pitch. When started without an
    78 input file argument (<option>-i</option>), aubionotes creates a jack input and a midi
    79 output. When an input file is given, it outputs the results on the console.</para>
     72<para>The library <emphasis>aubio</emphasis> provides a small set of functions
     73to extract events and objects from audio, from live streams or still files.
     74Onsets are used to label the beginning of notes, pitches to label their
     75height.</para>
     76
     77<para><command>aubionotes</command> is still in an experimental state. Its aim
     78is to segment notes with onsets, and label them with their detected pitch. When
     79started without an input file argument (<option>-i</option>), aubionotes
     80creates a jack input and a midi output. When an input file is given, it outputs
     81the results on the console.</para>
    8082
    8183  </refsect1>
     
    8385    <title>OPTIONS</title>
    8486
    85 <para>This program follows the usual GNU command line syntax, with long
    86 options starting with two dashes (`-').
    87 A summary of options is included below.</para>
     87<para>This program follows the usual GNU command line syntax, with long options
     88starting with two dashes (`-').  A summary of options is included below.</para>
     89
    8890<variablelist>
    8991  <varlistentry>
     
    99101  <option>--output fileout</option></term>
    100102  <listitem>
    101 <para>Save results in this file. The file will be created on the model of the input
    102 file. Results are marked by a very short wood-block sample.</para>
     103<para>Save results in this file. The file will be created on the model of the
     104input file. Results are marked by a very short wood-block sample.</para>
    103105  </listitem>
    104106  </varlistentry>
     
    110112<literal>0.001</literal> and <literal>0.900</literal>. Default is <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
    111113sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
     114  </listitem>
     115  </varlistentry>
     116  <varlistentry>
     117  <term><option>-O</option>
     118  <option>--onset value</option></term>
     119  <listitem>
     120
     121  <para>The onset detection function to run. Can be one of
     122  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
     123  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
     124  <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
     125  complex domain and HFC are used in parallel.</para>
     126
    112127  </listitem>
    113128  </varlistentry>
  • doc/aubioonset.sgml

    rb073447 r36bc60c  
    113113  </varlistentry>
    114114  <varlistentry>
     115  <term><option>-O</option>
     116  <option>--onset value</option></term>
     117  <listitem>
     118
     119  <para>The onset detection function to run. Can be one of
     120  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
     121  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
     122  <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
     123  complex domain and HFC are used in parallel.</para>
     124
     125  </listitem>
     126  </varlistentry>
     127  <varlistentry>
    115128  <term><option>-j</option>
    116129  <option>--jack</option></term>
Note: See TracChangeset for help on using the changeset viewer.