updated Documentation.txt

This commit is contained in:
Loïc Chapeaux 2002-02-10 18:50:55 +00:00
parent 8f7a6db11f
commit cd40fd4db2
2 changed files with 238 additions and 59 deletions

View File

@ -15,6 +15,7 @@ $Source$
Query! (2 MB).
* tbl_properties.php3; lines 806-917: removed the link for the "import
dump" feature if file upload is disabled.
* Documentation.txt: updated.
2002-02-09 Marc Delisle <lem9@users.sourceforge.net>
* main.php3, libraries/auth/cookie.auth.lib.php3, Patch

View File

@ -1,20 +1,20 @@
phpMyAdmin 2.2.3 Documentation
phpMyAdmin 2.2.4-dev Documentation
* Official phpMyAdmin project homepage [
* [1]Official phpMyAdmin project homepage [
http://www.phpwizard.net/projects/phpMyAdmin/ ]
* Sourceforge phpMyAdmin download page [
* [2]Sourceforge phpMyAdmin download page [
http://phpmyadmin.sourceforge.net/ ]
* Local documents:
+ Version history: ChangeLog
+ General notes: README
+ License: LICENSE
* Documentation version: $Id: Documentation.html,v 1.122 2002/01/06
19:04:25 lem9 Exp $
+ Version history: [3]ChangeLog
+ General notes: [4]README
+ License: [5]LICENSE
* Documentation version: $Id: Documentation.html,v 1.145 2002/02/10
09:24:47 loic1 Exp $
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[6]Top - [7]Requirements - [8]Introduction - [9]Installation -
[10]Configuration - [11]FAQ - [12]Developers - [13]Credits
______________________________________________________________________
Requirements
@ -27,8 +27,8 @@ Requirements
* a web-browser (doh!).
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[14]Top - [15]Requirements - [16]Introduction - [17]Installation
- [18]Configuration - [19]FAQ - [20]Developers - [21]Credits
______________________________________________________________________
Introduction
@ -54,8 +54,8 @@ Introduction
(--with-zlib) and/or Bzip2 support (--with-bz2).
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[22]Top - [23]Requirements - [24]Introduction - [25]Installation
- [26]Configuration - [27]FAQ - [28]Developers - [29]Credits
______________________________________________________________________
Installation
@ -71,15 +71,17 @@ Installation
Quick Install:
1. Untar or unzip the distribution (be sure to unzip the
subdirectories): tar xzvf phpMyAdmin_x.x.x.tar.gz
subdirectories): tar xzvf phpMyAdmin_x.x.x.tar.gz in your
webserver's document root.
2. Open the file config.inc.php3 in your favourite editor and change
the values for host, user and password to fit your environment.
Have a look at Configuration section for an explanation of all
values.
the values for host, user, password and authentication mode to fit
your environment. Also insert the correct value for
$cfgPmaAbsoluteUri. Have a look at [30]Configuration section for
an explanation of all values.
3. It is recommended that you protect the directory in which you
installed phpMyAdmin (unless it's on a closed intranet, or you
wish to use http or cookie authentication), for example with
HTTP-AUTH (in a .htaccess file). See the FAQ section for
HTTP-AUTH (in a .htaccess file). See the [31]FAQ section for
additional information.
4. Open the file <www.your-host.com>/<your-install-dir>/index.php3 in
your browser. phpMyAdmin should now display a welcome screen and
@ -158,8 +160,8 @@ Installation
protect your configuration file.
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[32]Top - [33]Requirements - [34]Introduction - [35]Installation
- [36]Configuration - [37]FAQ - [38]Developers - [39]Credits
______________________________________________________________________
Configuration
@ -212,8 +214,8 @@ Configuration
columns) & mysql.tables_priv (all columns except "Grantor" &
"Timestamp") tables. This account is used to check what
databases the user will see at login.
Please see the install section on "Using http authentication"
for more information.
Please see the [40]install section on "Using http
authentication" for more information.
Note that if you try login to phpMyAdmin with this "stduser",
you could get some errors, depending the exact privileges you
gave to the "stduser". phpMyAdmin does not support a direct
@ -290,6 +292,27 @@ Configuration
GRANT SELECT,INSERT,DELETE ON <bookmarkdb>.<bookmarktable> to
'stduser'@localhost;
$cfgServers[n]['relation'] string
Since release 2.2.4 you can describe in a relation table which
field is a key in another table. phpMyAdmin currently uses this
to make clickable the data values that point to another table.
Currently, the keys must be numeric, and you must be running
PHP 4.
To use this functionality you have to:
+ create in the same database a table (for example 'relation')
following this scheme:
CREATE TABLE `relation` (
`src_table` varchar(32) NOT NULL default '',
`src_column` varchar(32) NOT NULL default '',
`dest_table` varchar(32) NOT NULL default '',
`dest_column` varchar(32) NOT NULL default '',
PRIMARY KEY (`src_table`,`src_column`)
) TYPE=MyISAM COMMENT='Table Relation';
+ put the relation table name in $cfgServers[n]['relation']
+ then manually fill the relation table with information about
the keys.
$cfgServerDefault integer
If you have more than one server configured, you can set
$cfgServerDefault to any one of them to autoconnect to that
@ -335,6 +358,10 @@ Configuration
Defines whether to display table comment as tooltip in left
frame or not.
$cfgLeftFrameLight boolean
Defines whether to use select-based menu and display only the
current tables in the left frame (smaller page).
$cfgShowMysqlInfo boolean
$cfgShowMysqlVars boolean
$cfgShowPhpInfo boolean
@ -346,6 +373,10 @@ Configuration
you have to put this in your php.ini:
disable_functions = phpinfo()
$cfgLoginCookieRecall boolean
Define whether the previous login should be recalled or not in
cookie authentication mode.
$cfgShowStats boolean
Defines whether to display space usage and statistics about
databases and tables or not.
@ -376,7 +407,7 @@ Configuration
descending order for fields of type TIME, DATE, DATETIME &
TIMESTAMP, ascending order else- by default.
$cfgProtectBinary boolean
$cfgProtectBinary boolean or string
Defines whether BLOB or BINARY fields are protected from
edition when browsing a table's content or not. Valid values
are:
@ -384,6 +415,10 @@ Configuration
- blob to allow edition of all fields except BLOBS;
- all to disallow edition of all BINARY or BLOB fields.
$cfgShowFunctionFields boolean
Defines whether MySQL functions fields should be displayed or
not in edit/insert mode.
$cfgZipDump boolean
$cfgGZipDump boolean
$cfgBZipDump boolean
@ -431,6 +466,11 @@ Configuration
The color (HTML) used for the pointer in browse mode (does not
work with NS4).
$cfgBrowseMarkRow boolean
If the value is 1, you can visually mark rows with the color in
$cfgBrowsePointerColor, by clicking on them. Works on browsers
that support 'onmousedown'.
$cfgTextareaCols integer
$cfgTextareaRows integer
Number of columns and rows for the textareas.
@ -467,8 +507,8 @@ Configuration
need to edit this.
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[41]Top - [42]Requirements - [43]Introduction - [44]Installation
- [45]Configuration - [46]FAQ - [47]Developers - [48]Credits
______________________________________________________________________
FAQ - Frequently Asked Questions
@ -494,15 +534,15 @@ FAQ - Frequently Asked Questions
specified CGI application misbehaved by not returning a complete set
of HTTP headers...."
You just forgot to read the install.txt file from the php
distribution. Have a look at the last message in this bug report from
the official php bug database.
distribution. Have a look at the last message in this [49]bug report
from the official php bug database.
Using phpMyAdmin on IIS, I'm facing crashes and/or many error messages
with the http or advanced authentication mode.
This is a known problem with the php ISAPI filter: it's not so stable.
For some more information and complete testings see the messages
posted by André B. aka "djdeluxe76" in this thread from the phpWizard
forum.
posted by André B. aka "djdeluxe76" in [50]this thread from the
phpWizard forum.
Please use instead the cookie authentication mode.
I can't use phpMyAdmin on PWS: nothing is displayed!
@ -538,11 +578,12 @@ FAQ - Frequently Asked Questions
7.0 and you updated your php rpm to php-4.0.4pl1-3.i386.rpm, didn't
you?
So the problem is that this package has a serious bug that was
corrected ages ago in php (2001-01-28: see php's bug tracking system
for more details). The problem is that the bugged package is still
available though it was corrected (see redhat's bugzilla for more
details).
So please download the fixed package and the problem should go away.
corrected ages ago in php (2001-01-28: see [51]php's bug tracking
system for more details). The problem is that the bugged package is
still available though it was corrected (see [52]redhat's bugzilla for
more details).
So please download [53]the fixed package (4.0.4pl1-9) and the problem
should go away.
And that fixes the \r\n problem with file uploads!
I'm having troubles when uploading files with phpMyAdmin running on a
@ -553,6 +594,23 @@ FAQ - Frequently Asked Questions
SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
It seems to clear up many problems between IE and SSL.
I get an 'open_basedir restriction' while uploading a file from the
query box.
Since version 2.2.4, phpMyAdmin supports servers with open_basedir
restrictions. Assuming that the restriction allows you to open files
in the current directory ('.'), all you have to do is create a 'tmp'
directory under the phpMyAdmin install directory, with permissions 777
and the same owner as the owner of your phpMyAdmin directory. The
uploaded files will be moved there, and after execution of your SQL
commands, removed.
I have lost my MySQL root password, what can I do?
The MySql manual explains how to [54]reset the permissions.
I get an error 'No SQL query' when trying to execute a bookmark.
If PHP does not have read/write access to its upload_tmp_dir, it
cannot access the uploaded query.
[Configuration]
The error message "Warning: Cannot add header information - headers
@ -570,7 +628,7 @@ FAQ - Frequently Asked Questions
The error message "Warning: MySQL Connection Failed: Can't connect to
local MySQL server through socket '/tmp/mysql.sock' (111)...") is
displayed. What can I do?
Here is a fix suggested by Brad Ummer in the phpwizard forum:
Here is a fix suggested by Brad Ummer in the [55]phpwizard forum:
* First, you need to determine what socket is being used by MySQL.
To do this, telnet to your server and go to the MySQL bin
directory. In this directory there should be a file named
@ -584,7 +642,7 @@ FAQ - Frequently Asked Questions
config.inc.php3.
For example: $cfgServers[n]['socket'] = '/tmp/mysql.sock';
Have also a look at the corresponding section of the MySQL
Have also a look at the [56]corresponding section of the MySQL
documentation.
Nothing is displayed by my browser when I try to run phpMyAdmin, what
@ -611,6 +669,14 @@ FAQ - Frequently Asked Questions
opened browser windows and then go back to phpMyAdmin. You should be
able to logs in again.
When dumping a large table in compressed mode, I get a memory limit
error or a time limit error.
As of version 2.2.4, we build the compressed dump in memory, so large
tables dumps may hang. The only alternative we can think about (using
system calls to mysqldump then gzip or bzip2) would not be applicable
in environments where PHP is in safe mode: access to system programs
is is limited by the system administrator, and time limit is enforced.
[ISPs]
I'm an ISP. Can I setup one central copy of phpMyAdmin or do I need to
@ -675,10 +741,27 @@ FAQ - Frequently Asked Questions
Konqueror, or else they disappear. Gzip dumps give an error message.
Testing needs to be done for Konqueror 2.2.2.
In Internet Explorer 5.0, I get Javascript errors when browsing my
rows.
Upgrade to at least Internet Explorer 5.5SP2.
In Internet Explorer 5.0, 5.5 or 6.0, I get an error when trying to
modify a row in a table with many fields, or with a text field.
Your table neither have a primary key nor an unique one, so we must
use a long URL to identify this row. There is a limit on the lenght of
the URL in those browsers, and this not happen in Netscape, for
example. The workaround is to create a primary or unique key, or use
another browser.
I refresh (reload) my browser, and come back to the welcome page.
Some browsers support right-clicking into the frame you want to
refresh, just do this in the right frame.
With Mozilla 0.9.7 I have problems sending a query modified in the
query box.
Looks like a Mozilla bug: 0.9.6 was ok. We will keep an eye on future
Mozilla versions.
[Using phpMyAdmin]
I can't insert new rows into a table - MySQL brings up a SQL-error.
@ -707,10 +790,11 @@ FAQ - Frequently Asked Questions
I have found a bug. How do I inform developers?
Our Bug Tracker is located at
http://sourceforge.net/projects/phpmyadmin/ under the Bugs section.
[57]http://sourceforge.net/projects/phpmyadmin/ under the Bugs
section.
But please first discuss your bug with other users:
http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
http://www.phpwizard.net/projects/phpMyAdmin/ (and choose Support
[58]http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
[59]http://www.phpwizard.net/projects/phpMyAdmin/ (and choose Support
Forum)
I want to translate the messages to a new language or upgrade an
@ -737,15 +821,15 @@ FAQ - Frequently Asked Questions
[This will create a new sub-directory named phpMyAdmin]
* add your stuff
* put the modified files (tar'ed and gzip'ed) inside the patch
tracker of the phpMyAdmin SourceForge account.
tracker of the [60]phpMyAdmin SourceForge account.
Write access to the CVS tree is granted only to experienced developers
who have already contributed something useful to phpMyAdmin.
Also, have a look at the Developers section.
Also, have a look at the [61]Developers section.
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[62]Top - [63]Requirements - [64]Introduction - [65]Installation
- [66]Configuration - [67]FAQ - [68]Developers - [69]Credits
______________________________________________________________________
Developers Information
@ -767,7 +851,7 @@ Developers Information
please try to keep your code as simple as possible: beginners are
using phpMyAdmin as an example application.
By the way, we're currently updating all the scripts so they will
be XHTML1.0 and CSS2 compliant on one hand, they will fit PEAR
be XHTML1.0 and CSS2 compliant on one hand, they will fit [70]PEAR
coding standards on the other hand. Please pay attention to this.
* Please try to keep up the file-naming conventions. Table-related
stuff goes to tbl_*.php3, db-related code to db_*.php3 and so on.
@ -790,7 +874,7 @@ Developers Information
* add your stuff
* put the modified files (tar'ed and gzip'ed) inside the patch
tracker of the phpMyAdmin SourceForge account
(http://sourceforge.net/projects/phpmyadmin/)
([71]http://sourceforge.net/projects/phpmyadmin/)
Write access to the CVS tree is granted only to developers who have
already contributed something useful to phpMyAdmin. If you're
@ -798,8 +882,8 @@ Developers Information
mailing list.
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[72]Top - [73]Requirements - [74]Introduction - [75]Installation
- [76]Configuration - [77]FAQ - [78]Developers - [79]Credits
______________________________________________________________________
Credits
@ -865,20 +949,22 @@ CREDITS, in chronological order
Thanks to those guy who send us some major improvements to merge into the
code since version 2.1.0:
- Michal Cihar who implemented the enhanced
index creation/display feature.
- Michal Cihar <nijel at users.sourceforge.net> who implemented the
enhanced index creation/display feature.
- Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
(http://sourceforge.net/projects/phpmysqlformgen/) who suggested the patch
for multiple table printviews.
- Garvin Hicking who builds the patch for vertical
display of table rows.
- Piotr Roszatycki and Dan Wilson, for the
Cookie authentication mode.
- Garvin Hicking <hicking at faktor-e.de> who builds the patch for
vertical display of table rows.
- Piotr Roszatycki <d3xter at users.sourceforge.net> and Dan Wilson, for
the Cookie authentication mode.
- Axel Sander <n8falke at users.sourceforge.net> for the table
relation-links feature.
And also to the following people who have contributed minor changes,
enhancements, bugfixes or support for a new language since version 2.1.0:
Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita, Borges Botelh
o,
Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita, Bakondy Péter
, Borges Botelho,
Olivier Bussier, Neil Darlow, Kristof Hamann, Thomas Kläger, Lubos Klokner,
Martin Marconcini, Girish Nair, David Nordenberg, Bernard M. Piller,
Laurent Haas, "Sakamoto", www.securereality.com.au,
@ -927,8 +1013,100 @@ Original Credits of Version 2.1.0
and or just some feedback.
______________________________________________________________________
Top - Requirements - Introduction - Installation -
Configuration - FAQ - Developers - Credits
[80]Top - [81]Requirements - [82]Introduction - [83]Installation
- [84]Configuration - [85]FAQ - [86]Developers - [87]Credits
______________________________________________________________________
Valid XHTML 1.0! Valid CSS!
[88]Valid XHTML 1.0! [89]Valid CSS!
References
1. http://www.phpwizard.net/projects/phpMyAdmin/
2. http://phpmyadmin.sourceforge.net/
3. http://localhost/phpMyAdmin-devel/ChangeLog
4. http://localhost/phpMyAdmin-devel/README
5. http://localhost/phpMyAdmin-devel/LICENSE
6. http://localhost/phpMyAdmin-devel/Documentation.html#top
7. http://localhost/phpMyAdmin-devel/Documentation.html#require
8. http://localhost/phpMyAdmin-devel/Documentation.html#intro
9. http://localhost/phpMyAdmin-devel/Documentation.html#setup
10. http://localhost/phpMyAdmin-devel/Documentation.html#config
11. http://localhost/phpMyAdmin-devel/Documentation.html#faq
12. http://localhost/phpMyAdmin-devel/Documentation.html#developers
13. http://localhost/phpMyAdmin-devel/Documentation.html#credits
14. http://localhost/phpMyAdmin-devel/Documentation.html#top
15. http://localhost/phpMyAdmin-devel/Documentation.html#require
16. http://localhost/phpMyAdmin-devel/Documentation.html#intro
17. http://localhost/phpMyAdmin-devel/Documentation.html#setup
18. http://localhost/phpMyAdmin-devel/Documentation.html#config
19. http://localhost/phpMyAdmin-devel/Documentation.html#faq
20. http://localhost/phpMyAdmin-devel/Documentation.html#developers
21. http://localhost/phpMyAdmin-devel/Documentation.html#credits
22. http://localhost/phpMyAdmin-devel/Documentation.html#top
23. http://localhost/phpMyAdmin-devel/Documentation.html#require
24. http://localhost/phpMyAdmin-devel/Documentation.html#intro
25. http://localhost/phpMyAdmin-devel/Documentation.html#setup
26. http://localhost/phpMyAdmin-devel/Documentation.html#config
27. http://localhost/phpMyAdmin-devel/Documentation.html#faq
28. http://localhost/phpMyAdmin-devel/Documentation.html#developers
29. http://localhost/phpMyAdmin-devel/Documentation.html#credits
30. http://localhost/phpMyAdmin-devel/Documentation.html#config
31. http://localhost/phpMyAdmin-devel/Documentation.html#faq
32. http://localhost/phpMyAdmin-devel/Documentation.html#top
33. http://localhost/phpMyAdmin-devel/Documentation.html#require
34. http://localhost/phpMyAdmin-devel/Documentation.html#intro
35. http://localhost/phpMyAdmin-devel/Documentation.html#setup
36. http://localhost/phpMyAdmin-devel/Documentation.html#config
37. http://localhost/phpMyAdmin-devel/Documentation.html#faq
38. http://localhost/phpMyAdmin-devel/Documentation.html#developers
39. http://localhost/phpMyAdmin-devel/Documentation.html#credits
40. http://localhost/phpMyAdmin-devel/Documentation.html#setup
41. http://localhost/phpMyAdmin-devel/Documentation.html#top
42. http://localhost/phpMyAdmin-devel/Documentation.html#require
43. http://localhost/phpMyAdmin-devel/Documentation.html#intro
44. http://localhost/phpMyAdmin-devel/Documentation.html#setup
45. http://localhost/phpMyAdmin-devel/Documentation.html#config
46. http://localhost/phpMyAdmin-devel/Documentation.html#faq
47. http://localhost/phpMyAdmin-devel/Documentation.html#developers
48. http://localhost/phpMyAdmin-devel/Documentation.html#credits
49. http://bugs.php.net/bug.php?id=12061
50. http://www.phpwizard.net/phorum/read.php?f=1&i=6624&t=6300
51. http://www.php.net/bugs.php?id=8966
52. http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933
53. http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html
54. http://www.mysql.com/doc/R/e/Resetting_permissions.html
55. http://www.phpwizard.net/phorum/list.php?f=1
56. http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html
57. http://sourceforge.net/projects/phpmyadmin/
58. http://sourceforge.net/projects/phpmyadmin/
59. http://www.phpwizard.net/projects/phpMyAdmin/
60. https://sourceforge.net/projects/phpmyadmin/
61. http://localhost/phpMyAdmin-devel/Documentation.html#developers
62. http://localhost/phpMyAdmin-devel/Documentation.html#top
63. http://localhost/phpMyAdmin-devel/Documentation.html#require
64. http://localhost/phpMyAdmin-devel/Documentation.html#intro
65. http://localhost/phpMyAdmin-devel/Documentation.html#setup
66. http://localhost/phpMyAdmin-devel/Documentation.html#config
67. http://localhost/phpMyAdmin-devel/Documentation.html#faq
68. http://localhost/phpMyAdmin-devel/Documentation.html#developers
69. http://localhost/phpMyAdmin-devel/Documentation.html#credits
70. http://pear.php.net/
71. http://sourceforge.net/projects/phpmyadmin/
72. http://localhost/phpMyAdmin-devel/Documentation.html#top
73. http://localhost/phpMyAdmin-devel/Documentation.html#require
74. http://localhost/phpMyAdmin-devel/Documentation.html#intro
75. http://localhost/phpMyAdmin-devel/Documentation.html#setup
76. http://localhost/phpMyAdmin-devel/Documentation.html#config
77. http://localhost/phpMyAdmin-devel/Documentation.html#faq
78. http://localhost/phpMyAdmin-devel/Documentation.html#developers
79. http://localhost/phpMyAdmin-devel/Documentation.html#credits
80. http://localhost/phpMyAdmin-devel/Documentation.html#top
81. http://localhost/phpMyAdmin-devel/Documentation.html#require
82. http://localhost/phpMyAdmin-devel/Documentation.html#intro
83. http://localhost/phpMyAdmin-devel/Documentation.html#setup
84. http://localhost/phpMyAdmin-devel/Documentation.html#config
85. http://localhost/phpMyAdmin-devel/Documentation.html#faq
86. http://localhost/phpMyAdmin-devel/Documentation.html#developers
87. http://localhost/phpMyAdmin-devel/Documentation.html#credits
88. http://validator.w3.org/check/referer
89. http://jigsaw.w3.org/css-validator/