NAME

StanzaFile::Grub - read, parse, and write Grand Unified Bootloader configuration files.

SYNOPSIS

There are no interface changes between this and the parent class, StanzaFile. This is included, partly, as an example of the ease with which additional different stanza file formats can be supported using the StanzaFile class and, mostly, because I used the StanzaFile::Grub class in a kernel build and installation management package I wrote (check it out, kif at sourceforge.net).

DESCRIPTION

The grub configuration file format differs in a couple of ways from the WINDOWS.INI format. It has a "global" section that appears before any of the stanzas actually start. This global section is stored in a dummy stanza accessable via the header method defined in StanzaFile.

The format of entries in the global section also differs from entries in the stanzas.

All this is dealt with by overriding 5 methods.

$theObject->addHeader($leftHandSide, $rightHandSide)

addHeader puts a new global header item into the Grub StanzaFile object. The value of the new header item is the value of the $rightHandSide variable and is optional for those header items without values.

$theObject->headerAsString()

Produce a string suitable for printing that represents the contents of the header portion of the Grub stanza file object.

$theObject->isBeginning($line)

A predicate which tests the line to see if it is the beginning of a new stanza. If it is, the value of the predicate is the name of the new stanza. Otherwise the value of the predicate is undefined.

$theObject->isValue($line)

A predicate which tests the line to see if it contains a name/value pair and returns that pair as the value of the prediate. Otherwise it returns and undefined.

$theObject->stanzaAsString()

Produce a string suitable for printing that represents a Grub file stanza other than the header.

EXAMPLES

BUGS

None known.

WARNINGS

No comments or whitespace are preserved in the configuration file when it is read and/or written.

AUTHOR

Dick Munroe (munroe@csworks). I'm looking for work. If you hear of anything that might be of interest to a VERY senior engineer/architect drop me a note. See http://www.acornsw.com/resume/dick.html for details.

SEE ALSO

The Kernel Installation Facility uses these classes extensively. For more details see http://sourceforge.net/projects/kif/