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