source: multimedia/audioutils/vorbistools.xml

trunk
Last change on this file was 85a581fd, checked in by Bruce Dubbs <bdubbs@…>, 3 months ago

Tags

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