diff options
Diffstat (limited to 'odk/docs/tools.html')
| -rw-r--r-- | odk/docs/tools.html | 442 |
1 files changed, 231 insertions, 211 deletions
diff --git a/odk/docs/tools.html b/odk/docs/tools.html index 7fda224269bf..ba5051abb6af 100644 --- a/odk/docs/tools.html +++ b/odk/docs/tools.html @@ -1,3 +1,21 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> <html> <head> <title>LibreOffice %PRODUCT_RELEASE% SDK - Development Tools</title> @@ -12,41 +30,41 @@ <div id="TopHeader"> <a id="Logo" href="http://www.libreoffice.org/" title="Go to the Home of LibreOffice and the LibreOffice Community page"></a> <p id="HeaderTagLine"> - Software Development Kit %PRODUCT_RELEASE% + Software Development Kit %PRODUCT_RELEASE% </p> - </div> + </div> <div class="clear"> - </div> + </div> <div id="Layout"> <div class="typography"> <h1> Development Tools </h1> <table class="table1" cellpadding=0> - <tr> + <tr> <td colspan="3"><img class="nothing10" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="3"><img class="nothing1" src="images/nada.gif"></td> </tr> - <tr> - <td> + <tr> + <td> <table class="table3"> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#unopkg" title="link to the unopkg tool description">unopkg</a></td> - <td class="content87">The new UNO package deployment tool. It comes + <td class="content87">The new UNO package deployment tool. It comes with the office installation and can be found in the program directory of the office installation.</td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#unoexe" title="link to the uno tool description">uno</a></td> - <td class="content87">Tool to provide a UNO runtime environment and + <td class="content87">Tool to provide a UNO runtime environment and provide configured (deployed) or single components. This tool comes with the office installation and can be found in the program directory of the office installation.</td> @@ -54,42 +72,42 @@ <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td> - <td class="content87">Tool to merge several registry (e.g. type + <td class="content87">Tool to merge several registry (e.g. type 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> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#regview" title="link to the regview tool description">regview</a></td> - <td class="content87">Tool to view the content of a registry file - in a human readable manner. Special support for type library + <td class="content87">Tool to view the content of a registry file + in a human readable manner. Special support for type library 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> </tr> - <tr valign="middle"> + <tr valign="middle"> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#idlc" title="link to the idlc tool description">idlc</a></td> - <td class="content87">The UNOIDL compiler, generates a common - binary type library format as base for all codemaker tools and + <td class="content87">The UNOIDL compiler, generates a common + binary type library format as base for all codemaker tools and the UNO runtime type library.</td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#cppumaker" title="link to the cppumaker tool description">cppumaker</a></td> - <td class="content87">Tool for generating C++ code for the UNOIDL + <td class="content87">Tool for generating C++ code for the UNOIDL types stored in a type library.</td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#javamaker" title="link to the javamaker tool description">javamaker</a></td> - <td class="content87">Tool for generating Java class files for the + <td class="content87">Tool for generating Java class files for the UNOIDL types stored in a type library.</td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#climaker" title="link to the climaker tool description">climaker</a></td> - <td class="content87">Tool for generating CLI assemblies for the + <td class="content87">Tool for generating CLI assemblies for the UNOIDL types stored in a type library (windows only).</td> </tr> <tr valign="top"> @@ -105,37 +123,37 @@ <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td> - <td class="content87">Tool to merge several registry (e.g. type + <td class="content87">Tool to merge several registry (e.g. type libraries) files into one file.</td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#regview" title="link to the regview tool description">regview</a></td> - <td class="content87">Tool to view the content of a registry file - in a human readable manner. Special support for type library + <td class="content87">Tool to view the content of a registry file + in a human readable manner. Special support for type library nodes.</td> </tr> <tr valign="top"> <td class="content3"><img src="images/arrow-1.gif"></td> <td><a href="#autodoc" title="link to the autodoc tool description">autodoc</a></td> - <td class="content87">Tool to generate javadoc-like documentation + <td class="content87">Tool to generate javadoc-like documentation for C/C++ and UNOIDL files.</td> </tr> </table> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="unopkg"/>unopkg</td> <td align="right"> <a style="a:link:visited #FFFFFF;" href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> @@ -143,16 +161,16 @@ </tr> <tr> <td colspan="3"> - <p>'unopkg' is a tool for easy deployment of UNO packages in an existing - office installation. UNO packages are UNO components (single libraries or + <p>'unopkg' is a tool for easy deployment of UNO packages in an existing + office installation. UNO packages are UNO components (single libraries or Jar files or more complex zip files that contains one or more libraries| - Jar files, type libraries and configuration items), scripts and - LibreOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the - SDK but comes with the office directly and is a development tool as well + Jar files, type libraries and configuration items), scripts and + LibreOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the + SDK but comes with the office directly and is a development tool as well as an end user tool to deploy extension into an office installation.</p> - <p>More details concerning deployment and this tool can be find in the + <p>More details concerning deployment and this tool can be find in the 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> - <p><b>Note:</b> This tool works only in the <i><office>/program</i> + <p><b>Note:</b> This tool works only in the <i><office>/program</i> directory!</p> <p class="head2">Usage:</p> <blockquote> @@ -179,7 +197,7 @@ </tr> <tr> <td class="cell15"><code>reinstall</code></td> - <td class="cell85">export feature: reinstall all deployed + <td class="cell85">export feature: reinstall all deployed packages</td> </tr> <tr> @@ -188,7 +206,7 @@ </tr> <tr> <td class="cell15"><code>gui</code></td> - <td class="cell15">raise Package Manager Graphical User Interface + <td class="cell15">raise Package Manager Graphical User Interface (GUI)</td> </tr> </table> @@ -215,13 +233,13 @@ </tr> <tr> <td class="cell15"><code>--log-file <file></code></td> - <td class="cell85">custom log file; default: + <td class="cell85">custom log file; default: <i><cache-dir>/log.txt</i>.</td> </tr> <tr> <td class="cell15"><code>--shared</code></td> - <td class="cell85">expert feature: operate on shared installation - deployment context; run only when no concurrent Office process(es) are + <td class="cell85">expert feature: operate on shared installation + deployment context; run only when no concurrent Office process(es) are running!</td> </tr> <tr> @@ -237,31 +255,31 @@ </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="unoexe"/>uno</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>The UNO-starter is for running a component or service process, and - providing a runtime environment. Raising a component might look like + <p>The UNO-starter is for running a component or service process, and + providing a runtime environment. Raising a component might look like this </p> - <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb + <p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -r myregistry.rdb -- foo bar</code></p> <p>or</p> - <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb + <p><code>[c:\] uno.exe -s foo.bar.FooBarService -r myregistry.rdb -- foo bar</code></p> - <p>The starter loads the component and instantiates it. The component + <p>The starter loads the component and instantiates it. The component 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> <p> <code>interface XMain : com::sun::star::uno::XInterface <br> @@ -275,9 +293,9 @@ }; </code> </p> - <p>Method run() will be called and returns the error code given, back - to the system. If the uno starter is executed with the -u (URL) option, - then XInitialization is used instead of XMain. The -u option is described + <p>Method run() will be called and returns the error code given, back + to the system. If the uno starter is executed with the -u (URL) option, + then XInitialization is used instead of XMain. The -u option is described later.</p> <p class="head2">Usage:</p> <blockquote> @@ -294,8 +312,8 @@ <table class="table4"> <tr> <td class="cell15"><code><HostName></code></td> - <td class="cell85">Specifying a host name might be necessary to - distinguish the network interface to be used,if a machine is part of + <td class="cell85">Specifying a host name might be necessary to + distinguish the network interface to be used,if a machine is part of two networks.</td> </tr> <tr> @@ -304,7 +322,7 @@ </tr> <tr> <td class="cell15"><code><Name></code></td> - <td class="cell85">Identifier for demanded called component + <td class="cell85">Identifier for demanded called component instances.</td> </tr> <tr> @@ -313,51 +331,51 @@ (e.g., c:\myreg.rdb) are used by the ServiceManager. The <i>ro</i> ones are opened for reading only; whereas, a single <i>rw</i> one will be opened for reading and writing. If the <i>rw</i> one does - not exist, then it may be created. Components may read and write to + not exist, then it may be created. Components may read and write to store their persistent state.</td> </tr> <tr> <td class="cell15"><code>--singleaccept</code></td> - <td class="cell85">The uno starter will accept one connection, + <td class="cell85">The uno starter will accept one connection, provide the component instance and die.</td> </tr> <tr> <td class="cell15"><code>--singleinstance</code></td> - <td class="cell85">The uno starter will accept any number of - connections, but will provide the same single component instance any + <td class="cell85">The uno starter will accept any number of + connections, but will provide the same single component instance any time instead of creating a new instance for each connection.</td> </tr> </table> <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> - <p>You can easily connect to a server started with the - <code>-u (url)</code> option by using this service, giving the same url + <p>You can easily connect to a server started with the + <code>-u (url)</code> option by using this service, giving the same url to resolve. The service provides you an instance from remote.</p> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="idlc"/>idlc</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used - to check UNODL type definitions and transform valid type definitions - into a binary type library format, which is later used by all codemaker + <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used + to check UNODL type definitions and transform valid type definitions + into a binary type library format, which is later used by all codemaker tools. It is also used as a dynamic type library for UNO at runtime.<br> 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> <p class="head2">Usage:</p> @@ -368,12 +386,12 @@ <table class="table4"> <tr> <td class="cell15"><code>file_1 ... file_n</code></td> - <td class="cell85">specifies one or more idl files. Only files with + <td class="cell85">specifies one or more idl files. Only files with the extension '.idl' are valid.</td> </tr> <tr> <td class="cell15"><code>@<filename></code></td> - <td class="cell85">filename specifies the name of a command + <td class="cell85">filename specifies the name of a command file.</td> </tr> </table> @@ -383,14 +401,14 @@ <table class="table4"> <tr> <td class="cell15"><code>-O<path></code></td> - <td class="cell85">path describes the output directory. The - generated output is a registry file with the same name as the idl + <td class="cell85">path describes the output directory. The + generated output is a registry file with the same name as the idl input file.</td> </tr> <tr> <td class="cell15"><code>-I<path></code></td> - <td class="cell85">path specifies a directory where included files - that will be searched by the preprocessor are located. Multiple + <td class="cell85">path specifies a directory where included files + that will be searched by the preprocessor are located. Multiple directories can be combined with ';'.</td> </tr> <tr> @@ -399,7 +417,7 @@ </tr> <tr> <td class="cell15"><code>-C</code></td> - <td class="cell85">generates complete type information, including + <td class="cell85">generates complete type information, including additional service information and documentation.</td> </tr> <tr> @@ -409,31 +427,31 @@ </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="cppumaker"/>cppumaker</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>The 'cppumaker' generates a C++ representation for idl types. The - cppumaker works on a typelibrary, which is generated by the UNOIDL + <p>The 'cppumaker' generates a C++ representation for idl types. The + cppumaker works on a typelibrary, which is generated by the UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> - idlc</a>). It generates the output for all specified types and for all + idlc</a>). It generates the output for all specified types and for all types the specified types depend on.</p> <p class="head2">Usage:</p> <blockquote> @@ -444,115 +462,115 @@ <table class="table4"> <tr> <td class="cell15"><code>-O<path></code></td> - <td class="cell85">path describes the root directory for the - generated output. The output directory tree is generated under this + <td class="cell85">path describes the root directory for the + generated output. The output directory tree is generated under this directory.</td> </tr> <tr> <td class="cell15"><code>-T<name><br> |-T<t1>;<t2>...</code></td> - <td class="cell85">name specifies a type or a list of types. The - output for this type and all dependent types are generated. If no '-T' - option is specified, then output for all types is generated. It is also - possible to use a wildcard 'xy.*' to generate a complete module - inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' - option. Example: 'com.sun.star.uno.XInterface' or + <td class="cell85">name specifies a type or a list of types. The + output for this type and all dependent types are generated. If no '-T' + option is specified, then output for all types is generated. It is also + possible to use a wildcard 'xy.*' to generate a complete module + inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' + option. Example: 'com.sun.star.uno.XInterface' or 'com.sun.star.uno.*' are valid types. </td> </tr> <tr> <td class="cell15"><code>-B<name></code></td> - <td class="cell85">name specifies the base node. All types are - searched under this node. Default is the root '/' of the registry + <td class="cell85">name specifies the base node. All types are + searched under this node. Default is the root '/' of the registry files.</td> </tr> <tr> <td class="cell15"><code>-L</code></td> - <td class="cell85">UNO type functions are generated lightweight, that - means only the name and typeclass are given and everything else is - retrieved from the type library dynamically. The default is that UNO + <td class="cell85">UNO type functions are generated lightweight, that + means only the name and typeclass are given and everything else is + retrieved from the type library dynamically. The default is that UNO type functions provides enough type information for boostrapping C++. '-L' should be the default for external components.</td> </tr> <tr> <td class="cell15"><code>-C</code></td> - <td class="cell85">UNO type functions are generated comprehensive - that means all necessary information is available for bridging the + <td class="cell85">UNO type functions are generated comprehensive + that means all necessary information is available for bridging the type in UNO. </td> </tr> <tr> <td class="cell15"><code>-G</code></td> - <td class="cell85">generate only target files which do not + <td class="cell85">generate only target files which do not exist.</td> </tr> <tr> <td class="cell15"><code>-Gc</code></td> - <td class="cell85">generate only target files whose content will + <td class="cell85">generate only target files whose content will be changed.</td> </tr> <tr> <td class="cell15"><code>-X<name></code></td> - <td class="cell85">extra types, which are not be taken into account + <td class="cell85">extra types, which are not be taken into account for generation.</td> </tr> </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="javamaker"/>javamaker</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>The 'javamaker' generates the appropriate Java class file for each idl - type. The javamaker works on a typelibrary which is generated by the + <p>The 'javamaker' generates the appropriate Java class file for each idl + type. The javamaker works on a typelibrary which is generated by the UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> - idlc</a>). It generates the output for all specified types and for all + idlc</a>). It generates the output for all specified types and for all types the specified types depend on.</p> <p class="head2">Usage:</p> <blockquote> <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b> - </blockquote> + </blockquote> <p class="head2">Options:</p> <p> <table class="table4"> <tr> <td class="cell15"><code>-O<path></code></td> - <td class="cell85">path describes the root directory for the - generated output. The output directory tree is generated under this + <td class="cell85">path describes the root directory for the + generated output. The output directory tree is generated under this directory.</td> </tr> <tr> <td class="cell15"><code>-T<name>|-T<t1>;<t2>...</code></td> - <td class="cell85">name specifies a type or a list of types. The - output for this type and all dependent types are generated. If no '-T' - option is specified, then output for all types is generated. It is also - possible to use a wildcard 'xy.*' to generate a complete module - inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' - option. Example: 'com.sun.star.uno.XInterface' + <td class="cell85">name specifies a type or a list of types. The + output for this type and all dependent types are generated. If no '-T' + option is specified, then output for all types is generated. It is also + possible to use a wildcard 'xy.*' to generate a complete module + inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' + option. Example: 'com.sun.star.uno.XInterface' or 'com.sun.star.uno.*' are valid types. </td> </tr> <tr> <td class="cell15"><code>-B<name></code></td> - <td class="cell85">name specifies the base node. All types are - searched under this node. Default is the root '/' of the registry + <td class="cell85">name specifies the base node. All types are + searched under this node. Default is the root '/' of the registry files.</td> </tr> <tr> @@ -561,52 +579,52 @@ types the specified types depend on.</p> </tr> <tr> <td class="cell15"><code>-G</code></td> - <td class="cell85">generate only target files which do not + <td class="cell85">generate only target files which do not exist.</td> </tr> <tr> <td class="cell15"><code>-Gc</code></td> - <td class="cell85">generate only target files whose content will + <td class="cell85">generate only target files whose content will be changed.</td> </tr> <tr> <td class="cell15"><code>-X<name></code></td> - <td class="cell85">extra types, which will not be taken into account + <td class="cell85">extra types, which will not be taken into account for generation.</td> </tr> </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="climaker"/>climaker</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl - type. The climaker works on a typelibrary which is generated by the + <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl + type. The climaker works on a typelibrary which is generated by the UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> - idlc</a>). It generates the output for all specified types and for all + idlc</a>). It generates the output for all specified types and for all types the specified types depend on.</p> <p class="head2">Usage:</p> <blockquote> <b><code>climaker <switches> [registry-file-1 registry-file-2 ...]</code></b> - </blockquote> + </blockquote> <p class="head2">Options:</p> <p> <table class="table4"> @@ -671,25 +689,25 @@ types the specified types depend on.</p> </p> <p><b>Example:</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb</code></p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="uno-skeletonmaker"/>uno-skeletonmaker</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> <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> @@ -798,28 +816,28 @@ types the specified types depend on.</p> </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> - <td> + <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="regcomp"/>regcomp</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>'regcomp' is a tool to register|revoke external UNO components + <p>'regcomp' is a tool to register|revoke external UNO components into|from a registry which is used in a UNO environment.</p> <p class="head2">Usage:</p> <blockquote> @@ -830,61 +848,61 @@ types the specified types depend on.</p> <table class="table4"> <tr> <td class="cell15"><code>-register|revoke</code></td> - <td class="cell85">register means that the components will be + <td class="cell85">register means that the components will be installed and revoke means that they will be removed.</td> </tr> <tr> <td class="cell15"><code>-br<registryfile></code></td> <td class="cell85">the name of the registry used for bootstrapping - the program. If the bootstrap registry is specified and has the same + the program. If the bootstrap registry is specified and has the same name as the registration registry, '-r' is optional.</td> </tr> <tr> <td class="cell15"><code>-r<registryfile></code></td> - <td class="cell85">the name of the registry (will be created if + <td class="cell85">the name of the registry (will be created if it does not exist) where the component should be registered.</td> </tr> <tr> <td class="cell15"><code>-c<locationUrls></code></td> - <td class="cell85">the location of a component (DLL, Class name, - or an url of a jar file) or a list of urls separated by ';'s. Note - that, if a list of urls is specified, the components must all need + <td class="cell85">the location of a component (DLL, Class name, + or an url of a jar file) or a list of urls separated by ';'s. Note + that, if a list of urls is specified, the components must all need the same loader.</td> </tr> <tr> <td class="cell15"><code>-l<componentLoaderName></code></td> - <td class="cell85">the name of the needed loader, if no loader is - specified the 'com.sun.star.loader.SharedLibrary' is used. Supported - loaders: 'com.sun.star.loader.SharedLibrary' | + <td class="cell85">the name of the needed loader, if no loader is + specified the 'com.sun.star.loader.SharedLibrary' is used. Supported + loaders: 'com.sun.star.loader.SharedLibrary' | 'com.sun.star.loader.Java'.</td> </tr> </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="regmerge"/>regmerge</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>'regmerge' is a small tool to merge different registry files under a - specified key into another registry file. If a value already exists in - the target file the value is overwritten by the value of the source + <p>'regmerge' is a small tool to merge different registry files under a + specified key into another registry file. If a value already exists in + the target file the value is overwritten by the value of the source file.</p> <p class="head2">Usage:</p> <blockquote> @@ -899,45 +917,45 @@ types the specified types depend on.</p> </tr> <tr> <td class="cell15"><code><mergefile></code></td> - <td class="cell85">specifies the merged registry file. If this file + <td class="cell85">specifies the merged registry file. If this file doesn't exist, it is created.</td> </tr> <tr> <td class="cell15"><code><mergeKeyName></code></td> - <td class="cell85">specifies the merge key, everything is merged + <td class="cell85">specifies the merge key, everything is merged under this key. If this key doesn't exist, it is created.</td> </tr> <tr> <td class="cell15"><code><regfile_1> ... <regfile_n></code></td> - <td class="cell85">specifies one or more registry files that are + <td class="cell85">specifies one or more registry files that are merged.</td> </tr> </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="regview"/>regview</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>'regview' is a tool to show the contents of a registry file. The tool - dumps the hierarchical structure and the values of the nodes in a human + <p>'regview' is a tool to show the contents of a registry file. The tool + dumps the hierarchical structure and the values of the nodes in a human readable manner to stdout.</p> <p class="head2">Usage:</p> <blockquote> @@ -948,46 +966,46 @@ types the specified types depend on.</p> <table class="table4"> <tr> <td class="cell15">-br<registryfile></code></td> - <td class="cell85">the name of the registry whose contents should + <td class="cell85">the name of the registry whose contents should be viewed.</td> </tr> <tr> <td class="cell15"><code><keyName></code></td> - <td class="cell85">the name of a registry key. The name must be - fully qualified; for example, '/' means the root key and - '/UCR/com/sun/star/uno/XInterface' shows the type specification of the - XInterface type. If no key is specified, the tool dumps the whole + <td class="cell85">the name of a registry key. The name must be + fully qualified; for example, '/' means the root key and + '/UCR/com/sun/star/uno/XInterface' shows the type specification of the + XInterface type. If no key is specified, the tool dumps the whole content of the registry file.</td> </tr> </table> </p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> - <tr> + <tr> <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> </tr> <tr> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> <td> <table class="table2"> - <tr> + <tr> <td colspan="2" class="head1"><a name="autodoc"/>autodoc</td> <td align="right"> <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> </td> - </tr> + </tr> <tr> <td colspan="3"> - <p>The 'autodoc' tool is used for creating javadoc-like documentation + <p>The 'autodoc' tool is used for creating javadoc-like documentation from C++ and UNOIDL source code.</p> - <p>There are some conventions to follow when documenting C++- or + <p>There are some conventions to follow when documenting C++- or 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> - If you are not familiar with these, but do know javadoc: For simple C++ + If you are not familiar with these, but do know javadoc: For simple C++ sourcecode documentation, using javadoc-style comments will work.</p> <p class="head2">Usage:</p> <blockquote> @@ -999,16 +1017,16 @@ types the specified types depend on.</p> <table width="100%" border="1" cellpadding="4" cellspacing="0"> <tr> <td class="cell15"><code>-v <VerboseNr></code></td> - <td class="cell85"><VerboseNr> == 5 displays the parsed source + <td class="cell85"><VerboseNr> == 5 displays the parsed source code tokens, so you can locate which piece caused an parsing error.<br> - <VerboseNr> == 2 displays not only the parsed source code, + <VerboseNr> == 2 displays not only the parsed source code, but also the comments.<br><br> This option must be the first one, if it is used.</td> </tr> <tr> <td class="cell15"><code>-name "<Title>"</code></td> - <td class="cell85"><Title> occurs as the title of the start - page of the HTML output. If this option is omitted, a default title is + <td class="cell85"><Title> occurs as the title of the start + page of the HTML output. If this option is omitted, a default title is created.</td> </tr> <tr> @@ -1020,20 +1038,20 @@ types the specified types depend on.</p> <tr> <td class="cell15"><code>-lg <SourcecodeLanguage></code></td> <td class="cell85">Possible values are: c++ | idl.<br><br> - This also specifies which files will be parsed: "c++" parses - all files with the endings .hxx and .h, "idl" parses all + This also specifies which files will be parsed: "c++" parses + all files with the endings .hxx and .h, "idl" parses all files with the ending '.idl' .<br> To change this behaviour, see at option <code>-f</code>.</td> </tr> <tr> <td class="cell15"><code>-p <ProjectName> <ProjectDirectory></code></td> - <td class="cell85">this option can be used to divide large code + <td class="cell85">this option can be used to divide large code bases into different projects.<br> <ProjectName> gives a user-defined name for the project.<br> - <ProjectDirectory> is the root to which all paths, given with the - following options <code>-t,-d</code> and <code>-f</code>, are + <ProjectDirectory> is the root to which all paths, given with the + following options <code>-t,-d</code> and <code>-f</code>, are relative.<br> - This option can be omitted when there are no projects and all paths in + This option can be omitted when there are no projects and all paths in the following options are relative to the working directory.<br><br> The "{ ... }*" around the options <code>-p,-t,-d,-f</code> indicates, that this whole block of options can be repeated, each block @@ -1041,50 +1059,52 @@ types the specified types depend on.</p> </tr> <tr> <td class="cell15"><code>-t <SourceTree></code></td> - <td class="cell85">specifies that all files in the directory - <SourceTree> and it's subdirectories are parsed, where the file + <td class="cell85">specifies that all files in the directory + <SourceTree> and it's subdirectories are parsed, where the file ending matches the option <code>-lg</code>.<br> - There can be given multiple directories after one <code>-t</code> + There can be given multiple directories after one <code>-t</code> option.<br> - All relative paths are relative to the project-rootdirectory, + All relative paths are relative to the project-rootdirectory, given with the <code>-p</code> option.<br> </td> </tr> <tr> <td class="cell15"><code>-d <SourceDirectory></code></td> - <td class="cell85">Specifies that all files in th directory - <SourceDirectory>, but NOT it's subdirectories, are parsed, where + <td class="cell85">Specifies that all files in th directory + <SourceDirectory>, but NOT it's subdirectories, are parsed, where the file ending matches the option <code>-lg</code>.<br> - There can be multiple directories given after one <code>-d</code> + There can be multiple directories given after one <code>-d</code> option.<br> - All relative paths are relative to the project-rootdirectory, + All relative paths are relative to the project-rootdirectory, given with the <code>-p</code> option.</td> </tr> <tr> <td class="cell15"><code>-f <SourceFile></code></td> - <td class="cell85">parses the given file. The ending does not have + <td class="cell85">parses the given file. The ending does not have to match the <code>-lg</code> option.<br> There can be multiple files given after one <code>-f</code> option.<br> - All relative paths are relative to the project-rootdirectory, + All relative paths are relative to the project-rootdirectory, given with the <code>-p</code> option.</td> </tr> </table> - </p><b>Remark:</b> The sequence of options matters! Use them in the order given + </p><b>Remark:</b> The sequence of options matters! Use them in the order given in the "Usage"-paragraph.</p> </td> - </tr> + </tr> </table> </td> <td class="content1"><img class="nothing8" src="images/nada.gif"></td> </tr> </table> - </div> + </div> <div id="Footer"> <div id="FooterText"> <p> Copyright © 2000, 2010 LibreOffice contributors and/or their affiliates. All rights reserved. <br> - LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates. + LibreOffice was created by The Document Foundation, + based on Apache OpenOffice, which is Copyright 2011 + The Apache Software Foundation. <br> The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>. </p> @@ -1095,10 +1115,10 @@ types the specified types depend on.</p> <a href="http://www.documentfoundation.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.documentfoundation.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>. </p> - </div> - </div> - </div> - </div> - </body> -</html> + </div> + </div> + </div> + </div> + </body> +</html> |