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