eric6/Documentation/Source/install.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7336
0095e231ddaf
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>install</h1> 23 <h1>install</h1>
24
23 <p> 25 <p>
24 Installation script for the eric6 IDE and all eric6 related tools. 26 Installation script for the eric6 IDE and all eric6 related tools.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>PythonMarkers</td></tr><tr><td>PythonTextMarkers</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>includePythonVariant</td></tr><tr><td>installApis</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>pyqtOverride</td></tr><tr><td>pyqtVariant</td></tr><tr><td>sourceDir</td></tr> 31 <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>installApis</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>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
32 <tr><td>None</td></tr> 36 <tr><td>None</td></tr>
33 </table> 37 </table>
34 <h3>Functions</h3> 38 <h3>Functions</h3>
39
35 <table> 40 <table>
41
36 <tr> 42 <tr>
37 <td><a href="#__pyName">__pyName</a></td> 43 <td><a href="#__pyName">__pyName</a></td>
38 <td>Local function to create the Python source file name for the compiled .ui file.</td> 44 <td>Local function to create the Python source file name for the compiled .ui file.</td>
39 </tr><tr> 45 </tr>
46 <tr>
40 <td><a href="#cleanUp">cleanUp</a></td> 47 <td><a href="#cleanUp">cleanUp</a></td>
41 <td>Uninstall the old eric files.</td> 48 <td>Uninstall the old eric files.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#cleanUpLinuxSpecifics">cleanUpLinuxSpecifics</a></td> 51 <td><a href="#cleanUpLinuxSpecifics">cleanUpLinuxSpecifics</a></td>
44 <td>Clean up Linux specific files.</td> 52 <td>Clean up Linux specific files.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#cleanUpMacAppBundle">cleanUpMacAppBundle</a></td> 55 <td><a href="#cleanUpMacAppBundle">cleanUpMacAppBundle</a></td>
47 <td>Uninstall the macOS application bundle.</td> 56 <td>Uninstall the macOS application bundle.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#cleanUpWindowsLinks">cleanUpWindowsLinks</a></td> 59 <td><a href="#cleanUpWindowsLinks">cleanUpWindowsLinks</a></td>
50 <td>Clean up the Desktop and Start Menu entries for Windows.</td> 60 <td>Clean up the Desktop and Start Menu entries for Windows.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#cleanupSource">cleanupSource</a></td> 63 <td><a href="#cleanupSource">cleanupSource</a></td>
53 <td>Cleanup the sources directory to get rid of leftover files and directories.</td> 64 <td>Cleanup the sources directory to get rid of leftover files and directories.</td>
54 </tr><tr> 65 </tr>
66 <tr>
55 <td><a href="#compileUiFiles">compileUiFiles</a></td> 67 <td><a href="#compileUiFiles">compileUiFiles</a></td>
56 <td>Compile the .ui files to Python sources.</td> 68 <td>Compile the .ui files to Python sources.</td>
57 </tr><tr> 69 </tr>
70 <tr>
58 <td><a href="#copyAppStreamFile">copyAppStreamFile</a></td> 71 <td><a href="#copyAppStreamFile">copyAppStreamFile</a></td>
59 <td>Modify an appstream file and write it to its destination.</td> 72 <td>Modify an appstream file and write it to its destination.</td>
60 </tr><tr> 73 </tr>
74 <tr>
61 <td><a href="#copyDesktopFile">copyDesktopFile</a></td> 75 <td><a href="#copyDesktopFile">copyDesktopFile</a></td>
62 <td>Modify a desktop file and write it to its destination.</td> 76 <td>Modify a desktop file and write it to its destination.</td>
63 </tr><tr> 77 </tr>
78 <tr>
64 <td><a href="#copyToFile">copyToFile</a></td> 79 <td><a href="#copyToFile">copyToFile</a></td>
65 <td>Copy a string to a file.</td> 80 <td>Copy a string to a file.</td>
66 </tr><tr> 81 </tr>
82 <tr>
67 <td><a href="#copyTree">copyTree</a></td> 83 <td><a href="#copyTree">copyTree</a></td>
68 <td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td> 84 <td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td>
69 </tr><tr> 85 </tr>
86 <tr>
70 <td><a href="#createConfig">createConfig</a></td> 87 <td><a href="#createConfig">createConfig</a></td>
71 <td>Create a config file with the respective config entries.</td> 88 <td>Create a config file with the respective config entries.</td>
72 </tr><tr> 89 </tr>
90 <tr>
73 <td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td> 91 <td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td>
74 <td>Create the global plugins directory, if it doesn't exist.</td> 92 <td>Create the global plugins directory, if it doesn't exist.</td>
75 </tr><tr> 93 </tr>
94 <tr>
76 <td><a href="#createInstallConfig">createInstallConfig</a></td> 95 <td><a href="#createInstallConfig">createInstallConfig</a></td>
77 <td>Create the installation config dictionary.</td> 96 <td>Create the installation config dictionary.</td>
78 </tr><tr> 97 </tr>
98 <tr>
79 <td><a href="#createLinuxSpecifics">createLinuxSpecifics</a></td> 99 <td><a href="#createLinuxSpecifics">createLinuxSpecifics</a></td>
80 <td>Install Linux specific files.</td> 100 <td>Install Linux specific files.</td>
81 </tr><tr> 101 </tr>
102 <tr>
82 <td><a href="#createMacAppBundle">createMacAppBundle</a></td> 103 <td><a href="#createMacAppBundle">createMacAppBundle</a></td>
83 <td>Create a Mac application bundle.</td> 104 <td>Create a Mac application bundle.</td>
84 </tr><tr> 105 </tr>
106 <tr>
85 <td><a href="#createPyWrapper">createPyWrapper</a></td> 107 <td><a href="#createPyWrapper">createPyWrapper</a></td>
86 <td>Create an executable wrapper for a Python script.</td> 108 <td>Create an executable wrapper for a Python script.</td>
87 </tr><tr> 109 </tr>
110 <tr>
88 <td><a href="#createWindowsLinks">createWindowsLinks</a></td> 111 <td><a href="#createWindowsLinks">createWindowsLinks</a></td>
89 <td>Create Desktop and Start Menu links.</td> 112 <td>Create Desktop and Start Menu links.</td>
90 </tr><tr> 113 </tr>
114 <tr>
91 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> 115 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td>
92 <td>Create Windows shortcut.</td> 116 <td>Create Windows shortcut.</td>
93 </tr><tr> 117 </tr>
94 <td><a href="#determinePyQtVariant">determinePyQtVariant</a></td> 118 <tr>
95 <td>Module function to determine the PyQt variant to be used.</td>
96 </tr><tr>
97 <td><a href="#doDependancyChecks">doDependancyChecks</a></td> 119 <td><a href="#doDependancyChecks">doDependancyChecks</a></td>
98 <td>Perform some dependency checks.</td> 120 <td>Perform some dependency checks.</td>
99 </tr><tr> 121 </tr>
122 <tr>
100 <td><a href="#exit">exit</a></td> 123 <td><a href="#exit">exit</a></td>
101 <td>Exit the install script.</td> 124 <td>Exit the install script.</td>
102 </tr><tr> 125 </tr>
126 <tr>
103 <td><a href="#getWinregEntry">getWinregEntry</a></td> 127 <td><a href="#getWinregEntry">getWinregEntry</a></td>
104 <td>Function to get an entry from the Windows Registry.</td> 128 <td>Function to get an entry from the Windows Registry.</td>
105 </tr><tr> 129 </tr>
130 <tr>
106 <td><a href="#initGlobals">initGlobals</a></td> 131 <td><a href="#initGlobals">initGlobals</a></td>
107 <td>Module function to set the values of globals that need more than a simple assignment.</td> 132 <td>Module function to set the values of globals that need more than a simple assignment.</td>
108 </tr><tr> 133 </tr>
134 <tr>
109 <td><a href="#installEric">installEric</a></td> 135 <td><a href="#installEric">installEric</a></td>
110 <td>Actually perform the installation steps.</td> 136 <td>Actually perform the installation steps.</td>
111 </tr><tr> 137 </tr>
138 <tr>
112 <td><a href="#main">main</a></td> 139 <td><a href="#main">main</a></td>
113 <td>The main function of the script.</td> 140 <td>The main function of the script.</td>
114 </tr><tr> 141 </tr>
142 <tr>
115 <td><a href="#pipInstall">pipInstall</a></td> 143 <td><a href="#pipInstall">pipInstall</a></td>
116 <td>Install the given package via pip.</td> 144 <td>Install the given package via pip.</td>
117 </tr><tr> 145 </tr>
146 <tr>
118 <td><a href="#prepareInfoFile">prepareInfoFile</a></td> 147 <td><a href="#prepareInfoFile">prepareInfoFile</a></td>
119 <td>Function to prepare an Info.py file when installing from source.</td> 148 <td>Function to prepare an Info.py file when installing from source.</td>
120 </tr><tr> 149 </tr>
150 <tr>
121 <td><a href="#shutilCopy">shutilCopy</a></td> 151 <td><a href="#shutilCopy">shutilCopy</a></td>
122 <td>Wrapper function around shutil.copy() to ensure the permissions.</td> 152 <td>Wrapper function around shutil.copy() to ensure the permissions.</td>
123 </tr><tr> 153 </tr>
154 <tr>
124 <td><a href="#usage">usage</a></td> 155 <td><a href="#usage">usage</a></td>
125 <td>Display a usage message and exit.</td> 156 <td>Display a usage message and exit.</td>
126 </tr><tr> 157 </tr>
158 <tr>
127 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> 159 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td>
128 <td>Function to generate data for the Windows Desktop links.</td> 160 <td>Function to generate data for the Windows Desktop links.</td>
129 </tr><tr> 161 </tr>
162 <tr>
130 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> 163 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td>
131 <td>Function to generate the link names for the Windows Desktop.</td> 164 <td>Function to generate the link names for the Windows Desktop.</td>
132 </tr><tr> 165 </tr>
166 <tr>
133 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> 167 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td>
134 <td>Function to generate the name of the Start Menu top entry.</td> 168 <td>Function to generate the name of the Start Menu top entry.</td>
135 </tr><tr> 169 </tr>
170 <tr>
136 <td><a href="#wrapperNames">wrapperNames</a></td> 171 <td><a href="#wrapperNames">wrapperNames</a></td>
137 <td>Create the platform specific names for the wrapper script.</td> 172 <td>Create the platform specific names for the wrapper script.</td>
138 </tr> 173 </tr>
139 </table> 174 </table>
140 <hr /><hr /> 175 <hr />
176 <hr />
141 <a NAME="__pyName" ID="__pyName"></a> 177 <a NAME="__pyName" ID="__pyName"></a>
142 <h2>__pyName</h2> 178 <h2>__pyName</h2>
143 <b>__pyName</b>(<i>py_dir, py_file</i>) 179 <b>__pyName</b>(<i>py_dir, py_file</i>)
180
144 <p> 181 <p>
145 Local function to create the Python source file name for the compiled 182 Local function to create the Python source file name for the compiled
146 .ui file. 183 .ui file.
147 </p><dl> 184 </p>
185 <dl>
186
148 <dt><i>py_dir</i></dt> 187 <dt><i>py_dir</i></dt>
149 <dd> 188 <dd>
150 suggested name of the directory (string) 189 suggested name of the directory (string)
151 </dd><dt><i>py_file</i></dt> 190 </dd>
191 <dt><i>py_file</i></dt>
152 <dd> 192 <dd>
153 suggested name for the compile source file (string) 193 suggested name for the compile source file (string)
154 </dd> 194 </dd>
155 </dl><dl> 195 </dl>
196 <dl>
156 <dt>Returns:</dt> 197 <dt>Returns:</dt>
157 <dd> 198 <dd>
158 tuple of directory name (string) and source file name (string) 199 tuple of directory name (string) and source file name (string)
159 </dd> 200 </dd>
160 </dl> 201 </dl>
161 <div align="right"><a href="#top">Up</a></div> 202 <div align="right"><a href="#top">Up</a></div>
162 <hr /><hr /> 203 <hr />
204 <hr />
163 <a NAME="cleanUp" ID="cleanUp"></a> 205 <a NAME="cleanUp" ID="cleanUp"></a>
164 <h2>cleanUp</h2> 206 <h2>cleanUp</h2>
165 <b>cleanUp</b>(<i></i>) 207 <b>cleanUp</b>(<i></i>)
208
166 <p> 209 <p>
167 Uninstall the old eric files. 210 Uninstall the old eric files.
168 </p> 211 </p>
169 <div align="right"><a href="#top">Up</a></div> 212 <div align="right"><a href="#top">Up</a></div>
170 <hr /><hr /> 213 <hr />
214 <hr />
171 <a NAME="cleanUpLinuxSpecifics" ID="cleanUpLinuxSpecifics"></a> 215 <a NAME="cleanUpLinuxSpecifics" ID="cleanUpLinuxSpecifics"></a>
172 <h2>cleanUpLinuxSpecifics</h2> 216 <h2>cleanUpLinuxSpecifics</h2>
173 <b>cleanUpLinuxSpecifics</b>(<i></i>) 217 <b>cleanUpLinuxSpecifics</b>(<i></i>)
218
174 <p> 219 <p>
175 Clean up Linux specific files. 220 Clean up Linux specific files.
176 </p> 221 </p>
177 <div align="right"><a href="#top">Up</a></div> 222 <div align="right"><a href="#top">Up</a></div>
178 <hr /><hr /> 223 <hr />
224 <hr />
179 <a NAME="cleanUpMacAppBundle" ID="cleanUpMacAppBundle"></a> 225 <a NAME="cleanUpMacAppBundle" ID="cleanUpMacAppBundle"></a>
180 <h2>cleanUpMacAppBundle</h2> 226 <h2>cleanUpMacAppBundle</h2>
181 <b>cleanUpMacAppBundle</b>(<i></i>) 227 <b>cleanUpMacAppBundle</b>(<i></i>)
228
182 <p> 229 <p>
183 Uninstall the macOS application bundle. 230 Uninstall the macOS application bundle.
184 </p> 231 </p>
185 <div align="right"><a href="#top">Up</a></div> 232 <div align="right"><a href="#top">Up</a></div>
186 <hr /><hr /> 233 <hr />
234 <hr />
187 <a NAME="cleanUpWindowsLinks" ID="cleanUpWindowsLinks"></a> 235 <a NAME="cleanUpWindowsLinks" ID="cleanUpWindowsLinks"></a>
188 <h2>cleanUpWindowsLinks</h2> 236 <h2>cleanUpWindowsLinks</h2>
189 <b>cleanUpWindowsLinks</b>(<i></i>) 237 <b>cleanUpWindowsLinks</b>(<i></i>)
238
190 <p> 239 <p>
191 Clean up the Desktop and Start Menu entries for Windows. 240 Clean up the Desktop and Start Menu entries for Windows.
192 </p> 241 </p>
193 <div align="right"><a href="#top">Up</a></div> 242 <div align="right"><a href="#top">Up</a></div>
194 <hr /><hr /> 243 <hr />
244 <hr />
195 <a NAME="cleanupSource" ID="cleanupSource"></a> 245 <a NAME="cleanupSource" ID="cleanupSource"></a>
196 <h2>cleanupSource</h2> 246 <h2>cleanupSource</h2>
197 <b>cleanupSource</b>(<i>dirName</i>) 247 <b>cleanupSource</b>(<i>dirName</i>)
248
198 <p> 249 <p>
199 Cleanup the sources directory to get rid of leftover files 250 Cleanup the sources directory to get rid of leftover files
200 and directories. 251 and directories.
201 </p><dl> 252 </p>
253 <dl>
254
202 <dt><i>dirName</i></dt> 255 <dt><i>dirName</i></dt>
203 <dd> 256 <dd>
204 name of the directory to prune (string) 257 name of the directory to prune (string)
205 </dd> 258 </dd>
206 </dl> 259 </dl>
207 <div align="right"><a href="#top">Up</a></div> 260 <div align="right"><a href="#top">Up</a></div>
208 <hr /><hr /> 261 <hr />
262 <hr />
209 <a NAME="compileUiFiles" ID="compileUiFiles"></a> 263 <a NAME="compileUiFiles" ID="compileUiFiles"></a>
210 <h2>compileUiFiles</h2> 264 <h2>compileUiFiles</h2>
211 <b>compileUiFiles</b>(<i></i>) 265 <b>compileUiFiles</b>(<i></i>)
266
212 <p> 267 <p>
213 Compile the .ui files to Python sources. 268 Compile the .ui files to Python sources.
214 </p> 269 </p>
215 <div align="right"><a href="#top">Up</a></div> 270 <div align="right"><a href="#top">Up</a></div>
216 <hr /><hr /> 271 <hr />
272 <hr />
217 <a NAME="copyAppStreamFile" ID="copyAppStreamFile"></a> 273 <a NAME="copyAppStreamFile" ID="copyAppStreamFile"></a>
218 <h2>copyAppStreamFile</h2> 274 <h2>copyAppStreamFile</h2>
219 <b>copyAppStreamFile</b>(<i>src, dst, marker</i>) 275 <b>copyAppStreamFile</b>(<i>src, dst</i>)
276
220 <p> 277 <p>
221 Modify an appstream file and write it to its destination. 278 Modify an appstream file and write it to its destination.
222 </p><dl> 279 </p>
280 <dl>
281
223 <dt><i>src</i></dt> 282 <dt><i>src</i></dt>
224 <dd> 283 <dd>
225 source file name (string) 284 source file name (string)
226 </dd><dt><i>dst</i></dt> 285 </dd>
286 <dt><i>dst</i></dt>
227 <dd> 287 <dd>
228 destination file name (string) 288 destination file name (string)
229 </dd><dt><i>marker</i></dt> 289 </dd>
230 <dd> 290 </dl>
231 marker to be used (string) 291 <div align="right"><a href="#top">Up</a></div>
232 </dd> 292 <hr />
233 </dl> 293 <hr />
234 <div align="right"><a href="#top">Up</a></div>
235 <hr /><hr />
236 <a NAME="copyDesktopFile" ID="copyDesktopFile"></a> 294 <a NAME="copyDesktopFile" ID="copyDesktopFile"></a>
237 <h2>copyDesktopFile</h2> 295 <h2>copyDesktopFile</h2>
238 <b>copyDesktopFile</b>(<i>src, dst, marker</i>) 296 <b>copyDesktopFile</b>(<i>src, dst</i>)
297
239 <p> 298 <p>
240 Modify a desktop file and write it to its destination. 299 Modify a desktop file and write it to its destination.
241 </p><dl> 300 </p>
301 <dl>
302
242 <dt><i>src</i></dt> 303 <dt><i>src</i></dt>
243 <dd> 304 <dd>
244 source file name (string) 305 source file name (string)
245 </dd><dt><i>dst</i></dt> 306 </dd>
307 <dt><i>dst</i></dt>
246 <dd> 308 <dd>
247 destination file name (string) 309 destination file name (string)
248 </dd><dt><i>marker</i></dt> 310 </dd>
249 <dd> 311 </dl>
250 marker to be used (string) 312 <div align="right"><a href="#top">Up</a></div>
251 </dd> 313 <hr />
252 </dl> 314 <hr />
253 <div align="right"><a href="#top">Up</a></div>
254 <hr /><hr />
255 <a NAME="copyToFile" ID="copyToFile"></a> 315 <a NAME="copyToFile" ID="copyToFile"></a>
256 <h2>copyToFile</h2> 316 <h2>copyToFile</h2>
257 <b>copyToFile</b>(<i>name, text</i>) 317 <b>copyToFile</b>(<i>name, text</i>)
318
258 <p> 319 <p>
259 Copy a string to a file. 320 Copy a string to a file.
260 </p><dl> 321 </p>
322 <dl>
323
261 <dt><i>name</i></dt> 324 <dt><i>name</i></dt>
262 <dd> 325 <dd>
263 the name of the file. 326 the name of the file.
264 </dd><dt><i>text</i></dt> 327 </dd>
328 <dt><i>text</i></dt>
265 <dd> 329 <dd>
266 the contents to copy to the file. 330 the contents to copy to the file.
267 </dd> 331 </dd>
268 </dl> 332 </dl>
269 <div align="right"><a href="#top">Up</a></div> 333 <div align="right"><a href="#top">Up</a></div>
270 <hr /><hr /> 334 <hr />
335 <hr />
271 <a NAME="copyTree" ID="copyTree"></a> 336 <a NAME="copyTree" ID="copyTree"></a>
272 <h2>copyTree</h2> 337 <h2>copyTree</h2>
273 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=None, excludePatterns=None</i>) 338 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=None, excludePatterns=None</i>)
339
274 <p> 340 <p>
275 Copy Python, translation, documentation, wizards configuration, 341 Copy Python, translation, documentation, wizards configuration,
276 designer template files and DTDs of a directory tree. 342 designer template files and DTDs of a directory tree.
277 </p><dl> 343 </p>
344 <dl>
345
278 <dt><i>src</i></dt> 346 <dt><i>src</i></dt>
279 <dd> 347 <dd>
280 name of the source directory 348 name of the source directory
281 </dd><dt><i>dst</i></dt> 349 </dd>
350 <dt><i>dst</i></dt>
282 <dd> 351 <dd>
283 name of the destination directory 352 name of the destination directory
284 </dd><dt><i>filters</i></dt> 353 </dd>
354 <dt><i>filters</i></dt>
285 <dd> 355 <dd>
286 list of filter pattern determining the files to be copied 356 list of filter pattern determining the files to be copied
287 </dd><dt><i>excludeDirs</i></dt> 357 </dd>
358 <dt><i>excludeDirs</i></dt>
288 <dd> 359 <dd>
289 list of (sub)directories to exclude from copying 360 list of (sub)directories to exclude from copying
290 </dd><dt><i>excludePatterns=</i></dt> 361 </dd>
362 <dt><i>excludePatterns=</i></dt>
291 <dd> 363 <dd>
292 list of filter pattern determining the files to 364 list of filter pattern determining the files to
293 be skipped 365 be skipped
294 </dd> 366 </dd>
295 </dl> 367 </dl>
296 <div align="right"><a href="#top">Up</a></div> 368 <div align="right"><a href="#top">Up</a></div>
297 <hr /><hr /> 369 <hr />
370 <hr />
298 <a NAME="createConfig" ID="createConfig"></a> 371 <a NAME="createConfig" ID="createConfig"></a>
299 <h2>createConfig</h2> 372 <h2>createConfig</h2>
300 <b>createConfig</b>(<i></i>) 373 <b>createConfig</b>(<i></i>)
374
301 <p> 375 <p>
302 Create a config file with the respective config entries. 376 Create a config file with the respective config entries.
303 </p> 377 </p>
304 <div align="right"><a href="#top">Up</a></div> 378 <div align="right"><a href="#top">Up</a></div>
305 <hr /><hr /> 379 <hr />
380 <hr />
306 <a NAME="createGlobalPluginsDir" ID="createGlobalPluginsDir"></a> 381 <a NAME="createGlobalPluginsDir" ID="createGlobalPluginsDir"></a>
307 <h2>createGlobalPluginsDir</h2> 382 <h2>createGlobalPluginsDir</h2>
308 <b>createGlobalPluginsDir</b>(<i></i>) 383 <b>createGlobalPluginsDir</b>(<i></i>)
384
309 <p> 385 <p>
310 Create the global plugins directory, if it doesn't exist. 386 Create the global plugins directory, if it doesn't exist.
311 </p> 387 </p>
312 <div align="right"><a href="#top">Up</a></div> 388 <div align="right"><a href="#top">Up</a></div>
313 <hr /><hr /> 389 <hr />
390 <hr />
314 <a NAME="createInstallConfig" ID="createInstallConfig"></a> 391 <a NAME="createInstallConfig" ID="createInstallConfig"></a>
315 <h2>createInstallConfig</h2> 392 <h2>createInstallConfig</h2>
316 <b>createInstallConfig</b>(<i></i>) 393 <b>createInstallConfig</b>(<i></i>)
394
317 <p> 395 <p>
318 Create the installation config dictionary. 396 Create the installation config dictionary.
319 </p> 397 </p>
320 <div align="right"><a href="#top">Up</a></div> 398 <div align="right"><a href="#top">Up</a></div>
321 <hr /><hr /> 399 <hr />
400 <hr />
322 <a NAME="createLinuxSpecifics" ID="createLinuxSpecifics"></a> 401 <a NAME="createLinuxSpecifics" ID="createLinuxSpecifics"></a>
323 <h2>createLinuxSpecifics</h2> 402 <h2>createLinuxSpecifics</h2>
324 <b>createLinuxSpecifics</b>(<i></i>) 403 <b>createLinuxSpecifics</b>(<i></i>)
404
325 <p> 405 <p>
326 Install Linux specific files. 406 Install Linux specific files.
327 </p> 407 </p>
328 <div align="right"><a href="#top">Up</a></div> 408 <div align="right"><a href="#top">Up</a></div>
329 <hr /><hr /> 409 <hr />
410 <hr />
330 <a NAME="createMacAppBundle" ID="createMacAppBundle"></a> 411 <a NAME="createMacAppBundle" ID="createMacAppBundle"></a>
331 <h2>createMacAppBundle</h2> 412 <h2>createMacAppBundle</h2>
332 <b>createMacAppBundle</b>(<i>pydir</i>) 413 <b>createMacAppBundle</b>(<i>pydir</i>)
414
333 <p> 415 <p>
334 Create a Mac application bundle. 416 Create a Mac application bundle.
335 </p><dl> 417 </p>
418 <dl>
419
336 <dt><i>pydir</i> (str)</dt> 420 <dt><i>pydir</i> (str)</dt>
337 <dd> 421 <dd>
338 the name of the directory where the Python script will 422 the name of the directory where the Python script will
339 eventually be installed 423 eventually be installed
340 </dd> 424 </dd>
341 </dl> 425 </dl>
342 <div align="right"><a href="#top">Up</a></div> 426 <div align="right"><a href="#top">Up</a></div>
343 <hr /><hr /> 427 <hr />
428 <hr />
344 <a NAME="createPyWrapper" ID="createPyWrapper"></a> 429 <a NAME="createPyWrapper" ID="createPyWrapper"></a>
345 <h2>createPyWrapper</h2> 430 <h2>createPyWrapper</h2>
346 <b>createPyWrapper</b>(<i>pydir, wfile, saveDir, isGuiScript=True</i>) 431 <b>createPyWrapper</b>(<i>pydir, wfile, saveDir, isGuiScript=True</i>)
432
347 <p> 433 <p>
348 Create an executable wrapper for a Python script. 434 Create an executable wrapper for a Python script.
349 </p><dl> 435 </p>
436 <dl>
437
350 <dt><i>pydir</i></dt> 438 <dt><i>pydir</i></dt>
351 <dd> 439 <dd>
352 the name of the directory where the Python script will 440 the name of the directory where the Python script will
353 eventually be installed (string) 441 eventually be installed (string)
354 </dd><dt><i>wfile</i></dt> 442 </dd>
443 <dt><i>wfile</i></dt>
355 <dd> 444 <dd>
356 the basename of the wrapper (string) 445 the basename of the wrapper (string)
357 </dd><dt><i>saveDir</i></dt> 446 </dd>
447 <dt><i>saveDir</i></dt>
358 <dd> 448 <dd>
359 directory to save the file into (string) 449 directory to save the file into (string)
360 </dd><dt><i>isGuiScript</i></dt> 450 </dd>
451 <dt><i>isGuiScript</i></dt>
361 <dd> 452 <dd>
362 flag indicating a wrapper script for a GUI 453 flag indicating a wrapper script for a GUI
363 application (boolean) 454 application (boolean)
364 </dd> 455 </dd>
365 </dl><dl> 456 </dl>
457 <dl>
366 <dt>Returns:</dt> 458 <dt>Returns:</dt>
367 <dd> 459 <dd>
368 the platform specific name of the wrapper (string) 460 the platform specific name of the wrapper (string)
369 </dd> 461 </dd>
370 </dl> 462 </dl>
371 <div align="right"><a href="#top">Up</a></div> 463 <div align="right"><a href="#top">Up</a></div>
372 <hr /><hr /> 464 <hr />
465 <hr />
373 <a NAME="createWindowsLinks" ID="createWindowsLinks"></a> 466 <a NAME="createWindowsLinks" ID="createWindowsLinks"></a>
374 <h2>createWindowsLinks</h2> 467 <h2>createWindowsLinks</h2>
375 <b>createWindowsLinks</b>(<i></i>) 468 <b>createWindowsLinks</b>(<i></i>)
469
376 <p> 470 <p>
377 Create Desktop and Start Menu links. 471 Create Desktop and Start Menu links.
378 </p> 472 </p>
379 <div align="right"><a href="#top">Up</a></div> 473 <div align="right"><a href="#top">Up</a></div>
380 <hr /><hr /> 474 <hr />
475 <hr />
381 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> 476 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a>
382 <h2>createWindowsShortcut</h2> 477 <h2>createWindowsShortcut</h2>
383 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) 478 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>)
479
384 <p> 480 <p>
385 Create Windows shortcut. 481 Create Windows shortcut.
386 </p><dl> 482 </p>
483 <dl>
484
387 <dt><i>linkPath</i> (str)</dt> 485 <dt><i>linkPath</i> (str)</dt>
388 <dd> 486 <dd>
389 path of the shortcut file 487 path of the shortcut file
390 </dd><dt><i>targetPath</i> (str)</dt> 488 </dd>
489 <dt><i>targetPath</i> (str)</dt>
391 <dd> 490 <dd>
392 path the shortcut shall point to 491 path the shortcut shall point to
393 </dd><dt><i>iconPath</i> (str)</dt> 492 </dd>
493 <dt><i>iconPath</i> (str)</dt>
394 <dd> 494 <dd>
395 path of the icon file 495 path of the icon file
396 </dd> 496 </dd>
397 </dl> 497 </dl>
398 <div align="right"><a href="#top">Up</a></div> 498 <div align="right"><a href="#top">Up</a></div>
399 <hr /><hr /> 499 <hr />
400 <a NAME="determinePyQtVariant" ID="determinePyQtVariant"></a> 500 <hr />
401 <h2>determinePyQtVariant</h2>
402 <b>determinePyQtVariant</b>(<i></i>)
403 <p>
404 Module function to determine the PyQt variant to be used.
405 </p>
406 <div align="right"><a href="#top">Up</a></div>
407 <hr /><hr />
408 <a NAME="doDependancyChecks" ID="doDependancyChecks"></a> 501 <a NAME="doDependancyChecks" ID="doDependancyChecks"></a>
409 <h2>doDependancyChecks</h2> 502 <h2>doDependancyChecks</h2>
410 <b>doDependancyChecks</b>(<i></i>) 503 <b>doDependancyChecks</b>(<i></i>)
504
411 <p> 505 <p>
412 Perform some dependency checks. 506 Perform some dependency checks.
413 </p> 507 </p>
414 <div align="right"><a href="#top">Up</a></div> 508 <div align="right"><a href="#top">Up</a></div>
415 <hr /><hr /> 509 <hr />
510 <hr />
416 <a NAME="exit" ID="exit"></a> 511 <a NAME="exit" ID="exit"></a>
417 <h2>exit</h2> 512 <h2>exit</h2>
418 <b>exit</b>(<i>rcode=0</i>) 513 <b>exit</b>(<i>rcode=0</i>)
514
419 <p> 515 <p>
420 Exit the install script. 516 Exit the install script.
421 </p><dl> 517 </p>
518 <dl>
519
422 <dt><i>rcode</i></dt> 520 <dt><i>rcode</i></dt>
423 <dd> 521 <dd>
424 result code to report back (integer) 522 result code to report back (integer)
425 </dd> 523 </dd>
426 </dl> 524 </dl>
427 <div align="right"><a href="#top">Up</a></div> 525 <div align="right"><a href="#top">Up</a></div>
428 <hr /><hr /> 526 <hr />
527 <hr />
429 <a NAME="getWinregEntry" ID="getWinregEntry"></a> 528 <a NAME="getWinregEntry" ID="getWinregEntry"></a>
430 <h2>getWinregEntry</h2> 529 <h2>getWinregEntry</h2>
431 <b>getWinregEntry</b>(<i>name, path</i>) 530 <b>getWinregEntry</b>(<i>name, path</i>)
531
432 <p> 532 <p>
433 Function to get an entry from the Windows Registry. 533 Function to get an entry from the Windows Registry.
434 </p><dl> 534 </p>
535 <dl>
536
435 <dt><i>name</i> (str)</dt> 537 <dt><i>name</i> (str)</dt>
436 <dd> 538 <dd>
437 variable name 539 variable name
438 </dd><dt><i>path</i> (str)</dt> 540 </dd>
541 <dt><i>path</i> (str)</dt>
439 <dd> 542 <dd>
440 registry path of the variable 543 registry path of the variable
441 </dd> 544 </dd>
442 </dl><dl> 545 </dl>
546 <dl>
443 <dt>Returns:</dt> 547 <dt>Returns:</dt>
444 <dd> 548 <dd>
445 value of requested registry variable 549 value of requested registry variable
446 </dd> 550 </dd>
447 </dl><dl> 551 </dl>
552 <dl>
448 <dt>Return Type:</dt> 553 <dt>Return Type:</dt>
449 <dd> 554 <dd>
450 any 555 any
451 </dd> 556 </dd>
452 </dl> 557 </dl>
453 <div align="right"><a href="#top">Up</a></div> 558 <div align="right"><a href="#top">Up</a></div>
454 <hr /><hr /> 559 <hr />
560 <hr />
455 <a NAME="initGlobals" ID="initGlobals"></a> 561 <a NAME="initGlobals" ID="initGlobals"></a>
456 <h2>initGlobals</h2> 562 <h2>initGlobals</h2>
457 <b>initGlobals</b>(<i></i>) 563 <b>initGlobals</b>(<i></i>)
564
458 <p> 565 <p>
459 Module function to set the values of globals that need more than a 566 Module function to set the values of globals that need more than a
460 simple assignment. 567 simple assignment.
461 </p> 568 </p>
462 <div align="right"><a href="#top">Up</a></div> 569 <div align="right"><a href="#top">Up</a></div>
463 <hr /><hr /> 570 <hr />
571 <hr />
464 <a NAME="installEric" ID="installEric"></a> 572 <a NAME="installEric" ID="installEric"></a>
465 <h2>installEric</h2> 573 <h2>installEric</h2>
466 <b>installEric</b>(<i></i>) 574 <b>installEric</b>(<i></i>)
575
467 <p> 576 <p>
468 Actually perform the installation steps. 577 Actually perform the installation steps.
469 </p><dl> 578 </p>
579 <dl>
470 <dt>Returns:</dt> 580 <dt>Returns:</dt>
471 <dd> 581 <dd>
472 result code (integer) 582 result code (integer)
473 </dd> 583 </dd>
474 </dl> 584 </dl>
475 <div align="right"><a href="#top">Up</a></div> 585 <div align="right"><a href="#top">Up</a></div>
476 <hr /><hr /> 586 <hr />
587 <hr />
477 <a NAME="main" ID="main"></a> 588 <a NAME="main" ID="main"></a>
478 <h2>main</h2> 589 <h2>main</h2>
479 <b>main</b>(<i>argv</i>) 590 <b>main</b>(<i>argv</i>)
591
480 <p> 592 <p>
481 The main function of the script. 593 The main function of the script.
482 </p><dl> 594 </p>
595 <dl>
596
483 <dt><i>argv</i> (list of str)</dt> 597 <dt><i>argv</i> (list of str)</dt>
484 <dd> 598 <dd>
485 list of command line arguments 599 list of command line arguments
486 </dd> 600 </dd>
487 </dl> 601 </dl>
488 <div align="right"><a href="#top">Up</a></div> 602 <div align="right"><a href="#top">Up</a></div>
489 <hr /><hr /> 603 <hr />
604 <hr />
490 <a NAME="pipInstall" ID="pipInstall"></a> 605 <a NAME="pipInstall" ID="pipInstall"></a>
491 <h2>pipInstall</h2> 606 <h2>pipInstall</h2>
492 <b>pipInstall</b>(<i>packageName, message</i>) 607 <b>pipInstall</b>(<i>packageName, message</i>)
608
493 <p> 609 <p>
494 Install the given package via pip. 610 Install the given package via pip.
495 </p><dl> 611 </p>
612 <dl>
613
496 <dt><i>packageName</i> (str)</dt> 614 <dt><i>packageName</i> (str)</dt>
497 <dd> 615 <dd>
498 name of the package to be installed 616 name of the package to be installed
499 </dd><dt><i>message</i> (str)</dt> 617 </dd>
618 <dt><i>message</i> (str)</dt>
500 <dd> 619 <dd>
501 message to be shown to the user 620 message to be shown to the user
502 </dd> 621 </dd>
503 </dl><dl> 622 </dl>
623 <dl>
504 <dt>Returns:</dt> 624 <dt>Returns:</dt>
505 <dd> 625 <dd>
506 flag indicating a successful installation 626 flag indicating a successful installation
507 </dd> 627 </dd>
508 </dl><dl> 628 </dl>
629 <dl>
509 <dt>Return Type:</dt> 630 <dt>Return Type:</dt>
510 <dd> 631 <dd>
511 bool 632 bool
512 </dd> 633 </dd>
513 </dl> 634 </dl>
514 <div align="right"><a href="#top">Up</a></div> 635 <div align="right"><a href="#top">Up</a></div>
515 <hr /><hr /> 636 <hr />
637 <hr />
516 <a NAME="prepareInfoFile" ID="prepareInfoFile"></a> 638 <a NAME="prepareInfoFile" ID="prepareInfoFile"></a>
517 <h2>prepareInfoFile</h2> 639 <h2>prepareInfoFile</h2>
518 <b>prepareInfoFile</b>(<i>fileName</i>) 640 <b>prepareInfoFile</b>(<i>fileName</i>)
641
519 <p> 642 <p>
520 Function to prepare an Info.py file when installing from source. 643 Function to prepare an Info.py file when installing from source.
521 </p><dl> 644 </p>
645 <dl>
646
522 <dt><i>fileName</i></dt> 647 <dt><i>fileName</i></dt>
523 <dd> 648 <dd>
524 name of the Python file containing the info (string) 649 name of the Python file containing the info (string)
525 </dd> 650 </dd>
526 </dl> 651 </dl>
527 <div align="right"><a href="#top">Up</a></div> 652 <div align="right"><a href="#top">Up</a></div>
528 <hr /><hr /> 653 <hr />
654 <hr />
529 <a NAME="shutilCopy" ID="shutilCopy"></a> 655 <a NAME="shutilCopy" ID="shutilCopy"></a>
530 <h2>shutilCopy</h2> 656 <h2>shutilCopy</h2>
531 <b>shutilCopy</b>(<i>src, dst, perm=0o644</i>) 657 <b>shutilCopy</b>(<i>src, dst, perm=0o644</i>)
658
532 <p> 659 <p>
533 Wrapper function around shutil.copy() to ensure the permissions. 660 Wrapper function around shutil.copy() to ensure the permissions.
534 </p><dl> 661 </p>
662 <dl>
663
535 <dt><i>src</i></dt> 664 <dt><i>src</i></dt>
536 <dd> 665 <dd>
537 source file name (string) 666 source file name (string)
538 </dd><dt><i>dst</i></dt> 667 </dd>
668 <dt><i>dst</i></dt>
539 <dd> 669 <dd>
540 destination file name or directory name (string) 670 destination file name or directory name (string)
541 </dd><dt><i>perm=</i></dt> 671 </dd>
672 <dt><i>perm=</i></dt>
542 <dd> 673 <dd>
543 permissions to be set (integer) 674 permissions to be set (integer)
544 </dd> 675 </dd>
545 </dl> 676 </dl>
546 <div align="right"><a href="#top">Up</a></div> 677 <div align="right"><a href="#top">Up</a></div>
547 <hr /><hr /> 678 <hr />
679 <hr />
548 <a NAME="usage" ID="usage"></a> 680 <a NAME="usage" ID="usage"></a>
549 <h2>usage</h2> 681 <h2>usage</h2>
550 <b>usage</b>(<i>rcode=2</i>) 682 <b>usage</b>(<i>rcode=2</i>)
683
551 <p> 684 <p>
552 Display a usage message and exit. 685 Display a usage message and exit.
553 </p><dl> 686 </p>
687 <dl>
688
554 <dt><i>rcode</i></dt> 689 <dt><i>rcode</i></dt>
555 <dd> 690 <dd>
556 the return code passed back to the calling process. 691 the return code passed back to the calling process.
557 </dd> 692 </dd>
558 </dl> 693 </dl>
559 <div align="right"><a href="#top">Up</a></div> 694 <div align="right"><a href="#top">Up</a></div>
560 <hr /><hr /> 695 <hr />
696 <hr />
561 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> 697 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a>
562 <h2>windowsDesktopEntries</h2> 698 <h2>windowsDesktopEntries</h2>
563 <b>windowsDesktopEntries</b>(<i></i>) 699 <b>windowsDesktopEntries</b>(<i></i>)
700
564 <p> 701 <p>
565 Function to generate data for the Windows Desktop links. 702 Function to generate data for the Windows Desktop links.
566 </p><dl> 703 </p>
704 <dl>
567 <dt>Returns:</dt> 705 <dt>Returns:</dt>
568 <dd> 706 <dd>
569 list of tuples containing the desktop link name, 707 list of tuples containing the desktop link name,
570 the link target and the icon target 708 the link target and the icon target
571 </dd> 709 </dd>
572 </dl><dl> 710 </dl>
711 <dl>
573 <dt>Return Type:</dt> 712 <dt>Return Type:</dt>
574 <dd> 713 <dd>
575 list of tuples of (str, str, str) 714 list of tuples of (str, str, str)
576 </dd> 715 </dd>
577 </dl> 716 </dl>
578 <div align="right"><a href="#top">Up</a></div> 717 <div align="right"><a href="#top">Up</a></div>
579 <hr /><hr /> 718 <hr />
719 <hr />
580 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> 720 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a>
581 <h2>windowsDesktopNames</h2> 721 <h2>windowsDesktopNames</h2>
582 <b>windowsDesktopNames</b>(<i></i>) 722 <b>windowsDesktopNames</b>(<i></i>)
723
583 <p> 724 <p>
584 Function to generate the link names for the Windows Desktop. 725 Function to generate the link names for the Windows Desktop.
585 </p><dl> 726 </p>
727 <dl>
586 <dt>Returns:</dt> 728 <dt>Returns:</dt>
587 <dd> 729 <dd>
588 list of desktop link names 730 list of desktop link names
589 </dd> 731 </dd>
590 </dl><dl> 732 </dl>
733 <dl>
591 <dt>Return Type:</dt> 734 <dt>Return Type:</dt>
592 <dd> 735 <dd>
593 list of str 736 list of str
594 </dd> 737 </dd>
595 </dl> 738 </dl>
596 <div align="right"><a href="#top">Up</a></div> 739 <div align="right"><a href="#top">Up</a></div>
597 <hr /><hr /> 740 <hr />
741 <hr />
598 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> 742 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a>
599 <h2>windowsProgramsEntry</h2> 743 <h2>windowsProgramsEntry</h2>
600 <b>windowsProgramsEntry</b>(<i></i>) 744 <b>windowsProgramsEntry</b>(<i></i>)
745
601 <p> 746 <p>
602 Function to generate the name of the Start Menu top entry. 747 Function to generate the name of the Start Menu top entry.
603 </p><dl> 748 </p>
749 <dl>
604 <dt>Returns:</dt> 750 <dt>Returns:</dt>
605 <dd> 751 <dd>
606 name of the Start Menu top entry 752 name of the Start Menu top entry
607 </dd> 753 </dd>
608 </dl><dl> 754 </dl>
755 <dl>
609 <dt>Return Type:</dt> 756 <dt>Return Type:</dt>
610 <dd> 757 <dd>
611 str 758 str
612 </dd> 759 </dd>
613 </dl> 760 </dl>
614 <div align="right"><a href="#top">Up</a></div> 761 <div align="right"><a href="#top">Up</a></div>
615 <hr /><hr /> 762 <hr />
763 <hr />
616 <a NAME="wrapperNames" ID="wrapperNames"></a> 764 <a NAME="wrapperNames" ID="wrapperNames"></a>
617 <h2>wrapperNames</h2> 765 <h2>wrapperNames</h2>
618 <b>wrapperNames</b>(<i>dname, wfile</i>) 766 <b>wrapperNames</b>(<i>dname, wfile</i>)
767
619 <p> 768 <p>
620 Create the platform specific names for the wrapper script. 769 Create the platform specific names for the wrapper script.
621 </p><dl> 770 </p>
771 <dl>
772
622 <dt><i>dname</i></dt> 773 <dt><i>dname</i></dt>
623 <dd> 774 <dd>
624 name of the directory to place the wrapper into 775 name of the directory to place the wrapper into
625 </dd><dt><i>wfile</i></dt> 776 </dd>
777 <dt><i>wfile</i></dt>
626 <dd> 778 <dd>
627 basename (without extension) of the wrapper script 779 basename (without extension) of the wrapper script
628 </dd> 780 </dd>
629 </dl><dl> 781 </dl>
782 <dl>
630 <dt>Returns:</dt> 783 <dt>Returns:</dt>
631 <dd> 784 <dd>
632 the names of the wrapper scripts 785 the names of the wrapper scripts
633 </dd> 786 </dd>
634 </dl> 787 </dl>

eric ide

mercurial