.TH HOTSWAPRC 5 26th\ November\ 2002  
.SH NAME
hotswaprc \- configuration file for  hotswap
.SH DESCRIPTION
\fB/etc/hotswaprc\fR is the global
configuration file for the hotswap
utility.
.PP
It allows system administrators to specify arbitrary shell
scripts to be run after a device is inserted, as well as before
and after it is removed. Scripts are selected according to the
model name retrieved from the device. This is particularly
helpful for automatic configuration of CD\-RW
drives, which require SCSI emulation and bypass
normal access via the IDE subsystem.
.PP
\fBhotswaprc\fR is implemented as an
Extensible Mark\-up Language (XML) application.
XML documents are structured using elements of
the form <\fItag\-name\fR>
\fIcontent\fR
<\fItag\-name\fR>. A Document Type
Definition (DTD) describes the possible
\fIcontent\fR of each element.
.PP
Please refer to the XML specification for
more information. The hotswap distribution also contains an
example file, \fBdoc/hotswaprc.example\fR, which
includes the DTD for the configuration file
format.
.SH ELEMENTS
.TP 
<hotswap>
This is the root element of the document. Each valid
\fBhotswaprc\fR must contain exactly one
<hotswap> element. The <hotswap> element may
contain an arbitrary number of <device> elements.
.TP 
<device>
The configuration file contains one <device>
element for every device for which scripts are defined. The
<device> element is composed of the following elements
in this order: <name>, <post\-insert>,
<pre\-remove>, <post\-remove>. All but
<name> are optional.
.TP 
<name>
The content of this element is the model
identification string of the IDE device
the current <device> element refers to.
.TP 
<post\-insert>
Contains the shell script that is to be executed after
the device has been inserted and registered with the
kernel.
.TP 
<pre\-remove>
Contains the shell script that is to be run before
hotswap attempts to unregister the
device.
.TP 
<post\-remove>
Contains the shell script that is to be run after the
device had been unregistered.
.SH REPORT\ BUGS
Report bugs to t.stadelmann1@physics.ox.ac.uk.
.SH AUTHOR
Written by Tim Stadelmann.
.SH SEE\ ALSO
\fBhotswap\fR(1), \fBxhotswap\fR(1).
.SH COPYRIGHT
Copyright (c) 2002\-2003 Tim Stadelmann.
.PP
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General
Public License (GPL), Version 2 or any later
version published by the Free Software Foundation.