/usr/share/doc/burn/index.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>Burn</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 6253 2010-03-02 00:24:53Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: left }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="burn">
<h1 class="title">Burn</h1>

<p class="rubric">“Burn until recorded, now!”</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#about" id="id1">About</a></li>
<li><a class="reference internal" href="#requirements" id="id2">Requirements</a></li>
<li><a class="reference internal" href="#quick-start" id="id3">Quick start</a><ul>
<li><a class="reference internal" href="#examples" id="id4">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#status" id="id5">Status</a></li>
<li><a class="reference internal" href="#todo" id="id6">ToDo</a></li>
<li><a class="reference internal" href="#download" id="id7">Download</a></li>
<li><a class="reference internal" href="#documentation" id="id8">Documentation</a></li>
<li><a class="reference internal" href="#authors" id="id9">Authors</a></li>
<li><a class="reference internal" href="#thanks" id="id10">Thanks</a></li>
</ul>
</div>
<div class="section" id="about">
<h1><a class="toc-backref" href="#id1">About</a></h1>
<p>Burn is a simple program/script written in Python.</p>
<p>It's aim is to make it simple and quick to burn CDs or DVDs.</p>
<p>First of all Burn...</p>
<ul class="simple">
<li>... has to be a command line program/script;</li>
<li>... must perform any of its feature invoking it only once and with
one and only one command line.</li>
</ul>
<p>Burn should be able to:</p>
<ul class="simple">
<li>create Audio CD from .ogg, .mp3, .wav (even toghether)</li>
<li>copy CDs</li>
<li>create Data-CD or DVD (storage, backups, etc.)</li>
<li>create a CD or DVD from an existing ISO image.</li>
</ul>
<p>Burn still performs above features. Other things burn does:</p>
<ul class="simple">
<li>size of stuff to be burned.</li>
<li>compute if there is enough free space for temporary files (images
and audio files).</li>
<li>warns if size is bigger than CD/DVD capacity</li>
<li>convert .mp3 and .ogg in .wav without external decoders</li>
<li>perform burn simulations for testing</li>
<li>eject CD/DVD at the end of burn process</li>
<li>asks if you want to see what is going to be burned (mounts and
umount image)</li>
<li>asks if you want to make other copies</li>
<li>shows main id3 tags for .mp3 and .ogg files</li>
</ul>
</div>
<div class="section" id="requirements">
<h1><a class="toc-backref" href="#id2">Requirements</a></h1>
<p>In order to work, burn requires:</p>
<ul class="simple">
<li><a class="reference external" href="http://www.python.org/">python</a> (version 2.4 or later)</li>
<li><a class="reference external" href="http://cdrkit.org/">cdrkit</a> (wodim, genisoimage, cdrdao)</li>
<li><a class="reference external" href="http://eyed3.nicfit.net/releases/">eyeD3</a></li>
<li><a class="reference external" href="http://ekyo.nerim.net/software/pyogg/">pyogg</a> (python-pyvorbis) (generic Ogg Vorbis modules for Python).</li>
</ul>
<p><strong>Optionally</strong>: you can choose not to decode mp3 and ogg files with
native burn functions choosing to do it with external decoders. If you
wanto to do so, you have to install preferred decoders (ogg123,
mpg321, mpg123, etc.) and set up burn.conf. (remember: lame uses
mpg123 to convert to wav).</p>
<div class="admonition-warning-powerpc-users admonition">
<p class="first admonition-title">Warning PowerPC users</p>
<p class="last">Internal decoder (mp3 to wav) does not work. Please use external
decoding.</p>
</div>
</div>
<div class="section" id="quick-start">
<h1><a class="toc-backref" href="#id3">Quick start</a></h1>
<p>First of all, remember following points:</p>
<ol class="arabic simple">
<li>first argument has to be one of the burn modes:<ul>
<li><tt class="docutils literal"><span class="pre">-A</span></tt> for Audio-CD</li>
<li><tt class="docutils literal"><span class="pre">-D</span></tt> for Data-CD/DVD</li>
<li><tt class="docutils literal"><span class="pre">-I</span></tt> for ISO-CD/DVD</li>
<li><tt class="docutils literal"><span class="pre">-C</span></tt> for Copy-CD/DVD</li>
</ul>
</li>
<li>you can test burn commands using <tt class="docutils literal"><span class="pre">-s</span></tt> option after MODE, in this
way you can always perform a CD/DVD writing simulation. So you
don't have to waste CDs/DVDs to test it.</li>
</ol>
<div class="section" id="examples">
<h2><a class="toc-backref" href="#id4">Examples</a></h2>
<p>Here are some commands that help you start using burn quickly.</p>
<p>Creates a CD/DVD with /etc/ contents:</p>
<pre class="literal-block">
# burn -D -p /etc/
</pre>
<p>(you will find files and directories contained in /etc in CD's root.)</p>
<p>Creates a CD/DVD with spain.tar.gz in CDs root:</p>
<pre class="literal-block">
# burn -D -p /home/bigpaul/video/summer_2003/spain.tar.gz
</pre>
<p>Creates a CD/DVD containing the whole /etc/ directory:</p>
<pre class="literal-block">
# burn -D -r /etc/
</pre>
<p>(-r preserves path)</p>
<p>Creates a CD/DVD containing the whole /home/bigpaul/Mail renamed into
/mail_2003:</p>
<pre class="literal-block">
# burn -D -c /mail_2003 /home/bigpaul/Mail -p /boot/vmli*
</pre>
<p>(-c changes path name). This command also adds in CD's root every
vmli* file in /boot/ directory</p>
<p>Burns image.iso:</p>
<pre class="literal-block">
# burn -I -n image.iso
</pre>
<p>Copy CDs/DVDs:</p>
<pre class="literal-block">
# burn -C
</pre>
<p>Creates an Audio CD. Tracks come from wav files:</p>
<pre class="literal-block">
# burn -A -a *.wav
</pre>
<p>Creates an Audio CD. Tracks come from mp3 files:</p>
<pre class="literal-block">
# burn -A -a *.mp3
</pre>
<p>Creates an Audio CD. Tracks come from Ogg Vorbis files:</p>
<pre class="literal-block">
# burn -A -a *.ogg
</pre>
<p>Creates an Audio CD. Tracks come from .wav, .ogg, .mp3 files:</p>
<pre class="literal-block">
# burn -A -a *.mp3 file.ogg track01.wav
</pre>
</div>
</div>
<div class="section" id="status">
<h1><a class="toc-backref" href="#id5">Status</a></h1>
<p>Burn already works. But it is in the early developement stage.</p>
<p>It already features:</p>
<ul class="simple">
<li>Data-CD/DVD</li>
<li>Audio-CD</li>
<li>Copy-CD/DVD</li>
<li>ISO-CD/DVD</li>
<li>image mount and view for Data-CD/DVD and ISO-CD/DVD.</li>
<li>disk usage and prompt if you are going to overburn.</li>
</ul>
</div>
<div class="section" id="todo">
<h1><a class="toc-backref" href="#id6">ToDo</a></h1>
<p>To Do list for Burn:</p>
<ul class="simple">
<li>volume id</li>
<li>audio normalization</li>
<li>tag decoder option</li>
<li>cdrecord -pad option</li>
<li>fill CD with as many MP3 as possible. <a class="reference external" href="mailto:farnis&#64;despammed.com">farnis&#64;despammed.com</a></li>
<li>WAV track info support</li>
<li>CD cover easy solution</li>
</ul>
</div>
<div class="section" id="download">
<h1><a class="toc-backref" href="#id7">Download</a></h1>
<p>Latest <a class="reference external" href="http://www.bigpaul.org/burn/download/burn-0.4.4.tar.gz">stable version</a> (0.4.4)</p>
<p><a class="reference external" href="http://packages.debian.org/sid/burn/">Debian package</a></p>
<p>Old CVS repository <a class="reference external" href="http://cvs.hacknight.org/cgi/viewcvs.cgi/burn/">hacknight CVS</a></p>
<p>My bzr branch at launchpad: <tt class="docutils literal">bzr branch
<span class="pre">lp:~gaetano-paolone/+junk/burn/</span></tt></p>
<p>Ben Finney bzr branch: <tt class="docutils literal">bzr checkout
<span class="pre">http://vcs.whitetree.org/bzr/public/burn/burn.devel/</span></tt></p>
<p>Main revisions are also avaible from <a class="reference external" href="http://www.bigpaul.org/burn/download/">download directory</a></p>
</div>
<div class="section" id="documentation">
<h1><a class="toc-backref" href="#id8">Documentation</a></h1>
<p>Here is the help page. Other documents coming soon:</p>
<pre class="literal-block">
usage: burn -MODE [general_option] [mode_option] ...

For quick start you can get common examples with:

burn -e


options:
  -h, --help            show this help message and exit
  -e, --examples        show examples for quick startup

  Main burn MODES:
    The _have_ to be the first argument after program name
    -D, --data-cd       creates a Data CD/DVD.
    -I, --iso-cd        creates a CD/DVD from ISO.
    -C, --copy-cd       copy CD/DVD.
    -A, --audio-cd      creates an Audio CD from .wav, .mp3 and .ogg files.

  General options:
    These options could be used for every burn mode unless stated otherwise
    -s, --simulate      This option will perform a burn simulation.
    -j, --eject         This option will eject disk when burn process is over.

  Data CD Mode (-D) options:
    Data CD: adds files and directories.
    -p, --path          add file/s or path's content to CD-ROM/DVD's root.
                        e.g.: -p /cvs/myproj/ &lt;return&gt;. In this example we will
                        find CD-ROM/DVD's root filled with /cvs/myproj/
                        contents, but no /cvs/myproj/ will be created.
    -r, --preserve-path
                        add file/s or path's content to CD-ROM/DVD preserving
                        original path. e.g.: -r /cvs/myproj/ &lt;return&gt;. In this
                        example we will find /cvs/myproj/ in CD-ROM/DVD's root.
    -x, --exclude-path  every file or directory matching this string will not
                        be included.
    -cCHANGE_PATH, --change-path=CHANGE_PATH
                        usage: -c &lt;new_path&gt; &lt;old_path&gt;. With this option,
                        old_path will be named new_path in CD-ROM/DVD. e.g.: -c
                        /my_home/2004_Jan/ /home/bigpaul/ &lt;return&gt;. Thus
                        /home/bigpaul/ will be named  /my_home/2004_Jan/ in CD-
                        ROM/DVD.
    -l, --follow-symlink
                        this option allows burn to follow symbolic link
                        directories
    -m, --multisession  this option allows multisession CDs

  ISO CD Mode (-I) options:
    Creates a CD-ROM/DVD from an existing image.
    -nISO_NAME, --name=ISO_NAME
                        image name

  Copy CD Mode (-C) options:
    If you have both a reader and a recording unit you can perform a copy
    on-the-fly. You can also copy a CD even if you only have the recording
    unit.

  Audio CD Mode (-A) options:
    Audio CD is used to create an audio CD-ROM from .wav, .ogg and .mp3
    files. You can can use -a option to perform an Audio CD from different
    source audio files.
    -a, --audio-file    .wav, .mp3, .ogg file/s. Files must have extensions (no
                        matter if they are upper or lowercase).
    --audio-list=FILE_LIST
                        m3u playlist or file with one audio file per line.
    --clear-audiotemp   remove temporary audio files.
</pre>
</div>
<div class="section" id="authors">
<h1><a class="toc-backref" href="#id9">Authors</a></h1>
<p>The following people are primary contributors to Burn:</p>
<ul class="simple">
<li>Gaetano Paolone &lt;<a class="reference external" href="mailto:bigpaul&#64;hacknight.org">bigpaul&#64;hacknight.org</a>&gt;</li>
<li>Ben Finney &lt;<a class="reference external" href="mailto:ben+python&#64;benfinney.id.au">ben+python&#64;benfinney.id.au</a>&gt;</li>
</ul>
</div>
<div class="section" id="thanks">
<h1><a class="toc-backref" href="#id10">Thanks</a></h1>
<ul class="simple">
<li>to Flexer for this layout</li>
<li>to zufus for his critical commit ;)</li>
<li>to baluba for having tried to make it work in python2.1
(unsuccesfully)</li>
<li>to pivi for audio duration hint</li>
<li>to farnis for his patient tests</li>
<li>to giuppi for his willness of removing system calls and his
wonderful patches.</li>
<li>to ben finney for major code restyling</li>
</ul>
<!-- Local variables:
mode: rst
coding: utf-8
time-stamp-format: "%:y-%02m-%02d"
time-stamp-start: "^:Date:[         ]+"
time-stamp-end: "$"
time-stamp-line-limit: 20
End:
vim: filetype=rst fileencoding=utf-8 : -->
</div>
</div>
</body>
</html>
burn 0.4.6-2 / usr / share / doc / burn / index.html
