source: multimedia/audioutils/vorbistools.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 2 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 8.4 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
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 &lfs112_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 <para condition="html" role="usernotes">User Notes:
103 <ulink url="&blfs-wiki;/vorbistools"/>
104 </para>
105 </sect2>
106
107 <sect2 role="installation">
108 <title>Installation of Vorbis Tools</title>
109
110<!-- Applied in 1.4.2
111 <para>
112 First, apply a patch to fix some security issues:
113 </para>
114
115<screen><userinput remap="pre">patch -Np1 -i ../vorbis-tools-&vorbistools-version;-security_fix-1.patch</userinput></screen>
116-->
117
118 <para>
119 Install <application>Vorbis Tools</application> by running the
120 following commands:
121 </para>
122
123<screen><userinput>./configure --prefix=/usr \
124 --enable-vcut \
125 --without-curl &amp;&amp;
126make</userinput></screen>
127
128 <para>
129 This package does not come with a test suite.
130 </para>
131
132 <para>
133 Now, as the <systemitem class="username">root</systemitem> user:
134 </para>
135
136<screen role="root"><userinput>make install</userinput></screen>
137
138 </sect2>
139
140 <sect2 role="commands">
141 <title>Command Explanations</title>
142
143 <para>
144 <parameter>--enable-vcut</parameter>: This parameter is used so that
145 the <command>vcut</command> program is built as it is not by default.
146 </para>
147
148 <para>
149 <parameter>--without-curl</parameter>: This parameter disables HTTP
150 streaming in <command>ogg123</command>. Remove this parameter if you have
151 <application>cURL</application> installed.
152 </para>
153
154 </sect2>
155
156 <sect2 role="configuration">
157 <title>Configuring Vorbis Tools</title>
158
159 <sect3 id="vorbistools-config">
160 <title>Config Files</title>
161
162 <para>
163 <filename>/etc/libao.conf</filename>,
164 <filename>~/.libao</filename> and
165 <filename>~/.ogg123rc</filename>
166 </para>
167
168 <indexterm zone="vorbistools vorbistools-config">
169 <primary sortas="e-AA.libao">~/.libao</primary>
170 </indexterm>
171
172 <indexterm zone="vorbistools vorbistools-config">
173 <primary sortas="e-AA.ogg123rc">~/.ogg123rc</primary>
174 </indexterm>
175
176 <indexterm zone="vorbistools vorbistools-config">
177 <primary sortas="e-etc-libao.conf">/etc/libao.conf</primary>
178 </indexterm>
179
180 </sect3>
181
182 <sect3>
183 <title>Configuration Information</title>
184
185 <para>
186 Issue <command>man libao.conf</command> for information
187 about setting the default output device. Also see
188 <filename>/usr/share/doc/vorbis-tools-&vorbistools-version;/ogg123rc-example
189 </filename>.
190 </para>
191
192 </sect3>
193
194 </sect2>
195
196 <sect2 role="content">
197 <title>Contents</title>
198
199 <segmentedlist>
200 <segtitle>Installed Programs</segtitle>
201 <segtitle>Installed Libraries</segtitle>
202 <segtitle>Installed Directory</segtitle>
203
204 <seglistitem>
205 <seg>
206 ogg123, oggdec, oggenc, ogginfo, vcut and vorbiscomment
207 </seg>
208 <seg>
209 None
210 </seg>
211 <seg>
212 /usr/share/doc/vorbis-tools-&vorbistools-version;
213 </seg>
214 </seglistitem>
215 </segmentedlist>
216
217 <variablelist>
218 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
219 <?dbfo list-presentation="list"?>
220 <?dbhtml list-presentation="table"?>
221
222 <varlistentry id="ogg123">
223 <term><command>ogg123</command></term>
224 <listitem>
225 <para>
226 is a command-line audio player for Ogg Vorbis streams
227 </para>
228 <indexterm zone="vorbistools ogg123">
229 <primary sortas="b-ogg123">ogg123</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="oggdec">
235 <term><command>oggdec</command></term>
236 <listitem>
237 <para>
238 is a simple decoder which converts Ogg Vorbis files into
239 PCM audio files (WAV or raw)
240 </para>
241 <indexterm zone="vorbistools oggdec">
242 <primary sortas="b-oggdec">oggdec</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="oggenc">
248 <term><command>oggenc</command></term>
249 <listitem>
250 <para>
251 is an encoder that turns raw, WAV or
252 AIFF files into an Ogg Vorbis stream
253 </para>
254 <indexterm zone="vorbistools oggenc">
255 <primary sortas="b-oggenc">oggenc</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="ogginfo">
261 <term><command>ogginfo</command></term>
262 <listitem>
263 <para>
264 prints information stored in an audio file
265 </para>
266 <indexterm zone="vorbistools ogginfo">
267 <primary sortas="b-ogginfo">ogginfo</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="vcut">
273 <term><command>vcut</command></term>
274 <listitem>
275 <para>
276 splits a file into two files at a designated cut point
277 </para>
278 <indexterm zone="vorbistools vcut">
279 <primary sortas="b-vcut">vcut</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="vorbiscomment">
285 <term><command>vorbiscomment</command></term>
286 <listitem>
287 <para>
288 is an editor that changes information in the audio file
289 metadata tags
290 </para>
291 <indexterm zone="vorbistools vorbiscomment">
292 <primary sortas="b-vorbiscomment">vorbiscomment</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 </variablelist>
298
299 </sect2>
300
301</sect1>
Note: See TracBrowser for help on using the repository browser.