makes more sense the other way :)
[yasql.git] / INSTALL
blob691e8b14979c1c6004265332acb96e99b1791279
1 YASQL
3 Requirements:
5    Perl 5
6        This was developed with Perl 5.6, but is known to work
7        on 5.005_03 and above.  Any earlier version of Perl 5
8        may or may not work.  Perl 4 will definately not work.
10    Unix environment
11        YASQL was developed under GNU/Linux, and aimed at as many
12        Unix installations as possible.  Known to be
13        compatible with GNU/Linux, AIX and Sun Solaris.
14        Please send me an email (qzy@users.sourceforge.net) if it
15        works for other platforms.  I'd be especially
16        interested if it worked on Win32.
18    Oracle Server
19        It has been tested and developed for Oracle8 and
20        Oracle8i.  There is atleast one issue with Oracle7
21        that I know of (see ISSUES below) and I have not
22        tested it with Oracle9 yet.
24    Oracle client libraries
25        The Oracle client libraries must be installed for
26        DBD::Oracle.  Of course you can't install DBD::Oracle
27        without them...
29    DBD::Oracle
30        DBD::Oracle must be installed since this uses DBI for
31        database connections.
33    ORACLE_HOME
34        The ORACLE_HOME environment variable must be set if
35        you use a connection descriptor to connect so that
36        YASQL can translate the descriptor into usefull
37        connection information to make the actual connection.
39    ORACLE_SID
40        The ORACLE_SID environment variable must be set unless
41        you specify one with the -s option (see options
42        above).
44    Term::Readline
45        Term::Readline must be installed (it is with most Perl
46        installations), but more importantly, installing
47        Term::ReadLine::Gnu from CPAN will greatly enhance the
48        usability.
50    Time::HiRes
51        This is used for high resolution benchmarking.  It is
52        optional.
54    Text::CSV_XS
55        This perl module is required if you want to output CSV
56        or input from CSV files.  If you don't plan on using
57        this features, then you don't need to install this
58        module.
60    Term::ReadKey
61        This module is used for better input and output
62        control.  Right now it isn't required, but some parts
63        of YASQL will look and function better with this
64        installed.
66 Installation:
68  * gmake [options]
70    The following options are used by Makefile:
71      prefix=PREFIX         install architecture-independent files in PREFIX
72                              [/usr/local]
73      PERL=                 path to the perl binary
74      SHELL=                path to a POSIX shell
75      
76  * gmake [options] install
78 Etc:
80 type 'man yasql' for usage instructions.
82 type 'yasql' to run it!
84 To use the advanced features you should have the Term::Readline:Gnu perl 
85 package installed, as well as the Time::HiRes module.  Both of these are 
86 optional, but they really are nice to have.
88 Get the latest version from http://github.com/datamuc/yasqlng