summaryrefslogtreecommitdiff
path: root/odk/docs/install.html
blob: 884da753096d6389587198eaa3c2875075010138 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<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&uuml;rgen Schmidt">
  <meta name="CREATED" content="20020311;11245374">
  <meta name="CHANGEDBY" content="J&uuml;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">&nbsp;</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" alt=""></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" alt="[PRODUCTNAME] SDK"></div>
    </td>
    <td class="logo_color"><img src="../docs/images/black_dot.gif" width="1" height="121" alt=""></td>
    <td class="logo_color" width="222"> 
      <div align="center"><img src="../docs/images/logo.gif" width="222" height="121" alt=""></div>
    </td>
  </tr>
  <tr> 
    <td bgcolor="#000000" height="1"></td>
    <td bgcolor="#000000" height="1"><img src="../docs/images/black_dot.gif" width="1" height="1" alt=""></td>
    <td bgcolor="#000000" height="1" width="222"></td>
  </tr>
  <tr> 
    <td class="color1" height="12"></td>
    <td class="color2" height="12"><img src="../docs/images/black_dot.gif" width="1" height="12" alt=""></td>
    <td class="color2" 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" alt=""></td>
    <td bgcolor="#000000" height="1" width="222"></td>
  </tr>
  <tr> 
    <td colspan="3">&nbsp;</td>
  </tr>
  <tr> 
    <td colspan="3" height="8">
      <table width="100%" border="0" cellpadding="4">
        <tr> 
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
          <td align=center><a href="../index.html" title="link to the SDK start page">
	     SDK home</a></td>
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
        </tr>
        <tr>
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
          <td align=center><font size="6"><b>Installation guide</b></font></td>
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
        </tr>
        <tr> 
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
          <td>&nbsp;</td>
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
        </tr>
        <tr> 
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
          <td>
            <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 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>
            <dl>
              <dt><b>[PRODUCTNAME] installation</b>
              <dd>The SDK works on top of an existing office installation and uses the same libraries as
                  the office installation.
              <dt><b>JDK (1.4.1_01 or higher)</b>
              <dd>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>.
              <dt><b>C++ compiler</b>
              <dd>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:<br>
                  Solaris, Sun WorkShop 6 update 1 C++ 5.2 2000/09/11<br>
                  Linux, GNU C++ compiler, gcc version 3.0.1<br>
                  Windows, Microsoft C++ Compiler, Microsoft Developer Studio 6.0 (cl, version 12.00.8168) 
              <dt><b>GNU make (3.79.1 or higher)</b>
              <dd>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><br> 
                  NOTE: Windows user can find an executable of gnu make under 
                  <a target="_blank" href="http://www.nextgeneration.dk/gnu/make.zip" title="link to a windows version of gnumake on www.nextgeneration.dk (online)">http://www.nextgeneration.dk/gnu/make.zip</a>. It is not recommended to use the Cygwin
                  make, because it does not work well. For Solaris 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>.
            </dl>
            <p>The SDK provides a configure script (Unix and Windows2000/XP) that asks for relevant 
               directories (SDK, StarOffice, GNU make, Java, C++). After completing the
               configure script a new script will be created (Windows2000/XP and UNIX) to set the 
               necessary environment variables for using the SDK and the required tools. Under UNIX the configure script uses Perl. LINUX systems should have installed a working perl version and for 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.  
            </p>
            <ul>
              <li><b>configure</b>&nbsp;&nbsp;-> for Unix
              <li><b>configureWindows.bat</b></a>&nbsp;&nbsp;-> for Windows2000/XP or newer versions
            </ul>
            <p>Other versions of the operating system Windows should use the batch program 
	        <b>&lt;OO_SDK_HOME&gt;\setsdkenv_windows.bat</b> directly and adopt it to their local 
		environment.
            </p>
            <p>The first time you use the batch program, you must prepare it for your environment. 
	        Edit the script and set the following variables:
            </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 existing StarOffice&#153 or OpenOffice.org base installation, e.g.  
                       &quot;/opt/staroffice8&quot;. Please take care that it is not a user installation only.</td>
                 </tr>
                 <tr> 
                   <td widht=35%><b>OO_SDK_HOME</b></td>
                   <td widht=65%>path to the SDK root directory, e.g. &quot;/usr/local/StarOffice8_SDK&quot;</td>
                 </tr>
                 <tr> 
                   <td widht=35%><b>OO_SDK_JAVA_HOME</b></td>
                   <td widht=65%>path to the JDK</td>
                 </tr>
                 <tr> 
                   <td widht=35%><b>OO_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). The C++ compiler is <b>optional</b> and only 
					   necessary for building the C++ examples.</td>
                 </tr>
                 <tr> 
                   <td widht=35%><b>OO_SDK_MAKE_HOME</b></td>
                   <td widht=65%>path to GNU make.</td>
                 </tr>
                 <tr> 
                   <td widht=35%><b>OO_SDK_OUTPUT_DIR</b></td>
                   <td widht=65%>path to an exisiting directory where the example output is generated.
                       The output directory is <b>optional</b>, default is that the output is generated in
					   the SDK directory itself. If an output directory is specified, the output is generated in a SDK dependent subdirectory of this directory (e.g &lt;OO_SDK_OUTPUT_DIR&gt;/[PRODUCTNAME]/LINUXExample.out)</td>
                 </tr>
                 <tr> 
                   <td widht=35%><b>SDK_AUTO_DEPLOYMENT</b></td>
                   <td widht=65%>if this variable is set, the component examples will be automatically
                        deployed into the Office installation referenced by OFFICE_HOME. See also chapter
                        <a href="DevelopersGuide/Components/Components.htm#1+7+1+UNO+Package+Installation" title="link to &quot;UNO package installation&quot; chapter in the Developer's Guide">
                        &quot;UNO Package installation&quot;</a> from the Developer's Guide.
                 </tr>
               </table>
            </p>

	     <p>You have to 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 under Windows
              or the new started shell under UNIX.</p>
            <p><b>NOTE:</b> If you do not want to use the script to set your working environment, you 
	        must set the appropriate environment variables by yourself. The script sets the following 
		 environment variables:
            </p>
            <p><b>Common environment variables</b></p>
            <p> 
               <table width="100%" border=1 cellpadding=4 cellspacing=0>
                 <tr> 
                   <td widht=35%>CLASSPATH</td>
                   <td widht=65%><b>=<i>$OFFICE_HOME/program/classes/jurt.jar; 
										$OFFICE_HOME/program/classes/juh.jar;
										$OFFICE_HOME/program/classes/unoil.jar;
										$OFFICE_HOME/program/classes/ridl.jar;
										$OFFICE_HOME/program/classes/sandbox.jar;
										$CLASSPATH</i></b><br>
                       The classpath will be set or extended to the necessary jar files of the specified 
					   office installation.</td>
                 </tr>
               </table>
            </p>

            <p><b>Environment variables for UNIX</b></p>
            <p><b>Solaris</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 do not want automatic registration,
                       please comment this variable out in the script.</td>
                 </tr>
                 <tr> 
                   <td widht=35%>LD_LIBRARY_PATH</td>
                   <td widht=65%><b>=<i>$OFFICE_PROGRAM_PATH: $OO_SDK_HOME/(solsparc|solintel)/lib: $LD_LIBRARY_PATH</i></b><br>
                       The LD_LIBRARY_PATH will be set or will be extended by the office program path,
                       the platform dependent lib directory for some additional libraries.
                   </td>
                 </tr>
                 <tr> 
                   <td widht=35%>PATH</td>
                   <td widht=65%><b>=<i>$OO_SDK_HOME/(solsparc|solintel)/bin:$OO_SDK_MAKE_HOME:$OO_SDK_CPP_HOME:
										$OO_SDK_JAVA_HOME/bin:$PATH</i></b><br>
                       The PATH variable will be extended by the paths for the SDK development tools, 
                       the compiler, the JDK and GNU make.
                   </td>
                 </tr>
               </table>
            </p>
            <p><b>Linux</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 do not want automatic registration,
                       comment this variable out in the script.</td>
                 </tr>
                 <tr> 
                   <td widht=35%>LD_LIBRARY_PATH</td>
                   <td widht=65%><b>=<i>$OFFICE_PROGRAM_PATH:$SDK_HOM/linux/lib:$LD_LIBRARY_PATH</i></b><br>
                       The LD_LIBRARY_PATH will be set or will be extended by the office program path,
                       the platform dependent lib directory for some additional libraries.
                   </td>
                 </tr>
                 <tr> 
                   <td widht=35%>PATH</td>
                   <td widht=65%><b>=<i>$OO_SDK_HOME/linux/bin:$OO_SDK_MAKE_HOME:$OO_SDK_CPP_HOME:
										$OO_SDK_JAVA_HOME/bin:$PATH</i></b><br>
                       The PATH variable will be extended by the paths for the SDK development tools, 
                       the compiler, the JDK and GNU make.
                   </td>
                 </tr>
               </table>
            </p><br>
            <p><b>Environment variables for Windows</b></p>
            <p> In addition to setting these environment variables, the script calls the &quot;vcvar32.bat&quot; 
               batch file, which is provided by the Microsoft Developer Studio to set the necessary 
               environment variables 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,
                       please comment this variable out in the script.</td>
                 </tr>
                 <tr> 
                   <td widht=35%>PATH</td>
                   <td widht=65%><b>=<i>%OO_SDK_HOME%\windows\bin;%OO_SDK_MAKE_HOME%;%OO_SDK_CPP_HOME%;
										%OO_SDK_JAVA_HOME%\bin;%OFFICE_PROGRAM_PATH%;%PATH%</i></b><br>
                       The PATH variable will be extended by the paths for the SDK development tools, 
                       the compiler, the JDK, GNU make and the &lt;OFFICE_PROGRAM_PATH&gt;.
                   </td>
                 </tr>
                 <tr> 
                   <td widht=35%>LIB</td>
                   <td widht=65%><b>=<i>%OO_SDK_HOME%\windows\lib;%LIB%</i></b><br>                    
                       The LIB variable will be extended by the path to the import libraries which are 
                       necessary for windows.
                   </td>
                 </tr>
                 <tr> 
                   <td colspan="2">Additionally to setting these environment variables the script calls the 
                      &quot;vcvar32.bat&quot; batch file which is provided by the Microsoft Developer 
		      Studio to set the necessary environment variables for the compiler.</td>
                 </tr>
               </table>    
            </p>
          </td>
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
        </tr>
        <tr> 
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
          <td>&nbsp;</td>
	   <td align=center><img src="../docs/images/nada.gif" width="25" height="1"></td>
        </tr>
      </table>
      </blockquote>
    </td>
  </tr>
  <tr> 
    <td colspan="3">&nbsp;</td>
  </tr>
  <tr> 
    <td bgcolor="#000000" height="1"></td>
    <td bgcolor="#000000" height="1"><img src="../docs/images/black_dot.gif" width="1" height="1" alt=""></td>
    <td bgcolor="#000000" height="1" width="222"></td>
  </tr>
  <tr> 
    <td class="color2" height="6"></td>
    <td class="color1" height="6" width="1"><img src="../docs/images/black_dot.gif" width="1" height="6" alt=""></td>
    <td class="color1" 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" alt=""></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 2003 Sun Microsystems, Inc.</b></font>
      &nbsp
    </td>
  </tr>
</table>
</body>
</html>