tools.html (d353e71e) tools.html (80295734)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2<!--
3#**************************************************************
4#
5# Licensed to the Apache Software Foundation (ASF) under one
6# or more contributor license agreements. See the NOTICE file
7# distributed with this work for additional information
8# regarding copyright ownership. The ASF licenses this file

--- 158 unchanged lines hidden (view full) ---

167 <p>'unopkg' is a tool for easy deployment of UNO packages in an existing
168 office installation. UNO packages are UNO components (single libraries or
169 Jar files or more complex zip files that contains one or more libraries|
170 Jar files, type libraries and configuration items), scripts and
171 Apache OpenOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the
172 SDK but comes with the office directly and is a development tool as well
173 as an end user tool to deploy extension into an office installation.</p>
174 <p>More details concerning deployment and this tool can be find in the
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2<!--
3#**************************************************************
4#
5# Licensed to the Apache Software Foundation (ASF) under one
6# or more contributor license agreements. See the NOTICE file
7# distributed with this work for additional information
8# regarding copyright ownership. The ASF licenses this file

--- 158 unchanged lines hidden (view full) ---

167 <p>'unopkg' is a tool for easy deployment of UNO packages in an existing
168 office installation. UNO packages are UNO components (single libraries or
169 Jar files or more complex zip files that contains one or more libraries|
170 Jar files, type libraries and configuration items), scripts and
171 Apache OpenOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the
172 SDK but comes with the office directly and is a development tool as well
173 as an end user tool to deploy extension into an office installation.</p>
174 <p>More details concerning deployment and this tool can be find in the
175 Developer's Guide: <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p>
175 Developer's Guide: <a href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p>
176 <p><b>Note:</b> This tool works only in the <i>&lt;office&gt;/program</i>
177 directory!</p>
178 <p class="head2">Usage:</p>
179 <blockquote>
180 <b><code>
181 unopkg add &lt;options&gt; package-path...<br>
182 unopkg remove &lt;options&gt; package-name...<br>
183 unopkg list &lt;options&gt; package-name...<br>

--- 190 unchanged lines hidden (view full) ---

374 </td>
375 </tr>
376 <tr>
377 <td colspan="3">
378 <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used
379 to check UNODL type definitions and transform valid type definitions
380 into a binary type library format, which is later used by all codemaker
381 tools. It is also used as a dynamic type library for UNO at runtime.<br>
176 <p><b>Note:</b> This tool works only in the <i>&lt;office&gt;/program</i>
177 directory!</p>
178 <p class="head2">Usage:</p>
179 <blockquote>
180 <b><code>
181 unopkg add &lt;options&gt; package-path...<br>
182 unopkg remove &lt;options&gt; package-name...<br>
183 unopkg list &lt;options&gt; package-name...<br>

--- 190 unchanged lines hidden (view full) ---

374 </td>
375 </tr>
376 <tr>
377 <td colspan="3">
378 <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used
379 to check UNODL type definitions and transform valid type definitions
380 into a binary type library format, which is later used by all codemaker
381 tools. It is also used as a dynamic type library for UNO at runtime.<br>
382 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 &quot;UNOIDL Syntax Specification&quot; chapter in the Developer's Guide">here</a>.</p>
382 You can find a syntax description for UNOIDL <a href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/AppendixD/UNOIDL_Syntax_Specification" title="link to the &quot;UNOIDL Syntax Specification&quot; chapter in the Developer's Guide">here</a>.</p>
383 <p class="head2">Usage:</p>
384 <blockquote>
385 <b><code>idlc [-options] file_1 ... file_n | @&lt;filename&gt;</code></b>
386 </blockquote>
387 <p>
388 <table class="table4">
389 <tr>
390 <td class="cell15"><code>file_1 ... file_n</code></td>

--- 56 unchanged lines hidden (view full) ---

