odk/docs/tools.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
   2 <!--
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18 -->
  19 <html>
  20 <head>
  21   <title>LibreOffice %PRODUCT_RELEASE% SDK - Development Tools</title>
  22   <link rel="stylesheet" type="text/css" href="sdk_styles.css"/>
  23   <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
  24 </head>
  25 <body>
  26         <a name="tools"></a>
  27         <div id="BgContainer">
  28             <div id="Container">
  29                 <div id="TopHeader">
  30                     <a id="Logo" href="http://www.libreoffice.org/" title="Go to the Home of LibreOffice and the LibreOffice Community page"></a>
  31                     <p id="HeaderTagLine">
  32                         Software Development Kit %PRODUCT_RELEASE%
  33                     </p>
  34                 </div>
  35                 <div class="clear">
  36                 </div>
  37                 <div id="Layout">
  38                     <div class="typography">
  39                         <h1>
  40                             Development Tools
  41                         </h1>
  42 <table class="table1" cellpadding="0">
  43   <tr>
  44     <td colspan="3"><img  class="nothing10" src="images/nada.gif"/></td>
  45   </tr>
  46   <tr>
  47     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
  48     <td>
  49       <table class="table2">
  50             <tr>
  51                   <td colspan="3"><img class="nothing1" src="images/nada.gif"/></td>
  52         </tr>
  53         <tr>
  54           <td>
  55           <table class="table3">
  56             <tr valign="top">
  57               <td class="content3"><img src="images/arrow-1.gif"/></td>
  58               <td><a href="#unopkg"  title="link to the unopkg tool description">unopkg</a></td>
  59               <td class="content87">The new UNO package deployment tool. It comes
  60                           with the office installation and can be found in the program
  61                           directory of the office installation.</td>
  62             </tr>
  63             <tr valign="top">
  64               <td class="content3"><img src="images/arrow-1.gif"/></td>
  65               <td><a href="#unoexe"  title="link to the uno tool description">uno</a></td>
  66               <td class="content87">Tool to provide a UNO runtime environment and
  67                           provide configured (deployed) or single components. This tool
  68                           comes with the office installation and can be found in the program
  69                           directory of the office installation.</td>
  70             </tr>
  71            <tr valign="top">
  72               <td class="content3"><img src="images/arrow-1.gif"/></td>
  73               <td><a href="#regmerge"  title="link to the regmerge tool description">regmerge</a></td>
  74               <td class="content87">Tool to merge several registry (e.g. type
  75                           libraries) files into one file. <b>Note:</b> Since OpenOffice.org 3 it is no longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td>
  76             </tr>
  77             <tr valign="top">
  78               <td class="content3"><img src="images/arrow-1.gif"/></td>
  79               <td><a href="#regview"  title="link to the regview tool description">regview</a></td>
  80               <td class="content87">Tool to view the content of a registry file
  81                           in a human readable manner. Special support for type library
  82                           nodes. <b>Note:</b> Since OpenOffice.org 3 it is no longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td>
  83             </tr>
  84             <tr valign="middle">
  85               <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
  86             </tr>
  87             <tr valign="top">
  88               <td class="content3"><img src="images/arrow-1.gif"/></td>
  89               <td><a href="#idlc" title="link to the idlc tool description">idlc</a></td>
  90               <td class="content87">The UNOIDL compiler, generates a common
  91                           binary type library format as base for all codemaker tools and
  92                           the UNO runtime type library.</td>
  93             </tr>
  94             <tr valign="top">
  95               <td class="content3"><img src="images/arrow-1.gif"/></td>
  96               <td><a href="#cppumaker" title="link to the cppumaker tool description">cppumaker</a></td>
  97               <td class="content87">Tool for generating C++ code for the UNOIDL
  98                           types stored in a type library.</td>
  99             </tr>
 100             <tr valign="top">
 101               <td class="content3"><img src="images/arrow-1.gif"/></td>
 102               <td><a href="#javamaker" title="link to the javamaker tool description">javamaker</a></td>
 103               <td class="content87">Tool for generating Java class files for the
 104                           UNOIDL types stored in a type library.</td>
 105             </tr>
 106            <tr valign="top">
 107               <td class="content3"><img src="images/arrow-1.gif"/></td>
 108               <td><a href="#climaker" title="link to the climaker tool description">climaker</a></td>
 109               <td class="content87">Tool for generating CLI assemblies for the
 110                           UNOIDL types stored in a type library (windows only).</td>
 111             </tr>
 112             <tr valign="top">
 113               <td class="content3"><img src="images/arrow-1.gif"/></td>
 114               <td><a href="#uno-skeletonmaker" title="link to the uno-skeletonmaker tool description">uno-skeletonmaker</a></td>
 115               <td class="content87">Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.</td>
 116             </tr>
 117             <tr valign="top">
 118               <td class="content3"><img src="images/arrow-1.gif"/></td>
 119               <td><a href="#regmerge"  title="link to the regmerge tool description">regmerge</a></td>
 120               <td class="content87">Tool to merge several registry (e.g. type
 121                           libraries) files into one file.</td>
 122             </tr>
 123             <tr valign="top">
 124               <td class="content3"><img src="images/arrow-1.gif"/></td>
 125               <td><a href="#regview"  title="link to the regview tool description">regview</a></td>
 126               <td class="content87">Tool to view the content of a registry file
 127                           in a human readable manner. Special support for type library
 128                           nodes.</td>
 129             </tr>
 130             </table>
 131           </td>
 132                 </tr>
 133       </table>
 134     </td>
 135         <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 136   </tr>
 137   <tr>
 138     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 139   </tr>
 140   <tr>
 141     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 142     <td>
 143       <table class="table2">
 144         <tr>
 145                   <td colspan="2" class="head1"><a name="unopkg"/>unopkg</td>
 146                   <td align="right">
 147                         <a style="a:link:visited #FFFFFF;" href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 148                         <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a></td>
 149         </tr>
 150                 <tr>
 151                   <td colspan="3">
 152                   <p>'unopkg' is a tool for easy deployment of UNO packages in an existing
 153                   office installation. UNO packages are UNO components (single libraries or
 154                   Jar files or more complex zip files that contain one or more libraries|
 155                   Jar files, type libraries and configuration items), scripts  and
 156                   LibreOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the
 157                   SDK but comes with the office directly and is a development tool as well
 158                   as an end user tool to deploy extension into an office installation.</p>
 159                   <p>More details concerning deployment and this tool can be found in the
 160                   Developer's Guide: <a href="http://wiki.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p>
 161                   <p><b>Note:</b> This tool works only in the <i>&lt;office&gt;/program</i>
 162                   directory!</p>
 163                   <p class="head2">Usage:</p>
 164                   <blockquote>
 165                   <b><code>
 166                     unopkg add &lt;options&gt; package-path...<br/>
 167                         unopkg remove &lt;options&gt; package-name...<br/>
 168                         unopkg list &lt;options&gt; package-name...<br/>
 169                         unopkg reinstall &lt;options&gt;<br/>
 170                         unopkg gui<br/>
 171                         unopkg -V<br/>
 172                         unopkg -h<br/>
 173                   </code></b>
 174                   </blockquote>
 175                   <p class="head2">Sub-commands:</p>
 176                   <table class="table4">
 177                   <tr>
 178                     <td class="cell15"><code>add</code></td>
 179                         <td class="cell85">add packages</td>
 180                   </tr>
 181                         <tr>
 182                         <td class="cell15"><code>remove</code></td>
 183                         <td class="cell85">remove packages by name</td>
 184           </tr>
 185                   <tr>
 186             <td class="cell15"><code>reinstall</code></td>
 187                         <td class="cell85">expert feature: reinstall all deployed
 188                         packages</td>
 189           </tr>
 190                   <tr>
 191             <td class="cell15"><code>list</code></td>
 192                         <td class="cell85">list information about deployed packages</td>
 193           </tr>
 194                   <tr>
 195             <td class="cell15"><code>gui</code></td>
 196                         <td class="cell15">raise Package Manager Graphical User Interface
 197                         (GUI)</td>
 198           </tr>
 199                   </table>
 200                   <p class="head2">Options:</p>
 201                   <table class="table4">
 202                   <tr>
 203             <td class="cell15"><code>-h, --help</code></td>
 204             <td class="cell85">show this help on the command line</td>
 205           </tr>
 206                   <tr>
 207             <td class="cell15"><code>-V, --version</code></td>
 208                         <td class="cell85">shows version information
 209                         </td>
 210           </tr>
 211           <tr>
 212             <td class="cell15"><code>-v, --verbose</code></td>
 213                         <td class="cell85">dump verbose output to stdout</td>
 214           </tr>
 215                   <tr>
 216             <td class="cell15"><code>-f, --force</code></td>
 217                         <td class="cell85">force overwriting existing packages</td>
 218           </tr>
 219           <tr>
 220             <td class="cell15"><code>--log-file &lt;file&gt;</code></td>
 221                         <td class="cell85">custom log file; default:
 222                         <i>&lt;cache-dir&gt;/log.txt</i>.</td>
 223           </tr>
 224           <tr>
 225             <td class="cell15"><code>--shared</code></td>
 226                         <td class="cell85">expert feature: operate on shared installation
 227                         deployment context; run only when no concurrent Office process(es) are
 228                         running!</td>
 229           </tr>
 230           <tr>
 231                     <td class="cell15"><code>--deployment-context &lt;context&gt;</code>
 232                         </td>
 233                         <td class="cell85">expert feature: explicit deployment context</td>
 234           </tr>
 235                   </table>
 236                   </td>
 237                 </tr>
 238       </table>
 239     </td>
 240         <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 241   </tr>
 242   <tr>
 243     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 244   </tr>
 245   <tr>
 246     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 247     <td>
 248       <table class="table2">
 249         <tr>
 250                   <td colspan="2" class="head1"><a name="unoexe"/>uno</td>
 251                   <td align="right">
 252                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 253                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 254                   </td>
 255         </tr>
 256                 <tr>
 257                   <td colspan="3">
 258                   <p>The UNO-starter is for running a component or service process, and
 259                   providing a runtime environment. Raising a component might look like
 260                   this </p>
 261                   <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb
 262                   -- foo bar</code></p>
 263                   <p>or</p>
 264                   <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb
 265                   -- foo bar</code></p>
 266                   <p>The starter loads the component and instantiates it. The component
 267                   must export the interface <a href="%DOXYGEN_PREFIX1%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XMain.html" title="link into the IDL reference to the interface com.sun.star.lang.XMain">com.sun.star.lang.XMain</a>:</p>
 268                   <p>
 269                   <code>interface XMain : com::sun::star::uno::XInterface <br/>
 270             { <br/>
 271               &nbsp;&nbsp;&nbsp; /** This method is called to run the component.<br/>
 272               &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br/>
 273               &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @param aArguments command line arguments <br/>
 274               &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @return process error code to be returned to system <br/>
 275               &nbsp;&nbsp;&nbsp; */ <br/>
 276               &nbsp;&nbsp;&nbsp; long run( [in] sequence&lt; string &gt; arguments ); <br/>
 277             };
 278           </code>
 279                   </p>
 280                   <p>Method run() will be called and returns the error code given, back
 281                   to the system. If the uno starter is executed with the -u (URL) option,
 282                   then XInitialization is used instead of XMain. The -u option is described
 283                   later.</p>
 284                   <p class="head2">Usage:</p>
 285                   <blockquote>
 286                   <b><code>uno (-c&lt;ComponentImplementationName&gt; -l &lt;LocationUrl&gt;
 287                     | -s &lt;ServiceName&gt;) <br/>
 288             [-u uno:(socket[,host=&lt;HostName&gt;][,port=&lt;nnn&gt;]|pipe[,name=&lt;PipeName&gt;]);iiop|urp;&lt;Name&gt;<br/>
 289             [--singleaccept] [--singleinstance]] <br/>
 290             [-- &lt;Argument1 Argument2 ...&gt;]
 291           </code></b>
 292                   </blockquote>
 293                   <p class="head2">Options:</p>
 294                   <table class="table4">
 295           <tr>
 296             <td class="cell15"><code>&lt;HostName&gt;</code></td>
 297             <td class="cell85">Specifying a host name might be necessary to
 298                         distinguish the network interface to be used,if a machine is part of
 299                         two networks.</td>
 300           </tr>
 301           <tr>
 302             <td class="cell15"><code>&lt;PipeName&gt;</code></td>
 303             <td class="cell85">Name of a named pipe.</td>
 304           </tr>
 305           <tr>
 306             <td class="cell15"><code>&lt;Name&gt;</code></td>
 307             <td class="cell85">Identifier for demanded called component
 308                         instances.</td>
 309           </tr>
 310           <tr>
 311             <td class="cell15"><code>--singleaccept</code></td>
 312             <td class="cell85">The uno starter will accept one connection,
 313                         provide the component instance and die.</td>
 314           </tr>
 315           <tr>
 316             <td class="cell15"><code>--singleinstance</code></td>
 317             <td class="cell85">The uno starter will accept any number of
 318                         connections, but will provide the same single component instance any
 319                         time instead of creating a new instance for each connection.</td>
 320           </tr>
 321           </table>
 322                   <p><b>Service <a href="%DOXYGEN_PREFIX1%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1bridge_1_1UnoUrlResolver.html" title="link into the IDL reference to the service com.sun.star.bridge.UnoUrlResolver">com.sun.star.bridge.UnoUrlResolver</a></b></p>
 323                   <p>You can easily connect to a server started with the
 324                   <code>-u (url)</code> option by using this service, giving the same url
 325                   to resolve. The service provides you an instance from remote.</p>
 326                   </td>
 327                 </tr>
 328       </table>
 329     </td>
 330     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 331   </tr>
 332   <tr>
 333     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 334   </tr>
 335   <tr>
 336     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 337     <td>
 338       <table class="table2">
 339         <tr>
 340                   <td colspan="2" class="head1"><a name="idlc"/>idlc</td>
 341                   <td align="right">
 342                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 343                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 344                   </td>
 345         </tr>
 346                 <tr>
 347                   <td colspan="3">
 348                   <p>'idlc' is the UNOIDL compiler.  It is a full featured compiler used
 349                   to check UNODL type definitions and transform valid type definitions
 350                   into a binary type library format, which is later used by all codemaker
 351                   tools. It is also used as a dynamic type library for UNO at runtime.<br/>
 352                   You can find a syntax description for UNOIDL <a href="http://wiki.openoffice.org/wiki/Documentation/DevGuide/AppendixD/UNOIDL_Syntax_Specification" title="link to the &quot;UNOIDL Syntax Specification&quot; chapter in the Developer's Guide">here</a>.</p>
 353                   <p class="head2">Usage:</p>
 354                   <blockquote>
 355                   <b><code>idlc [-options] file_1 ... file_n | @&lt;filename&gt;</code></b>
 356                   </blockquote>
 357                   <table class="table4">
 358                   <tr>
 359             <td class="cell15"><code>file_1 ... file_n</code></td>
 360                         <td class="cell85">specifies one or more idl files. Only files with
 361                         the extension '.idl' are valid.</td>
 362           </tr>
 363                   <tr>
 364             <td class="cell15"><code>@&lt;filename&gt;</code></td>
 365                         <td class="cell85">filename specifies the name of a command
 366                         file.</td>
 367           </tr>
 368                   </table>
 369                   <p class="head2">Options:</p>
 370                   <table class="table4">
 371                   <tr>
 372             <td class="cell15"><code>-O&lt;path&gt;</code></td>
 373                         <td class="cell85">path describes the output directory. The
 374                         generated output is a registry file with the same name as the idl
 375                         input file.</td>
 376           </tr>
 377           <tr>
 378                     <td class="cell15"><code>-I&lt;path&gt;</code></td>
 379                         <td class="cell85">path specifies a directory where included files
 380                         that will be searched by the preprocessor are located. Multiple
 381                         directories can be combined with ';'.</td>
 382           </tr>
 383                   <tr>
 384             <td class="cell15"><code>-D&lt;name&gt;</code></td>
 385                         <td class="cell85">name defines a macro for the preprocessor.</td>
 386           </tr>
 387                   <tr>
 388             <td class="cell15"><code>-C</code></td>
 389                         <td class="cell85">generates complete type information, including
 390                         additional service information and documentation.</td>
 391           </tr>
 392                   <tr>
 393             <td class="cell15"><code>-h|?</code></td>
 394                         <td class="cell85">print this help message and exit.</td>
 395           </tr>
 396                   </table>
 397                   </td>
 398                 </tr>
 399       </table>
 400     </td>
 401     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 402   </tr>
 403   <tr>
 404     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 405   </tr>
 406   <tr>
 407     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 408     <td>
 409       <table class="table2">
 410         <tr>
 411                   <td colspan="2" class="head1"><a name="cppumaker"/>cppumaker</td>
 412                   <td align="right">
 413                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 414                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 415                   </td>
 416         </tr>
 417                 <tr>
 418                   <td colspan="3">
 419                   <p>The 'cppumaker' generates a C++ representation for idl types. The
 420                   cppumaker works on a typelibrary, which is generated by the UNOIDL
 421                   compiler (<a href="#idlc" title="link to the idlc tool description">
 422                   idlc</a>). It generates the output for all specified types and for all
 423                   types the specified types depend on.</p>
 424                   <p class="head2">Usage:</p>
 425                   <blockquote>
 426                   <b><code>cppumaker [-options] file_1 ... file_n</code></b>
 427                   </blockquote>
 428                   <p class="head2">Options:</p>
 429                   <table class="table4">
 430                   <tr>
 431             <td class="cell15"><code>-O&lt;path&gt;</code></td>
 432                         <td class="cell85">path describes the root directory for the
 433                         generated output. The output directory tree is generated under this
 434                         directory.</td>
 435           </tr>
 436                   <tr>
 437             <td class="cell15"><code>-T&lt;name&gt;<br/>
 438                         |-T&lt;t1&gt;;&lt;t2&gt;...</code></td>
 439                         <td class="cell85">name specifies a type or a list of types. The
 440                         output for this type and all dependent types are generated. If no '-T'
 441                         option is specified, then output for all types is generated. It is also
 442                         possible to use a wildcard 'xy.*' to generate a complete module
 443                         inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
 444                         option. Example: 'com.sun.star.uno.XInterface' or
 445                         'com.sun.star.uno.*' are valid types.
 446                         </td>
 447           </tr>
 448                   <tr>
 449             <td class="cell15"><code>-B&lt;name&gt;</code></td>
 450                         <td class="cell85">name specifies the base node. All types are
 451                         searched under this node. Default is the root '/' of the registry
 452                         files.
 453                         <br/>
 454                         <i>This option has been removed in LibreOffice 4.1.</i>
 455                         </td>
 456           </tr>
 457                   <tr>
 458             <td class="cell15"><code>-L</code></td>
 459                         <td class="cell85">UNO type functions are generated lightweight, that
 460                         means only the name and typeclass are given and everything else is
 461                         retrieved from the type library dynamically. The default is that UNO
 462                         type functions provides enough type information for bootstrapping C++.
 463                         '-L' should be the default for external components.</td>
 464           </tr>
 465                   <tr>
 466             <td class="cell15"><code>-C</code></td>
 467                         <td class="cell85">UNO type functions are generated comprehensive
 468                         that means all necessary information is available for bridging the
 469                         type in UNO.
 470             </td>
 471           </tr>
 472                   <tr>
 473             <td class="cell15"><code>-G</code></td>
 474                         <td class="cell85">generate only target files which do not
 475                         exist.</td>
 476           </tr>
 477           <tr>
 478             <td class="cell15"><code>-Gc</code></td>
 479                         <td class="cell85">generate only target files whose content will
 480                         be changed.</td>
 481                   </tr>
 482                   <tr>
 483             <td class="cell15"><code>-X&lt;name&gt;</code></td>
 484                         <td class="cell85">extra types, which are not be taken into account
 485                         for generation.</td>
 486           </tr>
 487                   </table>
 488                   </td>
 489                 </tr>
 490       </table>
 491     </td>
 492     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 493   </tr>
 494   <tr>
 495     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 496   </tr>
 497   <tr>
 498     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 499     <td>
 500       <table class="table2">
 501         <tr>
 502                   <td colspan="2" class="head1"><a name="javamaker"/>javamaker</td>
 503                   <td align="right">
 504                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 505                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 506                   </td>
 507         </tr>
 508                 <tr>
 509                   <td colspan="3">
 510                   <p>The 'javamaker' generates the appropriate Java class file for each idl
 511                   type. The javamaker works on a typelibrary which is generated by the
 512                   UNOIDL compiler (<a href="#idlc" title="link to the idlc tool description">
 513                   idlc</a>). It generates the output for all specified types and for all
 514 types the specified types depend on.</p>
 515                   <p class="head2">Usage:</p>
 516                   <blockquote>
 517                   <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b>
 518                   </blockquote>
 519                   <p class="head2">Options:</p>
 520                   <table class="table4">
 521                   <tr>
 522             <td class="cell15"><code>-O&lt;path&gt;</code></td>
 523                         <td class="cell85">path describes the root directory for the
 524                         generated output. The output directory tree is generated under this
 525                         directory.</td>
 526           </tr>
 527                   <tr>
 528             <td class="cell15"><code>-T&lt;name&gt;|-T&lt;t1&gt;;&lt;t2&gt;...</code></td>
 529                         <td class="cell85">name specifies a type or a list of types. The
 530                         output for this type and all dependent types are generated. If no '-T'
 531                         option is specified, then output for all types is generated. It is also
 532                         possible to use a wildcard 'xy.*' to generate a complete module
 533                         inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
 534                         option. Example: 'com.sun.star.uno.XInterface'
 535                         or 'com.sun.star.uno.*' are valid types.
 536             </td>
 537           </tr>
 538                   <tr>
 539                     <td class="cell15"><code>-B&lt;name&gt;</code></td>
 540                         <td class="cell85">name specifies the base node. All types are
 541                         searched under this node. Default is the root '/' of the registry
 542                         files.
 543                         <br/>
 544                         <i>This option has been removed in LibreOffice 4.1.</i>
 545                         </td>
 546           </tr>
 547           <tr>
 548             <td class="cell15"><code>-nD</code></td>
 549                         <td class="cell85">no dependent types are generated.</td>
 550           </tr>
 551                   <tr>
 552             <td class="cell15"><code>-G</code></td>
 553                         <td class="cell85">generate only target files which do not
 554                         exist.</td>
 555           </tr>
 556                   <tr>
 557             <td class="cell15"><code>-Gc</code></td>
 558                         <td class="cell85">generate only target files whose content will
 559                         be changed.</td>
 560           </tr>
 561           <tr>
 562             <td class="cell15"><code>-X&lt;name&gt;</code></td>
 563                         <td class="cell85">extra types, which will not be taken into account
 564                         for generation.</td>
 565           </tr>
 566                   </table>
 567                   </td>
 568                 </tr>
 569       </table>
 570     </td>
 571     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 572   </tr>
 573   <tr>
 574     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 575   </tr>
 576   <tr>
 577     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 578     <td>
 579       <table class="table2">
 580         <tr>
 581                   <td colspan="2" class="head1"><a name="climaker"/>climaker</td>
 582                   <td align="right">
 583                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 584                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 585                   </td>
 586         </tr>
 587                 <tr>
 588                   <td colspan="3">
 589                   <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl
 590                   type. The climaker works on a typelibrary which is generated by the
 591                   UNOIDL compiler (<a href="#idlc" title="link to the idlc tool description">
 592                   idlc</a>). It generates the output for all specified types and for all
 593                     types the specified types depend on.</p>
 594                   <p class="head2">Usage:</p>
 595                   <blockquote>
 596                   <b><code>climaker &lt;switches&gt; [registry-file-1 registry-file-2 ...]</code></b>
 597                   </blockquote>
 598                   <p class="head2">Options:</p>
 599                   <table class="table4">
 600                   <tr>
 601                     <td class="cell15"><code>-O, --out &lt;output_file&gt;</code></td>
 602                     <td class="cell85">output assembly file;<br/>
 603                       defaults to cli_unotypes.dll if more than one registry-file is given, else &lt;registry-file&gt;.dll</td>
 604                   </tr>
 605                   <tr>
 606                     <td class="cell15"><code>-T, --types &lt;type1[;type2;...]&gt;</code></td>
 607                     <td class="cell85">types to be generated (if none is given,
 608                       then all types of given registries are emitted</td>
 609                   </tr>
 610                   <tr>
 611                     <td class="cell15"><code>-X, --extra &lt;rdb-file&gt;></code></td>
 612                     <td class="cell85">additional rdb to saturate referenced types in
 613                       given registry file(s); these types will not be
 614                       emitted into the output assembly file</td>
 615                   </tr>
 616                   <tr>
 617                     <td class="cell15"><code>-r, --reference &lt;assembly-file&gt;</code></td>
 618                     <td class="cell85">reference metadata from assembly file</td>
 619                   </tr>
 620                   <tr>
 621                     <td class="cell15"><code>-k, --keyfile</code></td>
 622                     <td class="cell85">keyfile needed for strong name</td>
 623                   </tr>
 624                   <tr>
 625                     <td class="cell15"><code>--assembly-version &lt;version&gt;</code></td>
 626                     <td class="cell85">sets assembly version</td>
 627                   </tr>
 628                   <tr>
 629                     <td class="cell15"><code>--assembly-description &lt;text&gt;</code></td>
 630                     <td class="cell85">sets assembly description text</td>
 631                   </tr>
 632                   <tr>
 633                     <td class="cell15"><code>--assembly-product &lt;text&gt;</code></td>
 634                     <td class="cell85">sets assembly product name</td>
 635                   </tr>
 636                   <tr>
 637                     <td class="cell15"><code>--assembly-company &lt;text&gt;</code></td>
 638                     <td class="cell85">sets assembly company</td>
 639                   </tr>
 640                   <tr>
 641                     <td class="cell15"><code>--assembly-copyright &lt;text&gt;</code></td>
 642                     <td class="cell85">sets assembly copyright</td>
 643                   </tr>
 644                   <tr>
 645                     <td class="cell15"><code>--assembly-trademark &lt;text&gt;</code></td>
 646                     <td class="cell85">sets assembly trademark</td>
 647                   </tr>
 648                   <tr>
 649                     <td class="cell15"><code>-v, --verbose</code></td>
 650                     <td class="cell85">verbose output to stdout</td>
 651                   </tr>
 652                   <tr>
 653                     <td class="cell15"><code>-h, --help</code></td>
 654                     <td class="cell85">this message</td>
 655                   </tr>
 656
 657                   </table>
 658                   <p><b>Example:</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb</code></p>
 659                   </td>
 660                 </tr>
 661       </table>
 662     </td>
 663     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 664   </tr>
 665   <tr>
 666     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 667   </tr>
 668   <tr>
 669     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 670     <td>
 671       <table class="table2">
 672         <tr>
 673                   <td colspan="2" class="head1"><a name="uno-skeletonmaker"/>uno-skeletonmaker</td>
 674                   <td align="right">
 675                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 676                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 677                   </td>
 678         </tr>
 679                 <tr>
 680                   <td colspan="3">
 681                   <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>
 682                   <p class="head2">Usage:</p>
 683                   <blockquote>
 684                   <b><code>
 685                         uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) dump [&lt;options>] -t &lt;type&gt; ...<br/>
 686                         uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) component [&lt;options&gt;] -n &lt;name&gt; -t &lt;type&gt; ...<br/>
 687                         uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) calc-add-in [&lt;options&gt;] -n &lt;name&gt; -t &lt;add-in_service&gt;<br/>
 688                         uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) add-on [&lt;options&gt;] -n &lt;name&gt; -p &lt;protocol_name:command,...&gt;
 689                         uno-skeletonmaker -V, --version<br/>
 690                         uno-skeletonmaker -h, --help<br/>
 691                   </code></b>
 692                   </blockquote>
 693                   <p class="head2">Sub-commands:</p>
 694                   <table class="table4">
 695                   <tr>
 696                     <td class="cell15"><code>dump</code></td>
 697                     <td class="cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.</td>
 698                   </tr>
 699                   <tr>
 700                     <td class="cell15"><code>component</code></td>
 701                     <td class="cell85">generates language specific code skeleton files using the implementation name as the file and class name</td>
 702                   </tr>
 703                   <tr>
 704                     <td class="cell15"><code>calc-add-in</code></td>
 705                     <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>
 706                   </tr>
 707                   <tr>
 708                     <td class="cell15"><code>add-on</code></td>
 709                     <td class="cell85">generates a language specific code skeleton for an add-on component 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>
 710                   </tr>
 711                   </table>
 712                   <p class="head2">Options:</p>
 713                   <table class="table4">
 714                   <tr>
 715             <td class="cell15"><code>-env:INIFILENAME=&lt;url&gt;</code></td>
 716                         <td class="cell85">url specifies a URL to a UNO ini|rc file of an existing UNO environment (URE, office installation).</td>
 717           </tr>
 718                   <tr>
 719                     <td class="cell15"><code>-a, --all</code></td>
 720                         <td class="cell85">list all interface methods, not only the direct ones</td>
 721           </tr>
 722           <tr>
 723             <td class="cell15"><code>--(java5|cpp)</code></td>
 724                         <td class="cell85">select the target language<br/>
 725                         --java5 generate output for Java 1.5 or later (is currently the default)<br/>
 726                         --cpp generate output for C++</td>
 727           </tr>
 728                   <tr>
 729             <td class="cell15"><code>-sn, --shortnames</code></td>
 730                         <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>
 731           </tr>
 732                   <tr>
 733             <td class="cell15"><code>--propertysetmixin</code></td>
 734                         <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>
 735           </tr>
 736           <tr>
 737             <td class="cell15"><code>-lh, --licenseheader</code></td>
 738                         <td class="cell85">generates a default LibreOffice MPLv2 license header at the beginning of a component source file. This option is taken into account in 'component' mode only and if -o is unequal 'stdout'.</td>
 739           </tr>
 740           <tr>
 741             <td class="cell15"><code>-bc,<br>--backward-compatible</code></td>
 742                         <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>
 743           </tr>
 744           <tr>
 745             <td class="cell15"><code>-o &lt;path&gt;</code></td>
 746                         <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>
 747           </tr>
 748           <tr>
 749             <td class="cell15"><code>-l &lt;file&gt;</code></td>
 750                         <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>
 751           </tr>
 752           <tr>
 753             <td class="cell15"><code>-n &lt;name&gt;</code></td>
 754                         <td class="cell85">specifies an implementation name for the component (used as classname, filename and package|namespace name). In 'dump' mode it is used as classname (e.g. &quot;MyBase::&quot;, C++ only) to generate method bodies not inline.</td>
 755           </tr>
 756           <tr>
 757             <td class="cell15"><code>-d &lt;name&gt;</code></td>
 758                         <td class="cell85">specifies a base classname or a delegator. In 'dump' mode it is used as a delegator to forward methods. It can be used as '&lt;name&gt;::' for base forwarding, or '&lt;name&gt;-&gt;|.' for composition. Using &quot;_&quot; means that a default bodies with default return values are dumped.</td>
 759           </tr>
 760           <tr>
 761             <td class="cell15"><code>-t &lt;name&gt;</code></td>
 762                         <td class="cell85">specifies a UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).</td>
 763           </tr>
 764           <tr>
 765             <td class="cell15"><code>-p &lt;protocol:cmd(s)&gt;</code></td>
 766                         <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>
 767           </tr>
 768           <tr>
 769             <td class="cell15"><code>-V, --version</code></td>
 770                         <td class="cell85">print version number and exit.</td>
 771           </tr>
 772           <tr>
 773             <td class="cell15"><code>-h, --help</code></td>
 774                         <td class="cell85">print this help and exit.</td>
 775           </tr>
 776                   </table>
 777                   </td>
 778                 </tr>
 779       </table>
 780     </td>
 781     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 782   </tr>
 783   <tr>
 784     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 785   </tr>
 786   <tr>
 787     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 788     <td>
 789       <table class="table2">
 790         <tr>
 791                   <td colspan="2" class="head1"><a name="regmerge"/>regmerge</td>
 792                   <td align="right">
 793                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 794                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 795                   </td>
 796         </tr>
 797                 <tr>
 798                   <td colspan="3">
 799                   <p>'regmerge' is a small tool to merge different registry files under a
 800                   specified key into another registry file. If a value already exists in
 801                   the target file the value is overwritten by the value of the source
 802                   file.</p>
 803                   <p class="head2">Usage:</p>
 804                   <blockquote>
 805                   <b><code>regmerge [-v|--verbose] &lt;mergefile&gt; &lt;mergeKeyName&gt; &lt;regfile_1&gt; ... &lt;regfile_n&gt;</code></b>
 806                   </blockquote>
 807                   <p class="head2">Options:</p>
 808                   <table class="table4">
 809                   <tr>
 810             <td class="cell15"><code>-v|--verbose</code></td>
 811                         <td class="cell85">verbose output on stdout.</td>
 812           </tr>
 813                   <tr>
 814             <td class="cell15"><code>&lt;mergefile&gt;</code></td>
 815                         <td class="cell85">specifies the merged registry file. If this file
 816                         doesn't exist, it is created.</td>
 817                   </tr>
 818                   <tr>
 819             <td class="cell15"><code>&lt;mergeKeyName&gt;</code></td>
 820                         <td class="cell85">specifies the merge key, everything is merged
 821                         under this key. If this key doesn't exist, it is created.</td>
 822           </tr>
 823                   <tr>
 824             <td class="cell15"><code>&lt;regfile_1&gt; ... &lt;regfile_n&gt;</code></td>
 825                         <td class="cell85">specifies one or more registry files that are
 826                         merged.</td>
 827                   </tr>
 828                   </table>
 829                   </td>
 830                 </tr>
 831       </table>
 832     </td>
 833     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 834   </tr>
 835   <tr>
 836     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 837   </tr>
 838   <tr>
 839     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 840     <td>
 841       <table class="table2">
 842         <tr>
 843                   <td colspan="2" class="head1"><a name="regview"/>regview</td>
 844                   <td align="right">
 845                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 846                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 847                   </td>
 848         </tr>
 849                 <tr>
 850                   <td colspan="3">
 851                   <p>'regview' is a tool to show the contents of a registry file. The tool
 852                   dumps the hierarchical structure and the values of the nodes in a human
 853                   readable manner to stdout.</p>
 854                   <p class="head2">Usage:</p>
 855                   <blockquote>
 856                   <b><code>regview &lt;registryfile&gt; [&lt;keyName&gt;]</code></b>
 857                   </blockquote>
 858                   <p class="head2">Options:</p>
 859                   <table class="table4">
 860                   <tr>
 861             <td class="cell15"><code>-br&lt;registryfile&gt;</code></td>
 862                         <td class="cell85">the name of the registry whose contents should
 863                         be viewed.</td>
 864           </tr>
 865                   <tr>
 866             <td class="cell15"><code>&lt;keyName&gt;</code></td>
 867                         <td class="cell85">the name of a registry key. The name must be
 868                         fully qualified; for example, '/' means the root key and
 869                         '/UCR/com/sun/star/uno/XInterface' shows the type specification of the
 870                         XInterface type. If no key is specified, the tool dumps the whole
 871                         content of the registry file.</td>
 872                   </tr>
 873                   </table>
 874                   </td>
 875                 </tr>
 876       </table>
 877     </td>
 878     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 879   </tr>
 880   <tr>
 881     <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
 882   </tr>
 883   <tr>
 884     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 885     <td>
 886       <table class="table2">
 887         <tr>
 888                   <td colspan="2" class="head1"><a name="autodoc"/>autodoc</td>
 889                   <td align="right">
 890                     <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
 891                     <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
 892                   </td>
 893         </tr>
 894                 <tr>
 895                   <td colspan="3">
 896                   <p>The legacy 'autodoc' tool was used for creating javadoc-like
 897           documentation from C++ and UNO IDL source code in previous versions
 898           of the SDK.</p>
 899           <p>Because this tool was buggy and unmaintained it has been removed
 900           from the SDK.  Users are advised to use
 901           <a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a> instead,
 902           which supports UNO IDL since April 2013.</p>
 903                   </td>
 904                 </tr>
 905       </table>
 906     </td>
 907     <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
 908   </tr>
 909 </table>
 910                 </div>
 911                 <div id="Footer">
 912                     <div id="FooterText">
 913                         <p>
 914                             Copyright © 2000–2019 LibreOffice contributors. All rights reserved.
 915                             <br/>
 916                             LibreOffice was created by The Document Foundation,
 917                             based on Apache OpenOffice, which is Copyright 2011,
 918                             The Apache Software Foundation.
 919                             <br/>
 920                             The Document Foundation acknowledges all community members, please find more info <a href="https://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.
 921                         </p>
 922                         <p>
 923                             &nbsp;
 924                         </p>
 925                         <p>
 926                             <a href="http://www.documentfoundation.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.documentfoundation.org/imprint" target="_blank">Impressum (Legal Info)</a>
 927                             | Copyright information: The source code of LibreOffice is licensed under the Mozilla Public License v2.0 (<a href="http://www.libreoffice.org/download/license/" target="_blank">MPLv2</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.
 928                         </p>
 929                     </div>
 930                 </div>
 931             </div>
 932         </div>
 933         </div>
 934     </body>
 935 </html>
 936