xref: /trunk/main/odk/docs/tools.html (revision ef1ef8e6)
1cdf0e10cSrcweir<html>
2cdf0e10cSrcweir<head>
3cdf0e10cSrcweir  <title>OpenOffice.org %PRODUCT_RELEASE% SDK - Development Tools</title>
4cdf0e10cSrcweir  <link rel="stylesheet" type="text/css" href="sdk_styles.css">
5cdf0e10cSrcweir  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6cdf0e10cSrcweir  <meta name="author" content="J&uuml;rgen Schmidt">
7cdf0e10cSrcweir</head>
8cdf0e10cSrcweir
9cdf0e10cSrcweir<body class="sdkbody"><a name="tools"/>
10cdf0e10cSrcweir<table class="table1" cellpadding=0>
11cdf0e10cSrcweir  <tr style="background-image:url(images/sdk_head-2.png)">
12cdf0e10cSrcweir    <td colspan="3" align="left"><img src="images/sdk_head-1.png" width="800" height="120" usemap="#Map" border="0"></td>
13cdf0e10cSrcweir  </tr>
14cdf0e10cSrcweir  <tr>
15cdf0e10cSrcweir    <td colspan="3"><img  class="nothing10" src="images/nada.gif"></td>
16cdf0e10cSrcweir  </tr>
17cdf0e10cSrcweir  <tr>
18cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
19cdf0e10cSrcweir    <td>
20cdf0e10cSrcweir      <table class="table2">
21cdf0e10cSrcweir	    <tr>
22cdf0e10cSrcweir		  <td colspan="3"><img class="nothing1" src="images/nada.gif"></td>
23cdf0e10cSrcweir        </tr>
24cdf0e10cSrcweir        <tr>
25cdf0e10cSrcweir          <td>
26cdf0e10cSrcweir          <table class="table3">
27cdf0e10cSrcweir		  <tr>
28cdf0e10cSrcweir			<td colspan="2" class="head1">Development Tools</td>
29cdf0e10cSrcweir			<td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
30cdf0e10cSrcweir		  </tr>
31cdf0e10cSrcweir		  </table>
32cdf0e10cSrcweir          </td>
33cdf0e10cSrcweir        </tr>
34cdf0e10cSrcweir        <tr>
35cdf0e10cSrcweir          <td>
36cdf0e10cSrcweir          <table class="table3">
37cdf0e10cSrcweir            <tr valign="top">
38cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
39cdf0e10cSrcweir              <td><a href="#unopkg"  title="link to the unopkg tool description">unopkg</a></td>
40cdf0e10cSrcweir              <td class="content87">The new UNO package deployment tool. It comes
41cdf0e10cSrcweir			  with the office installation and can be found in the program
42cdf0e10cSrcweir			  directory of the office installation.</td>
43cdf0e10cSrcweir            </tr>
44cdf0e10cSrcweir            <tr valign="top">
45cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
46cdf0e10cSrcweir              <td><a href="#unoexe"  title="link to the uno tool description">uno</a></td>
47cdf0e10cSrcweir              <td class="content87">Tool to provide a UNO runtime environment and
48cdf0e10cSrcweir			  provide configured (deployed) or single components. This tool
49cdf0e10cSrcweir			  comes with the office installation and can be found in the program
50cdf0e10cSrcweir			  directory of the office installation.</td>
51cdf0e10cSrcweir            </tr>
52cdf0e10cSrcweir           <tr valign="top">
53cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
54cdf0e10cSrcweir              <td><a href="#regmerge"  title="link to the regmerge tool description">regmerge</a></td>
55cdf0e10cSrcweir              <td class="content87">Tool to merge several registry (e.g. type
56cdf0e10cSrcweir			  libraries) files into one file. <b>Note:</b> Since OpenOffice.org 3 it is not longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td>
57cdf0e10cSrcweir            </tr>
58cdf0e10cSrcweir            <tr valign="top">
59cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
60cdf0e10cSrcweir              <td><a href="#regview"  title="link to the regview tool description">regview</a></td>
61cdf0e10cSrcweir              <td class="content87">Tool to view the content of a registry file
62cdf0e10cSrcweir			  in a human readable manner. Special support for type library
63cdf0e10cSrcweir			  nodes. <b>Note:</b> Since OpenOffice.org 3 it is not longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td>
64cdf0e10cSrcweir            </tr>
65cdf0e10cSrcweir            <tr valign="middle">
66cdf0e10cSrcweir              <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
67cdf0e10cSrcweir            </tr>
68cdf0e10cSrcweir            <tr valign="top">
69cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
70cdf0e10cSrcweir              <td><a href="#idlc" title="link to the idlc tool description">idlc</a></td>
71cdf0e10cSrcweir              <td class="content87">The UNOIDL compiler, generates a common
72cdf0e10cSrcweir			  binary type library format as base for all codemaker tools and
73cdf0e10cSrcweir			  the UNO runtime type library.</td>
74cdf0e10cSrcweir            </tr>
75cdf0e10cSrcweir            <tr valign="top">
76cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
77cdf0e10cSrcweir              <td><a href="#cppumaker" title="link to the cppumaker tool description">cppumaker</a></td>
78cdf0e10cSrcweir              <td class="content87">Tool for generating C++ code for the UNOIDL
79cdf0e10cSrcweir			  types stored in a type library.</td>
80cdf0e10cSrcweir            </tr>
81cdf0e10cSrcweir            <tr valign="top">
82cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
83cdf0e10cSrcweir              <td><a href="#javamaker" title="link to the javamaker tool description">javamaker</a></td>
84cdf0e10cSrcweir              <td class="content87">Tool for generating Java class files for the
85cdf0e10cSrcweir			  UNOIDL types stored in a type library.</td>
86cdf0e10cSrcweir            </tr>
87cdf0e10cSrcweir           <tr valign="top">
88cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
89cdf0e10cSrcweir              <td><a href="#climaker" title="link to the climaker tool description">climaker</a></td>
90cdf0e10cSrcweir              <td class="content87">Tool for generating CLI assemblies for the
91cdf0e10cSrcweir			  UNOIDL types stored in a type library (windows only).</td>
92cdf0e10cSrcweir            </tr>
93cdf0e10cSrcweir            <tr valign="top">
94cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
95cdf0e10cSrcweir              <td><a href="#uno-skeletonmaker" title="link to the uno-skeletonmaker tool description">uno-skeletonmaker</a></td>
96cdf0e10cSrcweir              <td class="content87">Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.</td>
97cdf0e10cSrcweir            </tr>
98cdf0e10cSrcweir            <tr valign="top">
99cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
100cdf0e10cSrcweir              <td><a href="#regcomp"  title="link to the regcomp tool description">regcomp</a></td>
101cdf0e10cSrcweir              <td class="content87">A simple UNO component registration tool.</td>
102cdf0e10cSrcweir            </tr>
103cdf0e10cSrcweir            <tr valign="top">
104cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
105cdf0e10cSrcweir              <td><a href="#regmerge"  title="link to the regmerge tool description">regmerge</a></td>
106cdf0e10cSrcweir              <td class="content87">Tool to merge several registry (e.g. type
107cdf0e10cSrcweir			  libraries) files into one file.</td>
108cdf0e10cSrcweir            </tr>
109cdf0e10cSrcweir            <tr valign="top">
110cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
111cdf0e10cSrcweir              <td><a href="#regview"  title="link to the regview tool description">regview</a></td>
112cdf0e10cSrcweir              <td class="content87">Tool to view the content of a registry file
113cdf0e10cSrcweir			  in a human readable manner. Special support for type library
114cdf0e10cSrcweir			  nodes.</td>
115cdf0e10cSrcweir            </tr>
116cdf0e10cSrcweir            <tr valign="top">
117cdf0e10cSrcweir              <td class="content3"><img src="images/arrow-1.gif"></td>
118cdf0e10cSrcweir              <td><a href="#autodoc"  title="link to the autodoc tool description">autodoc</a></td>
119cdf0e10cSrcweir              <td class="content87">Tool to generate javadoc-like documentation
120cdf0e10cSrcweir			  for C/C++ and UNOIDL files.</td>
121cdf0e10cSrcweir            </tr>
122cdf0e10cSrcweir            </table>
123cdf0e10cSrcweir          </td>
124cdf0e10cSrcweir		</tr>
125cdf0e10cSrcweir      </table>
126cdf0e10cSrcweir    </td>
127cdf0e10cSrcweir	<td class="content1"><img class="nothing8" src="images/nada.gif"></td>
128cdf0e10cSrcweir  </tr>
129cdf0e10cSrcweir  <tr>
130cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
131cdf0e10cSrcweir  </tr>
132cdf0e10cSrcweir  <tr>
133cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
134cdf0e10cSrcweir    <td>
135cdf0e10cSrcweir      <table class="table2">
136cdf0e10cSrcweir        <tr>
137cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="unopkg"/>unopkg</td>
138cdf0e10cSrcweir		  <td align="right">
139cdf0e10cSrcweir			<a style="a:link:visited #FFFFFF;" href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
140cdf0e10cSrcweir			<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td>
141cdf0e10cSrcweir        </tr>
142cdf0e10cSrcweir		<tr>
143cdf0e10cSrcweir		  <td colspan="3">
144cdf0e10cSrcweir		  <p>'unopkg' is a tool for easy deployment of UNO packages in an existing
145cdf0e10cSrcweir		  office installation. UNO packages are UNO components (single libraries or
146cdf0e10cSrcweir		  Jar files or more complex zip files that contains one or more libraries|
147cdf0e10cSrcweir		  Jar files, type libraries and configuration items), scripts  and
148cdf0e10cSrcweir		  OpenOffice.org %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the
149cdf0e10cSrcweir		  SDK but comes with the office directly and is a development tool as well
150cdf0e10cSrcweir		  as an end user tool to deploy extension into an office installation.</p>
151cdf0e10cSrcweir		  <p>More details concerning deployment and this tool can be find in the
152cdf0e10cSrcweir		  Developer's Guide: <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p>
153cdf0e10cSrcweir		  <p><b>Note:</b> This tool works only in the <i>&lt;office&gt;/program</i>
154cdf0e10cSrcweir		  directory!</p>
155cdf0e10cSrcweir		  <p class="head2">Usage:</p>
156cdf0e10cSrcweir		  <blockquote>
157cdf0e10cSrcweir		  <b><code>
158cdf0e10cSrcweir		    unopkg add &lt;options&gt; package-path...<br>
159cdf0e10cSrcweir			unopkg remove &lt;options&gt; package-name...<br>
160cdf0e10cSrcweir			unopkg list &lt;options&gt; package-name...<br>
161cdf0e10cSrcweir			unopkg reinstall &lt;options&gt;<br>
162cdf0e10cSrcweir			unopkg gui<br>
163cdf0e10cSrcweir			unopkg -V<br>
164cdf0e10cSrcweir			unopkg -h<br>
165cdf0e10cSrcweir		  </code></b>
166cdf0e10cSrcweir		  </blockquote>
167cdf0e10cSrcweir		  <p class="head2">Sub-commands:</p>
168cdf0e10cSrcweir		  <p>
169cdf0e10cSrcweir		  <table class="table4">
170cdf0e10cSrcweir		  <tr>
171cdf0e10cSrcweir		    <td class="cell15"><code>add</code></td>
172cdf0e10cSrcweir			<td class="cell85">add packages</td>
173cdf0e10cSrcweir		  </tr>
174cdf0e10cSrcweir			<tr>
175cdf0e10cSrcweir			<td class="cell15"><code>remove</code></td>
176cdf0e10cSrcweir			<td class="cell85">remove packages by name</td>
177cdf0e10cSrcweir          </tr>
178cdf0e10cSrcweir		  <tr>
179cdf0e10cSrcweir            <td class="cell15"><code>reinstall</code></td>
180cdf0e10cSrcweir			<td class="cell85">export feature: reinstall all deployed
181cdf0e10cSrcweir			packages</td>
182cdf0e10cSrcweir          </tr>
183cdf0e10cSrcweir		  <tr>
184cdf0e10cSrcweir            <td class="cell15"><code>list</code></td>
185cdf0e10cSrcweir			<td class="cell85">list information about deployed packages</td>
186cdf0e10cSrcweir          </tr>
187cdf0e10cSrcweir		  <tr>
188cdf0e10cSrcweir            <td class="cell15"><code>gui</code></td>
189cdf0e10cSrcweir			<td class="cell15">raise Package Manager Graphical User Interface
190cdf0e10cSrcweir			(GUI)</td>
191cdf0e10cSrcweir          </tr>
192cdf0e10cSrcweir		  </table>
193cdf0e10cSrcweir		  </p>
194cdf0e10cSrcweir		  <p class="head2">Options:</p>
195cdf0e10cSrcweir		  <p>
196cdf0e10cSrcweir		  <table class="table4">
197cdf0e10cSrcweir		  <tr>
198cdf0e10cSrcweir            <td class="cell15"><code>-h, --help</code></td>
199cdf0e10cSrcweir            <td class="cell85">show this help on the command line</td>
200cdf0e10cSrcweir          </tr>
201cdf0e10cSrcweir		  <tr>
202cdf0e10cSrcweir            <td class="cell15"><code>-V, --version</code></td>
203cdf0e10cSrcweir			<td class="cell85">shows version information
204cdf0e10cSrcweir			</td>
205cdf0e10cSrcweir          </tr>
206cdf0e10cSrcweir          <tr>
207cdf0e10cSrcweir            <td class="cell15"><code>-v, --verbose</code></td>
208cdf0e10cSrcweir			<td class="cell85">dump verbose output to stdout</td>
209cdf0e10cSrcweir          </tr>
210cdf0e10cSrcweir		  <tr>
211cdf0e10cSrcweir            <td class="cell15"><code>-f, --force</code></td>
212cdf0e10cSrcweir			<td class="cell85">force overwriting existing packages</td>
213cdf0e10cSrcweir          </tr>
214cdf0e10cSrcweir          <tr>
215cdf0e10cSrcweir            <td class="cell15"><code>--log-file &lt;file&gt;</code></td>
216cdf0e10cSrcweir			<td class="cell85">custom log file; default:
217cdf0e10cSrcweir			<i>&lt;cache-dir&gt/log.txt</i>.</td>
218cdf0e10cSrcweir          </tr>
219cdf0e10cSrcweir          <tr>
220cdf0e10cSrcweir            <td class="cell15"><code>--shared</code></td>
221cdf0e10cSrcweir			<td class="cell85">expert feature: operate on shared installation
222cdf0e10cSrcweir			deployment context; run only when no concurrent Office process(es) are
223cdf0e10cSrcweir			running!</td>
224cdf0e10cSrcweir          </tr>
225cdf0e10cSrcweir          <tr>
226cdf0e10cSrcweir		    <td class="cell15"><code>--deployment-context &lt;context&gt</code>
227cdf0e10cSrcweir			</td>
228cdf0e10cSrcweir			<td class="cell85">expert feature: explicit deployment context</td>
229cdf0e10cSrcweir          </tr>
230cdf0e10cSrcweir		  </table>
231cdf0e10cSrcweir		  </p>
232cdf0e10cSrcweir		  </td>
233cdf0e10cSrcweir		</tr>
234cdf0e10cSrcweir      </table>
235cdf0e10cSrcweir    </td>
236cdf0e10cSrcweir	<td class="content1"><img class="nothing8" src="images/nada.gif"></td>
237cdf0e10cSrcweir  </tr>
238cdf0e10cSrcweir  <tr>
239cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
240cdf0e10cSrcweir  </tr>
241cdf0e10cSrcweir  <tr>
242cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
243cdf0e10cSrcweir    <td>
244cdf0e10cSrcweir      <table class="table2">
245cdf0e10cSrcweir        <tr>
246cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="unoexe"/>uno</td>
247cdf0e10cSrcweir		  <td align="right">
248cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
249cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
250cdf0e10cSrcweir		  </td>
251cdf0e10cSrcweir        </tr>
252cdf0e10cSrcweir		<tr>
253cdf0e10cSrcweir		  <td colspan="3">
254cdf0e10cSrcweir		  <p>The UNO-starter is for running a component or service process, and
255cdf0e10cSrcweir		  providing a runtime environment. Raising a component might look like
256cdf0e10cSrcweir		  this </p>
257cdf0e10cSrcweir		  <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb
258cdf0e10cSrcweir		  -- foo bar</code></p>
259cdf0e10cSrcweir		  <p>or</p>
260cdf0e10cSrcweir		  <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb
261cdf0e10cSrcweir		  -- foo bar</code></p>
262cdf0e10cSrcweir		  <p>The starter loads the component and instantiates it. The component
263cdf0e10cSrcweir		  must export the interface <a href="common/ref/com/sun/star/lang/XMain.html" title="link into the IDL reference to the interface com.sun.star.lang.XMain">com.sun.star.lang.XMain</a>:</p>
264cdf0e10cSrcweir		  <p>
265cdf0e10cSrcweir		  <code>interface XMain : com::sun::star::uno::XInterface <br>
266cdf0e10cSrcweir            { <br>
267cdf0e10cSrcweir              &nbsp;&nbsp;&nbsp; /** This method is called to run the component.<br>
268cdf0e10cSrcweir              &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>
269cdf0e10cSrcweir              &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @param aArguments command line arguments <br>
270cdf0e10cSrcweir              &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @return process error code to be returned to system <br>
271cdf0e10cSrcweir              &nbsp;&nbsp;&nbsp; */ <br>
272cdf0e10cSrcweir              &nbsp;&nbsp;&nbsp; long run( [in] sequence&lt; string &gt; arguments ); <br>
273cdf0e10cSrcweir            };
274cdf0e10cSrcweir          </code>
275cdf0e10cSrcweir		  </p>
276cdf0e10cSrcweir		  <p>Method run() will be called and returns the error code given, back
277cdf0e10cSrcweir		  to the system. If the uno starter is executed with the -u (URL) option,
278cdf0e10cSrcweir		  then XInitialization is used instead of XMain. The -u option is described
279cdf0e10cSrcweir		  later.</p>
280cdf0e10cSrcweir		  <p class="head2">Usage:</p>
281cdf0e10cSrcweir		  <blockquote>
282cdf0e10cSrcweir		  <b><code>uno (-c&lt;ComponentImplementationName&gt; -l &lt;LocationUrl&gt;
283cdf0e10cSrcweir		    | -s &lt;ServiceName&gt;) <br>
284cdf0e10cSrcweir            [-ro &lt;ReadOnlyRegistry1&gt;] [-ro &lt;ReadOnlyRegistry2&gt;] ... [-rw &lt;ReadWriteRegistry&gt;]<br>
285cdf0e10cSrcweir            [-u uno:(socket[,host=&lt;HostName&gt;][,port=&lt;nnn&gt;]|pipe[,name=&lt;PipeName&gt;]);iiop|urp;&lt;Name&gt;<br>
286cdf0e10cSrcweir            [--singleaccept] [--singleinstance]] <br>
287cdf0e10cSrcweir            [-- &lt;Argument1 Argument2 ...&gt;]
288cdf0e10cSrcweir          </code></b>
289cdf0e10cSrcweir		  </blockquote>
290cdf0e10cSrcweir		  <p class="head2">Options:</p>
291cdf0e10cSrcweir		  <p>
292cdf0e10cSrcweir		  <table class="table4">
293cdf0e10cSrcweir          <tr>
294cdf0e10cSrcweir            <td class="cell15"><code>&lt;HostName&gt;</code></td>
295cdf0e10cSrcweir            <td class="cell85">Specifying a host name might be necessary to
296cdf0e10cSrcweir			distinguish the network interface to be used,if a machine is part of
297cdf0e10cSrcweir			two networks.</td>
298cdf0e10cSrcweir          </tr>
299cdf0e10cSrcweir          <tr>
300cdf0e10cSrcweir            <td class="cell15"><code>&lt;PipeName&gt;</code></td>
301cdf0e10cSrcweir            <td class="cell85">Name of a named pipe.</td>
302cdf0e10cSrcweir          </tr>
303cdf0e10cSrcweir          <tr>
304cdf0e10cSrcweir            <td class="cell15"><code>&lt;Name&gt;</code></td>
305cdf0e10cSrcweir            <td class="cell85">Identifier for demanded called component
306cdf0e10cSrcweir			instances.</td>
307cdf0e10cSrcweir          </tr>
308cdf0e10cSrcweir          <tr>
309cdf0e10cSrcweir            <td class="cell15"><code>&lt;Registries&gt;</code></td>
310cdf0e10cSrcweir            <td class="cell85">The optional <code>&lt;Registries&gt;</code>
311cdf0e10cSrcweir			(e.g., c:\myreg.rdb) are used by the ServiceManager. The <i>ro</i>
312cdf0e10cSrcweir			ones are opened for reading only; whereas, a single <i>rw</i> one
313cdf0e10cSrcweir			will be opened for reading and writing. If the <i>rw</i> one does
314cdf0e10cSrcweir			not exist, then it may be created. Components may read and write to
315cdf0e10cSrcweir			store their persistent state.</td>
316cdf0e10cSrcweir          </tr>
317cdf0e10cSrcweir          <tr>
318cdf0e10cSrcweir            <td class="cell15"><code>--singleaccept</code></td>
319cdf0e10cSrcweir            <td class="cell85">The uno starter will accept one connection,
320cdf0e10cSrcweir			provide the component instance and die.</td>
321cdf0e10cSrcweir          </tr>
322cdf0e10cSrcweir          <tr>
323cdf0e10cSrcweir            <td class="cell15"><code>--singleinstance</code></td>
324cdf0e10cSrcweir            <td class="cell85">The uno starter will accept any number of
325cdf0e10cSrcweir			connections, but will provide the same single component instance any
326cdf0e10cSrcweir			time instead of creating a new instance for each connection.</td>
327cdf0e10cSrcweir          </tr>
328cdf0e10cSrcweir          </table>
329cdf0e10cSrcweir		  <p><b>Service <a href="common/ref/com/sun/star/bridge/UnoUrlResolver.html" title="link into the IDL reference to the service com.sun.star.bridge.UnoUrlResolver">com.sun.star.bridge.UnoUrlResolver</a></b></p>
330cdf0e10cSrcweir		  <p>You can easily connect to a server started with the
331cdf0e10cSrcweir		  <code>-u (url)</code> option by using this service, giving the same url
332cdf0e10cSrcweir		  to resolve. The service provides you an instance from remote.</p>
333cdf0e10cSrcweir		  </p>
334cdf0e10cSrcweir		  </td>
335cdf0e10cSrcweir		</tr>
336cdf0e10cSrcweir      </table>
337cdf0e10cSrcweir    </td>
338cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
339cdf0e10cSrcweir  </tr>
340cdf0e10cSrcweir  <tr>
341cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
342cdf0e10cSrcweir  </tr>
343cdf0e10cSrcweir  <tr>
344cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
345cdf0e10cSrcweir    <td>
346cdf0e10cSrcweir      <table class="table2">
347cdf0e10cSrcweir        <tr>
348cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="idlc"/>idlc</td>
349cdf0e10cSrcweir		  <td align="right">
350cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
351cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
352cdf0e10cSrcweir		  </td>
353cdf0e10cSrcweir        </tr>
354cdf0e10cSrcweir		<tr>
355cdf0e10cSrcweir		  <td colspan="3">
356cdf0e10cSrcweir		  <p>'idlc' is the UNOIDL compiler.  It is a full featured compiler used
357cdf0e10cSrcweir		  to check UNODL type definitions and transform valid type definitions
358cdf0e10cSrcweir		  into a binary type library format, which is later used by all codemaker
359cdf0e10cSrcweir		  tools. It is also used as a dynamic type library for UNO at runtime.<br>
360cdf0e10cSrcweir		  You can find a syntax description for UNOIDL <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixD/UNOIDL_Syntax_Specification" title="link to the &quot;UNOIDL Syntax Specification&quot; chapter in the Developer's Guide">here</a>.</p>
361cdf0e10cSrcweir		  <p class="head2">Usage:</p>
362cdf0e10cSrcweir		  <blockquote>
363cdf0e10cSrcweir		  <b><code>idlc [-options] file_1 ... file_n | @&lt;filename&gt;</code></b>
364cdf0e10cSrcweir		  </blockquote>
365cdf0e10cSrcweir		  <p>
366cdf0e10cSrcweir		  <table class="table4">
367cdf0e10cSrcweir		  <tr>
368cdf0e10cSrcweir            <td class="cell15"><code>file_1 ... file_n</code></td>
369cdf0e10cSrcweir			<td class="cell85">specifies one or more idl files. Only files with
370cdf0e10cSrcweir			the extension '.idl' are valid.</td>
371cdf0e10cSrcweir          </tr>
372cdf0e10cSrcweir		  <tr>
373cdf0e10cSrcweir            <td class="cell15"><code>@&lt;filename&gt;</code></td>
374cdf0e10cSrcweir			<td class="cell85">filename specifies the name of a command
375cdf0e10cSrcweir			file.</td>
376cdf0e10cSrcweir          </tr>
377cdf0e10cSrcweir		  </table>
378cdf0e10cSrcweir		  </p>
379cdf0e10cSrcweir		  <p class="head2">Options:</p>
380cdf0e10cSrcweir		  <p>
381cdf0e10cSrcweir		  <table class="table4">
382cdf0e10cSrcweir		  <tr>
383cdf0e10cSrcweir            <td class="cell15"><code>-O&lt;path&gt;</code></td>
384cdf0e10cSrcweir			<td class="cell85">path describes the output directory. The
385cdf0e10cSrcweir			generated output is a registry file with the same name as the idl
386cdf0e10cSrcweir			input file.</td>
387cdf0e10cSrcweir          </tr>
388cdf0e10cSrcweir          <tr>
389cdf0e10cSrcweir		    <td class="cell15"><code>-I&lt;path&gt;</code></td>
390cdf0e10cSrcweir			<td class="cell85">path specifies a directory where included files
391cdf0e10cSrcweir			that will be searched by the preprocessor are located. Multiple
392cdf0e10cSrcweir			directories can be combined with ';'.</td>
393cdf0e10cSrcweir          </tr>
394cdf0e10cSrcweir		  <tr>
395cdf0e10cSrcweir            <td class="cell15"><code>-D&lt;name&gt;</code></td>
396cdf0e10cSrcweir			<td class="cell85">name defines a macro for the preprocessor.</td>
397cdf0e10cSrcweir          </tr>
398cdf0e10cSrcweir		  <tr>
399cdf0e10cSrcweir            <td class="cell15"><code>-C</code></td>
400cdf0e10cSrcweir			<td class="cell85">generates complete type information, including
401cdf0e10cSrcweir			additional service information and documentation.</td>
402cdf0e10cSrcweir          </tr>
403cdf0e10cSrcweir		  <tr>
404cdf0e10cSrcweir            <td class="cell15"><code>-h|?</code></td>
405cdf0e10cSrcweir			<td class="cell85">print this help message and exit.</td>
406cdf0e10cSrcweir          </tr>
407cdf0e10cSrcweir		  </table>
408cdf0e10cSrcweir		  </p>
409cdf0e10cSrcweir		  </td>
410cdf0e10cSrcweir		</tr>
411cdf0e10cSrcweir      </table>
412cdf0e10cSrcweir    </td>
413cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
414cdf0e10cSrcweir  </tr>
415cdf0e10cSrcweir  <tr>
416cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
417cdf0e10cSrcweir  </tr>
418cdf0e10cSrcweir  <tr>
419cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
420cdf0e10cSrcweir    <td>
421cdf0e10cSrcweir      <table class="table2">
422cdf0e10cSrcweir        <tr>
423cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="cppumaker"/>cppumaker</td>
424cdf0e10cSrcweir		  <td align="right">
425cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
426cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
427cdf0e10cSrcweir		  </td>
428cdf0e10cSrcweir        </tr>
429cdf0e10cSrcweir		<tr>
430cdf0e10cSrcweir		  <td colspan="3">
431cdf0e10cSrcweir		  <p>The 'cppumaker' generates a C++ representation for idl types. The
432cdf0e10cSrcweir		  cppumaker works on a typelibrary, which is generated by the UNOIDL
433cdf0e10cSrcweir		  compiler (<a href="#idlc" link="link to the idlc tool description">
434cdf0e10cSrcweir		  idlc</a>). It generates the output for all specified types and for all
435cdf0e10cSrcweir		  types the specified types depend on.</p>
436cdf0e10cSrcweir		  <p class="head2">Usage:</p>
437cdf0e10cSrcweir		  <blockquote>
438cdf0e10cSrcweir		  <b><code>cppumaker [-options] file_1 ... file_n</code></b>
439cdf0e10cSrcweir		  </blockquote>
440cdf0e10cSrcweir		  <p class="head2">Options:</p>
441cdf0e10cSrcweir		  <p>
442cdf0e10cSrcweir		  <table class="table4">
443cdf0e10cSrcweir		  <tr>
444cdf0e10cSrcweir            <td class="cell15"><code>-O&lt;path&gt;</code></td>
445cdf0e10cSrcweir			<td class="cell85">path describes the root directory for the
446cdf0e10cSrcweir			generated output. The output directory tree is generated under this
447cdf0e10cSrcweir			directory.</td>
448cdf0e10cSrcweir          </tr>
449cdf0e10cSrcweir		  <tr>
450cdf0e10cSrcweir            <td class="cell15"><code>-T&lt;name&gt;<br>
451cdf0e10cSrcweir			|-T&lt;t1&gt;;&lt;t2&gt;...</code></td>
452cdf0e10cSrcweir			<td class="cell85">name specifies a type or a list of types. The
453cdf0e10cSrcweir			output for this type and all dependent types are generated. If no '-T'
454cdf0e10cSrcweir			option is specified, then output for all types is generated. It is also
455cdf0e10cSrcweir			possible to use a wildcard 'xy.*' to generate a complete module
456cdf0e10cSrcweir			inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
457cdf0e10cSrcweir			option. Example: 'com.sun.star.uno.XInterface' or
458cdf0e10cSrcweir			'com.sun.star.uno.*' are valid types.
459cdf0e10cSrcweir			</td>
460cdf0e10cSrcweir          </tr>
461cdf0e10cSrcweir		  <tr>
462cdf0e10cSrcweir            <td class="cell15"><code>-B&lt;name&gt;</code></td>
463cdf0e10cSrcweir			<td class="cell85">name specifies the base node. All types are
464cdf0e10cSrcweir			searched under this node. Default is the root '/' of the registry
465cdf0e10cSrcweir			files.</td>
466cdf0e10cSrcweir          </tr>
467cdf0e10cSrcweir		  <tr>
468cdf0e10cSrcweir            <td class="cell15"><code>-L</code></td>
469cdf0e10cSrcweir			<td class="cell85">UNO type functions are generated lightweight, that
470cdf0e10cSrcweir			means only the name and typeclass are given and everything else is
471cdf0e10cSrcweir			retrieved from the type library dynamically. The default is that UNO
472cdf0e10cSrcweir			type functions provides enough type information for boostrapping C++.
473cdf0e10cSrcweir			'-L' should be the default for external components.</td>
474cdf0e10cSrcweir          </tr>
475cdf0e10cSrcweir		  <tr>
476cdf0e10cSrcweir            <td class="cell15"><code>-C</code></td>
477cdf0e10cSrcweir			<td class="cell85">UNO type functions are generated comprehensive
478cdf0e10cSrcweir			that means all necessary information is available for bridging the
479cdf0e10cSrcweir			type in UNO.
480cdf0e10cSrcweir            </td>
481cdf0e10cSrcweir          </tr>
482cdf0e10cSrcweir		  <tr>
483cdf0e10cSrcweir            <td class="cell15"><code>-G</code></td>
484cdf0e10cSrcweir			<td class="cell85">generate only target files which do not
485cdf0e10cSrcweir			exist.</td>
486cdf0e10cSrcweir          </tr>
487cdf0e10cSrcweir          <tr>
488cdf0e10cSrcweir            <td class="cell15"><code>-Gc</code></td>
489cdf0e10cSrcweir			<td class="cell85">generate only target files whose content will
490cdf0e10cSrcweir			be changed.</td>
491cdf0e10cSrcweir		  </tr>
492cdf0e10cSrcweir		  <tr>
493cdf0e10cSrcweir            <td class="cell15"><code>-X&lt;name&gt;</code></td>
494cdf0e10cSrcweir			<td class="cell85">extra types, which are not be taken into account
495cdf0e10cSrcweir			for generation.</td>
496cdf0e10cSrcweir          </tr>
497cdf0e10cSrcweir		  </table>
498cdf0e10cSrcweir		  </p>
499cdf0e10cSrcweir		  </td>
500cdf0e10cSrcweir		</tr>
501cdf0e10cSrcweir      </table>
502cdf0e10cSrcweir    </td>
503cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
504cdf0e10cSrcweir  </tr>
505cdf0e10cSrcweir  <tr>
506cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
507cdf0e10cSrcweir  </tr>
508cdf0e10cSrcweir  <tr>
509cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
510cdf0e10cSrcweir    <td>
511cdf0e10cSrcweir      <table class="table2">
512cdf0e10cSrcweir        <tr>
513cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="javamaker"/>javamaker</td>
514cdf0e10cSrcweir		  <td align="right">
515cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
516cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
517cdf0e10cSrcweir		  </td>
518cdf0e10cSrcweir        </tr>
519cdf0e10cSrcweir		<tr>
520cdf0e10cSrcweir		  <td colspan="3">
521cdf0e10cSrcweir		  <p>The 'javamaker' generates the appropriate Java class file for each idl
522cdf0e10cSrcweir		  type. The javamaker works on a typelibrary which is generated by the
523cdf0e10cSrcweir		  UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description">
524cdf0e10cSrcweir		  idlc</a>). It generates the output for all specified types and for all
525cdf0e10cSrcweirtypes the specified types depend on.</p>
526cdf0e10cSrcweir		  <p class="head2">Usage:</p>
527cdf0e10cSrcweir		  <blockquote>
528cdf0e10cSrcweir		  <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b>
529cdf0e10cSrcweir		  </blockquote>
530cdf0e10cSrcweir		  <p class="head2">Options:</p>
531cdf0e10cSrcweir		  <p>
532cdf0e10cSrcweir		  <table class="table4">
533cdf0e10cSrcweir		  <tr>
534cdf0e10cSrcweir            <td class="cell15"><code>-O&lt;path&gt;</code></td>
535cdf0e10cSrcweir			<td class="cell85">path describes the root directory for the
536cdf0e10cSrcweir			generated output. The output directory tree is generated under this
537cdf0e10cSrcweir			directory.</td>
538cdf0e10cSrcweir          </tr>
539cdf0e10cSrcweir		  <tr>
540cdf0e10cSrcweir            <td class="cell15"><code>-T&lt;name&gt;|-T&lt;t1&gt;;&lt;t2&gt;...</code></td>
541cdf0e10cSrcweir			<td class="cell85">name specifies a type or a list of types. The
542cdf0e10cSrcweir			output for this type and all dependent types are generated. If no '-T'
543cdf0e10cSrcweir			option is specified, then output for all types is generated. It is also
544cdf0e10cSrcweir			possible to use a wildcard 'xy.*' to generate a complete module
545cdf0e10cSrcweir			inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
546cdf0e10cSrcweir			option. Example: 'com.sun.star.uno.XInterface'
547cdf0e10cSrcweir			or 'com.sun.star.uno.*' are valid types.
548cdf0e10cSrcweir            </td>
549cdf0e10cSrcweir          </tr>
550cdf0e10cSrcweir		  <tr>
551cdf0e10cSrcweir		    <td class="cell15"><code>-B&lt;name&gt;</code></td>
552cdf0e10cSrcweir			<td class="cell85">name specifies the base node. All types are
553cdf0e10cSrcweir			searched under this node. Default is the root '/' of the registry
554cdf0e10cSrcweir			files.</td>
555cdf0e10cSrcweir          </tr>
556cdf0e10cSrcweir          <tr>
557cdf0e10cSrcweir            <td class="cell15"><code>-nD</code></td>
558cdf0e10cSrcweir			<td class="cell85">no dependent types are generated.</td>
559cdf0e10cSrcweir          </tr>
560cdf0e10cSrcweir		  <tr>
561cdf0e10cSrcweir            <td class="cell15"><code>-G</code></td>
562cdf0e10cSrcweir			<td class="cell85">generate only target files which do not
563cdf0e10cSrcweir			exist.</td>
564cdf0e10cSrcweir          </tr>
565cdf0e10cSrcweir		  <tr>
566cdf0e10cSrcweir            <td class="cell15"><code>-Gc</code></td>
567cdf0e10cSrcweir			<td class="cell85">generate only target files whose content will
568cdf0e10cSrcweir			be changed.</td>
569cdf0e10cSrcweir          </tr>
570cdf0e10cSrcweir          <tr>
571cdf0e10cSrcweir            <td class="cell15"><code>-X&lt;name&gt;</code></td>
572cdf0e10cSrcweir			<td class="cell85">extra types, which will not be taken into account
573cdf0e10cSrcweir			for generation.</td>
574cdf0e10cSrcweir          </tr>
575cdf0e10cSrcweir		  </table>
576cdf0e10cSrcweir		  </p>
577cdf0e10cSrcweir		  </td>
578cdf0e10cSrcweir		</tr>
579cdf0e10cSrcweir      </table>
580cdf0e10cSrcweir    </td>
581cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
582cdf0e10cSrcweir  </tr>
583cdf0e10cSrcweir  <tr>
584cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
585cdf0e10cSrcweir  </tr>
586cdf0e10cSrcweir  <tr>
587cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
588cdf0e10cSrcweir    <td>
589cdf0e10cSrcweir      <table class="table2">
590cdf0e10cSrcweir        <tr>
591cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="climaker"/>climaker</td>
592cdf0e10cSrcweir		  <td align="right">
593cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
594cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
595cdf0e10cSrcweir		  </td>
596cdf0e10cSrcweir        </tr>
597cdf0e10cSrcweir		<tr>
598cdf0e10cSrcweir		  <td colspan="3">
599cdf0e10cSrcweir		  <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl
600cdf0e10cSrcweir		  type. The climaker works on a typelibrary which is generated by the
601cdf0e10cSrcweir		  UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description">
602cdf0e10cSrcweir		  idlc</a>). It generates the output for all specified types and for all
603cdf0e10cSrcweir		    types the specified types depend on.</p>
604cdf0e10cSrcweir		  <p class="head2">Usage:</p>
605cdf0e10cSrcweir		  <blockquote>
606cdf0e10cSrcweir		  <b><code>climaker &lt;switches&gt; [registry-file-1 registry-file-2 ...]</code></b>
607cdf0e10cSrcweir		  </blockquote>
608cdf0e10cSrcweir		  <p class="head2">Options:</p>
609cdf0e10cSrcweir		  <p>
610cdf0e10cSrcweir		  <table class="table4">
611cdf0e10cSrcweir		  <tr>
612cdf0e10cSrcweir		    <td class="cell15"><code>-O, --out &lt;output_file&gt;</code></td>
613cdf0e10cSrcweir		    <td class="cell85">output assembly file;<br>
614cdf0e10cSrcweir		      defaults to cli_unotypes.dll if more than one registry-file is given, else &lt;registry-file&gt;.dll</td>
615cdf0e10cSrcweir		  </tr>
616cdf0e10cSrcweir		  <tr>
617cdf0e10cSrcweir		    <td class="cell15"><code>-T, --types &lt;type1[;type2;...]&gt;</code></td>
618cdf0e10cSrcweir		    <td class="cell85">types to be generated (if none is given,
619cdf0e10cSrcweir		      then all types of given registries are emitted</td>
620cdf0e10cSrcweir		  </tr>
621cdf0e10cSrcweir		  <tr>
622cdf0e10cSrcweir		    <td class="cell15"><code>-X, --extra &lt;rdb-file&gt;></code></td>
623cdf0e10cSrcweir		    <td class="cell85">additional rdb to saturate referenced types in
624cdf0e10cSrcweir                      given registry file(s); these types will not be
625cdf0e10cSrcweir                      emitted into the output assembly file</td>
626cdf0e10cSrcweir		  </tr>
627cdf0e10cSrcweir		  <tr>
628cdf0e10cSrcweir		    <td class="cell15"><code>-r, --reference &lt;assembly-file&gt;</code></td>
629cdf0e10cSrcweir		    <td class="cell85">reference metadata from assembly file</td>
630cdf0e10cSrcweir		  </tr>
631cdf0e10cSrcweir		  <tr>
632cdf0e10cSrcweir		    <td class="cell15"><code>-k, --keyfile</code></td>
633cdf0e10cSrcweir		    <td class="cell85">keyfile needed for strong name</td>
634cdf0e10cSrcweir		  </tr>
635cdf0e10cSrcweir		  <tr>
636cdf0e10cSrcweir		    <td class="cell15"><code>--assembly-version &lt;version&gt;</code></td>
637cdf0e10cSrcweir		    <td class="cell85">sets assembly version</td>
638cdf0e10cSrcweir		  </tr>
639cdf0e10cSrcweir		  <tr>
640cdf0e10cSrcweir		    <td class="cell15"><code>--assembly-description &lt;text&gt;</code></td>
641cdf0e10cSrcweir		    <td class="cell85">sets assembly description text</td>
642cdf0e10cSrcweir		  </tr>
643cdf0e10cSrcweir		  <tr>
644cdf0e10cSrcweir		    <td class="cell15"><code>--assembly-product &lt;text&gt;</code></td>
645cdf0e10cSrcweir		    <td class="cell85">sets assembly product name</td>
646cdf0e10cSrcweir		  </tr>
647cdf0e10cSrcweir		  <tr>
648cdf0e10cSrcweir		    <td class="cell15"><code>--assembly-company &lt;text&gt;</code></td>
649cdf0e10cSrcweir		    <td class="cell85">sets assembly company</td>
650cdf0e10cSrcweir		  </tr>
651cdf0e10cSrcweir		  <tr>
652cdf0e10cSrcweir		    <td class="cell15"><code>--assembly-copyright &lt;text&gt;</code></td>
653cdf0e10cSrcweir		    <td class="cell85">sets assembly copyright</td>
654cdf0e10cSrcweir		  </tr>
655cdf0e10cSrcweir		  <tr>
656cdf0e10cSrcweir		    <td class="cell15"><code>--assembly-trademark &lt;text&gt;</code></td>
657cdf0e10cSrcweir		    <td class="cell85">sets assembly trademark</td>
658cdf0e10cSrcweir		  </tr>
659cdf0e10cSrcweir		  <tr>
660cdf0e10cSrcweir		    <td class="cell15"><code>-v, --verbose</code></td>
661cdf0e10cSrcweir		    <td class="cell85">verbose output to stdout</td>
662cdf0e10cSrcweir		  </tr>
663cdf0e10cSrcweir		  <tr>
664cdf0e10cSrcweir		    <td class="cell15"><code>-h, --help</code></td>
665cdf0e10cSrcweir		    <td class="cell85">this message</td>
666cdf0e10cSrcweir		  </tr>
667cdf0e10cSrcweir
668cdf0e10cSrcweir		  </table>
669cdf0e10cSrcweir		  </p>
670cdf0e10cSrcweir		  <p><b>Example:</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb</code></p>
671cdf0e10cSrcweir		  </td>
672cdf0e10cSrcweir		</tr>
673cdf0e10cSrcweir      </table>
674cdf0e10cSrcweir    </td>
675cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
676cdf0e10cSrcweir  </tr>
677cdf0e10cSrcweir  <tr>
678cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
679cdf0e10cSrcweir  </tr>
680cdf0e10cSrcweir  <tr>
681cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
682cdf0e10cSrcweir    <td>
683cdf0e10cSrcweir      <table class="table2">
684cdf0e10cSrcweir        <tr>
685cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="uno-skeletonmaker"/>uno-skeletonmaker</td>
686cdf0e10cSrcweir		  <td align="right">
687cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
688cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
689cdf0e10cSrcweir		  </td>
690cdf0e10cSrcweir        </tr>
691cdf0e10cSrcweir		<tr>
692cdf0e10cSrcweir		  <td colspan="3">
693cdf0e10cSrcweir		  <p>The 'uno-skeletonmaker' is a tool to simplify the UNO component development. It has different modes, from simply dumping code definitions for different languages on stdout up to generating complete code skeletons. The generation of code skeletons support common component skeletons as well as specialized skeletons for special service provider interfaces.</p>
694cdf0e10cSrcweir		  <p class="head2">Usage:</p>
695cdf0e10cSrcweir		  <blockquote>
696cdf0e10cSrcweir		  <b><code>
697cdf0e10cSrcweir			uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt; | -env:UNO_TYPES=&lt;url>) dump [&lt;options>] -t &lt;type&gt; ...<br>
698cdf0e10cSrcweir			uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt; | -env:UNO_TYPES=&lt;url&gt;) component [&lt;options&gt;] -n &lt;name&gt; -t &lt;type&gt; ...<br>
699cdf0e10cSrcweir			uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt; | -env:UNO_TYPES=&lt;url&gt;) calc-add-in [&lt;options&gt;] -n &lt;name&gt; -t &lt;add-in_service&gt;<br>
700cdf0e10cSrcweir			uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt; | -env:UNO_TYPES=&lt;url&gt;) add-on [&lt;options&gt;] -n &lt;name&gt; -p &lt;protocol_name:command,...&gt;
701cdf0e10cSrcweir			uno-skeletonmaker -V, --version<br>
702cdf0e10cSrcweir			uno-skeletonmaker -h, --help<br>
703cdf0e10cSrcweir		  </code></b>
704cdf0e10cSrcweir		  </blockquote>
705cdf0e10cSrcweir		  <p class="head2">Sub-commands:</p>
706cdf0e10cSrcweir		  <p>
707cdf0e10cSrcweir		  <table class="table4">
708cdf0e10cSrcweir		  <tr>
709cdf0e10cSrcweir		    <td class="cell15"><code>dump</code></td>
710cdf0e10cSrcweir		    <td class="cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.</td>
711cdf0e10cSrcweir		  </tr>
712cdf0e10cSrcweir		  <tr>
713cdf0e10cSrcweir                    <td class="cell15"><code>component</code></td>
714cdf0e10cSrcweir		    <td class="cell85">generates language specific code skeleton files using the implementation name as the file and class name</td>
715cdf0e10cSrcweir		  </tr>
716cdf0e10cSrcweir		  <tr>
717cdf0e10cSrcweir		    <td class="cell15"><code>calc-add-in</code></td>
718cdf0e10cSrcweir		    <td class="cell85">generates a language specific code skeleton for a Calc Add-Ins using the implementation name as the file and class name. A service type is necessary, referencing an interface which defines the new add-in functions.</td>
719cdf0e10cSrcweir		  </tr>
720cdf0e10cSrcweir		  <tr>
721cdf0e10cSrcweir		    <td class="cell15"><code>add-on</code></td>
722cdf0e10cSrcweir		    <td class="cell85">generates a language specific code skeleton for an add-on compnent using the implementation name as the file and class name. The protocol name(s) and the corresponding command(s) have to be specified with the '-p' option.</td>
723cdf0e10cSrcweir		  </tr>
724cdf0e10cSrcweir		  </table>
725cdf0e10cSrcweir		  </p>
726cdf0e10cSrcweir		  <p class="head2">Options:</p>
727cdf0e10cSrcweir		  <p>
728cdf0e10cSrcweir		  <table class="table4">
729cdf0e10cSrcweir		  <tr>
730cdf0e10cSrcweir            <td class="cell15"><code>-env:INIFILENAME=&lt;url&gt;</code></td>
731cdf0e10cSrcweir			<td class="cell85">url specifies a URL to an UNO ini|rc file of an existing UNO environment (URE, office installation).</td>
732cdf0e10cSrcweir          </tr>
733cdf0e10cSrcweir		  <tr>
734cdf0e10cSrcweir            <td class="cell15"><code>-env:UNO_TYPES=&lt;url&gt;</code></td>
735cdf0e10cSrcweir			<td class="cell85">url specifies a binary type library file. It can be a space separated list of urls.</td>
736cdf0e10cSrcweir          </tr>
737cdf0e10cSrcweir		  <tr>
738cdf0e10cSrcweir		    <td class="cell15"><code>-a, --all</code></td>
739cdf0e10cSrcweir			<td class="cell85">list all interface methods, not only the direct ones</td>
740cdf0e10cSrcweir          </tr>
741cdf0e10cSrcweir          <tr>
742cdf0e10cSrcweir            <td class="cell15"><code>--(java4|java5|cpp)</code></td>
743cdf0e10cSrcweir			<td class="cell85">select the target language<br>
744cdf0e10cSrcweir			--java4	generate output for Java 1.4 or earlier<br>
745cdf0e10cSrcweir			--java5 generate output for Java 1.5 or later (is currently the default)<br>
746cdf0e10cSrcweir			--cpp generate output for C++</td>
747cdf0e10cSrcweir          </tr>
748cdf0e10cSrcweir		  <tr>
749cdf0e10cSrcweir            <td class="cell15"><code>-sn, --shortnames</code></td>
750cdf0e10cSrcweir			<td class="cell85">using namespace abbreviation 'css:': for	'::com::sun::star::', only valid for sub-command 'dump' and target language 'cpp'. It is default for the sub-command 'component'.</td>
751cdf0e10cSrcweir          </tr>
752cdf0e10cSrcweir		  <tr>
753cdf0e10cSrcweir            <td class="cell15"><code>--propertysetmixin</code></td>
754cdf0e10cSrcweir			<td class="cell85">the generated skeleton implements the cppu::PropertySetMixin helper if a referenced new style service specifies an interface which provides attributes (directly or inherited).</td>
755cdf0e10cSrcweir          </tr>
756cdf0e10cSrcweir          <tr>
757cdf0e10cSrcweir            <td class="cell15"><code>-lh --licenseheader</code></td>
758cdf0e10cSrcweir			<td class="cell85">generates a default OpenOffice.org LGPL license header at the beginning of a component source file. This option is taken into account in 'component' mode only and if -o is unequal 'stdout'.</td>
759cdf0e10cSrcweir          </tr>
760cdf0e10cSrcweir          <tr>
761cdf0e10cSrcweir            <td class="cell15"><code>-bc<br>--backward-compatible</code></td>
762cdf0e10cSrcweir			<td class="cell85">specifies that the generated calc add-in is backward compatible to older office versions and implement the former required add-in interfaces where the implementation is mapped on the new add-in configuration. In this case the config schema needs to be bundled with the extension add-in as well. Default is a minimal add-in component skeleton based on the add-in configuration coming with the office since OO.org 2.0.4.</td>
763cdf0e10cSrcweir          </tr>
764cdf0e10cSrcweir          <tr>
765cdf0e10cSrcweir            <td class="cell15"><code>-o &lt;path&gt;</code></td>
766cdf0e10cSrcweir			<td class="cell85">path specifies an existing directory where the output files are generated to, only valid for sub-command 'component'. If path=stdout the generated code is generated on standard out instead of a file.</td>
767cdf0e10cSrcweir          </tr>
768cdf0e10cSrcweir          <tr>
769cdf0e10cSrcweir            <td class="cell15"><code>-l &lt;file&gt;</code></td>
770cdf0e10cSrcweir			<td class="cell85">specifies a binary type library (can be used more than once). The type library is integrated as an additional type provider in the bootstrapped type system.</td>
771cdf0e10cSrcweir          </tr>
772cdf0e10cSrcweir          <tr>
773cdf0e10cSrcweir            <td class="cell15"><code>-n &lt;name&gt;</code></td>
774cdf0e10cSrcweir			<td class="cell85">specifies an implementation name for the component (used as classname, filename and package|namespace name). In 'dump' mode it is used as classname (e.g. &quot;MyBase::&quot;, C++ only) to generate method bodies not inline.</td>
775cdf0e10cSrcweir          </tr>
776cdf0e10cSrcweir          <tr>
777cdf0e10cSrcweir            <td class="cell15"><code>-d &lt;name&gt;</code></td>
778cdf0e10cSrcweir			<td class="cell85">specifies a base classname or a delegator. In 'dump' mode it is used as a delegator to forward methods. It can be used as '&lt;name&gt;::' for base forwarding, or '&lt;name&gt;-&gt;|.' for composition. Using &quot;_&quot; means that a default bodies with default return values are dumped.</td>
779cdf0e10cSrcweir          </tr>
780cdf0e10cSrcweir          <tr>
781cdf0e10cSrcweir            <td class="cell15"><code>-t &lt;name&gt;</code></td>
782cdf0e10cSrcweir			<td class="cell85">specifies an UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).</td>
783cdf0e10cSrcweir          </tr>
784cdf0e10cSrcweir          <tr>
785cdf0e10cSrcweir            <td class="cell15"><code>-p &lt;protocol:cmd(s)&gt;</code></td>
786cdf0e10cSrcweir			<td class="cell85">specifies an add-on protocol name and the corresponding command names, where the commands are a ',' separated list of unique commands. This option is only valid for add-ons.</td>
787cdf0e10cSrcweir          </tr>
788cdf0e10cSrcweir          <tr>
789cdf0e10cSrcweir            <td class="cell15"><code>-V, --version</code></td>
790cdf0e10cSrcweir			<td class="cell85">print version number and exit.</td>
791cdf0e10cSrcweir          </tr>
792cdf0e10cSrcweir          <tr>
793cdf0e10cSrcweir            <td class="cell15"><code>-h, --help</code></td>
794cdf0e10cSrcweir			<td class="cell85">print this help and exit.</td>
795cdf0e10cSrcweir          </tr>
796cdf0e10cSrcweir		  </table>
797cdf0e10cSrcweir		  </p>
798cdf0e10cSrcweir		  </td>
799cdf0e10cSrcweir		</tr>
800cdf0e10cSrcweir      </table>
801cdf0e10cSrcweir    </td>
802cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
803cdf0e10cSrcweir  </tr>
804cdf0e10cSrcweir  <tr>
805cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
806cdf0e10cSrcweir  </tr>
807cdf0e10cSrcweir  <tr>
808cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
809cdf0e10cSrcweir    <td>
810cdf0e10cSrcweir      <table class="table2">
811cdf0e10cSrcweir        <tr>
812cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="regcomp"/>regcomp</td>
813cdf0e10cSrcweir		  <td align="right">
814cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
815cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
816cdf0e10cSrcweir		  </td>
817cdf0e10cSrcweir        </tr>
818cdf0e10cSrcweir		<tr>
819cdf0e10cSrcweir		  <td colspan="3">
820cdf0e10cSrcweir		  <p>'regcomp' is a tool to register|revoke external UNO components
821cdf0e10cSrcweir		  into|from a registry which is used in a UNO environment.</p>
822cdf0e10cSrcweir		  <p class="head2">Usage:</p>
823cdf0e10cSrcweir		  <blockquote>
824cdf0e10cSrcweir		  <b><code>regcomp -revoke [-br&lt;registryfile&gt;] -r &lt;registryfile&gt; -c &lt;locationUrl&gt;[-l&lt;componentLoaderName&gt;]</code></b>
825cdf0e10cSrcweir		  </blockquote>
826cdf0e10cSrcweir		  <p class="head2">Options:</p>
827cdf0e10cSrcweir		  <p>
828cdf0e10cSrcweir		  <table class="table4">
829cdf0e10cSrcweir		  <tr>
830cdf0e10cSrcweir			<td class="cell15"><code>-register|revoke</code></td>
831cdf0e10cSrcweir			<td class="cell85">register means that the components will be
832cdf0e10cSrcweir			installed and revoke means that they will be removed.</td>
833cdf0e10cSrcweir		  </tr>
834cdf0e10cSrcweir		  <tr>
835cdf0e10cSrcweir			<td class="cell15"><code>-br&lt;registryfile&gt;</code></td>
836cdf0e10cSrcweir			<td class="cell85">the name of the registry used for bootstrapping
837cdf0e10cSrcweir			the program. If the bootstrap registry is specified and has the same
838cdf0e10cSrcweir			name as the registration registry, '-r' is optional.</td>
839cdf0e10cSrcweir		  </tr>
840cdf0e10cSrcweir		  <tr>
841cdf0e10cSrcweir			<td class="cell15"><code>-r&lt;registryfile&gt;</code></td>
842cdf0e10cSrcweir			<td class="cell85">the name of the registry (will be created if
843cdf0e10cSrcweir			it does not exist) where the component should be registered.</td>
844cdf0e10cSrcweir		  </tr>
845cdf0e10cSrcweir		  <tr>
846cdf0e10cSrcweir			<td class="cell15"><code>-c&lt;locationUrls&gt;</code></td>
847cdf0e10cSrcweir			<td class="cell85">the location of a component (DLL, Class name,
848cdf0e10cSrcweir			or an url of a jar file) or a list of urls separated by ';'s. Note
849cdf0e10cSrcweir			that, if a list of urls is specified, the components must all need
850cdf0e10cSrcweir			the same loader.</td>
851cdf0e10cSrcweir		  </tr>
852cdf0e10cSrcweir		  <tr>
853cdf0e10cSrcweir			<td class="cell15"><code>-l&lt;componentLoaderName&gt;</code></td>
854cdf0e10cSrcweir			<td class="cell85">the name of the needed loader, if no loader is
855cdf0e10cSrcweir			specified the 'com.sun.star.loader.SharedLibrary' is used. Supported
856cdf0e10cSrcweir			loaders: 'com.sun.star.loader.SharedLibrary' |
857cdf0e10cSrcweir			'com.sun.star.loader.Java'.</td>
858cdf0e10cSrcweir		  </tr>
859cdf0e10cSrcweir		  </table>
860cdf0e10cSrcweir		  </p>
861cdf0e10cSrcweir		  </td>
862cdf0e10cSrcweir		</tr>
863cdf0e10cSrcweir      </table>
864cdf0e10cSrcweir    </td>
865cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
866cdf0e10cSrcweir  </tr>
867cdf0e10cSrcweir  <tr>
868cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
869cdf0e10cSrcweir  </tr>
870cdf0e10cSrcweir  <tr>
871cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
872cdf0e10cSrcweir    <td>
873cdf0e10cSrcweir      <table class="table2">
874cdf0e10cSrcweir        <tr>
875cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="regmerge"/>regmerge</td>
876cdf0e10cSrcweir		  <td align="right">
877cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
878cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
879cdf0e10cSrcweir		  </td>
880cdf0e10cSrcweir        </tr>
881cdf0e10cSrcweir		<tr>
882cdf0e10cSrcweir		  <td colspan="3">
883cdf0e10cSrcweir		  <p>'regmerge' is a small tool to merge different registry files under a
884cdf0e10cSrcweir		  specified key into another registry file. If a value already exists in
885cdf0e10cSrcweir		  the target file the value is overwritten by the value of the source
886cdf0e10cSrcweir		  file.</p>
887cdf0e10cSrcweir		  <p class="head2">Usage:</p>
888cdf0e10cSrcweir		  <blockquote>
889cdf0e10cSrcweir		  <b><code>regmerge [-v|--verbose] &lt;mergefile&gt; &lt;mergeKeyName&gt; &lt;regfile_1&gt; ... &lt;regfile_n&gt;</code></b>
890cdf0e10cSrcweir		  </blockquote>
891cdf0e10cSrcweir		  <p class="head2">Options:</p>
892cdf0e10cSrcweir		  <p>
893cdf0e10cSrcweir		  <table class="table4">
894cdf0e10cSrcweir		  <tr>
895cdf0e10cSrcweir            <td class="cell15"><code>-v|--verbose</code></td>
896cdf0e10cSrcweir			<td class="cell85">verbose output on stdout.</td>
897cdf0e10cSrcweir          </tr>
898cdf0e10cSrcweir		  <tr>
899cdf0e10cSrcweir            <td class="cell15"><code>&lt;mergefile&gt;</code></td>
900cdf0e10cSrcweir			<td class="cell85">specifies the merged registry file. If this file
901cdf0e10cSrcweir			doesn't exist, it is created.</td>
902cdf0e10cSrcweir		  </tr>
903cdf0e10cSrcweir		  <tr>
904cdf0e10cSrcweir            <td class="cell15"><code>&lt;mergeKeyName&gt;</code></td>
905cdf0e10cSrcweir			<td class="cell85">specifies the merge key, everything is merged
906cdf0e10cSrcweir			under this key. If this key doesn't exist, it is created.</td>
907cdf0e10cSrcweir          </tr>
908cdf0e10cSrcweir		  <tr>
909cdf0e10cSrcweir            <td class="cell15"><code>&lt;regfile_1&gt; ... &lt;regfile_n&gt;</code></td>
910cdf0e10cSrcweir			<td class="cell85">specifies one or more registry files that are
911cdf0e10cSrcweir			merged.</td>
912cdf0e10cSrcweir		  </tr>
913cdf0e10cSrcweir		  </table>
914cdf0e10cSrcweir		  </p>
915cdf0e10cSrcweir		  </td>
916cdf0e10cSrcweir		</tr>
917cdf0e10cSrcweir      </table>
918cdf0e10cSrcweir    </td>
919cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
920cdf0e10cSrcweir  </tr>
921cdf0e10cSrcweir  <tr>
922cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
923cdf0e10cSrcweir  </tr>
924cdf0e10cSrcweir  <tr>
925cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
926cdf0e10cSrcweir    <td>
927cdf0e10cSrcweir      <table class="table2">
928cdf0e10cSrcweir        <tr>
929cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="regview"/>regview</td>
930cdf0e10cSrcweir		  <td align="right">
931cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
932cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
933cdf0e10cSrcweir		  </td>
934cdf0e10cSrcweir        </tr>
935cdf0e10cSrcweir		<tr>
936cdf0e10cSrcweir		  <td colspan="3">
937cdf0e10cSrcweir		  <p>'regview' is a tool to show the contents of a registry file. The tool
938cdf0e10cSrcweir		  dumps the hierarchical structure and the values of the nodes in a human
939cdf0e10cSrcweir		  readable manner to stdout.</p>
940cdf0e10cSrcweir		  <p class="head2">Usage:</p>
941cdf0e10cSrcweir		  <blockquote>
942cdf0e10cSrcweir		  <b><code>regview &lt;registryfile&gt; [&lt;keyName&gt;]</code></b>
943cdf0e10cSrcweir		  </blockquote>
944cdf0e10cSrcweir		  <p class="head2">Options:</p>
945cdf0e10cSrcweir		  <p>
946cdf0e10cSrcweir		  <table class="table4">
947cdf0e10cSrcweir		  <tr>
948cdf0e10cSrcweir            <td class="cell15">-br&lt;registryfile&gt;</code></td>
949cdf0e10cSrcweir			<td class="cell85">the name of the registry whose contents should
950cdf0e10cSrcweir			be viewed.</td>
951cdf0e10cSrcweir          </tr>
952cdf0e10cSrcweir		  <tr>
953cdf0e10cSrcweir            <td class="cell15"><code>&lt;keyName&gt;</code></td>
954cdf0e10cSrcweir			<td class="cell85">the name of a registry key. The name must be
955cdf0e10cSrcweir			fully qualified; for example, '/' means the root key and
956cdf0e10cSrcweir			'/UCR/com/sun/star/uno/XInterface' shows the type specification of the
957cdf0e10cSrcweir			XInterface type. If no key is specified, the tool dumps the whole
958cdf0e10cSrcweir			content of the registry file.</td>
959cdf0e10cSrcweir		  </tr>
960cdf0e10cSrcweir		  </table>
961cdf0e10cSrcweir		  </p>
962cdf0e10cSrcweir		  </td>
963cdf0e10cSrcweir		</tr>
964cdf0e10cSrcweir      </table>
965cdf0e10cSrcweir    </td>
966cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
967cdf0e10cSrcweir  </tr>
968cdf0e10cSrcweir  <tr>
969cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
970cdf0e10cSrcweir  </tr>
971cdf0e10cSrcweir  <tr>
972cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
973cdf0e10cSrcweir    <td>
974cdf0e10cSrcweir      <table class="table2">
975cdf0e10cSrcweir        <tr>
976cdf0e10cSrcweir		  <td colspan="2" class="head1"><a name="autodoc"/>autodoc</td>
977cdf0e10cSrcweir		  <td align="right">
978cdf0e10cSrcweir		    <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
979cdf0e10cSrcweir		    <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
980cdf0e10cSrcweir		  </td>
981cdf0e10cSrcweir        </tr>
982cdf0e10cSrcweir		<tr>
983cdf0e10cSrcweir		  <td colspan="3">
984cdf0e10cSrcweir		  <p>The 'autodoc' tool is used for creating javadoc-like documentation
985cdf0e10cSrcweir		  from C++ and UNOIDL source code.</p>
986cdf0e10cSrcweir		  <p>There are some conventions to follow when documenting C++- or
987cdf0e10cSrcweir		  UNOIDL-sourcecode. See also the <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixB/IDL_Documentation_Guidelines" title="link to the UNOIDL Documentation Guidelines">UNOIDL Documentation Guidelines</a>.<br>
988cdf0e10cSrcweir          If you are not familiar with these, but do know javadoc: For simple C++
989cdf0e10cSrcweir		  sourcecode documentation, using javadoc-style comments will work.</p>
990cdf0e10cSrcweir		  <p class="head2">Usage:</p>
991cdf0e10cSrcweir		  <blockquote>
992cdf0e10cSrcweir		  <b><code>autodoc [ -v &lt;VerboseNr&gt; ] [ -name "&lt;TitleForTheDocu&gt;" ] -html &lt;OutputDirectory&gt; -lg &lt;SourcecodeLanguage&gt;<br>
993cdf0e10cSrcweir          { [ -p &lt;ProjectName&gt; &lt;ProjectRootDirectory&gt; ] &nbsp;-t &lt;SourceTree&gt;* | -d &lt;SourceDirectory&gt;* | -f &lt;SourceFile&gt;* }*</code></b>
994cdf0e10cSrcweir		  </blockquote>
995cdf0e10cSrcweir		  <p class="head2">Options:</p>
996cdf0e10cSrcweir		  <p>
997cdf0e10cSrcweir		  <table width="100%" border="1" cellpadding="4" cellspacing="0">
998cdf0e10cSrcweir		  <tr>
999cdf0e10cSrcweir            <td class="cell15"><code>-v &lt;VerboseNr&gt;</code></td>
1000cdf0e10cSrcweir            <td class="cell85">&lt;VerboseNr&gt; == 5 displays the parsed source
1001cdf0e10cSrcweir		    code tokens, so you can locate which piece caused an parsing error.<br>
1002cdf0e10cSrcweir            &lt;VerboseNr&gt; == 2 displays not only the parsed source code,
1003cdf0e10cSrcweir		    but also the comments.<br><br>
1004cdf0e10cSrcweir		    This option must be the first one, if it is used.</td>
1005cdf0e10cSrcweir          </tr>
1006cdf0e10cSrcweir          <tr>
1007cdf0e10cSrcweir            <td class="cell15"><code>-name "&lt;Title&gt;"</code></td>
1008cdf0e10cSrcweir		    <td class="cell85">&lt;Title&gt; occurs as the title of the start
1009cdf0e10cSrcweir		    page of the HTML output. If this option is omitted, a default title is
1010cdf0e10cSrcweir		    created.</td>
1011cdf0e10cSrcweir          </tr>
1012cdf0e10cSrcweir          <tr>
1013cdf0e10cSrcweir            <td class="cell15"><code>-html &lt;OutputDirectory&gt;</code></td>
1014cdf0e10cSrcweir            <td class="cell85">specifies the root directory where the HTML output
1015cdf0e10cSrcweir		    is created.<br>
1016cdf0e10cSrcweir            Autodoc does not remove old files there, though it overwrites them.</td>
1017cdf0e10cSrcweir          </tr>
1018cdf0e10cSrcweir          <tr>
1019cdf0e10cSrcweir            <td class="cell15"><code>-lg &lt;SourcecodeLanguage&gt;</code></td>
1020cdf0e10cSrcweir		    <td class="cell85">Possible values are: c++ | idl.<br><br>
1021cdf0e10cSrcweir            This also specifies which files will be parsed: &quot;c++&quot; parses
1022cdf0e10cSrcweir			all files with the endings .hxx and .h, &quot;idl&quot; parses all
1023cdf0e10cSrcweir			files with the ending '.idl' .<br>
1024cdf0e10cSrcweir            To change this behaviour, see at option <code>-f</code>.</td>
1025cdf0e10cSrcweir          </tr>
1026cdf0e10cSrcweir		  <tr>
1027cdf0e10cSrcweir            <td class="cell15"><code>-p &lt;ProjectName&gt; &lt;ProjectDirectory&gt;</code></td>
1028cdf0e10cSrcweir		    <td class="cell85">this option can be used to divide large code
1029cdf0e10cSrcweir		    bases into different projects.<br>
1030cdf0e10cSrcweir            &lt;ProjectName&gt; gives a user-defined name for the project.<br>
1031cdf0e10cSrcweir            &lt;ProjectDirectory&gt; is the root to which all paths, given with the
1032cdf0e10cSrcweir		    following options <code>-t,-d</code> and <code>-f</code>, are
1033cdf0e10cSrcweir			relative.<br>
1034cdf0e10cSrcweir		    This option can be omitted when there are no projects and all paths in
1035cdf0e10cSrcweir		    the following options are relative to the working directory.<br><br>
1036cdf0e10cSrcweir		    The &quot;{ ... }*&quot; around the options <code>-p,-t,-d,-f</code>
1037cdf0e10cSrcweir			indicates, that this whole block of options can be repeated, each block
1038cdf0e10cSrcweir			starting with a new <code>-p</code>.</td>
1039cdf0e10cSrcweir          </tr>
1040cdf0e10cSrcweir          <tr>
1041cdf0e10cSrcweir            <td class="cell15"><code>-t &lt;SourceTree&gt;</code></td>
1042cdf0e10cSrcweir		    <td class="cell85">specifies that all files in the directory
1043cdf0e10cSrcweir		    &lt;SourceTree&gt; and it's subdirectories are parsed, where the file
1044cdf0e10cSrcweir		    ending matches the option <code>-lg</code>.<br>
1045cdf0e10cSrcweir            There can be given multiple directories after one <code>-t</code>
1046cdf0e10cSrcweir			option.<br>
1047cdf0e10cSrcweir            All relative paths &nbsp;are relative to the project-rootdirectory,
1048cdf0e10cSrcweir		    given with the <code>-p</code> option.<br>
1049cdf0e10cSrcweir            </td>
1050cdf0e10cSrcweir          </tr>
1051cdf0e10cSrcweir          <tr>
1052cdf0e10cSrcweir		    <td class="cell15"><code>-d &lt;SourceDirectory&gt;</code></td>
1053cdf0e10cSrcweir            <td class="cell85">Specifies that all files in th directory
1054cdf0e10cSrcweir		    &lt;SourceDirectory&gt;, but NOT it's subdirectories, are parsed, where
1055cdf0e10cSrcweir		    the file ending matches the option <code>-lg</code>.<br>
1056cdf0e10cSrcweir            There can be multiple directories given after one <code>-d</code>
1057cdf0e10cSrcweir			option.<br>
1058cdf0e10cSrcweir            All relative paths &nbsp;are relative to the project-rootdirectory,
1059cdf0e10cSrcweir			given with the <code>-p</code> option.</td>
1060cdf0e10cSrcweir          </tr>
1061cdf0e10cSrcweir          <tr>
1062cdf0e10cSrcweir            <td class="cell15"><code>-f &lt;SourceFile&gt;</code></td>
1063cdf0e10cSrcweir            <td class="cell85">parses the given file. The ending does not have
1064cdf0e10cSrcweir		    to match the <code>-lg</code> option.<br>
1065cdf0e10cSrcweir            There can be multiple files given after one <code>-f</code> option.<br>
1066cdf0e10cSrcweir            All relative paths &nbsp;are relative to the project-rootdirectory,
1067cdf0e10cSrcweir		    given with the <code>-p</code> option.</td>
1068cdf0e10cSrcweir          </tr>
1069cdf0e10cSrcweir		  </table>
1070cdf0e10cSrcweir		  </p><b>Remark:</b> The sequence of options matters! Use them in the order given
1071cdf0e10cSrcweir		  in the &quot;Usage&quot;-paragraph.</p>
1072cdf0e10cSrcweir		  </td>
1073cdf0e10cSrcweir		</tr>
1074cdf0e10cSrcweir      </table>
1075cdf0e10cSrcweir    </td>
1076cdf0e10cSrcweir    <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
1077cdf0e10cSrcweir  </tr>
1078cdf0e10cSrcweir  <tr>
1079cdf0e10cSrcweir    <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
1080cdf0e10cSrcweir  </tr>
1081cdf0e10cSrcweir  <tr>
1082cdf0e10cSrcweir    <td colspan="3">
1083cdf0e10cSrcweir      <div class="centertext">
1084cdf0e10cSrcweir	<p><img class="oraclelogo" src="images/odk-footer-logo.gif" title="Sponsored by Oracle" alt="Oracle Logo" />
1085*ef1ef8e6SJürgen Schmidt            Copyright &copy; 2011 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOfifce.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.<p>
1086cdf0e10cSrcweir      </div>
1087cdf0e10cSrcweir    </td>
1088cdf0e10cSrcweir  </tr>
1089cdf0e10cSrcweir</table>
1090cdf0e10cSrcweir<map name="Map">
1091*ef1ef8e6SJürgen Schmidt  <area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org">
1092cdf0e10cSrcweir</map>
1093cdf0e10cSrcweir</body>
1094cdf0e10cSrcweir</html>
1095