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