Documentation/Source/eric5.install.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 396
b967825e73c6
--- a/Documentation/Source/eric5.install.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.install.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.install</h1>
 <p>
-&#73;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#115;&#99;&#114;&#105;&#112;&#116; &#102;&#111;&#114; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#53; &#73;&#68;&#69; &#97;&#110;&#100; &#97;&#108;&#108; &#101;&#114;&#105;&#99;&#53; &#114;&#101;&#108;&#97;&#116;&#101;&#100; &#116;&#111;&#111;&#108;&#115;.
+Installation script for the eric5 IDE and all eric5 related tools.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -36,55 +36,55 @@
 <table>
 <tr>
 <td><a href="#cleanUp">cleanUp</a></td>
-<td>&#85;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108; &#116;&#104;&#101; &#111;&#108;&#100; &#101;&#114;&#105;&#99; &#102;&#105;&#108;&#101;&#115;.</td>
+<td>Uninstall the old eric files.</td>
 </tr><tr>
 <td><a href="#compileUiDir">compileUiDir</a></td>
-<td>&#67;&#114;&#101;&#97;&#116;&#101;&#115; &#80;y&#116;&#104;&#111;&#110; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#102;&#114;&#111;&#109; &#81;&#116; &#68;&#101;&#115;&#105;&#103;&#110;&#101;&#114; .&#117;&#105; &#102;&#105;&#108;&#101;&#115; &#105;&#110; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#114; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#114;&#101;&#101;.</td>
+<td>Creates Python modules from Qt Designer .ui files in a directory or directory tree.</td>
 </tr><tr>
 <td><a href="#compileUiFiles">compileUiFiles</a></td>
-<td>&#67;&#111;&#109;&#112;&#105;&#108;&#101; &#116;&#104;&#101; .&#117;&#105; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#80;y&#116;&#104;&#111;&#110; &#115;&#111;&#117;&#114;&#99;&#101;&#115;.</td>
+<td>Compile the .ui files to Python sources.</td>
 </tr><tr>
 <td><a href="#compile_ui">compile_ui</a></td>
-<td>&#76;&#111;&#99;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#111;&#109;&#112;&#105;&#108;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; .&#117;&#105; &#102;&#105;&#108;&#101;.</td>
+<td>Local function to compile a single .ui file.</td>
 </tr><tr>
 <td><a href="#copyToFile">copyToFile</a></td>
-<td>&#67;&#111;&#112;y &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#97; &#102;&#105;&#108;&#101;.</td>
+<td>Copy a string to a file.</td>
 </tr><tr>
 <td><a href="#copyTree">copyTree</a></td>
-<td>&#67;&#111;&#112;y &#80;y&#116;&#104;&#111;&#110;, &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;, &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;, w&#105;z&#97;&#114;&#100;&#115; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110;, &#100;&#101;&#115;&#105;&#103;&#110;&#101;&#114; &#116;&#101;&#109;&#112;&#108;&#97;&#116;&#101; &#102;&#105;&#108;&#101;&#115; &#97;&#110;&#100; &#68;&#84;&#68;&#115; &#111;&#102; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#114;&#101;&#101;.</td>
+<td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td>
 </tr><tr>
 <td><a href="#createConfig">createConfig</a></td>
-<td>&#67;&#114;&#101;&#97;&#116;&#101; &#97; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101; w&#105;&#116;&#104; &#116;&#104;&#101; &#114;&#101;&#115;&#112;&#101;&#99;&#116;&#105;v&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#101;&#110;&#116;&#114;&#105;&#101;&#115;.</td>
+<td>Create a config file with the respective config entries.</td>
 </tr><tr>
 <td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td>
