1122c3632SJürgen Schmidt<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> 2122c3632SJürgen Schmidt<!-- 3122c3632SJürgen Schmidt#************************************************************** 4122c3632SJürgen Schmidt# 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 12122c3632SJürgen Schmidt# 13122c3632SJürgen Schmidt# http://www.apache.org/licenses/LICENSE-2.0 14122c3632SJürgen Schmidt# 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. 21122c3632SJürgen Schmidt# 22122c3632SJürgen Schmidt#************************************************************** 23122c3632SJürgen Schmidt --> 24cdf0e10cSrcweir<html> 25cdf0e10cSrcweir<head> 26cdf0e10cSrcweir <title>OpenOffice.org %PRODUCT_RELEASE% SDK - Development Tools</title> 27cdf0e10cSrcweir <link rel="stylesheet" type="text/css" href="sdk_styles.css"> 28cdf0e10cSrcweir <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 29cdf0e10cSrcweir <meta name="author" content="Jürgen Schmidt"> 30cdf0e10cSrcweir</head> 31cdf0e10cSrcweir 32cdf0e10cSrcweir<body class="sdkbody"><a name="tools"/> 33cdf0e10cSrcweir<table class="table1" cellpadding=0> 34cdf0e10cSrcweir <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> 37cdf0e10cSrcweir <tr> 38cdf0e10cSrcweir <td colspan="3"><img class="nothing10" src="images/nada.gif"></td> 39cdf0e10cSrcweir </tr> 40cdf0e10cSrcweir <tr> 41cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 42cdf0e10cSrcweir <td> 43cdf0e10cSrcweir <table class="table2"> 44cdf0e10cSrcweir <tr> 45cdf0e10cSrcweir <td colspan="3"><img class="nothing1" src="images/nada.gif"></td> 46cdf0e10cSrcweir </tr> 47cdf0e10cSrcweir <tr> 48cdf0e10cSrcweir <td> 49cdf0e10cSrcweir <table class="table3"> 50cdf0e10cSrcweir <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> 53cdf0e10cSrcweir </tr> 54cdf0e10cSrcweir </table> 55cdf0e10cSrcweir </td> 56cdf0e10cSrcweir </tr> 57cdf0e10cSrcweir <tr> 58cdf0e10cSrcweir <td> 59cdf0e10cSrcweir <table class="table3"> 60cdf0e10cSrcweir <tr valign="top"> 61cdf0e10cSrcweir <td class="content3"><img src="images/arrow-1.gif"></td> 62cdf0e10cSrcweir <td><a href="#unopkg" title="link to the unopkg tool description">unopkg</a></td> 63cdf0e10cSrcweir <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> 69cdf0e10cSrcweir <td><a href="#unoexe" title="link to the uno tool description">uno</a></td> 70cdf0e10cSrcweir <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> 77cdf0e10cSrcweir <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td> 78cdf0e10cSrcweir <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> 83cdf0e10cSrcweir <td><a href="#regview" title="link to the regview tool description">regview</a></td> 84cdf0e10cSrcweir <td class="content87">Tool to view the content of a registry file 85cdf0e10cSrcweir 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> 88cdf0e10cSrcweir <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> 94cdf0e10cSrcweir <td class="content87">The UNOIDL compiler, generates a common 95cdf0e10cSrcweir 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> 101cdf0e10cSrcweir <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> 107cdf0e10cSrcweir <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> 113cdf0e10cSrcweir <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> 123cdf0e10cSrcweir <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> 128cdf0e10cSrcweir <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td> 129cdf0e10cSrcweir <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> 135cdf0e10cSrcweir <td class="content87">Tool to view the content of a registry file 136cdf0e10cSrcweir 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> 141cdf0e10cSrcweir <td><a href="#autodoc" title="link to the autodoc tool description">autodoc</a></td> 142cdf0e10cSrcweir <td class="content87">Tool to generate javadoc-like documentation 143cdf0e10cSrcweir for C/C++ and UNOIDL files.</td> 144cdf0e10cSrcweir </tr> 145cdf0e10cSrcweir </table> 146cdf0e10cSrcweir </td> 147cdf0e10cSrcweir </tr> 148cdf0e10cSrcweir </table> 149cdf0e10cSrcweir </td> 150cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 151cdf0e10cSrcweir </tr> 152cdf0e10cSrcweir <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> 157cdf0e10cSrcweir <td> 158cdf0e10cSrcweir <table class="table2"> 159cdf0e10cSrcweir <tr> 160cdf0e10cSrcweir <td colspan="2" class="head1"><a name="unopkg"/>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"> 167cdf0e10cSrcweir <p>'unopkg' is a tool for easy deployment of UNO packages in an existing 168cdf0e10cSrcweir office installation. UNO packages are UNO components (single libraries or 169cdf0e10cSrcweir Jar files or more complex zip files that contains one or more libraries| 170cdf0e10cSrcweir Jar files, type libraries and configuration items), scripts and 171cdf0e10cSrcweir OpenOffice.org %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the 172cdf0e10cSrcweir 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> 174cdf0e10cSrcweir <p>More details concerning deployment and this tool can be find in the 175cdf0e10cSrcweir Developer's Guide: <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the "Extension Manager - unopkg" chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p> 176cdf0e10cSrcweir <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> 203cdf0e10cSrcweir <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> 212cdf0e10cSrcweir <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> 239cdf0e10cSrcweir <td class="cell85">custom log file; default: 240cdf0e10cSrcweir <i><cache-dir>/log.txt</i>.</td> 241cdf0e10cSrcweir </tr> 242cdf0e10cSrcweir <tr> 243cdf0e10cSrcweir <td class="cell15"><code>--shared</code></td> 244cdf0e10cSrcweir <td class="cell85">expert feature: operate on shared installation 245cdf0e10cSrcweir deployment context; run only when no concurrent Office process(es) are 246cdf0e10cSrcweir running!</td> 247cdf0e10cSrcweir </tr> 248cdf0e10cSrcweir <tr> 249cdf0e10cSrcweir <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> 261cdf0e10cSrcweir <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> 266cdf0e10cSrcweir <td> 267cdf0e10cSrcweir <table class="table2"> 268cdf0e10cSrcweir <tr> 269cdf0e10cSrcweir <td colspan="2" class="head1"><a name="unoexe"/>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> 274cdf0e10cSrcweir </tr> 275cdf0e10cSrcweir <tr> 276cdf0e10cSrcweir <td colspan="3"> 277cdf0e10cSrcweir <p>The UNO-starter is for running a component or service process, and 278cdf0e10cSrcweir providing a runtime environment. Raising a component might look like 279cdf0e10cSrcweir this </p> 280cdf0e10cSrcweir <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb 281cdf0e10cSrcweir -- foo bar</code></p> 282cdf0e10cSrcweir <p>or</p> 283cdf0e10cSrcweir <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb 284cdf0e10cSrcweir -- foo bar</code></p> 285cdf0e10cSrcweir <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> 299cdf0e10cSrcweir <p>Method run() will be called and returns the error code given, back 300cdf0e10cSrcweir to the system. If the uno starter is executed with the -u (URL) option, 301cdf0e10cSrcweir 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> 318cdf0e10cSrcweir <td class="cell85">Specifying a host name might be necessary to 319cdf0e10cSrcweir 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> 328cdf0e10cSrcweir <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 337cdf0e10cSrcweir 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> 342cdf0e10cSrcweir <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> 347cdf0e10cSrcweir <td class="cell85">The uno starter will accept any number of 348cdf0e10cSrcweir 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> 353cdf0e10cSrcweir <p>You can easily connect to a server started with the 354cdf0e10cSrcweir <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 </p> 357cdf0e10cSrcweir </td> 358cdf0e10cSrcweir </tr> 359cdf0e10cSrcweir </table> 360cdf0e10cSrcweir </td> 361cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 362cdf0e10cSrcweir </tr> 363cdf0e10cSrcweir <tr> 364cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 365cdf0e10cSrcweir </tr> 366cdf0e10cSrcweir <tr> 367cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 368cdf0e10cSrcweir <td> 369cdf0e10cSrcweir <table class="table2"> 370cdf0e10cSrcweir <tr> 371cdf0e10cSrcweir <td colspan="2" class="head1"><a name="idlc"/>idlc</td> 372cdf0e10cSrcweir <td align="right"> 373cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 374cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 375cdf0e10cSrcweir </td> 376cdf0e10cSrcweir </tr> 377cdf0e10cSrcweir <tr> 378cdf0e10cSrcweir <td colspan="3"> 379cdf0e10cSrcweir <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used 380cdf0e10cSrcweir to check UNODL type definitions and transform valid type definitions 381cdf0e10cSrcweir into a binary type library format, which is later used by all codemaker 382cdf0e10cSrcweir tools. It is also used as a dynamic type library for UNO at runtime.<br> 383cdf0e10cSrcweir You can find a syntax description for UNOIDL <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixD/UNOIDL_Syntax_Specification" title="link to the "UNOIDL Syntax Specification" chapter in the Developer's Guide">here</a>.</p> 384cdf0e10cSrcweir <p class="head2">Usage:</p> 385cdf0e10cSrcweir <blockquote> 386cdf0e10cSrcweir <b><code>idlc [-options] file_1 ... file_n | @<filename></code></b> 387cdf0e10cSrcweir </blockquote> 388cdf0e10cSrcweir <p> 389cdf0e10cSrcweir <table class="table4"> 390cdf0e10cSrcweir <tr> 391cdf0e10cSrcweir <td class="cell15"><code>file_1 ... file_n</code></td> 392cdf0e10cSrcweir <td class="cell85">specifies one or more idl files. Only files with 393cdf0e10cSrcweir the extension '.idl' are valid.</td> 394cdf0e10cSrcweir </tr> 395cdf0e10cSrcweir <tr> 396cdf0e10cSrcweir <td class="cell15"><code>@<filename></code></td> 397cdf0e10cSrcweir <td class="cell85">filename specifies the name of a command 398cdf0e10cSrcweir file.</td> 399cdf0e10cSrcweir </tr> 400cdf0e10cSrcweir </table> 401cdf0e10cSrcweir </p> 402cdf0e10cSrcweir <p class="head2">Options:</p> 403cdf0e10cSrcweir <p> 404cdf0e10cSrcweir <table class="table4"> 405cdf0e10cSrcweir <tr> 406cdf0e10cSrcweir <td class="cell15"><code>-O<path></code></td> 407cdf0e10cSrcweir <td class="cell85">path describes the output directory. The 408cdf0e10cSrcweir generated output is a registry file with the same name as the idl 409cdf0e10cSrcweir input file.</td> 410cdf0e10cSrcweir </tr> 411cdf0e10cSrcweir <tr> 412cdf0e10cSrcweir <td class="cell15"><code>-I<path></code></td> 413cdf0e10cSrcweir <td class="cell85">path specifies a directory where included files 414cdf0e10cSrcweir that will be searched by the preprocessor are located. Multiple 415cdf0e10cSrcweir directories can be combined with ';'.</td> 416cdf0e10cSrcweir </tr> 417cdf0e10cSrcweir <tr> 418cdf0e10cSrcweir <td class="cell15"><code>-D<name></code></td> 419cdf0e10cSrcweir <td class="cell85">name defines a macro for the preprocessor.</td> 420cdf0e10cSrcweir </tr> 421cdf0e10cSrcweir <tr> 422cdf0e10cSrcweir <td class="cell15"><code>-C</code></td> 423cdf0e10cSrcweir <td class="cell85">generates complete type information, including 424cdf0e10cSrcweir additional service information and documentation.</td> 425cdf0e10cSrcweir </tr> 426cdf0e10cSrcweir <tr> 427cdf0e10cSrcweir <td class="cell15"><code>-h|?</code></td> 428cdf0e10cSrcweir <td class="cell85">print this help message and exit.</td> 429cdf0e10cSrcweir </tr> 430cdf0e10cSrcweir </table> 431cdf0e10cSrcweir </p> 432cdf0e10cSrcweir </td> 433cdf0e10cSrcweir </tr> 434cdf0e10cSrcweir </table> 435cdf0e10cSrcweir </td> 436cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 437cdf0e10cSrcweir </tr> 438cdf0e10cSrcweir <tr> 439cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 440cdf0e10cSrcweir </tr> 441cdf0e10cSrcweir <tr> 442cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 443cdf0e10cSrcweir <td> 444cdf0e10cSrcweir <table class="table2"> 445cdf0e10cSrcweir <tr> 446cdf0e10cSrcweir <td colspan="2" class="head1"><a name="cppumaker"/>cppumaker</td> 447cdf0e10cSrcweir <td align="right"> 448cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 449cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 450cdf0e10cSrcweir </td> 451cdf0e10cSrcweir </tr> 452cdf0e10cSrcweir <tr> 453cdf0e10cSrcweir <td colspan="3"> 454cdf0e10cSrcweir <p>The 'cppumaker' generates a C++ representation for idl types. The 455cdf0e10cSrcweir cppumaker works on a typelibrary, which is generated by the UNOIDL 456cdf0e10cSrcweir compiler (<a href="#idlc" link="link to the idlc tool description"> 457cdf0e10cSrcweir idlc</a>). It generates the output for all specified types and for all 458cdf0e10cSrcweir types the specified types depend on.</p> 459cdf0e10cSrcweir <p class="head2">Usage:</p> 460cdf0e10cSrcweir <blockquote> 461cdf0e10cSrcweir <b><code>cppumaker [-options] file_1 ... file_n</code></b> 462cdf0e10cSrcweir </blockquote> 463cdf0e10cSrcweir <p class="head2">Options:</p> 464cdf0e10cSrcweir <p> 465cdf0e10cSrcweir <table class="table4"> 466cdf0e10cSrcweir <tr> 467cdf0e10cSrcweir <td class="cell15"><code>-O<path></code></td> 468cdf0e10cSrcweir <td class="cell85">path describes the root directory for the 469cdf0e10cSrcweir generated output. The output directory tree is generated under this 470cdf0e10cSrcweir directory.</td> 471cdf0e10cSrcweir </tr> 472cdf0e10cSrcweir <tr> 473cdf0e10cSrcweir <td class="cell15"><code>-T<name><br> 474cdf0e10cSrcweir |-T<t1>;<t2>...</code></td> 475cdf0e10cSrcweir <td class="cell85">name specifies a type or a list of types. The 476cdf0e10cSrcweir output for this type and all dependent types are generated. If no '-T' 477cdf0e10cSrcweir option is specified, then output for all types is generated. It is also 478cdf0e10cSrcweir possible to use a wildcard 'xy.*' to generate a complete module 479cdf0e10cSrcweir inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' 480cdf0e10cSrcweir option. Example: 'com.sun.star.uno.XInterface' or 481cdf0e10cSrcweir 'com.sun.star.uno.*' are valid types. 482cdf0e10cSrcweir </td> 483cdf0e10cSrcweir </tr> 484cdf0e10cSrcweir <tr> 485cdf0e10cSrcweir <td class="cell15"><code>-B<name></code></td> 486cdf0e10cSrcweir <td class="cell85">name specifies the base node. All types are 487cdf0e10cSrcweir searched under this node. Default is the root '/' of the registry 488cdf0e10cSrcweir files.</td> 489cdf0e10cSrcweir </tr> 490cdf0e10cSrcweir <tr> 491cdf0e10cSrcweir <td class="cell15"><code>-L</code></td> 492cdf0e10cSrcweir <td class="cell85">UNO type functions are generated lightweight, that 493cdf0e10cSrcweir means only the name and typeclass are given and everything else is 494cdf0e10cSrcweir retrieved from the type library dynamically. The default is that UNO 495cdf0e10cSrcweir type functions provides enough type information for boostrapping C++. 496cdf0e10cSrcweir '-L' should be the default for external components.</td> 497cdf0e10cSrcweir </tr> 498cdf0e10cSrcweir <tr> 499cdf0e10cSrcweir <td class="cell15"><code>-C</code></td> 500cdf0e10cSrcweir <td class="cell85">UNO type functions are generated comprehensive 501cdf0e10cSrcweir that means all necessary information is available for bridging the 502cdf0e10cSrcweir type in UNO. 503cdf0e10cSrcweir </td> 504cdf0e10cSrcweir </tr> 505cdf0e10cSrcweir <tr> 506cdf0e10cSrcweir <td class="cell15"><code>-G</code></td> 507cdf0e10cSrcweir <td class="cell85">generate only target files which do not 508cdf0e10cSrcweir exist.</td> 509cdf0e10cSrcweir </tr> 510cdf0e10cSrcweir <tr> 511cdf0e10cSrcweir <td class="cell15"><code>-Gc</code></td> 512cdf0e10cSrcweir <td class="cell85">generate only target files whose content will 513cdf0e10cSrcweir be changed.</td> 514cdf0e10cSrcweir </tr> 515cdf0e10cSrcweir <tr> 516cdf0e10cSrcweir <td class="cell15"><code>-X<name></code></td> 517cdf0e10cSrcweir <td class="cell85">extra types, which are not be taken into account 518cdf0e10cSrcweir for generation.</td> 519cdf0e10cSrcweir </tr> 520cdf0e10cSrcweir </table> 521cdf0e10cSrcweir </p> 522cdf0e10cSrcweir </td> 523cdf0e10cSrcweir </tr> 524cdf0e10cSrcweir </table> 525cdf0e10cSrcweir </td> 526cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 527cdf0e10cSrcweir </tr> 528cdf0e10cSrcweir <tr> 529cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 530cdf0e10cSrcweir </tr> 531cdf0e10cSrcweir <tr> 532cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 533cdf0e10cSrcweir <td> 534cdf0e10cSrcweir <table class="table2"> 535cdf0e10cSrcweir <tr> 536cdf0e10cSrcweir <td colspan="2" class="head1"><a name="javamaker"/>javamaker</td> 537cdf0e10cSrcweir <td align="right"> 538cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 539cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 540cdf0e10cSrcweir </td> 541cdf0e10cSrcweir </tr> 542cdf0e10cSrcweir <tr> 543cdf0e10cSrcweir <td colspan="3"> 544cdf0e10cSrcweir <p>The 'javamaker' generates the appropriate Java class file for each idl 545cdf0e10cSrcweir type. The javamaker works on a typelibrary which is generated by the 546cdf0e10cSrcweir UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> 547cdf0e10cSrcweir idlc</a>). It generates the output for all specified types and for all 548cdf0e10cSrcweirtypes the specified types depend on.</p> 549cdf0e10cSrcweir <p class="head2">Usage:</p> 550cdf0e10cSrcweir <blockquote> 551cdf0e10cSrcweir <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b> 552cdf0e10cSrcweir </blockquote> 553cdf0e10cSrcweir <p class="head2">Options:</p> 554cdf0e10cSrcweir <p> 555cdf0e10cSrcweir <table class="table4"> 556cdf0e10cSrcweir <tr> 557cdf0e10cSrcweir <td class="cell15"><code>-O<path></code></td> 558cdf0e10cSrcweir <td class="cell85">path describes the root directory for the 559cdf0e10cSrcweir generated output. The output directory tree is generated under this 560cdf0e10cSrcweir directory.</td> 561cdf0e10cSrcweir </tr> 562cdf0e10cSrcweir <tr> 563cdf0e10cSrcweir <td class="cell15"><code>-T<name>|-T<t1>;<t2>...</code></td> 564cdf0e10cSrcweir <td class="cell85">name specifies a type or a list of types. The 565cdf0e10cSrcweir output for this type and all dependent types are generated. If no '-T' 566cdf0e10cSrcweir option is specified, then output for all types is generated. It is also 567cdf0e10cSrcweir possible to use a wildcard 'xy.*' to generate a complete module 568cdf0e10cSrcweir inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' 569cdf0e10cSrcweir option. Example: 'com.sun.star.uno.XInterface' 570cdf0e10cSrcweir or 'com.sun.star.uno.*' are valid types. 571cdf0e10cSrcweir </td> 572cdf0e10cSrcweir </tr> 573cdf0e10cSrcweir <tr> 574cdf0e10cSrcweir <td class="cell15"><code>-B<name></code></td> 575cdf0e10cSrcweir <td class="cell85">name specifies the base node. All types are 576cdf0e10cSrcweir searched under this node. Default is the root '/' of the registry 577cdf0e10cSrcweir files.</td> 578cdf0e10cSrcweir </tr> 579cdf0e10cSrcweir <tr> 580cdf0e10cSrcweir <td class="cell15"><code>-nD</code></td> 581cdf0e10cSrcweir <td class="cell85">no dependent types are generated.</td> 582cdf0e10cSrcweir </tr> 583cdf0e10cSrcweir <tr> 584cdf0e10cSrcweir <td class="cell15"><code>-G</code></td> 585cdf0e10cSrcweir <td class="cell85">generate only target files which do not 586cdf0e10cSrcweir exist.</td> 587cdf0e10cSrcweir </tr> 588cdf0e10cSrcweir <tr> 589cdf0e10cSrcweir <td class="cell15"><code>-Gc</code></td> 590cdf0e10cSrcweir <td class="cell85">generate only target files whose content will 591cdf0e10cSrcweir be changed.</td> 592cdf0e10cSrcweir </tr> 593cdf0e10cSrcweir <tr> 594cdf0e10cSrcweir <td class="cell15"><code>-X<name></code></td> 595cdf0e10cSrcweir <td class="cell85">extra types, which will not be taken into account 596cdf0e10cSrcweir for generation.</td> 597cdf0e10cSrcweir </tr> 598cdf0e10cSrcweir </table> 599cdf0e10cSrcweir </p> 600cdf0e10cSrcweir </td> 601cdf0e10cSrcweir </tr> 602cdf0e10cSrcweir </table> 603cdf0e10cSrcweir </td> 604cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 605cdf0e10cSrcweir </tr> 606cdf0e10cSrcweir <tr> 607cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 608cdf0e10cSrcweir </tr> 609cdf0e10cSrcweir <tr> 610cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 611cdf0e10cSrcweir <td> 612cdf0e10cSrcweir <table class="table2"> 613cdf0e10cSrcweir <tr> 614cdf0e10cSrcweir <td colspan="2" class="head1"><a name="climaker"/>climaker</td> 615cdf0e10cSrcweir <td align="right"> 616cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 617cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 618cdf0e10cSrcweir </td> 619cdf0e10cSrcweir </tr> 620cdf0e10cSrcweir <tr> 621cdf0e10cSrcweir <td colspan="3"> 622cdf0e10cSrcweir <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl 623cdf0e10cSrcweir type. The climaker works on a typelibrary which is generated by the 624cdf0e10cSrcweir UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> 625cdf0e10cSrcweir idlc</a>). It generates the output for all specified types and for all 626cdf0e10cSrcweir types the specified types depend on.</p> 627cdf0e10cSrcweir <p class="head2">Usage:</p> 628cdf0e10cSrcweir <blockquote> 629cdf0e10cSrcweir <b><code>climaker <switches> [registry-file-1 registry-file-2 ...]</code></b> 630cdf0e10cSrcweir </blockquote> 631cdf0e10cSrcweir <p class="head2">Options:</p> 632cdf0e10cSrcweir <p> 633cdf0e10cSrcweir <table class="table4"> 634cdf0e10cSrcweir <tr> 635cdf0e10cSrcweir <td class="cell15"><code>-O, --out <output_file></code></td> 636cdf0e10cSrcweir <td class="cell85">output assembly file;<br> 637cdf0e10cSrcweir defaults to cli_unotypes.dll if more than one registry-file is given, else <registry-file>.dll</td> 638cdf0e10cSrcweir </tr> 639cdf0e10cSrcweir <tr> 640cdf0e10cSrcweir <td class="cell15"><code>-T, --types <type1[;type2;...]></code></td> 641cdf0e10cSrcweir <td class="cell85">types to be generated (if none is given, 642cdf0e10cSrcweir then all types of given registries are emitted</td> 643cdf0e10cSrcweir </tr> 644cdf0e10cSrcweir <tr> 645cdf0e10cSrcweir <td class="cell15"><code>-X, --extra <rdb-file>></code></td> 646cdf0e10cSrcweir <td class="cell85">additional rdb to saturate referenced types in 647cdf0e10cSrcweir given registry file(s); these types will not be 648cdf0e10cSrcweir emitted into the output assembly file</td> 649cdf0e10cSrcweir </tr> 650cdf0e10cSrcweir <tr> 651cdf0e10cSrcweir <td class="cell15"><code>-r, --reference <assembly-file></code></td> 652cdf0e10cSrcweir <td class="cell85">reference metadata from assembly file</td> 653cdf0e10cSrcweir </tr> 654cdf0e10cSrcweir <tr> 655cdf0e10cSrcweir <td class="cell15"><code>-k, --keyfile</code></td> 656cdf0e10cSrcweir <td class="cell85">keyfile needed for strong name</td> 657cdf0e10cSrcweir </tr> 658cdf0e10cSrcweir <tr> 659cdf0e10cSrcweir <td class="cell15"><code>--assembly-version <version></code></td> 660cdf0e10cSrcweir <td class="cell85">sets assembly version</td> 661cdf0e10cSrcweir </tr> 662cdf0e10cSrcweir <tr> 663cdf0e10cSrcweir <td class="cell15"><code>--assembly-description <text></code></td> 664cdf0e10cSrcweir <td class="cell85">sets assembly description text</td> 665cdf0e10cSrcweir </tr> 666cdf0e10cSrcweir <tr> 667cdf0e10cSrcweir <td class="cell15"><code>--assembly-product <text></code></td> 668cdf0e10cSrcweir <td class="cell85">sets assembly product name</td> 669cdf0e10cSrcweir </tr> 670cdf0e10cSrcweir <tr> 671cdf0e10cSrcweir <td class="cell15"><code>--assembly-company <text></code></td> 672cdf0e10cSrcweir <td class="cell85">sets assembly company</td> 673cdf0e10cSrcweir </tr> 674cdf0e10cSrcweir <tr> 675cdf0e10cSrcweir <td class="cell15"><code>--assembly-copyright <text></code></td> 676cdf0e10cSrcweir <td class="cell85">sets assembly copyright</td> 677cdf0e10cSrcweir </tr> 678cdf0e10cSrcweir <tr> 679cdf0e10cSrcweir <td class="cell15"><code>--assembly-trademark <text></code></td> 680cdf0e10cSrcweir <td class="cell85">sets assembly trademark</td> 681cdf0e10cSrcweir </tr> 682cdf0e10cSrcweir <tr> 683cdf0e10cSrcweir <td class="cell15"><code>-v, --verbose</code></td> 684cdf0e10cSrcweir <td class="cell85">verbose output to stdout</td> 685cdf0e10cSrcweir </tr> 686cdf0e10cSrcweir <tr> 687cdf0e10cSrcweir <td class="cell15"><code>-h, --help</code></td> 688cdf0e10cSrcweir <td class="cell85">this message</td> 689cdf0e10cSrcweir </tr> 690cdf0e10cSrcweir 691cdf0e10cSrcweir </table> 692cdf0e10cSrcweir </p> 693cdf0e10cSrcweir <p><b>Example:</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb</code></p> 694cdf0e10cSrcweir </td> 695cdf0e10cSrcweir </tr> 696cdf0e10cSrcweir </table> 697cdf0e10cSrcweir </td> 698cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 699cdf0e10cSrcweir </tr> 700cdf0e10cSrcweir <tr> 701cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 702cdf0e10cSrcweir </tr> 703cdf0e10cSrcweir <tr> 704cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 705cdf0e10cSrcweir <td> 706cdf0e10cSrcweir <table class="table2"> 707cdf0e10cSrcweir <tr> 708cdf0e10cSrcweir <td colspan="2" class="head1"><a name="uno-skeletonmaker"/>uno-skeletonmaker</td> 709cdf0e10cSrcweir <td align="right"> 710cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 711cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 712cdf0e10cSrcweir </td> 713cdf0e10cSrcweir </tr> 714cdf0e10cSrcweir <tr> 715cdf0e10cSrcweir <td colspan="3"> 716cdf0e10cSrcweir <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> 717cdf0e10cSrcweir <p class="head2">Usage:</p> 718cdf0e10cSrcweir <blockquote> 719cdf0e10cSrcweir <b><code> 720cdf0e10cSrcweir uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) dump [<options>] -t <type> ...<br> 721cdf0e10cSrcweir uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) component [<options>] -n <name> -t <type> ...<br> 722cdf0e10cSrcweir uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) calc-add-in [<options>] -n <name> -t <add-in_service><br> 723cdf0e10cSrcweir uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) add-on [<options>] -n <name> -p <protocol_name:command,...> 724cdf0e10cSrcweir uno-skeletonmaker -V, --version<br> 725cdf0e10cSrcweir uno-skeletonmaker -h, --help<br> 726cdf0e10cSrcweir </code></b> 727cdf0e10cSrcweir </blockquote> 728cdf0e10cSrcweir <p class="head2">Sub-commands:</p> 729cdf0e10cSrcweir <p> 730cdf0e10cSrcweir <table class="table4"> 731cdf0e10cSrcweir <tr> 732cdf0e10cSrcweir <td class="cell15"><code>dump</code></td> 733cdf0e10cSrcweir <td class="cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.</td> 734cdf0e10cSrcweir </tr> 735cdf0e10cSrcweir <tr> 736cdf0e10cSrcweir <td class="cell15"><code>component</code></td> 737cdf0e10cSrcweir <td class="cell85">generates language specific code skeleton files using the implementation name as the file and class name</td> 738cdf0e10cSrcweir </tr> 739cdf0e10cSrcweir <tr> 740cdf0e10cSrcweir <td class="cell15"><code>calc-add-in</code></td> 741cdf0e10cSrcweir <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> 742cdf0e10cSrcweir </tr> 743cdf0e10cSrcweir <tr> 744cdf0e10cSrcweir <td class="cell15"><code>add-on</code></td> 745cdf0e10cSrcweir <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> 746cdf0e10cSrcweir </tr> 747cdf0e10cSrcweir </table> 748cdf0e10cSrcweir </p> 749cdf0e10cSrcweir <p class="head2">Options:</p> 750cdf0e10cSrcweir <p> 751cdf0e10cSrcweir <table class="table4"> 752cdf0e10cSrcweir <tr> 753cdf0e10cSrcweir <td class="cell15"><code>-env:INIFILENAME=<url></code></td> 754cdf0e10cSrcweir <td class="cell85">url specifies a URL to an UNO ini|rc file of an existing UNO environment (URE, office installation).</td> 755cdf0e10cSrcweir </tr> 756cdf0e10cSrcweir <tr> 757cdf0e10cSrcweir <td class="cell15"><code>-env:UNO_TYPES=<url></code></td> 758cdf0e10cSrcweir <td class="cell85">url specifies a binary type library file. It can be a space separated list of urls.</td> 759cdf0e10cSrcweir </tr> 760cdf0e10cSrcweir <tr> 761cdf0e10cSrcweir <td class="cell15"><code>-a, --all</code></td> 762cdf0e10cSrcweir <td class="cell85">list all interface methods, not only the direct ones</td> 763cdf0e10cSrcweir </tr> 764cdf0e10cSrcweir <tr> 765cdf0e10cSrcweir <td class="cell15"><code>--(java4|java5|cpp)</code></td> 766cdf0e10cSrcweir <td class="cell85">select the target language<br> 767cdf0e10cSrcweir --java4 generate output for Java 1.4 or earlier<br> 768cdf0e10cSrcweir --java5 generate output for Java 1.5 or later (is currently the default)<br> 769cdf0e10cSrcweir --cpp generate output for C++</td> 770cdf0e10cSrcweir </tr> 771cdf0e10cSrcweir <tr> 772cdf0e10cSrcweir <td class="cell15"><code>-sn, --shortnames</code></td> 773cdf0e10cSrcweir <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> 774cdf0e10cSrcweir </tr> 775cdf0e10cSrcweir <tr> 776cdf0e10cSrcweir <td class="cell15"><code>--propertysetmixin</code></td> 777cdf0e10cSrcweir <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> 778cdf0e10cSrcweir </tr> 779cdf0e10cSrcweir <tr> 780cdf0e10cSrcweir <td class="cell15"><code>-lh --licenseheader</code></td> 781cdf0e10cSrcweir <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> 782cdf0e10cSrcweir </tr> 783cdf0e10cSrcweir <tr> 784cdf0e10cSrcweir <td class="cell15"><code>-bc<br>--backward-compatible</code></td> 785cdf0e10cSrcweir <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> 786cdf0e10cSrcweir </tr> 787cdf0e10cSrcweir <tr> 788cdf0e10cSrcweir <td class="cell15"><code>-o <path></code></td> 789cdf0e10cSrcweir <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> 790cdf0e10cSrcweir </tr> 791cdf0e10cSrcweir <tr> 792cdf0e10cSrcweir <td class="cell15"><code>-l <file></code></td> 793cdf0e10cSrcweir <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> 794cdf0e10cSrcweir </tr> 795cdf0e10cSrcweir <tr> 796cdf0e10cSrcweir <td class="cell15"><code>-n <name></code></td> 797cdf0e10cSrcweir <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> 798cdf0e10cSrcweir </tr> 799cdf0e10cSrcweir <tr> 800cdf0e10cSrcweir <td class="cell15"><code>-d <name></code></td> 801cdf0e10cSrcweir <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> 802cdf0e10cSrcweir </tr> 803cdf0e10cSrcweir <tr> 804cdf0e10cSrcweir <td class="cell15"><code>-t <name></code></td> 805cdf0e10cSrcweir <td class="cell85">specifies an UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).</td> 806cdf0e10cSrcweir </tr> 807cdf0e10cSrcweir <tr> 808cdf0e10cSrcweir <td class="cell15"><code>-p <protocol:cmd(s)></code></td> 809cdf0e10cSrcweir <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> 810cdf0e10cSrcweir </tr> 811cdf0e10cSrcweir <tr> 812cdf0e10cSrcweir <td class="cell15"><code>-V, --version</code></td> 813cdf0e10cSrcweir <td class="cell85">print version number and exit.</td> 814cdf0e10cSrcweir </tr> 815cdf0e10cSrcweir <tr> 816cdf0e10cSrcweir <td class="cell15"><code>-h, --help</code></td> 817cdf0e10cSrcweir <td class="cell85">print this help and exit.</td> 818cdf0e10cSrcweir </tr> 819cdf0e10cSrcweir </table> 820cdf0e10cSrcweir </p> 821cdf0e10cSrcweir </td> 822cdf0e10cSrcweir </tr> 823cdf0e10cSrcweir </table> 824cdf0e10cSrcweir </td> 825cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 826cdf0e10cSrcweir </tr> 827cdf0e10cSrcweir <tr> 828cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 829cdf0e10cSrcweir </tr> 830cdf0e10cSrcweir <tr> 831cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 832cdf0e10cSrcweir <td> 833cdf0e10cSrcweir <table class="table2"> 834cdf0e10cSrcweir <tr> 835cdf0e10cSrcweir <td colspan="2" class="head1"><a name="regcomp"/>regcomp</td> 836cdf0e10cSrcweir <td align="right"> 837cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 838cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 839cdf0e10cSrcweir </td> 840cdf0e10cSrcweir </tr> 841cdf0e10cSrcweir <tr> 842cdf0e10cSrcweir <td colspan="3"> 843cdf0e10cSrcweir <p>'regcomp' is a tool to register|revoke external UNO components 844cdf0e10cSrcweir into|from a registry which is used in a UNO environment.</p> 845cdf0e10cSrcweir <p class="head2">Usage:</p> 846cdf0e10cSrcweir <blockquote> 847cdf0e10cSrcweir <b><code>regcomp -revoke [-br<registryfile>] -r <registryfile> -c <locationUrl>[-l<componentLoaderName>]</code></b> 848cdf0e10cSrcweir </blockquote> 849cdf0e10cSrcweir <p class="head2">Options:</p> 850cdf0e10cSrcweir <p> 851cdf0e10cSrcweir <table class="table4"> 852cdf0e10cSrcweir <tr> 853cdf0e10cSrcweir <td class="cell15"><code>-register|revoke</code></td> 854cdf0e10cSrcweir <td class="cell85">register means that the components will be 855cdf0e10cSrcweir installed and revoke means that they will be removed.</td> 856cdf0e10cSrcweir </tr> 857cdf0e10cSrcweir <tr> 858cdf0e10cSrcweir <td class="cell15"><code>-br<registryfile></code></td> 859cdf0e10cSrcweir <td class="cell85">the name of the registry used for bootstrapping 860cdf0e10cSrcweir the program. If the bootstrap registry is specified and has the same 861cdf0e10cSrcweir name as the registration registry, '-r' is optional.</td> 862cdf0e10cSrcweir </tr> 863cdf0e10cSrcweir <tr> 864cdf0e10cSrcweir <td class="cell15"><code>-r<registryfile></code></td> 865cdf0e10cSrcweir <td class="cell85">the name of the registry (will be created if 866cdf0e10cSrcweir it does not exist) where the component should be registered.</td> 867cdf0e10cSrcweir </tr> 868cdf0e10cSrcweir <tr> 869cdf0e10cSrcweir <td class="cell15"><code>-c<locationUrls></code></td> 870cdf0e10cSrcweir <td class="cell85">the location of a component (DLL, Class name, 871cdf0e10cSrcweir or an url of a jar file) or a list of urls separated by ';'s. Note 872cdf0e10cSrcweir that, if a list of urls is specified, the components must all need 873cdf0e10cSrcweir the same loader.</td> 874cdf0e10cSrcweir </tr> 875cdf0e10cSrcweir <tr> 876cdf0e10cSrcweir <td class="cell15"><code>-l<componentLoaderName></code></td> 877cdf0e10cSrcweir <td class="cell85">the name of the needed loader, if no loader is 878cdf0e10cSrcweir specified the 'com.sun.star.loader.SharedLibrary' is used. Supported 879cdf0e10cSrcweir loaders: 'com.sun.star.loader.SharedLibrary' | 880cdf0e10cSrcweir 'com.sun.star.loader.Java'.</td> 881cdf0e10cSrcweir </tr> 882cdf0e10cSrcweir </table> 883cdf0e10cSrcweir </p> 884cdf0e10cSrcweir </td> 885cdf0e10cSrcweir </tr> 886cdf0e10cSrcweir </table> 887cdf0e10cSrcweir </td> 888cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 889cdf0e10cSrcweir </tr> 890cdf0e10cSrcweir <tr> 891cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 892cdf0e10cSrcweir </tr> 893cdf0e10cSrcweir <tr> 894cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 895cdf0e10cSrcweir <td> 896cdf0e10cSrcweir <table class="table2"> 897cdf0e10cSrcweir <tr> 898cdf0e10cSrcweir <td colspan="2" class="head1"><a name="regmerge"/>regmerge</td> 899cdf0e10cSrcweir <td align="right"> 900cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 901cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 902cdf0e10cSrcweir </td> 903cdf0e10cSrcweir </tr> 904cdf0e10cSrcweir <tr> 905cdf0e10cSrcweir <td colspan="3"> 906cdf0e10cSrcweir <p>'regmerge' is a small tool to merge different registry files under a 907cdf0e10cSrcweir specified key into another registry file. If a value already exists in 908cdf0e10cSrcweir the target file the value is overwritten by the value of the source 909cdf0e10cSrcweir file.</p> 910cdf0e10cSrcweir <p class="head2">Usage:</p> 911cdf0e10cSrcweir <blockquote> 912cdf0e10cSrcweir <b><code>regmerge [-v|--verbose] <mergefile> <mergeKeyName> <regfile_1> ... <regfile_n></code></b> 913cdf0e10cSrcweir </blockquote> 914cdf0e10cSrcweir <p class="head2">Options:</p> 915cdf0e10cSrcweir <p> 916cdf0e10cSrcweir <table class="table4"> 917cdf0e10cSrcweir <tr> 918cdf0e10cSrcweir <td class="cell15"><code>-v|--verbose</code></td> 919cdf0e10cSrcweir <td class="cell85">verbose output on stdout.</td> 920cdf0e10cSrcweir </tr> 921cdf0e10cSrcweir <tr> 922cdf0e10cSrcweir <td class="cell15"><code><mergefile></code></td> 923cdf0e10cSrcweir <td class="cell85">specifies the merged registry file. If this file 924cdf0e10cSrcweir doesn't exist, it is created.</td> 925cdf0e10cSrcweir </tr> 926cdf0e10cSrcweir <tr> 927cdf0e10cSrcweir <td class="cell15"><code><mergeKeyName></code></td> 928cdf0e10cSrcweir <td class="cell85">specifies the merge key, everything is merged 929cdf0e10cSrcweir under this key. If this key doesn't exist, it is created.</td> 930cdf0e10cSrcweir </tr> 931cdf0e10cSrcweir <tr> 932cdf0e10cSrcweir <td class="cell15"><code><regfile_1> ... <regfile_n></code></td> 933cdf0e10cSrcweir <td class="cell85">specifies one or more registry files that are 934cdf0e10cSrcweir merged.</td> 935cdf0e10cSrcweir </tr> 936cdf0e10cSrcweir </table> 937cdf0e10cSrcweir </p> 938cdf0e10cSrcweir </td> 939cdf0e10cSrcweir </tr> 940cdf0e10cSrcweir </table> 941cdf0e10cSrcweir </td> 942cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 943cdf0e10cSrcweir </tr> 944cdf0e10cSrcweir <tr> 945cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 946cdf0e10cSrcweir </tr> 947cdf0e10cSrcweir <tr> 948cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 949cdf0e10cSrcweir <td> 950cdf0e10cSrcweir <table class="table2"> 951cdf0e10cSrcweir <tr> 952cdf0e10cSrcweir <td colspan="2" class="head1"><a name="regview"/>regview</td> 953cdf0e10cSrcweir <td align="right"> 954cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 955cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 956cdf0e10cSrcweir </td> 957cdf0e10cSrcweir </tr> 958cdf0e10cSrcweir <tr> 959cdf0e10cSrcweir <td colspan="3"> 960cdf0e10cSrcweir <p>'regview' is a tool to show the contents of a registry file. The tool 961cdf0e10cSrcweir dumps the hierarchical structure and the values of the nodes in a human 962cdf0e10cSrcweir readable manner to stdout.</p> 963cdf0e10cSrcweir <p class="head2">Usage:</p> 964cdf0e10cSrcweir <blockquote> 965cdf0e10cSrcweir <b><code>regview <registryfile> [<keyName>]</code></b> 966cdf0e10cSrcweir </blockquote> 967cdf0e10cSrcweir <p class="head2">Options:</p> 968cdf0e10cSrcweir <p> 969cdf0e10cSrcweir <table class="table4"> 970cdf0e10cSrcweir <tr> 971cdf0e10cSrcweir <td class="cell15">-br<registryfile></code></td> 972cdf0e10cSrcweir <td class="cell85">the name of the registry whose contents should 973cdf0e10cSrcweir be viewed.</td> 974cdf0e10cSrcweir </tr> 975cdf0e10cSrcweir <tr> 976cdf0e10cSrcweir <td class="cell15"><code><keyName></code></td> 977cdf0e10cSrcweir <td class="cell85">the name of a registry key. The name must be 978cdf0e10cSrcweir fully qualified; for example, '/' means the root key and 979cdf0e10cSrcweir '/UCR/com/sun/star/uno/XInterface' shows the type specification of the 980cdf0e10cSrcweir XInterface type. If no key is specified, the tool dumps the whole 981cdf0e10cSrcweir content of the registry file.</td> 982cdf0e10cSrcweir </tr> 983cdf0e10cSrcweir </table> 984cdf0e10cSrcweir </p> 985cdf0e10cSrcweir </td> 986cdf0e10cSrcweir </tr> 987cdf0e10cSrcweir </table> 988cdf0e10cSrcweir </td> 989cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 990cdf0e10cSrcweir </tr> 991cdf0e10cSrcweir <tr> 992cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 993cdf0e10cSrcweir </tr> 994cdf0e10cSrcweir <tr> 995cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 996cdf0e10cSrcweir <td> 997cdf0e10cSrcweir <table class="table2"> 998cdf0e10cSrcweir <tr> 999cdf0e10cSrcweir <td colspan="2" class="head1"><a name="autodoc"/>autodoc</td> 1000cdf0e10cSrcweir <td align="right"> 1001cdf0e10cSrcweir <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> 1002cdf0e10cSrcweir <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> 1003cdf0e10cSrcweir </td> 1004cdf0e10cSrcweir </tr> 1005cdf0e10cSrcweir <tr> 1006cdf0e10cSrcweir <td colspan="3"> 1007cdf0e10cSrcweir <p>The 'autodoc' tool is used for creating javadoc-like documentation 1008cdf0e10cSrcweir from C++ and UNOIDL source code.</p> 1009cdf0e10cSrcweir <p>There are some conventions to follow when documenting C++- or 1010cdf0e10cSrcweir UNOIDL-sourcecode. See also the <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixB/IDL_Documentation_Guidelines" title="link to the UNOIDL Documentation Guidelines">UNOIDL Documentation Guidelines</a>.<br> 1011cdf0e10cSrcweir If you are not familiar with these, but do know javadoc: For simple C++ 1012cdf0e10cSrcweir sourcecode documentation, using javadoc-style comments will work.</p> 1013cdf0e10cSrcweir <p class="head2">Usage:</p> 1014cdf0e10cSrcweir <blockquote> 1015cdf0e10cSrcweir <b><code>autodoc [ -v <VerboseNr> ] [ -name "<TitleForTheDocu>" ] -html <OutputDirectory> -lg <SourcecodeLanguage><br> 1016cdf0e10cSrcweir { [ -p <ProjectName> <ProjectRootDirectory> ] -t <SourceTree>* | -d <SourceDirectory>* | -f <SourceFile>* }*</code></b> 1017cdf0e10cSrcweir </blockquote> 1018cdf0e10cSrcweir <p class="head2">Options:</p> 1019cdf0e10cSrcweir <p> 1020cdf0e10cSrcweir <table width="100%" border="1" cellpadding="4" cellspacing="0"> 1021cdf0e10cSrcweir <tr> 1022cdf0e10cSrcweir <td class="cell15"><code>-v <VerboseNr></code></td> 1023cdf0e10cSrcweir <td class="cell85"><VerboseNr> == 5 displays the parsed source 1024cdf0e10cSrcweir code tokens, so you can locate which piece caused an parsing error.<br> 1025cdf0e10cSrcweir <VerboseNr> == 2 displays not only the parsed source code, 1026cdf0e10cSrcweir but also the comments.<br><br> 1027cdf0e10cSrcweir This option must be the first one, if it is used.</td> 1028cdf0e10cSrcweir </tr> 1029cdf0e10cSrcweir <tr> 1030cdf0e10cSrcweir <td class="cell15"><code>-name "<Title>"</code></td> 1031cdf0e10cSrcweir <td class="cell85"><Title> occurs as the title of the start 1032cdf0e10cSrcweir page of the HTML output. If this option is omitted, a default title is 1033cdf0e10cSrcweir created.</td> 1034cdf0e10cSrcweir </tr> 1035cdf0e10cSrcweir <tr> 1036cdf0e10cSrcweir <td class="cell15"><code>-html <OutputDirectory></code></td> 1037cdf0e10cSrcweir <td class="cell85">specifies the root directory where the HTML output 1038cdf0e10cSrcweir is created.<br> 1039cdf0e10cSrcweir Autodoc does not remove old files there, though it overwrites them.</td> 1040cdf0e10cSrcweir </tr> 1041cdf0e10cSrcweir <tr> 1042cdf0e10cSrcweir <td class="cell15"><code>-lg <SourcecodeLanguage></code></td> 1043cdf0e10cSrcweir <td class="cell85">Possible values are: c++ | idl.<br><br> 1044cdf0e10cSrcweir This also specifies which files will be parsed: "c++" parses 1045cdf0e10cSrcweir all files with the endings .hxx and .h, "idl" parses all 1046cdf0e10cSrcweir files with the ending '.idl' .<br> 1047cdf0e10cSrcweir To change this behaviour, see at option <code>-f</code>.</td> 1048cdf0e10cSrcweir </tr> 1049cdf0e10cSrcweir <tr> 1050cdf0e10cSrcweir <td class="cell15"><code>-p <ProjectName> <ProjectDirectory></code></td> 1051cdf0e10cSrcweir <td class="cell85">this option can be used to divide large code 1052cdf0e10cSrcweir bases into different projects.<br> 1053cdf0e10cSrcweir <ProjectName> gives a user-defined name for the project.<br> 1054cdf0e10cSrcweir <ProjectDirectory> is the root to which all paths, given with the 1055cdf0e10cSrcweir following options <code>-t,-d</code> and <code>-f</code>, are 1056cdf0e10cSrcweir relative.<br> 1057cdf0e10cSrcweir This option can be omitted when there are no projects and all paths in 1058cdf0e10cSrcweir the following options are relative to the working directory.<br><br> 1059cdf0e10cSrcweir The "{ ... }*" around the options <code>-p,-t,-d,-f</code> 1060cdf0e10cSrcweir indicates, that this whole block of options can be repeated, each block 1061cdf0e10cSrcweir starting with a new <code>-p</code>.</td> 1062cdf0e10cSrcweir </tr> 1063cdf0e10cSrcweir <tr> 1064cdf0e10cSrcweir <td class="cell15"><code>-t <SourceTree></code></td> 1065cdf0e10cSrcweir <td class="cell85">specifies that all files in the directory 1066cdf0e10cSrcweir <SourceTree> and it's subdirectories are parsed, where the file 1067cdf0e10cSrcweir ending matches the option <code>-lg</code>.<br> 1068cdf0e10cSrcweir There can be given multiple directories after one <code>-t</code> 1069cdf0e10cSrcweir option.<br> 1070cdf0e10cSrcweir All relative paths are relative to the project-rootdirectory, 1071cdf0e10cSrcweir given with the <code>-p</code> option.<br> 1072cdf0e10cSrcweir </td> 1073cdf0e10cSrcweir </tr> 1074cdf0e10cSrcweir <tr> 1075cdf0e10cSrcweir <td class="cell15"><code>-d <SourceDirectory></code></td> 1076cdf0e10cSrcweir <td class="cell85">Specifies that all files in th directory 1077cdf0e10cSrcweir <SourceDirectory>, but NOT it's subdirectories, are parsed, where 1078cdf0e10cSrcweir the file ending matches the option <code>-lg</code>.<br> 1079cdf0e10cSrcweir There can be multiple directories given after one <code>-d</code> 1080cdf0e10cSrcweir option.<br> 1081cdf0e10cSrcweir All relative paths are relative to the project-rootdirectory, 1082cdf0e10cSrcweir given with the <code>-p</code> option.</td> 1083cdf0e10cSrcweir </tr> 1084cdf0e10cSrcweir <tr> 1085cdf0e10cSrcweir <td class="cell15"><code>-f <SourceFile></code></td> 1086cdf0e10cSrcweir <td class="cell85">parses the given file. The ending does not have 1087cdf0e10cSrcweir to match the <code>-lg</code> option.<br> 1088cdf0e10cSrcweir There can be multiple files given after one <code>-f</code> option.<br> 1089cdf0e10cSrcweir All relative paths are relative to the project-rootdirectory, 1090cdf0e10cSrcweir given with the <code>-p</code> option.</td> 1091cdf0e10cSrcweir </tr> 1092cdf0e10cSrcweir </table> 1093cdf0e10cSrcweir </p><b>Remark:</b> The sequence of options matters! Use them in the order given 1094cdf0e10cSrcweir in the "Usage"-paragraph.</p> 1095cdf0e10cSrcweir </td> 1096cdf0e10cSrcweir </tr> 1097cdf0e10cSrcweir </table> 1098cdf0e10cSrcweir </td> 1099cdf0e10cSrcweir <td class="content1"><img class="nothing8" src="images/nada.gif"></td> 1100cdf0e10cSrcweir </tr> 1101cdf0e10cSrcweir <tr> 1102cdf0e10cSrcweir <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> 1103cdf0e10cSrcweir </tr> 1104cdf0e10cSrcweir <tr> 1105cdf0e10cSrcweir <td colspan="3"> 1106cdf0e10cSrcweir <div class="centertext"> 1107270eceedSJürgen Schmidt <p><img class="apachelogo" src="images/odk-footer-logo.gif" title="Apache Feather" alt="Apache Feather" /> 1108*507825ddSAriel Constenla-Haile Copyright © 2011 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.<p> 1109cdf0e10cSrcweir </div> 1110cdf0e10cSrcweir </td> 1111cdf0e10cSrcweir </tr> 1112cdf0e10cSrcweir</table> 1113cdf0e10cSrcweir<map name="Map"> 1114ef1ef8e6SJürgen Schmidt <area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org"> 1115cdf0e10cSrcweir</map> 1116cdf0e10cSrcweir</body> 1117cdf0e10cSrcweir</html> 1118
