Changeset 8d0b707 for doc


Ignore:
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:
3 added
3 edited

Legend:

Unmodified
Added
Removed
  • doc/Makefile.am

    r06156a6 r8d0b707  
    11EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \
    22        aubionotes.sgml aubioonset.sgml \
    3         aubioonset.1 aubionotes.1
     3        aubiocut.sgml aubiopitch.sgml aubiotrack.sgml \
     4        aubioonset.1 aubionotes.1 \
     5        aubiocut.1 aubiopitch.1 aubiotrack.1
    46
    5 man_MANS = aubionotes.1 aubioonset.1
     7man_MANS = aubionotes.1 aubioonset.1 \
     8        aubiocut.1 aubiopitch.1 aubiotrack.1
    69CLEANFILES = $(man_MANS)
    710
  • doc/aubionotes.sgml

    r06156a6 r8d0b707  
    7272    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
    7373
    74 <para>The library <emphasis>aubio</emphasis> provides a small set of functions
    75 to extract events and objects from audio, from live streams or still files.
    76 Onsets are used to label the beginning of notes, pitches to label their
    77 height.</para>
    78 
    79 <para><command>aubionotes</command> is still in an experimental state. Its aim
    80 is to segment notes with onsets, and label them with their detected pitch. When
    81 started without an input file argument (<option>-i</option>), aubionotes
    82 creates a jack input and a midi output. When an input file is given, it outputs
    83 the results on the console.</para>
     74    <para><command>&dhpackage;</command> is still in an experimental state.
     75    Its aim is to extract the melody and output it as a midi stream with a
     76    minimal deleay. Pitch candidates are selected at each frame, onset and
     77    silences are used to segment the notes.</para>
     78
     79    <para>When started without an input file argument (<option>-i</option>),
     80    aubionotes creates a jack input and a midi output. When an input file is
     81    given, it outputs the results on the console.</para>
     82
    8483
    8584  </refsect1>
     
    8786    <title>OPTIONS</title>
    8887
    89 <para>This program follows the usual GNU command line syntax, with long options
    90 starting with two dashes (`-').  A summary of options is included below.</para>
     88    <para>This program follows the usual GNU command line syntax, with long
     89    options starting with two dashes (`-').  A summary of options is included
     90    below.</para>
    9191
    9292<variablelist>
     
    175175    <title>SEE ALSO</title>
    176176
    177     <para><command>aubioonset</command> (1)</para>
     177    <para>
     178    <command>aubioonset</command>(1)
     179    <command>aubiotrack</command>(1)
     180    <command>aubionotes</command>(1)
     181    <command>aubiopitch</command>(1)
     182    </para>
    178183
    179184  </refsect1>
  • doc/aubioonset.sgml

    r06156a6 r8d0b707  
    160160
    161161  </refsect1>
    162   <refsect1>
    163     <title>SEE ALSO</title>
    164 
    165     <para><command>aubionotes</command> (1)</para>
    166 
    167   </refsect1>
    168 
    169162<refsect1>
    170163<title>BUGS</title>
     
    174167
    175168</refsect1>
     169
     170  <refsect1>
     171    <title>SEE ALSO</title>
     172
     173        <para>
     174        <command>aubiocut</command>(1)
     175        <command>aubiotrack</command>(1)
     176        <command>aubionotes</command>(1)
     177        <command>aubiopitch</command>(1)
     178        </para>
     179
     180
     181  </refsect1>
    176182
    177183  <refsect1>
Note: See TracChangeset for help on using the changeset viewer.