Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/install-i18n.html
src/eric7/Documentation/Source/install-i18n.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>install-i18n</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>install-i18n</h1> | |
| 10 | |
| 11 <p> | |
| 12 Installation script for the eric IDE translation files. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>configDir</td></tr><tr><td>privateInstall</td></tr><tr><td>progName</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#getConfigDir">getConfigDir</a></td> | |
| 30 <td>Global function to get the name of the directory storing the config data.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#installTranslations">installTranslations</a></td> | |
| 34 <td>Install the translation files into the right place.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#main">main</a></td> | |
| 38 <td>The main function of the script.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#usage">usage</a></td> | |
| 42 <td>Display a usage message and exit.</td> | |
| 43 </tr> | |
| 44 </table> | |
| 45 <hr /> | |
| 46 <hr /> | |
| 47 <a NAME="getConfigDir" ID="getConfigDir"></a> | |
| 48 <h2>getConfigDir</h2> | |
| 49 <b>getConfigDir</b>(<i></i>) | |
| 50 | |
| 51 <p> | |
| 52 Global function to get the name of the directory storing the config data. | |
| 53 </p> | |
| 54 <dl> | |
| 55 <dt>Return:</dt> | |
| 56 <dd> | |
| 57 directory name of the config dir (string) | |
| 58 </dd> | |
| 59 </dl> | |
| 60 <div align="right"><a href="#top">Up</a></div> | |
| 61 <hr /> | |
| 62 <hr /> | |
| 63 <a NAME="installTranslations" ID="installTranslations"></a> | |
| 64 <h2>installTranslations</h2> | |
| 65 <b>installTranslations</b>(<i></i>) | |
| 66 | |
| 67 <p> | |
| 68 Install the translation files into the right place. | |
| 69 </p> | |
| 70 <div align="right"><a href="#top">Up</a></div> | |
| 71 <hr /> | |
| 72 <hr /> | |
| 73 <a NAME="main" ID="main"></a> | |
| 74 <h2>main</h2> | |
| 75 <b>main</b>(<i>argv</i>) | |
| 76 | |
| 77 <p> | |
| 78 The main function of the script. | |
| 79 </p> | |
| 80 <dl> | |
| 81 | |
| 82 <dt><i>argv</i></dt> | |
| 83 <dd> | |
| 84 list of command line arguments (list of strings) | |
| 85 </dd> | |
| 86 </dl> | |
| 87 <div align="right"><a href="#top">Up</a></div> | |
| 88 <hr /> | |
| 89 <hr /> | |
| 90 <a NAME="usage" ID="usage"></a> | |
| 91 <h2>usage</h2> | |
| 92 <b>usage</b>(<i>rcode=2</i>) | |
| 93 | |
| 94 <p> | |
| 95 Display a usage message and exit. | |
| 96 </p> | |
| 97 <dl> | |
| 98 | |
| 99 <dt><i>rcode</i></dt> | |
| 100 <dd> | |
| 101 return code passed back to the calling process (integer) | |
| 102 </dd> | |
| 103 </dl> | |
| 104 <div align="right"><a href="#top">Up</a></div> | |
| 105 <hr /> | |
| 106 </body></html> |
