source: multimedia/videoutils/vlc.xml@ 3d6e95d

systemd-13485
Last change on this file since 3d6e95d was 3d6e95d, checked in by Douglas R. Reno <renodr@…>, 8 years ago

(systemd) Merge to trunk r17470

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17472 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 14.1 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 vlc-download-http "&sources-anduin-http;/vlc/vlc-&vlc-version;.tar.xz">
8 <!ENTITY vlc-download-ftp "&sources-anduin-ftp;/vlc/vlc-&vlc-version;.tar.xz">
9 <!ENTITY vlc-md5sum "ea02989ea69f8eda65a4dcf73982eed2">
10 <!ENTITY vlc-size "20 MB">
11 <!ENTITY vlc-buildsize "673 MB (add 4 MB for tests)">
12 <!ENTITY vlc-time "6.0 SBU (add 0.2 SBU for tests)">
13]>
14
15<sect1 id="vlc" xreflabel="VLC-&vlc-version;">
16 <?dbhtml filename="vlc.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>VLC-&vlc-version;</title>
24
25 <indexterm zone="vlc">
26 <primary sortas="a-VLC">VLC</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to VLC</title>
31
32 <para>
33 <application>VLC</application> is a media player, streamer, and encoder.
34 It can play from many inputs, such as files, network streams, capture
35 devices, desktops, or DVD, SVCD, VCD, and audio CD. It can use most audio
36 and video codecs (MPEG 1/2/4, H264, VC-1, DivX, WMV, Vorbis, AC3, AAC,
37 etc.), and it can also convert to different formats and/or send streams
38 through the network.
39 </para>
40
41 &lfs78_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&vlc-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&vlc-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &vlc-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &vlc-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &vlc-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &vlc-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">VLC Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <xref linkend="alsa-lib"/>,
82 <xref linkend="ffmpeg"/>,
83 <xref linkend="liba52"/>,
84 <xref linkend="libgcrypt"/>
85 <xref linkend="libmad"/>,
86 <xref linkend="lua"/>, and
87 <xref linkend="x-window-system"/>,
88 </para>
89
90 <bridgehead renderas="sect4">Optional features and packages</bridgehead>
91 <para role="optional">
92 <xref linkend="dbus"/>
93 </para>
94
95 <bridgehead renderas="sect4">Optional input plugins</bridgehead>
96 <para role="optional">
97
98 <xref linkend="libdv"/>,
99 <xref linkend="libdvdcss"/>,
100 <xref linkend="libdvdread"/>,
101 <xref linkend="libdvdnav"/>,
102 <xref linkend="opencv"/>,
103 <xref linkend="samba"/>,
104 <xref linkend="v4l-utils"/>,
105 <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
106 <ulink url="http://sourceforge.net/projects/libdc1394/">libdc1394</ulink>,
107 <ulink url="http://sourceforge.net/projects/libcddb/">libcddb</ulink>,
108 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
109 <ulink url="http://www.live555.com/">Live555</ulink>, and
110 <ulink url="http://www.gnu.org/software/vcdimager/">VCDImager</ulink>
111 (requires <xref linkend="libcdio"/>)
112 </para>
113
114 <bridgehead renderas="sect4">Optional mux/demux plugins</bridgehead>
115 <para role="optional">
116 <xref linkend="libogg"/>,
117 <ulink url="https://github.com/kode54/Game_Music_Emu">Game Music Emu</ulink>,
118 <ulink url="http://www.videolan.org/developers/libdvbpsi.html">libdvbpsi</ulink>,
119 <ulink url="http://downloads.xiph.org/releases/libshout/">libshout</ulink>,
120 <ulink url="http://dl.matroska.org/downloads/libmatroska/">libmatroska</ulink>
121 (requires <ulink url="http://dl.matroska.org/downloads/libebml/">libebml</ulink>),
122 <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
123 <ulink url="http://www.musepack.net/">Musepack</ulink>, and
124 <ulink url="http://sourceforge.net/projects/sidplay2/">sidplay-libs</ulink>
125 </para>
126
127 <bridgehead renderas="sect4">Optional codec plugins</bridgehead>
128 <para role="optional">
129 <xref linkend="faad2"/>,
130 <xref linkend="flac"/>,
131 <xref linkend="libass"/>,
132 <xref linkend="libmpeg2"/>,
133 <xref linkend="libpng"/>,
134 <xref linkend="libtheora"/>,
135 <xref linkend="libva"/>,
136 <xref linkend="libvorbis"/>,
137 <xref linkend="opus"/>,
138 <xref linkend="speex"/>,
139 <xref linkend="x264"/>,
140 <ulink url="http://sourceforge.net/projects/dirac/">Dirac</ulink>,
141 <ulink url="http://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
142 <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>,
143 <ulink url="http://code.google.com/p/libkate/">libkate</ulink>,
144 <ulink url="http://www.khronos.org/openmax/">OpenMAX</ulink>,
145 <ulink url="http://sourceforge.net/projects/schrodinger/">Schroedinger</ulink>,
146 <ulink url="http://wiki.xiph.org/Tremor">Tremor</ulink>,
147 <ulink url="http://www.twolame.org/">Twolame</ulink>, and
148 <ulink url="http://sourceforge.net/projects/zapping/">Zapping VBI</ulink>
149 </para>
150
151 <bridgehead renderas="sect4">Optional video plugins</bridgehead>
152 <para role="optional">
153 <xref linkend="aalib"/>,
154 <xref linkend="fontconfig"/>,
155 <xref linkend="freetype2"/>,
156 <xref linkend="fribidi"/>,
157 <xref linkend="librsvg"/>,
158 <xref linkend="libvdpau"/>,
159 <xref linkend="sdl"/>
160 (with <ulink url="http://www.libsdl.org/projects/SDL_image/">SDL_image</ulink>), and
161 <ulink url="http://caca.zoy.org/">libcaca</ulink>
162 </para>
163
164 <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
165 <para role="optional">
166 <xref linkend="pulseaudio"/>,
167 <xref linkend="libsamplerate"/>, and
168 <ulink url="http://jackaudio.org/">JACK</ulink>
169 </para>
170
171 <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
172 <para role="optional">
173 <xref linkend="qt5"/> (for the GUI and plugins),
174 <ulink url="http://pkgbuild.com/~giovanni/libtar/">libtar</ulink>, and
175 <ulink url="http://www.lirc.org/">LIRC</ulink>
176 </para>
177
178 <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
179 <para role="optional">
180 <ulink url="http://sourceforge.net/projects/goom/">Goom</ulink> and
181 <ulink url="http://sourceforge.net/projects/projectm/">projectM</ulink>
182 </para>
183
184 <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
185 <para role="optional">
186 <xref linkend="avahi"/>,
187 <ulink url="http://sourceforge.net/projects/libmtp/">libmtp</ulink> and
188 <ulink url="http://sourceforge.net/projects/pupnp/">libupnp</ulink>
189 </para>
190
191 <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
192 <para role="optional">
193 <xref linkend="gnutls"/>,
194 <xref linkend="libnotify"/>,
195 <xref linkend="libxml2"/>,
196 <xref linkend="taglib"/>, and
197 <xref linkend="xdg-utils"/> (runtime)
198 </para>
199
200 <para condition="html" role="usernotes">
201 User Notes: <ulink url="&blfs-wiki;/vlc"/>
202 </para>
203 </sect2>
204
205 <sect2 role="installation">
206 <title>Installation of VLC</title>
207
208 <para>
209 If you wish to avoid many invalid warnings, issue:
210 </para>
211<screen><userinput>sed -i '/seems to be moved/s/^/#/' autotools/ltmain.sh</userinput></screen>
212
213 <para>
214 Install <application>VLC</application> by running the following commands:
215 </para>
216
217<screen><userinput>BUILDCC=gcc \
218CFLAGS="-I $XORG_PREFIX/include" \
219./configure --prefix=/usr &amp;&amp;
220
221make</userinput></screen>
222
223 <para>
224 Again, if both Qt4 and 5 are installed, restore
225 <envar>PKG_CONFIG_PATH</envar>:
226 </para>
227
228<screen><userinput>PKG_CONFIG_PATH=$SAVEPATH &amp;&amp;
229unset SAVEPATH</userinput></screen>
230
231 <para>
232 To test the results, issue: <command>make -k check</command>.
233 One test fails for unknown reasons.
234 </para>
235
236 <para>
237 Now, as the <systemitem class="username">root</systemitem> user:
238 </para>
239
240 <note>
241 <para>
242 If the XORG_PREFIX is not /usr, make sure the LIBRARY_PATH
243 environment variable is set properly when doing the install, For example:
244 <command>sudo make LIBRARY_PATH=$XORG_PREFIX/lib ... install</command>.
245 </para>
246 </note>
247
248<screen role="root"><userinput>make docdir=/usr/share/doc/vlc-&vlc-version; install</userinput></screen>
249
250 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
251 href="../../xincludes/update-icons-and-desktop.xml"/>
252
253 </sect2>
254
255 <sect2 role="commands">
256 <title>Command Explanations</title>
257
258 <para>
259 <envar>BUILDCC=gcc</envar>: This environment variable
260 is needed for compatibility with <xref linkend="gcc"/>.
261 </para>
262
263 <para>
264 <envar>CFLAGS="-I $XORG_PREFIX/include"</envar>: This environment variable
265 is needed if <application>xorg</application> is not installed in
266 <filename class="directory">/usr</filename>.
267 </para>
268
269 <para>
270 <option>--enable-opencv=no</option>: This switch disables
271 <application>OpenCV</application> suport.
272 </para>
273
274 <para>
275 <option>--disable-lua</option>: Use this switch if you don't have
276 <application>Lua</application> installed.
277 </para>
278
279 <para>
280 <option>--disable-mad</option>: Use this switch if you don't
281 have <application>libmad</application> installed.
282 </para>
283
284 <para>
285 <option>--disable-avcodec --disable-swscale</option>: Use these switches
286 if you don't have <application>FFmpeg</application> installed.
287 </para>
288
289 <para>
290 <option>--disable-a52</option>: Use this switch if you don't have
291 <application>liba52</application> installed.
292 </para>
293
294 <para>
295 <option>--disable-xcb</option>: Use this switch if you don't have
296 <application>X Window System</application> installed.
297 </para>
298
299 <para>
300 <option>--disable-alsa</option>: Use this switch if you don't have
301 <application>ALSA</application> installed.
302 </para>
303
304 <para>
305 <option>--disable-libgcrypt</option>: Use this switch if you don't
306 have <application>libgcrypt</application> installed.
307 </para>
308
309 <note>
310 <para>
311 There are many options to <application>VLC</application>'s
312 <command>configure</command> command. Check the
313 <command>configure --help</command> output for a complete list.
314 </para>
315 </note>
316
317 </sect2>
318
319 <sect2 role="content">
320 <title>Contents</title>
321
322 <segmentedlist>
323 <segtitle>Installed Programs</segtitle>
324 <segtitle>Installed Libraries</segtitle>
325 <segtitle>Installed Directories</segtitle>
326
327 <seglistitem>
328 <seg>
329 cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
330 </seg>
331 <seg>
332 libvlccore.so, libvlc.so and many plugins in
333 /usr/lib/vlc/plugins
334 </seg>
335 <seg>
336 /usr/{include,lib,share}/vlc and
337 /usr/share/doc/vlc-&vlc-version;
338 </seg>
339 </seglistitem>
340 </segmentedlist>
341
342 <variablelist>
343 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
344 <?dbfo list-presentation="list"?>
345 <?dbhtml list-presentation="table"?>
346
347 <varlistentry id="cvlc">
348 <term><command>cvlc</command></term>
349 <listitem>
350 <para>
351 is a script to run VLC with the dummy interface.
352 </para>
353 <indexterm zone="vlc cvlc">
354 <primary sortas="b-cvlc">cvlc</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="nvlc">
360 <term><command>nvlc</command></term>
361 <listitem>
362 <para>
363 is a script to run VLC with the ncurses interface.
364 </para>
365 <indexterm zone="vlc nvlc">
366 <primary sortas="b-nvlc">nvlc</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="qvlc">
372 <term><command>qvlc</command></term>
373 <listitem>
374 <para>
375 is a script to run <application>VLC</application> with the
376 <application>Qt</application> interface.
377 </para>
378 <indexterm zone="vlc qvlc">
379 <primary sortas="b-qvlc">qvlc</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="rvlc">
385 <term><command>rvlc</command></term>
386 <listitem>
387 <para>
388 is a script to run <application>VLC</application> with a command
389 line interface.
390 </para>
391 <indexterm zone="vlc rvlc">
392 <primary sortas="b-rvlc">rvlc</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="svlc">
398 <term><command>svlc</command></term>
399 <listitem>
400 <para>
401 is a script to run <application>VLC</application> with the skins
402 interface.
403 </para>
404 <indexterm zone="vlc svlc">
405 <primary sortas="b-svlc">svlc</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="vlc-prog">
411 <term><command>vlc</command></term>
412 <listitem>
413 <para>
414 is the <application>VLC</application> media player.
415 </para>
416 <indexterm zone="vlc vlc-prog">
417 <primary sortas="b-vlc">vlc</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="vlc-wrapper">
423 <term><command>vlc-wrapper</command></term>
424 <listitem>
425 <para>
426 is a wrapper to drop privileges with <application>VLC</application>.
427 </para>
428 <indexterm zone="vlc vlc-wrapper">
429 <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 </variablelist>
435
436 </sect2>
437
438</sect1>
Note: See TracBrowser for help on using the repository browser.