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