33 </table> |
33 </table> |
34 <h3>Functions</h3> |
34 <h3>Functions</h3> |
35 <table> |
35 <table> |
36 <tr> |
36 <tr> |
37 <td><a href="#initGlobals">initGlobals</a></td> |
37 <td><a href="#initGlobals">initGlobals</a></td> |
38 <td>Sets the values of globals that need more than a simple assignment.</td> |
38 <td>Module function to set the values of globals that need more than a simple assignment.</td> |
39 </tr><tr> |
39 </tr><tr> |
40 <td><a href="#main">main</a></td> |
40 <td><a href="#main">main</a></td> |
41 <td>The main function of the script.</td> |
41 <td>The main function of the script.</td> |
42 </tr><tr> |
42 </tr><tr> |
43 <td><a href="#usage">usage</a></td> |
43 <td><a href="#usage">usage</a></td> |
47 <hr /><hr /> |
47 <hr /><hr /> |
48 <a NAME="initGlobals" ID="initGlobals"></a> |
48 <a NAME="initGlobals" ID="initGlobals"></a> |
49 <h2>initGlobals</h2> |
49 <h2>initGlobals</h2> |
50 <b>initGlobals</b>(<i></i>) |
50 <b>initGlobals</b>(<i></i>) |
51 <p> |
51 <p> |
52 Sets the values of globals that need more than a simple assignment. |
52 Module function to set the values of globals that need more than a |
|
53 simple assignment. |
53 </p> |
54 </p> |
54 <div align="right"><a href="#top">Up</a></div> |
55 <div align="right"><a href="#top">Up</a></div> |
55 <hr /><hr /> |
56 <hr /><hr /> |
56 <a NAME="main" ID="main"></a> |
57 <a NAME="main" ID="main"></a> |
57 <h2>main</h2> |
58 <h2>main</h2> |
58 <b>main</b>(<i>argv</i>) |
59 <b>main</b>(<i>argv</i>) |
59 <p> |
60 <p> |
60 The main function of the script. |
61 The main function of the script. |
61 </p><p> |
62 </p><dl> |
62 argv is the list of command line arguments. |
63 <dt><i>argv</i></dt> |
63 </p> |
64 <dd> |
|
65 list of command line arguments (list of strings) |
|
66 </dd> |
|
67 </dl> |
64 <div align="right"><a href="#top">Up</a></div> |
68 <div align="right"><a href="#top">Up</a></div> |
65 <hr /><hr /> |
69 <hr /><hr /> |
66 <a NAME="usage" ID="usage"></a> |
70 <a NAME="usage" ID="usage"></a> |
67 <h2>usage</h2> |
71 <h2>usage</h2> |
68 <b>usage</b>(<i>rcode=2</i>) |
72 <b>usage</b>(<i>rcode=2</i>) |
69 <p> |
73 <p> |
70 Display a usage message and exit. |
74 Display a usage message and exit. |
71 </p><p> |
75 </p><dl> |
72 rcode is the return code passed back to the calling process. |
76 <dt><i>rcode</i></dt> |
73 </p> |
77 <dd> |
|
78 return code passed back to the calling process (integer) |
|
79 </dd> |
|
80 </dl> |
74 <div align="right"><a href="#top">Up</a></div> |
81 <div align="right"><a href="#top">Up</a></div> |
75 <hr /> |
82 <hr /> |
76 </body></html> |
83 </body></html> |