Project

Profile

Help

Revision 1ff21c76

Added by Debbie Lockett about 1 year ago

Saxon/C 1.2 documentation (under latest9.9): further updates for installation section (cut old info)

View differences:

latest9.9/hec/saxonc-doc/doc/starting.xml
82 82
         
83 83
         <aside>The use of symbolic links to specify where the Saxon/C library is installed is no longer
84 84
            recommended. It is better to set the SAXONC_HOME environment variable directly.</aside>
85
         
86
         <!--TODO what about JET-home environment variable? If you use the same location as for saxon
87
         library, as above, then it doesn't need to be set separately???
88
            - similarly what about LD_LIBRARY_PATH ?-->
89
         
90

  
91
         <!--<ol>
92
            <li>
93
               <p>To install the Saxon-[EDITION]/C release, first unzip the file
94
                  <code>libsaxon-[EDITION]C-setupv[VERSION].zip</code> and execute the
95
                  command:</p>
96
               <kbd>./libsaxon-[EDITION]C-setup-v[VERSION]</kbd>
97
            </li>
98

  
99
            <li>
100
               <p>The next step is to select the destination where the product files will be
101
                  installed. The product files are unpacked in the <code>Saxon-[EDITION]C</code>
102
                  directory.</p>
103

  
104
               <kbd>cd Saxonica/Saxon-[EDITION]C[VERSION]/</kbd>
105
               <kbd>sudo cp libsaxon[EDITION].so /usr/lib/.</kbd>
106

  
107
               <p>Alternatively you can either create a symbolic link to where the saxon library is
108
                  installed so it can be found or use the SAXONC_HOME environment variable to set the location of the library. For example:</p>
109

  
110
               <kbd>ln -s path/Saxonica/Saxon-[EDITION]C[VERSION]/libsaxon[EDITION].so
111
                  /usr/lib/libsaxon[EDITION].so</kbd>
112

  
113
               <p>Or</p>
114
               <kbd>export SAXONC_HOME=path/Saxonica/Saxon-[EDITION]C[VERSION]</kbd>
115
               <p>You may also need to set the LD_LIBRARY_PATH to the same location.</p>
116
               
117
            </li>
118

  
119
            <li>
120
               <p>You need to set up the environment for the JET JVM. The JVM is in the
121
                     <code>Saxonica/Saxon-[EDITION]C[VERSION]/rt</code> directory.</p>
122

  
123
               <kbd>sudo cp -r rt /usr/lib/.</kbd>
124

  
125
               <p>Alternatively you can create a symbolic link to the JetVM library so it can be
126
                  found. For example:</p>
127

  
128
               <kbd>ln -s path/Saxonica/Saxon-[EDITION]C[VERSION]/rt /usr/lib/rt</kbd>
129
            </li>
130

  
131
            <li>
132
               <p>Set the JET-home environment accordingly to where it is installed, e.g.
133
                     <code>JET-home=/usr/lib/Saxon-[EDITION]C[VERSION]/rt</code>. The directory
134
                     <code>JET-home/lib/amd64</code> must be listed in the
135
                     <code>LD_LIBRARY_PATH</code> environment variable. For instance, if you are
136
                  using a bash or Bourne shell, use the following command:</p>
137
               <kbd style="word-wrap: break-word;">export JET_HOME=/usr/lib/rt</kbd>
138
               <kbd style="word-wrap: break-word;">export
139
                  LD_LIBRARY_PATH=$JET_HOME/lib/amd64/jetvm:$JET_HOME/lib/amd64:$LD_LIBRARY_PATH</kbd>
140

  
141
               <p>Alternatively, for Ubuntu, you can create a file <code>/etc/ld.so.conf.d/jetvm.conf</code>
142
                  with content:</p>
143

  
144
               <samp><![CDATA[# JetVM env path (required for Saxon)
145
      /usr/lib/rt/lib/amd64
146
      /usr/lib/rt/lib/amd64/jetvm]]></samp>
147

  
148
               <p>Next run: </p>
149
               <kbd>sudo ldconfig</kbd>
150
               <p>Ignore the message 'file /lib/libsaxon[EDITION].so is truncated'. The library was created using
151
               Excelsior JET. The library is loaded from within the Saxon/C application and not in the usual way of shared libraries.</p>