-<td>&#67;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#103;&#108;&#111;&#98;&#97;&#108; &#112;&#108;&#117;&#103;&#105;&#110;&#115; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y, &#105;&#102; &#105;&#116; &#100;&#111;&#101;&#115;&#110;'&#116; &#101;x&#105;&#115;&#116;.</td>
+<td>Create the global plugins directory, if it doesn't exist.</td>
 </tr><tr>
 <td><a href="#createInstallConfig">createInstallConfig</a></td>
-<td>&#67;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#99;&#111;&#110;&#102;&#105;&#103; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y.</td>
+<td>Create the installation config dictionary.</td>
 </tr><tr>
 <td><a href="#createPyWrapper">createPyWrapper</a></td>
-<td>&#67;&#114;&#101;&#97;&#116;&#101; &#97;&#110; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#102;&#111;&#114; &#97; &#80;y&#116;&#104;&#111;&#110; &#115;&#99;&#114;&#105;&#112;&#116;.</td>
+<td>Create an executable wrapper for a Python script.</td>
 </tr><tr>
 <td><a href="#doDependancyChecks">doDependancyChecks</a></td>
-<td>&#80;&#101;&#114;&#102;&#111;&#114;&#109; &#115;&#111;&#109;&#101; &#100;&#101;&#112;&#101;&#110;&#100;&#101;&#110;&#99;y &#99;&#104;&#101;&#99;&#107;&#115;.</td>
+<td>Perform some dependency checks.</td>
 </tr><tr>
 <td><a href="#initGlobals">initGlobals</a></td>
-<td>&#83;&#101;&#116;&#115; &#116;&#104;&#101; v&#97;&#108;&#117;&#101;&#115; &#111;&#102; &#103;&#108;&#111;&#98;&#97;&#108;&#115; &#116;&#104;&#97;&#116; &#110;&#101;&#101;&#100; &#109;&#111;&#114;&#101; &#116;&#104;&#97;&#110; &#97; &#115;&#105;&#109;&#112;&#108;&#101; &#97;&#115;&#115;&#105;&#103;&#110;&#109;&#101;&#110;&#116;.</td>
+<td>Sets the values of globals that need more than a simple assignment.</td>
 </tr><tr>
 <td><a href="#installEric">installEric</a></td>
-<td>&#65;&#99;&#116;&#117;&#97;&#108;&#108;y &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#101;&#112;&#115;.</td>
+<td>Actually perform the installation steps.</td>
 </tr><tr>
 <td><a href="#main">main</a></td>
-<td>&#84;&#104;&#101; &#109;&#97;&#105;&#110; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#115;&#99;&#114;&#105;&#112;&#116;.</td>
+<td>The main function of the script.</td>
 </tr><tr>
 <td><a href="#pyName">pyName</a></td>
-<td>&#76;&#111;&#99;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; &#110;&#97;&#109;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#109;&#112;&#105;&#108;&#101;&#100; .&#117;&#105; &#102;&#105;&#108;&#101;.</td>
+<td>Local function to create the Python source file name for the compiled .ui file.</td>
 </tr><tr>
 <td><a href="#usage">usage</a></td>
-<td>&#68;&#105;&#115;&#112;&#108;&#97;y &#97; &#117;&#115;&#97;&#103;&#101; &#109;&#101;&#115;&#115;&#97;&#103;&#101; &#97;&#110;&#100; &#101;x&#105;&#116;.</td>
+<td>Display a usage message and exit.</td>
 </tr><tr>
 <td><a href="#wrapperName">wrapperName</a></td>
-<td>&#67;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#112;&#108;&#97;&#116;&#102;&#111;&#114;&#109; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#97;&#109;&#101; &#102;&#111;&#114; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#115;&#99;&#114;&#105;&#112;&#116;.</td>
+<td>Create the platform specific name for the wrapper script.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -92,7 +92,7 @@
 <h2>cleanUp</h2>
 <b>cleanUp</b>(<i></i>)
 <p>
