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