<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!ENTITY dhfirstname "<firstname>Szabolcs</firstname>">
  <!ENTITY dhsurname   "<surname>Székelyi</surname>">
  <!ENTITY dhdate      "<date>February  8, 2008</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>cc@mail.3d.hu</email>">
  <!ENTITY dhusername  "Székelyi Szabolcs">
  <!ENTITY dhucpackage "<refentrytitle>VAMP-SIMPLE-HOST</refentrytitle>">
  <!ENTITY dhpackage   "vamp-simple-host">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

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

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

    <refpurpose>a simple Vamp plugin host</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg>-s</arg>
      <arg><replaceable>pluginlibrary</replaceable>[.so]:<replaceable>plugin</replaceable>[:<replaceable>output</replaceable>]</arg>
      <arg>file</arg>
      <arg><option>-o</option><replaceable> outfile</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg>-s</arg>
      <arg><replaceable>pluginlibrary</replaceable>[.so]:<replaceable>plugin</replaceable></arg>
      <arg>file</arg>
      <arg>[<replaceable>outputno</replaceable>]</arg>
      <arg><option>-o</option><replaceable> outfile</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

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

    <para><command>&dhpackage;</command> allows processing of a
    libsndfile-readable audio file using Vamp plugins, listing
    available plugins and the plugin search path.</para>

    <para>By default, <command>&dhpackage;</command> loads plugin
       id <replaceable>plugin</replaceable> from
       <replaceable>pluginlibrary</replaceable> and runs it on the
       audio data in <replaceable>file</replaceable>, retrieving the
       named <replaceable>output</replaceable>, or output number
       <replaceable>outputno</replaceable> (the first output by
       default) and dumping it to standard output, or
       to <replaceable>outfile</replaceable> if
       the <option>-o</option> option is given.</para>

    <para><replaceable>pluginlibrary</replaceable> should be a library
       name, not a file path; the standard Vamp library search path
       will be used to locate it.  If a file path is supplied, the
       directory part(s) will be ignored.</para>

    <para>If the <option>-s</option> option is given, results will be
       labelled with the audio sample frame at which they
       occur. Otherwise, they will be labelled with time in
       seconds.</para>

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

    <variablelist>
      <varlistentry>
        <term><option>-l</option>, <option>--list</option></term>
        <listitem>
          <para>List the plugin libraries and Vamp plugins in the
          library search path in a verbose human-readable format.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--list-full</option></term>
        <listitem>
          <para>List all data reported by all the Vamp plugins in the
          library search path in a very verbose human-readable
          format.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--list-ids</option></term>
        <listitem>
          <para>List the plugins in the search path in a terse
          machine-readable format, in the form
          vamp:soname:identifier.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--list-outputs</option></term>
        <listitem>
          <para>List the outputs for plugins in the search path in a
          machine-readable format, in the form
          vamp:soname:identifier:output.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--list-by-category</option></term>
        <listitem>
          <para>List the plugins as a plugin index by category, in a
          machine-readable format. The format may change in future
          releases.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option></term>
        <listitem>
          <para>Print out the Vamp library search path.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option></term>
        <listitem>
          <para>Label results with the audio sample frame at which
	    they occur. Otherwise, they will be labelled with time in
	    seconds.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o <replaceable>file</replaceable></option></term>
        <listitem>
          <para>Dump plugin output
          into <replaceable>file</replaceable>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option></term>
        <listitem>
          <para>Display version information only.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>ENVIRONMENT</title>

    <variablelist>
      <varlistentry>
	<term>VAMP_PATH</term>
	<listitem>
	  <para>A colon-separated list of directories to look for
	  plugins.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others), because the
      original program does not have a manual page.  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any
      later version published by the Free Software Foundation.</para>
    <para>
      On Debian systems, the complete text of the GNU General Public
      License can be found in /usr/share/common-licenses/GPL.</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:
-->
