diff options
| author | Juergen Schmidt <jsc@openoffice.org> | 2002-05-07 12:03:23 +0000 |
|---|---|---|
| committer | Juergen Schmidt <jsc@openoffice.org> | 2002-05-07 12:03:23 +0000 |
| commit | bc0ce24428b5773d6c4ed70b7dbac34c57b3ef6f (patch) | |
| tree | a12f482cafdaf41d33a848c9a22aa4400a1f8c32 /odk | |
| parent | 9bd015bd55f186dd8227353fb4067a72b705d513 (diff) | |
#99053# new docu html files
Diffstat (limited to 'odk')
| -rw-r--r-- | odk/docs/install.html | 221 | ||||
| -rw-r--r-- | odk/docs/notsupported.html | 90 | ||||
| -rw-r--r-- | odk/docs/tools.html | 1027 |
3 files changed, 1338 insertions, 0 deletions
diff --git a/odk/docs/install.html b/odk/docs/install.html new file mode 100644 index 000000000000..80e0e31eaee0 --- /dev/null +++ b/odk/docs/install.html @@ -0,0 +1,221 @@ +<html> +<head> + <title>[TITLE] SDK-Installation guide</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="AUTHOR" content="Jürgen Schmidt"> + <meta name="CREATED" content="20020311;11245374"> + <meta name="CHANGEDBY" content="Jürgen Schmidt"> + <meta name="CHANGED" content="20020311;11420968"> +</head> + +<body bgcolor="#FFFFFF" text="#000000" leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> +<table width="100%" border="0" cellspacing="0" cellpadding="0"> + <tr> + <td height="15" colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="../docs/images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td> + <div align="left"><img src="../docs/images/sdk_logo.gif" width="328" height="121"></div> + </td> + <td><img src="../docs/images/black_dot.gif" width="1" height="121"></td> + <td width="222"> + <div align="left"><img src="../docs/images/logo.gif" width="222" height="121"></div> + </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td><img src="../docs/images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#99CCFF" height="12"></td> + <td bgcolor="#99CCFF" height="12"><img src="../docs/images/black_dot.gif" width="1" height="12"></td> + <td bgcolor="#003399" height="12" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="../docs/images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3" height="8"> + <blockquote> + <table width="100%" border="0" cellpadding="4"> + <tr> + <td colspan="4" align=center><a name="examples"/><font size="6"><b>Installation guide</b></font> + <a href="../index.html">SDK home</a> + </td> + </tr> + <tr> + <td colspan="4"> </td> + </tr> + <tr> + <td colspan="4"> + <p>The [PRODUCTNAME] SDK comes with a set of development tools, base libraries and jar files which + can be used to develop Java/C++ components, to embed [PRODUCTNAME] application in your own programs + or to use the API (scripting or remote control the office). For a complete working + environment we have some additional requirements. + </p> + <dl> + <dt><b>StarOffice™ or OpenOffice.org installation</b> + <dd>The SDK works on top of an existing office installation and uses the same libraries as the office. + <dt><b>JDK (1.3.1_02 or higher)</b> + <dd>A JDK is necessary for developing Java components or applications + <dt><b>C++ compiler</b> + <dd>A C++ compler is necessary for developing C++ components or applications. UNO depends + on a compiler dependent language binding so that we use the appropriate compiler where a + language binsing exists:<br> + Solaris, Sun WorkShop 6 update 1 C++ 5.2 2000/09/11<br> + Linux, GNU C++ compiler, gcc vwersion 3.0.1<br> + Windows, Microsoft C++ Compiler, Microsoft Developer Studio 6.0 (cl, version 12.00.8168)<br> + <dt><b>GNU make (3.79.1 or higher)</b> + <dd>GNU make is used to build the examples of the SDK. + </dl> + <p>The SDK provides a shell script (Windows and UNIX) to set the necessary environment variables + for using the SDK and the required tools. + </p> + <ul> + <li><a href="../setsdkenv_unix">setsdkenv_unix</a> + <li><a href="../setsdkenv_windows.bat">setsdkenv_windows.bat</a> + </ul> + <p>The first time you use the script you have have to prepare it for your environment. Edit the script + and set the following variabels: + </p> + <p> + <table width="100%" border=1 cellpadding=4 cellspacing=0> + <tr> + <td widht=35%><b>OFFICE_HOME</b></td> + <td widht=65%>path to an exisiting StarOffice™ or OpenOffice.org installation, e.g. + "/usr/local/StarOffice6.0"</td> + </tr> + <tr> + <td widht=35%><b>SDK_HOME</b></td> + <td widht=65%>path to the SDK root directory, e.g "/usr/local/StarOffice6.0SDK"</td> + </tr> + <tr> + <td widht=35%><b>SDK_JAVA_HOME</b></td> + <td widht=65%>path to the JDK</td> + </tr> + <tr> + <td widht=35%><b>SDK_CPP_HOME</b></td> + <td widht=65%>path to the C++ compiler (under windows the directory where the vcvar32.bat file + can be found)</td> + </tr> + <tr> + <td widht=35%><b>SDK_MAKE</b></td> + <td widht=65%>path to GNU make</td> + </tr> + </table> + </p> + <p>If you don't want to use the script to set your working environment you have to set the appropriate + environment variables by yourself. The script sets the following environment variables. + </p> + <p><b>Environment variables for UNIX</b></p> + <p> + <table width="100%" border=1 cellpadding=4 cellspacing=0> + <tr> + <td widht=35%>OFFICE_PROGRAM_PATH</td> + <td widht=65%><b>=<i>$OFFICE_HOME/program</i></b><br> + This variable is used to register example components + automatically in your Office installation. If you don't want automatic registration, + pleace comment this variable out in the script.</td> + </tr> + <tr> + <td widht=35%>LD_LIBRARY_PATH</td> + <td widht=65%><b>=<i>$LD_LIBRARY_PATH/$OFFICE_PROGRAM_PATH:$SDK_HOM/solsparc/lib</i></b><br> + The LD_LIBRARY_PATH will be set or will be extended by the office program path and the platform + dependent lib directory for some additional libraries. + </td> + </tr> + <tr> + <td widht=35%>PATH</td> + <td widht=65%><b>=<i>$PATH:$SDK_HOM/solsparc/bin:$SDK_MAKE:$SDK_CPP_HOME:$SDK_JAVA_HOME/bin</i></b><br> + The PATH variable will be extended by the pathes for the SDK development tools, the compiler, + the JDK, GNU make. + </td> + </tr> + </table> + </p> + <p><b>Environment variables for Windows</b></p> + <p> Additionally to setting these environment varibales the script calls the "vcvar32.bat" batch file + which is provided by the Microsoft Develper Studio to set the necessary environment varibales for + the compiler. + <table width="100%" border=1 cellpadding=4 cellspacing=0> + <tr> + <td widht=35%>OFFICE_PROGRAM_PATH</td> + <td widht=65%><b>=<i>$OFFICE_HOME/program</i></b><br> + This variable is used to register example components + automatically in your Office installation. If you don't want automatic registration, + pleace comment this variable out in the script.</td> + </tr> + <tr> + <td widht=35%>PATH</td> + <td widht=65%><b>=<i>$PATH:$SDK_HOME/solsparc/bin:$SDK_MAKE:$SDK_CPP_HOME:$SDK_JAVA_HOME/bin + :$OFFICE_PROGRAM_PATH</i></b><br> + The PATH variable will be extended by the pathes for the SDK development tools, the compiler, + the JDK, GNU make and the $OFFICE_PROGRAM_PATH. + </td> + </tr> + <tr> + <td widht=35%>LIB</td> + <td widht=65%><b>=<i>$LIB:$SDK_HOME/windows/lib</i></b><br> + The LIB variable will be extended by the path to the import libraries which are necessary + for winsows. + </td> + </tr> + <tr> + <td colspan="2">Additionally to setting these environment varibales the script calls the + "vcvar32.bat" batch file which is provided by the Microsoft Develper Studio to set the + necessary environment varibales for the compiler.</td> + </tr> + </table> + </p> + </td> + </tr> + <tr> + <td colspan="4"> </td> + </tr> + </table> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="../docs/images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="../docs/images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="../docs/images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <p align=center><font size=2><b>Copyright 2002 Sun Microsystems, + Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</b></font> + </p> +   + </td> + </tr> +</table> +</body> +</html> diff --git a/odk/docs/notsupported.html b/odk/docs/notsupported.html new file mode 100644 index 000000000000..dbe7b65c112c --- /dev/null +++ b/odk/docs/notsupported.html @@ -0,0 +1,90 @@ +<html> +<head> + <title>[TITLE] SDK-Not supported page</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="AUTHOR" content="Jürgen Schmidt"> + <meta name="CREATED" content="20020311;11245374"> + <meta name="CHANGEDBY" content="Jürgen Schmidt"> + <meta name="CHANGED" content="20020311;11420968"> +</head> + +<body bgcolor="#FFFFFF" text="#000000" leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> +<table width="100%" border="0" cellspacing="0" cellpadding="0"> + <tr> + <td height="15" colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td> + <div align="left"><img src="images/sdk_logo.gif" width="328" height="121"></div> + </td> + <td><img src="images/black_dot.gif" width="1" height="121"></td> + <td width="222"> + <div align="left"><img src="images/logo.gif" width="222" height="121"></div> + </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#99CCFF" height="12"></td> + <td bgcolor="#99CCFF" height="12"><img src="images/black_dot.gif" width="1" height="12"></td> + <td bgcolor="#003399" height="12" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3" height="8"> + <table width="100%" border="0" cellpadding="5"> + <tr> + <td> + <p align=center><font SIZE=6><b><i>This page is currently not supported!<i></b></font></p> + </td> + </tr> + </table> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <p align=center><font size=2><b>Copyright 2002 Sun Microsystems, + Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</b></font> + </p> +   + </td> + </tr> +</table> +</body> +</html> diff --git a/odk/docs/tools.html b/odk/docs/tools.html new file mode 100644 index 000000000000..065ed9922de1 --- /dev/null +++ b/odk/docs/tools.html @@ -0,0 +1,1027 @@ +<html> +<head> + <title>[TITLE] SDK-Development Tools</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="AUTHOR" content="Jürgen Schmidt"> + <meta name="CREATED" content="20020311;11245374"> + <meta name="CHANGEDBY" content="Jürgen Schmidt"> + <meta name="CHANGED" content="20020311;11420968"> +</head> + +<body bgcolor="#FFFFFF" text="#000000" leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> +<table width="100%" border="0" cellspacing="0" cellpadding="0"> + <tr> + <td height="15" colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td> + <div align="left"><img src="images/sdk_logo.gif" width="328" height="121"></div> + </td> + <td><img src="images/black_dot.gif" width="1" height="121"></td> + <td width="222"> + <div align="left"><img src="images/logo.gif" width="222" height="121"></div> + </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#99CCFF" height="12"></td> + <td bgcolor="#99CCFF" height="12"><img src="images/black_dot.gif" width="1" height="12"></td> + <td bgcolor="#003399" height="12" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3" height="8"> + <table width="100%" border="0" cellpadding="4"> + <tr> + <td colspan="4" align=center><a name="tools"/><font size="6"><b>Development Tools</b></font></td> + </tr> + <tr> + <td colspan="4"> </td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#idlc">idlc</a></font> + </td> + <td width=86%> + The UNOIDL compiler, generates a common binary type library format as base for all codemaker + tools and the UNO runtime type library. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#cppumaker">cppumaker</a></font> + </td> + <td width=86%> + Tool for generating C++ code for the UNOIDL types stored in a type library. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#javamaker">javamaker</a></font> + </td> + <td width=86%> + Tool for generating Java code for the UNOIDL types stored in a type library. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#rdbmaker">rdbmaker</a></font> + </td> + <td width=86%> + Tool for building type libraries with only a specified set of types and their dependencies. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#regcomp">regcomp</a></font> + </td> + <td width=86%> + The UNO component registration tool. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#regmerge">regmerge</a></font> + </td> + <td width=86%> + Tool to merge several registry (type libraries) files into one file. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#regview">regview</a></font> + </td> + <td width=86%> + Tool to view the content of a registry key (type node). + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#xml2cmp">xml2cmp</a></font> + </td> + <td width=86%> + A small helper tool to extract different information from xml module description files. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#unoexe">uno</a></font> + </td> + <td width=86%> + Tool to start UNO components and provide a UNO runtime environment. + </td> + <td width=2%></td> + </tr> + <tr> + <td width=2%></td> + <td width=10%> + <font size="3"><a href="#autodoc">autodoc</a></font> + </td> + <td width=86%> + Tool to generate javadoc like documentation for C/C++ and UNOIDL files. + </td> + <td width=2%></td> + </tr> + </table> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="idlc">idlc</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>'idlc' is the UNOIDL compiler, a full featured compiler to check UNODL type definitions and + transform valid type definitions into a binary type library format which is later used of all + codemaker tools, and is used as a dynamic type library for UNO at runtime.<br> + You can find a syntax description for UNOIDL <a href="notsupported.html">here</a>.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>idlc [-options] file_1 ... file_n | @<filename></code></b> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td widht=15%><code>file_1 ... file_n</code></td> + <td width=85%> + specifies one or more idl files. Only files with the extension '.idl' are valid. + </td> + </tr> + <tr> + <td width=15%><code>@<filename></code></td> + <td width=85%> + filename specifies the name of a command file. + </td> + </tr> + </table> + </p> + <p><b>Options:</b></p> + <p> + <TABLE width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-O<path></code></td> + <td width=85%> + 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 width=15%><code>-I<path></code></td> + <td width=85%> + path specifies a directory where include files are located, that will be searched by the + preprocessor. Multiple directories can be combined with ';'. + </td> + </tr> + <tr> + <td width=15%><code>-D<name></code></td> + <td width=85%> + name defines a macro for the preprocessor. + </td> + </tr> + <tr> + <td width=15%><code>-C</code></td> + <td width=85%> + generate complete type information, including additional service information and documentation. + </td> + </tr> + <tr> + <td width=15%><code>-h|?</code></td> + <td width=85%> + print this help message and exit. + </td> + </tr> + </table> + </p> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="cppumaker">cppumaker</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>The cppumaker generates a C++ representation for idl types. The cppumaker works on a typelibrary + which is generated by the unoidl. It generates the output for all specified types and for all types + the specified types depend on.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>cppumaker [-options] file_1 ... file_n</code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-O<path></code></td> + <td width=85%> + path describes the root directory for the generated output. The output directory + tree is generated under this directory. + </td> + </tr> + <tr> + <td width=15%><code>-T<name></code></td> + <td width=85%> + name specifies a type or a list of types. The output for this [t1;...] type is generated. + If no '-T' option is specified, then output for all types is generated. + </td> + </tr> + <tr> + <td width=15%><code>-B<name></code></td> + <td width=85%> + name specifies the base node. All types are searched under this node. Default is the + root '/' of the registry files. + </td> + </tr> + <tr> + <td width=15%><code>-L|-C</code></td> + <td width=85%> + In general, the cppumaker tool generates getCppuType() functions in three ways: + <p> + <ol> + <li>no option (default)<br> + This generates headers so that UNO runs correctly as long as: + <dl> + <dt style="margin-right: 1cm; margin-bottom: 0.5cm"> + -- one compiler compiled all code (no bridging needed for inter-component communication) + </dt> + <dt style="margin-right: 1cm; margin-bottom: 0.5cm"> + -- no marshaling is needed (no bridging needed for interprocess communication) + </dt> + <dt style="margin-right: 1cm; margin-bottom: 0.5cm"> + -- no scripting is needed (in general, this needs full type description support) + </dt> + </dl> + <li>-L (_ONLY_ usable on Windows!)<br> + This option generates the shortest getCppuType() functions, but + needs a running type description manager (+provider) reading all + type information from the applicat.rdb! ==> !! Cannot be used + at setup startup, because no applicat.rdb is involved at this + early stage!! + <li>-C (fully comprehensive type information)<br> + This options generates the longest form of getCppuType() functions, + including a comprehensive description of a type, thus there is + no need for a type description manager (+provider) reading types + from applicat.rdb: + <dl> + <dt style="margin-right: 1cm; margin-bottom: 0.5cm"> + -- limitation: only previously used types are provided by the runtime (i.e., only types + which were previously registered due to a getCppuType() call are accessible by name) + </dt> + </dl> + </ol> + </p> + </td> + </tr> + <tr> + <td width=15%><code>-G</code></td> + <td width=85%> + generate only target files which do not exist. + </td> + </tr> + <tr> + <td width=15%><code>-Gc</code></td> + <td width=85%> + generate only target files whose content will be changed. + </td> + </tr> + </table> + </p> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="javamaker">javamaker</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>The javamaker generates the appropriate java file for each idl type. The javamaker works + on a typelibrary which is generated by the unoidl. It generates the output for all specified + types and for all types the specified types depend on.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>javamaker [-options] file_1 ... file_n</code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-O<path></code></td> + <td width=85%> + path describes the root directory for the generated output. The output directory + tree is generated under this directory. + </td> + </tr> + <tr> + <td width=15%><code>-T<name></code></td> + <td width=85%> + name specifies a type or a list of types. The output for this [t1;...] type is generated. + If no '-T' option is specified, then output for all types is generated. + </td> + </tr> + <tr> + <td width=15%><code>-B<name></code></td> + <td width=85%> + name specifies the base node. All types are searched under this node. Default is the + root '/' of the registry files. + </td> + </tr> + </table> + </p> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="rdbmaker">rdbmaker</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>The rdbmaker generates subsets of the typelibrary. The rdbmaker works on a typelibrary which + is generated by the unoidl. It generates a subset of the typelibrary which contains all specified + types and all types the specified types depend on. This could be used to provide all types and + only the necessary types for a component.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>rdbmaker [-options] file_1 ... file_n</code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-O<fileName></code></td> + <td width=85%> + filename specifies the name of the generated registry or text file. + </td> + </tr> + <tr> + <td width=15%><code>-L</code></td> + <td width=85%> + specifies that only a text file is generated with the names of the specified types + and their dependencies. Default is that a registry file will be created. + </td> + </tr> + <tr> + <td width=15%><code>-T<name></code></td> + <td width=85%> + name specifies a type or a list of types. The output for this [t1;...] type is generated. + If no '-T' option is specified, then output for all types is generated. + </td> + </tr> + <tr> + <td width=15%><code>-FT<name></code></td> + <td width=85%> + name specifies a type or a list of types. For these types, nothing will be generated. + </td> + </tr> + <tr> + <td width=15%><code>-F<file></code></td> + <td width=85%> + file specifies a text file. For the specified types in this file, nothing will be generated. + </td> + </tr> + <tr> + <td width=15%><code>-B<name></code></td> + <td width=85%> + name specifies the base node. All types are searched under this node. Default is the + root '/' of the registry files. + </td> + </tr> + </table> + </p> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><A name="regcomp">regcomp</A></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>'regcomp' is a tool to register|revoke external UNO components into|from + a registry which is used for a UNO environment.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>regcomp -revoke [-br<registryfile>] -r <registryfile> -c <locationUrl> + [-l<componentLoaderName>]</code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-register|revoke</code></td> + <td width=85%> + register means that the components will be installed and revoke means that they will be removed. + </td> + </tr> + <tr> + <td width=15%><code>-br<registryfile></code></td> + <td width=85%> + the name of the registry used for bootstrapping the program. If the bootstrap registry is + specified and has the same name as the registration registry, '-r' is optional. + </td> + </tr> + <tr> + <td width=15%><code>-r<registryfile></code></td> + <td width=85%> + the name of the registry (will be created if it does not exist) where the component should + be registered. + </td> + </tr> + <tr> + <td width=15%><code>-c<locationUrls></code></td> + <td width=85%> + the location of a component (DLL, Class name, or an url of a jar file) or a list of urls + separated by ';'s. Note, if a list of urls is specified, the components must all need the + same loader. + </td> + </tr> + <tr> + <td width=15%><code>-l<componentLoaderName></code></td> + <td width=85%> + 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> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><A name="regmerge">regmerge</A></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <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 targetfile + the value would be overwritten by the value of the sourcefile.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>regmerge <mergefile> mergeKeyName &tg;regfile_1> ... <regfile_n></code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-register|revoke</code></td> + <td width=85%> + register means that the components will be installed and revoke means that they will be removed. + </td> + </tr> + <tr> + <td width=15%><code>-br<registryfile></code></td> + <td width=85%> + the name of the registry used for bootstrapping the program. If the bootstrap registry is + specified and has the same name as the registration registry, '-r' is optional. + </td> + </tr> + <tr> + <td width=15%><code>-r<registryfile></code></td> + <td width=85%> + the name of the registry (will be created if it does not exist) where the component should + be registered. + </td> + </tr> + <tr> + <td width=15%><code>-c<locationUrls></code></td> + <td width=85%> + the location of an component (DLL, Class name, or an url of a jar file) or a list of urls + seperated by ';'s. Note, if a list of urls is specified, the components must all need the + same loader. + </td> + </tr> + <tr> + <td width=15%><code>-l<componentLoaderName></code></td> + <td width=85%> + 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> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><A name="regview">regview</A></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <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 to stdout in a human readable form.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>regview <registryfile> [<keyName>]</code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-br<registryfile></code></td> + <td width=85%> + the name of the registry whose contents should be viewed. + </td> + </tr> + <tr> + <td width=15%><code><keyName></code></td> + <td width=85%> + the name of a registry key. The name must be full 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> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="xml2cmp">xml2cmp</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>The tool xml2cmp parses .xml files, which contain the descriptions of components that implement + UNO services. Each .xml file refers to one library. The library may contain one or more component + descriptions. <br> + There are two ways of using xml2cmp:</p> + <p><b>Usage:</b></p> + <ul> + <li> + <b><code>xml2cmp [-func <funcFile>] [-html <htmlFile>] [-types <typeFile>] + <Xml_FileName></code></b> + <p>This version parses the file <xml_filename> and produces three possible types of output, each of + which is optional, but there must be at least one of them.</p> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-func <funcFile></code></td> + <td width=85%> + produces a file with the name <code><funcfile></code>. This should be .c|.cxx|.cpp or similar + kind of source code file. This file contains the definition of the function 'const sal_Char * + SAL_CALL component_getDescriptionFunc();' which returns the parsed file as ASCII text. + </td> + </tr> + <tr> + <td width=15%><code>-html <htmlFile></code></td> + <td width=85%> + produces a file with the name <code><htmlfile></code>. It should be a .htm|.html file. That file + contains the contents of the parsed file in HTML-readable form. + </td> + </tr> + <tr> + <td width=15%><code>-types <typeFile></code></td> + <td width=85%> + produces a textfile with the name <code><typefile></code>. This textfile is intended to be + included in a makefile and contains the definition of a variable<br><br> + <code> + <libraryName>_XML2CMPTYPES= \<br> + <type_used_by_LibraryName_1> \<br> + <type_used_by_LibraryName_2> \<br> + ... <br> + </code> + <br> + So, the variable <libraryName>_XML2CMPTYPES contains a list of the types, + used by that library. + </td> + </tr> + </table> + </p> + <p>All output of this first version of xml2cmp is put into the working directory.</p> + </li> + </ul> + <ul> + <li> + <b><code>xml2cmp -ix <sourcedirectory> <outputdirectory> [<tagname1> + [<tagname2> ...]]</code></b> + <p>This version parses all .xml files which are found in <code><sourcedirectory></code> or its + subdirectories. It produces the .html output of all parsed .xml files (as in version 1 above). Also, + it produces a file, named xmlindex.html. This is an HTML file which contains tables alphabetically + ordered on the left side, which allows assigning, from one 'XML-tags' contents to another (of all + original parsed .xml files). The following tables are produced (Module refers to a library): + </p> + <p> + SupportedService -> ModuleName<br> + ModuleName -> SupportedService<br> + <tagname1> -> ComponentName<br> + <tagname2> -> ComponentName<br> + ... + </p> + <p>All output files of the second version of xml2cmp are put to the <outputDirectory></p> + </li> + </ul> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="unoexe">uno</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>The UNO-starter is for running a component or service process, 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 -- foo bar </code> </p> + <p>or</p> + <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 must export the interface + <a href="common/ref/com/sun/star/lang/XMain.html">com.sun.star.lang.XMain</a>:</p> + <p><code>interface XMain : com::sun::star::uno::XInterface <br> + { <br> + /** This method is called to run the component.<br> + <br> + @param aArguments command line arguments <br> + @return process error code to be returned to system <br> + */ <br> + long run( [in] sequence< string > arguments ); <br> + }; + </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 later.</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>uno (-c<ComponentImplementationName> -l <LocationUrl> + | -s <ServiceName>) <br> + [-ro <ReadOnlyRegistry1>] [-ro <ReadOnlyRegistry2>] ... [-rw <ReadWriteRegistry>]<br> + [-u uno:(socket[,host=<HostName>][,port=<nnn>]|pipe[,name=<PipeName>]);iiop|urp; + <Name><br> + [--singleaccept] [--singleinstance]] <br> + [-- <Argument1 Argument2 ...>] + </code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code><HostName></code></td> + <td width=85%> + 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> + <td width=15%><code><PipeName></code></td> + <td width=85%> + Name of a named pipe. + </td> + </tr> + <tr> + <td width=15%><code><Name></code></td> + <td width=85%> + Identifier for demanded called component instances. + </td> + </tr> + <tr> + <td width=15%><code><Registries></code></td> + <td width=85%> + The optional <code><Registries></code>(e.g., c:\myreg.rdb) are used by the ServiceManager. + The <font face="Courier New, Courier, mono">ro</font> ones are opened for reading only; + whereas, a single <font face="Courier New, Courier, mono">rw</font> one will be opened for + reading and writing. If the <font face="Courier New, Courier, mono">rw</font> one does not + exist, then it may be created. Components may read and write to store their persistent state. + </td> + </tr> + <tr> + <td width=15%><code>--singleaccept</code></td> + <td width=85%> + The uno starter will accept one connection, provide the component instance and die. + </td> + </tr> + <tr> + <td width=15%><code>--singleinstance</code></td> + <td width=85%> + 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"> + com.sun.star.bridge.UnoUrlResolver</a></b></p> + <p>You can easily connect to a server started with the -u (url) option by using this service giving + the same url to resolve. The service provides you an instance from remote.</p> + </p> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <blockquote> + <p><font size="5"><b><a name="autodoc">autodoc</a></b></font> + + <a href="../index.html">SDK home</a> <a href="#tools">tools overview</a> + </p> + <p>The autodoc tools ...</p> + <p><b>Usage:</b></p> + <blockquote> + <b><code>autodoc ... </code></b> + <p><b>Options:</b></p> + <p> + <table width=100% border=1 cellpadding=4 cellspacing=0> + <tr> + <td width=15%><code>-O<path></code></td> + <td width=85%> + path describes the root directory for the generated output. The output directory + tree is generated under this directory. + </td> + </tr> + <tr> + <td width=15%><code>-T<name></code></td> + <td width=85%> + name specifies a type or a list of types. The output for this [t1;...] type is generated. + If no '-T' option is specified, then output for all types is generated. + </td> + </tr> + <tr> + <td width=15%><code>-B<name></code></td> + <td width=85%> + name specifies the base node. All types are searched under this node. Default is the + root '/' of the registry files. + </td> + </tr> + </table> + </p> + </blockquote> + </td> + </tr> + <tr> + <td colspan="3"> </td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td bgcolor="#003399" height="6"></td> + <td bgcolor="#000000" height="6" width="1"><img src="images/black_dot.gif" width="1" height="6"></td> + <td bgcolor="#99CCFF" height="6" width="222"></td> + </tr> + <tr> + <td bgcolor="#000000" height="1"></td> + <td bgcolor="#000000" height="1" width="1"><img src="images/black_dot.gif" width="1" height="1"></td> + <td bgcolor="#000000" height="1" width="222"></td> + </tr> + <tr> + <td colspan="3" height="8"></td> + </tr> + <tr> + <td colspan="3"> + <p align=center><font size=2><b>Copyright 2002 Sun Microsystems, + Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</b></font> + </p> +   + </td> + </tr> +</table> +</body> +</html> |