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