[ruby-oci8-commit] [490] trunk/ruby-oci8: add a new document file.

nobody at rubyforge.org nobody at rubyforge.org
Mon Jan 9 02:23:26 EST 2012


Revision: 490
Author:   kubo
Date:     2012-01-09 02:23:25 -0500 (Mon, 09 Jan 2012)

Log Message:
-----------
add a new document file.

Modified Paths:
--------------
    trunk/ruby-oci8/.gitignore
    trunk/ruby-oci8/ChangeLog
    trunk/ruby-oci8/dist-files

Added Paths:
-----------
    trunk/ruby-oci8/docs/
    trunk/ruby-oci8/docs/install-full-client.md

Property Changed:
----------------
    trunk/ruby-oci8/


Property changes on: trunk/ruby-oci8
___________________________________________________________________
Modified: svn:ignore
   - config.save
sqlnet.log
*.rbc

   + config.save
sqlnet.log
*.rbc
.git
doc
.yardoc


Modified: trunk/ruby-oci8/.gitignore
===================================================================
--- trunk/ruby-oci8/.gitignore	2012-01-08 05:01:43 UTC (rev 489)
+++ trunk/ruby-oci8/.gitignore	2012-01-09 07:23:25 UTC (rev 490)
@@ -1,6 +1,8 @@
 .svn
+.yardoc
 config.save
-doc/.svn
+doc
+docs/.svn
 ext/.svn
 ext/oci8/.svn
 ext/oci8/apiwrap.h

Modified: trunk/ruby-oci8/ChangeLog
===================================================================
--- trunk/ruby-oci8/ChangeLog	2012-01-08 05:01:43 UTC (rev 489)
+++ trunk/ruby-oci8/ChangeLog	2012-01-09 07:23:25 UTC (rev 490)
@@ -1,3 +1,6 @@
+2012-01-09  KUBO Takehiro  <kubo at jiubao.org>
+	* docs/install-full-client.md: add a new document file.
+
 2012-01-08  KUBO Takehiro  <kubo at jiubao.org>
 	* doc/*: remove obsolete documents.
 

Modified: trunk/ruby-oci8/dist-files
===================================================================
--- trunk/ruby-oci8/dist-files	2012-01-08 05:01:43 UTC (rev 489)
+++ trunk/ruby-oci8/dist-files	2012-01-09 07:23:25 UTC (rev 490)
@@ -8,11 +8,7 @@
 pre-distclean.rb
 ruby-oci8.gemspec
 setup.rb
-doc/api.en.html
-doc/api.en.rd
-doc/api.ja.html
-doc/api.ja.rd
-doc/manual.css
+docs/install-full-client.md
 ext/oci8/.document
 ext/oci8/MANIFEST
 ext/oci8/apiwrap.c.tmpl

Added: trunk/ruby-oci8/docs/install-full-client.md
===================================================================
--- trunk/ruby-oci8/docs/install-full-client.md	                        (rev 0)
+++ trunk/ruby-oci8/docs/install-full-client.md	2012-01-09 07:23:25 UTC (rev 490)
@@ -0,0 +1,108 @@
+# @title Install for Oracle Full Client
+
+Introduction
+============
+
+This page explains the way to install ruby-oci8 for Oracle Full Client
+installations.
+
+For Oracle Instant Client, look at {file:docs/install-instant-client.md}.
+For Windows, look at {file:docs/install-binary-package.md} unless you
+have a special need to compile ruby-oci8 by yourself.
+
+Check the environment
+=====================
+
+Oracle installation
+-------------------
+
+Run the following command and confirm it works fine. If it doesn't
+work well, you need to ask to your database administrator.
+
+    sqlplus USERNAME/PASSWORD
+
+ruby installation
+-----------------
+
+Run the following command. If it ends with "can't find header files
+for ruby" or "ruby: no such file to load -- mkmf (LoadError)", you need
+to install ruby-devel(redhat) or ruby-dev(debian/ubuntu).
+
+    ruby -r mkmf -e ""
+
+development tools
+-----------------
+
+You need a C compiler and development tools such as make or nmake.
+Note that they must be same with ones used to compile the ruby.
+For example, you need Oracle Solaris Studio, not gcc, for ruby
+compiled by Oracle Solaris Studio.
+
+Installation
+============
+
+Download the source code
+------------------------
+
+Download the latest tar.gz package such as ruby-oci8 2.1.0.tar.gz,
+which is the latest version at the time of writing, from [rubyforge][].
+
+Set the library search path
+-----------------------
+
+### UNIX
+
+Set the library search path, whose name depends on the OS, to point to
+$ORACLE_HOME/lib. If the database is 64-bit and the ruby is 32-bit,
+use $ORACLE_HOME/lib32 instead.
+
+<table style="border: 1px #E3E3E3 solid; border-collapse: collapse; border-spacing: 0;">
+<thead>
+  <tr><th> OS                        </th><th> library search path                   </th></tr>
+</thead>
+<tbody>
+  <tr><td> Linux                     </td><td> LD_LIBRARY_PATH                       </td></tr>
+  <tr><td> Solaris 32-bit ruby       </td><td> LD_LIBRARY_PATH_32 or LD_LIBRARY_PATH </td></tr>
+  <tr><td> Solaris 64-bit ruby       </td><td> LD_LIBRARY_PATH_64 or LD_LIBRARY_PATH </td></tr>
+  <tr><td> HP-UX PA-RISC 32-bit ruby </td><td> SHLIB_PATH                            </td></tr>
+  <tr><td> HP-UX PA-RISC 64-bit ruby </td><td> LD_LIBRARY_PATH                       </td></tr>
+  <tr><td> HP-UX IA64                </td><td> LD_LIBRARY_PATH                       </td></tr>
+  <tr><td> Mac OS X                  </td><td> DYLD_LIBRARY_PATH                     </td></tr>
+  <tr><td> AIX                       </td><td> LIBPATH                               </td></tr>
+</tbody>
+</table>
+
+Do not forget to export the variable as follows:
+
+    $ LD_LIBRARY_PATH=$ORACLE_HOME/lib
+    $ export LD_LIBRARY_PATH
+
+### Windows(mswin32, mingw32, cygwin)
+
+If sqlplus runs correctly, library search path has no problem.
+
+Run make and install
+--------------------
+
+### UNIX or Windows(mingw32, cygwin)
+
+    gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
+    cd ruby-oci8-VERSION
+    make
+    make install
+
+note: If you use '''sudo''', use it only when running 'make install'.
+sudo doesn't pass library search path to the executing command for security reasons.
+
+### Windows(mswin32)
+
+
+    gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
+    cd ruby-oci8-VERSION
+    nmake
+    nmake install
+
+If you have a problem, look at {file:docs/platform-specific-issues.md}
+and {file:docs/report-installation-issue.md}.
+
+[rubyforge]: http://rubyforge.org/frs/?group_id=256




More information about the ruby-oci8-commit mailing list