<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

  <!ENTITY dhfirstname "<firstname>Robert</firstname>">
  <!ENTITY dhsurname   "<surname>Jordens</surname>">
  <!ENTITY dhdate      "<date>Mai  9, 2002</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>jordens@debian.org</email>">
  <!ENTITY dhusername  "Robert Jordens">
  <!ENTITY dhucpackage "<refentrytitle>TIMEMACHINE</refentrytitle>">
  <!ENTITY dhpackage   "timemachine">
  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>JACK audio recorder for spontaneous and conservatory use
    </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
		<!-- [-c channels] [-n jack-name] [-p file prefix]-->
      <arg><option>-h</option></arg>
	  <arg><option>-c</option> &lt;number of channels&gt;</arg>
	  <arg><option>-n</option> &lt;JACK client name&gt;</arg>
	  <arg><option>-p</option> &lt;file prefix&gt;</arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> tool.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

        <para><command>&dhpackage;</command> writes the last 10
        seconds of audio _before_ the button press and everything from now 
        on up to the next button press into a WAV-file. </para>
        <para>The idea is that you doodle away with whatever is kicking 
        around in your studio and when you heard an interesting noise, you'd 
        press record and capture it, without having to try and recreate it.
        </para>
        <para>Run it with <command>&dhpackage;</command> then connect it up with 
        a jack patchbay app. To start recording click in the window, to 
        stop recording click in the window again.</para>
        <para>It will create a file following tm-*.wav, with an 
        ISO 8601 timestamp, eg tm-2003-01-19T20:47:03.wav. The time is the 
        time that the recording starts from, not when you click.</para>
        <para>It uses the JACK audio connection kit, an API that lets audio 
        application communicate with each other and share audio data in 
        realtime. </para>

        <para>The generated file will be a W64 file, a valid but
        unusual WAV format that might not be recognized by some
        programs. Binaries linked with libsndfile should be able to
        read it. Also, note that the sample rate of the file with be
        the same as the sample rate <command>jackd</command> is
        running at when <command>&dhpackage;</command> is started.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>
        </term>
        <listitem>
          <para>Help: show available flags.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c &lt;number of channels&gt;</option>
        </term>
        <listitem>
          <para>Specifies the numer of channels to listen on, record and write 
          to the file. Valind numbers: 1-8, 2 is the default.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n &lt;jack-name&gt;</option>
        </term>
        <listitem>
          <para>Name with which to register as a JACK client. Defaults 
          to "TimeMachine".</para>
        </listitem>
      </varlistentry>
     <varlistentry>
        <term><option>-p &lt;file prefix&gt;</option>
        </term>
        <listitem>
          <para>The prefix for WAV files to be written. Defaults to "tm-".</para>
        </listitem>
      </varlistentry>
    </variablelist>


  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>jackd(1)</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
	<para>This manual page was written by &dhusername; &dhemail; for the
	&debian; system (but may be used by others).  Permission is granted
	to copy, distribute and/or modify this document under the terms of
	the <acronym>GNU</acronym> General Public License, Version 2. On
	Debian systems, the full text of this license can be found in the
	file /usr/share/common-licenses/GPL-2.</para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


