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