====
burn
====

------------------------------------------------------
record from various sources to optical media (CD, DVD)
------------------------------------------------------

:Author: |author|
:Date: 2009-07-22
:Copyright:
    This is free software: you may copy, modify, and/or distribute
    this work under the terms of the GNU General Public License,
    version 2 or later as published by the Free Software Foundation.
    No warranty expressed or implied. See the source for details.
:Manual section: 1
:Manual group: Burn

..  |command| replace:: burn

SYNOPSIS
========

| |command| `MAIN_MODE` `[OPTIONS]...` `[FILE/S]...`
| |command| --help

DESCRIPTION
===========

CD-writing program/script. Features Data-CD, Audio-CD, Copy on the
fly, Iso-CD.

CONFIGURATION
=============

Configuration files for burn are: ``~/.burnrc`` or ``/etc/burn.conf``.
You can edit them to change values.

If you don't have these files you can:

1)  use ``burn-configure`` utility 

2)  take the configuration template, edit and copy it as ``~/.burnrc``
    or ``/etc/burn.conf``

MAIN MODES
==========

-D, --data-cd
    To create Data-CD

-I, --iso-cd
    To create ISO-CD

-C, --copy-cd
    To copy CDs

-A, --audio-cd
    To create an audio CD from WAV, MP3 and ogg files

EXAMPLES
========

::

    # burn -D -p /etc/

Creates a CD with /etc/ contents.
(you will find files and directories contained in /etc in CD's root.)

::

    # burn -D -p /home/bigpaul/video/summer_2003/spain.tar.gz

Creates a CD with spain.tar.gz in CD's root

::

    # burn -D -r /etc/

Creates a CD containing the whole /etc/ directory. (-r preserves path)

::

    # burn -D -c /mail_2003 /home/bigpaul/Mail -p /boot/vmli*

Creates a CD containing the whole /home/bigpaul/Mail renamed
into /mail_2003. (-c changes path name). This command also adds
in CD's root every vmli* file in /boot/ directory

::

    # burn -I -n image.iso

Burns image.iso

::

    # burn -C

Copy CDs (disk at once).

::

    # burn -A -a *.wav

Creates an Audio CD. Tracks come from wav files

::

    # burn -A -a *.mp3

Creates an Audio CD. Tracks come from mp3 files

::

    # burn -A -a *.ogg

Creates an Audio CD. Tracks come from Ogg Vorbis files

::

    # burn -A -a *.mp3 file.ogg track01.wav

Creates an Audio CD preserving input order. In this example the first
audio tracks will come from mp3 files, than we will find the one from
``file.ogg`` and finally the one from ``track01.wav``

GENERAL OPTIONS
===============

-s, --simulate
    to perform a burn simulation

DATA-CD OPTIONS
===============

-p, --path
    add file/s or path's content to CD-ROM's root. e.g.: ``-p
    /cvs/myproj/``. In this example we will find CD-ROM'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 preserving original path.
    e.g.: ``-r /cvs/myproj/``. In this example we will find
    ``/cvs/myproj/`` in CD-ROM's root

-x, --exclude-path
    every file or directory matching this string will not be included

-c, --change-path
    old_path will be named new_path in CD-ROM. e.g.: ``-c
    /my_home/2004_Jan/ /home/bigpaul/``. Thus ``/home/bigpaul/`` will
    be named ``/my_home/2004_Jan/`` in CD-ROM.

-l, --follow-symlink
    this option allows burn to follow symbolic link directories

-m, --multisession
    this option allows multisession CDs

ISO-CD OPTIONS
==============

-n, --name
    image name

AUDIO-CD OPTIONS
================

-a, --audio-file
    mp3, ogg or wav file/s

..  |author| replace::
    Ben Finney <ben+python@benfinney.id.au>,
    Gaetano Paolone <bigpaul@hacknight.org>

..
    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 :
