eric6/Documentation/Source/install.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8266
560547c2b6ec
--- a/eric6/Documentation/Source/install.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/install.html	Mon Feb 01 10:38:16 2021 +0100
@@ -23,12 +23,12 @@
 <h1>install</h1>
 
 <p>
-Installation script for the eric6 IDE and all eric6 related tools.
+Installation script for the eric IDE and all eric related tools.
 </p>
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>configName</td></tr><tr><td>currDir</td></tr><tr><td>defaultMacAppBundleName</td></tr><tr><td>defaultMacAppBundlePath</td></tr><tr><td>defaultMacPythonExe</td></tr><tr><td>distDir</td></tr><tr><td>doCleanDesktopLinks</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>eric6SourceDir</td></tr><tr><td>forceCleanDesktopLinks</td></tr><tr><td>ignorePyqt5Tools</td></tr><tr><td>installApis</td></tr><tr><td>installCwd</td></tr><tr><td>installInfo</td></tr><tr><td>installInfoName</td></tr><tr><td>macAppBundleName</td></tr><tr><td>macAppBundlePath</td></tr><tr><td>macPythonExe</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>platBinDirOld</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>sourceDir</td></tr><tr><td>yes2All</td></tr>
+<tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>configName</td></tr><tr><td>createInstallInfoFile</td></tr><tr><td>currDir</td></tr><tr><td>defaultMacAppBundleName</td></tr><tr><td>defaultMacAppBundlePath</td></tr><tr><td>defaultMacPythonExe</td></tr><tr><td>distDir</td></tr><tr><td>doCleanDesktopLinks</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>eric6SourceDir</td></tr><tr><td>forceCleanDesktopLinks</td></tr><tr><td>ignorePyqt5Tools</td></tr><tr><td>installApis</td></tr><tr><td>installCwd</td></tr><tr><td>installInfo</td></tr><tr><td>installInfoName</td></tr><tr><td>macAppBundleName</td></tr><tr><td>macAppBundlePath</td></tr><tr><td>macPythonExe</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>platBinDirOld</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>sourceDir</td></tr><tr><td>yes2All</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -97,7 +97,7 @@
 </tr>
 <tr>
 <td><a href="#createInstallInfo">createInstallInfo</a></td>
-<td>Record information about the way eric6 was installed.</td>
+<td>Record information about the way eric was installed.</td>
 </tr>
 <tr>
 <td><a href="#createLinuxSpecifics">createLinuxSpecifics</a></td>
@@ -206,7 +206,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of directory name (string) and source file name (string)
 </dd>
@@ -371,7 +371,7 @@
 <dd>
 list of (sub)directories to exclude from copying
 </dd>
-<dt><i>excludePatterns=</i></dt>
+<dt><i>excludePatterns</i></dt>
 <dd>
 list of filter pattern determining the files to
         be skipped
@@ -415,7 +415,7 @@
 <b>createInstallInfo</b>(<i></i>)
 
 <p>
-    Record information about the way eric6 was installed.
+    Record information about the way eric was installed.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
@@ -477,7 +477,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the platform specific name of the wrapper (string)
 </dd>
@@ -566,7 +566,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 value of requested registry variable
 </dd>
@@ -599,7 +599,7 @@
     Actually perform the installation steps.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 result code (integer)
 </dd>
@@ -615,7 +615,7 @@
     Check, if pip is outdated.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating an outdated pip
 </dd>
@@ -665,7 +665,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a successful installation
 </dd>
@@ -713,7 +713,7 @@
 <dd>
 destination file name or directory name (string)
 </dd>
-<dt><i>perm=</i></dt>
+<dt><i>perm</i></dt>
 <dd>
 permissions to be set (integer)
 </dd>
@@ -756,7 +756,7 @@
     Function to generate data for the Windows Desktop links.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of tuples containing the desktop link name,
         the link target and the icon target
@@ -779,7 +779,7 @@
     Function to generate the link names for the Windows Desktop.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of desktop link names
 </dd>
@@ -801,7 +801,7 @@
     Function to generate the name of the Start Menu top entry.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of the Start Menu top entry
 </dd>
@@ -834,7 +834,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the names of the wrapper scripts
 </dd>

eric ide

mercurial