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