-    &#85;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108; &#116;&#104;&#101; &#111;&#108;&#100; &#101;&#114;&#105;&#99; &#102;&#105;&#108;&#101;&#115;.
+    Uninstall the old eric files.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -100,30 +100,30 @@
 <h2>compileUiDir</h2>
 <b>compileUiDir</b>(<i>dir, recurse = False, map = None, **compileUi_args</i>)
 <p>
-            &#67;&#114;&#101;&#97;&#116;&#101;&#115; &#80;y&#116;&#104;&#111;&#110; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#102;&#114;&#111;&#109; &#81;&#116; &#68;&#101;&#115;&#105;&#103;&#110;&#101;&#114; .&#117;&#105; &#102;&#105;&#108;&#101;&#115; &#105;&#110; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#114;
-            &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#114;&#101;&#101;.
+            Creates Python modules from Qt Designer .ui files in a directory or
+            directory tree.
 </p><p>
-            &#78;&#111;&#116;&#101;&#58; &#84;&#104;&#105;&#115; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#105;&#115; &#97; &#109;&#111;&#100;&#105;&#102;&#105;&#101;&#100; v&#101;&#114;&#115;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#111;&#110;&#101; &#102;&#111;&#117;&#110;&#100; &#105;&#110; &#80;y&#81;&#116;&#52;.
+            Note: This function is a modified version of the one found in PyQt4.
 </p><dl>
 <dt><i>dir</i></dt>
 <dd>
-&#78;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#115;&#99;&#97;&#110; &#102;&#111;&#114; &#102;&#105;&#108;&#101;&#115; w&#104;&#111;&#115;&#101; &#110;&#97;&#109;&#101; &#101;&#110;&#100;&#115; w&#105;&#116;&#104;
-                '.&#117;&#105;'. &#66;y &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#80;y&#116;&#104;&#111;&#110; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#115; &#99;&#114;&#101;&#97;&#116;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#115;&#97;&#109;&#101;
-                &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#101;&#110;&#100;&#105;&#110;&#103; w&#105;&#116;&#104; '.&#112;y'.
+Name of the directory to scan for files whose name ends with
+                '.ui'. By default the generated Python module is created in the same
+                directory ending with '.py'.
 </dd><dt><i>recurse</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#97;&#116; &#97;&#110;y &#115;&#117;&#98;-&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;&#105;&#101;&#115; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#115;&#99;&#97;&#110;&#110;&#101;&#100;.
+flag indicating that any sub-directories should be scanned.
 </dd><dt><i>map</i></dt>
 <dd>
-&#97;&#110; &#111;&#112;&#116;&#105;&#111;&#110;&#97;&#108; &#99;&#97;&#108;&#108;&#97;&#98;&#108;&#101; &#116;&#104;&#97;&#116; &#105;&#115; &#112;&#97;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y
-                &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; '.&#117;&#105;' &#102;&#105;&#108;&#101; &#97;&#110;&#100; &#116;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#109;&#111;&#100;&#117;&#108;&#101; &#116;&#104;&#97;&#116; w&#105;&#108;&#108; &#98;&#101;
-                &#99;&#114;&#101;&#97;&#116;&#101;&#100;. &#84;&#104;&#101; &#99;&#97;&#108;&#108;&#97;&#98;&#108;&#101; &#115;&#104;&#111;&#117;&#108;&#100; &#114;&#101;&#116;&#117;&#114;&#110; &#97; &#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y
-                &#105;&#110; w&#104;&#105;&#99;&#104; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#109;&#111;&#100;&#117;&#108;&#101; w&#105;&#108;&#108; &#98;&#101; &#99;&#114;&#101;&#97;&#116;&#101;&#100; &#97;&#110;&#100; &#116;&#104;&#101; (&#112;&#111;&#115;&#115;&#105;&#98;&#108;y &#109;&#111;&#100;&#105;&#102;&#105;&#101;&#100;)
-                &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.
+an optional callable that is passed the name of the directory
+                containing the '.ui' file and the name of the Python module that will be
+                created. The callable should return a tuple of the name of the directory
+                in which the Python module will be created and the (possibly modified)
+                name of the module.
 </dd><dt><i>compileUi_args</i></dt>
 <dd>
