source: multimedia/cdwriteutils/libisoburn.xml

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

Tag most of multimedia (kwave remains)
  • 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 libisoburn-download-http
8 "https://files.libburnia-project.org/releases/libisoburn-&libisoburn-version;.tar.gz">
9 <!ENTITY libisoburn-download-ftp " ">
10 <!ENTITY libisoburn-md5sum "efb19f7f718f0791f717b2c6094995ec">
11 <!ENTITY libisoburn-size "1.5 MB">
12 <!ENTITY libisoburn-buildsize "20 MB (with Tk and HTML documentation)">
13 <!ENTITY libisoburn-time "0.2 SBU (with Tk and HTML documentation)">
14]>
15
16<sect1 id="libisoburn" xreflabel="libisoburn-&libisoburn-version;">
17 <?dbhtml filename="libisoburn.html"?>
18
19
20 <title>libisoburn-&libisoburn-version;</title>
21
22 <indexterm zone="libisoburn">
23 <primary sortas="a-libisoburn">libisoburn</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to libisoburn</title>
28
29 <para>
30 <application>libisoburn</application> is a frontend for libraries
31 <application>libburn</application> and <application>libisofs</application>
32 which enables creation and expansion of ISO-9660 filesystems on all
33 CD/DVD/BD media supported by <application>libburn</application>. This
34 includes media like DVD+RW, which do not support multi-session management
35 on media level and even plain disk files or block devices.
36 </para>
37
38 &lfs121_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&libisoburn-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&libisoburn-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &libisoburn-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &libisoburn-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &libisoburn-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &libisoburn-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">libisoburn Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="libburn"/> and
79 <xref linkend="libisofs"/>
80 </para>
81
82 <bridgehead renderas="sect4">Optional</bridgehead>
83 <para>
84 <xref linkend="doxygen"/> (to generate HTML documentation),
85 <xref linkend="tk"/> (for <command>xorriso-tcltk</command>), and
86 <ulink url="https://www.einval.com/~steve/software/JTE/">libjte</ulink>
87 </para>
88
89 </sect2>
90
91 <sect2 role="installation">
92 <title>Installation of libisoburn</title>
93
94 <para>
95 Install <application>libisoburn</application> by running the following
96 commands:
97 </para>
98
99<screen><userinput>./configure --prefix=/usr \
100 --disable-static \
101 --enable-pkg-check-modules &amp;&amp;
102make</userinput></screen>
103
104 <para>
105 If you have installed <application>Doxygen</application> and wish to
106 generate the HTML documentation, issue the following command:
107 </para>
108
109<screen remap="doc"><userinput>doxygen doc/doxygen.conf</userinput></screen>
110
111 <para>
112 This package does not come with a test suite.
113 </para>
114
115 <para>
116 Now, as the <systemitem class="username">root</systemitem> user:
117 </para>
118
119<screen role="root"><userinput>make install</userinput></screen>
120
121 <para>
122 If you have built the HTML documentation, install it by running the
123 following commands as the
124 <systemitem class="username">root</systemitem> user:
125 </para>
126
127<screen role="root"
128 remap="doc"><userinput>install -v -dm755 /usr/share/doc/libisoburn-&libisoburn-version; &amp;&amp;
129install -v -m644 doc/html/* /usr/share/doc/libisoburn-&libisoburn-version;</userinput></screen>
130
131 </sect2>
132
133 <sect2 role="commands">
134 <title>Command Explanations</title>
135
136 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
137 href="../../xincludes/static-libraries.xml"/>
138
139 <para>
140 <parameter>--enable-pkg-check-modules</parameter>: Enable
141 <application>pkg-config</application> check for
142 <application>libburn</application> and
143 <application>libisofs</application>.
144 </para>
145
146 </sect2>
147
148 <sect2 role="content">
149 <title>Contents</title>
150
151 <segmentedlist>
152 <segtitle>Installed Programs</segtitle>
153 <segtitle>Installed Library</segtitle>
154 <segtitle>Installed Directories</segtitle>
155
156 <seglistitem>
157 <seg>
158 osirrox,
159 xorrecord,
160 xorriso,
161 xorriso-dd-target,
162 xorrisofs, and
163 xorriso-tcltk
164 </seg>
165 <seg>
166 libisoburn.so
167 </seg>
168 <seg>
169 /usr/include/libisoburn and
170 /usr/share/doc/libisoburn-&libisoburn-version;
171 </seg>
172 </seglistitem>
173 </segmentedlist>
174
175 <variablelist>
176 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
177 <?dbfo list-presentation="list"?>
178 <?dbhtml list-presentation="table"?>
179
180 <varlistentry id="osirrox">
181 <term><command>osirrox</command></term>
182 <listitem>
183 <para>
184 is a symbolic link to <command>xorriso</command> that copies files
185 from ISO image to a disk filesystem
186 </para>
187 <indexterm zone="libisoburn osirrox">
188 <primary sortas="b-osirrox">osirrox</primary>
189 </indexterm>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry id="xorrecord">
194 <term><command>xorrecord</command></term>
195 <listitem>
196 <para>
197 is a symbolic link to <command>xorriso</command> that provides a
198 cdrecord type user interface
199 </para>
200 <indexterm zone="libisoburn xorrecord">
201 <primary sortas="b-xorrecord">xorrecord</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="xorriso">
207 <term><command>xorriso</command></term>
208 <listitem>
209 <para>
210 is a program to create, load, manipulate, read, and write ISO 9660
211 filesystem images with Rock Ridge extensions
212 </para>
213 <indexterm zone="libisoburn xorriso">
214 <primary sortas="b-xorriso">xorriso</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="xorriso-dd-target">
220 <term><command>xorriso-dd-target</command></term>
221 <listitem>
222 <para>
223 is a program to check a USB or memory card device to see whether it
224 is suitable for image copying
225 </para>
226 <indexterm zone="libisoburn xorriso-dd-target">
227 <primary sortas="b-xorriso-dd-target">xorriso-dd-target</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="xorrisofs">
233 <term><command>xorrisofs</command></term>
234 <listitem>
235 <para>
236 is a symbolic link to <command>xorriso</command> that provides
237 a mkisofs type user interface
238 </para>
239 <indexterm zone="libisoburn xorrisofs">
240 <primary sortas="b-xorrisofs">xorrisofs</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="xorriso-tcltk">
246 <term><command>xorriso-tcltk</command></term>
247 <listitem>
248 <para>
249 is a frontend that operates xorriso in dialog mode
250 </para>
251 <indexterm zone="libisoburn xorriso-tcltk">
252 <primary sortas="b-xorriso-tcltk">xorriso-tcltk</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="libisoburn-lib">
258 <term><filename class="libraryfile">libisoburn.so</filename></term>
259 <listitem>
260 <para>
261 contains the <application>libisoburn</application> API functions
262 </para>
263 <indexterm zone="libisoburn libisoburn-lib">
264 <primary sortas="c-libisoburn">libisoburn.so</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 </variablelist>
270
271 </sect2>
272
273</sect1>
Note: See TracBrowser for help on using the repository browser.