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>
Configuration of ntp-client</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>
Configuration of ntp-client</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>
Configuration of ntp-client</h1>
</td>
<td class="filecell">include/ntp-client/misc.ycp</td>
</tr>
<tr>
<td>Miscelanous functions for configuration of ntp-client.</td>
</tr>
<tr>
<td>
<ul>
<li>Jiri Srain <jsrain@suse.cz></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>CWMFirewallInterfaces</li>
<li>IP</li>
<li>NtpClient</li>
<li>Popup</li>
<li>Progress</li>
<li>Service</li>
</ul>
<h1>Includes</h1>
<ul>
<li>ntp-client/clocktypes.ycp</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#PollAbort">PollAbort ()</a>
</li>
<li>
<a href="#ReallyAbort">ReallyAbort ()</a>
</li>
<li>
<a href="#getClockType">getClockType (string address)</a>
</li>
<li>
<a href="#getClockTypesCombo">getClockTypesCombo ()</a>
</li>
<li>
<a href="#getClockUnitNumber">getClockUnitNumber (string address)</a>
</li>
<li>
<a href="#opts2string">opts2string (map<string,any> options, string other)</a>
</li>
<li>
<a href="#proposeInterfacesToAllowAccess">proposeInterfacesToAllowAccess ()</a>
</li>
<li>
<a href="#reallyExit">reallyExit ()</a>
</li>
<li>
<a href="#restartNtpDaemon">restartNtpDaemon ()</a>
</li>
<li>
<a href="#setClockType">setClockType (string address, integer clock_type)</a>
</li>
<li>
<a href="#setClockUnitNumber">setClockUnitNumber (string address, integer unit_number)</a>
</li>
<li>
<a href="#silentWrite">silentWrite ()</a>
</li>
<li>
<a href="#string2opts">string2opts (string options_string, list<string> with_param, list<string> without_param)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="reallyExit">local
<b>reallyExit ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Ask user if exit without saving</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if exit</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="restartNtpDaemon">local
<b>restartNtpDaemon ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Restart the NTP daemon service</p>
<div class="sigbox">
<span class="sig" id="silentWrite">local
<b>silentWrite ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Write the NTP settings without displaying progress</p>
<div class="sigbox">
<span class="sig" id="string2opts">local
<b>string2opts (string options_string, list<string> with_param, list<string> without_param)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Parse string to map of options</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">options_string</span>
</td>
<td class="descbox">string of options</td>
</tr>
<tr>
<td class="pbox">
<span class="p">with_param</span>
</td>
<td class="descbox">a list of options that must have a parameter</td>
</tr>
<tr>
<td class="pbox">
<span class="p">without_param</span>
</td>
<td class="descbox">a list of options that don't have any parameter</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">options as a map</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="opts2string">local
<b>opts2string (map<string,any> options, string other)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create options string from a map</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">options</span>
</td>
<td class="descbox">a map options represented as a map</td>
</tr>
<tr>
<td class="pbox">
<span class="p">other</span>
</td>
<td class="descbox">string other options that were set as string</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">options represented as a string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReallyAbort">local
<b>ReallyAbort ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
If modified, ask for confirmation</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if abort is confirmed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="PollAbort">local
<b>PollAbort ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check for pending Abort press</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if pending abort</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getClockType">local
<b>getClockType (string address)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Get the type of the clock from the address</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">address</span>
</td>
<td class="descbox">string the clock identification in the IP address form</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">the clock type</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="setClockType">local
<b>setClockType (string address, integer clock_type)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Set the clock type into an IP address</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">address</span>
</td>
<td class="descbox">string the IP address to patch the clock number into</td>
</tr>
<tr>
<td class="pbox">
<span class="p">clock_type</span>
</td>
<td class="descbox">integer the clock type to be set</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">IP address with clock type set correctly</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getClockUnitNumber">local
<b>getClockUnitNumber (string address)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Get the unit number of the clock from the address</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">address</span>
</td>
<td class="descbox">string the clock identification in the IP address form</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">the unit number</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="setClockUnitNumber">local
<b>setClockUnitNumber (string address, integer unit_number)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Set the clock unit number into an IP address</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">address</span>
</td>
<td class="descbox">string the IP address to patch the clock number into</td>
</tr>
<tr>
<td class="pbox">
<span class="p">unit_number</span>
</td>
<td class="descbox">integer the unit number to be set</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">IP address with unit number set correctly</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getClockTypesCombo">local
<b>getClockTypesCombo ()
<span class="a"> -> </span>
<span class="t">list<list<string> ></span>
</b>
</span>
</div>
<p>
Get entries for the clock type combo box</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">of items for the combo box</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="proposeInterfacesToAllowAccess">local
<b>proposeInterfacesToAllowAccess ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Propose the interface to be allowed for access in firewall
At the moment not used</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