Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/install.html

eric7/Documentation/Source/install.html

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

Mercurial Repository: eric

eric ide

mercurial