3 <title>[TITLE] SDK - Development Tools
</title>
4 <link rel=
"stylesheet" type=
"text/css" href=
"sdk_styles.css">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
6 <meta name=
"author" content=
"Jürgen Schmidt">
7 <meta name=
"created" content=
"2004-12-14">
10 <body class=
"sdkbody"><a name=
"tools"/>
11 <table class=
"table1" cellpadding=
0>
12 <tr style=
"background-image:url(images/sdk_head-2.gif); backgorund-position: bottom; ">
13 <td colspan=
"2" align=
"left"><img src=
"images/sdk_head-1.gif" width=
"335" height=
"109" usemap=
"#Map" border=
"0"></td>
14 <td align=right
><img src=
"images/sdk_head-3.gif" width=
"32" height=
"109"></td>
17 <td colspan=
"3"><img class=
"nothing10" src=
"images/nada.gif"></td>
20 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
22 <table class=
"table2">
24 <td colspan=
"3"><img class=
"nothing1" src=
"images/nada.gif"></td>
28 <table class=
"table3">
30 <td colspan=
"2" class=
"head1">Development Tools
</td>
31 <td align=
"right"><a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a></td>
38 <table class=
"table3">
40 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
41 <td><a href=
"#unopkg" title=
"link to the unopkg tool description">unopkg
</a></td>
42 <td class=
"content87">The new UNO package deployment tool. It comes
43 with the office installation and can be found in the program
44 directory of the office installation.
</td>
47 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
48 <td><a href=
"#unoexe" title=
"link to the uno tool description">uno
</a></td>
49 <td class=
"content87">Tool to provide a UNO runtime environment and
50 provide configured (deployed) or single components. This tool
51 comes with the office installation and can be found in the program
52 directory of the office installation.
</td>
55 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
56 <td><a href=
"#regmerge" title=
"link to the regmerge tool description">regmerge
</a></td>
57 <td class=
"content87">Tool to merge several registry (e.g. type
58 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>
61 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
62 <td><a href=
"#regview" title=
"link to the regview tool description">regview
</a></td>
63 <td class=
"content87">Tool to view the content of a registry file
64 in a human readable manner. Special support for type library
65 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>
68 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
71 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
72 <td><a href=
"#idlc" title=
"link to the idlc tool description">idlc
</a></td>
73 <td class=
"content87">The UNOIDL compiler, generates a common
74 binary type library format as base for all codemaker tools and
75 the UNO runtime type library.
</td>
78 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
79 <td><a href=
"#cppumaker" title=
"link to the cppumaker tool description">cppumaker
</a></td>
80 <td class=
"content87">Tool for generating C++ code for the UNOIDL
81 types stored in a type library.
</td>
84 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
85 <td><a href=
"#javamaker" title=
"link to the javamaker tool description">javamaker
</a></td>
86 <td class=
"content87">Tool for generating Java class files for the
87 UNOIDL types stored in a type library.
</td>
90 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
91 <td><a href=
"#uno-skeletonmaker" title=
"link to the uno-skeletonmaker tool description">uno-skeletonmaker
</a></td>
92 <td class=
"content87">Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.
</td>
95 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
96 <td><a href=
"#regcomp" title=
"link to the regcomp tool description">regcomp
</a></td>
97 <td class=
"content87">A simple UNO component registration tool.
</td>
100 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
101 <td><a href=
"#regmerge" title=
"link to the regmerge tool description">regmerge
</a></td>
102 <td class=
"content87">Tool to merge several registry (e.g. type
103 libraries) files into one file.
</td>
106 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
107 <td><a href=
"#regview" title=
"link to the regview tool description">regview
</a></td>
108 <td class=
"content87">Tool to view the content of a registry file
109 in a human readable manner. Special support for type library
113 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
114 <td><a href=
"#autodoc" title=
"link to the autodoc tool description">autodoc
</a></td>
115 <td class=
"content87">Tool to generate javadoc-like documentation
116 for C/C++ and UNOIDL files.
</td>
123 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
126 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
129 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
131 <table class=
"table2">
133 <td colspan=
"2" class=
"head1"><a name=
"unopkg"/>unopkg
</td>
135 <a style=
"a:link:visited #FFFFFF;" href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
136 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a></td>
140 <p>'unopkg' is a tool for easy deployment of UNO packages in an existing
141 office installation. UNO packages are UNO components (single libraries or
142 Jar files or more complex zip files that contains one or more libraries|
143 Jar files, type libraries and configuration items), scripts and
144 [PRODUCTNAME] Basic libraries as zip package. 'unopkg' is not part of the
145 SDK but comes with the office directly and is a development tool as well
146 as an end user tool to deploy extension into an office installation.
</p>
147 <p>More details concerning deployment and this tool can be find in the
148 Developer's Guide:
<a href=
"http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title=
"link to the "Extension Manager - unopkg" chapter in the Developer's Guide">Extension Manager -
<i>unopkg
</i></a>.
</p>
149 <p><b>Note:
</b> This tool works only in the
<i><office
>/program
</i>
151 <p class=
"head2">Usage:
</p>
154 unopkg add
<options
> package-path...
<br>
155 unopkg remove
<options
> package-name...
<br>
156 unopkg list
<options
> package-name...
<br>
157 unopkg reinstall
<options
><br>
163 <p class=
"head2">Sub-commands:
</p>
165 <table class=
"table4">
167 <td class=
"cell15"><code>add
</code></td>
168 <td class=
"cell85">add packages
</td>
171 <td class=
"cell15"><code>remove
</code></td>
172 <td class=
"cell85">remove packages by name
</td>
175 <td class=
"cell15"><code>reinstall
</code></td>
176 <td class=
"cell85">export feature: reinstall all deployed
180 <td class=
"cell15"><code>list
</code></td>
181 <td class=
"cell85">list information about deployed packages
</td>
184 <td class=
"cell15"><code>gui
</code></td>
185 <td class=
"cell15">raise Package Manager Graphical User Interface
190 <p class=
"head2">Options:
</p>
192 <table class=
"table4">
194 <td class=
"cell15"><code>-h, --help
</code></td>
195 <td class=
"cell85">show this help on the command line
</td>
198 <td class=
"cell15"><code>-V, --version
</code></td>
199 <td class=
"cell85">shows version information
203 <td class=
"cell15"><code>-v, --verbose
</code></td>
204 <td class=
"cell85">dump verbose output to stdout
</td>
207 <td class=
"cell15"><code>-f, --force
</code></td>
208 <td class=
"cell85">force overwriting existing packages
</td>
211 <td class=
"cell15"><code>--log-file
<file
></code></td>
212 <td class=
"cell85">custom log file; default:
213 <i><cache-dir>/log.txt
</i>.
</td>
216 <td class=
"cell15"><code>--shared
</code></td>
217 <td class=
"cell85">expert feature: operate on shared installation
218 deployment context; run only when no concurrent Office process(es) are
222 <td class=
"cell15"><code>--deployment-context
<context>
</code>
224 <td class=
"cell85">expert feature: explicit deployment context
</td>
232 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
235 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
238 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
240 <table class=
"table2">
242 <td colspan=
"2" class=
"head1"><a name=
"unoexe"/>uno
</td>
244 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
245 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
250 <p>The UNO-starter is for running a component or service process, and
251 providing a runtime environment. Raising a component might look like
253 <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb
254 -- foo bar
</code></p>
256 <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb
257 -- foo bar
</code></p>
258 <p>The starter loads the component and instantiates it. The component
259 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>
261 <code>interface XMain : com::sun::star::uno::XInterface
<br>
263 /** This method is called to run the component.
<br>
264 <br>
265 @param aArguments command line arguments
<br>
266 @return process error code to be returned to system
<br>
267 */
<br>
268 long run( [in] sequence
< string
> arguments );
<br>
272 <p>Method run() will be called and returns the error code given, back
273 to the system. If the uno starter is executed with the -u (URL) option,
274 then XInitialization is used instead of XMain. The -u option is described
276 <p class=
"head2">Usage:
</p>
278 <b><code>uno (-c
<ComponentImplementationName
> -l
<LocationUrl
>
279 | -s
<ServiceName
>)
<br>
280 [-ro
<ReadOnlyRegistry1
>] [-ro
<ReadOnlyRegistry2
>] ... [-rw
<ReadWriteRegistry
>]
<br>
281 [-u uno:(socket[,host=
<HostName
>][,port=
<nnn
>]|pipe[,name=
<PipeName
>]);iiop|urp;
<Name
><br>
282 [--singleaccept] [--singleinstance]]
<br>
283 [--
<Argument1 Argument2 ...
>]
286 <p class=
"head2">Options:
</p>
288 <table class=
"table4">
290 <td class=
"cell15"><code><HostName
></code></td>
291 <td class=
"cell85">Specifying a host name might be necessary to
292 distinguish the network interface to be used,if a machine is part of
296 <td class=
"cell15"><code><PipeName
></code></td>
297 <td class=
"cell85">Name of a named pipe.
</td>
300 <td class=
"cell15"><code><Name
></code></td>
301 <td class=
"cell85">Identifier for demanded called component
305 <td class=
"cell15"><code><Registries
></code></td>
306 <td class=
"cell85">The optional
<code><Registries
></code>
307 (e.g., c:\myreg.rdb) are used by the ServiceManager. The
<i>ro
</i>
308 ones are opened for reading only; whereas, a single
<i>rw
</i> one
309 will be opened for reading and writing. If the
<i>rw
</i> one does
310 not exist, then it may be created. Components may read and write to
311 store their persistent state.
</td>
314 <td class=
"cell15"><code>--singleaccept
</code></td>
315 <td class=
"cell85">The uno starter will accept one connection,
316 provide the component instance and die.
</td>
319 <td class=
"cell15"><code>--singleinstance
</code></td>
320 <td class=
"cell85">The uno starter will accept any number of
321 connections, but will provide the same single component instance any
322 time instead of creating a new instance for each connection.
</td>
325 <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>
326 <p>You can easily connect to a server started with the
327 <code>-u (url)
</code> option by using this service, giving the same url
328 to resolve. The service provides you an instance from remote.
</p>
334 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
337 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
340 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
342 <table class=
"table2">
344 <td colspan=
"2" class=
"head1"><a name=
"idlc"/>idlc
</td>
346 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
347 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
352 <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used
353 to check UNODL type definitions and transform valid type definitions
354 into a binary type library format, which is later used by all codemaker
355 tools. It is also used as a dynamic type library for UNO at runtime.
<br>
356 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 "UNOIDL Syntax Specification" chapter in the Developer's Guide">here
</a>.
</p>
357 <p class=
"head2">Usage:
</p>
359 <b><code>idlc [-options] file_1 ... file_n | @
<filename
></code></b>
362 <table class=
"table4">
364 <td class=
"cell15"><code>file_1 ... file_n
</code></td>
365 <td class=
"cell85">specifies one or more idl files. Only files with
366 the extension '.idl' are valid.
</td>
369 <td class=
"cell15"><code>@
<filename
></code></td>
370 <td class=
"cell85">filename specifies the name of a command
375 <p class=
"head2">Options:
</p>
377 <table class=
"table4">
379 <td class=
"cell15"><code>-O
<path
></code></td>
380 <td class=
"cell85">path describes the output directory. The
381 generated output is a registry file with the same name as the idl
385 <td class=
"cell15"><code>-I
<path
></code></td>
386 <td class=
"cell85">path specifies a directory where included files
387 that will be searched by the preprocessor are located. Multiple
388 directories can be combined with ';'.
</td>
391 <td class=
"cell15"><code>-D
<name
></code></td>
392 <td class=
"cell85">name defines a macro for the preprocessor.
</td>
395 <td class=
"cell15"><code>-C
</code></td>
396 <td class=
"cell85">generates complete type information, including
397 additional service information and documentation.
</td>
400 <td class=
"cell15"><code>-h|?
</code></td>
401 <td class=
"cell85">print this help message and exit.
</td>
409 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
412 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
415 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
417 <table class=
"table2">
419 <td colspan=
"2" class=
"head1"><a name=
"cppumaker"/>cppumaker
</td>
421 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
422 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
427 <p>The 'cppumaker' generates a C++ representation for idl types. The
428 cppumaker works on a typelibrary, which is generated by the UNOIDL
429 compiler (
<a href=
"#idlc" link=
"link to the idlc tool description">
430 idlc
</a>). It generates the output for all specified types and for all
431 types the specified types depend on.
</p>
432 <p class=
"head2">Usage:
</p>
434 <b><code>cppumaker [-options] file_1 ... file_n
</code></b>
436 <p class=
"head2">Options:
</p>
438 <table class=
"table4">
440 <td class=
"cell15"><code>-O
<path
></code></td>
441 <td class=
"cell85">path describes the root directory for the
442 generated output. The output directory tree is generated under this
446 <td class=
"cell15"><code>-T
<name
><br>
447 |-T
<t1
>;
<t2
>...
</code></td>
448 <td class=
"cell85">name specifies a type or a list of types. The
449 output for this type and all dependent types are generated. If no '-T'
450 option is specified, then output for all types is generated. It is also
451 possible to use a wildcard 'xy.*' to generate a complete module
452 inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
453 option. Example: 'com.sun.star.uno.XInterface' or
454 'com.sun.star.uno.*' are valid types.
458 <td class=
"cell15"><code>-B
<name
></code></td>
459 <td class=
"cell85">name specifies the base node. All types are
460 searched under this node. Default is the root '/' of the registry
464 <td class=
"cell15"><code>-L
</code></td>
465 <td class=
"cell85">UNO type functions are generated lightweight, that
466 means only the name and typeclass are given and everything else is
467 retrieved from the type library dynamically. The default is that UNO
468 type functions provides enough type information for boostrapping C++.
469 '-L' should be the default for external components.
</td>
472 <td class=
"cell15"><code>-C
</code></td>
473 <td class=
"cell85">UNO type functions are generated comprehensive
474 that means all necessary information is available for bridging the
479 <td class=
"cell15"><code>-G
</code></td>
480 <td class=
"cell85">generate only target files which do not
484 <td class=
"cell15"><code>-Gc
</code></td>
485 <td class=
"cell85">generate only target files whose content will
489 <td class=
"cell15"><code>-X
<name
></code></td>
490 <td class=
"cell85">extra types, which are not be taken into account
499 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
502 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
505 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
507 <table class=
"table2">
509 <td colspan=
"2" class=
"head1"><a name=
"javamaker"/>javamaker
</td>
511 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
512 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
517 <p>The 'javamaker' generates the appropriate Java class file for each idl
518 type. The javamaker works on a typelibrary which is generated by the
519 UNOIDL compiler (
<a href=
"#idlc" link=
"link to the idlc tool description">
520 idlc
</a>). It generates the output for all specified types and for all
521 types the specified types depend on.
</p>
522 <p class=
"head2">Usage:
</p>
524 <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+
1 -Xfile_n+
2</code></b>
526 <p class=
"head2">Options:
</p>
528 <table class=
"table4">
530 <td class=
"cell15"><code>-O
<path
></code></td>
531 <td class=
"cell85">path describes the root directory for the
532 generated output. The output directory tree is generated under this
536 <td class=
"cell15"><code>-T
<name
>|-T
<t1
>;
<t2
>...
</code></td>
537 <td class=
"cell85">name specifies a type or a list of types. The
538 output for this type and all dependent types are generated. If no '-T'
539 option is specified, then output for all types is generated. It is also
540 possible to use a wildcard 'xy.*' to generate a complete module
541 inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
542 option. Example: 'com.sun.star.uno.XInterface'
543 or 'com.sun.star.uno.*' are valid types.
547 <td class=
"cell15"><code>-B
<name
></code></td>
548 <td class=
"cell85">name specifies the base node. All types are
549 searched under this node. Default is the root '/' of the registry
553 <td class=
"cell15"><code>-nD
</code></td>
554 <td class=
"cell85">no dependent types are generated.
</td>
557 <td class=
"cell15"><code>-G
</code></td>
558 <td class=
"cell85">generate only target files which do not
562 <td class=
"cell15"><code>-Gc
</code></td>
563 <td class=
"cell85">generate only target files whose content will
567 <td class=
"cell15"><code>-X
<name
></code></td>
568 <td class=
"cell85">extra types, which will not be taken into account
577 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
580 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
583 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
585 <table class=
"table2">
587 <td colspan=
"2" class=
"head1"><a name=
"uno-skeletonmaker"/>uno-skeletonmaker
</td>
589 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
590 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
595 <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>
596 <p class=
"head2">Usage:
</p>
599 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) dump [
<options
>] -t
<type
> ...
<br>
600 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) component [
<options
>] -n
<name
> -t
<type
> ...
<br>
601 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) calc-add-in [
<options
>] -n
<name
> -t
<add-in_service
><br>
602 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) add-on [
<options
>] -n
<name
> -p
<protocol_name:command,...
>
603 uno-skeletonmaker -V, --version
<br>
604 uno-skeletonmaker -h, --help
<br>
607 <p class=
"head2">Sub-commands:
</p>
609 <table class=
"table4">
611 <td class=
"cell15"><code>dump
</code></td>
612 <td class=
"cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.
</td>
615 <td class=
"cell15"><code>component
</code></td>
616 <td class=
"cell85">generates language specific code skeleton files using the implementation name as the file and class name
</td>
619 <td class=
"cell15"><code>calc-add-in
</code></td>
620 <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>
623 <td class=
"cell15"><code>add-on
</code></td>
624 <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>
628 <p class=
"head2">Options:
</p>
630 <table class=
"table4">
632 <td class=
"cell15"><code>-env:INIFILENAME=
<url
></code></td>
633 <td class=
"cell85">url specifies a URL to an UNO ini|rc file of an existing UNO environment (URE, office installation).
</td>
636 <td class=
"cell15"><code>-env:UNO_TYPES=
<url
></code></td>
637 <td class=
"cell85">url specifies a binary type library file. It can be a space separated list of urls.
</td>
640 <td class=
"cell15"><code>-a, --all
</code></td>
641 <td class=
"cell85">list all interface methods, not only the direct ones
</td>
644 <td class=
"cell15"><code>--(java4|java5|cpp)
</code></td>
645 <td class=
"cell85">select the target language
<br>
646 --java4 generate output for Java
1.4 or earlier
<br>
647 --java5 generate output for Java
1.5 or later (is currently the default)
<br>
648 --cpp generate output for C++
</td>
651 <td class=
"cell15"><code>-sn, --shortnames
</code></td>
652 <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>
655 <td class=
"cell15"><code>--propertysetmixin
</code></td>
656 <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>
659 <td class=
"cell15"><code>-lh --licenseheader
</code></td>
660 <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>
663 <td class=
"cell15"><code>-bc
<br>--backward-compatible
</code></td>
664 <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>
667 <td class=
"cell15"><code>-o
<path
></code></td>
668 <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>
671 <td class=
"cell15"><code>-l
<file
></code></td>
672 <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>
675 <td class=
"cell15"><code>-n
<name
></code></td>
676 <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.
"MyBase::
", C++ only) to generate method bodies not inline.
</td>
679 <td class=
"cell15"><code>-d
<name
></code></td>
680 <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 '
<name
>::' for base forwarding, or '
<name
>-
>|.' for composition. Using
"_
" means that a default bodies with default return values are dumped.
</td>
683 <td class=
"cell15"><code>-t
<name
></code></td>
684 <td class=
"cell85">specifies an UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).
</td>
687 <td class=
"cell15"><code>-p
<protocol:cmd(s)
></code></td>
688 <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>
691 <td class=
"cell15"><code>-V, --version
</code></td>
692 <td class=
"cell85">print version number and exit.
</td>
695 <td class=
"cell15"><code>-h, --help
</code></td>
696 <td class=
"cell85">print this help and exit.
</td>
704 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
707 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
710 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
712 <table class=
"table2">
714 <td colspan=
"2" class=
"head1"><a name=
"regcomp"/>regcomp
</td>
716 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
717 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
722 <p>'regcomp' is a tool to register|revoke external UNO components
723 into|from a registry which is used in a UNO environment.
</p>
724 <p class=
"head2">Usage:
</p>
726 <b><code>regcomp -revoke [-br
<registryfile
>] -r
<registryfile
> -c
<locationUrl
>[-l
<componentLoaderName
>]
</code></b>
728 <p class=
"head2">Options:
</p>
730 <table class=
"table4">
732 <td class=
"cell15"><code>-register|revoke
</code></td>
733 <td class=
"cell85">register means that the components will be
734 installed and revoke means that they will be removed.
</td>
737 <td class=
"cell15"><code>-br
<registryfile
></code></td>
738 <td class=
"cell85">the name of the registry used for bootstrapping
739 the program. If the bootstrap registry is specified and has the same
740 name as the registration registry, '-r' is optional.
</td>
743 <td class=
"cell15"><code>-r
<registryfile
></code></td>
744 <td class=
"cell85">the name of the registry (will be created if
745 it does not exist) where the component should be registered.
</td>
748 <td class=
"cell15"><code>-c
<locationUrls
></code></td>
749 <td class=
"cell85">the location of a component (DLL, Class name,
750 or an url of a jar file) or a list of urls separated by ';'s. Note
751 that, if a list of urls is specified, the components must all need
752 the same loader.
</td>
755 <td class=
"cell15"><code>-l
<componentLoaderName
></code></td>
756 <td class=
"cell85">the name of the needed loader, if no loader is
757 specified the 'com.sun.star.loader.SharedLibrary' is used. Supported
758 loaders: 'com.sun.star.loader.SharedLibrary' |
759 'com.sun.star.loader.Java'.
</td>
767 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
770 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
773 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
775 <table class=
"table2">
777 <td colspan=
"2" class=
"head1"><a name=
"regmerge"/>regmerge
</td>
779 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
780 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
785 <p>'regmerge' is a small tool to merge different registry files under a
786 specified key into another registry file. If a value already exists in
787 the target file the value is overwritten by the value of the source
789 <p class=
"head2">Usage:
</p>
791 <b><code>regmerge [-v|--verbose]
<mergefile
> <mergeKeyName
> <regfile_1
> ...
<regfile_n
></code></b>
793 <p class=
"head2">Options:
</p>
795 <table class=
"table4">
797 <td class=
"cell15"><code>-v|--verbose
</code></td>
798 <td class=
"cell85">verbose output on stdout.
</td>
801 <td class=
"cell15"><code><mergefile
></code></td>
802 <td class=
"cell85">specifies the merged registry file. If this file
803 doesn't exist, it is created.
</td>
806 <td class=
"cell15"><code><mergeKeyName
></code></td>
807 <td class=
"cell85">specifies the merge key, everything is merged
808 under this key. If this key doesn't exist, it is created.
</td>
811 <td class=
"cell15"><code><regfile_1
> ...
<regfile_n
></code></td>
812 <td class=
"cell85">specifies one or more registry files that are
821 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
824 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
827 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
829 <table class=
"table2">
831 <td colspan=
"2" class=
"head1"><a name=
"regview"/>regview
</td>
833 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
834 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
839 <p>'regview' is a tool to show the contents of a registry file. The tool
840 dumps the hierarchical structure and the values of the nodes in a human
841 readable manner to stdout.
</p>
842 <p class=
"head2">Usage:
</p>
844 <b><code>regview
<registryfile
> [
<keyName
>]
</code></b>
846 <p class=
"head2">Options:
</p>
848 <table class=
"table4">
850 <td class=
"cell15">-br
<registryfile
></code></td>
851 <td class=
"cell85">the name of the registry whose contents should
855 <td class=
"cell15"><code><keyName
></code></td>
856 <td class=
"cell85">the name of a registry key. The name must be
857 fully qualified; for example, '/' means the root key and
858 '/UCR/com/sun/star/uno/XInterface' shows the type specification of the
859 XInterface type. If no key is specified, the tool dumps the whole
860 content of the registry file.
</td>
868 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
871 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-2.gif"></td>
874 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
876 <table class=
"table2">
878 <td colspan=
"2" class=
"head1"><a name=
"autodoc"/>autodoc
</td>
880 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
881 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
886 <p>The 'autodoc' tool is used for creating javadoc-like documentation
887 from C++ and UNOIDL source code.
</p>
888 <p>There are some conventions to follow when documenting C++- or
889 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>
890 If you are not familiar with these, but do know javadoc: For simple C++
891 sourcecode documentation, using javadoc-style comments will work.
</p>
892 <p class=
"head2">Usage:
</p>
894 <b><code>autodoc [ -v
<VerboseNr
> ] [ -name
"<TitleForTheDocu>" ] -html
<OutputDirectory
> -lg
<SourcecodeLanguage
><br>
895 { [ -p
<ProjectName
> <ProjectRootDirectory
> ]
-t
<SourceTree
>* | -d
<SourceDirectory
>* | -f
<SourceFile
>* }*
</code></b>
897 <p class=
"head2">Options:
</p>
899 <table width=
"100%" border=
"1" cellpadding=
"4" cellspacing=
"0">
901 <td class=
"cell15"><code>-v
<VerboseNr
></code></td>
902 <td class=
"cell85"><VerboseNr
> ==
5 displays the parsed source
903 code tokens, so you can locate which piece caused an parsing error.
<br>
904 <VerboseNr
> ==
2 displays not only the parsed source code,
905 but also the comments.
<br><br>
906 This option must be the first one, if it is used.
</td>
909 <td class=
"cell15"><code>-name
"<Title>"</code></td>
910 <td class=
"cell85"><Title
> occurs as the title of the start
911 page of the HTML output. If this option is omitted, a default title is
915 <td class=
"cell15"><code>-html
<OutputDirectory
></code></td>
916 <td class=
"cell85">specifies the root directory where the HTML output
918 Autodoc does not remove old files there, though it overwrites them.
</td>
921 <td class=
"cell15"><code>-lg
<SourcecodeLanguage
></code></td>
922 <td class=
"cell85">Possible values are: c++ | idl.
<br><br>
923 This also specifies which files will be parsed:
"c++
" parses
924 all files with the endings .hxx and .h,
"idl
" parses all
925 files with the ending '.idl' .
<br>
926 To change this behaviour, see at option
<code>-f
</code>.
</td>
929 <td class=
"cell15"><code>-p
<ProjectName
> <ProjectDirectory
></code></td>
930 <td class=
"cell85">this option can be used to divide large code
931 bases into different projects.
<br>
932 <ProjectName
> gives a user-defined name for the project.
<br>
933 <ProjectDirectory
> is the root to which all paths, given with the
934 following options
<code>-t,-d
</code> and
<code>-f
</code>, are
936 This option can be omitted when there are no projects and all paths in
937 the following options are relative to the working directory.
<br><br>
938 The
"{ ... }*
" around the options
<code>-p,-t,-d,-f
</code>
939 indicates, that this whole block of options can be repeated, each block
940 starting with a new
<code>-p
</code>.
</td>
943 <td class=
"cell15"><code>-t
<SourceTree
></code></td>
944 <td class=
"cell85">specifies that all files in the directory
945 <SourceTree
> and it's subdirectories are parsed, where the file
946 ending matches the option
<code>-lg
</code>.
<br>
947 There can be given multiple directories after one
<code>-t
</code>
949 All relative paths
are relative to the project-rootdirectory,
950 given with the
<code>-p
</code> option.
<br>
954 <td class=
"cell15"><code>-d
<SourceDirectory
></code></td>
955 <td class=
"cell85">Specifies that all files in th directory
956 <SourceDirectory
>, but NOT it's subdirectories, are parsed, where
957 the file ending matches the option
<code>-lg
</code>.
<br>
958 There can be multiple directories given after one
<code>-d
</code>
960 All relative paths
are relative to the project-rootdirectory,
961 given with the
<code>-p
</code> option.
</td>
964 <td class=
"cell15"><code>-f
<SourceFile
></code></td>
965 <td class=
"cell85">parses the given file. The ending does not have
966 to match the
<code>-lg
</code> option.
<br>
967 There can be multiple files given after one
<code>-f
</code> option.
<br>
968 All relative paths
are relative to the project-rootdirectory,
969 given with the
<code>-p
</code> option.
</td>
972 </p><b>Remark:
</b> The sequence of options matters! Use them in the order given
973 in the
"Usage
"-paragraph.
</p>
978 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
981 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
985 <div align=
"center"><p>Copyright
2009 Sun Microsystems, Inc.
</p></div>
990 <area shape=
"rect" coords=
"10,10,80,50" href=
"http://www.sun.com">
991 <area shape=
"rect" coords=
"155,65,335,85" href=
"../index.html">