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 sysconfig</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 sysconfig</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 sysconfig</h1>
</td>
<td class="filecell">modules/Sysconfig.ycp</td>
</tr>
<tr>
<td>Data for configuration of sysconfig, 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 sysconfig.
Input and output routines.
<h1>Imports</h1>
<ul>
<li>Directory</li>
<li>IP</li>
<li>Label</li>
<li>Mode</li>
<li>Progress</li>
<li>Report</li>
<li>Service</li>
<li>String</li>
<li>Summary</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#Export">Export ()</a>
</li>
<li>
<a href="#Import">Import (list settings)</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#Read">Read ()</a>
</li>
<li>
<a href="#RegisterAgents">RegisterAgents ()</a>
</li>
<li>
<a href="#Search">Search (map params, boolean show_progress)</a>
</li>
<li>
<a href="#Set">Set (list<map> settings)</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#Write">Write ()</a>
</li>
<li>
<a href="#get_all">get_all ()</a>
</li>
<li>
<a href="#get_all_names">get_all_names ()</a>
</li>
<li>
<a href="#get_description">get_description (string varid)</a>
</li>
<li>
<a href="#get_file_from_id">get_file_from_id (string id)</a>
</li>
<li>
<a href="#get_location_from_id">get_location_from_id (string id)</a>
</li>
<li>
<a href="#get_metadata">get_metadata (string input)</a>
</li>
<li>
<a href="#get_modified">get_modified ()</a>
</li>
<li>
<a href="#get_name_from_id">get_name_from_id (string id)</a>
</li>
<li>
<a href="#get_only_comment">get_only_comment (string input)</a>
</li>
<li>
<a href="#modified">modified (string varid)</a>
</li>
<li>
<a href="#parse_metadata">parse_metadata (string comment)</a>
</li>
<li>
<a href="#remove_whitespaces">remove_whitespaces (string input)</a>
</li>
<li>
<a href="#set_value">set_value (string variable, string new_value, boolean force, boolean force_change)</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#ConfirmationDialog">ConfirmationDialog (string message, string command)</a>
</li>
<li>
<a href="#StartCommand">StartCommand (string start_command, string label, string error, string confirm, boolean confirmaction)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<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>
Data was modified?</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="get_name_from_id">global
<b>get_name_from_id (string id)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get variable name from variable identification or empty string if input is invalid</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">id</span>
</td>
<td class="descbox">Variable identification</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">Variable name</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
get_name_from_id("var$file") -> "var"</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_file_from_id">global
<b>get_file_from_id (string id)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get file name where is variable located from variable identification</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">id</span>
</td>
<td class="descbox">Variable identification</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">File name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_only_comment">global
<b>get_only_comment (string input)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get comment without metadata</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>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Comment used as variable description</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Search">global
<b>Search (map params, boolean show_progress)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Search in syscnfig files for value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">params</span>
</td>
<td class="descbox">search parameters</td>
</tr>
<tr>
<td class="pbox">
<span class="p">show_progress</span>
</td>
<td class="descbox">if true progress bar will be displayed</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 found variables (IDs)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="remove_whitespaces">global
<b>remove_whitespaces (string input)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Remove white spaces at beginning or at the end of string</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>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">String without white spaces</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_metadata">global
<b>get_metadata (string input)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get metadata lines from input string</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>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Metadata lines in list</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="parse_metadata">global
<b>parse_metadata (string comment)
<span class="a"> -> </span>
<span class="t">map<string, string></span>
</b>
</span>
</div>
<p>
Parse metadata from comment</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">comment</span>
</td>
<td class="descbox">Input comment</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">parsed metadata</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_location_from_id">global
<b>get_location_from_id (string id)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get variable location in tree widget from variable identification</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">id</span>
</td>
<td class="descbox">Variable identification</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">Variable location</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_description">global
<b>get_description (string varid)
<span class="a"> -> </span>
<span class="t">map<string, any></span>
</b>
</span>
</div>
<p>
Get description of selected variable</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">varid</span>
</td>
<td class="descbox">Variable identification</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">Description map</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="set_value">global
<b>set_value (string variable, string new_value, boolean force, boolean force_change)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Set new variable value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">variable</span>
</td>
<td class="descbox">Variable identification</td>
</tr>
<tr>
<td class="pbox">
<span class="p">new_value</span>
</td>
<td class="descbox">New value</td>
</tr>
<tr>
<td class="pbox">
<span class="p">force</span>
</td>
<td class="descbox">If true - do not check if new value is valid</td>
</tr>
<tr>
<td class="pbox">
<span class="p">force_change</span>
</td>
<td class="descbox">Force value as changed even if it is equal to old 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">Result: `not_found (specified variable was not found in config file),
`not_valid (new value is not valid - doesn't match variable type definition),
`ok (success)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="modified">global
<b>modified (string varid)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Return modification status of variable</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">varid</span>
</td>
<td class="descbox">Variable identification</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 variable was modified</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_modified">global
<b>get_modified ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get list of modified variables</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">List of modified variables</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_all">global
<b>get_all ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get list of all variables</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">List of variable identifications</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_all_names">global
<b>get_all_names ()
<span class="a"> -> </span>
<span class="t">map<string, list<string> ></span>
</b>
</span>
</div>
<p>
Get map of all variables</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Map of variable names, key is variable name, value is a list of variable identifications</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="RegisterAgents">global
<b>RegisterAgents ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Register .syseditor path (use INI agent in multiple file mode)</p>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Read all sysconfig variables</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="ConfirmationDialog">local
<b>ConfirmationDialog (string message, string command)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Display confirmation dialog</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">message</span>
</td>
<td class="descbox">Confirmation message</td>
</tr>
<tr>
<td class="pbox">
<span class="p">command</span>
</td>
<td class="descbox">Command to confirm</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">`cont - start command, `skip - skip this command, `abort - skip all remaining commands</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StartCommand">local
<b>StartCommand (string start_command, string label, string error, string confirm, boolean confirmaction)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Start activation command, ask user to confirm it when it is required.
Display specified error message when the command fails.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">start_command</span>
</td>
<td class="descbox">Command to start</td>
</tr>
<tr>
<td class="pbox">
<span class="p">label</span>
</td>
<td class="descbox">Progress bar label</td>
</tr>
<tr>
<td class="pbox">
<span class="p">error</span>
</td>
<td class="descbox">Error message displayed when command failes</td>
</tr>
<tr>
<td class="pbox">
<span class="p">confirm</span>
</td>
<td class="descbox">Confirmation messge</td>
</tr>
<tr>
<td class="pbox">
<span class="p">confirmaction</span>
</td>
<td class="descbox">Display confirmation 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">`success - command was started, `failed - command failed (non-zero exit value),
`skip - command was skipped, `abort - command starting was aborted</td>
</tr>
</table>
</dd>
</dl>
<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 all sysconfig settings</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="Set">global
<b>Set (list<map> settings)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set all sysconfig settings from the list
(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 set.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Import">global
<b>Import (list settings)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Set all sysconfig settings from the list and read information from files
(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">list</span>
</b>
</span>
</div>
<p>
Dump the sysconfig 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="Summary">global
<b>Summary ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create a textual summary</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">summary of the current configuration</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