Main Page | Data Structures | Directories | File List | Data Fields | Globals


Go to the documentation of this file.
00001 /**
00002    @author Dana Jansens, Derek Foreman
00004    @mainpage Libburn Documentation Index
00006    @section intro Introduction
00008    Libburn is an open source library suite for reading, mastering and writing
00009    optical discs.
00011    @section using Using the library
00013    @subsection concepts Library concepts
00015    There are a few concepts to introduce in order for you to understand how to
00016    use Libburn. So, lets start with them:
00018    <ol>
00019    <li> Read - The process of reading the data on a disc for storage or
00020         copying.
00021    <li> Write - The process of writing data onto a disc to create a new
00022         disc image or append to an existing one.
00023    <li> Drive - A Drive is a hardware device used to reading and/or writing
00024         discs. CD burners and CD-ROMs are examples of Drives.
00025    </ol>
00027    @subsection working Working with the library
00029    Now that you understand the above @ref concepts, you're ready to look at the
00030    actual use of the library.
00032    In general, using the library to perform a process consists of the following
00033    steps:
00035    <ol>
00036    <li> Initialize the library. (If not already done; a single instance of
00037         the library can perform multiple operations simultaneously with
00038         multiple drives.)
00039    <li> Scan for available Drives.
00040    <li> Choose and grab a Drive for reading/writing.
00041    <li> Fill in the options for the operation.
00042    <li> Wait for the operation to complete, displaying status along the way
00043         if desired.
00044    <li> Release the Drive.
00045    <li> Destroy the library instance. (If you're done working with the
00046         library.)
00047    </ol>
00049    Here's a very simple example of burning an ISO file
00051    @include burniso.c
00052 */

Generated on Mon Feb 13 18:31:19 2006 for libburn by  doxygen 1.4.2