--- a/eric6/Documentation/Source/eric6.uninstall.html Mon Sep 02 18:52:31 2019 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,286 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric6.uninstall</title> -<meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body><a NAME="top" ID="top"></a> -<h1>eric6.uninstall</h1> -<p> -Uninstallation script for the eric6 IDE and all eric6 related tools. -</p> -<h3>Global Attributes</h3> -<table> -<tr><td>PythonMarkers</td></tr><tr><td>currDir</td></tr><tr><td>defaultMacAppBundleName</td></tr><tr><td>defaultMacAppBundlePath</td></tr><tr><td>includePythonVariant</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>settingsNameGlobal</td></tr><tr><td>settingsNameOrganization</td></tr> -</table> -<h3>Classes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Functions</h3> -<table> -<tr> -<td><a href="#exit">exit</a></td> -<td>Exit the uninstall script.</td> -</tr><tr> -<td><a href="#getConfigDir">getConfigDir</a></td> -<td>Module function to get the name of the directory storing the config data.</td> -</tr><tr> -<td><a href="#getWinregEntry">getWinregEntry</a></td> -<td>Function to get an entry from the Windows Registry.</td> -</tr><tr> -<td><a href="#initGlobals">initGlobals</a></td> -<td>Set the values of globals that need more than a simple assignment.</td> -</tr><tr> -<td><a href="#main">main</a></td> -<td>The main function of the script.</td> -</tr><tr> -<td><a href="#removeConfigurationData">removeConfigurationData</a></td> -<td>Remove the eric configuration directory.</td> -</tr><tr> -<td><a href="#removeDataDirectory">removeDataDirectory</a></td> -<td>Remove the eric data directory.</td> -</tr><tr> -<td><a href="#removePluginDirectories">removePluginDirectories</a></td> -<td>Remove the plug-in directories.</td> -</tr><tr> -<td><a href="#uninstallEric">uninstallEric</a></td> -<td>Uninstall the eric files.</td> -</tr><tr> -<td><a href="#uninstallLinuxSpecifics">uninstallLinuxSpecifics</a></td> -<td>Uninstall Linux specific files.</td> -</tr><tr> -<td><a href="#uninstallMacAppBundle">uninstallMacAppBundle</a></td> -<td>Uninstall the macOS application bundle.</td> -</tr><tr> -<td><a href="#uninstallWindowsLinks">uninstallWindowsLinks</a></td> -<td>Clean up the Desktop and Start Menu entries for Windows.</td> -</tr><tr> -<td><a href="#usage">usage</a></td> -<td>Display a usage message and exit.</td> -</tr><tr> -<td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> -<td>Function to generate the link names for the Windows Desktop.</td> -</tr><tr> -<td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> -<td>Function to generate the name of the Start Menu top entry.</td> -</tr><tr> -<td><a href="#wrapperNames">wrapperNames</a></td> -<td>Create the platform specific names for the wrapper script.</td> -</tr> -</table> -<hr /><hr /> -<a NAME="exit" ID="exit"></a> -<h2>exit</h2> -<b>exit</b>(<i>rcode=0</i>) -<p> - Exit the uninstall script. -</p><dl> -<dt><i>rcode</i></dt> -<dd> -result code to report back (integer) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="getConfigDir" ID="getConfigDir"></a> -<h2>getConfigDir</h2> -<b>getConfigDir</b>(<i></i>) -<p> - Module function to get the name of the directory storing the config data. -</p><dl> -<dt>Returns:</dt> -<dd> -directory name of the config dir (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="getWinregEntry" ID="getWinregEntry"></a> -<h2>getWinregEntry</h2> -<b>getWinregEntry</b>(<i>name, path</i>) -<p> - Function to get an entry from the Windows Registry. -</p><dl> -<dt><i>name</i> (str)</dt> -<dd> -variable name -</dd><dt><i>path</i> (str)</dt> -<dd> -registry path of the variable -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -value of requested registry variable -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -any -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="initGlobals" ID="initGlobals"></a> -<h2>initGlobals</h2> -<b>initGlobals</b>(<i></i>) -<p> - Set the values of globals that need more than a simple assignment. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="main" ID="main"></a> -<h2>main</h2> -<b>main</b>(<i>argv</i>) -<p> - The main function of the script. -</p><dl> -<dt><i>argv</i></dt> -<dd> -list of command line arguments -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="removeConfigurationData" ID="removeConfigurationData"></a> -<h2>removeConfigurationData</h2> -<b>removeConfigurationData</b>(<i></i>) -<p> - Remove the eric configuration directory. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="removeDataDirectory" ID="removeDataDirectory"></a> -<h2>removeDataDirectory</h2> -<b>removeDataDirectory</b>(<i></i>) -<p> - Remove the eric data directory. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="removePluginDirectories" ID="removePluginDirectories"></a> -<h2>removePluginDirectories</h2> -<b>removePluginDirectories</b>(<i></i>) -<p> - Remove the plug-in directories. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="uninstallEric" ID="uninstallEric"></a> -<h2>uninstallEric</h2> -<b>uninstallEric</b>(<i></i>) -<p> - Uninstall the eric files. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="uninstallLinuxSpecifics" ID="uninstallLinuxSpecifics"></a> -<h2>uninstallLinuxSpecifics</h2> -<b>uninstallLinuxSpecifics</b>(<i></i>) -<p> - Uninstall Linux specific files. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="uninstallMacAppBundle" ID="uninstallMacAppBundle"></a> -<h2>uninstallMacAppBundle</h2> -<b>uninstallMacAppBundle</b>(<i></i>) -<p> - Uninstall the macOS application bundle. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="uninstallWindowsLinks" ID="uninstallWindowsLinks"></a> -<h2>uninstallWindowsLinks</h2> -<b>uninstallWindowsLinks</b>(<i></i>) -<p> - Clean up the Desktop and Start Menu entries for Windows. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="usage" ID="usage"></a> -<h2>usage</h2> -<b>usage</b>(<i>rcode=2</i>) -<p> - Display a usage message and exit. -</p><dl> -<dt><i>rcode</i></dt> -<dd> -return code passed back to the calling process (integer) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> -<h2>windowsDesktopNames</h2> -<b>windowsDesktopNames</b>(<i></i>) -<p> - Function to generate the link names for the Windows Desktop. -</p><dl> -<dt>Returns:</dt> -<dd> -list of desktop link names -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -list of str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> -<h2>windowsProgramsEntry</h2> -<b>windowsProgramsEntry</b>(<i></i>) -<p> - Function to generate the name of the Start Menu top entry. -</p><dl> -<dt>Returns:</dt> -<dd> -name of the Start Menu top entry -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="wrapperNames" ID="wrapperNames"></a> -<h2>wrapperNames</h2> -<b>wrapperNames</b>(<i>dname, wfile</i>) -<p> - Create the platform specific names for the wrapper script. -</p><dl> -<dt><i>dname</i></dt> -<dd> -name of the directory to place the wrapper into -</dd><dt><i>wfile</i></dt> -<dd> -basename (without extension) of the wrapper script -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -the names of the wrapper scripts -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file