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