source: multimedia/audioutils/vorbistools.xml

trunk
Last change on this file was 181e069f, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Tag all perl modules
  • Property mode set to 100644
File size: 8.3 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY vorbistools-download-http "https://downloads.xiph.org/releases/vorbis/vorbis-tools-&vorbistools-version;.tar.gz">
8 <!ENTITY vorbistools-download-ftp " ">
9 <!ENTITY vorbistools-md5sum "998fca293bd4e4bdc2b96fb70f952f4e">
10 <!ENTITY vorbistools-size "1.3 MB">
11 <!ENTITY vorbistools-buildsize "12 MB">
12 <!ENTITY vorbistools-time "0.1 SBU">
13]>
14
15<sect1 id="vorbistools" xreflabel="vorbis-tools-&vorbistools-version;">
16 <?dbhtml filename="vorbistools.html"?>
17
18
19 <title>vorbis-tools-&vorbistools-version;</title>
20
21 <indexterm zone="vorbistools">
22 <primary sortas="a-Vorbis-Tools">Vorbis Tools</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Vorbis Tools</title>
27
28 <para>
29 The <application>Vorbis Tools</application> package contains
30 command-line tools useful for encoding, playing or editing
31 files using the Ogg CODEC.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&vorbistools-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&vorbistools-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &vorbistools-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &vorbistools-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &vorbistools-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &vorbistools-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70<!-- Applied in 1.4.2
71 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
72 <itemizedlist spacing="compact">
73 <listitem>
74 <para>
75 Required patch:
76 <ulink url="&patch-root;/vorbis-tools-&vorbistools-version;-security_fix-1.patch"/>
77 </para>
78 </listitem>
79 </itemizedlist>
80-->
81 <bridgehead renderas="sect3">Vorbis Tools Dependencies</bridgehead>
82
83 <bridgehead renderas="sect4">Required</bridgehead>
84 <para role="required">
85 <xref linkend="libvorbis"/>
86 </para>
87
88 <bridgehead renderas="sect4">Optional (required to build the
89 <command>ogg123</command> program)</bridgehead>
90 <para role="optional">
91 <xref linkend="libao"/>
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <xref linkend="curl"/>,
97 <xref linkend="flac"/>,
98 <xref linkend="speex"/>, and
99 <ulink url="https://code.google.com/archive/p/libkate/">libkate</ulink>
100 </para>
101
102 </sect2>
103
104 <sect2 role="installation">
105 <title>Installation of Vorbis Tools</title>
106
107<!-- Applied in 1.4.2
108 <para>
109 First, apply a patch to fix some security issues:
110 </para>
111
112<screen><userinput remap="pre">patch -Np1 -i ../vorbis-tools-&vorbistools-version;-security_fix-1.patch</userinput></screen>
113-->
114
115 <para>
116 Install <application>Vorbis Tools</application> by running the
117 following commands:
118 </para>
119
120<screen><userinput>./configure --prefix=/usr \
121 --enable-vcut \
122 --without-curl &amp;&amp;
123make</userinput></screen>
124
125 <para>
126 This package does not come with a test suite.
127 </para>
128
129 <para>
130 Now, as the <systemitem class="username">root</systemitem> user:
131 </para>
132
133<screen role="root"><userinput>make install</userinput></screen>
134
135 </sect2>
136
137 <sect2 role="commands">
138 <title>Command Explanations</title>
139
140 <para>
141 <parameter>--enable-vcut</parameter>: This parameter is used so that
142 the <command>vcut</command> program is built as it is not by default.
143 </para>
144
145 <para>
146 <parameter>--without-curl</parameter>: This parameter disables HTTP
147 streaming in <command>ogg123</command>. Remove this parameter if you have
148 <application>cURL</application> installed.
149 </para>
150
151 </sect2>
152
153 <sect2 role="configuration">
154 <title>Configuring Vorbis Tools</title>
155
156 <sect3 id="vorbistools-config">
157 <title>Config Files</title>
158
159 <para>
160 <filename>/etc/libao.conf</filename>,
161 <filename>~/.libao</filename> and
162 <filename>~/.ogg123rc</filename>
163 </para>
164
165 <indexterm zone="vorbistools vorbistools-config">
166 <primary sortas="e-AA.libao">~/.libao</primary>
167 </indexterm>
168
169 <indexterm zone="vorbistools vorbistools-config">
170 <primary sortas="e-AA.ogg123rc">~/.ogg123rc</primary>
171 </indexterm>
172
173 <indexterm zone="vorbistools vorbistools-config">
174 <primary sortas="e-etc-libao.conf">/etc/libao.conf</primary>
175 </indexterm>
176
177 </sect3>
178
179 <sect3>
180 <title>Configuration Information</title>
181
182 <para>
183 Issue <command>man libao.conf</command> for information
184 about setting the default output device. Also see
185 <filename>/usr/share/doc/vorbis-tools-&vorbistools-version;/ogg123rc-example
186 </filename>.
187 </para>
188
189 </sect3>
190
191 </sect2>
192
193 <sect2 role="content">
194 <title>Contents</title>
195
196 <segmentedlist>
197 <segtitle>Installed Programs</segtitle>
198 <segtitle>Installed Libraries</segtitle>
199 <segtitle>Installed Directory</segtitle>
200
201 <seglistitem>
202 <seg>
203 ogg123, oggdec, oggenc, ogginfo, vcut and vorbiscomment
204 </seg>
205 <seg>
206 None
207 </seg>
208 <seg>
209 /usr/share/doc/vorbis-tools-&vorbistools-version;
210 </seg>
211 </seglistitem>
212 </segmentedlist>
213
214 <variablelist>
215 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
216 <?dbfo list-presentation="list"?>
217 <?dbhtml list-presentation="table"?>
218
219 <varlistentry id="ogg123">
220 <term><command>ogg123</command></term>
221 <listitem>
222 <para>
223 is a command-line audio player for Ogg Vorbis streams
224 </para>
225 <indexterm zone="vorbistools ogg123">
226 <primary sortas="b-ogg123">ogg123</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="oggdec">
232 <term><command>oggdec</command></term>
233 <listitem>
234 <para>
235 is a simple decoder which converts Ogg Vorbis files into
236 PCM audio files (WAV or raw)
237 </para>
238 <indexterm zone="vorbistools oggdec">
239 <primary sortas="b-oggdec">oggdec</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="oggenc">
245 <term><command>oggenc</command></term>
246 <listitem>
247 <para>
248 is an encoder that turns raw, WAV or
249 AIFF files into an Ogg Vorbis stream
250 </para>
251 <indexterm zone="vorbistools oggenc">
252 <primary sortas="b-oggenc">oggenc</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="ogginfo">
258 <term><command>ogginfo</command></term>
259 <listitem>
260 <para>
261 prints information stored in an audio file
262 </para>
263 <indexterm zone="vorbistools ogginfo">
264 <primary sortas="b-ogginfo">ogginfo</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="vcut">
270 <term><command>vcut</command></term>
271 <listitem>
272 <para>
273 splits a file into two files at a designated cut point
274 </para>
275 <indexterm zone="vorbistools vcut">
276 <primary sortas="b-vcut">vcut</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="vorbiscomment">
282 <term><command>vorbiscomment</command></term>
283 <listitem>
284 <para>
285 is an editor that changes information in the audio file
286 metadata tags
287 </para>
288 <indexterm zone="vorbistools vorbiscomment">
289 <primary sortas="b-vorbiscomment">vorbiscomment</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 </variablelist>
295
296 </sect2>
297
298</sect1>
Note: See TracBrowser for help on using the repository browser.