diff options
Diffstat (limited to 'odk/docs')
26 files changed, 1896 insertions, 0 deletions
diff --git a/odk/docs/common/ref/idl.css b/odk/docs/common/ref/idl.css new file mode 100644 index 000000000000..3fdb1a07a00c --- /dev/null +++ b/odk/docs/common/ref/idl.css @@ -0,0 +1,131 @@ +/* Autodoc css file for IDL documentation */ + + +/*See bottom of file for explanations.*/ + +body { background-color:#ffffff; } + +#adc-idlref a { text-decoration: none; } +#adc-idlref a:link { color: #C44B01; } +#adc-idlref a:visited { color: #638093; } +#adc-idlref a:active { color: #9DCA12; } + +#adc-idlref h3 + { font-size:13pt; font-weight:bold; + margin-top:3pt; margin-bottom:1pt; } + +#adc-idlref p, #adc-idlref dt, #adc-idlref dd, #adc-idlref pre + { font-size:11pt; + margin-top:3pt; margin-bottom:1pt; } + +#adc-idlref pre { font-family:monospace; } + +#adc-idlref table.subtitle { margin-top:6pt; margin-bottom:6pt; } + +#adc-idlref td { font-size:11pt; } +#adc-idlref td.title + { font-family: Arial; font-size:19pt; font-weight:bold; + line-height:30pt; + background-image:url(../../images/bg_table.gif); + text-align:center; } + +#adc-idlref td.subtitle + { font-family: Arial; font-size:13pt; + line-height:20pt; + background-image:url(../../images/bg_table.gif); } + +#adc-idlref td.crosstitle + { font-size:12pt; font-weight:bold; + line-height:15pt; background-color:#eeeeff; } + +#adc-idlref td.imdetail + { width:100%; + background-image:url(../../images/bg_table3.gif); } + +#adc-idlref td.imsum_left { width:30%; } +#adc-idlref td.imsum_right { width:70%; } + +#adc-idlref table.navimain { background-image:url(../../images/bg_table2.gif); } + +#adc-idlref td.navimain + { background-image:url(../../images/bg_table2.gif); + text-align:center; + font-family: Arial; font-size:12pt; font-weight:bold; + padding-left:7pt; padding-right:7pt; } + +#adc-idlref td.navimainself + { text-align:center; + font-family: Arial; font-size:12pt; font-weight:bold; + color:#ffffff; } + +#adc-idlref td.navimainnone + { text-align:center; + font-family: Arial; font-size:12pt; } + +#adc-idlref td.navisub + { text-align:center; + font-family: Arial; font-size:9pt; font-variant:small-caps; + padding-left:7pt; padding-right:7pt; } + +#adc-idlref a.navimain + { text-align:center; + font-family: Arial; font-size:12pt; font-weight:bold; + color:#C44B01; } + +#adc-idlref a.navisub + { text-align:center; + font-family: Arial; font-size:9pt; font-variant:small-caps; + color:#C44B01; } + +#adc-idlref a.membertitle { font-size:12pt; font-weight:bold; line-height:18pt; } + +#adc-idlref a:link.navimain, #adc-idlref a:link.navisub { color:#C44B01; } +#adc-idlref a:visited.navimain, #adc-idlref a:visited.navisub { color: #638093; } +#adc-idlref a:active.navimain, #adc-idlref a:active.navisub { color: #9DCA12; } + +#adc-idlref .dt { font-weight:bold; } +#adc-idlref .namechain { font-size:13pt; font-weight:bold; + margin-top:3pt; margin-bottom:6pt; } +#adc-idlref .title2 { font-size:13pt; font-style:italic; font-weight:bold; text-align:left; } + +#adc-idlref table { empty-cells:show; } + +#adc-idlref .childlist td, +#adc-idlref .commentedlinks td, +#adc-idlref .memberlist td, +#adc-idlref .subtitle td, +#adc-idlref .crosstitle td { border: .1pt solid grey; } + +#adc-idlref .flag-table td { border: .1pt solid #cccccc; } + +#adc-idlref .title-table td, +#adc-idlref .table-in-method td, +#adc-idlref .table-in-data td, +#adc-idlref .navimain td, +#adc-idlref .navisub td, +#adc-idlref .expl-table td, +#adc-idlref .param-table td { border: none; } + + +/* Explanation of CSS classes: + +table.lightbg Background of navigation bar. +.navimain Text in main navigation bar. +.navisub Text in lower navigation bar. +td.navimainself Cell in main navigation bar with "selected" shadow: You are here. +td.navimainnone Cell in main navigation bar with no link. + +.namechain Line with current module path. + +td.crosstitle Comment box for bases (base interfaces etc.) +td.imsum_left Left part of such boxes. +td.imsum_right Right part of such boxes. + +td.title Main title of the page like "interface XYz" +.subtitle Tables, and head cells of those, which list members + like "method summary" and "method details". + +td.imdetail Background table of method's detail description. +a.membertitle Method name (as jump label) in method's detail + description. +*/ diff --git a/odk/docs/cpp/ref/cpp.css b/odk/docs/cpp/ref/cpp.css new file mode 100755 index 000000000000..d657b2b17244 --- /dev/null +++ b/odk/docs/cpp/ref/cpp.css @@ -0,0 +1,127 @@ +/* Autodoc css file for C++ documentation */ + + +body { background-color:#ffffff; } + +#adc-cppref a { text-decoration: none; } +#adc-cppref a:link { color: #C44B01; } +#adc-cppref a:visited { color: #638093; } +#adc-cppref a:active { color: #9DCA12; } + +#adc-cppref h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; } +#adc-cppref h2 { font-family:Arial; font-size:16pt; margin-top:3pt; margin-bottom:5pt; } +#adc-cppref h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; } +#adc-cppref h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } +#adc-cppref dl { margin-top:1pt; margin-bottom:1pt; } +#adc-cppref dl.member { margin-top:1pt; margin-bottom:1pt; + background-image:url(../../images/bg_table3.gif); } +#adc-cppref dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } +#adc-cppref dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } +#adc-cppref dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; } +#adc-cppref dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; } +#adc-cppref dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; } +#adc-cppref p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; } +#adc-cppref pre { font-family:monospace; font-size:10pt; margin-top:1pt; margin-bottom:1pt; } +#adc-cppref tr { font-size:10pt; } +#adc-cppref td { font-size:10pt; } + +#adc-cppref dt.attention { color:#dd0000; } + +#adc-cppref div.title { text-align:center; line-height:26pt; + background-image:url(../../images/bg_table.gif); } +#adc-cppref .subtitle { background-image:url(../../images/bg_table.gif); } + +#adc-cppref td.flagname { background-image:url(../../images/bg_table2.gif); + font-family:Arial; font-size:8pt; font-weight:bold; } +#adc-cppref td.flagyes { font-family:Arial; font-size:8pt; font-weight:bold; } +#adc-cppref td.flagno { font-family:Arial; font-size:8pt; } +#adc-cppref td.flagtext { font-family:Arial; font-size:8pt; font-weight:bold; } + +#adc-cppref td.navimain, td.navimain a + { background-image:url(../../images/bg_table2.gif); + font-family:Arial; font-size:12pt; font-weight:bold; } + +/* background-color:#eeeeff; color:#000000; */ + +#adc-cppref td.navimainself + { background-color:#2222ad; color:#ffffff; + font-family:Arial; font-size:12pt; font-weight:bold; } +#adc-cppref td.navimainnone + { background-image:url(../../images/bg_table2.gif); + font-family:Arial; font-size:12pt; } + +#adc-cppref div.define { font-family:Arial; background-color:#ccccff; } + +#adc-cppref .nqclass { color:#008800; } + +#adc-cppref h3.help { background-color:#eeeeff; margin-top:12pt; } + +#adc-cppref .btpubl { color:#33ff33; } +#adc-cppref .btprot { color:#cc9933; } +#adc-cppref .btpriv { color:#ff6666; } +#adc-cppref .btvpubl { color:#33ff33; font-style:italic; } +#adc-cppref .btvprot { color:#cc9933; font-style:italic; } +#adc-cppref .btvpriv { color:#ff6666; font-style:italic; } +#adc-cppref .btself { font-weight:bold; } + +#adc-cppref table { empty-cells:show; } + +#adc-cppref .childlist td, +#adc-cppref .commentedlinks td, +#adc-cppref .memberlist td, +#adc-cppref .title-table td, +#adc-cppref .subtitle td, +#adc-cppref .crosstitle td { border: .1pt solid grey } + +#adc-cppref .flag-table td { border: .1pt solid #cccccc; } + +#adc-cppref .table-in-method td, +#adc-cppref .table-in-data td, +#adc-cppref .navimain td, +#adc-cppref .navisub td, +#adc-cppref .expl-table td, +#adc-cppref .param-table td { border: none; } + + +/* Explanation of CSS classes: + +dl.member provides coloured frame for function descriptions. +dd.member makes the content of this frame white + +dt.attention special colour for @attention remarks + +div.title HTML page headline +.subtitle headline of lists of members and similar + + These are for the flagtables in classes: +td.flagname Flag name. +td.flagyes flag value "yes" +td.flagno flag value "no" +td.flagtext other flag value + + + These are for the main navigationbar: +td.navimain, td.navimain a + Links in navibar. +td.navimainself Text in navibar which refers to current page. +td.navimainnone Text which links to nothing. + + +div.define Subtitles on the #define/macro descriptions page + +.nqclass special color for classes in the qualification + on top of type pages like in: + ::nsp1::nsp2::_ClassXY_:: + +h3.help Subtitles on the help page + + These are for the base class tree on class pages: +.btpubl public base class +.btprot protected +.btpriv private +.btvpubl virtual public +.btvprot virtual protected +.btvpriv virtual private +.btself placeholder for currently displayed class + +*/ diff --git a/odk/docs/images/arrow-1.gif b/odk/docs/images/arrow-1.gif Binary files differnew file mode 100644 index 000000000000..e58046ae9d5a --- /dev/null +++ b/odk/docs/images/arrow-1.gif diff --git a/odk/docs/images/arrow-2.gif b/odk/docs/images/arrow-2.gif Binary files differnew file mode 100644 index 000000000000..94e7a2673e9e --- /dev/null +++ b/odk/docs/images/arrow-2.gif diff --git a/odk/docs/images/arrow-3.gif b/odk/docs/images/arrow-3.gif Binary files differnew file mode 100644 index 000000000000..e58046ae9d5a --- /dev/null +++ b/odk/docs/images/arrow-3.gif diff --git a/odk/docs/images/bg_table.gif b/odk/docs/images/bg_table.gif Binary files differnew file mode 100644 index 000000000000..8c961993cf31 --- /dev/null +++ b/odk/docs/images/bg_table.gif diff --git a/odk/docs/images/bg_table2.gif b/odk/docs/images/bg_table2.gif Binary files differnew file mode 100755 index 000000000000..8f8ad2f1d442 --- /dev/null +++ b/odk/docs/images/bg_table2.gif diff --git a/odk/docs/images/bg_table3.gif b/odk/docs/images/bg_table3.gif Binary files differnew file mode 100755 index 000000000000..d0c6469c9525 --- /dev/null +++ b/odk/docs/images/bg_table3.gif diff --git a/odk/docs/images/bluball.gif b/odk/docs/images/bluball.gif Binary files differnew file mode 100644 index 000000000000..dc7c020045d3 --- /dev/null +++ b/odk/docs/images/bluball.gif diff --git a/odk/docs/images/nada.gif b/odk/docs/images/nada.gif Binary files differnew file mode 100644 index 000000000000..75b945d25538 --- /dev/null +++ b/odk/docs/images/nada.gif diff --git a/odk/docs/images/nav_down.png b/odk/docs/images/nav_down.png Binary files differnew file mode 100644 index 000000000000..4f2cf361a3dd --- /dev/null +++ b/odk/docs/images/nav_down.png diff --git a/odk/docs/images/nav_home.png b/odk/docs/images/nav_home.png Binary files differnew file mode 100644 index 000000000000..36c4cf76cdde --- /dev/null +++ b/odk/docs/images/nav_home.png diff --git a/odk/docs/images/nav_left.png b/odk/docs/images/nav_left.png Binary files differnew file mode 100644 index 000000000000..605501566a97 --- /dev/null +++ b/odk/docs/images/nav_left.png diff --git a/odk/docs/images/nav_right.png b/odk/docs/images/nav_right.png Binary files differnew file mode 100644 index 000000000000..6b8c2185b2c3 --- /dev/null +++ b/odk/docs/images/nav_right.png diff --git a/odk/docs/images/nav_up.png b/odk/docs/images/nav_up.png Binary files differnew file mode 100644 index 000000000000..5576317aa47d --- /dev/null +++ b/odk/docs/images/nav_up.png diff --git a/odk/docs/images/ooo-main-app_32.png b/odk/docs/images/ooo-main-app_32.png Binary files differnew file mode 100644 index 000000000000..f2e6e9e4d451 --- /dev/null +++ b/odk/docs/images/ooo-main-app_32.png diff --git a/odk/docs/images/sdk_head-1.gif b/odk/docs/images/sdk_head-1.gif Binary files differnew file mode 100644 index 000000000000..53bf8a54685a --- /dev/null +++ b/odk/docs/images/sdk_head-1.gif diff --git a/odk/docs/images/sdk_head-2.gif b/odk/docs/images/sdk_head-2.gif Binary files differnew file mode 100644 index 000000000000..7fe80c4e48ce --- /dev/null +++ b/odk/docs/images/sdk_head-2.gif diff --git a/odk/docs/images/sdk_head-3.gif b/odk/docs/images/sdk_head-3.gif Binary files differnew file mode 100644 index 000000000000..053e5ec60a17 --- /dev/null +++ b/odk/docs/images/sdk_head-3.gif diff --git a/odk/docs/images/sdk_line-1.gif b/odk/docs/images/sdk_line-1.gif Binary files differnew file mode 100644 index 000000000000..cf04e12891cd --- /dev/null +++ b/odk/docs/images/sdk_line-1.gif diff --git a/odk/docs/images/sdk_line-2.gif b/odk/docs/images/sdk_line-2.gif Binary files differnew file mode 100644 index 000000000000..18c48453f0a1 --- /dev/null +++ b/odk/docs/images/sdk_line-2.gif diff --git a/odk/docs/images/so-main-app_32.png b/odk/docs/images/so-main-app_32.png Binary files differnew file mode 100644 index 000000000000..e79033ffe1ea --- /dev/null +++ b/odk/docs/images/so-main-app_32.png diff --git a/odk/docs/install.html b/odk/docs/install.html new file mode 100644 index 000000000000..e11440538bb5 --- /dev/null +++ b/odk/docs/install.html @@ -0,0 +1,418 @@ +<html> +<head> + <title>[TITLE] - Installation Guide</title> + <link rel="stylesheet" type="text/css" href="sdk_styles.css"> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="author" content="Jürgen Schmidt"> + <meta name="created" content="2004-12-14"> +</head> +<body class="sdkbody"><a name="install"/> +<table class="table1" cellpadding=0> + <tr style="background-image:url(images/sdk_head-2.gif); backgorund-position: bottom; "> + <td class="background" colspan="2" align="left"><img src="images/sdk_head-1.gif" width="335" height="109" usemap="#Map" border="0"></td> + <td class="background" align=right><img src="images/sdk_head-3.gif" width="32" height="109"></td> + </tr> + <tr> + <td colspan="3"><img class="nothing10" src="images/nada.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="3"><img class="nothing1" src="images/nada.gif"></td> + </tr> + <tr> + <td> + <table class="table3"> + <tr> + <td colspan="2" class="head1">Installation Guide</td> + <td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td> + </tr> + </table> + </td> + </tr> + <tr> + <td> + <table class="table3"> + <tr> + <td colspan="2"> + <p>The [PRODUCTNAME] SDK comes with a set of development tools, base + libraries, header files and helper class files that can be used to + develop Java/C++ components, to embed the [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> + </td> + </tr> + <tr valign="top"> + <td><b>[PRODUCTNAME] installation</td> + <td class="content80">The SDK works on top of an existing office + installation and uses the same libraries as the office installation.</td> + </tr> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr valign="top"> + <td><b>JDK (1.5 or higher)<b></td> + <td class="content80"> + <p>A JDK is necessary for developing Java components or applications. An appropriate Java SDK can be found on <a target="_blank" href="http://java.sun.com/products" title="link to the Java SDK download page (online)">http://java.sun.com/products</a>.</p> + <p>Recommendation is to use Java 6 excepting for Mac OS because initially Mac OS supported a 64bit version of Java 6 only.</p> + <p><b>Note</b>: The Java compiler is <b><u>optional</u></b>!</p></td> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr valign="top"> + <td><b>C++ compiler<b></td> + <td class="content80">A C++ compiler 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 binding + exists: + <table class="table4"> + <tr> + <td class="cell15">Solaris</td> + <td class="cell85">Sun Studion 8 (20070730)</td> + </tr> + <tr> + <td class="cell15">Linux</td> + <td class="cell80">GNU C++ compiler, gcc version 4.0.1</td> + </tr> + <tr> + <td class="cell15">Windows</td> + <td class="cell80">Microsoft C++ Compiler, Microsoft Visual Studio 2008 or the Express version (cl, version 15.00.21022)</td> + </tr> + </table> + <p><b>Note</b>: The C++ compiler is <b><u>optional</u></b>! If you use the Express edition you have to ensure that the <a href="http://www.microsoft.com/downloads/details.aspx?familyid=9B2DA534-3E03-4391-8A4D-074B9F2BC1BF&displaylang=en">Microsoft Visual Studio 2008 Redistributable Package</a> is also installed. You can download this package from Microsoft directly.</a></p></td> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr valign="top"> + <td><b>Microsoft .NET Framework SDK version 1.0 or higher<b></td> + <td class="content80">The SDK is required for building CLI applications. + That is, programs written in languages, such as C# or VB.NET.<br> + <p><b>Note</b>: The .NET Framework is <b><u>optional</u></b>!</p></td> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr valign="top"> + <td><b>GNU make (3.79.1 or higher)<b></td> + <td class="content80"> + <p>GNU make is used to build the examples of the SDK. GNU make is available from <a target="_blank" href="http://www.gnu.org" title="link to www.gnu.org (online)">http://www.gnu.org</a>. It can be ftped via <a target="_blank" href="ftp://ftp.gnu.org/gnu/make" title="link to gnumake on www.gnu.org (online)">ftp://ftp.gnu.org/gnu/make</a></p> + <p><b>Note</b>: Windows user can find an executable of gnu make under <a target="_blank" href="http://www.mingw.org/wiki/Getting_Started" title="link to the MinGW Getting Started wiki (online)">http://www.mingw.org/wiki/Getting_Started</a> (see the mingw32-make link under "Manual Installation"). Do not use the Cygwin make, because it does not + work well. On Solaris gnu make can be found often under <b><i>/usr/sfw/bin/gmake</i></b>, but keep in mind that you have to use <b>'gmake'</b> then. Or you can find gnu make also under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a>.</td> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr valign="top"> + <td><b>zip tool (2.3 or higher)<b></td> + <td class="content80">The zip tool is used to create UNO packages. zip is + a new requirement to make the SDK independent of a Java SDK.<br> + If you do not have these already, you can download them from <a target="_blank" href="http://www.info-zip.org" title="link to www.ubfi-zip.org (online)">http://www.info-zip.org</a>. Note: The cygwin zip.exe does not work for the build under + the 4NT shell. You have to use the native w32 version.</td> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td><img class="nothing10" src="images/nada.gif"></td> + <td align="right"> + <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td> + </tr> + <tr valign="middle"> + <td colspan="2"> + <p>The SDK provides an implicit configuration mechanism, which + configures the SDK build environment to your personal needs the first + time you use the SDK environment. This configuration step creates one or + two new setsdkenv_XXX scripts in the user's home directory:</P> + <ul> + <li><b>$HOME/$OO_SDK_NAME/setsdkenv_unix.sh</b> and <b>$HOME/$OO_SDK_NAME/setsdkenv_unix.csh</b> -> for Unix + <li><b>C:\Documents and Settings\<username>\Application Data\%OO_SDK_NAME%\setsdkenv_windows.bat</b></a> -> for Windows2000/XP or later + </ul> + <p>The automatically started configure script (Unix and Windows2000/XP) + requests relevant information and directories (SDK, StarOffice, GNU make, + Java, C++), in order to prepare a working SDK environment. After completing the + configure script once, the newly created script is always used to set the + necessary environment variables for using the SDK and the required + tools.</P> + <p>On UNIX operating systems, the configure script uses Perl. LINUX systems should have + installed a working Perl version, and on Solaris you can find a working + Perl version under <a target="_blank" href="http://www.sunfreeware.com/" title="link to www.sunfreeware.com (online)">http://www.sunfreeware.com/</a> if + necessary. On Windows, the configure script uses Windows Script and + a JScipt. If you have problems with Windows Script, you can download a + newer version of <a href ="http://www.microsoft.com/downloads/details.aspx?FamilyId=C717D943-7E4B-4622-86EB-95A22B832CAA&displaylang=en" link"link to the download page for the Windows Script">Windows Script</a>. + </p> + <p>On other versions of Windows, use the batch + file template <b><OO_SDK_HOME>\setsdkenv_windows.template</b>, + rename it to *.bat, and adapt it to your local environment.</p> + <p>If you use the template batch file, edit and set + the following variables:</p> + <table class="table4"> + <tr valign="top"> + <td class="cell20"><b>OFFICE_HOME</b></td> + <td class="cell80">Path to an existing StarOffice™ or OpenOffice.org + base installation, e.g. "/opt/staroffice8". Be sure + that it is not a user installation only. Exactly one of OFFICE_HOME + and OO_SDK_URE_HOME must be set. The other should be either unset or + set to an empty value.</td> + </tr> + <tr><a name="oosdkname"/> + <td class="cell20"><b>OO_SDK_NAME</b></td> + <td class="cell80">The configuration uses the + directory name of the SDK, but you can use another name as well. + It is important that the name does not contain spaces, because of a limitation + of gnu make which cannot handle spaces correctly. This name is, for + example, used to create an output directory in the users home directory + for any generated output when you use the SDK build environment.</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_URE_HOME</b></td> + <td class="cell80">Path to an existing UNO Runtime Environment + installation, e.g. "/opt/openoffice.org/ure". Exactly one of + OFFICE_HOME and OO_SDK_URE_HOME must be set. The other should be + either unset or set to an empty value.</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_HOME</b></td> + <td class="cell80">Path to the SDK root directory, e.g. + "/usr/local/StarOffice8_SDK"</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_JAVA_HOME</b></td> + <td class="cell80">Path to a JDK root directory. The JDK is + <b>optional</b> and only necessary if you like to run the Java examples + or if you like to use the SDK environment to develop your own Java + solution.</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_CPP_HOME</b></td> + <td class="cell80">Path to the C++ compiler (on Windows, the directory + where the "<i>vcvar32.bat</i>" file can be found). The C++ + compiler is <b>optional</b> and only necessary for building the C++ + examples.</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_CLI_HOME</b></td> + <td class="cell80">Path to the C# compiler and VB.NET compiler (on + Windows, this directory can be found under the system directory (e.g. + c:\WINXP\Microsoft.NET\Framework\v1.0.3705). The compilers are + <b>optional</b> and only necessary for building the CLI examples.<br> + <b>Note: Windows only!</b></td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_MAKE_HOME</b></td> + <td class="cell80">Path to GNU make.</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_ZIP_HOME</b></td> + <td class="cell80">Path to the 'zip' tool.</td> + </tr> + <tr> + <td class="cell20"><b>OO_SDK_OUTPUT_DIR</b></td> + <td class="cell80">Path to an existing directory where the example output + is generated. The output directory is <b>optional</b>, by default + the output is generated in the SDK directory itself. If an output + directory is specified, the output is generated in a SDK dependent + subdirectory in this directory (e.g. <OO_SDK_OUTPUT_DIR> + /[PRODUCTNAME]/LINUXExample.out)</td> + </tr> + <tr> + <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td> + <td class="cell80">If this variable is set, the component examples are automatically deployed into the Office installation referenced by + OFFICE_HOME. See also chapter <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the "Extension Manager - unopkg" chapter in the Developer's Guide">"Extension Manager - unopkg"</a> from the Developer's Guide. + This variable is only relevant when OFFICE_HOME is set.</td> + </tr> + </table> + <p>You must run the <b>setsdkenv_XXX</b> script every time you want to + use the configured SDK environment. The settings are local for the current + shell on Windows or the new started shell on UNIX. On UNIX you + can now source one of the prepared environment + script files ("setsdkenv_unix.sh" or + "setsdkenv_unix.csh" dependending on the shell you use) to prepare + your current shell instead of starting a new shell.</p> + </td> + </tr> + <tr valign="middle"> + <td colspan="2"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td><img class="nothing10" src="images/nada.gif"></td> + <td align="right"> + <a href="#install" title="link to the top of this page"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td> + </tr> + <tr> + <td colspan="2"> + <p class="head2">Manual Setting</p> + <p>If you do not want to use the script to set your working + environment, you must set the appropriate environment variables + yourself. The script sets the following environment variables:</p> + <p class="head3">Common Environment Variables</p> + <table class="table4"> + <tr valign="top"> + <td class="cell20">OO_SDK_NAME</td> + <td class="cell80">See description <a href="#oosdkname" title="link to the description of the environment variable OO_SDK_NAME">above</a>.</td> + </tr> + <tr valign="top"> + <td class="cell20">OO_SDK_URE_BIN_DIR</td> + <td class="cell80">The path within the chosen office or URE + installation where binary executables are located (e.g., + <i>$OFFICE_HOME/program</i> for an office installation, or + <i>$OO_SDK_URE_HOME/bin</i> for a Unix URE installation).</td> + </tr> + <tr valign="top"> + <td class="cell20">OO_SDK_URE_LIB_DIR</td> + <td class="cell80">The path within the chosen office or URE + installation where dynamic libraries are located (e.g., + <i>$OFFICE_HOME/program</i> for an office installation, or + <i>$OO_SDK_URE_HOME/lib</i> for a Unix URE installation).</td> + </tr> + <tr valign="top"> + <td class="cell20">OO_SDK_URE_JAVA_DIR</td> + <td class="cell80">The path within the chosen office or URE + installation where Java JARs are located (e.g., + <i>$OFFICE_HOME/program/classes</i> for an office installation, or + <i>$OO_SDK_URE_HOME/share/java</i> for a Unix URE installation).</td> + </tr> + <tr valign="top"> + <td class="cell20">CLASSPATH</td> + <td class="cell80"> + =<i>$OO_SDK_URE_JAVA_DIR/juh.jar; + $OO_SDK_URE_JAVA_DIR/jurt.jar; + $OO_SDK_URE_JAVA_DIR/ridl.jar; + $OO_SDK_URE_JAVA_DIR/unoloader.jar; + [$OO_SDK_URE_JAVA_DIR/unoil.jar;] + $CLASSPATH</i><br> + <p>The classpath will be set or extended to the necessary jar files of + the specified office installation. (<i>unoil.jar</i> is only included + when OFFICE_HOME is set.)</p> + </td> + </tr> + <tr valign="top"> + <td class="cell20">OFFICE_PROGRAM_PATH</td> + <td class="cell80">=<i>$OFFICE_HOME/program</i><br> + <p>This variable is used to find, for example, the office type library and + the UNO package deployment tool. This variable is only relevant when + OFFICE_HOME is set.</p> + </td> + </tr> + <tr valign="top"> + <td class="cell20">UNO_PATH</td> + <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br> + <p>This variable is used to ensure that the new C++ UNO bootstrap + mechanism uses the configured office installation of the SDK. Normally + the bootstrap mechanism finds the default office installation for the + user on the system. This variable is optional but is set from the scripts + to ensure a homogeneous environment. Especially useful during development + where you might have more than one office installation installed. This + variable is only relevant when OFFICE_HOME is set.</p> + </td> + </tr> + </table> + <p class="head3">Environment Variables for UNIX</p> + <p class="head4">Solaris</p> + <table class="table4"> + <tr valign="top"> + <td class="cell20">LD_LIBRARY_PATH</td> + <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i><br> + <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE + library path, the platform dependent lib directory for several additional + libraries.</p> + </td> + </tr> + <tr valign="top"> + <td class="cell20">PATH</td> + <td class="cell80">=<i>$OO_SDK_HOME/(solsparc|solintel)/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH</i></b><br> + <p>The PATH variable will be extended by the paths for the SDK development + tools, the compiler, the JDK, GNU make, the zip tool and the + OO_SDK_URE_BIN_DIR, where the compiler or the JDK are + optional.</p> + </td> + </tr> + <tr> + <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script + additionally creates symbolic links to the public dynamic libraries of + the URE in <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, which are + needed for linking.</td> + </tr> + </table> + <p class="head4">Linux</p> + <table class="table4"> + <tr valign="top"> + <td class="cell20">LD_LIBRARY_PATH</td> + <td class="cell80">=<i>$OO_SDK_URE_LIB_DIR: $SDK_HOME/linux/lib: $LD_LIBRARY_PATH</i><br> + <p>The LD_LIBRARY_PATH will be set or will be extended by the office/URE + library path, the platform dependent lib directory for some additional + libraries.</p> + </td> + </tr> + <tr valign="top"> + <td class="cell20">PATH</td> + <td class="cell80">=<i>$OO_SDK_HOME/linux/bin:$OO_SDK_MAKE_HOME: $OO_SDK_ZIP_HOME: [$OO_SDK_CPP_HOME:] [$OO_SDK_JAVA_HOME/bin:] $OO_SDK_URE_BIN_DIR: $PATH</i><br> + <p>The PATH variable will be extended by the paths for the SDK development + tools, the compiler, the JDK, GNU make, the zip tool and the + OO_SDK_URE_BIN_DIR, where the compiler and the JDK are + optional.</p> + </td> + </tr> + <tr> + <td colspan="2" class="cell80">When OO_SDK_URE_HOME is set, the script + additionally creates symbolic links to the public dynamic libraries of + the URE in <i>$OO_SDK_HOME/linux/lib</i>, which are needed for + linking.</td> + </tr> + </table> + <p class="head3">Environment Variables for Windows</p> + <table class="table4"> + <tr valign="top"> + <td class="cell20">PATH</td> + <td class="cell80">=<i>%OO_SDK_HOME%\windows\bin; %OO_SDK_MAKE_HOME%; %OO_SDK_ZIP_HOME%; [%OO_SDK_CLI_HOME%;] [%OO_SDK_CPP_HOME%;] [%OO_SDK_JAVA_HOME%\bin;] %OO_SDK_URE_BIN_DIR%; %PATH%</i><br> + <p>The PATH variable will be extended by the paths for the SDK development + tools, the compiler, the JDK, GNU make, the zip tool and the + OO_SDK_URE_BIN_DIR.</p> + </td> + </tr> + <tr valign="top"> + <td class="cell20">LIB</td> + <td class="cell80">=<i>%OO_SDK_HOME%\windows\lib; %LIB%</i><br> + <p>The LIB variable will be extended by the path to the import libraries + that are necessary for Windows.</p> + </td> + </tr> + <tr valign="top"> + <td colspan="2" class="cell80">In addition to setting these environment + variables, the script calls the "<i>vcvar32.bat</i>" batch file + which is provided by the Microsoft Developer Studio to set the necessary + environment variables for the compiler.</td> + </tr> + </table> + </td> + </tr> + </table> + </td> + </tr> + </table> + </td> + </tr> + <tr> + <td colspan="3"><img class="nothing30" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr> + <td colspan="3"> + <div align="center"><p>Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved.</p></div> + </td> + </tr> +</table> +<map name="Map"> + <area shape="rect" coords="10,68,93,105" href="http://www.oracle.com"> +</map> +</body> +</html> diff --git a/odk/docs/notsupported.html b/odk/docs/notsupported.html new file mode 100644 index 000000000000..ce02acedb3c0 --- /dev/null +++ b/odk/docs/notsupported.html @@ -0,0 +1 @@ +<html>
<head>
<title>[TITLE] - Not supported page</title>
<link rel="stylesheet" type="text/css" href="sdk_styles.css">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="author" content="Jürgen Schmidt">
<meta name="created" content="2004-12-14">
</head>
<body class="sdkbody">
<table class="table1" cellpadding=0>
<tr style="background-image:url(images/sdk_head-2.gif); backgorund-position: bottom; ">
<td colspan="2" align="left"><img src="images/sdk_head-1.gif" width="335" height="109" usemap="#Map" border="0"></td>
<td align=right><img src="images/sdk_head-3.gif" width="32" height="109"></td>
</tr>
<tr>
<td colspan="3"><img class="nothing10" src="images/nada.gif"></td>
</tr>
<tr>
<td colspan="3">
<table class="table2">
<tr>
<td>
<p align="center"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></p>
</td>
</tr>
<tr>
<td><img class="nothing8" src="images/nada.gif"></td>
</tr>
<tr>
<td>
<p class="note">This page is currently not supported!</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="3"><img class="nothing30" src="images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td>
</tr>
<tr>
<td colspan="3">
<div align="center"><p>Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved.</p></div>
</td>
</tr>
</table>
<map name="Map">
<area shape="rect" coords="10,68,93,105" href="http://www.oracle.com">
</map>
</body>
</html>
\ No newline at end of file diff --git a/odk/docs/sdk_styles.css b/odk/docs/sdk_styles.css new file mode 100644 index 000000000000..a3fdd7b199ef --- /dev/null +++ b/odk/docs/sdk_styles.css @@ -0,0 +1,127 @@ +a { text-decoration: none; } +a:link { color: #C44B01; } +a:visited { color: #638093; } +a:active { color: #9DCA12; } + +.sdkbody { background-color: #FFFFFF; + color: #000000; + margin-top: 0; + margin-bottom: 0; + margin-left: 0; + margin-right: 0; + font-family: Arial, Helvetica, sans-serif; } + +.note { font-size: 20; + font-weight: bold; + font-style: italic; + text-align: center; } + +.table1 { width: 100%; + border-style: none; + border-spacing: 0; + padding: 0; } + +.table2 { width: 100%; + border-style: none; + border-spacing: 8; + padding: 5; } + +.table3 { width: 100%; + border-style: none; + border-spacing: 6; + padding: 0; } + +.table4 { width: 100%; + border-width: 2px; + border-style: groove; + border-color: #CCCCCC; + border-spacing: 0; + border-collapse: collapse; } + +.cell15 { width: 15%; + border-width: 2px; + border-style: groove; + border-color: #CCCCCC; + border-spacing: 0; + border-collapse: collapse; + padding: 4; } + +.cell20 { width: 20%; + border-width: 2px; + border-style: groove; + border-color: #CCCCCC; + border-spacing: 0; + border-collapse: collapse; + padding: 4; } + +.cell80 { width: 80%; + border-width: 2px; + border-style: groove; + border-color: #CCCCCC; + border-spacing: 0; + border-collapse: collapse; + padding: 4; } + +.cell85 { width: 85%; + border-width: 2px; + border-style: groove; + border-color: #CCCCCC; + border-spacing: 0; + border-collapse: collapse; + padding: 4; } + +.nothing1 { width: 20; + height: 1; } + +.nothing8 { width: 20; + height: 8; } + +.nothing10 { width: 20; + height: 10; } + +.nothing30 { width: 20; + height: 30; } + + +.appicon { width: 32; + height: 32; + border: 0; } + +.line { width: 100%; + height: 5; + border: 0; + vertical-align: middle; } + + +.arrow { width: 16; + height: 13; } + +.head1 { font-size: 20; + font-weight: bold; } + +.head2 { font-size: 18; + font-weight: bold; } + +.head3 { font-size: 17; + font-weight: bold; } + +.head4 { font-size: 16; + font-weight: bold; } + +.thead { font-weight: bold; + background-image:url(../docs/images/bg_table.gif); + backgorund-position: middle; } + +.navigate { border: 0; } + +.content1 { width: 1%; } +.content3 { width: 3%; } +.content4 { width: 4%; } +.content10 { width: 10%; } +.content20 { width: 20%; } +.content70 { width: 70%; } +.content75 { width: 75%; } +.content80 { width: 80%; } +.content87 { width: 87%; } + + diff --git a/odk/docs/tools.html b/odk/docs/tools.html new file mode 100644 index 000000000000..b02265dfb488 --- /dev/null +++ b/odk/docs/tools.html @@ -0,0 +1,1092 @@ +<html> +<head> + <title>[TITLE] SDK - Development Tools</title> + <link rel="stylesheet" type="text/css" href="sdk_styles.css"> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <meta name="author" content="Jürgen Schmidt"> +</head> + +<body class="sdkbody"><a name="tools"/> +<table class="table1" cellpadding=0> + <tr style="background-image:url(images/sdk_head-2.gif); backgorund-position: bottom; "> + <td colspan="2" align="left"><img src="images/sdk_head-1.gif" width="335" height="109" usemap="#Map" border="0"></td> + <td align=right><img src="images/sdk_head-3.gif" width="32" height="109"></td> + </tr> + <tr> + <td colspan="3"><img class="nothing10" src="images/nada.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="3"><img class="nothing1" src="images/nada.gif"></td> + </tr> + <tr> + <td> + <table class="table3"> + <tr> + <td colspan="2" class="head1">Development Tools</td> + <td align="right"><a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td> + </tr> + </table> + </td> + </tr> + <tr> + <td> + <table class="table3"> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#unopkg" title="link to the unopkg tool description">unopkg</a></td> + <td class="content87">The new UNO package deployment tool. It comes + with the office installation and can be found in the program + directory of the office installation.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#unoexe" title="link to the uno tool description">uno</a></td> + <td class="content87">Tool to provide a UNO runtime environment and + provide configured (deployed) or single components. This tool + comes with the office installation and can be found in the program + directory of the office installation.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td> + <td class="content87">Tool to merge several registry (e.g. type + libraries) files into one file. <b>Note:</b> Since OpenOffice.org 3 it is not longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#regview" title="link to the regview tool description">regview</a></td> + <td class="content87">Tool to view the content of a registry file + in a human readable manner. Special support for type library + nodes. <b>Note:</b> Since OpenOffice.org 3 it is not longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td> + </tr> + <tr valign="middle"> + <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#idlc" title="link to the idlc tool description">idlc</a></td> + <td class="content87">The UNOIDL compiler, generates a common + binary type library format as base for all codemaker tools and + the UNO runtime type library.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#cppumaker" title="link to the cppumaker tool description">cppumaker</a></td> + <td class="content87">Tool for generating C++ code for the UNOIDL + types stored in a type library.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#javamaker" title="link to the javamaker tool description">javamaker</a></td> + <td class="content87">Tool for generating Java class files for the + UNOIDL types stored in a type library.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#climaker" title="link to the climaker tool description">climaker</a></td> + <td class="content87">Tool for generating CLI assemblies for the + UNOIDL types stored in a type library (windows only).</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#uno-skeletonmaker" title="link to the uno-skeletonmaker tool description">uno-skeletonmaker</a></td> + <td class="content87">Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#regcomp" title="link to the regcomp tool description">regcomp</a></td> + <td class="content87">A simple UNO component registration tool.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td> + <td class="content87">Tool to merge several registry (e.g. type + libraries) files into one file.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#regview" title="link to the regview tool description">regview</a></td> + <td class="content87">Tool to view the content of a registry file + in a human readable manner. Special support for type library + nodes.</td> + </tr> + <tr valign="top"> + <td class="content3"><img src="images/arrow-1.gif"></td> + <td><a href="#autodoc" title="link to the autodoc tool description">autodoc</a></td> + <td class="content87">Tool to generate javadoc-like documentation + for C/C++ and UNOIDL files.</td> + </tr> + </table> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="unopkg"/>unopkg</td> + <td align="right"> + <a style="a:link:visited #FFFFFF;" href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a></td> + </tr> + <tr> + <td colspan="3"> + <p>'unopkg' is a tool for easy deployment of UNO packages in an existing + office installation. UNO packages are UNO components (single libraries or + Jar files or more complex zip files that contains one or more libraries| + Jar files, type libraries and configuration items), scripts and + [PRODUCTNAME] Basic libraries as zip package. 'unopkg' is not part of the + SDK but comes with the office directly and is a development tool as well + as an end user tool to deploy extension into an office installation.</p> + <p>More details concerning deployment and this tool can be find in the + Developer's Guide: <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the "Extension Manager - unopkg" chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p> + <p><b>Note:</b> This tool works only in the <i><office>/program</i> + directory!</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code> + unopkg add <options> package-path...<br> + unopkg remove <options> package-name...<br> + unopkg list <options> package-name...<br> + unopkg reinstall <options><br> + unopkg gui<br> + unopkg -V<br> + unopkg -h<br> + </code></b> + </blockquote> + <p class="head2">Sub-commands:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>add</code></td> + <td class="cell85">add packages</td> + </tr> + <tr> + <td class="cell15"><code>remove</code></td> + <td class="cell85">remove packages by name</td> + </tr> + <tr> + <td class="cell15"><code>reinstall</code></td> + <td class="cell85">export feature: reinstall all deployed + packages</td> + </tr> + <tr> + <td class="cell15"><code>list</code></td> + <td class="cell85">list information about deployed packages</td> + </tr> + <tr> + <td class="cell15"><code>gui</code></td> + <td class="cell15">raise Package Manager Graphical User Interface + (GUI)</td> + </tr> + </table> + </p> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-h, --help</code></td> + <td class="cell85">show this help on the command line</td> + </tr> + <tr> + <td class="cell15"><code>-V, --version</code></td> + <td class="cell85">shows version information + </td> + </tr> + <tr> + <td class="cell15"><code>-v, --verbose</code></td> + <td class="cell85">dump verbose output to stdout</td> + </tr> + <tr> + <td class="cell15"><code>-f, --force</code></td> + <td class="cell85">force overwriting existing packages</td> + </tr> + <tr> + <td class="cell15"><code>--log-file <file></code></td> + <td class="cell85">custom log file; default: + <i><cache-dir>/log.txt</i>.</td> + </tr> + <tr> + <td class="cell15"><code>--shared</code></td> + <td class="cell85">expert feature: operate on shared installation + deployment context; run only when no concurrent Office process(es) are + running!</td> + </tr> + <tr> + <td class="cell15"><code>--deployment-context <context></code> + </td> + <td class="cell85">expert feature: explicit deployment context</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="unoexe"/>uno</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>The UNO-starter is for running a component or service process, and + providing a runtime environment. Raising a component might look like + 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" title="link into the IDL reference to the interface com.sun.star.lang.XMain">com.sun.star.lang.XMain</a>:</p> + <p> + <code>interface XMain : com::sun::star::uno::XInterface <br> + { <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 class="head2">Usage:</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> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code><HostName></code></td> + <td class="cell85">Specifying a host name might be necessary to + distinguish the network interface to be used,if a machine is part of + two networks.</td> + </tr> + <tr> + <td class="cell15"><code><PipeName></code></td> + <td class="cell85">Name of a named pipe.</td> + </tr> + <tr> + <td class="cell15"><code><Name></code></td> + <td class="cell85">Identifier for demanded called component + instances.</td> + </tr> + <tr> + <td class="cell15"><code><Registries></code></td> + <td class="cell85">The optional <code><Registries></code> + (e.g., c:\myreg.rdb) are used by the ServiceManager. The <i>ro</i> + ones are opened for reading only; whereas, a single <i>rw</i> one + will be opened for reading and writing. If the <i>rw</i> one does + not exist, then it may be created. Components may read and write to + store their persistent state.</td> + </tr> + <tr> + <td class="cell15"><code>--singleaccept</code></td> + <td class="cell85">The uno starter will accept one connection, + provide the component instance and die.</td> + </tr> + <tr> + <td class="cell15"><code>--singleinstance</code></td> + <td class="cell85">The uno starter will accept any number of + connections, but will provide the same single component instance any + time instead of creating a new instance for each connection.</td> + </tr> + </table> + <p><b>Service <a href="common/ref/com/sun/star/bridge/UnoUrlResolver.html" title="link into the IDL reference to the service com.sun.star.bridge.UnoUrlResolver">com.sun.star.bridge.UnoUrlResolver</a></b></p> + <p>You can easily connect to a server started with the + <code>-u (url)</code> option by using this service, giving the same url + to resolve. The service provides you an instance from remote.</p> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="idlc"/>idlc</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>'idlc' is the UNOIDL compiler. It is a full featured compiler used + to check UNODL type definitions and transform valid type definitions + into a binary type library format, which is later used by all codemaker + tools. It is also used as a dynamic type library for UNO at runtime.<br> + You can find a syntax description for UNOIDL <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixD/UNOIDL_Syntax_Specification" title="link to the "UNOIDL Syntax Specification" chapter in the Developer's Guide">here</a>.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>idlc [-options] file_1 ... file_n | @<filename></code></b> + </blockquote> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>file_1 ... file_n</code></td> + <td class="cell85">specifies one or more idl files. Only files with + the extension '.idl' are valid.</td> + </tr> + <tr> + <td class="cell15"><code>@<filename></code></td> + <td class="cell85">filename specifies the name of a command + file.</td> + </tr> + </table> + </p> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-O<path></code></td> + <td class="cell85">path describes the output directory. The + generated output is a registry file with the same name as the idl + input file.</td> + </tr> + <tr> + <td class="cell15"><code>-I<path></code></td> + <td class="cell85">path specifies a directory where included files + that will be searched by the preprocessor are located. Multiple + directories can be combined with ';'.</td> + </tr> + <tr> + <td class="cell15"><code>-D<name></code></td> + <td class="cell85">name defines a macro for the preprocessor.</td> + </tr> + <tr> + <td class="cell15"><code>-C</code></td> + <td class="cell85">generates complete type information, including + additional service information and documentation.</td> + </tr> + <tr> + <td class="cell15"><code>-h|?</code></td> + <td class="cell85">print this help message and exit.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="cppumaker"/>cppumaker</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>The 'cppumaker' generates a C++ representation for idl types. The + cppumaker works on a typelibrary, which is generated by the UNOIDL + compiler (<a href="#idlc" link="link to the idlc tool description"> + idlc</a>). It generates the output for all specified types and for all + types the specified types depend on.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>cppumaker [-options] file_1 ... file_n</code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-O<path></code></td> + <td class="cell85">path describes the root directory for the + generated output. The output directory tree is generated under this + directory.</td> + </tr> + <tr> + <td class="cell15"><code>-T<name><br> + |-T<t1>;<t2>...</code></td> + <td class="cell85">name specifies a type or a list of types. The + output for this type and all dependent types are generated. If no '-T' + option is specified, then output for all types is generated. It is also + possible to use a wildcard 'xy.*' to generate a complete module + inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' + option. Example: 'com.sun.star.uno.XInterface' or + 'com.sun.star.uno.*' are valid types. + </td> + </tr> + <tr> + <td class="cell15"><code>-B<name></code></td> + <td class="cell85">name specifies the base node. All types are + searched under this node. Default is the root '/' of the registry + files.</td> + </tr> + <tr> + <td class="cell15"><code>-L</code></td> + <td class="cell85">UNO type functions are generated lightweight, that + means only the name and typeclass are given and everything else is + retrieved from the type library dynamically. The default is that UNO + type functions provides enough type information for boostrapping C++. + '-L' should be the default for external components.</td> + </tr> + <tr> + <td class="cell15"><code>-C</code></td> + <td class="cell85">UNO type functions are generated comprehensive + that means all necessary information is available for bridging the + type in UNO. + </td> + </tr> + <tr> + <td class="cell15"><code>-G</code></td> + <td class="cell85">generate only target files which do not + exist.</td> + </tr> + <tr> + <td class="cell15"><code>-Gc</code></td> + <td class="cell85">generate only target files whose content will + be changed.</td> + </tr> + <tr> + <td class="cell15"><code>-X<name></code></td> + <td class="cell85">extra types, which are not be taken into account + for generation.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="javamaker"/>javamaker</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>The 'javamaker' generates the appropriate Java class file for each idl + type. The javamaker works on a typelibrary which is generated by the + UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> + idlc</a>). It generates the output for all specified types and for all +types the specified types depend on.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-O<path></code></td> + <td class="cell85">path describes the root directory for the + generated output. The output directory tree is generated under this + directory.</td> + </tr> + <tr> + <td class="cell15"><code>-T<name>|-T<t1>;<t2>...</code></td> + <td class="cell85">name specifies a type or a list of types. The + output for this type and all dependent types are generated. If no '-T' + option is specified, then output for all types is generated. It is also + possible to use a wildcard 'xy.*' to generate a complete module + inclusive all subdirectories. The use of '-T*' is equivalent to no '-T' + option. Example: 'com.sun.star.uno.XInterface' + or 'com.sun.star.uno.*' are valid types. + </td> + </tr> + <tr> + <td class="cell15"><code>-B<name></code></td> + <td class="cell85">name specifies the base node. All types are + searched under this node. Default is the root '/' of the registry + files.</td> + </tr> + <tr> + <td class="cell15"><code>-nD</code></td> + <td class="cell85">no dependent types are generated.</td> + </tr> + <tr> + <td class="cell15"><code>-G</code></td> + <td class="cell85">generate only target files which do not + exist.</td> + </tr> + <tr> + <td class="cell15"><code>-Gc</code></td> + <td class="cell85">generate only target files whose content will + be changed.</td> + </tr> + <tr> + <td class="cell15"><code>-X<name></code></td> + <td class="cell85">extra types, which will not be taken into account + for generation.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="climaker"/>climaker</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl + type. The climaker works on a typelibrary which is generated by the + UNOIDL compiler (<a href="#idlc" link="link to the idlc tool description"> + idlc</a>). It generates the output for all specified types and for all + types the specified types depend on.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>climaker <switches> [registry-file-1 registry-file-2 ...]</code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-O, --out <output_file></code></td> + <td class="cell85">output assembly file;<br> + defaults to cli_unotypes.dll if more than one registry-file is given, else <registry-file>.dll</td> + </tr> + <tr> + <td class="cell15"><code>-T, --types <type1[;type2;...]></code></td> + <td class="cell85">types to be generated (if none is given, + then all types of given registries are emitted</td> + </tr> + <tr> + <td class="cell15"><code>-X, --extra <rdb-file>></code></td> + <td class="cell85">additional rdb to saturate referenced types in + given registry file(s); these types will not be + emitted into the output assembly file</td> + </tr> + <tr> + <td class="cell15"><code>-r, --reference <assembly-file></code></td> + <td class="cell85">reference metadata from assembly file</td> + </tr> + <tr> + <td class="cell15"><code>-k, --keyfile</code></td> + <td class="cell85">keyfile needed for strong name</td> + </tr> + <tr> + <td class="cell15"><code>--assembly-version <version></code></td> + <td class="cell85">sets assembly version</td> + </tr> + <tr> + <td class="cell15"><code>--assembly-description <text></code></td> + <td class="cell85">sets assembly description text</td> + </tr> + <tr> + <td class="cell15"><code>--assembly-product <text></code></td> + <td class="cell85">sets assembly product name</td> + </tr> + <tr> + <td class="cell15"><code>--assembly-company <text></code></td> + <td class="cell85">sets assembly company</td> + </tr> + <tr> + <td class="cell15"><code>--assembly-copyright <text></code></td> + <td class="cell85">sets assembly copyright</td> + </tr> + <tr> + <td class="cell15"><code>--assembly-trademark <text></code></td> + <td class="cell85">sets assembly trademark</td> + </tr> + <tr> + <td class="cell15"><code>-v, --verbose</code></td> + <td class="cell85">verbose output to stdout</td> + </tr> + <tr> + <td class="cell15"><code>-h, --help</code></td> + <td class="cell85">this message</td> + </tr> + + </table> + </p> + <p><b>Example:</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb</code></p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="uno-skeletonmaker"/>uno-skeletonmaker</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>The 'uno-skeletonmaker' is a tool to simplify the UNO component development. It has different modes, from simply dumping code definitions for different languages on stdout up to generating complete code skeletons. The generation of code skeletons support common component skeletons as well as specialized skeletons for special service provider interfaces.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code> + uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) dump [<options>] -t <type> ...<br> + uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) component [<options>] -n <name> -t <type> ...<br> + uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) calc-add-in [<options>] -n <name> -t <add-in_service><br> + uno-skeletonmaker (-env:INIFILENAME=<url> | -env:UNO_TYPES=<url>) add-on [<options>] -n <name> -p <protocol_name:command,...> + uno-skeletonmaker -V, --version<br> + uno-skeletonmaker -h, --help<br> + </code></b> + </blockquote> + <p class="head2">Sub-commands:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>dump</code></td> + <td class="cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.</td> + </tr> + <tr> + <td class="cell15"><code>component</code></td> + <td class="cell85">generates language specific code skeleton files using the implementation name as the file and class name</td> + </tr> + <tr> + <td class="cell15"><code>calc-add-in</code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>add-on</code></td> + <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> + </tr> + </table> + </p> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-env:INIFILENAME=<url></code></td> + <td class="cell85">url specifies a URL to an UNO ini|rc file of an existing UNO environment (URE, office installation).</td> + </tr> + <tr> + <td class="cell15"><code>-env:UNO_TYPES=<url></code></td> + <td class="cell85">url specifies a binary type library file. It can be a space separated list of urls.</td> + </tr> + <tr> + <td class="cell15"><code>-a, --all</code></td> + <td class="cell85">list all interface methods, not only the direct ones</td> + </tr> + <tr> + <td class="cell15"><code>--(java4|java5|cpp)</code></td> + <td class="cell85">select the target language<br> + --java4 generate output for Java 1.4 or earlier<br> + --java5 generate output for Java 1.5 or later (is currently the default)<br> + --cpp generate output for C++</td> + </tr> + <tr> + <td class="cell15"><code>-sn, --shortnames</code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>--propertysetmixin</code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>-lh --licenseheader</code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>-bc<br>--backward-compatible</code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>-o <path></code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>-l <file></code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>-n <name></code></td> + <td class="cell85">specifies an implementation name for the component (used as classname, filename and package|namespace name). In 'dump' mode it is used as classname (e.g. "MyBase::", C++ only) to generate method bodies not inline.</td> + </tr> + <tr> + <td class="cell15"><code>-d <name></code></td> + <td class="cell85">specifies a base classname or a delegator. In 'dump' mode it is used as a delegator to forward methods. It can be used as '<name>::' for base forwarding, or '<name>->|.' for composition. Using "_" means that a default bodies with default return values are dumped.</td> + </tr> + <tr> + <td class="cell15"><code>-t <name></code></td> + <td class="cell85">specifies an UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).</td> + </tr> + <tr> + <td class="cell15"><code>-p <protocol:cmd(s)></code></td> + <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> + </tr> + <tr> + <td class="cell15"><code>-V, --version</code></td> + <td class="cell85">print version number and exit.</td> + </tr> + <tr> + <td class="cell15"><code>-h, --help</code></td> + <td class="cell85">print this help and exit.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="regcomp"/>regcomp</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>'regcomp' is a tool to register|revoke external UNO components + into|from a registry which is used in a UNO environment.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>regcomp -revoke [-br<registryfile>] -r <registryfile> -c <locationUrl>[-l<componentLoaderName>]</code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-register|revoke</code></td> + <td class="cell85">register means that the components will be + installed and revoke means that they will be removed.</td> + </tr> + <tr> + <td class="cell15"><code>-br<registryfile></code></td> + <td class="cell85">the name of the registry used for bootstrapping + the program. If the bootstrap registry is specified and has the same + name as the registration registry, '-r' is optional.</td> + </tr> + <tr> + <td class="cell15"><code>-r<registryfile></code></td> + <td class="cell85">the name of the registry (will be created if + it does not exist) where the component should be registered.</td> + </tr> + <tr> + <td class="cell15"><code>-c<locationUrls></code></td> + <td class="cell85">the location of a component (DLL, Class name, + or an url of a jar file) or a list of urls separated by ';'s. Note + that, if a list of urls is specified, the components must all need + the same loader.</td> + </tr> + <tr> + <td class="cell15"><code>-l<componentLoaderName></code></td> + <td class="cell85">the name of the needed loader, if no loader is + specified the 'com.sun.star.loader.SharedLibrary' is used. Supported + loaders: 'com.sun.star.loader.SharedLibrary' | + 'com.sun.star.loader.Java'.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="regmerge"/>regmerge</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>'regmerge' is a small tool to merge different registry files under a + specified key into another registry file. If a value already exists in + the target file the value is overwritten by the value of the source + file.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>regmerge [-v|--verbose] <mergefile> <mergeKeyName> <regfile_1> ... <regfile_n></code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15"><code>-v|--verbose</code></td> + <td class="cell85">verbose output on stdout.</td> + </tr> + <tr> + <td class="cell15"><code><mergefile></code></td> + <td class="cell85">specifies the merged registry file. If this file + doesn't exist, it is created.</td> + </tr> + <tr> + <td class="cell15"><code><mergeKeyName></code></td> + <td class="cell85">specifies the merge key, everything is merged + under this key. If this key doesn't exist, it is created.</td> + </tr> + <tr> + <td class="cell15"><code><regfile_1> ... <regfile_n></code></td> + <td class="cell85">specifies one or more registry files that are + merged.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="regview"/>regview</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>'regview' is a tool to show the contents of a registry file. The tool + dumps the hierarchical structure and the values of the nodes in a human + readable manner to stdout.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>regview <registryfile> [<keyName>]</code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table class="table4"> + <tr> + <td class="cell15">-br<registryfile></code></td> + <td class="cell85">the name of the registry whose contents should + be viewed.</td> + </tr> + <tr> + <td class="cell15"><code><keyName></code></td> + <td class="cell85">the name of a registry key. The name must be + fully qualified; for example, '/' means the root key and + '/UCR/com/sun/star/uno/XInterface' shows the type specification of the + XInterface type. If no key is specified, the tool dumps the whole + content of the registry file.</td> + </tr> + </table> + </p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-2.gif"></td> + </tr> + <tr> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + <td> + <table class="table2"> + <tr> + <td colspan="2" class="head1"><a name="autodoc"/>autodoc</td> + <td align="right"> + <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"></a> + <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"></a> + </td> + </tr> + <tr> + <td colspan="3"> + <p>The 'autodoc' tool is used for creating javadoc-like documentation + from C++ and UNOIDL source code.</p> + <p>There are some conventions to follow when documenting C++- or + UNOIDL-sourcecode. See also the <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AppendixB/IDL_Documentation_Guidelines" title="link to the UNOIDL Documentation Guidelines">UNOIDL Documentation Guidelines</a>.<br> + If you are not familiar with these, but do know javadoc: For simple C++ + sourcecode documentation, using javadoc-style comments will work.</p> + <p class="head2">Usage:</p> + <blockquote> + <b><code>autodoc [ -v <VerboseNr> ] [ -name "<TitleForTheDocu>" ] -html <OutputDirectory> -lg <SourcecodeLanguage><br> + { [ -p <ProjectName> <ProjectRootDirectory> ] -t <SourceTree>* | -d <SourceDirectory>* | -f <SourceFile>* }*</code></b> + </blockquote> + <p class="head2">Options:</p> + <p> + <table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr> + <td class="cell15"><code>-v <VerboseNr></code></td> + <td class="cell85"><VerboseNr> == 5 displays the parsed source + code tokens, so you can locate which piece caused an parsing error.<br> + <VerboseNr> == 2 displays not only the parsed source code, + but also the comments.<br><br> + This option must be the first one, if it is used.</td> + </tr> + <tr> + <td class="cell15"><code>-name "<Title>"</code></td> + <td class="cell85"><Title> occurs as the title of the start + page of the HTML output. If this option is omitted, a default title is + created.</td> + </tr> + <tr> + <td class="cell15"><code>-html <OutputDirectory></code></td> + <td class="cell85">specifies the root directory where the HTML output + is created.<br> + Autodoc does not remove old files there, though it overwrites them.</td> + </tr> + <tr> + <td class="cell15"><code>-lg <SourcecodeLanguage></code></td> + <td class="cell85">Possible values are: c++ | idl.<br><br> + This also specifies which files will be parsed: "c++" parses + all files with the endings .hxx and .h, "idl" parses all + files with the ending '.idl' .<br> + To change this behaviour, see at option <code>-f</code>.</td> + </tr> + <tr> + <td class="cell15"><code>-p <ProjectName> <ProjectDirectory></code></td> + <td class="cell85">this option can be used to divide large code + bases into different projects.<br> + <ProjectName> gives a user-defined name for the project.<br> + <ProjectDirectory> is the root to which all paths, given with the + following options <code>-t,-d</code> and <code>-f</code>, are + relative.<br> + This option can be omitted when there are no projects and all paths in + the following options are relative to the working directory.<br><br> + The "{ ... }*" around the options <code>-p,-t,-d,-f</code> + indicates, that this whole block of options can be repeated, each block + starting with a new <code>-p</code>.</td> + </tr> + <tr> + <td class="cell15"><code>-t <SourceTree></code></td> + <td class="cell85">specifies that all files in the directory + <SourceTree> and it's subdirectories are parsed, where the file + ending matches the option <code>-lg</code>.<br> + There can be given multiple directories after one <code>-t</code> + option.<br> + All relative paths are relative to the project-rootdirectory, + given with the <code>-p</code> option.<br> + </td> + </tr> + <tr> + <td class="cell15"><code>-d <SourceDirectory></code></td> + <td class="cell85">Specifies that all files in th directory + <SourceDirectory>, but NOT it's subdirectories, are parsed, where + the file ending matches the option <code>-lg</code>.<br> + There can be multiple directories given after one <code>-d</code> + option.<br> + All relative paths are relative to the project-rootdirectory, + given with the <code>-p</code> option.</td> + </tr> + <tr> + <td class="cell15"><code>-f <SourceFile></code></td> + <td class="cell85">parses the given file. The ending does not have + to match the <code>-lg</code> option.<br> + There can be multiple files given after one <code>-f</code> option.<br> + All relative paths are relative to the project-rootdirectory, + given with the <code>-p</code> option.</td> + </tr> + </table> + </p><b>Remark:</b> The sequence of options matters! Use them in the order given + in the "Usage"-paragraph.</p> + </td> + </tr> + </table> + </td> + <td class="content1"><img class="nothing8" src="images/nada.gif"></td> + </tr> + <tr> + <td colspan="3"><img class="line" src="images/sdk_line-1.gif"></td> + </tr> + <tr> + <td colspan="3"> + <div align="center"><p>Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved.</p></div> + </td> + </tr> +</table> +<map name="Map"> + <area shape="rect" coords="10,68,93,105" href="http://www.oracle.com"> +</map> +</body> +</html> |
