--- a/src/eric7/Documentation/Source/eric7.SystemUtilities.OSUtilities.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.OSUtilities.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,24 +7,22 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.SystemUtilities.OSUtilities</h1>
-
<p>
Module implementing Operating System related utility functions.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#getEnvironmentEntry">getEnvironmentEntry</a></td>
<td>Module function to get an environment entry.</td>
@@ -74,15 +72,16 @@
<td>Function to get the user's real name (aka.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="getEnvironmentEntry" ID="getEnvironmentEntry"></a>
<h2>getEnvironmentEntry</h2>
<b>getEnvironmentEntry</b>(<i>key, default=None</i>)
-
<p>
Module function to get an environment entry.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -113,10 +112,10 @@
<a NAME="getHomeDir" ID="getHomeDir"></a>
<h2>getHomeDir</h2>
<b>getHomeDir</b>(<i></i>)
-
<p>
Function to get a users home directory.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -135,10 +134,10 @@
<a NAME="getRealName" ID="getRealName"></a>
<h2>getRealName</h2>
<b>getRealName</b>(<i></i>)
-
<p>
Function to get the real name of the user.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -157,10 +156,10 @@
<a NAME="getUserName" ID="getUserName"></a>
<h2>getUserName</h2>
<b>getUserName</b>(<i></i>)
-
<p>
Function to get the user name.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -179,10 +178,10 @@
<a NAME="hasEnvironmentEntry" ID="hasEnvironmentEntry"></a>
<h2>hasEnvironmentEntry</h2>
<b>hasEnvironmentEntry</b>(<i>key</i>)
-
<p>
Module function to check, if the environment contains an entry.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -208,10 +207,10 @@
<a NAME="isFreeBsdPlatform" ID="isFreeBsdPlatform"></a>
<h2>isFreeBsdPlatform</h2>
<b>isFreeBsdPlatform</b>(<i></i>)
-
<p>
Function to check, if this is a BSD (FreeBSD) platform.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -230,10 +229,10 @@
<a NAME="isLinuxPlatform" ID="isLinuxPlatform"></a>
<h2>isLinuxPlatform</h2>
<b>isLinuxPlatform</b>(<i></i>)
-
<p>
Function to check, if this is a Linux platform.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -252,10 +251,10 @@
<a NAME="isMacPlatform" ID="isMacPlatform"></a>
<h2>isMacPlatform</h2>
<b>isMacPlatform</b>(<i></i>)
-
<p>
Function to check, if this is a Mac platform.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -274,10 +273,10 @@
<a NAME="isWindowsPlatform" ID="isWindowsPlatform"></a>
<h2>isWindowsPlatform</h2>
<b>isWindowsPlatform</b>(<i></i>)
-
<p>
Function to check, if this is a Windows platform.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -296,10 +295,10 @@
<a NAME="win32_GetUserName" ID="win32_GetUserName"></a>
<h2>win32_GetUserName</h2>
<b>win32_GetUserName</b>(<i></i>)
-
<p>
Function to get the user name under Win32.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -318,10 +317,10 @@
<a NAME="win32_Kill" ID="win32_Kill"></a>
<h2>win32_Kill</h2>
<b>win32_Kill</b>(<i>pid</i>)
-
<p>
Function to provide an os.kill equivalent for Win32.
</p>
+
<dl>
<dt><i>pid</i> (int)</dt>
@@ -347,10 +346,10 @@
<a NAME="win32_getRealName" ID="win32_getRealName"></a>
<h2>win32_getRealName</h2>
<b>win32_getRealName</b>(<i></i>)
-
<p>
Function to get the user's real name (aka. display name) under Win32.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -365,4 +364,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
