doc/aubiomfcc.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3 <!-- Process this file with docbook-to-man to generate an nroff manual
   4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
   5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
   6      less'.  A typical entry in a Makefile or Makefile.am is:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10
  11
  12         The docbook-to-man binary is found in the docbook-to-man package.
  13         Please remember that if you create the nroff version in one of the
  14         debian/rules file targets (such as build), you will need to include
  15         docbook-to-man in your Build-Depends control field.
  16
  17   -->
  18
  19   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  20   <!ENTITY dhfirstname "<firstname>Paul</firstname>">
  21   <!ENTITY dhsurname   "<surname>Brossier</surname>">
  22   <!-- Please adjust the date whenever revising the manpage. -->
  23   <!ENTITY dhdate      "<date>December 1, 2004</date>">
  24   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  25        allowed: see man(7), man(1). -->
  26   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  27   <!ENTITY dhemail     "<email>piem@aubio.org</email>">
  28   <!ENTITY dhusername  "Paul Brossier">
  29   <!ENTITY dhucpackage "<refentrytitle>AUBIOMFCC</refentrytitle>">
  30   <!ENTITY dhpackage   "aubiomfcc">
  31
  32   <!ENTITY debian      "<productname>Debian</productname>">
  33   <!ENTITY gnu         "<acronym>GNU</acronym>">
  34   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  35 ]>
  36
  37 <refentry>
  38   <refentryinfo>
  39     <address>
  40       &dhemail;
  41     </address>
  42     <author>
  43       &dhfirstname;
  44       &dhsurname;
  45     </author>
  46     <copyright>
  47       <year>2003</year>
  48       <holder>&dhusername;</holder>
  49     </copyright>
  50     &dhdate;
  51   </refentryinfo>
  52   <refmeta>
  53     &dhucpackage;
  54
  55     &dhsection;
  56   </refmeta>
  57   <refnamediv>
  58     <refname>&dhpackage;</refname>
  59
  60     <refpurpose>a command line tool for real time mfcc extraction</refpurpose>
  61
  62   </refnamediv>
  63   <refsynopsisdiv>
  64     <cmdsynopsis>
  65       <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
  66     </cmdsynopsis>
  67   </refsynopsisdiv>
  68   <refsect1>
  69     <title>DESCRIPTION</title>
  70
  71     <para><command>&dhpackage;</command> extracts Mel-Frequency Cepstrum
  72     Coefficients (MFCC) in audio signals.</para>
  73
  74     <para>When started without an input file argument
  75     (<option>--input</option>), <command>&dhpackage;</command> creates jack
  76     input and output ports. When an input file is given, the results are given
  77     on the console.</para>
  78
  79   </refsect1>
  80   <refsect1>
  81     <title>OPTIONS</title>
  82
  83     <para>This program follows the usual GNU command line syntax, with long
  84     options starting with two dashes (`-').  A summary of options is included
  85     below.</para>
  86
  87 <variablelist>
  88   <varlistentry>
  89   <term><option>-i</option>
  90   <option>--input filein</option></term>
  91   <listitem>
  92
  93   <para>Run analysis on this audio file. Most common uncompressed formats are
  94   supported.</para>
  95
  96   </listitem>
  97   </varlistentry>
  98   <varlistentry>
  99   <term><option>-j</option>
 100   <option>--jack</option></term>
 101   <listitem>
 102   <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
 103   </listitem>
 104   </varlistentry>
 105   <varlistentry>
 106   <term><option>-v</option>
 107   <option>--verbose</option></term>
 108   <listitem>
 109   <para>Show results on the console (default).</para>
 110   </listitem>
 111   </varlistentry>
 112   <varlistentry>
 113   <term><option>-h</option>
 114   <option>--help</option></term>
 115   <listitem>
 116   <para>Show summary of options.</para>
 117   </listitem>
 118   </varlistentry>
 119 </variablelist>
 120
 121   </refsect1>
 122   <refsect1>
 123     <title>SEE ALSO</title>
 124
 125     <para>
 126     <command>aubiotrack</command>(1)
 127     <command>aubionotes</command>(1)
 128     <command>aubiocut</command>(1)
 129     <command>aubiopitch</command>(1)
 130     <command>aubioonset</command>(1)
 131     </para>
 132
 133   </refsect1>
 134
 135   <refsect1>
 136     <title>AUTHOR</title>
 137
 138     <para>This manual page was written by &dhusername; (&dhemail;). Permission
 139     is granted to copy, distribute and/or modify this document under the terms
 140     of the &gnu; General Public License, Version 3 any later version published
 141     by the Free Software Foundation.</para>
 142
 143     <para>On Debian systems, the complete text of the GNU General Public
 144     License can be found in /usr/share/common-licenses/GPL.</para>
 145
 146   </refsect1>
 147 </refentry>
 148
 149 <!-- Keep this comment at the end of the file
 150 Local variables:
 151 mode: sgml
 152 sgml-omittag:t
 153 sgml-shorttag:t
 154 sgml-minimize-attributes:nil
 155 sgml-always-quote-attributes:t
 156 sgml-indent-step:2
 157 sgml-indent-data:t
 158 sgml-parent-document:nil
 159 sgml-default-dtd-file:nil
 160 sgml-exposed-tags:nil
 161 sgml-local-catalogs:nil
 162 sgml-local-ecat-files:nil
 163 End:
 164 -->
 165
 166