eric7/Documentation/Source/install-i18n.html

branch
eric7
changeset 8312
800c432b34c8
parent 7989
a21d673a8f99
child 8596
d64760b2da50
equal deleted inserted replaced
8311:4e8b98454baa 8312:800c432b34c8
1 <!DOCTYPE html>
2 <html><head>
3 <title>install-i18n</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-i18n</h1>
24
25 <p>
26 Installation script for the eric IDE translation files.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>configDir</td></tr><tr><td>privateInstall</td></tr><tr><td>progName</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="#getConfigDir">getConfigDir</a></td>
44 <td>Global function to get the name of the directory storing the config data.</td>
45 </tr>
46 <tr>
47 <td><a href="#installTranslations">installTranslations</a></td>
48 <td>Install the translation files into the right place.</td>
49 </tr>
50 <tr>
51 <td><a href="#main">main</a></td>
52 <td>The main function of the script.</td>
53 </tr>
54 <tr>
55 <td><a href="#usage">usage</a></td>
56 <td>Display a usage message and exit.</td>
57 </tr>
58 </table>
59 <hr />
60 <hr />
61 <a NAME="getConfigDir" ID="getConfigDir"></a>
62 <h2>getConfigDir</h2>
63 <b>getConfigDir</b>(<i></i>)
64
65 <p>
66 Global function to get the name of the directory storing the config data.
67 </p>
68 <dl>
69 <dt>Return:</dt>
70 <dd>
71 directory name of the config dir (string)
72 </dd>
73 </dl>
74 <div align="right"><a href="#top">Up</a></div>
75 <hr />
76 <hr />
77 <a NAME="installTranslations" ID="installTranslations"></a>
78 <h2>installTranslations</h2>
79 <b>installTranslations</b>(<i></i>)
80
81 <p>
82 Install the translation files into the right place.
83 </p>
84 <div align="right"><a href="#top">Up</a></div>
85 <hr />
86 <hr />
87 <a NAME="main" ID="main"></a>
88 <h2>main</h2>
89 <b>main</b>(<i>argv</i>)
90
91 <p>
92 The main function of the script.
93 </p>
94 <dl>
95
96 <dt><i>argv</i></dt>
97 <dd>
98 list of command line arguments (list of strings)
99 </dd>
100 </dl>
101 <div align="right"><a href="#top">Up</a></div>
102 <hr />
103 <hr />
104 <a NAME="usage" ID="usage"></a>
105 <h2>usage</h2>
106 <b>usage</b>(<i>rcode=2</i>)
107
108 <p>
109 Display a usage message and exit.
110 </p>
111 <dl>
112
113 <dt><i>rcode</i></dt>
114 <dd>
115 return code passed back to the calling process (integer)
116 </dd>
117 </dl>
118 <div align="right"><a href="#top">Up</a></div>
119 <hr />
120 </body></html>

eric ide

mercurial