Bootloader::Core::ZIPLUser Contributed Perl DocumentaBootloader::Core::ZIPL(3)NAMEBootloader::Core::ZIPL - ZIPL library for bootloader configuration
PREFACE
This package is the ZIPL library of the bootloader configuration
SYNOPSIS
use Bootloader::Core::ZIPL;
"$obj_ref = Bootloader::Core::ZIPL->new ();"
"$settings_ref = Bootloader::Core::ZIPL->GetSettings ();"
"$files_ref = Bootloader::Core::ZIPL->ListFiles ();"
"$status = Bootloader::Core::ZIPL->FixSectionName ($name, \$names_ref,
$type);"
"$status = Bootloader::Core::ZIPL->ParseLines (\%files,
$avoid_reading_device_map);"
"$sections_ref Bootloader::Core->SplitLinesToSections (\@lines,
\@section_starts);"
"$files_ref = Bootloader::Core::ZIPL->CreateLines ();"
"$status = Bootloader::Core::ZIPL->UpdateBootloader ($avoid_init);"
"$status = Bootloader::Core::ZIPL->InitializeBootloader ();"
"$lines_ref = Bootloader::Core::ZIPL->Info2Section (\%section_info,
\@sect_names);"
"$sectin_info_ref = Bootloader::Core::ZIPL->Section2Info
(\@section_lines);"
"$glob_info = $Bootloader::Core::ZIPL->Global2Info (\@glob_lines,
\@section_names);"
"$lines_ref = Bootloader::Core::ZIPL->Info2Global (\%section_info,
\@section_names, \@sections);"
"Bootloader::Core::ZIPL->MangleSections (\@sections, \%global);"
"($lines_ref, $com_bef)
Bootloader::Core::ZIPL->ProcessSingleMenuFileLine ($lines, $com_bef,
$separator);"
"$line = Bootloader::Core::ZIPL->CreateSingleMenuFileLine ($key,
$value, $separator);"
DESCRIPTION
"$obj_ref = Bootloader::Core::ZIPL->new ();"
Creates an instance of the Bootloader::Core::ZIPL class.
"$settings_ref = Bootloader::Core::ZIPL->GetSettings ();"
returns the complete settings in a hash. Does not read the settings
from the system, but returns internal structures.
"$files_ref = Bootloader::Core::ZIPL->ListFiles ();"
Returns the list of the configuration files of the bootloader Returns
undef on fail
"$status = Bootloader::Core::ZIPL->FixSectionName ($name, \$names_ref,
$type);"
"$status = Bootloader::Core::ZIPL->ParseLines (\%files,
$avoid_reading_device_map);"
Parses the contents of all files and stores the settings in the
internal structures. As first argument, it takes a hash reference,
where keys are file names and values are references to lists, each
member is one line of the file. As second argument, it takes a
boolean flag that, if set to a true value, causes it to skip updating
the internal device_map information. The latter argument is not used
for ZIPL. Returns undef on fail, defined nonzero value on success.
"$sections_ref Bootloader::Core->SplitLinesToSections (\@lines,
\@section_starts);"
Splits the lines of the configuration file to particular sections As
argument it takes a reference to a list of lines (each line
represented as a hash) and a reference to a list of keys starting a
new section. Returns a reference of a list of sections, each
represented as a list of lines. The first section is the global
section of the bootloader (without
"$files_ref = Bootloader::Core::ZIPL->CreateLines ();"
creates contents of all files from the internal structures. Returns
a hash reference in the same format as argument of ParseLines on
success, or undef on fail.
"$status = Bootloader::Core::ZIPL->UpdateBootloader ($avoid_init);"
Updates the settings in the system. Backs original configuration
files up and replaces them with the ones with the '.new' suffix. Also
performs operations needed to make the change effect (run
'/sbin/zipl'). Returns undef on fail, defined nonzero value on
success.
"$status = Bootloader::Core::ZIPL->InitializeBootloader ();"
Initializes the firmware to boot the bootloader. Returns undef on
fail, defined nonzero value otherwise
"$lines_ref = Bootloader::Core::ZIPL->Info2Section (\%section_info,
\@sect_names);"
Takes the info about the section and uses it to construct the list of
lines. The info about the section also contains the original lines.
As parameter, takes the section info (reference to a hash), returns
the lines (a list of hashes).
"$sectin_info_ref = Bootloader::Core::ZIPL->Section2Info
(\@section_lines);"
Gets the information about the section. As argument, takes a
reference to the list of lines building the section, returns a
reference to a hash containing information about the section.
"$glob_info = $Bootloader::Core::ZIPL->Global2Info (\@glob_lines,
\@section_names);"
Gets the general information from the global section of the menu
file. This information usually means the default section, graphical
menu, timeout etc. As argument it takes a reference to the list of
hashes representing lines of the section, returns a reference to a
hash containing the important information.
"$lines_ref = Bootloader::Core::ZIPL->Info2Global (\%section_info,
\@section_names, \@sections);"
Takes the info about the global options and uses it to construct the
list of lines. The info about global option also contains the
original lines. As parameter, takes the section info (reference to a
hash) and a list of sectino names, returns the lines (a list of
hashes).
"Bootloader::Core::ZIPL->MangleSections (\@sections, \%global);"
Modifies the section and global data so that the data which is de-
facto global, but in zipl.conf is in sections (defaultboot, menu) is
moved to the global section. Modifies the data which it gets via
references directly!!!
"($lines_ref, $com_bef)
Bootloader::Core::ZIPL->ProcessSingleMenuFileLine ($lines, $com_bef,
$separator);"
processes line represented as string and returns it represented as
hashes (containing key, value, relevant comments). The list may be
empty, contain one or more items. As argument, it takes a line (as
string), comment from previous lines and separator between the key
and value. Returns a reference to a list of hashed and a pending
comment.
"$line = Bootloader::Core::ZIPL->CreateSingleMenuFileLine ($key,
$value, $separator);"
Transforms a line (hash) to a string to save. As arguments it takes
the the key, the value and a string to separate the key and the
value. Returns a string.
perl v5.10.0 2013-03-28 Bootloader::Core::ZIPL(3)