/usr/share/doc/ice34-slice/reference/Ice/Properties.html is in ice34-slice 3.4.2-8.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>
Ice::Properties
</title>
<style type="text/css">
body {
font-family: Arial, Helvetica, sans-serif;
}
.Page {
width: 850px;
margin-left: auto;
margin-right: auto;
}
.Symbol {
font-family: "Courier New", Courier, mono;
}
.Synopsis {
font-family: "Courier New", Courier, mono;
font-weight: bold;
}
.Deprecated {
font-style: italic;
}
.Warning {
font-style: italic;
}
.Note {
font-style: italic;
}
.HeaderFooter {
width: 100%;
}
.Logo {
border-style: none;
}
.LogoTable {
}
.Button {
border-style: none;
}
.ButtonGrey {
border-style: none;
cursor: default;
}
</style>
</head>
<body>
<div class="Page">
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html"><img class="Button" src="../images/home.gif" alt="Home"></a></td>
<td><a href="Process.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Ice.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="PropertiesAdmin.html"><img class="Button" src="../images/next.gif" alt="Next"></a></td>
<td><a href="../_sindex.html"><img class="Button" src="../images/index.gif" alt="Index"></a></td>
</tr>
</table>
</td>
<td align="center">
<table>
<tr>
<td>
<form method="get" action="/cgi-bin/swish.cgi" enctype="application/x-www-form-urlencoded" class="form">
<div>
<input maxlength="100" value="" type="text" name="query">
<input type="submit" value="Search" name="submit"></div>
</form></td>
</tr>
</table>
</td>
<td align="right">
<table class="LogoTable">
<tr>
<td><a href="http://www.zeroc.com"><img class="Logo" src="../images/logo.gif" alt="Logo"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- SwishCommand index -->
<hr>
<h1 class="Symbol">Ice::Properties</h1>
<h2>Overview</h2>
<h3 class="Synopsis">local interface Properties</h3>
<p>
A property set used to configure Ice and Ice applications.
Properties are key/value pairs, with both keys and values
being strings. By convention, property keys should have the form
<em>application-name</em>[.<em>category</em>[.<em>sub-category</em>]].<em>name</em>.</p>
<h4>Used By</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#clone">clone</a></dt>
<dt class="Symbol"><a class="Symbol" href="Communicator.html#getProperties">Communicator::getProperties</a></dt>
</dl>
<h2>Operation Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="#getProperty">getProperty</a></dt>
<dd>
Get a property by key.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPropertyWithDefault">getPropertyWithDefault</a></dt>
<dd>
Get a property by key.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPropertyAsInt">getPropertyAsInt</a></dt>
<dd>
Get a property as an integer.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPropertyAsIntWithDefault">getPropertyAsIntWithDefault</a></dt>
<dd>
Get a property as an integer.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPropertyAsList">getPropertyAsList</a></dt>
<dd>
Get a property as a list of strings.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPropertyAsListWithDefault">getPropertyAsListWithDefault</a></dt>
<dd>
Get a property as a list of strings.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPropertiesForPrefix">getPropertiesForPrefix</a></dt>
<dd>
Get all properties whose keys begins with
<em>prefix</em>.</dd>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
<dd>
Set a property.</dd>
<dt class="Symbol"><a class="Symbol" href="#getCommandLineOptions">getCommandLineOptions</a></dt>
<dd>
Get a sequence of command-line options that is equivalent to
this property set.</dd>
<dt class="Symbol"><a class="Symbol" href="#parseCommandLineOptions">parseCommandLineOptions</a></dt>
<dd>
Convert a sequence of command-line options into properties.</dd>
<dt class="Symbol"><a class="Symbol" href="#parseIceCommandLineOptions">parseIceCommandLineOptions</a></dt>
<dd>
Convert a sequence of command-line options into properties.</dd>
<dt class="Symbol"><a class="Symbol" href="#load">load</a></dt>
<dd>
Load properties from a file.</dd>
<dt class="Symbol"><a class="Symbol" href="#clone">clone</a></dt>
<dd>
Create a copy of this property set.</dd>
</dl>
<h2>Operations</h2>
<h3 class="Synopsis">string <a class="Symbol" name="getProperty">getProperty</a>(string key)</h3>
<p>
Get a property by key. If the property is not set, an empty
string is returned.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
</dl>
<h4>Return Value</h4>
<p>The property value.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
</dl>
<h3 class="Synopsis">string <a class="Symbol" name="getPropertyWithDefault">getPropertyWithDefault</a>(string key, string value)</h3>
<p>
Get a property by key. If the property is not set, the
given default value is returned.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
<dt class="Symbol">value</dt>
<dd>
The default value to use if the property does not
exist.</dd>
</dl>
<h4>Return Value</h4>
<p>The property value or the default value.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
</dl>
<h3 class="Synopsis">int <a class="Symbol" name="getPropertyAsInt">getPropertyAsInt</a>(string key)</h3>
<p>
Get a property as an integer. If the property is not set, 0
is returned.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
</dl>
<h4>Return Value</h4>
<p>The property value interpreted as an integer.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
</dl>
<h3 class="Synopsis">int <a class="Symbol" name="getPropertyAsIntWithDefault">getPropertyAsIntWithDefault</a>(string key, int value)</h3>
<p>
Get a property as an integer. If the property is not set, the
given default value is returned.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
<dt class="Symbol">value</dt>
<dd>
The default value to use if the property does not
exist.</dd>
</dl>
<h4>Return Value</h4>
<p>The property value interpreted as an integer, or the
default value.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> <a class="Symbol" name="getPropertyAsList">getPropertyAsList</a>(string key)</h3>
<p>
Get a property as a list of strings. If the property is not set,
an empty list is returned. The strings in the list can contain
whitespace if they are enclosed in single or double quotes.
If quotes are mismatched, an empty list is returned.
Within single quotes or double-quotes, you can escape the
quote in question with \, e.g. O'Reilly can be written as
O'Reilly, "O'Reilly" or 'O\'Reilly'.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
</dl>
<h4>Return Value</h4>
<p>The property value interpreted as a list of strings.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> <a class="Symbol" name="getPropertyAsListWithDefault">getPropertyAsListWithDefault</a>(string key, <a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> value)</h3>
<p>
Get a property as a list of strings. If the property is not set,
the default list is returned. The strings in the list can contain
whitespace if they are enclosed in single or double quotes.
If quotes are mismatched, the default list is returned.
Within single quotes or double-quotes, you can escape the
quote in question with \, e.g. O'Reilly can be written as
O'Reilly, "O'Reilly" or 'O\'Reilly'.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
<dt class="Symbol">value</dt>
<dd>
The default value to use if the property is not set.</dd>
</dl>
<h4>Return Value</h4>
<p>The property value interpreted as list of strings, or the
default value.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setProperty">setProperty</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#PropertyDict">PropertyDict</a> <a class="Symbol" name="getPropertiesForPrefix">getPropertiesForPrefix</a>(string prefix)</h3>
<p>
Get all properties whose keys begins with
<em>prefix</em>. If
<em>prefix</em> is an empty string,
then all properties are returned.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">prefix</dt>
<dd>
The prefix to search for (empty string if none).</dd>
</dl>
<h4>Return Value</h4>
<p>The matching property set.</p>
<h3 class="Synopsis">void <a class="Symbol" name="setProperty">setProperty</a>(string key, string value)</h3>
<p>
Set a property. To unset a property, set it to
the empty string.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">key</dt>
<dd>
The property key.</dd>
<dt class="Symbol">value</dt>
<dd>
The property value.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#getProperty">getProperty</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> <a class="Symbol" name="getCommandLineOptions">getCommandLineOptions</a>()</h3>
<p>
Get a sequence of command-line options that is equivalent to
this property set. Each element of the returned sequence is
a command-line option of the form
<tt>--<em>key</em>=<em>value</em></tt>.</p>
<h4>Return Value</h4>
<p>The command line options for this property set.</p>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> <a class="Symbol" name="parseCommandLineOptions">parseCommandLineOptions</a>(string prefix, <a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> options)</h3>
<p>
Convert a sequence of command-line options into properties.
All options that begin with
<tt>--<em>prefix</em>.</tt> are
converted into properties. If the prefix is empty, all options
that begin with <tt>--</tt> are converted to properties.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">prefix</dt>
<dd>
The property prefix, or an empty string to
convert all options starting with <tt>--</tt>.</dd>
<dt class="Symbol">options</dt>
<dd>
The command-line options.</dd>
</dl>
<h4>Return Value</h4>
<p>The command-line options that do not start with the specified
prefix, in their original order.</p>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> <a class="Symbol" name="parseIceCommandLineOptions">parseIceCommandLineOptions</a>(<a class="Symbol" href="../Ice.html#StringSeq">StringSeq</a> options)</h3>
<p>
Convert a sequence of command-line options into properties.
All options that begin with one of the following prefixes
are converted into properties: <tt>--Ice</tt>, <tt>--IceBox</tt>, <tt>--IceGrid</tt>,
<tt>--IcePatch2</tt>, <tt>--IceSSL</tt>, <tt>--IceStorm</tt>, <tt>--Freeze</tt>, and <tt>--Glacier2</tt>.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">options</dt>
<dd>
The command-line options.</dd>
</dl>
<h4>Return Value</h4>
<p>The command-line options that do not start with one of
the listed prefixes, in their original order.</p>
<h3 class="Synopsis">void <a class="Symbol" name="load">load</a>(string file)</h3>
<p>
Load properties from a file.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">file</dt>
<dd>
The property file.</dd>
</dl>
<h3 class="Synopsis">Properties <a class="Symbol" name="clone">clone</a>()</h3>
<p>
Create a copy of this property set.</p>
<h4>Return Value</h4>
<p>A copy of this property set.</p>
<hr>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html"><img class="Button" src="../images/home.gif" alt="Home"></a></td>
<td><a href="Process.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Ice.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="PropertiesAdmin.html"><img class="Button" src="../images/next.gif" alt="Next"></a></td>
<td><a href="../_sindex.html"><img class="Button" src="../images/index.gif" alt="Index"></a></td>
</tr>
</table>
</td>
<td align="center">
<table>
<tr>
<td>
<form method="get" action="/cgi-bin/swish.cgi" enctype="application/x-www-form-urlencoded" class="form">
<div>
<input maxlength="100" value="" type="text" name="query">
<input type="submit" value="Search" name="submit"></div>
</form></td>
</tr>
</table>
</td>
<td align="right">
<table class="LogoTable">
<tr>
<td><a href="http://www.zeroc.com"><img class="Logo" src="../images/logo.gif" alt="Logo"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- SwishCommand index -->
</div>
</body>
</html>
|