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>
Backup 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>
Backup 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>
Backup module
</h1>
</td>
<td class="filecell">
functions.ycp
</td>
</tr>
<tr>
<td></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>
Functions used by backup module.
<h1>Imports</h1>
<ul>
<li>AutoinstClone</li>
<li>Directory</li>
<li>FileSystems</li>
<li>FileUtils</li>
<li>FileUtils</li>
<li>Label</li>
<li>Mode</li>
<li>Nfs</li>
<li>Popup</li>
<li>Profile</li>
<li>Report</li>
<li>Storage</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#AbortConfirmation">AbortConfirmation (symbol type)</a>
</li>
<li>
<a href="#AddId">AddId (list<string> in)</a>
</li>
<li>
<a href="#AddIdBool">AddIdBool (list in, boolean val)</a>
</li>
<li>
<a href="#AddIdExt2">AddIdExt2 (list<map<string, any> > in)</a>
</li>
<li>
<a href="#AddMissingExtension">AddMissingExtension (string file, string extension)</a>
</li>
<li>
<a href="#CloneSystem">CloneSystem (string filename, list<string> additional, string extra_key, map extra_options)</a>
</li>
<li>
<a href="#CreateUnderLine">CreateUnderLine (string input, string ch)</a>
</li>
<li>
<a href="#DetectMountpoints">DetectMountpoints ()</a>
</li>
<li>
<a href="#Ext2Filesystems">Ext2Filesystems ()</a>
</li>
<li>
<a href="#Ext2MountPoint">Ext2MountPoint (string device_name)</a>
</li>
<li>
<a href="#GetBaseName">GetBaseName (string file)</a>
</li>
<li>
<a href="#GetInstallPackages">GetInstallPackages ()</a>
</li>
<li>
<a href="#GetListWithFlags">GetListWithFlags (list<string> in, list<string> selected)</a>
</li>
<li>
<a href="#GetMountedFilesystems">GetMountedFilesystems ()</a>
</li>
<li>
<a href="#MediaList2UIList">MediaList2UIList (list<map<string, any> > media)</a>
</li>
<li>
<a href="#MpointTableContents">MpointTableContents (list<string> selected, list<string> all, map<string,map> description)</a>
</li>
<li>
<a href="#NFSFileExists">NFSFileExists (string server, string share, string filename)</a>
</li>
<li>
<a href="#NFSfile">NFSfile (string server, string share, string filename)</a>
</li>
<li>
<a href="#SecondsToDateString">SecondsToDateString (integer sec)</a>
</li>
<li>
<a href="#SendMail">SendMail (string user, string subject, string message)</a>
</li>
<li>
<a href="#SendSummary">SendSummary (map remove_result, string cron_profile, string backup_result, string backup_details)</a>
</li>
<li>
<a href="#SetMultiWidgetsState">SetMultiWidgetsState ()</a>
</li>
<li>
<a href="#ShowEditDialog">ShowEditDialog (string label, string value, list<string> values, list <string> forbidden_letters)</a>
</li>
<li>
<a href="#get_free_space">get_free_space (string directory)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="AbortConfirmation">local
<b>AbortConfirmation (symbol type)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Display abort confirmation dialog</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">type</span>
</td>
<td class="descbox">Select dialog type, possible values: `changed, `not_changed or `none for none dialog</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">False if user select to not abort, true otherwise.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ShowEditDialog">local
<b>ShowEditDialog (string label, string value, list<string> values, list <string> forbidden_letters)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Ask user for some value: display dialog with label, text entry and OK/Cancel buttons.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">label</span>
</td>
<td class="descbox">Displayed text above the text entry in the dialog</td>
</tr>
<tr>
<td class="pbox">
<span class="p">value</span>
</td>
<td class="descbox">Default text in text entry, for empty text set value to "" or nil</td>
</tr>
<tr>
<td class="pbox">
<span class="p">values</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">forbidden_letters</span>
</td>
<td class="descbox"></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">Returned map: $[ "text" : string, "clicked" : symbol ]. Value with key text is string entered by user, symbol is `ok or `cancel depending which button was pressed.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetMountedFilesystems">local
<b>GetMountedFilesystems ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Returns list of mounted file systems types.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">List of strings, each mounted file system type is reported only onetimes, list is alphabetically sorted.</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
GetMountedFilesystems() -> [ "devpts", "ext2", "nfs", "proc", "reiserfs" ]</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Ext2Filesystems">local
<b>Ext2Filesystems ()
<span class="a"> -> </span>
<span class="t">list<map<string, any> ></span>
</b>
</span>
</div>
<p>
Returns list of Ext2 mountpoints - actually mounted and from /etc/fstab file</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">List of strings</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
Ext2Filesystems() -> [ "/dev/hda1", "/dev/hda4" ]</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetListWithFlags">local
<b>GetListWithFlags (list<string> in, list<string> selected)
<span class="a"> -> </span>
<span class="t">list<term></span>
</b>
</span>
</div>
<p>
This function reads two lists: full list and selection list (contains subset of items in full list). Returned list can be used in MultiSelectionBox widget.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">in</span>
</td>
<td class="descbox">List of items</td>
</tr>
<tr>
<td class="pbox">
<span class="p">selected</span>
</td>
<td class="descbox">List with subset of items from list in.</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">List of alphabetically sorted strings</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
GetListWithFlags(["/dev", "/etc"], ["/etc"]) -> [`item (`id ("/dev"), "/dev", false), `item (`id ("/etc"), "/etc", true)]</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddIdBool">local
<b>AddIdBool (list in, boolean val)
<span class="a"> -> </span>
<span class="t">list<term></span>
</b>
</span>
</div>
<p>
Set boolean value val to all items in list.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">in</span>
</td>
<td class="descbox">Input list of items</td>
</tr>
<tr>
<td class="pbox">
<span class="p">val</span>
</td>
<td class="descbox">Requested 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">List of items</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
AddIdBool( [ `item(`id("ext2"), "ext2", true) ], false) ) -> [ `item (`id ("ext2"), "ext2", false) ]</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddId">local
<b>AddId (list<string> in)
<span class="a"> -> </span>
<span class="t">list<term></span>
</b>
</span>
</div>
<p>
Returns list of items from list of values.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">in</span>
</td>
<td class="descbox">Input list of values</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">List of items</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
AddId("abc", "123") -> [`item(`id("abc"), "abc"), `item(`id("123"), "123")]</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddIdExt2">local
<b>AddIdExt2 (list<map<string, any> > in)
<span class="a"> -> </span>
<span class="t">list<term></span>
</b>
</span>
</div>
<p>
Returns list of items from list of values.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">in</span>
</td>
<td class="descbox">Input list of maps with keys "partition", "mountpoints" and strings as values</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">List of items</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
AddId([ $["partition" : "/dev/hda3", "mountpoint" : "/usr"] ]) -> [`item(`id("/dev/hda3"), "/dev/hda3", "/usr")]</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="MediaList2UIList">local
<b>MediaList2UIList (list<map<string, any> > media)
<span class="a"> -> </span>
<span class="t">list<term></span>
</b>
</span>
</div>
<p>
Convert media description list to ComboBox items list</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">media</span>
</td>
<td class="descbox">Medium descriptions - list of maps with keys (and values): "label" (description string), "symbol" (identification symbol), "capacity" (size of free space on empty medium)</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">Items list for UI widgets</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetMultiWidgetsState">local
<b>SetMultiWidgetsState ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set state of depending widgets in Multiple volume options dialog</p>
<div class="sigbox">
<span class="sig" id="Ext2MountPoint">local
<b>Ext2MountPoint (string device_name)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return mount point for Ext2 partition. This function at first checks if partition is mounted. If yes it returns actual mout point, if no it searches mount point from /etc/fstab file.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device_name</span>
</td>
<td class="descbox">Name of device</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">Mount point of device or nil if device does not exist or there is other file system than Ext2</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
Ext2MountPoint("/dev/hda1") -> "/boot"</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddMissingExtension">local
<b>AddMissingExtension (string file, string extension)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Add extension to the file name if it is missing.
This function skips adding when the file is under the /dev/ path
or when it is an existing device file.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">file</span>
</td>
<td class="descbox">filname</td>
</tr>
<tr>
<td class="pbox">
<span class="p">extension</span>
</td>
<td class="descbox">file extension (with dot)</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">filename with extension</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
AddMissingExtension("filename", ".ext") -> "filename.ext"
AddMissingExtension("filename.tar", ".gz") -> "filename.tar.gz"
AddMissingExtension("filename.tar", ".tar") -> "filename.tar"</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetBaseName">local
<b>GetBaseName (string file)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get base file name without extension</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">file</span>
</td>
<td class="descbox">file name</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">base file name</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
GetBaseName("file.ext") -> "file"
GetBaseName("file") -> "file"
GetBaseName("dir/file.ext") -> "file"</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SendMail">local
<b>SendMail (string user, string subject, string message)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Send mail to specified user</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">user</span>
</td>
<td class="descbox">Target email address</td>
</tr>
<tr>
<td class="pbox">
<span class="p">subject</span>
</td>
<td class="descbox">Subject string</td>
</tr>
<tr>
<td class="pbox">
<span class="p">message</span>
</td>
<td class="descbox">Message body</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="CreateUnderLine">local
<b>CreateUnderLine (string input, string ch)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create string from character ch with the same lenght as input</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">input</span>
</td>
<td class="descbox">Input string</td>
</tr>
<tr>
<td class="pbox">
<span class="p">ch</span>
</td>
<td class="descbox">String used in output</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">String containg size(input) character</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SendSummary">local
<b>SendSummary (map remove_result, string cron_profile, string backup_result, string backup_details)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Send summary mail of the backup process to root.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">remove_result</span>
</td>
<td class="descbox">Result of removing/renaming of the old archives</td>
</tr>
<tr>
<td class="pbox">
<span class="p">cron_profile</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">backup_result</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">backup_details</span>
</td>
<td class="descbox"></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="SecondsToDateString">local
<b>SecondsToDateString (integer sec)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Convert number of second since 1.1.1970 to string. Result has format YYYYMMDDHHMMSS</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sec</span>
</td>
<td class="descbox">Number of seconds</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">String representation of the time, returns input value (sec) if an error occured</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetInstallPackages">local
<b>GetInstallPackages ()
<span class="a"> -> </span>
<span class="t">list <string></span>
</b>
</span>
</div>
<p>
Read packages available on the installation sources
(Requires at least one installation source, otherwise return empty list)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">available packages</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CloneSystem">local
<b>CloneSystem (string filename, list<string> additional, string extra_key, map extra_options)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Store autoyast profile of the system to file</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">filename</span>
</td>
<td class="descbox">where setting will be saved</td>
</tr>
<tr>
<td class="pbox">
<span class="p">additional</span>
</td>
<td class="descbox">additional part of system to clone</td>
</tr>
<tr>
<td class="pbox">
<span class="p">extra_key</span>
</td>
<td class="descbox">name of the extra configuration</td>
</tr>
<tr>
<td class="pbox">
<span class="p">extra_options</span>
</td>
<td class="descbox">options for extra_key</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="DetectMountpoints">local
<b>DetectMountpoints ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Detect mount points</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">map of mount points</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="MpointTableContents">local
<b>MpointTableContents (list<string> selected, list<string> all, map<string,map> description)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Create table content with detected mount points</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">selected</span>
</td>
<td class="descbox">selected mount points to use</td>
</tr>
<tr>
<td class="pbox">
<span class="p">all</span>
</td>
<td class="descbox">all detected mount points + user defined dirs</td>
</tr>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">detected mount points</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">table content</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="NFSFileExists">local
<b>NFSFileExists (string server, string share, string filename)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check whether file on the NFS server exists</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">server</span>
</td>
<td class="descbox">remote server name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">share</span>
</td>
<td class="descbox">exported directory</td>
</tr>
<tr>
<td class="pbox">
<span class="p">filename</span>
</td>
<td class="descbox">name of the file</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 - file exists, false - file doesn't exist, nil - error (mount failed)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="NFSfile">local
<b>NFSfile (string server, string share, string filename)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create NFS file description string</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">server</span>
</td>
<td class="descbox">server name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">share</span>
</td>
<td class="descbox">exported directory name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">filename</span>
</td>
<td class="descbox">remote file name</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 (nil if any of the parameter is nil)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_free_space">local
<b>get_free_space (string directory)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Get available space in the directory</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">directory</span>
</td>
<td class="descbox">selected directory</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">on success returns parsed df output in a map
$["device" : string(device), "total" : integer(total), "used" : integer(used), "free" : integer(free) ]</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