more typos
[phpmyadmin/crack.git] / Documentation.txt
blob6dd397762f0a3244d419a60ab58a042da53df0dd
2    ______________________________________________________________________
3    
4    Top  -  Requirements  -  Introduction  -  Installation  -
5    Configuration
6    Transformations  -  FAQ  -  Developers  -  Credits  -  Translators
7    ______________________________________________________________________
8    
9                       phpMyAdmin 2.5.1-rc1 Documentation
10                                        
11      * SourceForge phpMyAdmin project page   [ http://www.phpmyadmin.net/
12        ] 
13      * Local documents:
14           + Version history: ChangeLog
15           + General notes: README
16           + License: LICENSE
17      * Documentation version: $Id: Documentation.html,v 1.449 2003/05/26
18        12:33:36 lem9 Exp $
19        
20 Requirements
22      * PHP3 or PHP4: phpMyAdmin widely uses the 'str_replace()' PHP
23        function that was added in PHP 3.0.6, but was buggy up until
24        PHP 3.0.8. Then you should not run this script with PHP3 < 3.0.8.
25        PHP also needs to be compiled with MySQL support;
26        If you want to display inline thumbnails of JPEGs, you also need
27        GD2 support in PHP.
28      * MySQL (tested with 3.21.x, 3.22.x, 3.23.x and 4.0.x);
29        Note: Because of a major change in the definition syntax of string
30        field types, this version of phpMyAdmin probably won't work
31        correctly with MySQL >= 4.1.0!
32      * a web-browser (doh!).
33        
34 Introduction
36    phpMyAdmin can manage a whole MySQL server (needs a super-user) as
37    well as a single database. To accomplish the latter you'll need a
38    properly set up MySQL user who can read/write only the desired
39    database. It's up to you to look up the appropriate part in the MySQL
40    manual.
41    Currently phpMyAdmin can:
42      * create and drop databases
43      * create, copy, drop, rename and alter tables
44      * do table maintenance
45      * delete, edit and add fields
46      * execute any SQL-statement, even batch-queries
47      * manage keys on fields
48      * load text files into tables
49      * create (*) and read dumps of tables
50      * export (*) data to CSV, XML and Latex formats
51      * administer multiple servers
52      * manage MySQL users and privileges
53      * check referential integrity
54      * using Query-by-example (QBE), create complex queries automatically
55        connecting required tables
56      * create PDF graphics of your Database layout
57      * search globally in a database or a subset of it
58      * transform stored data into any format using a set of predefined
59        functions, like displaying BLOB-data as image or download-link or
60        ...
61      * communicate in 42 different languages
62        
63    (*)  phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
64    dumps and CSV exports if you use PHP4 >= 4.0.4 with Zlib support
65    (--with-zlib) and/or Bzip2 support (--with-bz2).
66    
67 Installation
69    NOTE: phpMyAdmin does not apply any special security methods to the
70    MySQL database server. It is still the system administrator's job to
71    grant permissions on the MySQL databases properly. phpMyAdmin's
72    "Privileges" page can be used for this.
73    
74    Warning for Mac users:if you are on a MacOS version before OS X,
75    StuffIt unstuffs with Mac formats.
76    So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin
77    scripts before uploading them to your server, as PHP seems not to like
78    Mac-style end of lines character ("\r").
79    
80    Documentation warning: when you see in this document a .php3 file
81    extension, please transpose to .php if you are using a kit with files
82    having this extension.
83    
84    Quick Install:
85     1. Choose and download a distribution kit with the files having the
86        extension (.php3 or .php) depending on the way your web/PHP server
87        interprets those extensions.
88     2. Untar or unzip the distribution (be sure to unzip the
89        subdirectories): tar -xzvf phpMyAdmin_x.x.x.tar.gz in your
90        webserver's document root. If you don't have direct access to your
91        document root, put the files in a directory on your local machine,
92        and, after step 3, transfer the directory on your web server
93        using, for example, ftp.
94     3. Open the file config.inc.php3 in your favorite editor and change
95        the values for host, user, password and authentication mode to fit
96        your environment. Here, "host" means the MySQL server. Also insert
97        the correct value for $cfg['PmaAbsoluteUri']. Have a look at
98        Configuration section for an explanation of all values.
99     4. It is recommended that you protect the directory in which you
100        installed phpMyAdmin (unless it's on a closed intranet, or you
101        wish to use HTTP or cookie authentication), for example with
102        HTTP-AUTH (in a .htaccess file). See the FAQ section for
103        additional information.
104     5. Open the file <www.your-host.com>/<your-install-dir>/index.php3 in
105        your browser. phpMyAdmin should now display a welcome screen and
106        your databases, or a login dialog if using HTTP or cookie
107        authentication mode.
108     6. For a whole set of new features (bookmarks, comments, SQL-history,
109        PDP-generation) you need to create a set of tables in your
110        database. Please look at your scripts/ directory, where you should
111        find a file called create_tables.sql. You can already use your
112        phpMyAdmin to create the tables for you. Please be aware that you
113        may have to have special (administrator) privileges to create the
114        database and tables. After having imported the create_tables.sql
115        file, you should specify the table names in your config.inc.php3
116        file. The directives used for that can be found in the
117        Configuration section.
118        
119    Upgrading from an older version:
120      * Please do not copy your older config.inc.php3 over the new one: it
121        may offer new configuration variables, and the new version may
122        depend on these for normal behavior. It is suggested instead to
123        insert your site values in the new one.
124        
125    Using authentication modes:
126      * HTTP and cookie authentication modes are recommended in a
127        multi-user environment where you want to give users access to
128        their own database and don't want them to play around with others.
129        Nevertheless be aware that MS Internet Explorer seems to be really
130        buggy about cookies, at least till version 6. And PHP 4.1.1 is
131        also a bit buggy in this area!
132        Even in a single-user environment, you might prefer to use HTTP or
133        cookie mode so that your user/password pair are not in clear in
134        the configuration file.
135      * HTTP and cookie authentication modes are more secure: the MySQL
136        password does not need to be set in the phpMyAdmin configuration
137        file (except for the "controluser" -see the Configuration
138        section).
139        However, keep in mind that the password travels in plain text,
140        unless you are using the HTTPS protocol.
141        In cookie mode, we send the password in a temporary cookie, so
142        most browsers should not store the password in their cookie file.
143      * For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that
144        has only the SELECT privilege on the mysql.user (all columns
145        except "Password"), mysql.db (all columns) & mysql.tables_priv
146        (all columns except "Grantor" & "Timestamp") tables.
147        You must specify the details for the controluser in the
148        config.inc.php3 file under the $cfg['Servers'][$i]['controluser']&
149        $cfg['Servers'][$i]['controlpass'] settings.
150        The following example assumes you want to use pma as the
151        controluser and pmapass as the controlpass, but this is only an
152        example: use something else in your file!
153        Of course you have to replace localhost by the webserver's host if
154        it's not the same as the MySQL server's one.
156 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
157 GRANT SELECT (
158     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
159     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
160     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
161     Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
162     Execute_priv, Repl_slave_priv, Repl_client_priv
163     ) ON mysql.user TO 'pma'@'localhost';
164 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
165 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
166 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
167     ON mysql.tables_priv TO 'pma'@'localhost';
169        If you are using an old MySQL version (below 4.0.2), please use
170        this query instead of the second one:
172 GRANT SELECT (
173     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
174     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
175     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
176     ) ON mysql.user TO 'pma'@'localhost';
178        ... and if you want to use the many new relation and bookmark
179        features:
181 GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db> TO 'pma'@'localhost';
183        (this of course requires you to have a special DB for phpMyAdmin,
184        the contents will be explained later)
185        Of course, the above queries only work if your MySQL version
186        supports the GRANT command. This is the case since 3.22.11.
187      * Then each of the true users should be granted a set of privileges
188        on a set of particular databases. Normally you shouldn't give
189        global privileges to an ordinary user, unless you understand the
190        impact of those privileges (for example, you are creating a
191        superuser).
192        For example, to grant the user real_user with all privileges on
193        the database user_base:
194           GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost
195        IDENTIFIED BY 'real_password';
196        What the user may now do is controlled entirely by the MySQL user
197        management system.
198        With HTTP or cookie authentication mode, you don't need to fill
199        the user/password fields inside the $cfg['Servers'] array.
200        
201    'http' authentication mode:
202      * Was called 'advanced' in versions before 2.2.3.
203      * Introduced in 1.3.0, it uses Basic HTTP authentication method and
204        allows you to login as any valid MySQL user.
205      * Is only supported with PHP running as an Apache module, not with
206        CGI.
207        
208    'cookie' authentication mode:
209      * You can use this method as a replacement for the HTTP
210        authentication (for example, if you're running IIS).
211      * Obviously, the user must enable cookies in the browser.
212      * With this mode, the use can truly logout of phpMyAdmin and login
213        back with the same username.
214        
215    'config' authentication mode:
216      * This mode is the less secure one because it requires you to fill
217        the $cfg['Servers'][$i]['user'] and
218        $cfg['Servers'][$i]['password'] fields.
219        But you don't need to setup a "controluser" here: using the
220        $cfg['Servers'][$i]['only_db'] might be enough.
221      * In the ISP FAQ section, there is an entry explaining how to
222        protect your configuration file.
223      * For additional security in this mode, you may wish to consider the
224        Host authentication $cfg['Servers'][$i]['AllowDeny']['order'] and
225        $cfg['Servers'][$i]['AllowDeny']['rules'] configuration
226        directives.
227        
228 Configuration
230    Warning for Mac users: PHP seems not to like Mac end of lines
231    character ("\r"). So ensure you choose the option that allows to use
232    the *nix end of line character ("\n") in your text editor before
233    registering a script you have modified.
234    
235    All configurable data is placed in config.inc.php3.
236    
237    $cfg['PmaAbsoluteUri'] string
238           Sets here the complete URL (with full path) to your phpMyAdmin
239           version. E.g.
240           http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
241           phpMyAdmin needs this setting, because of requirements of the
242           HTTP protocol, explained in RFC2616, section 14.30.
243           Don't forget the slash at the end of your URL. The URL must
244           contain characters that are valid for a URL, and on some
245           servers, the path is case-sensitive.
246           Starting with version 2.3.0, you can try to leave this
247           parameter empty, because the program tries to auto-detect its
248           proper value. Additional details are in the configuration file.
249           Alternatively, this setting can be dynamically completed. For
250           example, you can try to use such a kind of code:
251           
252 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
253                        . $_SERVER['HTTP_HOST']
254                        . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
255                        . substr($_SERVER['PHP_SELF'], 0, strrpos($_SERVER['PHP_SELF'], '/')+1);
257     or
259 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
260                        . $_SERVER['SERVER_NAME']
261                        . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
262                        . substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['SCRIPT_NAME'], '/')+1);
265           Please note that the $_SERVER array doesn't exist in
266           PHP < 4.1.0. Try to replace $_SERVER by $HTTP_SERVER_VARS or
267           $GLOBALS in this case.
268           
269    $cfg['PmaAbsoluteUri_DisableWarning'] boolean
270           By default, when you leave $cfg['PmaAbsoluteUri'] empty, and
271           the system detects your absolute URI automatically, we display
272           a warning to remind you. If you have tested the automatic
273           detection, and it works perfectly for your setup, then you can
274           set this variable to squelch the warning.
275           
276    $cfg['PmaNoRelation_DisableWarning'] boolean
277           Starting with version 2.3.0 phpMyAdmin offers a lot of features
278           to work with master / foreign - tables (see
279           $cfg['Servers'][$i]['pmadb']).
280           If you tried to set this up and it does not work for you, have
281           a look on the "Structure" page of one database where you would
282           like to use it. You will find a link that will analyze why
283           those features have been disabled.
284           If you do not want to use those features set this variable to
285           TRUE to stop this message from appearing.
286           
287    $cfg['Servers'] array
288           Since version 1.4.2, phpMyAdmin supports the administration of
289           multiple MySQL servers. Therefore, a $cfg['Servers']-array has
290           been added which contains the login information for the
291           different servers. The first $cfg['Servers'][$i]['host']
292           contains the hostname of the first server, the second
293           $cfg['Servers'][$i]['host'] the hostname of the second server,
294           etc. If you have only one server to administer, simply leave
295           free the hostname of the other $cfg['Server']-entries.
296           
297    $cfg['Servers'][$i]['host'] string
298           The hostname of your $i-th MySQL-server. E.g. localhost.
299           
300    $cfg['Servers'][$i]['port'] string
301           The port-number of your $i-th MySQL-server. Default is 3306
302           (leave blank). If you use "localhost" as the hostname, MySQL
303           ignores this port number and connects with the socket, so if
304           you want to connect to a port different from the default port,
305           use "127.0.0.1" or the real hostname in
306           $cfg['Servers'][$i]['host'].
307           
308    $cfg['Servers'][$i]['socket'] string
309           The path to the socket to use. Leave blank for default.
310           To use the socket feature you must run PHP 3.0.10 or more.
311           
312    $cfg['Servers'][$i]['connect_type'] string
313           What type connection to use with the MySQL server. Your options
314           are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly
315           guaranteed to be available on all MySQL servers, while sockets
316           are not supported on some platforms.
317           To use the socket mode, your MySQL server must be on the same
318           machine as the Web server.
319           
320    $cfg['Servers'][$i]['compress'] boolean
321           Whether to use a compressed protocol for the MySQL server
322           connection or not (experimental).
323           This feature requires PHP >= 4.3.0.
324           
325    $cfg['Servers'][$i]['controluser'] string
326           $cfg['Servers'][$i]['controlpass'] string
327           When using HTTP or cookie authentication modes (or 'config'
328           authentication mode since phpMyAdmin 2.2.1), you need to supply
329           the details of a MySQL account that has SELECT privilege on the
330           mysql.user (all columns except "Password"), mysql.db (all
331           columns) & mysql.tables_priv (all columns except "Grantor" &
332           "Timestamp") tables. This account is used to check what
333           databases the user will see at login.
334           Please see the install section on "Using HTTP authentication"
335           for more information.
336           Note that if you try login to phpMyAdmin with this
337           "controluser", you could get some errors, depending the exact
338           privileges you gave to the "controluser". phpMyAdmin does not
339           support a direct login with the "controluser".
340           In versions before 2.2.5, those were called "stduser/stdpass".
341           
342    $cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
343           Whether config or cookie or http authentication should be used
344           for this server.
345           
346           + 'config' authentication ($auth_type = 'config') is the plain
347             old way: username and password are stored in config.inc.php3.
348           + 'cookie' authentication mode ($auth_type = 'cookie') as
349             introduced in 2.2.3 allows you to log in as any valid MySQL
350             user with the help of... cookies. Log name and password are
351             stored in cookies during the session and password is deleted
352             when it ends.
353           + 'http' authentication (was called 'advanced' in older
354             versions) ($auth_type = 'http') as introduced in 1.3.0 allows
355             you to log in as any valid MySQL user via HTTP-Auth.
356             
357           Please see the install section on "Using authentication modes"
358           for more information.
359           
360    $cfg['Servers'][$i]['user'] string
361           $cfg['Servers'][$i]['password'] string
362           The user/password-pair which phpMyAdmin will use to connect to
363           this MySQL-server. This user/password pair is not needed when
364           HTTP or cookie authentication is used, and should be empty.
365           
366    $cfg['Servers'][$i]['only_db'] string or array
367           If set to a(an array of) database name(s), only this(these)
368           database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
369           this/these database(s) name(s) may contain MySQL wildcards
370           characters ("_" and "%"): if you want to use literal instances
371           of these characters, escape them (I.E. use 'my\_db' and not
372           'my_db').
373           This setting is an efficient way to lower the server charge
374           since the latter does not need to send MySQL requests to build
375           the available database list. But it does not replace the
376           privileges rules of the MySQL database server. If set, it just
377           means only these databases will be displayed but not at all
378           other databases can't be used.
379           An example of using more that one database:
380           $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
381           
382    $cfg['Servers'][$i]['verbose'] string
383           Only useful when using phpMyAdmin with multiple server entries.
384           If set, this string will be displayed instead of the hostname
385           in the pull-down menu on the main page. This can be useful if
386           you want to show only certain databases on your system, for
387           example.
388           
389    $cfg['Servers'][$i]['pmadb'] string
390           Starting with version 2.3.0 phpMyAdmin offers a lot of features
391           to work with master / foreign - tables. To use those as well as
392           the bookmark feature you need special tables with a predefined
393           structure, which we explain below.
394           If you are the only user of this phpMyAdmin installation, you
395           can use your current database to store those special tables; in
396           this case, just put your current database name in
397           $cfg['Servers'][$i]['pmadb'].
398           If you are setting up a multi-user phpMyAdmin installation, you
399           will need to create a new database and setup special
400           privileges, so, as superuser:
401           
402           + create a new database for phpMyAdmin:
403               CREATE DATABASE phpmyadmin;
404             Note that "controluser" must have SELECT, INSERT, UPDATE and
405             DELETE privileges on this database. Here is a query to set up
406             those privileges (using "phpmyadmin" as the database name,
407             and "pma" as the controluser):
408               GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to
409             'pma'@'localhost';
410             do not give any other user rights on this database.
411           + enter the database name in $cfg['Servers'][$i]['pmadb']
412             
413    $cfg['Servers'][$i]['bookmarktable'] string
414           Since release 2.2.0 phpMyAdmin allows to bookmark queries. This
415           can be useful for queries you often run.
416           To allow the usage of this functionality you have to:
417           
418           + set up "pmadb" as described above
419           + within this database create a table following this scheme:
420                  CREATE TABLE `PMA_bookmark` (
421                    id int(11) DEFAULT '0' NOT NULL auto_increment,
422                    dbase varchar(255) NOT NULL,
423                    user varchar(255) NOT NULL,
424                    label varchar(255) NOT NULL,
425                    query text NOT NULL,
426                    PRIMARY KEY (id)
427                  ) TYPE=MyISAM COMMENT='Bookmarks';
428           + enter the table name in $cfg['Servers'][$i]['bookmarktable']
429             
430    $cfg['Servers'][$i]['relation'] string
431           Since release 2.2.4 you can describe, in a special 'relation'
432           table, which field is a key in another table (a foreign key).
433           phpMyAdmin currently uses this to
434           
435           + make clickable, when you browse the master table, the data
436             values that point to the foreign table;
437           + display in an optional tool-tip the "display field" when
438             browsing the master table, if you move the mouse to a column
439             containing a foreign key (use also the 'table_info' table);
440           + display links on the table properties page, to check
441             referential integrity (display missing foreign keys) for each
442             described key;
443           + in query-by-example, create automatic joins (see an example
444             in the FAQ, section "Using phpMyAdmin");
445           + enable you to get a PDF schema of your database (also uses
446             the table_coords table).
447             
448           The keys can be numeric or character.
449           To allow the usage of this functionality the superuser has to:
450           
451           + set up "pmadb" as described above
452           + within this database create a table following this scheme:
453                  CREATE TABLE `PMA_relation` (
454                    `master_db` varchar(64) NOT NULL default '',
455                    `master_table` varchar(64) NOT NULL default '',
456                    `master_field` varchar(64) NOT NULL default '',
457                    `foreign_db` varchar(64) NOT NULL default '',
458                    `foreign_table` varchar(64) NOT NULL default '',
459                    `foreign_field` varchar(64) NOT NULL default '',
460                    PRIMARY KEY (`master_db`, `master_table`,
461             `master_field`),
462                    KEY foreign_field (foreign_db, foreign_table)
463                  ) TYPE=MyISAM COMMENT='Relation table';
464           + put the relation table name in
465             $cfg['Servers'][$i]['relation']
466           + now as normal user open phpMyAdmin and for each one of your
467             tables where you want to use this feature, click
468             "Structure/Relation view/" and choose foreign fields.
469             
470           Please note that in the current (2.3.0) version, master_db must
471           be the same as foreign_db. Those fields have been put in future
472           development of the cross-db relations.
473           
474    $cfg['Servers'][$i]['table_info'] string
475           Since release 2.3.0 you can describe, in a special 'table_info'
476           table, which field is to be displayed as a tool-tip when moving
477           the cursor over the corresponding key.
478           This configuration variable will hold the name of this special
479           table. To allow the usage of this functionality the superuser
480           has to:
481           
482           + set up "pmadb" as described above
483           + within this database create a table following this scheme:
484                  CREATE TABLE `PMA_table_info` (
485                    `db_name` varchar(64) NOT NULL default '',
486                    `table_name` varchar(64) NOT NULL default '',
487                    `display_field` varchar(64) NOT NULL default '',
488                    PRIMARY KEY (`db_name`, `table_name`)
489                  ) TYPE=MyISAM COMMENT='Table information for
490             phpMyAdmin';
491           + put the table name in $cfg['Servers'][$i]['table_info']
492           + then for each table where you want to use this feature, click
493             "Structure/Relation view/Choose field to display" to choose
494             the field.
495             
496           Usage tip: Display field.
497           
498    $cfg['Servers'][$i]['table_coords'] string
499           $cfg['Servers'][$i]['pdf_pages'] string
500           Since release 2.3.0 you can have phpMyAdmin create PDF pages
501           showing the relations between your tables. To do this it needs
502           two tables "pdf_pages" (storing information about the available
503           PDF pages) and "table_coords" (storing coordinates where each
504           table will be placed on a PDF schema output).
505           You must be using the "relation" feature and have a table of
506           PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF
507           output.
508           To allow the usage of this functionality the superuser has to:
509           
510           + set up "pmadb" as described above
511           + within this database create a table following this scheme:
512                  CREATE TABLE `PMA_table_coords` (
513                    `db_name` varchar(64) NOT NULL default '',
514                    `table_name` varchar(64) NOT NULL default '',
515                    `pdf_page_number` int NOT NULL default '0',
516                    `x` float unsigned NOT NULL default '0',
517                    `y` float unsigned NOT NULL default '0',
518                    PRIMARY KEY (`db_name`, `table_name`,
519             `pdf_page_number`)
520                  ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin
521             PDF output';
522           + also within this database create:
523                  CREATE TABLE `PMA_pdf_pages` (
524                    `db_name` varchar(64) NOT NULL default '',
525                    `page_nr` int(10) unsigned NOT NULL auto_increment,
526                    `page_descr` varchar(50) NOT NULL default '',
527                    PRIMARY KEY (page_nr),
528                    KEY (db_name)
529                  ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
530           + put the first table name in
531             $cfg['Servers'][$i]['table_coords'] and the second table name
532             in $cfg['Servers'][$i]['pdf_pages']
533             
534           Usage tips: PDF output.
535           
536    $cfg['Servers'][$i]['column_info'] string
537           Since release 2.3.0 you can store comments to describe each
538           column for each table. These will then be shown on the
539           "printview".
540           Starting with release 2.5.0, comments are consequently used on
541           the table property pages and table browse view, showing up as
542           tool-tips above the column name (properties page) or embedded
543           within the header of table in browse view. They can also be
544           shown in a table dump. Please see the relevant configuration
545           directives later on.
546           Also new in release 2.5.0 is a mime-transformation system which
547           is also based on the following table structure. See
548           Transformations for further information. To use the
549           mime-transformation system, your column_info table has to have
550           the three new fields 'mimetype', 'transformation',
551           'transformation_options'.
552           To allow the usage of this functionality the superuser has to:
553           
554           + set up "pmadb" as described above
555           + within this database create a table following this scheme:
556                  CREATE TABLE `PMA_column_info` (
557                    id int(5) unsigned NOT NULL auto_increment,
558                    db_name varchar(64) NOT NULL default '',
559                    table_name varchar(64) NOT NULL default '',
560                    column_name varchar(64) NOT NULL default '',
561                    `comment` varchar(255) NOT NULL default '',
562                    mimetype varchar(255) NOT NULL default '',
563                    transformation varchar(255) NOT NULL default '',
564                    transformation_options varchar(255) NOT NULL default
565             '',
566                    PRIMARY KEY (id),
567                    UNIQUE KEY db_name (db_name, table_name, column_name)
568                  ) TYPE=MyISAM COMMENT='Comments for Columns';
569           + put the table name in $cfg['Servers'][$i]['column_info']
570           + To update your PRE-2.5.0 Column_comments Table use this:
571                  ALTER TABLE `PMA_column_comments`
572                    ADD `mimetype` VARCHAR( 255 ) NOT NULL ,
573                    ADD `transformation` VARCHAR( 255 ) NOT NULL ,
574                    ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;
575             and remember that the Variable in config.inc.php has been
576             renamed from
577             $cfg['Servers'][$i]['column_comments'] to
578             $cfg['Servers'][$i]['column_info']
579             
580    $cfg['Servers'][$i]['history'] string
581           Since release 2.5.0 you can store your SQL history, which means
582           all queries you entered manually into the phpMyAdmin interface.
583           If you don't want to use a table- based history, you can use
584           the JavaScript-based history. Using that, all your history
585           items are deleted when closing the window.
586           Using $cfg['QueryHistoryMax'] you can specify an amount of
587           history items you want to have on hold. On every login, this
588           list gets cut to the maximum amount.
589           The query history is only available if you use the
590           JavaScript-based query window, see $cfg['QueryFrame'].
591           To allow the usage of this functionality the superuser has to:
592           
593           + set up "pmadb" as described above
594           + within this database create a table following this scheme:
595                  CREATE TABLE `PMA_history` (
596                    `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
597                    `username` VARCHAR( 64 ) NOT NULL ,
598                    `db` VARCHAR( 64 ) NOT NULL ,
599                    `table` VARCHAR( 64 ) NOT NULL ,
600                    `timevalue` TIMESTAMP NOT NULL ,
601                    `sqlquery` TEXT NOT NULL ,
602                    PRIMARY KEY ( `id` ) ,
603                    INDEX ( `username` , `db` , `table` , `timevalue` )
604                    ) TYPE=MyISAM COMMENT='SQL history';
605           + put the table name in $cfg['Servers'][$i]['history']
606             
607    $cfg['Servers'][$i]['verbose_check'] string
608           Because release 2.5.0 introduced the new MIME-transformation
609           support, the column_info table got enhanced with three new
610           fields. If the above variable is set to TRUE (default)
611           phpMyAdmin will check if you have the latest table structure
612           available. If not, it will emit a warning to the superuser.
613           You can disable this checking behavior by setting the variable
614           to false, which should offer a performance increase.
615           Recommended to set to FALSE, when you are sure, your table
616           structure is up to date.
617           
618    $cfg['Servers'][$i]['AllowDeny']['order'] string
619           If your rule order is empty, then IP authentication is
620           disabled.
621           If your rule order is set to 'deny,allow' then the system
622           applies all deny rules followed by allow rules. Access is
623           allowed by default. Any client which does not match a Deny
624           command or does match an Allow command will be allowed access
625           to the server.
626           If your rule order is set to 'allow,deny' then the system
627           applies all allow rules followed by deny rules. Access is
628           denied by default. Any client which does not match an Allow
629           directive or does match a Deny directive will be denied access
630           to the server.
631           If your rule order is set to 'explicit', the authentication is
632           performed in a similar fashion to rule order 'deny,allow', with
633           the added restriction that your host/username combination must
634           be listed in the allow rules, and not listed in the deny rules.
635           This is the most secure means of using Allow/Deny rules, and
636           was available in Apache by specifying allow and deny rules
637           without setting any order.
638           
639    $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
640           The general format for the rules is as such:
641                 <'allow' | 'deny'> <username> [from] <ipmask>
642           If you wish to match all users, it is possible to use a '%' as
643           a wildcard in the username field.
644           There are a few shortcuts you can use in the ipmask field as
645           well:
646                'all' -> 0.0.0.0/0
647                'localhost' -> 127.0.0.1/8
648           Having an empty rule list is equivalent to either using 'allow
649           % from all' if your rule order is set to 'deny,allow' or 'deny
650           % from all' if your rule order is set to 'allow,deny' or
651           'explicit'.
652           For the IP matching system, the following work:
653           xxx.xxx.xxx.xxx (an exact IP address)
654           xxx.xxx.xxx.[yyy-zzz] (an IP address range)
655           xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type
656           IP addresses)
657           But the following does not work:
658           xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
659           
660    $cfg['ServerDefault'] integer
661           If you have more than one server configured, you can set
662           $cfg['ServerDefault'] to any one of them to autoconnect to that
663           server when phpMyAdmin is started, or set it to 0 to be given a
664           list of servers without logging in.
665           If you have only one server configured, $cfg['ServerDefault']
666           MUST be set to that server.
667           
668    $cfg['OBGzip'] boolean
669           Defines whether to use GZip output buffering for increased
670           speed in HTTP transfers.
671           
672    $cfg['PersistentConnections'] boolean
673           Whether persistent connections should be used or not
674           (mysql_connect or mysql_pconnect).
675           
676    $cfg['ExecTimeLimit'] integer [number of seconds]
677           Set the number of seconds a script is allowed to run. If
678           seconds is set to zero, no time limit is imposed.
679           This setting is used while importing/exporting dump files but
680           has no effect when PHP is running in safe mode.
681           
682    $cfg['SkipLockedTables'] boolean
683           Mark used tables and make it possible to show databases with
684           locked tables (since 3.23.30).
685           
686    $cfg['ShowSQL'] boolean
687           Defines whether SQL-queries generated by phpMyAdmin should be
688           displayed or not.
689           
690    $cfg['AllowUserDropDatabase'] boolean
691           Defines whether normal users (non-administrator) are allowed to
692           delete their own database or not. If set as FALSE, the link
693           "Drop Database" will not be shown, and even a "DROP DATABASE
694           mydatabase" will be rejected. Quite practical for ISP's with
695           many customers.
696           
697    $cfg['Confirm'] boolean
698           Whether a warning ("Are your really sure..") should be
699           displayed when you're about to loose data.
700           
701    $cfg['LoginCookieRecall'] boolean
702           Define whether the previous login should be recalled or not in
703           cookie authentication mode.
704           
705    $cfg['UseDbSearch'] boolean
706           Define whether the "search string inside database" is enabled
707           or not.
708           
709    $cfg['LeftFrameLight'] boolean
710           Defines whether to use select-based menu and display only the
711           current tables in the left frame (smaller page). Only in
712           Non-Lightmode you can use the feature to display nested folders
713           using $cfg['LeftFrameTableSeparator']
714           
715    $cfg['LeftFrameTableSeparator'] string
716           Defines a string to be used to nest table spaces. Defaults to
717           '__'. This means if you have tables like 'first__second__third'
718           this will be shown as a three-level hierarchie like: first >
719           second > third. If set to FALSE or empty, the feature is
720           disabled. NOTE: You shall not use this Separator in a table
721           name at the beginning or end of a table name, or multiple times
722           after another without any other characters in between.
723           
724    $cfg['LeftFrameTableLevel'] string
725           Defines how many sublevels should be displayed when splitting
726           up tables by the above Separator.
727           
728    $cfg['ShowTooltip'] boolean
729           Defines whether to display table comment as tool-tip in left
730           frame or not.
731           
732    $cfg['ShowTooltipAliasDB'] boolean
733           If tool-tips are enabled and a DB comment is set, this will
734           flip the comment and the real name. That means, if you have a
735           table called 'user0001' and add the comment 'MyName' on it, you
736           will see the name 'MyName' used consequently in the left frame
737           and the tool-tip shows the real name of the DB.
738           
739    $cfg['ShowTooltipAliasTB'] boolean
740           Same as $cfg['ShowTooltipAliasDB'], except this works for table
741           names.
742           
743    $cfg['ShowStats'] boolean
744           Defines whether to display space usage and statistics about
745           databases and tables or not.
746           Note that statistics requires at least MySQL 3.23.3 and that,
747           at this date, MySQL doesn't return such information for
748           Berkeley DB tables.
749           
750    $cfg['ShowMysqlInfo'] boolean
751           $cfg['ShowMysqlVars'] boolean
752           $cfg['ShowPhpInfo'] boolean
753           $cfg['ShowChgPassword'] boolean
754           Defines whether to display the "MySQL runtime information",
755           "MySQL system variables", "PHP information" and "Change
756           password " links or not for simple users at the starting main
757           (right) frame. This setting does not check MySQL commands
758           entered directly.
759           Please note that to block the usage of phpinfo() in scripts,
760           you have to put this in your php.ini:
761               disable_functions = phpinfo()
762           Also note that enabling the "Change password " link has no
763           effect with "config" authentication mode: because of the hard
764           coded password value in the configuration file, end users can't
765           be allowed to change their passwords.
766           
767    $cfg['SuggestDBName'] boolean
768           Defines whether to suggest a database name on the "Create
769           Database" form or to keep the textfield empty.
770           
771    $cfg['ShowBlob'] boolean
772           Defines whether BLOB fields are shown when browsing a table's
773           content or not.
774           
775    $cfg['NavigationBarIconic'] boolean
776           Defines whether navigation bar buttons contain text or symbols
777           only.
778           
779    $cfg['ShowAll'] boolean
780           Defines whether an user should be displayed a "show all
781           (records)" button in browse mode or not.
782           
783    $cfg['MaxRows'] integer
784           Number of rows displayed when browsing a result set. If the
785           result set contains more rows, Previous/Next links will be
786           shown.
787           
788    $cfg['Order'] string [DESC|ASC|SMART]
789           Defines whether fields are displayed in ascending (ASC) order,
790           in descending (DESC) order or in a "smart" (SMART) order - I.E.
791           descending order for fields of type TIME, DATE, DATETIME &
792           TIMESTAMP, ascending order else- by default.
793           
794    $cfg['ProtectBinary'] boolean or string
795           Defines whether BLOB or BINARY fields are protected from
796           edition when browsing a table's content or not. Valid values
797           are:
798           - FALSE to allow edition of all fields;
799           - blob to allow edition of all fields except BLOBS;
800           - all to disallow edition of all BINARY or BLOB fields.
801           
802    $cfg['ShowFunctionFields'] boolean
803           Defines whether MySQL functions fields should be displayed or
804           not in edit/insert mode.
805           
806    $cfg['CharEditing'] string
807           Defines which type of editing controls should be used for CHAR
808           and VARCHAR fields. Possible values are:
809           
810           + input - this allows to limit size of text to size of field in
811             MySQL, but has problems with newlines in fields
812           + textarea - no problems with newlines in fields, but also no
813             length limitations
814             
815           Default is old behavior so input.
816           
817    $cfg['ZipDump'] boolean
818           $cfg['GZipDump'] boolean
819           $cfg['BZipDump'] boolean
820           Defines whether to allow the use of zip/GZip/BZip2 compression
821           when creating a dump file or not.
822           
823    $cfg['LightTabs'] string
824           If set to True, do use less graphically intense tabs on the top
825           of the mainframe.
826           
827    $cfg['DefaultTabServer'] string
828           Defines the tab displayed by default on server view. Possible
829           values: "main.php3" (recommended for multi-user setups),
830           "server_databases.php3", "server_status.php3",
831           "server_variables.php3", "server_privileges.php3" or
832           "server_processlist.php3".
833           
834    $cfg['DefaultTabDatabase'] string
835           Defines the tab displayed by default on database view. Possible
836           values: "db_details_structure.php3", "db_details.php3" or
837           "db_search.php3".
838           
839    $cfg['DefaultTabTable'] string
840           Defines the tab displayed by default on table view. Possible
841           values: "tbl_properties_structure.php3", "tbl_properties.php3",
842           "tbl_select.php3" or "tbl_change.php3".
843           
844    $cfg['MySQLManualBase'] string
845           If set to an URL which points to the MySQL documentation (type
846           depends on $cfg['MySQLManualType']), appropriate help links are
847           generated.
848           See MySQL Documentation page for more information about MySQL
849           manuals and their types.
850           
851    $cfg['MySQLManualType'] string
852           Type of MySQL documentation:
853           
854           + old - old style used in phpMyAdmin 2.3.0 and sooner
855           + searchable - "Searchable, with user comments"
856           + chapters - "HTML, one page per chapter"
857           + big - "HTML, all on one page"
858           + none - do not show documentation links
859             
860    $cfg['DefaultLang'] string
861           Defines the default language to use, if not browser-defined or
862           user-defined.
863           See the select_lang.inc.php3 script to know the valid values
864           for this setting.
865           
866    $cfg['Lang'] string
867           Force: always use this language (must be defined in the
868           select_lang.inc.php3 script).
869           
870    $cfg['DefaultCharset'] string
871           Default character set to use for recoding of MySQL queries.
872           This must be enabled and it's described by
873           $cfg['AllowAnywhereRecoding'] option.
874           You can give here any character set which is in
875           $cfg['AvailableCharsets'] array and this is just default
876           choice, user can select any of them.
877           
878    $cfg['AllowAnywhereRecoding'] boolean
879           Allow character set recoding of MySQL queries. You need recode
880           or iconv support (compiled in or module) in PHP to allow MySQL
881           queries recoding and used language file must have it enabled
882           (by default only these which are in Unicode, just to avoid
883           losing some characters).
884           
885    $cfg['RecodingEngine'] string
886           You can select here which functions will be used for character
887           set conversion. Possible values are:
888           
889           + auto - automatically use available one (first is tested
890             iconv, then recode)
891           + iconv - use iconv or libiconv functions
892           + recode - use recode_string function
893             
894           Default is auto.
895           
896    $cfg['IconvExtraParams'] string
897           Specify some parameters for iconv used in charset conversion.
898           See iconv documentation for details.
899           
900    $cfg['AvailableCharsets'] array
901           Available character sets for MySQL conversion. You can add your
902           own (any of supported by recode/iconv) or remove these which
903           you don't use. Character sets will be shown in same order as
904           here listed, so if you frequently use some of these move them
905           to the top.
906           
907    $cfg['GD2Available'] string
908           Specifies whether GD >= 2 is available. If yes it can be used
909           for MIME transformations.
910           Possible values are:
911           
912           + auto - automatically detect, this is a bit expensive
913             operation for php < 4.3.0 so it is preffered to change this
914             according to your server real possibilities
915           + yes - GD 2 functions can be used
916           + no - GD 2 function can not be used
917             
918           Default is auto.
919           
920    $cfg['LeftWidth'] integer
921           Left frame width in pixel.
922           
923    $cfg['LeftBgColor'] string [HTML color]
924           $cfg['RightBgColor'] string [HTML color]
925           The background colors (HTML) used for both the frames.
926           
927    $cfg['RightBgImage'] string
928           The URI of the background image used for the right frame. It
929           can be absolute as well as relative from your phpMyAdmin
930           directory.
931           
932    $cfg['LeftPointerColor'] string [HTML color]
933           The color (HTML) used for the pointer in the left frame (does
934           not work with Netscape 4).
935           
936    $cfg['Border'] integer
937           The size of a table's border.
938           
939    $cfg['ThBgcolor'] string [HTML color]
940           The color (HTML) used for table headers.
941           
942    $cfg['BgcolorOne'] string [HTML color]
943           The color (HTML) #1 for table rows.
944           
945    $cfg['BgcolorTwo'] string [HTML color]
946           The color (HTML) #2 for table rows.
947           
948    $cfg['BrowsePointerColor'] string [HTML color]
949           $cfg['BrowseMarkerColor'] string [HTML color]
950           The colors (HTML) uses for the pointer and the marker in browse
951           mode (does not work with Netscape 4).
952           The former feature highlights the row over which your mouse is
953           passing and the latter lets you visually mark/unmark rows by
954           clicking on them.
955           You can disable both of these features by emptying the
956           respective directive.
957           
958    $cfg['TextareaCols'] integer
959           $cfg['TextareaRows'] integer
960           $cfg['CharTextareaCols'] integer
961           $cfg['CharTextareaRows'] integer
962           Number of columns and rows for the textareas.
963           This value will be emphasized (*2) for SQL query textareas and
964           (*1.25) for SQL textareas inside the query window.
965           The Char* values are used for CHAR and VARCHAR editing (if
966           configured via $cfg['CharEditing']).
967           
968    $cfg['LongtextDoubleTextarea'] boolean
969           Defines whether textarea for LONGTEXT fields should have double
970           size.
971           
972    $cfg['TextareaAutoSelect'] boolean
973           Defines if the whole textarea of the query box will be selected
974           on click.
975           
976    $cfg['CtrlArrowsMoving'] boolean
977           Enable Ctrl+Arrows moving between fields when editing?
978           
979    $cfg['LimitChars'] integer
980           Maximal number of Chars showed in a TEXT OR a BLOB field on
981           browse view. Can be turned off by a toggle button on the browse
982           page.
983           
984    $cfg['ModifyDeleteAtLeft'] boolean
985           $cfg['ModifyDeleteAtRight'] boolean
986           Defines the place where modify and delete links would be put
987           when tables contents are displayed (you may have them displayed
988           both at the left and at the right). "Left" and "right" are
989           parsed as "top" and "bottom" with vertical display mode.
990           
991    $cfg['DefaultDisplay'] string
992           $cfg['HeaderFlipType'] string
993           There are 3 display modes: horizontal, horizontalflipped and
994           vertical. Define which one is displayed by default. The first
995           mode displays each row on a horizontal line, the second rotates
996           the headers by 90 degrees, so you can use descriptive headers
997           even though fields only contain small values and still print
998           them out. The vertical mode sorts each row on a vertical
999           lineup.
1000           The HeaderFlipType can be set to 'css' or 'faked'. When using
1001           'css' the rotation of the header for horizontalflipped is done
1002           via CSS. If set to 'faked' PGP does the transformation for you,
1003           but of course this does not look as good as CSS.
1004           
1005    $cfg['DefaultPropDisplay'] string
1006           When editing/creating new columns in a table all fields
1007           normally get lined up one field a line. (default:
1008           'horizontal'). If you set this to 'vertical' you can have each
1009           field lined up vertically beneath each other. You can save up a
1010           lot of place on the horizontal direction and no longer have to
1011           scroll.
1012           
1013    $cfg['ShowBrowseComments'] boolean
1014           $cfg['ShowPropertyComments'] boolean
1015           By setting the corresponding variable to TRUE you can enable
1016           the display of column comments in Browse or Property display.
1017           In browse mode, the comments are show inside the header. In
1018           property mode, comments are displayed using a CSS-formatted
1019           dashed-line below the name of the field. The comment is shown
1020           as a tool-tip for that field.
1021           
1022    $cfg['UploadDir'] string
1023           The name of the directory, ending with a slash, where SQL files
1024           have been uploaded by other means than phpMyAdmin (for example,
1025           ftp). Those files are available under a drop-down box when you
1026           click the database name, then the SQL tab.
1027           Please note that the file names must have the suffix ".sql".
1028           This feature is useful when your file is too big to be uploaded
1029           via HTTP, or when file uploads are disabled in PHP.
1030           Please note that if PHP is running in safe mode, this directory
1031           must be owned by the same user as the owner of the phpMyAdmin
1032           scripts.
1033           
1034    $cfg['SaveDir'] string
1035           The name of the directory, ending with a slash, where dumps can
1036           be saved.
1037           Please note that the directory has to be writable for user
1038           running webserver.
1039           Please note that if PHP is running in safe mode, this directory
1040           must be owned by the same user as the owner of the phpMyAdmin
1041           scripts.
1042           
1043    $cfg['RepeatCells'] integer
1044           Repeat the headers every X cells, or 0 to deactivate.
1045           
1046    $cfg['QueryFrame'] boolean
1047           $cfg['QueryFrameJS'] boolean
1048           $cfg['QueryFrameDebug'] boolean
1049           $cfg['QueryWindowWidth'] integer
1050           $cfg['QueryWindowHeight'] integer
1051           $cfg['QueryHistoryDB'] boolean
1052           $cfg['QueryWindowDefTab'] string
1053           $cfg['QueryHistoryMax'] integer
1054           All those variables affect the new query frame/window. When
1055           $cfg['QueryFrame'] is set to true a new frame is embedded on
1056           the left with a small area. Clicking on that results in opening
1057           a direct interface to enter SQL queries.
1058           When $cfg['QueryFrameJS'] is set to true, clicking on that link
1059           opens a new custom sized browser window
1060           ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] - both
1061           integers for the size in pixels). If set to false, clicking on
1062           the link only opens the SQL input in the mainframe.
1063           The usage of the JavaScript query window is recommended if you
1064           have a JavaScript enabled browser. Basic functions are used to
1065           exchange quite a few variables, so most 4th generation browsers
1066           should be capable to use that feature. It currently is only
1067           tested with Internet Explorer 6 and Mozilla 1.x.
1068           If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are
1069           logged to a table, which has to be created by you (see
1070           $cfg['Servers'][$i]['history']). If set to FALSE, all your
1071           queries will be appended to the form, but only as long as your
1072           window is opened they remain saved.
1073           When using the JavaScript based query window, it will always
1074           get updated when you click on a new table/db to browse and will
1075           focus if you click on "Edit SQL" after using a query.
1076           If $cfg['QueryHistoryDB'] is set to TRUE you can specify the
1077           amount of saved history items using $cfg['QueryHistoryMax'].
1078           The query window also has a custom tabbed look to group the
1079           features. Using the variable $cfg['QueryWindowDefTab'] you can
1080           specify the default tab to be used when opening the query
1081           window. It can be set to either 'sql', 'files', 'history' or
1082           'full'.
1083           The variable $cfg['QueryFrameDebug'] can be used by developers
1084           for easier future feature integration.
1085           
1086    $cfg['BrowseMIME'] boolean
1087           Enable MIME-transformations.
1088           
1089    $cfg['MaxExactCount'] integer
1090           Determines for how large tables phpMyAdmin should get exact row
1091           count by SELECT COUNT. If approximate row count is smaller than
1092           this value, SELECT COUNT will be used, otherwise only value
1093           returned by SHOW TABLE STATUS.
1094           
1095    $cfg['SQP']['fmtType'] string [html|none]
1096           The main use of the new SQL Parser is to pretty-print SQL
1097           queries. By default we use HTML to format the query, but you
1098           can disable this by setting this variable to 'none'
1099           
1100    $cfg['SQP']['fmtInd'] float
1101           $cfg['SQP']['fmtIndUnit'] string [em|px|pt|ex]
1102           For the pretty-printing of SQL queries, under some cases the
1103           part of a query inside a bracket is indented. By changing
1104           $cfg['SQP']['fmtInd'] you can change the amount of this indent.
1105           Related in purpose is $cfg['SQP']['fmtIndUnit'] which specifies
1106           the units of the indent amount that you specified. This is used
1107           via stylesheets.
1108           
1109    $cfg['SQP']['fmtColor'] array of string tuples
1110           This array is used to define the colours for each type of
1111           element of the pretty-printed SQL queries. The tuple format is
1112           class => [HTML colour code | empty string]
1113           If you specify an empty string for the color of a class, it is
1114           ignored in creating the stylesheet. You should not alter the
1115           class names, only the colour strings.
1116           Class name key:
1117           
1118           + comment Applies to all comment sub-classes
1119           + comment_mysql Comments as "#...\n"
1120           + comment_ansi Comments as "-- ...\n"
1121           + comment_c Comments as "/*...*/"
1122           + digit Applies to all digit sub-classes
1123           + digit_hex Hexadecimal numbers
1124           + digit_integer Integer numbers
1125           + digit_float Floating point numbers
1126           + punct Applies to all punctuation sub-classes
1127           + punct_bracket_open_round Opening brackets"("
1128           + punct_bracket_close_round Closing brackets ")"
1129           + punct_listsep List item Separator ","
1130           + punct_qualifier Table/Column Qualifier "."
1131           + punct_queryend End of query marker ";"
1132           + alpha Applies to all alphabetic classes
1133           + alpha_columnType Identifiers matching a column type
1134           + alpha_columnAttrib Identifiers matching a
1135             database/table/column attribute
1136           + alpha_functionName Identifiers matching a MySQL function name
1137           + alpha_reservedWord Identifiers matching any other reserved
1138             word
1139           + alpha_variable Identifiers matching a SQL variable "@foo"
1140           + alpha_identifier All other identifiers
1141           + quote Applies to all quotation mark classes
1142           + quote_double Double quotes "
1143           + quote_single Single quotes '
1144           + quote_backtick Backtick quotes `
1145             
1146    $cfg['SQLValidator']['use'] boolean
1147           phpMyAdmin now supports use of the Mimer SQL Validator service,
1148           as originally published on Slashdot.
1149           For help in setting up your system to use the service, see the
1150           FAQ #6.14.
1151           
1152    $cfg['SQLValidator']['username'] string
1153           $cfg['SQLValidator']['password'] string
1154           The SOAP service allows you to login with anonymous and any
1155           password, so we use those by default.. Instead, if you have an
1156           account with them, you can put your login details here, and it
1157           will be used in place of the anonymous login.
1158           
1159    $cfg['DBG']['enable'] boolean
1160           DEVELOPERS ONLY!
1161           Enable the DBG extension for debugging phpMyAdmin. Required for
1162           profiling the code.
1163           For help in setting up your system to this, see the Developers
1164           section.
1165           
1166    $cfg['DBG']['profile']['enable'] boolean
1167           DEVELOPERS ONLY!
1168           Enable profiling support for phpMyAdmin. This will append a
1169           chunk of data to the end of every page displayed in the main
1170           window with profiling statistics for that page.
1171           You may need need to increase the maximum execution time for
1172           this to complete successfully.
1173           
1174    $cfg['DBG']['profile']['threshold'] float (units in milliseconds)
1175           DEVELOPERS ONLY!
1176           When profiling data is displayed, this variable controls the
1177           threshold of display for any profiling data, based on the
1178           average time each time has taken. If it is over the threshold
1179           it is displayed, otherwise it is not displayed. This takes a
1180           value in milliseconds. In most cases you don't need to edit
1181           this.
1182           
1183    $cfg['ColumnTypes'] array
1184           All possible types of a MySQL column. In most cases you don't
1185           need to edit this.
1186           
1187    $cfg['AttributeTypes'] array
1188           Possible attributes for fields. In most cases you don't need to
1189           edit this.
1190           
1191    $cfg['Functions'] array
1192           A list of functions MySQL supports. In most cases you don't
1193           need to edit this.
1194           
1195 Transformations
1197    Introduction  -  Usage  -  File structure  -
1198    
1199   [1. Introduction]
1200   
1201    To enable transformations, you have to setup the column_info table and
1202    the proper directives. Please see the Configuration section on how to
1203    do so.
1204    
1205    You can apply different transformations to the contents of each field.
1206    The transformation will take the content of each field and transform
1207    it with certain rules defined in the selected transformation.
1208    
1209    Say you have a field 'filename' which contains a filename. Normally
1210    you would see in phpMyAdmin only this filename. Using transformations
1211    you can transform that filename into a HTML link, so you can click
1212    inside of the phpMyAdmin structure on the field's link and will see
1213    the file displayed in a new browser window. Using transformation
1214    options you can also specify strings to append/prepend to a string or
1215    the format you want the output stored in.
1216    
1217    For a general overview of all available transformations and their
1218    options, you can consult your
1219    <www.your-host.com>/<your-install-dir>/libraries/transformations/overv
1220    iew.php3 installation.
1221    
1222   [2. Usage]
1223   
1224    Go to your tbl_properties.inc.php3 page (i.e. reached through clicking
1225    on the 'properties' link for a table). There you will see three new
1226    fields at the end of the line. They are called 'MIME-type', 'Browser
1227    transformation' and 'Transformation options'.
1228      * The field 'MIME-type' is a dropdown field. You have the options to
1229        leave that field empty or to use 'auto' [this feature is not yet
1230        available]. Please note that transformations are inactive as long
1231        as no mime-type is selected.
1232      * The field 'Browser transformation' is a drop-down field. You can
1233        choose from a hopefully growing amount of pre-defined
1234        transformations. See below for information on how to build your
1235        own transformation.
1236        There are global transformations and mimetype-bound
1237        transformations. Global transformations can be used for any
1238        mimetype. They will take the mimetype, if necessary, into regard.
1239        Mimetype-bound transformations usually only operate on a certain
1240        mimetype. There are transformations which operate on the main
1241        mimetype (like 'image'), which will most likely take the subtype
1242        into regard, and those who only operate on a specific subtype
1243        (like 'image/jpeg').
1244        You can use transformations on mimetypes for which the function
1245        was not defined for. There is no security check for you selected
1246        the right transformation, so take care of what the output will be
1247        like.
1248      * The field 'Transformation options' is a free-type textfield. You
1249        have to enter transform-function specific options here. Usually
1250        the transforms can operate with default options, but it is
1251        generally a good idea to look up the overview to see which options
1252        are necessary.
1253        Much like the ENUM/SET-Fields, you have to split up several
1254        options using the format 'a','b','c',...(NOTE THE MISSING BLANKS).
1255        This is because internally the options will be parsed as an array,
1256        leaving the first value the first element in the array, and so
1257        forth.
1258        If you want to specify a MIME character set you can define it in
1259        the transformation_options. You have to put that outside of the
1260        pre-defined options of the specific mime-transform, as the last
1261        value of the set. Use the format "'; charset=XXX'". If you use a
1262        transform, for which you can specify 2 options and you want to
1263        append a character set, enter "'first parameter','second
1264        parameter','charset=us-ascii'". You can, however use the defaults
1265        for the parameters: "'','','charset=us-ascii'".
1266        
1267   [3. File structure]
1268   
1269    All mimetypes and their transformations are defined through single
1270    files in the directory 'libraries/transformations/'.
1271    
1272    They are stored in files to ease up customization and easy adding of
1273    new transformations.
1274    
1275    Because the user cannot enter own mimetypes, it is kept sure that
1276    transformations always work. It makes no sense to apply a
1277    transformation to a mimetype, the transform-function doesn't know to
1278    handle.
1279    
1280    One can, however, use empty mime-types and global transformations
1281    which should work for many mimetypes. You can also use transforms on a
1282    different mimetype they where built for, but pay attention to option
1283    usage as well as what the transformation does to your field.
1284    
1285    There is a basic file called 'global.inc.php3'. This function can be
1286    included by any other transform function and provides some basic
1287    functions.
1288    
1289    There are 5 possible file names:
1290     1. A mimetype+subtype transform:
1291        [mimetype]_[subtype]__[transform].inc.php3
1292        Please not that mimetype and subtype are separated via '_', which
1293        shall not be contained in their names. The transform
1294        function/filename may contain only characters which cause no
1295        problems in the file system as well as the PHP function naming
1296        convention.
1297        The transform function will the be called
1298        'PMA_transform_[mimetype]_[subtype]__[transform]()'.
1299        Example:
1300        text_html__formatted.inc.php3
1301        PMA_transform_text_html__formatted()
1302     2. A mimetype (w/o subtype) transform:
1303        [mimetype]__[transform].inc.php3
1304        Please note that there are no single '_' characters. The transform
1305        function/filename may contain only characters which cause no
1306        problems in the file system as well as the PHP function naming
1307        convention.
1308        The transform function will the be called
1309        'PMA_transform_[mimetype]__[transform]()'.
1310        Example:
1311        text__formatted.inc.php3
1312        PMA_transform_text__formatted()
1313     3. A mimetype+subtype without specific transform function
1314        [mimetype]_[subtype].inc.php3
1315        Please note that there are no '__' characters in the filename. Do
1316        not use special characters in the filename causing problems with
1317        the file system.
1318        No transformation function is defined in the file itself.
1319        Example:
1320        text_plain.inc.php3
1321        (No function)
1322     4. A mimetype (w/o subtype) without specific transform function
1323        [mimetype].inc.php3
1324        Please note that there are no '_' characters in the filename. Do
1325        not use special characters in the filename causing problems with
1326        the file system.
1327        No transformation function is defined in the file itself.
1328        Example:
1329        text.inc.php3
1330        (No function)
1331     5. A global transform function with no specific mimetype
1332        global__[transform].inc.php3
1333        The transform function will the be called
1334        'PMA_transform_global__[transform]()'.
1335        Example:
1336        global__formatted
1337        PMA_transform_global__formatted()
1338        
1339    So generally use '_' to split up mimetype and subtype, and '__' to
1340    provide a transform function.
1341    
1342    All filenames containing no '__' in themselves are not shown as valid
1343    transform functions in the dropdown.
1344    
1345    Please see the libraries/transformations/TEMPLATE file for adding your
1346    own transform function. See the
1347    libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1348    without a transform function. Also note the introduction of a function
1349    description in the language files. For each function a
1350    $strTransformation_[filename without .inc.php3] has to exist.
1351    
1352    You can use the template generator to generate new functions and
1353    entries in the language file.
1354    
1355    To create a new transform function please see
1356    libraries/transformations/template_generator.sh. To create a new,
1357    empty mimetype please see
1358    libraries/transformations/template_generator_mimetype.sh.
1359    
1360 FAQ - Frequently Asked Questions
1362    Server  -  Configuration  -  Limitations  -  Multi-user  -  Browsers
1363    -  Usage tips  -  Project  -
1364    
1365   [1. Server]
1366   
1367     [1.1] I'm running PHP 4+ and my server is crashing each time a specific
1368     action is required or phpMyAdmin sends a blank page or a page full of
1369     cryptic characters to my browser, what can I do?
1370     
1371    There are some known PHP bugs with output buffering and compression.
1372    Try to set the $cfg['OBGzip'] directive to FALSE in your
1373    config.inc.php or .php3 file and the zlib.output_compression directive
1374    to Off in your php configuration file.
1375    Furthermore, we know about such problems connected to the release
1376    candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together
1377    with MS Internet Explorer. Please upgrade to the release version PHP
1378    4.2.0.
1379    
1380     [1.2] My Apache server crashes when using phpMyAdmin.
1381     
1382    You should first try the latest versions of Apache (and possibly
1383    MySQL).
1384    See also the other FAQ entry about PHP bugs with output buffering.
1385    If your server keeps crashing, please ask for help in the various
1386    Apache support groups.
1387    
1388     [1.3] I'm running phpMyAdmin with "cookie" authentication mode under PHP
1389     4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the script:
1390     I'm always displayed the login screen.
1391     
1392    This is a known PHP bug (see this bug report) from the official PHP
1393    bug database. It means there is and won't be any phpMyAdmin fix
1394    against it because there is no way to code a fix.
1395    
1396     [1.4] Using phpMyAdmin on IIS, I'm displayed the error message: "The
1397     specified CGI application misbehaved by not returning a complete set of
1398     HTTP headers...".
1399     
1400    You just forgot to read the install.txt file from the php
1401    distribution. Have a look at the last message in this bug report from
1402    the official PHP bug database.
1403    
1404     [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
1405     messages with the HTTP or advanced authentication mode.
1406     
1407    This is a known problem with the PHP ISAPI filter: it's not so stable.
1408    For some more information and complete testings see the messages
1409    posted by André B. aka "djdeluxe76" in this thread from the phpWizard
1410    forum.
1411    Please use instead the cookie authentication mode.
1412    
1413     [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!
1414     
1415    This seems to be a PWS bug. Filippo Simoncini found a workaround (at
1416    this time there is no better fix): remove or comment the DOCTYPE
1417    declarations (2 lines) from the scripts header.inc.php3,
1418    header_printview.inc.php3, index.php3, left.php3 and
1419    libraries/common.lib.php3.
1420    
1421     [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
1422     work.
1423     
1424    These features are based on the gzencode() and bzcompress() PHP
1425    functions to be more independent of the platform (Unix/Windows, Safe
1426    Mode or not, and so on). So, you must have PHP4 >= 4.0.4 and
1427    Zlib/Bzip2 support (--with-zlib and --with-bz2).
1428    We faced PHP crashes when trying to download a dump with MS Internet
1429    Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0.
1430    In this case you should switch to the release version of PHP 4.2.0.
1431    
1432     [1.8] I cannot insert a text file in a table, and I get an error about safe
1433     mode being in effect.
1434     
1435    Your uploaded file is saved by PHP in the "upload dir", as defined in
1436    php.ini by the variable upload_tmp_dir (usually the system default is
1437    /tmp).
1438    We recommend the following setup for Apache servers running in safe
1439    mode, to enable uploads of files while being reasonably secure:
1440      * create a separate directory for uploads: mkdir /tmp/php
1441      * give ownership to the Apache server's user.group: chown
1442        apache.apache /tmp/php
1443      * give proper permission: chmod 600 /tmp/php
1444      * put upload_tmp_dir = /tmp/php in php.ini
1445      * restart Apache
1446        
1447     [1.9] I'm having troubles when uploading files. In general file uploads
1448     don't work on my system and uploaded files have a Content-Type: header in
1449     the first line.
1450     
1451    It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat
1452    7.0 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't
1453    you?
1454    So the problem is that this package has a serious bug that was
1455    corrected ages ago in PHP (2001-01-28: see PHP's bug tracking system
1456    for more details). The problem is that the bugged package is still
1457    available though it was corrected (see RedHat's BugZilla for more
1458    details).
1459    So please download the fixed package (4.0.4pl1-9) and the problem
1460    should go away.
1461    And that fixes the \r\n problem with file uploads!
1462    
1463     [1.10] I'm having troubles when uploading files with phpMyAdmin running on
1464     a secure server. My browser is Internet Explorer and I'm using the Apache
1465     server.
1466     
1467    As suggested by "Rob M" in the phpWizard forum, add this line to your
1468    httpd.conf:
1469        SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
1470    It seems to clear up many problems between Internet Explorer and SSL.
1471    
1472     [1.11] I get an 'open_basedir restriction' while uploading a file from the
1473     query box.
1474     
1475    Since version 2.2.4, phpMyAdmin supports servers with open_basedir
1476    restrictions. Assuming that the restriction allows you to open files
1477    in the current directory ('.'), all you have to do is create a 'tmp'
1478    directory under the phpMyAdmin install directory, with permissions 777
1479    and the same owner as the owner of your phpMyAdmin directory. The
1480    uploaded files will be moved there, and after execution of your SQL
1481    commands, removed.
1482    
1483     [1.12] I have lost my MySQL root password, what can I do?
1484     
1485    The MySQL manual explains how to reset the permissions.
1486    
1487     [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
1488     
1489    If PHP does not have read/write access to its upload_tmp_dir, it
1490    cannot access the uploaded query.
1491    
1492     [1.14] I get an error 'No SQL query' when trying to submit a query from the
1493     convenient text area.
1494     
1495    Check the post_max_size directive from your PHP configuration file and
1496    try to increase it.
1497    
1498     [1.15] I have problems with mysql.user field names.
1499     
1500    In older MySQL versions, the User and Password fields were named user
1501    and password. Please modify your field names to align with current
1502    standards.
1503    
1504     [1.16] I cannot upload big dump files.
1505     
1506    The first things to check (or ask your host provider to check) are the
1507    values of upload_max_filesize, memory_limit and post_max_size in the
1508    php.ini configuration file.
1509    All of these three settings limit the maximum size of data that can be
1510    submitted and handled by PHP. One user also said that post_max_size
1511    and memory_limit need to be larger than upload_max_filesize.
1512    
1513     [1.17] Does phpMyAdmin support MySQL 4.1?
1514     
1515    Because of a major change in the definition syntax of string field
1516    types, this version of phpMyAdmin probably won't work correctly with
1517    MySQL >= 4.1.0! We will work on the support as soon as MySQL 4.1.0 is
1518    released.
1519    
1520     [1.18] I'm running MySQL <= 4.0.1 having lower_case_table_names set to 1.
1521     If I create a new table with a capital letter in its name it is changed to
1522     lowercase as it should. But if I try to DROP this table MySQL is unable to
1523     find the corresponding file.
1524     
1525    This is a bug of MySQL <= 4.0.1. Please upgrade to at least
1526    MySQL 4.0.2 or turn off your lower_case_table_names directive.
1527    
1528     [1.19] I can't run the "display relations" feature because the script seems
1529     not to know the font face I'm using!
1530     
1531    The "FPDF" library we're using for this feature requires some special
1532    files to use font faces.
1533    Please refers to the FPDF manual to build these files.
1534    
1535     [1.20] I receive the error "cannot load MySQL extension, please check PHP
1536     Configuration".
1537     
1538    To connect to a MySQL server, PHP needs a set of MySQL functions
1539    called "MySQL extension". This extension may be part of the PHP server
1540    (compiled-in), otherwise it needs to be loaded dynamically. Its name
1541    is probably mysql.so or mysql.dll. phpMyAdmin tried to load the
1542    extension but failed.
1543    Usually, the problem is solved by installing a software package called
1544    "PHP-MySQL" or something similar.
1545    
1546     [1.21] I am running the CGI version of PHP under Unix, and I cannot login
1547     using cookie auth.
1548     
1549    In php.ini, set mysql.max_links higher than 1.
1550    
1551     [1.22] I don't see the "Location of text file" field, so I cannot upload.
1552     
1553    This is most likely because in php.ini, your file_uploads parameter is
1554    not set to "on".
1555    
1556     [1.23] I'm running MySQL on a Win32 machine. Each time I create a new table
1557     the table and field names are changed to lowercase!
1558     
1559    This happens because the MySQL directive lower_case_table_names
1560    defaults to 1 (ON) in the Win32 version of MySQL. You can change this
1561    behavior by simply changing the directive to 0 (OFF):
1562    Just edit your my.ini file that should be located in your Windows
1563    directory and add the following line to the group [mysqld]:
1564    set-variable = lower_case_table_names=0
1565    Next, save the file and restart the MySQL service. You can always
1566    check the value of this directive using the query
1567    SHOW VARIABLES LIKE 'lower_case_table_names';
1568    
1569     [1.24] Some characters are being truncated in my queries, or I get
1570     characters randomly added. I am running PHP 4.2.3.
1571     
1572    This is a PHP 4.2.3 bug.
1573    
1574     [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP, and I get
1575     problems, such as undefined variables when I run a SQL query.
1576     
1577    A tip from Jose Fandos: put a comment on the following two lines in
1578    httpd.conf, like this:
1579    # mod_gzip_item_include file \.php$
1580    # mod_gzip_item_include mime "application/x-httpd-php.*"
1581    as this version of mod_gzip on Apache (Windows) has problems handling
1582    PHP scripts. Of course you have to restart Apache.
1583    
1584     [1.26] I just installed phpMyAdmin in my document root of IIS but I get the
1585     error "No input file specified" when trying to run phpMyAdmin.
1586     
1587    This is a permission problem. Right-click on the phpmyadmin folder and
1588    choose properties. Under the tab Security, click on "Add" and select
1589    the user "IUSER_machine" from the list. Now set his permissions and it
1590    should work.
1591    
1592     [1.27] I get empty page when I want to view huge page (eg.
1593     db_details_structure.php3 with plenty of dabases).
1594     
1595    This is a PHP bug that occur when GZIP output buffering enabled. If
1596    you turn off it (by $cfg['OBGzip'] = FALSE in config.inc.php3), it
1597    should work. This bug will be fixed in PHP 5.0.0.
1598    
1599     [1.28] My MySQL server sometimes refuses queries and returns the message
1600     'Errorcode: 13'. What does this mean?
1601     
1602    This can happen due to a MySQL bug when having database / table names
1603    with upper case characters although lower_case_table_names is set to
1604    1. To fix this, turn off this directive, convert all database and
1605    table names to lower case and turn it on again. Alternatively, there's
1606    a bug-fix available starting with MySQL 3.23.56 / 4.0.11-gamma.
1607    
1608     [1.29] When I create a table or modify a field, I get an error and the
1609     fields are duplicated.
1610     
1611    It is possible to configure Apache in such a way that PHP has problems
1612    interpreting .php files.
1613    The problems occur when two different (and conflicting) set of
1614    directives are used:
1615    SetOutputFilter PHP
1616    SetInputFilter PHP
1617    &
1618    AddType application/x-httpd-php .php
1619    In the case we saw, one set of directives was in httpd.conf, while the
1620    other set was in php.conf.
1621    The recommended way is with AddType, so just comment out the first set
1622    of lines and restart Apache:
1623    #SetOutputFilter PHP
1624    #SetInputFilter PHP
1625    
1626   [2. Configuration]
1627   
1628     [2.1] The error message "Warning: Cannot add header information - headers
1629     already sent by ..." is displayed, what's the problem?
1630     
1631    Edit your config.inc.php or .php3 file and ensure there is nothing
1632    (I.E. no blank lines, no spaces, no characters...) neither before the
1633    <?php tag at the beginning, neither after the ?> tag at the end.
1634    
1635     [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
1636     
1637    Either there is an error with your PHP setup or your username/password
1638    is wrong. Try to make a small script which uses mysql_connect and see
1639    if it works. If it doesn't, it may be you haven't even compiled MySQL
1640    support into PHP.
1641    
1642     [2.3] The error message "Warning: MySQL Connection Failed: Can't connect to
1643     local MySQL server through socket '/tmp/mysql.sock' (111)..." is displayed.
1644     What can I do?
1645     
1646    For RedHat users, Harald Legner suggests this on the mailing list:
1647    On my RedHat-Box the socket of MySQL is /var/lib/mysql/mysql.sock. In
1648    your php.ini you will find a line
1649        mysql.default_socket = /tmp/mysql.sock
1650    change it to
1651        mysql.default_socket = /var/lib/mysql/mysql.sock
1652    Then restart apache and it will work.
1653    Here is a fix suggested by Brad Ummer in the phpwizard forum:
1654      * First, you need to determine what socket is being used by MySQL.
1655        To do this, telnet to your server and go to the MySQL bin
1656        directory. In this directory there should be a file named
1657        mysqladmin. Type ./mysqladmin variables, and this should give you
1658        a bunch of info about your MySQL server, including the socket
1659        (/tmp/mysql.sock, for example).
1660      * Then, you need to tell PHP to use this socket.
1661        Assuming you are using PHP 3.0.10 or better, you can specify the
1662        socket to use when you open the connection. To do this in
1663        phpMyAdmin, you need to complete the socket information in the
1664        config.inc.php3.
1665        For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';
1666        Please also make sure that the permissions of this file allow to
1667        be readable by your webserver (i.e. '0755').
1668        
1669    Have also a look at the corresponding section of the MySQL
1670    documentation.
1671    
1672     [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin, what
1673     can I do?
1674     
1675    Try to set the $cfg['OBGZip'] directive to FALSE in the phpMyAdmin
1676    configuration file. It helps sometime.
1677    Also have a look at your PHP version number: if it contains "4.0b..."
1678    it means you're running a beta version of PHP. That's not a so good
1679    idea, please upgrade to a plain revision.
1680    
1681     [2.5] Each time I want to insert or change a record or drop a database or a
1682     table, an error 404 (page not found) is displayed or, with HTTP or cookie
1683     authentication, I'm asked to login again. What's wrong?
1684     
1685    Check the value you set for the $cfg['PmaAbsoluteUri'] directive in
1686    the phpMyAdmin configuration file.
1687    
1688     [2.6] I get an "Access denied for user: 'root@localhost' (Using password:
1689     YES)"-error when trying to access a MySQL-Server on a host which is
1690     port-forwarded for my localhost
1691     
1692    When you are using a port on your localhost, which you redirect via
1693    port-forwarding to another host, MySQL is not resolving the localhost
1694    as expected.
1695    Erik Wasser explains: The solution is: if your host is "localhost"
1696    MySQL (the commandline tool 'mysql' as well) always tries to use the
1697    socket connection for speeding up things. And that doesn't work in
1698    this configuration with port forwarding.
1699    If you enter "127.0.0.1" as hostname, everything is right and MySQL
1700    uses the TCP connection.
1701    
1702   [3. Known limitations]
1703   
1704     [3.1] When using HTTP authentication, an user who logged out can not
1705     relogin in with the same nick.
1706     
1707    This is related to the authentication mechanism (protocol) used by
1708    phpMyAdmin. We plan to change it as soon as we may find enough free
1709    time to do it, but you can bypass this problem: just close all the
1710    opened browser windows and then go back to phpMyAdmin. You should be
1711    able to log in again.
1712    
1713     [3.2] When dumping a large table in compressed mode, I get a memory limit
1714     error or a time limit error.
1715     
1716    As of version 2.2.4, we build the compressed dump in memory, so large
1717    tables dumps may hang. The only alternative we can think about (using
1718    system calls to mysqldump then gzip or bzip2) would not be applicable
1719    in environments where PHP is in safe mode: access to system programs
1720    is is limited by the system administrator, and time limit is enforced.
1721    
1722     [3.3] With InnoDB tables, I lose foreign key relationships when I rename or
1723     alter a table.
1724     
1725    This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep
1726    in mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
1727    
1728     [3.4] I am unable to import dumps I created with the mysqldump tool bundled
1729     with the MySQL server distribution.
1730     
1731    The problem is that mysqldump creates invalid comments like this:
1732 -- MySQL dump 8.22
1734 -- Host: localhost Database: database
1735 ---------------------------------------------------------
1736 -- Server version 3.23.54
1738    The invalid part of the code is the horizontal line made of dashes
1739    that appears once in every dump created with mysqldump. If you want to
1740    run your dump you have to turn it into valid MySQL. This means, you
1741    have to add a whitespace after the first to dashes of the line or add
1742    a # before it:
1743    -- -------------------------------------------------------
1744    or
1745    #---------------------------------------------------------
1746    
1747     [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there are
1748     some multiple hierarchies displayed in a wrong manner?!
1749     
1750    Please note that you should not use the seperating string multiple
1751    times without any characters between them, or at the beginning/end of
1752    your table name. If you have to, think about using another
1753    TableSeparator or disabling that feature
1754    
1755   [4. ISPs, multi-user installations ]
1756   
1757     [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I need
1758     to install it for each customer.
1759     
1760    Since version 2.0.3, you can setup a central copy of phpMyAdmin for
1761    all your users. The development of this feature was kindly sponsored
1762    by NetCologne GmbH. This requires a properly setup MySQL user
1763    management and phpMyAdmin HTTP or cookie authentication. See the
1764    install section on "Using HTTP authentication".
1765    
1766     [4.2] What's the preferred way of making phpMyAdmin secure against evil
1767     access.
1768     
1769    This depends on your system.
1770    If you're running a server which cannot be accessed by other people,
1771    it's sufficient to use the directory protection bundled with your
1772    webserver (with Apache you can use .htaccess files, for example).
1773    If other people have telnet access to your server, you should use
1774    phpMyAdmin's HTTP authentication feature.
1775    Suggestions:
1776      * Your config.inc.php3 file should be chmod 660.
1777      * All your phpMyAdmin files should be chown phpmy.apache, where
1778        phpmy is a user whose password is only known to you, and apache is
1779        the group under which Apache runs.
1780      * You should use PHP safe mode, to protect from other users that try
1781        to include your config.inc.php3 in their scripts.
1782        
1783     [4.3] I get errors about not being able to include a file in /lang or in
1784     /libraries.
1785     
1786    Check php.ini, or ask your sysadmin to check it. The include_path must
1787    contain "." somewhere in it, and open_basedir, if used, must contain
1788    "." and "./lang" to allow normal operation of phpMyAdmin.
1789    
1790     [4.4] phpMyAdmin always gives "Access denied" when using HTTP
1791     authentication.
1792     
1793    This could happen for several reasons:
1794      * $cfg['Servers'][$i]['controluser'] and/or
1795        $cfg['Servers'][$i]['controlpass'] are wrong.
1796      * The username/password you specify in the login-dialog are invalid.
1797      * You have already setup a security mechanism for the
1798        phpMyAdmin-directory, eg. a .htaccess file. This would interfere
1799        with phpMyAdmin's authentication, so remove it.
1800        
1801     [4.5] Is it possible to let users create their own databases?
1802     
1803    Starting with 2.2.5, in the user management page, you can enter a
1804    wildcard database name for a user (for example "joe%"), and put the
1805    privileges you want. For example, adding SELECT, INSERT, UPDATE,
1806    DELETE, CREATE, DROP, INDEX, ALTER would let a user create/manage
1807    his/her database(s).
1808    
1809     [4.6] How can I use the Host-based authentication additions?
1810     
1811    If you have existing rules from an old .htaccess file, you can take
1812    them and add a username between the 'deny'/'allow' and 'from' strings.
1813    Using the username wildcard of '%' would be a major benefit here if
1814    your installation is suited to using it. Then you can just add those
1815    updated lines into the $cfg['Servers'][$i]['AllowDeny']['rules']
1816    array.
1817    If you want a pre-made sample, you can try this fragment. It stops the
1818    'root' user from logging in from any networks other than the private
1819    network IP blocks.
1820        //block root from logging in except from the private networks
1821        $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
1822        $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
1823            'deny root from all',
1824            'allow root from localhost',
1825            'allow root from 10.0.0.0/8',
1826            'allow root from 192.168.0.0/16',
1827            'allow root from 172.16.0.0/12',
1828            );
1829    
1830     [4.7] Authentication window is displayed more than once, why?
1831     
1832    This happens if you are using a URL to start phpMyAdmin which is
1833    different than the one set in your $cfg['PmaAbsoluteUri']. For
1834    example, a missing "www", or entering with an IP address while a
1835    domain name is defined in the config file.
1836    
1837   [5. Browsers or client OS]
1838   
1839     [5.1] I get an out of memory error, and my controls are non-functional,
1840     when trying to create a table with more than 14 fields.
1841     
1842    We could reproduce this problem only under Win98/98SE. Testing under
1843    WinNT4 or Win2K, we could easily create more than 60 fields.
1844    A workaround is to create a smaller number of fields, then come back
1845    to your table properties and add the other fields.
1846    
1847     [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
1848     
1849    This is not a phpMyAdmin problem but a Xitami known bug: you'll face
1850    it with each script/website that use forms.
1851    Upgrade or downgrade your Xitami server.
1852    
1853     [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
1854     
1855    With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except
1856    that the proposed file name for the dump is always 'tbl_dump.php'.
1857    Bzip2 dumps don't seem to work.
1858    With Konqueror 2.2.1: plain dumps work; zip dumps are placed into the
1859    user's temporary directory, so they must be moved before closing
1860    Konqueror, or else they disappear. GZip dumps give an error message.
1861    Testing needs to be done for Konqueror 2.2.2.
1862    
1863     [5.4] I can't use the cookie authentication mode because Internet Explorer
1864     never stores the cookies.
1865     
1866    MS Internet Explorer seems to be really buggy about cookies, at least
1867    till version 6. And thanks to Andrew Zivolup we've traced also a PHP
1868    4.1.1 bug in this area!
1869    Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it
1870    may work!
1871    
1872     [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
1873     rows.
1874     
1875    Upgrade to at least Internet Explorer 5.5 SP2.
1876    
1877     [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not
1878     found") when trying to modify a row in a table with many fields, or with a
1879     text field
1880     
1881    Your table neither have a primary key nor an unique one, so we must
1882    use a long URL to identify this row. There is a limit on the length of
1883    the URL in those browsers, and this not happen in Netscape, for
1884    example. The workaround is to create a primary or unique key, or use
1885    another browser.
1886    
1887     [5.7] I refresh (reload) my browser, and come back to the welcome page.
1888     
1889    Some browsers support right-clicking into the frame you want to
1890    refresh, just do this in the right frame.
1891    
1892     [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
1893     query box.
1894     
1895    Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
1896    Mozilla versions.
1897    
1898     [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
1899     whitespace in the SQL-Query edit area: the page scrolls down.
1900     
1901    This is a Mozilla bug (see bug #26882 at BugZilla).
1902    
1903     [5.10] With Netscape 4.75 I get empty rows between each row of data in a
1904     CSV exported file.
1905     
1906    This is a known Netscape 4.75 bug: it adds some line feeds when
1907    exporting data in octet-stream mode. Since we can't detect the
1908    specific Netscape version, we cannot workaround this bug.
1909    
1910     [5.11] Extended-ASCII characters like German umlauts are displayed wrong.
1911     
1912    Please ensure that you have set your browser's character set to the
1913    one of the language file you have selected on phpMyAdmin's start page.
1914    Alternatively, you can try the auto detection mode that is supported
1915    by the recent versions of the most browsers.
1916    
1917     [5.12] Apple OS X: Safari browser changes special characters to "?".
1918     
1919    This issue has been reported by a OS X user, who adds that Chimera,
1920    Netscape and Mozilla do not have this problem.
1921    
1922     [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type, I
1923     cannot manage two servers: I login to the first one, then the other one,
1924     but if I switch back to the first, I have to login on each operation.
1925     
1926    This is a bug in Internet Explorer, other browsers do not behave this
1927    way.
1928    
1929     [5.14] Using Opera6, I can manage to get to the authentification, but
1930     nothing happens after that, only a blank screen.
1931     
1932    Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in
1933    Opera6, because it is not able to interpret frameset definitiions
1934    written by JavaScript. Please upgrade to Opera7 at least.
1935    
1936   [6. Using phpMyAdmin]
1937   
1938     [6.1] I can't insert new rows into a table / I can't create a table - MySQL
1939     brings up a SQL-error.
1940     
1941    Examine the SQL error with care. Often the problem is caused by
1942    specifying a wrong field-type.
1943    Common errors include:
1944      * Using VARCHAR without a size argument
1945      * Using TEXT or BLOB with a size argument
1946        
1947    Also, look at the syntax chapter in the MySQL manual to confirm that
1948    your syntax is correct.
1949    
1950     [6.2] When I create a table, I click the Index checkbox for 2 fields and
1951     phpMyAdmin generates only one index with those 2 fields.
1952     
1953    In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a
1954    multi-fields index. If you want two indexes, create the first one when
1955    creating the table, save, then display the table properties and click
1956    the Index link to create the other index.
1957    
1958     [6.3] How can I insert a null value into my table?
1959     
1960    Since version 2.2.3, you have a checkbox for each field that can be
1961    null. Before 2.2.3, you had to enter "null", without the quotes, as
1962    the field's value.
1963    
1964     [6.4] How can I backup my database or table?
1965     
1966    Click on a database or table name in the left frame, the properties
1967    will be displayed. Then on the menu, click "Export", you can dump the
1968    structure, the data, or both. This will generate standard SQL
1969    statements that can be used to recreate your database/table.
1970    You will need to choose "Save as file", so that phpMyAdmin can
1971    transmit the resulting dump to your station. Depending on your PHP
1972    configuration, you will see options to compress the dump. See also the
1973    $cfg['ExecTimeLimit'] configuration variable.
1974    For additional help on this subject, look for the word "dump" in this
1975    document.
1976    
1977     [6.5] How can I restore (upload) my database or table using a dump? How can
1978     I run a ".sql" file.
1979     
1980    Click on a database name in the left frame, the properties will be
1981    local displayed. Then in the "Run SQL query" section, type in your
1982    dump filename, or use the Browse button. Then click Go.
1983    For additional help on this subject, look for the word "upload" in
1984    this document.
1985    
1986     [6.6] How can I use the relation table in Query-by-example?
1987     
1988    Here is an example with the tables persons, towns and countries, all
1989    located in the database mydb. If you don't have a PMA_relation table,
1990    create it as explained in the configuration section. Then create the
1991    example tables:
1992         CREATE TABLE REL_countries (
1993           country_code char(1) NOT NULL default '',
1994           description varchar(10) NOT NULL default '',
1995           PRIMARY KEY (country_code)
1996         ) TYPE=MyISAM;
1997         INSERT INTO REL_countries VALUES ('C', 'Canada');
1998         CREATE TABLE REL_persons (
1999           id tinyint(4) NOT NULL auto_increment,
2000           person_name varchar(32) NOT NULL default '',
2001           town_code varchar(5) default '0',
2002           country_code char(1) NOT NULL default '',
2003           PRIMARY KEY (id)
2004         ) TYPE=MyISAM;
2005         INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
2006         INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
2007         CREATE TABLE REL_towns (
2008           town_code varchar(5) NOT NULL default '0',
2009           description varchar(30) NOT NULL default '',
2010           PRIMARY KEY (town_code)
2011         ) TYPE=MyISAM;
2012         INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
2013         INSERT INTO REL_towns VALUES ('M', 'Montréal');
2014    To setup appropriate links and display information:
2015      * on table "REL_persons" click Structure, then Relation view
2016      * in Links, for "town_code" choose "REL_towns->code"
2017      * in Links, for "country_code" choose "REL_countries->country_code"
2018      * on table "REL_towns" click Structure, then Relation view
2019      * in "Choose field to display", choose "description"
2020      * repeat the two previous steps for table "REL_countries"
2021        
2022    Then test like this:
2023      * Click on your db name in the left frame
2024      * Choose "Query"
2025      * Use tables: persons, towns, countries
2026      * Click "Update query"
2027      * In the fields row, choose persons.person_name and click the "Show"
2028        tickbox
2029      * Do the same for towns.description and countries.descriptions in
2030        the other 2 columns
2031      * Click "Update query" and you will see in the query box that the
2032        correct joins have been generated
2033      * Click "Submit query"
2034        
2035     [6.7] How can I use the "display field" feature?
2036     
2037    Starting from the previous example, create the PMA_table_info as
2038    explained in the configuration section, then browse your persons
2039    table, and move the mouse over a town code or country code.
2040    
2041     [6.8] How can I produce a PDF schema of my database?
2042     
2043    First you have to fill the "relation", "table_coords" and "pdf_pages"
2044    configuration variables.
2045    Then, think about your schema layout: which tables will go on which
2046    pages.
2047      * Click on your db name in the left frame
2048      * Choose "Structure" in the navigation on top
2049      * Choose "Edit PDF Pages" which should be somewhere at the bottom of
2050        the page
2051      * Enter the name for a first pdf page and submit
2052      * Choose this page to edit
2053      * Now add a table you want to show on this page and it's coordinates
2054        and submit
2055        First you will have to guess this coordinates of course, so just
2056        expect to have an area of about 297 * 210 and put the tables
2057        coordinates somewhere in there, you will be able to have a look at
2058        what happened and change them later.
2059        For example, x=100 and y=200 means that the table will be at 200
2060        mm down and 100 mm right from the upper left corner.
2061        Actually if you have a width of more than 300 or a height of more
2062        than 200 than it will automatically be scaled but 300*100 is a
2063        good start to have an idea of what coordinates to use.
2064      * After every table you submitted you will have the possibility to
2065        submit more tables
2066      * When you have entered enough tables Click on your db name in the
2067        left frame again
2068      * Now, again at the bottom of the page you should be able to choose
2069        "Display PDF schema"
2070        For testing it might be useful to show the grid as well, so you
2071        can see the coordinates used.
2072        Maybe also choose color and submit.
2073      * Save the file he will offer you to something like Schema.pdf
2074        (Internet Explorer has some bug there which might make it offer it
2075        without an extension. Under Windows it is important to have the
2076        extension ".pdf", under other OSes you should be fine just saving
2077        the file under the name it offers).
2078        
2079     [6.9] phpMyAdmin is changing the type of one of my columns!
2080     
2081    No, it's MySQL that is doing silent column type changing.
2082    
2083     [6.10] When creating a privilege, what happens with underscores in the
2084     database name?
2085     
2086    If you do not put a backslash before the underscore, this is a
2087    wildcard grant, and the underscore means "any character". So, if the
2088    database name is "john_db", the user would get rights to john1db,
2089    john2db...
2090    If you put a backslash before the underscore, it means that the
2091    database name will have a real underscore.
2092    
2093     [6.11] What is the curious symbol ø in the statistics pages?
2094     
2095    It means "average".
2096    
2097     [6.12] I want to understand some Export options.
2098     
2099    "Complete inserts" adds the column names on every INSERT command, for
2100    better documentation (but resulting file is bigger).
2101    "Extended inserts" provides a shorter dump file by using only once the
2102    INSERT verb and the table name.
2103    "Enclose table and field names with backquotes" ensures that field and
2104    table names formed with special characters are protected.
2105    "Include column comments as inline SQL-comments" includes any column
2106    comments set in the PMA-DB in the dump as SQL comments (/* xxx */).
2107    
2108     [6.13] I would like to create a database with a dot in its name.
2109     
2110    This is a bad idea, because in MySQL the syntax "database.table" is
2111    the normal way to reference a database and table name. Worse, MySQL
2112    will usually let you create a database with a dot, but then you cannot
2113    work with it, nor delete it.
2114    
2115     [6.14] How do I set up the SQL Validator?
2116     
2117    To use it, you need a very recent version of PHP, 4.3.0 recommended,
2118    with XML, PCRE and PEAR support. On your system command line, run
2119    "pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME SOAP"
2120    to get the necessary PEAR modules for usage.
2121    If you use it, you should be aware that any SQL statement you submit
2122    will be stored anonymously (database/table/column names, strings,
2123    numbers replaced with generic values). The Mimer SQL Validator itself,
2124    is © 2001 Upright Database Technology. We utilize it as free SOAP
2125    service.
2126    
2127     [6.15] I want to add a BLOB field and put an index on it, but MySQL says
2128     "BLOB column '...' used in key specification without a key length".
2129     
2130    The right way to do this, is to create the field without any indexes,
2131    then display the table structure and use the "Create an index" dialog.
2132    On this page, you will be able to choose your BLOB field, and set a
2133    size to the index, which is the condition to create an index on a BLOB
2134    field.
2135    
2136     [6.16] How can I simply move in page with plenty editing fields?
2137     
2138    You can use Ctrl+arrows for moving on most pages with plenty editing
2139    fields (table structure changes, row editing, etc.) (must be anabled
2140    in configuration - see. $cfg['CtrlArrowsMoving']). You can also have a
2141    look at the directive $cfg['DefaultPropDisplay'] ('vertical') and see
2142    if this eases up editing for you.
2143    
2144     [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
2145     then useful for?
2146     
2147    Slow down :). Defining mimetypes is of no use, if you can't put
2148    transformations on them. Otherwise you could just put a comment on the
2149    field. Because entering your own mimetype will cause serious syntax
2150    checking issues and validation, this introduces a high-risk
2151    false-user-input situation. Instead you have to initialize mimetypes
2152    using functions or empty mimetype definitions.
2153    Plus, you have a whole overview of available mimetypes. Who knows all
2154    those mimetypes by heart so he/she can enter it at will?
2155    
2156     [6.17] Bookmarks: Where can I store bookmarks? Why can't I see any
2157     bookmarks below the query box? What is this variable for?
2158     
2159    Any query you have executed can be stored as a bookmark on the page
2160    where the results are displayed. You will find a button labeled
2161    'Bookmark this query' just at the end of the page.
2162    As soon as you have stored a bookmark, it is related to the database
2163    you run the query on. You can now access a bookmark dropdown on each
2164    page, the query box appears on for that database.
2165    Since phpMyAdmin 2.5.0 you are also able to store variables for the
2166    bookmarks. Just use the string /*[VARIABLE]*/ anywhere in your query.
2167    Everything which is put into the value input box on the query box page
2168    will replace the string "/*[VARIABLE]*/" in your stored query. Just be
2169    aware of that you HAVE to create a valid query, otherwise your query
2170    won't be even able to be stored in the database.
2171    Also remember, that everything else inside the /*[VARIABLE]*/ string
2172    for your query will remain the way it is, but will be stripped of the
2173    /**/ chars. So you can use:
2174    /*, [VARIABLE] AS myname */
2175    which will be expanded to
2176    , VARIABLE as myname
2177    in your query, where VARIABLE is the string you entered in the input
2178    box. If an empty string is provided, no replacements are made.
2179    A more complex example. Say you have stored this query:
2180    SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE
2181    '%[VARIABLE]%' */
2182    Say, you now enter "phpMyAdmin" as the variable for the stored query,
2183    the full query will be:
2184    SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE
2185    '%phpMyAdmin%'
2186    You can use multiple occurences of /*[VARIABLE]*/ in a single query.
2187    NOTE THE ABSENCE OF SPACES inside the "/**/" construct. Any spaces
2188    inserted there will be later also inserted as spaces in your query and
2189    may lead to unexpected results especially when using the variable
2190    expansion inside of a "LIKE ''" expression.
2191    Your initial query which is going to be stored as a bookmark has to
2192    yield at least one result row so you can store the bookmark. You may
2193    have that to work around using well positioned "/**/" comments.
2194    
2195   [7. phpMyAdmin project]
2196   
2197     [7.1] I have found a bug. How do I inform developers?
2198     
2199    Our Bug Tracker is located at
2200    http://sourceforge.net/projects/phpmyadmin/ under the Bugs section.
2201    But please first discuss your bug with other users:
2202    http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
2203    
2204     [7.2] I want to translate the messages to a new language or upgrade an
2205     existing language, where do I start?
2206     
2207    Always use the current CVS version of your language file. For a new
2208    language, start from english-iso-8859-1.inc.php3. If you don't know
2209    how to get the CVS version, please ask one of the developers.
2210    Please note that we try not to use HTML entities like &eacute; in the
2211    translations, since we define the right character set in the file.
2212    With HTML entities, the text on JavaScript messages would not display
2213    correctly. However there are some entities that need to be there, for
2214    quotes ,non-breakable spaces, ampersands, less than, greater than.
2215    You can then put your translations, as a zip file to avoid losing
2216    special characters, on the sourceforge.net translation tracker.
2217    It would be a good idea to subscribe to the phpmyadmin-translators
2218    mailing list, because this is where we ask for translations of new
2219    messages.
2220    
2221     [7.3] I would like to help out with the development of phpMyAdmin. How
2222     should I proceed?
2223     
2224    The following method is preferred for new developers:
2225     1. fetch the current CVS tree over anonymous CVS:
2226        cvs
2227        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2228        admin login
2229        [Password: simply press the Enter key]
2230        cvs -z3
2231        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2232        admin checkout phpMyAdmin
2233        [This will create a new sub-directory named phpMyAdmin]
2234     2. add your stuff
2235     3. put the modified files (tar'ed and gzip'ed) inside the patch
2236        tracker of the phpMyAdmin SourceForge account.
2237        
2238    Write access to the CVS tree is granted only to experienced developers
2239    who have already contributed something useful to phpMyAdmin.
2240    Also, have a look at the Developers section.
2241    
2242 Developers Information
2244    phpMyAdmin is Open Source, so you're invited to contribute to it. Many
2245    great features have been written by other people and you too can help
2246    to make phpMyAdmin a useful tool.
2247    
2248    If you're planning to contribute source, please read the following
2249    information:
2250      * All files include header.inc.php3 (layout),
2251        libraries/common.lib.php3 (common functions) and config.inc.php3.
2252        All configuration data belongs in config.inc.php3. Please keep it
2253        free from other code.
2254        Commonly used functions should be added to
2255        libraries/common.lib.php3 and more specific ones may be added
2256        within a library stored into the libraries sub-directory.
2257      * Obviously, you're free to use whatever coding style you want. But
2258        please try to keep your code as simple as possible: beginners are
2259        using phpMyAdmin as an example application.
2260        As far as possible, we want the scripts to be XHTML1.0 and CSS2
2261        compliant on one hand, they fit the PEAR coding standards on the
2262        other hand. Please pay attention to this.
2263      * Please try to keep up the file-naming conventions. Table-related
2264        stuff goes to tbl_*.php3, db-related code to db_*.php3,
2265        server-related tools to server_*.php3 and so on.
2266      * Please don't use verbose strings in your code, instead add the
2267        string (at least) to english-iso-8859-1.inc.php3 and print() it
2268        out.
2269      * If you want to be really helpful, write an entry for the
2270        ChangeLog.
2271      * The DBG extension (PHP Debugger DBG) is now supported by
2272        phpMyAdmin for developers to better debug and profile their code.
2273        Please see the $cfg['DBG']* configuration options for more
2274        information.
2275        This is in memoriam of the Space Shuttle Columbia (STS-107) which
2276        was lost during its re-entry into Earth's atmosphere and in memory
2277        of the brave men and women who gave their lives for the people of
2278        Earth.
2279        
2280 Credits
2283 phpMyAdmin - Credits
2284 ====================
2286 CREDITS, in chronological order
2287 -------------------------------
2289 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
2290     * creator of the phpmyadmin project
2291     * maintainer from 1998 to summer 2000
2293 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
2294     * multi-language version
2295     * various fixes and improvements
2296     * project co-administrator
2298 - Olivier Müller <om_at_omnis.ch>
2299     * started SourceForge phpMyAdmin project in March 2001
2300     * sync'ed different existing CVS trees with new features and bugfixes
2301     * multi-language improvements, dynamic language selection
2302     * current project maintainer
2303     * many bugfixes and improvements
2305 - Loïc Chapeaux <lolo_at_phpheaven.net>
2306     * rewrote and optimized javascript, DHTML and DOM stuff
2307     * rewrote the scripts so they fit the PEAR coding standards and
2308       generate XHTML1.0 and CSS2 compliant codes
2309     * improved the language detection system
2310     * many bugfixes and improvements
2312 - Robin Johnson <robbat2_at_users.sourceforge.net>
2313     * database maintence controls
2314     * table type code
2315     * Host authentication IP Allow/Deny
2316     * DB-based configuration (Not completed)
2317     * SQL parser
2318     * SQL validator
2319     * many bugfixes and improvements
2321 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
2322     * bookmarks feature
2323     * multiple dump feature
2324     * gzip dump feature
2325     * zip dump feature
2327 - Geert Lund <glund_at_silversoft.dk>
2328     * various fixes
2329     * moderator of the phpMyAdmin users forum at phpwizard.net
2331 - Korakot Chaovavanich <korakot_at_iname.com>
2332     * "insert as new row" feature
2334 - Pete Kelly <webmaster_at_trafficg.com>
2335     * rewrote and fix dump code
2336     * bugfixes
2338 - Steve Alberty <alberty_at_neptunlabs.de>
2339     * rewrote dump code for PHP4
2340     * mySQL table statistics
2341     * bugfixes
2343 - Benjamin Gandon <gandon_at_isia.cma.fr>
2344     * main author of the version 2.1.0.1
2345     * bugfixes
2347 - Alexander M. Turek <rabus_at_bugfixes.info>
2348     * XML exports
2349     * MySQL 4 related features
2350     * various small features and fixes
2351     * German language file updates
2353 - Mike Beck <mike.beck_at_ibmiller.de>
2354     * automatic joins in QBE
2355     * links column in printview
2356     * Relation view
2358 - Michal Cihar <nijel_at_users.sourceforge.net>
2359     * enhanced index creation/display feature
2360     * feature to use a different charset for HTML than for MySQL
2361     * Czech language file updates
2363 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
2364   (http://sourceforge.net/projects/phpmysqlformgen/)
2365     * suggested the patch for multiple table printviews
2367 - Garvin Hicking <hicking_at_faktor-e.de>
2368     * built the patch for vertical display of table rows
2369     * built the Javascript based Query window + SQL history
2370     * Improvement of column/db comments
2371     * (MIME)-Transformations for columns
2372     * Use custom alias names for Databases in left frame
2373     * vertical display of column properties page
2374     * some bugfixes, smaller features
2376 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
2377     * japanese kanji encoding conversion feature
2379 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
2380     * the Cookie authentication mode
2382 - Axel Sander <n8falke_at_users.sourceforge.net>
2383     * table relation-links feature
2385 - Maxime Delorme <delorme.maxime_at_free.fr>
2386     * PDF schema output, thanks also to Olivier Plathey for the
2387       "FPDF" library (see http://www.fpdf.org/).
2389 - Olof Edlund <olof.edlund_at_upright.se>
2390     * SQL validator server
2392 - Ivan R. Lanin <ivanlanin_at_users.sourceforfe.net>
2393     * phpMyAdmin logo
2395 And also to the following people who have contributed minor changes,
2396 enhancements, bugfixes or support for a new language since version 2.1.0:
2398 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
2399 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
2400 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
2401 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
2402 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
2403 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
2404 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
2405 Luís V., Martijn W. van der Lee,
2406 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
2407 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
2410 Original Credits of Version 2.1.0
2411 ---------------------------------
2413     This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
2414     to create a web-based interface to MySQL using PHP3. Although I have not
2415     used any of his source-code, there are some concepts I've borrowed from
2416     him. phpMyAdmin was created because Peter told me he wasn't going to
2417     further develop his (great) tool.
2418     Thanks go to
2419     - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
2420       code for the check when dropping a table or database. He also suggested
2421       that you should be able to specify the primary key on tbl_create.php3. To
2422       version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
2423       well as a bug-report. Plus many smaller improvements.
2424     - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
2425       were introduced in 1.3.0 (including quite significant ones like the
2426       authentication). For 1.4.1 he enhanced the table-dump feature. Plus
2427       bug-fixes and help.
2428     - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
2429       language-independent by outsourcing the strings to a separate file. He
2430       also contributed the French translation.
2431     - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
2432       tbl_select.php3, a feature to display only some fields from a table.
2433     - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
2434       functions in tbl_change.php3. He also added the
2435       "Query by Example" feature in 2.0.
2436     - Dave Walton <walton_at_nordicdms.com> added support for multiple
2437       servers and is a regular contributor for bug-fixes.
2438     - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
2439       features for 2.0.6.
2440     The following people have contributed minor changes, enhancements, bugfixes
2441     or support for a new language:
2442     Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
2443     Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
2444     Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
2445     G. Wieggers.
2447     And thanks to everyone else who sent me email with suggestions, bug-reports
2448     and or just some feedback.
2450                                         Valid XHTML 1.0!      Valid CSS!