1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 3.2 Final//EN">
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
21 <title>LibreOffice %PRODUCT_RELEASE% SDK - Development Tools
</title>
22 <link rel=
"stylesheet" type=
"text/css" href=
"sdk_styles.css">
23 <meta http-equiv=
"Content-Type" content=
"text/html; charset=utf-8">
24 <meta name=
"author" content=
"Jürgen Schmidt">
28 <div id=
"BgContainer">
31 <a id=
"Logo" href=
"http://www.libreoffice.org/" title=
"Go to the Home of LibreOffice and the LibreOffice Community page"></a>
32 <p id=
"HeaderTagLine">
33 Software Development Kit %PRODUCT_RELEASE%
39 <div class=
"typography">
43 <table class=
"table1" cellpadding=
0>
45 <td colspan=
"3"><img class=
"nothing10" src=
"images/nada.gif"></td>
48 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
50 <table class=
"table2">
52 <td colspan=
"3"><img class=
"nothing1" src=
"images/nada.gif"></td>
56 <table class=
"table3">
58 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
59 <td><a href=
"#unopkg" title=
"link to the unopkg tool description">unopkg
</a></td>
60 <td class=
"content87">The new UNO package deployment tool. It comes
61 with the office installation and can be found in the program
62 directory of the office installation.
</td>
65 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
66 <td><a href=
"#unoexe" title=
"link to the uno tool description">uno
</a></td>
67 <td class=
"content87">Tool to provide a UNO runtime environment and
68 provide configured (deployed) or single components. This tool
69 comes with the office installation and can be found in the program
70 directory of the office installation.
</td>
73 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
74 <td><a href=
"#regmerge" title=
"link to the regmerge tool description">regmerge
</a></td>
75 <td class=
"content87">Tool to merge several registry (e.g. type
76 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>
79 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
80 <td><a href=
"#regview" title=
"link to the regview tool description">regview
</a></td>
81 <td class=
"content87">Tool to view the content of a registry file
82 in a human readable manner. Special support for type library
83 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>
86 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
89 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
90 <td><a href=
"#idlc" title=
"link to the idlc tool description">idlc
</a></td>
91 <td class=
"content87">The UNOIDL compiler, generates a common
92 binary type library format as base for all codemaker tools and
93 the UNO runtime type library.
</td>
96 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
97 <td><a href=
"#cppumaker" title=
"link to the cppumaker tool description">cppumaker
</a></td>
98 <td class=
"content87">Tool for generating C++ code for the UNOIDL
99 types stored in a type library.
</td>
102 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
103 <td><a href=
"#javamaker" title=
"link to the javamaker tool description">javamaker
</a></td>
104 <td class=
"content87">Tool for generating Java class files for the
105 UNOIDL types stored in a type library.
</td>
108 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
109 <td><a href=
"#climaker" title=
"link to the climaker tool description">climaker
</a></td>
110 <td class=
"content87">Tool for generating CLI assemblies for the
111 UNOIDL types stored in a type library (windows only).
</td>
114 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
115 <td><a href=
"#uno-skeletonmaker" title=
"link to the uno-skeletonmaker tool description">uno-skeletonmaker
</a></td>
116 <td class=
"content87">Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.
</td>
119 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
120 <td><a href=
"#regmerge" title=
"link to the regmerge tool description">regmerge
</a></td>
121 <td class=
"content87">Tool to merge several registry (e.g. type
122 libraries) files into one file.
</td>
125 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
126 <td><a href=
"#regview" title=
"link to the regview tool description">regview
</a></td>
127 <td class=
"content87">Tool to view the content of a registry file
128 in a human readable manner. Special support for type library
132 <td class=
"content3"><img src=
"images/arrow-1.gif"></td>
133 <td><a href=
"#autodoc" title=
"link to the autodoc tool description">autodoc
</a></td>
134 <td class=
"content87">Tool to generate javadoc-like documentation
135 for C/C++ and UNOIDL files.
</td>
142 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
145 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
148 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
150 <table class=
"table2">
152 <td colspan=
"2" class=
"head1"><a name=
"unopkg"/>unopkg
</td>
154 <a style=
"a:link:visited #FFFFFF;" href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
155 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a></td>
159 <p>'unopkg' is a tool for easy deployment of UNO packages in an existing
160 office installation. UNO packages are UNO components (single libraries or
161 Jar files or more complex zip files that contains one or more libraries|
162 Jar files, type libraries and configuration items), scripts and
163 LibreOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the
164 SDK but comes with the office directly and is a development tool as well
165 as an end user tool to deploy extension into an office installation.
</p>
166 <p>More details concerning deployment and this tool can be find in the
167 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>
168 <p><b>Note:
</b> This tool works only in the
<i><office
>/program
</i>
170 <p class=
"head2">Usage:
</p>
173 unopkg add
<options
> package-path...
<br>
174 unopkg remove
<options
> package-name...
<br>
175 unopkg list
<options
> package-name...
<br>
176 unopkg reinstall
<options
><br>
182 <p class=
"head2">Sub-commands:
</p>
184 <table class=
"table4">
186 <td class=
"cell15"><code>add
</code></td>
187 <td class=
"cell85">add packages
</td>
190 <td class=
"cell15"><code>remove
</code></td>
191 <td class=
"cell85">remove packages by name
</td>
194 <td class=
"cell15"><code>reinstall
</code></td>
195 <td class=
"cell85">export feature: reinstall all deployed
199 <td class=
"cell15"><code>list
</code></td>
200 <td class=
"cell85">list information about deployed packages
</td>
203 <td class=
"cell15"><code>gui
</code></td>
204 <td class=
"cell15">raise Package Manager Graphical User Interface
209 <p class=
"head2">Options:
</p>
211 <table class=
"table4">
213 <td class=
"cell15"><code>-h, --help
</code></td>
214 <td class=
"cell85">show this help on the command line
</td>
217 <td class=
"cell15"><code>-V, --version
</code></td>
218 <td class=
"cell85">shows version information
222 <td class=
"cell15"><code>-v, --verbose
</code></td>
223 <td class=
"cell85">dump verbose output to stdout
</td>
226 <td class=
"cell15"><code>-f, --force
</code></td>
227 <td class=
"cell85">force overwriting existing packages
</td>
230 <td class=
"cell15"><code>--log-file
<file
></code></td>
231 <td class=
"cell85">custom log file; default:
232 <i><cache-dir>/log.txt
</i>.
</td>
235 <td class=
"cell15"><code>--shared
</code></td>
236 <td class=
"cell85">expert feature: operate on shared installation
237 deployment context; run only when no concurrent Office process(es) are
241 <td class=
"cell15"><code>--deployment-context
<context>
</code>
243 <td class=
"cell85">expert feature: explicit deployment context
</td>
251 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
254 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
257 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
259 <table class=
"table2">
261 <td colspan=
"2" class=
"head1"><a name=
"unoexe"/>uno
</td>
263 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
264 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
269 <p>The UNO-starter is for running a component or service process, and
270 providing a runtime environment. Raising a component might look like
272 <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb
273 -- foo bar
</code></p>
275 <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb
276 -- foo bar
</code></p>
277 <p>The starter loads the component and instantiates it. The component
278 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>
280 <code>interface XMain : com::sun::star::uno::XInterface
<br>
282 /** This method is called to run the component.
<br>
283 <br>
284 @param aArguments command line arguments
<br>
285 @return process error code to be returned to system
<br>
286 */
<br>
287 long run( [in] sequence
< string
> arguments );
<br>
291 <p>Method run() will be called and returns the error code given, back
292 to the system. If the uno starter is executed with the -u (URL) option,
293 then XInitialization is used instead of XMain. The -u option is described
295 <p class=
"head2">Usage:
</p>
297 <b><code>uno (-c
<ComponentImplementationName
> -l
<LocationUrl
>
298 | -s
<ServiceName
>)
<br>
299 [-u uno:(socket[,host=
<HostName
>][,port=
<nnn
>]|pipe[,name=
<PipeName
>]);iiop|urp;
<Name
><br>
300 [--singleaccept] [--singleinstance]]
<br>
301 [--
<Argument1 Argument2 ...
>]
304 <p class=
"head2">Options:
</p>
306 <table class=
"table4">
308 <td class=
"cell15"><code><HostName
></code></td>
309 <td class=
"cell85">Specifying a host name might be necessary to
310 distinguish the network interface to be used,if a machine is part of
314 <td class=
"cell15"><code><PipeName
></code></td>
315 <td class=
"cell85">Name of a named pipe.
</td>
318 <td class=
"cell15"><code><Name
></code></td>
319 <td class=
"cell85">Identifier for demanded called component
323 <td class=
"cell15"><code>--singleaccept
</code></td>
324 <td class=
"cell85">The uno starter will accept one connection,
325 provide the component instance and die.
</td>
328 <td class=
"cell15"><code>--singleinstance
</code></td>
329 <td class=
"cell85">The uno starter will accept any number of
330 connections, but will provide the same single component instance any
331 time instead of creating a new instance for each connection.
</td>
334 <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>
335 <p>You can easily connect to a server started with the
336 <code>-u (url)
</code> option by using this service, giving the same url
337 to resolve. The service provides you an instance from remote.
</p>
343 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
346 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
349 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
351 <table class=
"table2">
353 <td colspan=
"2" class=
"head1"><a name=
"idlc"/>idlc
</td>
355 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
356 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
361 <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used
362 to check UNODL type definitions and transform valid type definitions
363 into a binary type library format, which is later used by all codemaker
364 tools. It is also used as a dynamic type library for UNO at runtime.
<br>
365 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>
366 <p class=
"head2">Usage:
</p>
368 <b><code>idlc [-options] file_1 ... file_n | @
<filename
></code></b>
371 <table class=
"table4">
373 <td class=
"cell15"><code>file_1 ... file_n
</code></td>
374 <td class=
"cell85">specifies one or more idl files. Only files with
375 the extension '.idl' are valid.
</td>
378 <td class=
"cell15"><code>@
<filename
></code></td>
379 <td class=
"cell85">filename specifies the name of a command
384 <p class=
"head2">Options:
</p>
386 <table class=
"table4">
388 <td class=
"cell15"><code>-O
<path
></code></td>
389 <td class=
"cell85">path describes the output directory. The
390 generated output is a registry file with the same name as the idl
394 <td class=
"cell15"><code>-I
<path
></code></td>
395 <td class=
"cell85">path specifies a directory where included files
396 that will be searched by the preprocessor are located. Multiple
397 directories can be combined with ';'.
</td>
400 <td class=
"cell15"><code>-D
<name
></code></td>
401 <td class=
"cell85">name defines a macro for the preprocessor.
</td>
404 <td class=
"cell15"><code>-C
</code></td>
405 <td class=
"cell85">generates complete type information, including
406 additional service information and documentation.
</td>
409 <td class=
"cell15"><code>-h|?
</code></td>
410 <td class=
"cell85">print this help message and exit.
</td>
418 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
421 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
424 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
426 <table class=
"table2">
428 <td colspan=
"2" class=
"head1"><a name=
"cppumaker"/>cppumaker
</td>
430 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
431 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
436 <p>The 'cppumaker' generates a C++ representation for idl types. The
437 cppumaker works on a typelibrary, which is generated by the UNOIDL
438 compiler (
<a href=
"#idlc" link=
"link to the idlc tool description">
439 idlc
</a>). It generates the output for all specified types and for all
440 types the specified types depend on.
</p>
441 <p class=
"head2">Usage:
</p>
443 <b><code>cppumaker [-options] file_1 ... file_n
</code></b>
445 <p class=
"head2">Options:
</p>
447 <table class=
"table4">
449 <td class=
"cell15"><code>-O
<path
></code></td>
450 <td class=
"cell85">path describes the root directory for the
451 generated output. The output directory tree is generated under this
455 <td class=
"cell15"><code>-T
<name
><br>
456 |-T
<t1
>;
<t2
>...
</code></td>
457 <td class=
"cell85">name specifies a type or a list of types. The
458 output for this type and all dependent types are generated. If no '-T'
459 option is specified, then output for all types is generated. It is also
460 possible to use a wildcard 'xy.*' to generate a complete module
461 inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
462 option. Example: 'com.sun.star.uno.XInterface' or
463 'com.sun.star.uno.*' are valid types.
467 <td class=
"cell15"><code>-B
<name
></code></td>
468 <td class=
"cell85">name specifies the base node. All types are
469 searched under this node. Default is the root '/' of the registry
473 <td class=
"cell15"><code>-L
</code></td>
474 <td class=
"cell85">UNO type functions are generated lightweight, that
475 means only the name and typeclass are given and everything else is
476 retrieved from the type library dynamically. The default is that UNO
477 type functions provides enough type information for boostrapping C++.
478 '-L' should be the default for external components.
</td>
481 <td class=
"cell15"><code>-C
</code></td>
482 <td class=
"cell85">UNO type functions are generated comprehensive
483 that means all necessary information is available for bridging the
488 <td class=
"cell15"><code>-G
</code></td>
489 <td class=
"cell85">generate only target files which do not
493 <td class=
"cell15"><code>-Gc
</code></td>
494 <td class=
"cell85">generate only target files whose content will
498 <td class=
"cell15"><code>-X
<name
></code></td>
499 <td class=
"cell85">extra types, which are not be taken into account
508 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
511 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
514 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
516 <table class=
"table2">
518 <td colspan=
"2" class=
"head1"><a name=
"javamaker"/>javamaker
</td>
520 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
521 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
526 <p>The 'javamaker' generates the appropriate Java class file for each idl
527 type. The javamaker works on a typelibrary which is generated by the
528 UNOIDL compiler (
<a href=
"#idlc" link=
"link to the idlc tool description">
529 idlc
</a>). It generates the output for all specified types and for all
530 types the specified types depend on.
</p>
531 <p class=
"head2">Usage:
</p>
533 <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+
1 -Xfile_n+
2</code></b>
535 <p class=
"head2">Options:
</p>
537 <table class=
"table4">
539 <td class=
"cell15"><code>-O
<path
></code></td>
540 <td class=
"cell85">path describes the root directory for the
541 generated output. The output directory tree is generated under this
545 <td class=
"cell15"><code>-T
<name
>|-T
<t1
>;
<t2
>...
</code></td>
546 <td class=
"cell85">name specifies a type or a list of types. The
547 output for this type and all dependent types are generated. If no '-T'
548 option is specified, then output for all types is generated. It is also
549 possible to use a wildcard 'xy.*' to generate a complete module
550 inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
551 option. Example: 'com.sun.star.uno.XInterface'
552 or 'com.sun.star.uno.*' are valid types.
556 <td class=
"cell15"><code>-B
<name
></code></td>
557 <td class=
"cell85">name specifies the base node. All types are
558 searched under this node. Default is the root '/' of the registry
562 <td class=
"cell15"><code>-nD
</code></td>
563 <td class=
"cell85">no dependent types are generated.
</td>
566 <td class=
"cell15"><code>-G
</code></td>
567 <td class=
"cell85">generate only target files which do not
571 <td class=
"cell15"><code>-Gc
</code></td>
572 <td class=
"cell85">generate only target files whose content will
576 <td class=
"cell15"><code>-X
<name
></code></td>
577 <td class=
"cell85">extra types, which will not be taken into account
586 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
589 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
592 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
594 <table class=
"table2">
596 <td colspan=
"2" class=
"head1"><a name=
"climaker"/>climaker
</td>
598 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
599 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
604 <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl
605 type. The climaker works on a typelibrary which is generated by the
606 UNOIDL compiler (
<a href=
"#idlc" link=
"link to the idlc tool description">
607 idlc
</a>). It generates the output for all specified types and for all
608 types the specified types depend on.
</p>
609 <p class=
"head2">Usage:
</p>
611 <b><code>climaker
<switches
> [registry-file-
1 registry-file-
2 ...]
</code></b>
613 <p class=
"head2">Options:
</p>
615 <table class=
"table4">
617 <td class=
"cell15"><code>-O, --out
<output_file
></code></td>
618 <td class=
"cell85">output assembly file;
<br>
619 defaults to cli_unotypes.dll if more than one registry-file is given, else
<registry-file
>.dll
</td>
622 <td class=
"cell15"><code>-T, --types
<type1[;type2;...]
></code></td>
623 <td class=
"cell85">types to be generated (if none is given,
624 then all types of given registries are emitted
</td>
627 <td class=
"cell15"><code>-X, --extra
<rdb-file
>></code></td>
628 <td class=
"cell85">additional rdb to saturate referenced types in
629 given registry file(s); these types will not be
630 emitted into the output assembly file
</td>
633 <td class=
"cell15"><code>-r, --reference
<assembly-file
></code></td>
634 <td class=
"cell85">reference metadata from assembly file
</td>
637 <td class=
"cell15"><code>-k, --keyfile
</code></td>
638 <td class=
"cell85">keyfile needed for strong name
</td>
641 <td class=
"cell15"><code>--assembly-version
<version
></code></td>
642 <td class=
"cell85">sets assembly version
</td>
645 <td class=
"cell15"><code>--assembly-description
<text
></code></td>
646 <td class=
"cell85">sets assembly description text
</td>
649 <td class=
"cell15"><code>--assembly-product
<text
></code></td>
650 <td class=
"cell85">sets assembly product name
</td>
653 <td class=
"cell15"><code>--assembly-company
<text
></code></td>
654 <td class=
"cell85">sets assembly company
</td>
657 <td class=
"cell15"><code>--assembly-copyright
<text
></code></td>
658 <td class=
"cell85">sets assembly copyright
</td>
661 <td class=
"cell15"><code>--assembly-trademark
<text
></code></td>
662 <td class=
"cell85">sets assembly trademark
</td>
665 <td class=
"cell15"><code>-v, --verbose
</code></td>
666 <td class=
"cell85">verbose output to stdout
</td>
669 <td class=
"cell15"><code>-h, --help
</code></td>
670 <td class=
"cell85">this message
</td>
675 <p><b>Example:
</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb
</code></p>
680 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
683 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
686 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
688 <table class=
"table2">
690 <td colspan=
"2" class=
"head1"><a name=
"uno-skeletonmaker"/>uno-skeletonmaker
</td>
692 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
693 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
698 <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>
699 <p class=
"head2">Usage:
</p>
702 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) dump [
<options
>] -t
<type
> ...
<br>
703 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) component [
<options
>] -n
<name
> -t
<type
> ...
<br>
704 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) calc-add-in [
<options
>] -n
<name
> -t
<add-in_service
><br>
705 uno-skeletonmaker (-env:INIFILENAME=
<url
> | -env:UNO_TYPES=
<url
>) add-on [
<options
>] -n
<name
> -p
<protocol_name:command,...
>
706 uno-skeletonmaker -V, --version
<br>
707 uno-skeletonmaker -h, --help
<br>
710 <p class=
"head2">Sub-commands:
</p>
712 <table class=
"table4">
714 <td class=
"cell15"><code>dump
</code></td>
715 <td class=
"cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.
</td>
718 <td class=
"cell15"><code>component
</code></td>
719 <td class=
"cell85">generates language specific code skeleton files using the implementation name as the file and class name
</td>
722 <td class=
"cell15"><code>calc-add-in
</code></td>
723 <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>
726 <td class=
"cell15"><code>add-on
</code></td>
727 <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>
731 <p class=
"head2">Options:
</p>
733 <table class=
"table4">
735 <td class=
"cell15"><code>-env:INIFILENAME=
<url
></code></td>
736 <td class=
"cell85">url specifies a URL to an UNO ini|rc file of an existing UNO environment (URE, office installation).
</td>
739 <td class=
"cell15"><code>-env:UNO_TYPES=
<url
></code></td>
740 <td class=
"cell85">url specifies a binary type library file. It can be a space separated list of urls.
</td>
743 <td class=
"cell15"><code>-a, --all
</code></td>
744 <td class=
"cell85">list all interface methods, not only the direct ones
</td>
747 <td class=
"cell15"><code>--(java4|java5|cpp)
</code></td>
748 <td class=
"cell85">select the target language
<br>
749 --java4 generate output for Java
1.4 or earlier
<br>
750 --java5 generate output for Java
1.5 or later (is currently the default)
<br>
751 --cpp generate output for C++
</td>
754 <td class=
"cell15"><code>-sn, --shortnames
</code></td>
755 <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>
758 <td class=
"cell15"><code>--propertysetmixin
</code></td>
759 <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>
762 <td class=
"cell15"><code>-lh --licenseheader
</code></td>
763 <td class=
"cell85">generates a default LibreOffice MPLv2 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>
766 <td class=
"cell15"><code>-bc
<br>--backward-compatible
</code></td>
767 <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>
770 <td class=
"cell15"><code>-o
<path
></code></td>
771 <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>
774 <td class=
"cell15"><code>-l
<file
></code></td>
775 <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>
778 <td class=
"cell15"><code>-n
<name
></code></td>
779 <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>
782 <td class=
"cell15"><code>-d
<name
></code></td>
783 <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>
786 <td class=
"cell15"><code>-t
<name
></code></td>
787 <td class=
"cell85">specifies an UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).
</td>
790 <td class=
"cell15"><code>-p
<protocol:cmd(s)
></code></td>
791 <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>
794 <td class=
"cell15"><code>-V, --version
</code></td>
795 <td class=
"cell85">print version number and exit.
</td>
798 <td class=
"cell15"><code>-h, --help
</code></td>
799 <td class=
"cell85">print this help and exit.
</td>
807 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
810 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
813 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
815 <table class=
"table2">
817 <td colspan=
"2" class=
"head1"><a name=
"regmerge"/>regmerge
</td>
819 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
820 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
825 <p>'regmerge' is a small tool to merge different registry files under a
826 specified key into another registry file. If a value already exists in
827 the target file the value is overwritten by the value of the source
829 <p class=
"head2">Usage:
</p>
831 <b><code>regmerge [-v|--verbose]
<mergefile
> <mergeKeyName
> <regfile_1
> ...
<regfile_n
></code></b>
833 <p class=
"head2">Options:
</p>
835 <table class=
"table4">
837 <td class=
"cell15"><code>-v|--verbose
</code></td>
838 <td class=
"cell85">verbose output on stdout.
</td>
841 <td class=
"cell15"><code><mergefile
></code></td>
842 <td class=
"cell85">specifies the merged registry file. If this file
843 doesn't exist, it is created.
</td>
846 <td class=
"cell15"><code><mergeKeyName
></code></td>
847 <td class=
"cell85">specifies the merge key, everything is merged
848 under this key. If this key doesn't exist, it is created.
</td>
851 <td class=
"cell15"><code><regfile_1
> ...
<regfile_n
></code></td>
852 <td class=
"cell85">specifies one or more registry files that are
861 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
864 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
867 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
869 <table class=
"table2">
871 <td colspan=
"2" class=
"head1"><a name=
"regview"/>regview
</td>
873 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
874 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
879 <p>'regview' is a tool to show the contents of a registry file. The tool
880 dumps the hierarchical structure and the values of the nodes in a human
881 readable manner to stdout.
</p>
882 <p class=
"head2">Usage:
</p>
884 <b><code>regview
<registryfile
> [
<keyName
>]
</code></b>
886 <p class=
"head2">Options:
</p>
888 <table class=
"table4">
890 <td class=
"cell15">-br
<registryfile
></code></td>
891 <td class=
"cell85">the name of the registry whose contents should
895 <td class=
"cell15"><code><keyName
></code></td>
896 <td class=
"cell85">the name of a registry key. The name must be
897 fully qualified; for example, '/' means the root key and
898 '/UCR/com/sun/star/uno/XInterface' shows the type specification of the
899 XInterface type. If no key is specified, the tool dumps the whole
900 content of the registry file.
</td>
908 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
911 <td colspan=
"3"><img class=
"line" src=
"images/sdk_line-1.gif"></td>
914 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
916 <table class=
"table2">
918 <td colspan=
"2" class=
"head1"><a name=
"autodoc"/>autodoc
</td>
920 <a href=
"#tools" title=
"link to the tools overview"><img class=
"navigate" src=
"images/nav_up.png"></a>
921 <a href=
"../index.html" title=
"link to the SDK start page"><img class=
"navigate" src=
"images/nav_home.png"></a>
926 <p>The 'autodoc' tool is used for creating javadoc-like documentation
927 from C++ and UNOIDL source code.
</p>
928 <p>There are some conventions to follow when documenting C++- or
929 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>
930 If you are not familiar with these, but do know javadoc: For simple C++
931 sourcecode documentation, using javadoc-style comments will work.
</p>
932 <p class=
"head2">Usage:
</p>
934 <b><code>autodoc [ -v
<VerboseNr
> ] [ -name
"<TitleForTheDocu>" ] -html
<OutputDirectory
> -lg
<SourcecodeLanguage
><br>
935 { [ -p
<ProjectName
> <ProjectRootDirectory
> ]
-t
<SourceTree
>* | -d
<SourceDirectory
>* | -f
<SourceFile
>* }*
</code></b>
937 <p class=
"head2">Options:
</p>
939 <table width=
"100%" border=
"1" cellpadding=
"4" cellspacing=
"0">
941 <td class=
"cell15"><code>-v
<VerboseNr
></code></td>
942 <td class=
"cell85"><VerboseNr
> ==
5 displays the parsed source
943 code tokens, so you can locate which piece caused an parsing error.
<br>
944 <VerboseNr
> ==
2 displays not only the parsed source code,
945 but also the comments.
<br><br>
946 This option must be the first one, if it is used.
</td>
949 <td class=
"cell15"><code>-name
"<Title>"</code></td>
950 <td class=
"cell85"><Title
> occurs as the title of the start
951 page of the HTML output. If this option is omitted, a default title is
955 <td class=
"cell15"><code>-html
<OutputDirectory
></code></td>
956 <td class=
"cell85">specifies the root directory where the HTML output
958 Autodoc does not remove old files there, though it overwrites them.
</td>
961 <td class=
"cell15"><code>-lg
<SourcecodeLanguage
></code></td>
962 <td class=
"cell85">Possible values are: c++ | idl.
<br><br>
963 This also specifies which files will be parsed:
"c++
" parses
964 all files with the endings .hxx and .h,
"idl
" parses all
965 files with the ending '.idl' .
<br>
966 To change this behaviour, see at option
<code>-f
</code>.
</td>
969 <td class=
"cell15"><code>-p
<ProjectName
> <ProjectDirectory
></code></td>
970 <td class=
"cell85">this option can be used to divide large code
971 bases into different projects.
<br>
972 <ProjectName
> gives a user-defined name for the project.
<br>
973 <ProjectDirectory
> is the root to which all paths, given with the
974 following options
<code>-t,-d
</code> and
<code>-f
</code>, are
976 This option can be omitted when there are no projects and all paths in
977 the following options are relative to the working directory.
<br><br>
978 The
"{ ... }*
" around the options
<code>-p,-t,-d,-f
</code>
979 indicates, that this whole block of options can be repeated, each block
980 starting with a new
<code>-p
</code>.
</td>
983 <td class=
"cell15"><code>-t
<SourceTree
></code></td>
984 <td class=
"cell85">specifies that all files in the directory
985 <SourceTree
> and it's subdirectories are parsed, where the file
986 ending matches the option
<code>-lg
</code>.
<br>
987 There can be given multiple directories after one
<code>-t
</code>
989 All relative paths
are relative to the project-rootdirectory,
990 given with the
<code>-p
</code> option.
<br>
994 <td class=
"cell15"><code>-d
<SourceDirectory
></code></td>
995 <td class=
"cell85">Specifies that all files in th directory
996 <SourceDirectory
>, but NOT it's subdirectories, are parsed, where
997 the file ending matches the option
<code>-lg
</code>.
<br>
998 There can be multiple directories given after one
<code>-d
</code>
1000 All relative paths
are relative to the project-rootdirectory,
1001 given with the
<code>-p
</code> option.
</td>
1004 <td class=
"cell15"><code>-f
<SourceFile
></code></td>
1005 <td class=
"cell85">parses the given file. The ending does not have
1006 to match the
<code>-lg
</code> option.
<br>
1007 There can be multiple files given after one
<code>-f
</code> option.
<br>
1008 All relative paths
are relative to the project-rootdirectory,
1009 given with the
<code>-p
</code> option.
</td>
1012 </p><b>Remark:
</b> The sequence of options matters! Use them in the order given
1013 in the
"Usage
"-paragraph.
</p>
1018 <td class=
"content1"><img class=
"nothing8" src=
"images/nada.gif"></td>
1023 <div id=
"FooterText">
1025 Copyright ©
2000,
2013 LibreOffice contributors and/or their affiliates. All rights reserved.
1027 LibreOffice was created by The Document Foundation,
1028 based on Apache OpenOffice, which is Copyright
2011
1029 The Apache Software Foundation.
1031 The Document Foundation acknowledges all community members, please find more info
<a href=
"http://www.libreoffice.org/about-us/credits/" target=
"_blank">at our website
</a>.
1037 <a href=
"http://www.documentfoundation.org/privacy" target=
"_blank">Privacy Policy
</a> |
<a href=
"http://www.documentfoundation.org/imprint" target=
"_blank">Impressum (Legal Info)
</a>
1038 | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (
<a href=
"http://www.libreoffice.org/download/license/" target=
"_blank">LGPLv3
</a>).
"LibreOffice" and
"The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our
<a href=
"http://wiki.documentfoundation.org/TradeMark_Policy" target=
"_blank">trademark policy
</a>.