-&#97;&#110;y &#97;&#100;&#100;&#105;&#116;&#105;&#111;&#110;&#97;&#108; &#107;&#101;yw&#111;&#114;&#100; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115; &#116;&#104;&#97;&#116; &#97;&#114;&#101; &#112;&#97;&#115;&#115;&#101;&#100; &#116;&#111;
-                &#116;&#104;&#101; &#99;&#111;&#109;&#112;&#105;&#108;&#101;&#85;&#105;() &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#104;&#97;&#116; &#105;&#115; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#101;&#97;&#99;&#104; &#80;y&#116;&#104;&#111;&#110; &#109;&#111;&#100;&#117;&#108;&#101;.
+any additional keyword arguments that are passed to
+                the compileUi() function that is called to create each Python module.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -132,7 +132,7 @@
 <h2>compileUiFiles</h2>
 <b>compileUiFiles</b>(<i></i>)
 <p>
-    &#67;&#111;&#109;&#112;&#105;&#108;&#101; &#116;&#104;&#101; .&#117;&#105; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#80;y&#116;&#104;&#111;&#110; &#115;&#111;&#117;&#114;&#99;&#101;&#115;.
+    Compile the .ui files to Python sources.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -140,14 +140,14 @@
 <h2>compile_ui</h2>
 <b>compile_ui</b>(<i>ui_dir, ui_file</i>)
 <p>
-                &#76;&#111;&#99;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#111;&#109;&#112;&#105;&#108;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; .&#117;&#105; &#102;&#105;&#108;&#101;.
+                Local function to compile a single .ui file.
 </p><dl>
 <dt><i>ui_dir</i></dt>
 <dd>
-&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; .&#117;&#105; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+directory containing the .ui file (string)
 </dd><dt><i>ui_file</i></dt>
 <dd>
-&#102;&#105;&#108;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; .&#117;&#105; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+file name of the .ui file (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -156,14 +156,14 @@
 <h2>copyToFile</h2>
 <b>copyToFile</b>(<i>name, text</i>)
 <p>
-    &#67;&#111;&#112;y &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#97; &#102;&#105;&#108;&#101;.
+    Copy a string to a file.
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
-&#116;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+the name of the file.
 </dd><dt><i>text</i></dt>
 <dd>
-&#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#116;&#111; &#99;&#111;&#112;y &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+the contents to copy to the file.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -172,21 +172,21 @@
 <h2>copyTree</h2>
 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=[]</i>)
 <p>
-    &#67;&#111;&#112;y &#80;y&#116;&#104;&#111;&#110;, &#116;&#114;&#97;&#110;&#115;&#108;&#97;&#116;&#105;&#111;&#110;, &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;, w&#105;z&#97;&#114;&#100;&#115; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110;,
-    &#100;&#101;&#115;&#105;&#103;&#110;&#101;&#114; &#116;&#101;&#109;&#112;&#108;&#97;&#116;&#101; &#102;&#105;&#108;&#101;&#115; &#97;&#110;&#100; &#68;&#84;&#68;&#115; &#111;&#102; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#114;&#101;&#101;.
+    Copy Python, translation, documentation, wizards configuration,
+    designer template files and DTDs of a directory tree.
 </p><dl>
 <dt><i>src</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y
+name of the source directory
 </dd><dt><i>dst</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#101;&#115;&#116;&#105;&#110;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y
+name of the destination directory
 </dd><dt><i>filters</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#116;&#101;&#114; &#112;&#97;&#116;&#116;&#101;&#114;&#110; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#98;&#101; &#99;&#111;&#112;&#105;&#101;&#100;