447 <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
448 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
449 </td>
450 </tr>
451 <tr>
452 <td colspan="3">
453 <p>The 'cppumaker' generates a C++ representation for idl types. The
454 cppumaker works on a typelibrary, which is generated by the UNOIDL
383 <p class="head2">Usage:</p>
384 <blockquote>
385 <b><code>idlc [-options] file_1 ... file_n | @&lt;filename&gt;</code></b>
386 </blockquote>
387 <p>
388 <table class="table4">
389 <tr>
390 <td class="cell15"><code>file_1 ... file_n</code></td>

--- 56 unchanged lines hidden (view full) ---

447 <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
448 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
449 </td>
450 </tr>
451 <tr>
452 <td colspan="3">
453 <p>The 'cppumaker' generates a C++ representation for idl types. The
454 cppumaker works on a typelibrary, which is generated by the UNOIDL
455 compiler (<a href="#idlc" link="link to the idlc tool description">
456 idlc</a>). It generates the output for all specified types and for all
455 compiler (<a href="#idlc" link="link to the idlc tool description">idlc</a>).
456 It generates the output for all specified types and for all
457 types the specified types depend on.</p>
458 <p class="head2">Usage:</p>
459 <blockquote>
460 <b><code>cppumaker [-options] file_1 ... file_n</code></b>
461 </blockquote>
462 <p class="head2">Options:</p>
463 <p>
464 <table class="table4">

--- 72 unchanged lines hidden (view full) ---

537 <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
538 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
539 </td>
540 </tr>
541 <tr>
542 <td colspan="3">
543 <p>The 'javamaker' generates the appropriate Java class file for each idl
544 type. The javamaker works on a typelibrary which is generated by the
457 types the specified types depend on.</p>
458 <p class="head2">Usage:</p>
459 <blockquote>
460 <b><code>cppumaker [-options] file_1 ... file_n</code></b>
461 </blockquote>
462 <p class="head2">Options:</p>
463 <p>
464 <table class="table4">

--- 72 unchanged lines hidden (view full) ---

537 <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
538 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
539 </td>
540 </tr>
541 <tr>
542 <td colspan="3">
543 <p>The 'javamaker' generates the appropriate Java class file for each idl
544 type. The javamaker works on a typelibrary which is generated by the
545 UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description">
546 idlc</a>). It generates the output for all specified types and for all
547types the specified types depend on.</p>
545 UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description">idlc</a>).
546 It generates the output for all specified types and for all
547 types the specified types depend on.</p>
548 <p class="head2">Usage:</p>
549 <blockquote>
550 <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b>
551 </blockquote>
552 <p class="head2">Options:</p>
553 <p>
554 <table class="table4">
555 <tr>

--- 59 unchanged lines hidden (view full) ---

615 <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
616 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
617 </td>
618 </tr>
619 <tr>
620 <td colspan="3">
621 <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl
622 type. The climaker works on a typelibrary which is generated by the
548 <p class="head2">Usage:</p>
549 <blockquote>
550 <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b>
551 </blockquote>
552 <p class="head2">Options:</p>
553 <p>
554 <table class="table4">
555 <tr>

--- 59 unchanged lines hidden (view full) ---

615 <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a>
616 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
617 </td>
618 </tr>
619 <tr>
620 <td colspan="3">
621 <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl
622 type. The climaker works on a typelibrary which is generated by the
623 UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description">
624 idlc</a>). It generates the output for all specified types and for all
625 types the specified types depend on.</p>
623 UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description">idlc</a>).
624 It generates the output for all specified types and for all
625 types the specified types depend on.</p>
626 <p class="head2">Usage:</p>
627 <blockquote>
628 <b><code>climaker &lt;switches&gt; [registry-file-1 registry-file-2 ...]</code></b>
629 </blockquote>
630 <p class="head2">Options:</p>
631 <p>
632 <table class="table4">
633 <tr>

--- 367 unchanged lines hidden (view full) ---

