<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!ENTITY dhfirstname "<firstname>Szabolcs</firstname>">
  <!ENTITY dhsurname   "<surname>Székelyi</surname>">
  <!ENTITY dhdate      "<date>December 26, 2009</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>cc@mail.3d.hu</email>">
  <!ENTITY dhusername  "Székelyi Szabolcs">
  <!ENTITY dhucpackage "<refentrytitle>VAMP-RDF-TEMPLATE-GENERATOR</refentrytitle>">
  <!ENTITY dhpackage   "vamp-rdf-template-generator">

  <!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>2009</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

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

    <refpurpose>create a skeleton RDF description file describing a Vamp plugin library using the Vamp ontology</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-i</option></arg>

      <arg>vamp:<replaceable>soname</replaceable>[:<replaceable>plugin</replaceable>]</arg>

      <arg>...</arg>

    </cmdsynopsis>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><replaceable>PLUGIN_BASE_URI</replaceable></arg>

      <arg><option>-m</option> <replaceable>YOUR_URI</replaceable></arg>

      <arg>[vamp:]<replaceable>soname</replaceable>[:<replaceable>plugin</replaceable>]</arg>

      <arg>...</arg>

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

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</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> is a program to generate RDF
      description templates from binary Vamp libraries. It outputs a
      template for the RDF file describing plugins contained
      in <replaceable>soname</replaceable>, or
      for <replaceable>plugin</replaceable> in <replaceable>soname</replaceable>.  The generated output
      requires manual editing. It will
      contain <replaceable>PLUGIN_BASE_URI</replaceable> as the topic
      and base URI of the description
      and <replaceable>YOUR_URI</replaceable> as the plugin
      maker.</para>

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

    <variablelist>
      <varlistentry>
        <term><option>-i</option>
        </term>
        <listitem>
          <para>Run in interactive mode, prompting for
	    <replaceable>PLUGIN_BASE_URI</replaceable>
	    and <replaceable>YOUR_URI</replaceable>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option> <replaceable>YOUR_URI</replaceable>
	</term>
        <listitem>
          <para>Set the plugin maker
          to <replaceable>YOUR_URI</replaceable>.</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 (and may be used by others).  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:
-->