+list of filter pattern determining the files to be copied
 </dd><dt><i>excludeDirs</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; (&#115;&#117;&#98;)&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;&#105;&#101;&#115; &#116;&#111; &#101;x&#99;&#108;&#117;&#100;&#101; &#102;&#114;&#111;&#109; &#99;&#111;&#112;y&#105;&#110;&#103;
+list of (sub)directories to exclude from copying
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -195,7 +195,7 @@
 <h2>createConfig</h2>
 <b>createConfig</b>(<i></i>)
 <p>
-    &#67;&#114;&#101;&#97;&#116;&#101; &#97; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101; w&#105;&#116;&#104; &#116;&#104;&#101; &#114;&#101;&#115;&#112;&#101;&#99;&#116;&#105;v&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#101;&#110;&#116;&#114;&#105;&#101;&#115;.
+    Create a config file with the respective config entries.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -203,7 +203,7 @@
 <h2>createGlobalPluginsDir</h2>
 <b>createGlobalPluginsDir</b>(<i></i>)
 <p>
-    &#67;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#103;&#108;&#111;&#98;&#97;&#108; &#112;&#108;&#117;&#103;&#105;&#110;&#115; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y, &#105;&#102; &#105;&#116; &#100;&#111;&#101;&#115;&#110;'&#116; &#101;x&#105;&#115;&#116;.
+    Create the global plugins directory, if it doesn't exist.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -211,7 +211,7 @@
 <h2>createInstallConfig</h2>
 <b>createInstallConfig</b>(<i></i>)
 <p>
-    &#67;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#99;&#111;&#110;&#102;&#105;&#103; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y.
+    Create the installation config dictionary.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -219,20 +219,20 @@
 <h2>createPyWrapper</h2>
 <b>createPyWrapper</b>(<i>pydir, wfile</i>)
 <p>
-    &#67;&#114;&#101;&#97;&#116;&#101; &#97;&#110; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#102;&#111;&#114; &#97; &#80;y&#116;&#104;&#111;&#110; &#115;&#99;&#114;&#105;&#112;&#116;.
+    Create an executable wrapper for a Python script.
 </p><dl>
 <dt><i>pydir</i></dt>
 <dd>
-&#116;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y w&#104;&#101;&#114;&#101; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#115;&#99;&#114;&#105;&#112;&#116; w&#105;&#108;&#108; &#101;v&#101;&#110;&#116;&#117;&#97;&#108;&#108;y
-        &#98;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#101;&#100;
+the name of the directory where the Python script will eventually
+        be installed
 </dd><dt><i>wfile</i></dt>
 <dd>
-&#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114;
+the basename of the wrapper
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#112;&#108;&#97;&#116;&#102;&#111;&#114;&#109; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114;
+the platform specific name of the wrapper
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -241,7 +241,7 @@
 <h2>doDependancyChecks</h2>
 <b>doDependancyChecks</b>(<i></i>)
 <p>
-    &#80;&#101;&#114;&#102;&#111;&#114;&#109; &#115;&#111;&#109;&#101; &#100;&#101;&#112;&#101;&#110;&#100;&#101;&#110;&#99;y &#99;&#104;&#101;&#99;&#107;&#115;.
+    Perform some dependency checks.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -249,7 +249,7 @@
 <h2>initGlobals</h2>
 <b>initGlobals</b>(<i></i>)
 <p>
-    &#83;&#101;&#116;&#115; &#116;&#104;&#101; v&#97;&#108;&#117;&#101;&#115; &#111;&#102; &#103;&#108;&#111;&#98;&#97;&#108;&#115; &#116;&#104;&#97;&#116; &#110;&#101;&#101;&#100; &#109;&#111;&#114;&#101; &#116;&#104;&#97;&#110; &#97; &#115;&#105;&#109;&#112;&#108;&#101; &#97;&#115;&#115;&#105;&#103;&#110;&#109;&#101;&#110;&#116;.
+    Sets the values of globals that need more than a simple assignment.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -257,7 +257,7 @@
 <h2>installEric</h2>
 <b>installEric</b>(<i></i>)
 <p>
-    &#65;&#99;&#116;&#117;&#97;&#108;&#108;y &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#101;&#112;&#115;.
+    Actually perform the installation steps.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -265,11 +265,11 @@
 <h2>main</h2>
 <b>main</b>(<i>argv</i>)
 <p>
-    &#84;&#104;&#101; &#109;&#97;&#105;&#110; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#115;&#99;&#114;&#105;&#112;&#116;.
+    The main function of the script.
 </p><dl>
 <dt><i>argv</i></dt>
 <dd>
-&#116;&#104;&#101; &#108;&#105;&#115;&#116; &#111;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#108;&#105;&#110;&#101; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115;.
+the list of command line arguments.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -278,19 +278,19 @@
 <h2>pyName</h2>
 <b>pyName</b>(<i>py_dir, py_file</i>)
 <p>
-        &#76;&#111;&#99;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; &#110;&#97;&#109;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#109;&#112;&#105;&#108;&#101;&#100; .&#117;&#105; &#102;&#105;&#108;&#101;.
+        Local function to create the Python source file name for the compiled .ui file.
 </p><dl>
 <dt><i>py_dir</i></dt>
 <dd>
-&#115;&#117;&#103;&#103;&#101;&#115;&#116;&#101;&#100; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y (&#115;&#116;&#114;&#105;&#110;&#103;)
+suggested name of the directory (string)
 </dd><dt><i>py_file</i></dt>
 <dd>
-&#115;&#117;&#103;&#103;&#101;&#115;&#116;&#101;&#100; &#110;&#97;&#109;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#109;&#112;&#105;&#108;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+suggested name for the compile source file (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) &#97;&#110;&#100; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+tuple of directory name (string) and source file name (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -299,11 +299,11 @@
 <h2>usage</h2>
 <b>usage</b>(<i>rcode = 2</i>)
 <p>
-    &#68;&#105;&#115;&#112;&#108;&#97;y &#97; &#117;&#115;&#97;&#103;&#101; &#109;&#101;&#115;&#115;&#97;&#103;&#101; &#97;&#110;&#100; &#101;x&#105;&#116;.
+    Display a usage message and exit.
 </p><dl>
 <dt><i>rcode</i></dt>
 <dd>
-&#116;&#104;&#101; &#114;&#101;&#116;&#117;&#114;&#110; &#99;&#111;&#100;&#101; &#112;&#97;&#115;&#115;&#101;&#100; &#98;&#97;&#99;&#107; &#116;&#111; &#116;&#104;&#101; &#99;&#97;&#108;&#108;&#105;&#110;&#103; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+the return code passed back to the calling process.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -312,19 +312,19 @@
 <h2>wrapperName</h2>
 <b>wrapperName</b>(<i>dname, wfile</i>)
 <p>
-    &#67;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#112;&#108;&#97;&#116;&#102;&#111;&#114;&#109; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#97;&#109;&#101; &#102;&#111;&#114; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#115;&#99;&#114;&#105;&#112;&#116;.
+    Create the platform specific name for the wrapper script.
 </p><dl>
 <dt><i>dname</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#112;&#108;&#97;&#99;&#101; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#105;&#110;&#116;&#111;
+name of the directory to place the wrapper into
 </dd><dt><i>wfile</i></dt>
 <dd>
-&#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; (w&#105;&#116;&#104;&#111;&#117;&#116; &#101;x&#116;&#101;&#110;&#115;&#105;&#111;&#110;) &#111;&#102; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#115;&#99;&#114;&#105;&#112;&#116;
+basename (without extension) of the wrapper script
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; w&#114;&#97;&#112;&#112;&#101;&#114; &#115;&#99;&#114;&#105;&#112;&#116;
+the name of the wrapper script
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial