libisoburn 1.5.6
comments
Go to the documentation of this file.
1/**
2 @author Mario Danic, Vreixo Formoso, Thomas Schmitt
3
4 @mainpage Libisoburn Documentation Index
5
6 @section intro Introduction
7
8Libburnia is an open-source project for reading, mastering and writing
9optical discs. This page is about its capability to read, manipulate, and
10write ISO 9660 filesystems with Rock Ridge extensions. Media can be optical
11media or filesystem objects.
12
13Our scope is currently Linux 2.4 and 2.6, FreeBSD, OpenSolaris, or NetBSD.
14
15libisoburn is an add-on to libburn and libisofs which coordinates both and
16also allows to grow ISO-9660 filesystem images on multi-session media as well
17as on overwriteable media via the same API.
18All media peculiarities are handled automatically.
19
20xorriso is an application of all three libraries which creates, loads,
21manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions.
22Manipulation is not only adding or overwriting of files but also deletion,
23renaming, and attribute changing. An incremental backup feature is provided.
24The xorriso features are accessible via built-in command interpreters and
25via a C language API.
26
27
28SONAME:
29libisoburn.so.1 (since 0.1.0, February 2008).
30
31
32 @section using Using the libraries
33
34Our build system is based on autotools.
35User experience tells us that you will need at least autotools version 1.7.
36
37To build libisoburn go into its toplevel directory and execute:
38
39- ./bootstrap (needed if you downloaded from SVN)
40
41- ./configure
42
43- make
44
45To make the library and the xorriso application accessible for running and
46software development:
47
48- make install
49
50
51For direct use as command line tool use the xorriso binary which among many
52other features provides a mkisofs emulation via command "-as mkisofs".
53See man page xorriso/xorriso.1 or GNU info document xorriso/xorriso.info.
54
55
56If you want to link an own application with libisoburn, you have
57two alternative APIs for choice:
58
59- libisoburn, together with libburn and libisofs.
60
61- xorriso, a complete representation of xorriso command line options.
62 It encapsulates the three lower level libraries.
63 Calls of both API families shall not be mixed.
64
65For a description of the lbisoburn API read libisoburn/libisoburn.h
66See file README for download and installation of a release tarball.
67You will also have to install and understand the two libraries of the
68Libburnia project which provide fundamental services:
69libburn is the library by which preformatted data get onto optical media.
70See libburn/libburn.h for its API description.
71libisofs is the library to handle ISO 9660 filesystems with Rock Ridge
72extensions. Its API is described in libisofs/libisofs.h .
73
74For xorriso features see its man page xorriso/xorriso.1 or
75its GNU info document xorriso/xorriso.info.
76For the corresponding C language API see libisoburn/xorriso.h (or
77xorriso/xorriso.h in the build directory).
78The implementation this API is part of libisoburn.
79The xorriso command line tool gets installed as dynamically linked
80binary together with libisoburn.
81
82There is also a statically linked release named GNU xorriso.
83See xorriso/README_gnu_xorriso for its download and installation.
84
85*/

Generated for libisoburn by  doxygen 1.12.0