00001 /** 00002 @author Mario Danic, Vreixo Formoso, Thomas Schmitt 00003 00004 @mainpage Libisoburn Documentation Index 00005 00006 @section intro Introduction 00007 00008 Libburnia is an open-source project for reading, mastering and writing 00009 optical discs. This page is about its capability to read, manipulate, and 00010 write ISO 9660 filesystems with Rock Ridge extensions. Media can be optical 00011 media or filesystem objects. 00012 00013 Our scope is currently Linux 2.4 and 2.6, or FreeBSD, or OpenSolaris. 00014 00015 libisoburn is an add-on to libburn and libisofs which coordinates both and 00016 also allows to grow ISO-9660 filesystem images on multi-session media as well 00017 as on overwriteable media via the same API. 00018 All media peculiarities are handled automatically. 00019 00020 xorriso is an application of all three libraries which creates, loads, 00021 manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions. 00022 Manipulation is not only adding or overwriting of files but also deletion, 00023 renaming, and attribute changing. An incremental backup feature is provided. 00024 The xorriso features are accessible via built-in command interpreters and 00025 via a C language API. 00026 00027 00028 SONAME: 00029 libisoburn.so.1 (since 0.1.0, February 2008). 00030 00031 00032 @section using Using the libraries 00033 00034 Our build system is based on autotools. 00035 User experience tells us that you will need at least autotools version 1.7. 00036 00037 To build libisoburn go into its toplevel directory and execute: 00038 00039 - ./bootstrap (needed if you downloaded from SVN) 00040 00041 - ./configure 00042 00043 - make 00044 00045 To make the library and the xorriso application accessible for running resp. 00046 software development: 00047 00048 - make install 00049 00050 00051 For direct use as command line tool use the xorriso binary which among many 00052 other features provides a mkisofs emulation via command "-as mkisofs". 00053 See man page xorriso/xorriso.1 or GNU info document xorriso/xorriso.info. 00054 00055 00056 If you want to link an own application with libisoburn, you have 00057 two alternative APIs for choice: 00058 00059 - libisoburn, together with libburn and libisofs. 00060 00061 - xorriso, a complete representation of xorriso command line options. 00062 It encapsulates the three lower level libraries. 00063 Calls of both API families shall not be mixed. 00064 00065 For a description of the lbisoburn API read libisoburn/libisoburn.h 00066 See file README for download and installation of a release tarball. 00067 You will also have to install and understand the two libraries of the 00068 Libburnia project which provide fundamental services: 00069 libburn is the library by which preformatted data get onto optical media. 00070 See libburn/libburn.h for its API description. 00071 libisofs is the library to handle ISO 9660 filesystems with Rock Ridge 00072 extensions. Its API is described in libisofs/libisofs.h . 00073 00074 For xorriso features see its man page xorriso/xorriso.1 or 00075 its GNU info document xorriso/xorriso.info. 00076 For the corresponding C language API see libisoburn/xorriso.h (resp. 00077 xorriso/xorriso.h in the build directory). 00078 The implementation this API is part of libisoburn. 00079 The xorriso command line tool gets installed as dynamically linked 00080 binary together with libisoburn. 00081 00082 There is also a statically linked release named GNU xorriso. 00083 See xorriso/README_gnu_xorriso for its download and installation. 00084 00085 */
1.4.7