Updated documentation aspects
This commit is contained in:
parent
494693cc63
commit
50eba7ee31
29
doc/comments
29
doc/comments
@ -6,8 +6,8 @@
|
|||||||
@section intro Introduction
|
@section intro Introduction
|
||||||
|
|
||||||
Libburnia is an open-source project for reading, mastering and writing
|
Libburnia is an open-source project for reading, mastering and writing
|
||||||
optical discs. For now this means only CD-R and CD-RW.
|
optical discs. For now this means CD-R, CD-RW, DVD-RAM, DVD+RW, DVD-RW.
|
||||||
Support for DVD+RW and DVD-RW is emerging.
|
DVD-R is untested yet.
|
||||||
|
|
||||||
|
|
||||||
The project comprises of several more or less interdependent parts which
|
The project comprises of several more or less interdependent parts which
|
||||||
@ -82,9 +82,8 @@ languages and development tools.
|
|||||||
|
|
||||||
libburner is a minimal demo application for the library libburn
|
libburner is a minimal demo application for the library libburn
|
||||||
(see: libburn/libburn.h) as provided on http://libburn.pykix.org .
|
(see: libburn/libburn.h) as provided on http://libburn.pykix.org .
|
||||||
It can list the available devices, can blank a CD-RW and
|
It can list the available devices, can blank a CD-RW or DVD-RW and
|
||||||
can burn to CD-R or CD-RW.
|
can burn to CD-R, CD-RW, DVD-RAM, DVD+RW, DVD-RW.
|
||||||
New: burning to DVD+/-RW (single data track, single session only).
|
|
||||||
|
|
||||||
It's main purpose, nevertheless, is to show you how to use libburn and also
|
It's main purpose, nevertheless, is to show you how to use libburn and also
|
||||||
to serve the libburnia team as reference application. libburner does indeed
|
to serve the libburnia team as reference application. libburner does indeed
|
||||||
@ -95,8 +94,9 @@ stay upward compatible for a good while.
|
|||||||
<pre>
|
<pre>
|
||||||
Usage: test/libburner
|
Usage: test/libburner
|
||||||
[--drive <address>|<driveno>|"-"] [--audio]
|
[--drive <address>|<driveno>|"-"] [--audio]
|
||||||
[--blank_fast|--blank_full] [--try_to_simulate]
|
[--blank_fast|--blank_full|--format_overwrite]
|
||||||
[--multi] [one or more imagefiles|"-"]
|
[--try_to_simulate]
|
||||||
|
[--multi] [<one or more imagefiles>|"-"]
|
||||||
Examples
|
Examples
|
||||||
A bus scan (needs rw-permissions to see a drive):
|
A bus scan (needs rw-permissions to see a drive):
|
||||||
test/libburner --drive -
|
test/libburner --drive -
|
||||||
@ -106,22 +106,27 @@ Burn a file to drive chosen by persistent address, close:
|
|||||||
test/libburner --drive /dev/hdc my_image_file
|
test/libburner --drive /dev/hdc my_image_file
|
||||||
Blank a used CD-RW (is combinable with burning in one run):
|
Blank a used CD-RW (is combinable with burning in one run):
|
||||||
test/libburner --drive /dev/hdc --blank_fast
|
test/libburner --drive /dev/hdc --blank_fast
|
||||||
Burn two audio tracks
|
Blank a used DVD-RW (is combinable with burning in one run):
|
||||||
|
test/libburner --drive /dev/hdc --blank_full
|
||||||
|
Format a DVD-RW to avoid need for blanking before re-use:
|
||||||
|
test/libburner --drive /dev/hdc --format_overwrite
|
||||||
|
Burn two audio tracks (to CD only):
|
||||||
lame --decode -t /path/to/track1.mp3 track1.cd
|
lame --decode -t /path/to/track1.mp3 track1.cd
|
||||||
test/dewav /path/to/track2.wav -o track2.cd
|
test/dewav /path/to/track2.wav -o track2.cd
|
||||||
test/libburner --drive /dev/hdc --audio track1.cd track2.cd
|
test/libburner --drive /dev/hdc --audio track1.cd track2.cd
|
||||||
Burn a compressed afio archive on-the-fly:
|
Burn a compressed afio archive on-the-fly:
|
||||||
( cd my_directory ; find . -print | afio -oZ - ) | \
|
( cd my_directory ; find . -print | afio -oZ - ) | \
|
||||||
test/libburner --drive /dev/hdc -
|
test/libburner --drive /dev/hdc -
|
||||||
To be read from *not mounted* CD via: afio -tvZ /dev/hdc
|
To be read from *not mounted* media via: afio -tvZ /dev/hdc
|
||||||
Program tar would need a clean EOF which our padded CD cannot deliver.
|
|
||||||
</pre>
|
</pre>
|
||||||
libburner has two companions, telltoc and dewav, which help to perform some
|
libburner has two companions, telltoc and dewav, which help to perform some
|
||||||
peripheral tasks of burning.
|
peripheral tasks of burning.
|
||||||
|
|
||||||
telltoc prints a table of content (sessions, tracks and leadouts), it tells
|
telltoc prints a table of content (sessions, tracks and leadouts), it tells
|
||||||
about type and state of CD media, and also is able to provide the necessary
|
about type and state of media, and also is able to provide the necessary
|
||||||
multi-session information for program mkisofs option -C.
|
multi-session information for program mkisofs option -C. Especially helpful
|
||||||
|
are its predictions with "Write multi" and "Write modes" where availability
|
||||||
|
of "TAO" indicates that tracks of unpredicted length can be written.
|
||||||
See: test/telltoc --help.
|
See: test/telltoc --help.
|
||||||
|
|
||||||
dewav extracts raw byte-swapped audio data from files of format .wav (MS WAVE)
|
dewav extracts raw byte-swapped audio data from files of format .wav (MS WAVE)
|
||||||
|
@ -8,8 +8,9 @@
|
|||||||
|
|
||||||
libburner is a minimal demo application for the library libburn as provided
|
libburner is a minimal demo application for the library libburn as provided
|
||||||
on http://libburnia.pykix.org . It can list the available devices, can
|
on http://libburnia.pykix.org . It can list the available devices, can
|
||||||
blank a CD-RW, can format a DVD-RW, and can burn to CD-R, CD-RW, DVD+RW,
|
blank a CD-RW or DVD-RW, can format a DVD-RW, and can burn to CD-R, CD-RW,
|
||||||
DVD-RAM or DVD-RW.
|
DVD+RW, DVD-RAM or DVD-RW. Not tested: DVD-R. Not supported yet: DVD+R [DL].
|
||||||
|
|
||||||
It's main purpose, nevertheless, is to show you how to use libburn and also
|
It's main purpose, nevertheless, is to show you how to use libburn and also
|
||||||
to serve the libburnia team as reference application. libburner.c does indeed
|
to serve the libburnia team as reference application. libburner.c does indeed
|
||||||
define the standard way how above three gestures can be implemented and
|
define the standard way how above three gestures can be implemented and
|
||||||
@ -593,9 +594,11 @@ int libburner_setup(int argc, char **argv)
|
|||||||
printf(" %s --drive /dev/hdc my_image_file\n", argv[0]);
|
printf(" %s --drive /dev/hdc my_image_file\n", argv[0]);
|
||||||
printf("Blank a used CD-RW (is combinable with burning in one run):\n");
|
printf("Blank a used CD-RW (is combinable with burning in one run):\n");
|
||||||
printf(" %s --drive /dev/hdc --blank_fast\n",argv[0]);
|
printf(" %s --drive /dev/hdc --blank_fast\n",argv[0]);
|
||||||
printf("Format a DVD-RW once before first use with libburner:\n");
|
printf("Blank a used DVD-RW (is combinable with burning in one run):\n");
|
||||||
|
printf(" %s --drive /dev/hdc --blank_full\n",argv[0]);
|
||||||
|
printf("Format a DVD-RW to avoid need for blanking before re-use:\n");
|
||||||
printf(" %s --drive /dev/hdc --format_overwrite\n", argv[0]);
|
printf(" %s --drive /dev/hdc --format_overwrite\n", argv[0]);
|
||||||
printf("Burn two audio tracks:\n");
|
printf("Burn two audio tracks (to CD only):\n");
|
||||||
printf(" lame --decode -t /path/to/track1.mp3 track1.cd\n");
|
printf(" lame --decode -t /path/to/track1.mp3 track1.cd\n");
|
||||||
printf(" test/dewav /path/to/track2.wav -o track2.cd\n");
|
printf(" test/dewav /path/to/track2.wav -o track2.cd\n");
|
||||||
printf(" %s --drive /dev/hdc --audio track1.cd track2.cd\n", argv[0]);
|
printf(" %s --drive /dev/hdc --audio track1.cd track2.cd\n", argv[0]);
|
||||||
|
Loading…
Reference in New Issue
Block a user