NAME

burn - CGI script that initiates the burning process.


SYNOPSIS

burn accepts input from a filled out HTML form (see index) with instructions for burning a CD, asks for any options for the drivers if the user chose to use advanced options, then initiates the burn, and sends the user to the page for that job.


DESCRIPTION

burn is the main interface to the all of CGIBurn. It gets information about source and destination devices from the filled out form, and finds the appropriate driver to do the copy. If the user selected to see additional options, a page with options appropriate for the driver is displayed, which sends the user back to this script when the options are selected. When the final selection is made, burn starts up a job for the process, and sends the user to the status page for that job.

CGI paramaters which are recognized are:

src
The name of the source device.
dst
The name of the destination device.
submit_burn
Button indicating that the user has made their final selections, and we should start burning.
submit_options
Button indicating that the user wishes to see addition options.
src:*
Options for the source device. See GetSrcOptions in CGIBurn::Driver.
dst:*
Options for the destination device. See GetDstOptions in CGIBurn::Driver.


TEMPLATES

burn uses the template options.tpl as options.

All templates
All templates have access to all :const variables from CGIBurn::Conf.
options/pagestart
Displayed at the top of the page. No special variables.
options/devstart
Displayed once for the source device, and once for the destination. Special variables are:
DEV_SRCDST_SHORT
Either ``src'' or ``dst'' for the source or destination device.
DEV_SRCDST_LONG
Either ``Source'' or ``Destination'' for the source or destination device.
DEV_NAME
The short name of the device.
DEV_DESCRIPTION
A user-presentable description of the device.
options/optnone
If there are no options for a device, this is displayed instead of options/optstart, options/opteach, options/optend. Has access to all variables from options/devstart, plus
OPT_DESCRIPTION
A description of the item to be presented to the user.
OPT_NAME
A short name of the item to be passed to CGI scripts.
options/optstart
Displayed for each option for each device, followed by a series of options/opteach, and a options/optend block.
options/opteach
Has access to all options from options/optstart and options/devstart, plus:
CHOICE_SELECTED
The word ``selected'' if the choice being displayed is the default option, otherwise an empty string.
CHOICE_NAME
The short name of the choice, which will be passed to CGI scripts.
CHOICE_DESCRIPTION
A short description of the choice, to be displayed to the user.
options/optend
Displayed for each option, after options/optstart and a series of options/opteach blocks.

Has access to all variables from options/devstart

options/devend
Displayed once for the source device and the end device. Has access to all variables from options/devstart.
options/buttons
Displayed right before the bottom of the page, to display a button to start the burn.
options/pageend
Displayed last.


SEE ALSO

README, CONFIG, TEMPLATES, CGI Perl module, CGI::Carp Perl module, CGIBurn::Conf, CGIBurn::Driver, CGIBurn::Job, CGIBurn::CGITools.