Skip to content

Doc improvements #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 4, 2013
Merged

Doc improvements #17

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ced859f
Removed duplicate links, format URLs as link.
mbeijen Sep 30, 2013
33707ab
Reformat copyright list, split LICENSE to separate section.
mbeijen Sep 30, 2013
5fee7fc
Improved cpan client instructions, removed Data::ShowTable, which is …
mbeijen Sep 30, 2013
b0b9739
Removed obsolete info.
mbeijen Oct 3, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 38 additions & 95 deletions lib/DBD/mysql.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1869,32 +1869,27 @@ If you are using precompiled binaries, then it may be possible to
use just selected RPM's like MySQL-client and MySQL-devel or something
similar, depending on the distribution.

First you need to install the DBI module. For using I<dbimon>, a
simple DBI shell it is recommended to install Data::ShowTable another
Perl module.

I recommend trying automatic installation via the CPAN module. Try

perl -MCPAN -e shell
cpan

If you are using the CPAN module for the first time, it will prompt
you a lot of questions. If you finally receive the CPAN prompt, enter

install Bundle::DBD::mysql
install DBD::mysql

=head2 Manual Installation

If this fails (which may be the case for a number of reasons, for
example because you are behind a firewall or don't have network
access), you need to do a manual installation. First of all you
need to fetch the modules from CPAN search
need to fetch the modules from CPAN

http://search.cpan.org/
L<https://metacpan.org>

The following modules are required

DBI
Data::ShowTable
DBD::mysql

Then enter the following commands (note - versions are just examples):
Expand All @@ -1906,13 +1901,6 @@ Then enter the following commands (note - versions are just examples):
make test
make install

cd ..
gzip -cd Data-ShowTable-(version).tar.gz | tar xf -
cd Data-ShowTable-3.3
perl Makefile.PL
make
make install

cd ..
gzip -cd DBD-mysql-(version)-tar.gz | tar xf -
cd DBD-mysql-(version)
Expand All @@ -1931,8 +1919,6 @@ F</usr/lib/mysql/libmysqlclient.a> or F</usr/lib/libmysqlclient.so>.
=head1 WIN32 INSTALLATION

If you are using ActivePerl, you may use ppm to install DBD-mysql.
For Perl 5.6, upgrade to Build 623 or later, then it is sufficient
to run

ppm install DBI
ppm install DBD::mysql
Expand All @@ -1942,19 +1928,6 @@ variable http_proxy, for example like this:

set http_proxy=http://myproxy.com:8080/

As of this writing, DBD::mysql is missing in the ActivePerl 5.8.0
repository. However, Randy Kobes has kindly donated an own
distribution and the following might succeed:

ppm install http://theoryx5.uwinnipeg.ca/ppms/DBD-mysql.ppd

Otherwise you definitely *need* a C compiler. And it *must* be the same
compiler that was being used for compiling Perl itself. If you don't
have a C compiler, the file README.win32 from the Perl source
distribution tells you where to obtain freely distributable C compilers
like egcs or gcc. The Perl sources are available via CPAN search

http://search.cpan.org

I recommend using the win32clients package for installing DBD::mysql
under Win32, available for download on www.tcx.se. The following steps
Expand All @@ -1964,28 +1937,6 @@ have been required for me:

=item -

The current Perl versions (5.6, as of this writing) do have a problem
with detecting the C libraries. I recommend to apply the following
patch:

*** c:\Perl\lib\ExtUtils\Liblist.pm.orig Sat Apr 15 20:03:40 2000
--- c:\Perl\lib\ExtUtils\Liblist.pm Sat Apr 15 20:03:45 2000
***************
*** 230,235 ****
--- 230,239 ----
# add "$Config{installarchlib}/CORE" to default search path
push @libpath, "$Config{installarchlib}/CORE";

