File: vamp-rdf-template-generator.sgml

package info (click to toggle)
vamp-plugin-sdk 2.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,508 kB
  • sloc: cpp: 7,551; ansic: 911; makefile: 338; sh: 170; perl: 31
file content (154 lines) | stat: -rw-r--r-- 4,482 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<!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:
-->