Sat, 02 Jan 2010 18:19:35 +0000
Updated documentation.
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <?xml version="1.0" encoding="utf-8"?> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <html><head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <title>eric5.install-i18n</title> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | <style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | </style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | </head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | <body><a NAME="top" ID="top"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | <h1>eric5.install-i18n</h1> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | Installation script for the eric5 IDE translation files. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | <h3>Global Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | <tr><td>configDir</td></tr><tr><td>privateInstall</td></tr><tr><td>progName</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Classes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <h3>Functions</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <td><a href="#getConfigDir">getConfigDir</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <td>Global function to get the name of the directory storing the config data.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <td><a href="#installTranslations">installTranslations</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <td>Install the translation files into the right place.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <td><a href="#main">main</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <td>The main function of the script.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | <td><a href="#usage">usage</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <td>Display a usage message and exit.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <a NAME="getConfigDir" ID="getConfigDir"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <h2>getConfigDir</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <b>getConfigDir</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | Global function to get the name of the directory storing the config data. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | directory name of the config dir (string) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | <a NAME="installTranslations" ID="installTranslations"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | <h2>installTranslations</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | <b>installTranslations</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | Install the translation files into the right place. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <a NAME="main" ID="main"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | <h2>main</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <b>main</b>(<i>argv</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | The main function of the script. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <dt><i>argv</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | list of command line arguments (list of strings) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | <a NAME="usage" ID="usage"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <h2>usage</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | <b>usage</b>(<i>rcode = 2</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | Display a usage message and exit. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80 | <dt><i>rcode</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | return code passed back to the calling process (integer) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
85 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | <hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | </body></html> |