+ if ($VC and exists($ENV{LIB}) and defined($ENV{LIB})) {
+ push(@libpath, split(/;/, $ENV{LIB}));
+ }
+
foreach (Text::ParseWords::quotewords('\s+', 0, $potential_libs)){

$thislib = $_;

=item -

Extract sources into F<C:\>. This will create a directory F<C:\mysql>
with subdirectories include and lib.

Expand All @@ -2003,7 +1954,7 @@ example F<C:\src\siteperl>

=item -

Open a DOS shell and change directory to F<C:\src\siteperl>.
Open a CMD.exe shell and change directory to F<C:\src\siteperl>.

=item -

Expand Down Expand Up @@ -2040,30 +1991,6 @@ Continued in the usual way:
nmake
nmake install

=back

If you want to create a PPM package for the ActiveState Perl version, then
modify the above steps as follows: Run

perl Makefile.PL NAME=DBD-mysql BINARY_LOCATION=DBD-mysql.tar.gz
nmake ppd
nmake

Once that is done, use tar and gzip (for example those from the CygWin32
distribution) to create an archive:

mkdir x86
tar cf x86/DBD-mysql.tar blib
gzip x86/DBD-mysql.tar

Put the files x86/DBD-mysql.tar.gz and DBD-mysql.ppd onto some WWW server
and install them by typing

install http://your.server.name/your/directory/DBD-mysql.ppd

in the PPM program.


=head1 AUTHORS

Originally, there was a non-DBI driver, Mysql, which was much like
Expand Down Expand Up @@ -2104,43 +2031,58 @@ many features and fixes from DBD::mysql have come from the community.

=head1 COPYRIGHT


This module is
Large Portions Copyright (c) 2004-2010 Patrick Galbraith

=over

=item *

Large Portions Copyright (c) 2004-2013 Patrick Galbraith

=item *

Large Portions Copyright (c) 2004-2006 Alexey Stroganov

=item *

Large Portions Copyright (c) 2003-2005 Rudolf Lippan

=item *

Large Portions Copyright (c) 1997-2003 Jochen Wiedmann, with code portions
Copyright (c)1994-1997 their original authors This module is
released under the same license as Perl itself. See the Perl README
for details.

=item *

Copyright (c)1994-1997 their original authors

=back


=head1 LICENSE

This module is released under the same license as Perl itself. See
L<http://www.perl.com/perl/misc/Artistic.html> for details.


=head1 MAILING LIST SUPPORT

This module is maintained and supported on a mailing list, dbi-users.

To subscribe to this list, send and email to
To subscribe to this list, send an email to

dbi-users-subscribe@perl.org

Mailing list archives are at

http://groups.google.com/group/perl.dbi.users?hl=en&lr=

Also, the main DBI site is at

http://dbi.perl.org/

And source:
L<http://groups.google.com/group/perl.dbi.users?hl=en&lr=>

https://github.com/perl5-dbi/DBD-mysql/

=head1 ADDITIONAL DBI INFORMATION

Additional information on the DBI project can be found on the World
Wide Web at the following URL:

http://dbi.perl.org
L<http://dbi.perl.org>

where documentation, pointers to the mailing lists and mailing list
archives and pointers to the most current versions of the modules can
Expand All @@ -2150,10 +2092,11 @@ Information on the DBI interface itself can be gained by typing:

perldoc DBI

Information on the DBD::mysql specifically can be gained by typing:
Information on DBD::mysql specifically can be gained by typing:

perldoc DBD::mysql

(this will display the document you're currently reading)


=head1 BUG REPORTING, ENHANCEMENT/FEATURE REQUESTS
Expand All @@ -2162,7 +2105,7 @@ Please report bugs, including all the information needed
such as DBD::mysql version, MySQL version, OS type/version, etc
to this link:

http://rt.cpan.org
L<https://rt.cpan.org/Dist/Display.html?Name=DBD-mysql>

Note: until recently, MySQL/Sun/Oracle responded to bugs and assisted in
fixing bugs which many thanks should be given for their help!
Expand Down