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