1001 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
1002 </td>
1003 </tr>
1004 <tr>
1005 <td colspan="3">
1006 <p>The 'autodoc' tool is used for creating javadoc-like documentation
1007 from C++ and UNOIDL source code.</p>
1008 <p>There are some conventions to follow when documenting C++- or
626 <p class="head2">Usage:</p>
627 <blockquote>
628 <b><code>climaker &lt;switches&gt; [registry-file-1 registry-file-2 ...]</code></b>
629 </blockquote>
630 <p class="head2">Options:</p>
631 <p>
632 <table class="table4">
633 <tr>

--- 367 unchanged lines hidden (view full) ---

1001 <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a>
1002 </td>
1003 </tr>
1004 <tr>
1005 <td colspan="3">
1006 <p>The 'autodoc' tool is used for creating javadoc-like documentation
1007 from C++ and UNOIDL source code.</p>
1008 <p>There are some conventions to follow when documenting C++- or
1009 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>
1009 UNOIDL-sourcecode. See also the <a href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/AppendixB/IDL_Documentation_Guidelines" title="link to the UNOIDL Documentation Guidelines">UNOIDL Documentation Guidelines</a>.<br>
1010 If you are not familiar with these, but do know javadoc: For simple C++
1011 sourcecode documentation, using javadoc-style comments will work.</p>
1012 <p class="head2">Usage:</p>
1013 <blockquote>
1014 <b><code>autodoc [ -v &lt;VerboseNr&gt; ] [ -name "&lt;TitleForTheDocu&gt;" ] -html &lt;OutputDirectory&gt; -lg &lt;SourcecodeLanguage&gt;<br>
1015 { [ -p &lt;ProjectName&gt; &lt;ProjectRootDirectory&gt; ] &nbsp;-t &lt;SourceTree&gt;* | -d &lt;SourceDirectory&gt;* | -f &lt;SourceFile&gt;* }*</code></b>
1016 </blockquote>
1017 <p class="head2">Options:</p>

--- 80 unchanged lines hidden (view full) ---

1098 <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
1099 </tr>
1100 <tr>
1101 <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
1102 </tr>
1103 <tr>
1104 <td colspan="3">
1105 <div class="centertext">
1010 If you are not familiar with these, but do know javadoc: For simple C++
1011 sourcecode documentation, using javadoc-style comments will work.</p>
1012 <p class="head2">Usage:</p>
1013 <blockquote>
1014 <b><code>autodoc [ -v &lt;VerboseNr&gt; ] [ -name "&lt;TitleForTheDocu&gt;" ] -html &lt;OutputDirectory&gt; -lg &lt;SourcecodeLanguage&gt;<br>
1015 { [ -p &lt;ProjectName&gt; &lt;ProjectRootDirectory&gt; ] &nbsp;-t &lt;SourceTree&gt;* | -d &lt;SourceDirectory&gt;* | -f &lt;SourceFile&gt;* }*</code></b>
1016 </blockquote>
1017 <p class="head2">Options:</p>

--- 80 unchanged lines hidden (view full) ---

1098 <td class="content1"><img class="nothing8" src="images/nada.gif"></td>
1099 </tr>
1100 <tr>
1101 <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
1102 </tr>
1103 <tr>
1104 <td colspan="3">
1105 <div class="centertext">
1106 <p><img class="apachelogo" src="images/odk-footer-logo.gif" title="Apache Feather" alt="Apache Feather" />
1106 <p><img class="apachelogo" src="images/sdk-footer-logo.png" title="Apache Logo" alt="Apache Logo" />
1107 Copyright &copy; 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 </div>
1109 </td>
1110 </tr>
1111</table>
1112<map name="Map">
1113 <area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org">
1114</map>
1115</body>
1116</html>
1107 Copyright &copy; 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 </div>
1109 </td>
1110 </tr>
1111</table>
1112<map name="Map">
1113 <area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org">
1114</map>
1115</body>
1116</html>