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