152
            </li>
153
            
154
            <li>
155
               <p>You must also copy the <code>saxon-data</code> directory into the same directory
156
                  as the <code>libsaxon[EDITION].so</code>.</p>
157
            </li>
158
         </ol>-->
159 85

  
160 86
         <p>Saxon/C is now installed, and ready to run. Please see <a href="../running">Running
161 87
               Saxon/C</a> to get started. Note that the commercial products Saxon-PE/C and
......
203 129
               <kbd>sudo cp libsaxon[EDITION].dylib /usr/local/lib/.</kbd>
204 130
               <kbd>sudo cp -r rt /usr/local/lib/.</kbd>
205 131
               <kbd>sudo cp -r saxon-data /usr/local/lib/.</kbd>
132
               
133
               <aside>If you encounter permission issues after copying, then the privileges of
134
                  the folders and files may need adjusting.</aside>
206 135
            </li>
207 136
            <li>
208 137
               <p><b>Set the SAXONC_HOME environment variable</b></p>
......
214 143
                  location.</p>
215 144
            </li>
216 145
         </ol>
217
         
218
         <!-- TODO Would it be useful to add the following back to step 3? 
219
               "The privileges of the folders and files may need adjusting after copying everything
220
               if you encounter permission issues." -->
221
         
222
         <!-- TODO Also note previously had info about setting DYLD_LIBRARY_PATH, is that still
223
            necessary? -->
224

  
225
         <!--<ol>
226
            <li>
227
               <p>To install any of the Saxon/C releases on the Mac OS system, first unzip the
228
                  self-contained file <code>libsaxon-[EDITION]-mac-setup-v[VERSION].zip</code>.</p>
229
            </li>
230

  
231
            <li>
232
               <p>The next step is to copy the <code>libsaxon[EDITION].dylib</code> library and the
233
                     <code>rt</code> directories to your install location. The C/C++ interface by
234
                  default assumes the library files and directories are installed in the
235
                     <code>/usr/local/lib</code> directory. The location of the Saxon/C library can
236
                  be set using the <code>SAXONC_HOME</code> environment variable. The privileges of
237
                  the folders and files may need adjusting after copying everything if you encounter
238
                  permission issues. Use for instance the following commands:</p>
239

  
240
               <kbd>cd libsaxon-HEC-mac-setup-v[VERSION]/</kbd>
241
               <kbd>sudo cp libsaxonhec.dylib /usr/local/lib/.</kbd>
242
               <kbd>sudo cp -r rt /usr/local/lib/.</kbd>
243
            </li>
244

  
245
            <li>
246
               <p>The <code>DYLD_LIBRARY_PATH</code> environment variable must be set as
247
                  follows:</p>
248

  
249
               <kbd>export JET_HOME=/usr/local/lib/rt</kbd>
250
               <kbd>export DYLD_LIBRARY_PATH=$JET_HOME/lib/jetvm:$DYLD_LIBRARY_PATH</kbd>
251
            </li>
252
         </ol>-->
253 146

  
254 147
         <p>Saxon/C is now installed, and ready to run. Please see <a href="../running">Running
255 148
               Saxon/C</a> to get started. Note that the commercial products Saxon-PE/C and
......
301 194
            </li>
302 195
         </ol>
303 196

  
304
         <!--<ol>
305
            <li>
306
               <p>To install the Saxon-[EDITION]/C release, first run the executable
307
                     <code>libsaxon-[EDITION]-win-setup-v[VERSION].exe</code>.</p>
308
            </li>
309

  
310
            <li>
311
               <p>The next step is to select the destination where the product files will be
312
                  installed - the default and recommended location is <code>C:\Program
313
                     Files\Saxonica\Saxon[EDITION][VERSION]</code>. This is the location that the
314
                  PHP extension looks for the Saxon/C DLL library, so we advise using this default
315
                  location. </p>
316
            </li>
317
         </ol>-->
318

  
319 197
         <p>Saxon/C is now installed, and ready to run. Please see <a href="../running">Running
320 198
               Saxon/C</a> to get started. Note that the commercial products Saxon-PE/C and
321 199
            Saxon-EE/C require a license, so you may also need to refer to <a href="../licensing"

Also available in: Unified diff