ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
Bootloader installation and configuration
</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
Bootloader installation and configuration
</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
Bootloader installation and configuration
</h1>
</td>
<td class="filecell">
modules/BootGRUB.ycp
</td>
</tr>
<tr>
<td>
Module containing specific functions for GRUB configuration
and installation
</td>
</tr>
<tr>
<td>
<ul>
<li> Jiri Srain <jsrain@suse.cz></li>
<li> Joachim Plack <jplack@suse.de></li>
<li> Olaf Dabrunz <od@suse.de></li>
<li> Philipp Thomas <pth@suse.de></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>Arch</li>
<li>BootCommon</li>
<li>BootStorage</li>
<li>HTML</li>
<li>Kernel</li>
<li>Mode</li>
<li>Pkg</li>
<li>Stage</li>
<li>Storage</li>
<li>StorageDevices</li>
</ul>
<h1>Includes</h1>
<ul>
<li>bootloader/grub/dialogs.ycp</li>
<li>bootloader/grub/misc.ycp</li>
<li>bootloader/routines/popups.ycp</li>
</ul>
<h1>Global Variables</h1>
<ul>
<li>
<a href="#disks_order">disks_order</a>
</li>
<li>
<a href="#merge_level">merge_level</a>
</li>
<li>
<a href="#update_device_map_done">update_device_map_done</a>
</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#BootGRUB">BootGRUB ()</a>
</li>
<li>
<a href="#CheckAdditionalKernels">CheckAdditionalKernels ()</a>
</li>
<li>
<a href="#FlagOnetimeBoot">FlagOnetimeBoot (string section)</a>
</li>
<li>
<a href="#GetFunctions">GetFunctions ()</a>
</li>
<li>
<a href="#Initializer">Initializer ()</a>
</li>
<li>
<a href="#Propose">Propose ()</a>
</li>
<li>
<a href="#Read">Read (boolean reread, boolean avoid_reading_device_map)</a>
</li>
<li>
<a href="#Reset">Reset (boolean init)</a>
</li>
<li>
<a href="#Save">Save (boolean clean, boolean init, boolean flush)</a>
</li>
<li>
<a href="#StandardGlobals">StandardGlobals ()</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#Update">Update ()</a>
</li>
<li>
<a href="#Write">Write ()</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="merge_level">global
<b>merge_level
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Shall proposal merge menus?</p>
<div class="sigbox">
<span class="sig" id="update_device_map_done">global
<b>update_device_map_done
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
The variable indicate if client bootloader_preupdate
successful update device map
If success true else false </p>
<div class="sigbox">
<span class="sig" id="disks_order">global
<b>disks_order
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Disks order for ordering widget purproses</p>
<div class="sigbox">
<span class="sig" id="CheckAdditionalKernels">global
<b>CheckAdditionalKernels ()
<span class="a"> -> </span>
<span class="t">list<map<string,string> ></span>
</b>
</span>
</div>
<p>
Check for additional kernels which could go to the proposed settings</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of kernels to propose</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">Info:</div>
<p>
Propose sections to bootloader menu
modifies internal structures</p>
<div class="sigbox">
<span class="sig" id="StandardGlobals">global
<b>StandardGlobals ()
<span class="a"> -> </span>
<span class="t">map<string,string></span>
</b>
</span>
</div>
<p>
Propose global options of bootloader</p>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read (boolean reread, boolean avoid_reading_device_map)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Read settings from disk</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">reread</span>
</td>
<td class="descbox">boolean true to force reread settings from system</td>
</tr>
<tr>
<td class="pbox">
<span class="p">avoid_reading_device_map</span>
</td>
<td class="descbox">do not read new device map from file, use
internal data</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Reset">global
<b>Reset (boolean init)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Reset bootloader settings</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">init</span>
</td>
<td class="descbox">boolean true to repropose also device map</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Propose">global
<b>Propose ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Propose bootloader settings</p>
<div class="sigbox">
<span class="sig" id="Save">global
<b>Save (boolean clean, boolean init, boolean flush)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Save all bootloader configuration files to the cache of the PlugLib
PlugLib must be initialized properly !!!</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">clean</span>
</td>
<td class="descbox">boolean true if settings should be cleaned up (checking their
correctness, supposing all files are on the disk</td>
</tr>
<tr>
<td class="pbox">
<span class="p">init</span>
</td>
<td class="descbox">boolean true to init the library</td>
</tr>
<tr>
<td class="pbox">
<span class="p">flush</span>
</td>
<td class="descbox">boolean true to flush settings to the disk</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Summary">global
<b>Summary ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Display bootloader summary</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of summary lines</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Update">global
<b>Update ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update read settings to new version of configuration files</p>
<div class="sigbox">
<span class="sig" id="Write">global
<b>Write ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Write bootloader settings to disk</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="FlagOnetimeBoot">global
<b>FlagOnetimeBoot (string section)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Boot passed section once on next reboot.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">section</span>
</td>
<td class="descbox">string section to boot</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetFunctions">global
<b>GetFunctions ()
<span class="a"> -> </span>
<span class="t">map<string, any></span>
</b>
</span>
</div>
<p>
Return map of provided functions</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a map of functions (eg. $["write"::Write])</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Initializer">global
<b>Initializer ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initializer of GRUB bootloader</p>
<div class="sigbox">
<span class="sig" id="BootGRUB">global
<b>BootGRUB ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Constructor</p>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018