libburnia/libburn
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Made a try to get doxygen portal page readable by pre tags and truncation

Browse Source
This commit is contained in:
Thomas Schmitt 2006-09-05 13:09:54 +00:00
parent 2cf262dcaa
commit a9949d5e36
1 changed files with 42 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
doc/comments_test_ts
View File

@ -61,84 +61,61 @@ User experience tells us that you will need at least autotools version 1.7.
To build libburn and its subprojects it should be sufficient to go into To build libburn and its subprojects it should be sufficient to go into
its toplevel directory and execute its toplevel directory and execute
<dl> - ./bootstrap (needed if you downloaded from SVN)
<dd>./bootstrap (needed if you downloaded from SVN)
<dd>./configure - ./configure
<dd>make
</dl> - make
To make the libraries accessible for running resp. developing applications To make the libraries accessible for running resp. developing applications
<dl> - make install
<dd>make install
</dl>
Both libraries are written in C language and get built by autotools. Both libraries are written in C language and get built by autotools.
Thus we expect them to be useable by a wide range of Linux-implemented Thus we expect them to be useable by a wide range of Linux-implemented
languages and development tools. languages and development tools.
We are still practicing.
@subsection working Working with the library @section libburner Libburner
In general, using the library to perform a process consists of the following libburner is a minimal demo application for the library libburn
steps: (see: libburn/libburn.h) as provided on http://libburn.pykix.org .
It can list the available devices, can blank a CD-RW and
can burn to CD-R or CD-RW.
<dl> It's main purpose, nevertheless, is to show you how to use libburn and also
<dd>1. Initialize the library. to serve the libburn team as reference application. libburner does indeed
<dd>2. Depends on wether you know the persisten drive address in advance define the standard way how above three gestures can be implemented and
<dl> stay upward compatible for a good while.
<dd>If yes:
<dd>2a. Aquire this drive alone and directly by function
burn_drive_scan_and_grab() and be done until step 5
<dd>If no address known yet:
<dd>2b. Scan for available Drives..
</dl>
<dd>3b. Choose a Drive for reading/writing and inquire its persistent address.
<dd>4b. Shut down library, re-initialize it and like in step 2a aquire the
chosen drive by function burn_drive_scan_and_grab()
<dd>5. Fill in the options for the operation.
<dd>6. Wait for the operation to complete, displaying status along the way
if desired.
<dd>7. Release the Drive.
<dd>8. Destroy the library instance. (If you're done working with the library.)
</dl>
@section libburner Libburner
libburner is a minimal demo application for the library libburn (see: libburn.h)
as provided on http://libburn.pykix.org . It can list the available devices, can
blank a CD-RW and can burn to CD-R or CD-RW.<br>
It's main purpose, nevertheless, is to show you how to use libburn and also
to serve the libburn team as reference application. libburner.c does indeed
define the standard way how above three gestures can be implemented and
stay upward compatible for a good while.
@subsection libburner-help Libburner --help @subsection libburner-help Libburner --help
<dl> <pre>
<dd>Usage: test/libburner Usage: test/libburner
<dl> [--drive <address>|<driveno>|"-"]
<dd> [--drive <address>|<driveno>|"-"] [--verbose <level>] [--blank_fast|--blank_full]
<dd> [--verbose <level>] [--blank_fast|--blank_full] [--burn_for_real|--try_to_simulate] [--stdin_size <bytes>]
<dd> [--burn_for_real|--try_to_simulate] [--stdin_size <bytes>] [<imagefile>|"-"]
<dd> [<imagefile>|"-"] Examples
</dl> A bus scan (needs rw-permissions to see a drive):
<dd>Examples test/libburner --drive -
<dl> Burn a file to drive chosen by number:
<dd> A bus scan (needs rw-permissions to see a drive): test/libburner --drive - test/libburner --drive 0 --burn_for_real my_image_file
<dd> Burn a file to drive chosen by number: Burn a file to drive chosen by persistent address:
<dl><dd> test/libburner --drive 0 --burn_for_real my_image_file</dl> test/libburner --drive /dev/hdc --burn_for_real my_image_file
<dd> Burn a file to drive chosen by persistent address: Blank a used CD-RW (is combinable with burning in one run):
<dl><dd> test/libburner --drive /dev/hdc --burn_for_real my_image_file</dl> test/libburner --drive 0 --blank_fast
<dd> Blank a used CD-RW (is combinable with burning in one run): Burn a compressed afio archive on-the-fly, pad up to 700 MB:
<dl><dd> test/libburner --drive 0 --blank_fast</dl> ( cd my_directory ; find . -print | afio -oZ - ) | \
<dd> Burn a compressed afio archive on-the-fly, pad up to 700 MB: test/libburner --drive /dev/hdc --burn_for_real --stdin_size 734003200 -
<dl><dd> ( cd my_directory ; find . -print | afio -oZ - ) | \ To be read from *not mounted* CD via:
<dd> test/libburner --drive /dev/hdc --burn_for_real --stdin_size 734003200 - </dl> afio -tvZ /dev/hdc
<dd>To be read from *not mounted* CD via: afio -tvZ /dev/hdc Program tar would need a clean EOF which our padded CD cannot deliver.
<dd> Program tar would need a clean EOF which our padded CD cannot deliver. </pre>
</dl>
@subsection libburner-source Sourceode of libburner
Click on blue names of functions, structures, variables, etc in oder to
get to the according specs of libburn API or libburner sourcecode.
@include libburner.c @include libburner.c
*/ */