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>
Restore module
</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>
Restore module
</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>
Restore module
</h1>
</td>
<td class="filecell">
modules/Restore.ycp
</td>
</tr>
<tr>
<td>
Data for configuration of restore, input and output functions.
</td>
</tr>
<tr>
<td>
<ul>
<li> Ladislav Slezak <lslezak@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
Representation of the configuration of restore.
Input and output routines.
<h1>Imports</h1>
<ul>
<li>Label</li>
<li>Message</li>
<li>Mode</li>
<li>Package</li>
<li>Popup</li>
<li>Progress</li>
<li>Report</li>
<li>Service</li>
<li>String</li>
<li>Summary</li>
<li>URL</li>
</ul>
<h1>Global Variables</h1>
<ul>
<li>
<a href="#restoreRPMdb">restoreRPMdb</a>
</li>
<li>
<a href="#runSuSEconfig">runSuSEconfig</a>
</li>
<li>
<a href="#runbootloader">runbootloader</a>
</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#ActivateBootloader">ActivateBootloader ()</a>
</li>
<li>
<a href="#ClearInstalledPackagesCache">ClearInstalledPackagesCache ()</a>
</li>
<li>
<a href="#Export">Export ()</a>
</li>
<li>
<a href="#GetActualInstalledPackages">GetActualInstalledPackages ()</a>
</li>
<li>
<a href="#GetArchiveComment">GetArchiveComment ()</a>
</li>
<li>
<a href="#GetArchiveDate">GetArchiveDate ()</a>
</li>
<li>
<a href="#GetArchiveFiles">GetArchiveFiles ()</a>
</li>
<li>
<a href="#GetArchiveHostname">GetArchiveHostname ()</a>
</li>
<li>
<a href="#GetArchiveInfo">GetArchiveInfo ()</a>
</li>
<li>
<a href="#GetArchiveInstalledPackages">GetArchiveInstalledPackages ()</a>
</li>
<li>
<a href="#GetArchiveName">GetArchiveName ()</a>
</li>
<li>
<a href="#GetExtraPackages">GetExtraPackages ()</a>
</li>
<li>
<a href="#GetInputName">GetInputName ()</a>
</li>
<li>
<a href="#GetMismatchedPackages">GetMismatchedPackages ()</a>
</li>
<li>
<a href="#GetMissingPackages">GetMissingPackages ()</a>
</li>
<li>
<a href="#GetSelectedPackages">GetSelectedPackages ()</a>
</li>
<li>
<a href="#Import">Import (map settings)</a>
</li>
<li>
<a href="#IsMultiVolume">IsMultiVolume ()</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#MountInput">MountInput (string input)</a>
</li>
<li>
<a href="#Read">Read (string input)</a>
</li>
<li>
<a href="#ReadActualInstalledPackages">ReadActualInstalledPackages ()</a>
</li>
<li>
<a href="#ReadNextVolume">ReadNextVolume (string input)</a>
</li>
<li>
<a href="#ResetAll">ResetAll ()</a>
</li>
<li>
<a href="#ResetArchiveSelection">ResetArchiveSelection ()</a>
</li>
<li>
<a href="#Set">Set (map settings)</a>
</li>
<li>
<a href="#SetRestoreSelection">SetRestoreSelection (string pkgname, map selection)</a>
</li>
<li>
<a href="#SetSelectionProperty">SetSelectionProperty (map<string,map> settings)</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#TestAllVolumes">TestAllVolumes ()</a>
</li>
<li>
<a href="#TotalFilesToRestore">TotalFilesToRestore ()</a>
</li>
<li>
<a href="#TotalPackagesToRestore">TotalPackagesToRestore ()</a>
</li>
<li>
<a href="#Umount">Umount ()</a>
</li>
<li>
<a href="#Write">Write (block<boolean> abort, symbol progress, string targetdir)</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#AddVolume">AddVolume (string file)</a>
</li>
<li>
<a href="#CheckVolume">CheckVolume (string filename, integer num)</a>
</li>
<li>
<a href="#CopyVolume">CopyVolume (string filename, integer num)</a>
</li>
<li>
<a href="#RemoveShortCut">RemoveShortCut (string scut)</a>
</li>
<li>
<a href="#mountCD">mountCD (integer cdindex)</a>
</li>
<li>
<a href="#mountDevice">mountDevice (string device)</a>
</li>
<li>
<a href="#mountFloppy">mountFloppy (integer fdindex)</a>
</li>
<li>
<a href="#mountNFS">mountNFS (string server, string file)</a>
</li>
<li>
<a href="#yesno">yesno (boolean b)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="runbootloader">global
<b>runbootloader
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Run lilo after files are restored</p>
<div class="sigbox">
<span class="sig" id="runSuSEconfig">global
<b>runSuSEconfig
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Run SuSEconfig after files are restored</p>
<div class="sigbox">
<span class="sig" id="restoreRPMdb">global
<b>restoreRPMdb
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Rewrite RPM db - unapack /var/lib/rpm/* files from backup if present</p>
<div class="sigbox">
<span class="sig" id="Modified">global
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Return modified flag</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if modified</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="IsMultiVolume">global
<b>IsMultiVolume ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Selected archive has more parts</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">boolen True if archive have more than one part.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveDate">global
<b>GetArchiveDate ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return date when backup archive was created. Date is stored in archive in file info/date.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Date</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetInputName">global
<b>GetInputName ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return name of backup archive</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Input name file name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveName">global
<b>GetArchiveName ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return name of backup archive</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">File name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveComment">global
<b>GetArchiveComment ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return user comment stored in archive. Comment is stored in file info/comment.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Archive comment</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveHostname">global
<b>GetArchiveHostname ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return host name of machine on which backup archive was created. Host name is stored in archive in file info/hostname.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Host name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveInstalledPackages">global
<b>GetArchiveInstalledPackages ()
<span class="a"> -> </span>
<span class="t">map<string,string></span>
</b>
</span>
</div>
<p>
Return map with packages installed at backup time (form is $["package name" : "version"]).</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Installed packages at backup time</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveFiles">global
<b>GetArchiveFiles ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Return list of files in the backup archive</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Files in the archive</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReadActualInstalledPackages">global
<b>ReadActualInstalledPackages ()
<span class="a"> -> </span>
<span class="t">map<string,string></span>
</b>
</span>
</div>
<p>
Read installed packages.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map $[ "packagename" : "version" ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetActualInstalledPackages">global
<b>GetActualInstalledPackages ()
<span class="a"> -> </span>
<span class="t">map<string,string></span>
</b>
</span>
</div>
<p>
Return installed packages. Result is cached in Restore module, so only first use takes long time</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map $[ "packagename" : "version" ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetMissingPackages">global
<b>GetMissingPackages ()
<span class="a"> -> </span>
<span class="t">map<string, map<string, string> ></span>
</b>
</span>
</div>
<p>
Return missing packages (packages which were installed at backup time, but at restore time they are not installed)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map $[ "packagename" : $[ "ver" : "version", "descr" : "Short description of the package"]], key description is present only if decription exists</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetExtraPackages">global
<b>GetExtraPackages ()
<span class="a"> -> </span>
<span class="t">map<string,map<string,string> ></span>
</b>
</span>
</div>
<p>
Return extra packages (packages which are installed at restore time, but at restore time they are installed)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map $[ "packagename" : $[ "ver" : "version", "descr" : "Short description of the package"]], key description is present only if decription exists</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetMismatchedPackages">global
<b>GetMismatchedPackages ()
<span class="a"> -> </span>
<span class="t">map<string, map <string, string> ></span>
</b>
</span>
</div>
<p>
Return packages which have different version at backup archive and in system</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map $[ "packagename" : $[ "inst": "installed version", "ver" : "version at backup time, "descr" : "Short description of the package"]], key description is present only if decription exists</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetSelectedPackages">global
<b>GetSelectedPackages ()
<span class="a"> -> </span>
<span class="t">map<string, map></span>
</b>
</span>
</div>
<p>
Returns selected packages (even partially).</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map with same keys as map returned by GetArchiveInfo()</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ClearInstalledPackagesCache">global
<b>ClearInstalledPackagesCache ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Clear cache of installed packages. Next use of GetActualInstalledPackages() function will reread installed packages.</p>
<div class="sigbox">
<span class="sig" id="Umount">global
<b>Umount ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Umount mounted file system.</p>
<div class="sigbox">
<span class="sig" id="mountNFS">local
<b>mountNFS (string server, string file)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Access to file on NFS server</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">server</span>
</td>
<td class="descbox">Name or IP adress of NFS server</td>
</tr>
<tr>
<td class="pbox">
<span class="p">file</span>
</td>
<td class="descbox">File on the server</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">$[ "mounted" : boolena (true on success), "mountpoint" : string (mount point) , "file" : string (file name), "server_dir" : string (directory on the server) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="mountCD">local
<b>mountCD (integer cdindex)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Access to file on CD</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">cdindex</span>
</td>
<td class="descbox">Index of CD drive (in list SCR::Read(.probe.cdrom))</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">$[ "mounted" : boolena (true on success), "mpoint" : string (mount point) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="mountFloppy">local
<b>mountFloppy (integer fdindex)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Access to file on floppy</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">fdindex</span>
</td>
<td class="descbox">Index of floppy drive (in list SCR::Read(.probe.floppy))</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">$[ "mounted" : boolena (true on success), "mpoint" : string (mount point) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="mountDevice">local
<b>mountDevice (string device)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Mount device</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">Device file name (e.g. /dev/cdrom, /dev/sda...)</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">Map $[ "mounted" : boolean (true on success), "mpoint" : string (mount point where device was mounted) ];</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="MountInput">global
<b>MountInput (string input)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Mount input source</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">input</span>
</td>
<td class="descbox">File in URl-like syntax</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">Map $[ "success" : boolean (true on success), "mpoint" : string (mount point), "file" : string (file name on the local system) ];</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CheckVolume">local
<b>CheckVolume (string filename, integer num)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Check if volume number in archive is equal to expected volume number</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">filename</span>
</td>
<td class="descbox">Volume file name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">num</span>
</td>
<td class="descbox">Number of volume</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">Map $[ "success" : boolean (true on success), "lastvolume" : boolean (true if archive is last volume) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CopyVolume">local
<b>CopyVolume (string filename, integer num)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Copy volume to the local temporary directory</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">filename</span>
</td>
<td class="descbox">Source file</td>
</tr>
<tr>
<td class="pbox">
<span class="p">num</span>
</td>
<td class="descbox">Number of volume</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">Map $[ "success" : boolean (true on success), "file" : string (file name in the temporary directory) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddVolume">local
<b>AddVolume (string file)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Add next volume - check volume, copy volume to the temp. dir.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">file</span>
</td>
<td class="descbox">File name of volume</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">Map $[ "success" : boolean (true on success), "lastvolume" : boolean (true if archive is last volume) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetRestoreSelection">global
<b>SetRestoreSelection (string pkgname, map selection)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Change restore selection of package.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkgname</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">selection</span>
</td>
<td class="descbox">New restore selection for package, map $[ "sel_type" : "X", "sel_file" : ["files"] ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetSelectionProperty">global
<b>SetSelectionProperty (map<string,map> settings)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set selection in _auto client and display properties of archive</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">Restoration selection</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read (string input)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Read contents of archive</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">input</span>
</td>
<td class="descbox">File name of backup archive. File on NFS server is 'nfs://server:/dir/file.tar', local file: 'file:///dir/file.tar' (prefix is file://, directory is /dir)</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 archive was succesfully read, otherwise false (file does not exist, not tar archive, broken archive, archive not created by Backup module, ...)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Set">global
<b>Set (map settings)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set settings</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">Map with settings: start lilo, run SuSEconfig, restore RPM db</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Import">global
<b>Import (map settings)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Get all restore settings - for use by autoinstallation</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">The YCP structure to be imported</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="Export">global
<b>Export ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Dump the restore settings to a single map - for use by autoinstallation.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Dumped settings (later acceptable by Import ())</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetArchiveInfo">global
<b>GetArchiveInfo ()
<span class="a"> -> </span>
<span class="t">map<string, map<string, any> ></span>
</b>
</span>
</div>
<p>
Return restore configuration</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map $[ "packagename" : $["vers" : "version", "files" : ["files in the archive"], "prefix" : "installprefix", "descr" : "Short description", "sel_type" : "X", "sel_file" : ["selected files to restore"] ] ], possible values for "sel_type" key are: "X" - restore all files from archive, " " - do not restore this package, "P" - partial restore, restore only selected files at "sel_file" key. Package name "" means files not owned by any package.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="TotalPackagesToRestore">global
<b>TotalPackagesToRestore ()
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Return number of packages which will be restored from archive</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Total selected packages</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="TotalFilesToRestore">global
<b>TotalFilesToRestore ()
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Return number of files which will be unpacked from archive</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Total selected files</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ActivateBootloader">global
<b>ActivateBootloader ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Activate boot loader configuration if requested.
Uses variable Restore::runbootloader</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="Write">global
<b>Write (block<boolean> abort, symbol progress, string targetdir)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Restore files from archive</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">abort</span>
</td>
<td class="descbox">This block is periodically evaluated, if it evaluates to true restoration will be aborted. It should be something like ``{return UI::PollInput () == `abort;} if UI exists or ``{ return false; } if there is no UI (abort will not be possible).</td>
</tr>
<tr>
<td class="pbox">
<span class="p">progress</span>
</td>
<td class="descbox">Id of progress bar or nil.</td>
</tr>
<tr>
<td class="pbox">
<span class="p">targetdir</span>
</td>
<td class="descbox">Directory to which files from archive will be upacked</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">Map $[ "aborted" : boolean, "restored" : [ "restored file" ], "failed" : [ "failed file" ] ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReadNextVolume">global
<b>ReadNextVolume (string input)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Read next volume of multi volume archive</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">input</span>
</td>
<td class="descbox">Archive name in URL-like syntax</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">Map $[ "success" : boolean (true on success), "lastvolume" : boolean (true if archive is last volume) ]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="TestAllVolumes">global
<b>TestAllVolumes ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Test all volumes together</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">True: all volumes are OK, false: an error occured</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ResetArchiveSelection">global
<b>ResetArchiveSelection ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Clear all archive settings</p>
<div class="sigbox">
<span class="sig" id="ResetAll">global
<b>ResetAll ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Clear all settings (archive and list of installed packages)</p>
<div class="sigbox">
<span class="sig" id="RemoveShortCut">local
<b>RemoveShortCut (string scut)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Remove shortcut mark from string</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">scut</span>
</td>
<td class="descbox">string with shortcut mark (&)</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">result</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="yesno">local
<b>yesno (boolean b)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Convert boolean value to translated "yes" or "no" string</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">b</span>
</td>
<td class="descbox">input value</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">translated Yes/No string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Summary">global
<b>Summary ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create restore configuration summary. Used in autoinstallation restore module configuration.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">rich text summary</td>
</tr>
</table>
</dd>
</dl>
</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