<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libisoburn: libisoburn-1.1.8/doc/comments Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libisoburn <span id="projectnumber">1.1.8</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">libisoburn-1.1.8/doc/comments</div> </div>
</div>
<div class="contents">
<a href="comments.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span>
<a name="l00002"></a>00002 <span class="comment"> @author Mario Danic, Vreixo Formoso, Thomas Schmitt</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> @mainpage Libisoburn Documentation Index</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> @section intro Introduction</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">Libburnia is an open-source project for reading, mastering and writing</span>
<a name="l00009"></a>00009 <span class="comment">optical discs. This page is about its capability to read, manipulate, and</span>
<a name="l00010"></a>00010 <span class="comment">write ISO 9660 filesystems with Rock Ridge extensions. Media can be optical</span>
<a name="l00011"></a>00011 <span class="comment">media or filesystem objects.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">Our scope is currently Linux 2.4 and 2.6, or FreeBSD, or OpenSolaris.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">libisoburn is an add-on to libburn and libisofs which coordinates both and</span>
<a name="l00016"></a>00016 <span class="comment">also allows to grow ISO-9660 filesystem images on multi-session media as well</span>
<a name="l00017"></a>00017 <span class="comment">as on overwriteable media via the same API.</span>
<a name="l00018"></a>00018 <span class="comment">All media peculiarities are handled automatically.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">xorriso is an application of all three libraries which creates, loads,</span>
<a name="l00021"></a>00021 <span class="comment">manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions.</span>
<a name="l00022"></a>00022 <span class="comment">Manipulation is not only adding or overwriting of files but also deletion,</span>
<a name="l00023"></a>00023 <span class="comment">renaming, and attribute changing. An incremental backup feature is provided.</span>
<a name="l00024"></a>00024 <span class="comment">The xorriso features are accessible via built-in command interpreters and</span>
<a name="l00025"></a>00025 <span class="comment">via a C language API.</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">SONAME:</span>
<a name="l00029"></a>00029 <span class="comment">libisoburn.so.1 (since 0.1.0, February 2008).</span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment"> @section using Using the libraries</span>
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">Our build system is based on autotools.</span>
<a name="l00035"></a>00035 <span class="comment">User experience tells us that you will need at least autotools version 1.7.</span>
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">To build libisoburn go into its toplevel directory and execute:</span>
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">- ./bootstrap (needed if you downloaded from SVN)</span>
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">- ./configure</span>
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">- make</span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">To make the library and the xorriso application accessible for running resp.</span>
<a name="l00046"></a>00046 <span class="comment">software development:</span>
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">- make install</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">For direct use as command line tool use the xorriso binary which among many</span>
<a name="l00052"></a>00052 <span class="comment">other features provides a mkisofs emulation via command "-as mkisofs".</span>
<a name="l00053"></a>00053 <span class="comment">See man page xorriso/xorriso.1 or GNU info document xorriso/xorriso.info.</span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">If you want to link an own application with libisoburn, you have</span>
<a name="l00057"></a>00057 <span class="comment">two alternative APIs for choice:</span>
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">- libisoburn, together with libburn and libisofs.</span>
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">- xorriso, a complete representation of xorriso command line options.</span>
<a name="l00062"></a>00062 <span class="comment"> It encapsulates the three lower level libraries.</span>
<a name="l00063"></a>00063 <span class="comment"> Calls of both API families shall not be mixed.</span>
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment">For a description of the lbisoburn API read libisoburn/libisoburn.h</span>
<a name="l00066"></a>00066 <span class="comment">See file README for download and installation of a release tarball.</span>
<a name="l00067"></a>00067 <span class="comment">You will also have to install and understand the two libraries of the </span>
<a name="l00068"></a>00068 <span class="comment">Libburnia project which provide fundamental services:</span>
<a name="l00069"></a>00069 <span class="comment">libburn is the library by which preformatted data get onto optical media.</span>
<a name="l00070"></a>00070 <span class="comment">See libburn/libburn.h for its API description.</span>
<a name="l00071"></a>00071 <span class="comment">libisofs is the library to handle ISO 9660 filesystems with Rock Ridge </span>
<a name="l00072"></a>00072 <span class="comment">extensions. Its API is described in libisofs/libisofs.h .</span>
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment">For xorriso features see its man page xorriso/xorriso.1 or</span>
<a name="l00075"></a>00075 <span class="comment">its GNU info document xorriso/xorriso.info.</span>
<a name="l00076"></a>00076 <span class="comment">For the corresponding C language API see libisoburn/xorriso.h (resp.</span>
<a name="l00077"></a>00077 <span class="comment">xorriso/xorriso.h in the build directory).</span>
<a name="l00078"></a>00078 <span class="comment">The implementation this API is part of libisoburn.</span>
<a name="l00079"></a>00079 <span class="comment">The xorriso command line tool gets installed as dynamically linked</span>
<a name="l00080"></a>00080 <span class="comment">binary together with libisoburn.</span>
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">There is also a statically linked release named GNU xorriso.</span>
<a name="l00083"></a>00083 <span class="comment">See xorriso/README_gnu_xorriso for its download and installation.</span>
<a name="l00084"></a>00084 <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment">*/</span>
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated for libisoburn by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.4 </small></address>
</body>
</html>
