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