Error Buddy

Do you have an error message from your application? Then find the answer with Error Buddy. You can search over 40000 source code files and troubleshooting documents using our beta lucene/nutch search interface or if you prefer, search as normal using google. With LXR technology you can drill right down into the line of source code where it came from with full cross-referencing.

If after searching you didn't get your ideal answer, or you are still unclear what the error means, you can choose to post that question to the community forums following the link included in the search results.

corestack/ phpMyAdmin-2.6.1-pl3/ Documentation.txt [1.6]
001    ______________________________________________________________________
002 
003    Top  -  Requirements  -  Introduction  -  Installation  -  Configuration
004    Transformations  -  FAQ  -  Developers  -  Credits  -  Translators
005    ______________________________________________________________________
006 
007                       phpMyAdmin 2.6.1-pl3 Documentation
008 
009      * SourceForge phpMyAdmin project page   [ http://www.phpmyadmin.net/ ] 
010      * Local documents:
011           + Version history: ChangeLog
012           + General notes: README
013           + License: LICENSE
014      * Documentation version: $Id: Documentation.html,v 2.103.2.5 2005/03/03        20:54:24 rabus Exp $
015 
016 Requirements
017 
018      * PHP
019           + You need PHP 4.1.0 or newer (*)
020           + If you want to display inline thumbnails of JPEGs with the original
021             aspect ratio, you also need GD2 support in PHP
022           + Starting with phpMyAdmin 2.6.1, MIME-based transformations that use
023             an external program need PHP 4.3.0 or newer
024      * MySQL 3.23.32 or newer (details);
025      * Not really a requirement but a strong suggestion: if you are using th       e "cookie" authentication method, having the mcrypt PHP extension on
026        your web server accelerates not only the login phase but every other
027        action that you do in phpMyAdmin.
028      * a web-browser (doh!).
029 
030 Introduction
031 
032    phpMyAdmin can manage a whole MySQL server (needs a super-user) as well a   s a single database. To accomplish the latter you'll need a properly set    up MySQL user who can read/write only the desired database. It's up to   you to look up the appropriate part in the MySQL manual.
033    Currently phpMyAdmin can:
034      * create and drop databases
035      * create, copy, drop, rename and alter tables
036      * do table maintenance
037      * delete, edit and add fields
038      * execute any SQL-statement, even batch-queries
039      * manage keys on fields
040      * load text files into tables
041      * create (*) and read dumps of tables
042      * export (*) data to CSV, XML and Latex formats
043      * administer multiple servers
044      * manage MySQL users and privileges
045      * check referential integrity in MyISAM tables
046      * using Query-by-example (QBE), create complex queries automatically co       nnecting required tables
047      * create PDF graphics of your Database layout
048      * search globally in a database or a subset of it
049      * transform stored data into any format using a set of predefined funct       ions, like displaying BLOB-data as image or download-link or ...
050      * support InnoDB tables and foreign keys (see FAQ 3.6)
051      * support mysqli, the improved MySQL extension (see FAQ 1.17)
052      * communicate in 47 different languages
053 
054    (*)  phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dump   s and CSV exports if you use PHP4 >= 4.0.4 with Zlib support (--with-zli   b) and/or Bzip2 support (--with-bz2).
055 
056 Installation
057 
058    NOTE: phpMyAdmin does not apply any special security methods to the MySQL    database server. It is still the system administrator's job to grant pe   rmissions on the MySQL databases properly. phpMyAdmin's "Privileges" pag   e can be used for this.
059 
060    Warning for Mac users:if you are on a MacOS version before OS X, StuffIt   unstuffs with Mac formats.
061    So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin script   s before uploading them to your server, as PHP seems not to like Mac-sty   le end of lines character ("\r").
062 
063   Quick Install
064 
065     1. Untar or unzip the distribution (be sure to unzip the subdirectories)       : tar -xzvf phpMyAdmin_x.x.x.tar.gz in your webserver's document root.
066        If you don't have direct access to your document root, put the files in
067        a directory on your local machine, and, after step 3, transfer the
068        directory on your web server using, for example, ftp.
069     2. Ensure that all the scripts have the appropriate owner (if PHP is run       ning in safe mode, having some scripts with an owner different from the
070        owner of other scripts will be a problem). See FAQ 4.2 for suggestions.
071     3. Open the file config.inc.php in your favorite editor and change the v       alues for host, user, password and authentication mode to fit your
072        environment.  Here, "host" means the MySQL server. Also insert the
073        correct value for $cfg['PmaAbsoluteUri']. Have a look at Configuration
074        section  for  an  explanation  of all values. Please also read the
075        remaining  of  this  Installation  section  for  information about
076        authentication modes and the linked-tables infrastructure.
077     4. It is recommended that you protect the directory in which you install       ed phpMyAdmin (unless it's on a closed intranet, or you wish to use
078        HTTP  or  cookie authentication), for example with HTTP-AUTH (in a
079        .htaccess  file).  See  the  multi-user sub-section of the FAQ for
080        additional information, especially FAQ 4.4.
081     5. Open the file <www.your-host.com>/<your-install-dir>/index.php in you       r browser. phpMyAdmin should now display a welcome screen and your
082        databases, or a login dialog if using HTTP or cookie authentication
083        mode.
084 
085   Linked-tables infrastructure
086 
087    For a whole set of new features (bookmarks, comments, SQL-history, PDF-ge   neration, field contents transformation, etc.) you need to create a set   of special tables. Those tables can be located in your own database, or   in a central database for a multi-user installation (this database would    then be accessed by the controluser, so no other user should have right   s to it).
088    Please look at your scripts/ directory, where you should find a file call   ed create_tables.sql. (If you are using a Windows server, pay special at   tention to FAQ 1.23).
089    If your MySQL server's version is 4.1.2 or later, please use create_table   s_mysql_4_1_2+.sql instead, for a new installation.
090    If you already had this infrastructure and upgraded to MySQL 4.1.2 or lat   er, please use upgrade_tables_mysql_4_1_2+.sql.
091    You can use your phpMyAdmin to create the tables for you. Please be aware    that you may need special (administrator) privileges to create the data   base and tables, and that the script may need some tuning, depending on   the database name.
092    After having imported the create_tables.sql file, you should specify the   table names in your config.inc.php file. The directives used for that ca   n be found in the Configuration section. You will also need to have a co   ntroluser with the proper rights to those tables (see section Using auth   entication modes below).
093 
094   Upgrading from an older version
095 
096      * You can safely copy your older config.inc.php over a new one, if you       can live with default values for possible new parameters (you can check
097        release notes to see what new features were added). This compatibility
098        will stay for long time, current version supports importing config files
099        from 2.2 and maybe even older (nobody has tried that).
100 
101   Using authentication modes
102 
103      * HTTP and cookie authentication modes are recommended in a multi-user       environment where you want to give users access to their own database
104        and don't want them to play around with others.
105        Nevertheless be aware that MS Internet Explorer seems to be really buggy
106        about cookies, at least till version 6. And PHP 4.1.1 is also a bit
107        buggy in this area!
108        Even in a single-user environment, you might prefer to use HTTP or
109        cookie mode so that your user/password pair are not in clear in the
110        configuration file.
111      * HTTP and cookie authentication modes are more secure: the MySQL login        information does not need to be set in the phpMyAdmin configuration
112        file (except possibly for the controluser).
113        However, keep in mind that the password travels in plain text, unless
114        you are using the HTTPS protocol.
115        In cookie mode, the password is stored, encrypted with the blowfish
116        algorithm, in a temporary cookie.
117      * Note: starting with phpMyAdmin 2.6.1, configuring the controluser to       enable HTTP and cookie authentication applies only to MySQL servers
118        older than 4.1.2.
119        For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
120        only  the  SELECT  privilege on the mysql.user (all columns except
121        "Password"),  mysql.db (all columns), mysql.host (all columns) and
122        mysql.tables_priv (all columns except "Grantor" & "Timestamp") tables.
123        You must specify the details for the controluser in the config.inc.php
124        file       under      the      $cfg['Servers'][$i]['controluser']&
125        $cfg['Servers'][$i]['controlpass'] settings.
126        The following example assumes you want to use pma as the controluser and
127        pmapass as the controlpass, but this is only an example: use something
128        else in your file!
129        Of course you have to replace localhost by the webserver's host if it's
130        not the same as the MySQL server's one.
131 
132 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
133 GRANT SELECT (
134     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
135     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
136     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
137     Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
138     Execute_priv, Repl_slave_priv, Repl_client_priv
139     ) ON mysql.user TO 'pma'@'localhost';
140 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
141 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
142 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
143     ON mysql.tables_priv TO 'pma'@'localhost';
144 
145        If you are using an old MySQL version (below 4.0.2), please replace the
146        first GRANT SELECT query by this one:
147 
148 GRANT SELECT (
149     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
150     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
151     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
152     ) ON mysql.user TO 'pma'@'localhost';
153 
154        ... and if you want to use the many new relation and bookmark features:
155 
156 GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db>.* TO 'pma'@'localhost';
157 
158        (this of course requires you to have a special DB for phpMyAdmin, the
159        contents will be explained later)
160        Of course, the above queries only work if your MySQL version supports
161        the GRANT command. This is the case since 3.22.11.
162      * Then each of the true users should be granted a set of privileges on       a set of particular databases. Normally you shouldn't give global
163        privileges to an ordinary user, unless you understand the impact of
164        those privileges (for example, you are creating a superuser).
165        For example, to grant the user real_user with all privileges on the
166        database user_base:
167           GRANT  ALL  PRIVILEGES  ON user_base.* TO 'real_user'@localhost
168        IDENTIFIED BY 'real_password';
169        What  the user may now do is controlled entirely by the MySQL user
170        management system.
171        With HTTP or cookie authentication mode, you don't need to fill the
172        user/password fields inside the $cfg['Servers'] array.
173 
174     'http' authentication mode
175 
176      * Was called 'advanced' in versions before 2.2.3.
177      * Introduced in 1.3.0, it uses Basic HTTP authentication method and all       ows you to login as any valid MySQL user.
178      * Is supported with PHP running as an Apache module. For IIS (ISAPI) su       pport using CGI PHP, see FAQ 1.32.
179      * See also FAQ 4.4 about not using the .htaccess mechanism along with '       http' authentication mode.
180 
181     'cookie' authentication mode
182 
183      * You can use this method as a replacement for the HTTP authentication       (for example, if you're running IIS).
184      * Obviously, the user must enable cookies in the browser.
185      * With this mode, the user can truly logout of phpMyAdmin and login bac       k with the same username.
186      * If you want to login to arbitrary server see $cfg['AllowArbitraryServ       er'] directive.
187      * See also the requirements section for a way to improve the interface       speed while using this mode.
188 
189     'config' authentication mode
190 
191      * This mode is the less secure one because it requires you to fill the        $cfg['Servers'][$i]['user'] and $cfg['Servers'][$i]['password'] fields.
192        But  you  don't  need  to  setup  a  "controluser" here: using the
193        $cfg['Servers'][$i]['only_db'] might be enough.
194      * In the ISP FAQ section, there is an entry explaining how to protect y       our configuration file.
195      * For additional security in this mode, you may wish to consider the Ho       st  authentication  $cfg['Servers'][$i]['AllowDeny']['order'] and
196        $cfg['Servers'][$i]['AllowDeny']['rules'] configuration directives.
197 
198 Configuration
199 
200    Warning for Mac users: PHP seems not to like Mac end of lines character (   "\r"). So ensure you choose the option that allows to use the *nix end o   f line character ("\n") in your text editor before registering a script   you have modified.
201 
202    Configuration note: Almost all configurable data is placed in config.inc.   php. The parameters which relate to design (like colors) are placed in t   hemes/themename/layout.inc.php. You might also want to modify config.foo   ter.inc.php and config.header.inc.php files to add your site specific co   de to be included on start and end of each page.
203 
204    $cfg['PmaAbsoluteUri'] string
205           Sets  here the complete URL (with full path) to your phpMyAdmin
206           version. E.g.
207           http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
208           phpMyAdmin needs this setting, because of requirements of the HTTP
209           protocol, explained in RFC2616, section 14.30.
210           Don't forget the slash at the end of your URL. The URL must contain
211           characters that are valid for a URL, and on some servers, the path is
212           case-sensitive.
213           Starting with version 2.3.0, you can try to leave this parameter
214           empty, because the program tries to auto-detect its proper value.
215           Additional details are in the configuration file.
216 
217    $cfg['PmaAbsoluteUri_DisableWarning'] boolean
218           By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the
219           system detects your absolute URI automatically, we display a warning
220           to remind you. If you have tested the automatic detection, and it
221           works perfectly for your setup, then you can set this variable to
222           squelch the warning.
223 
224    $cfg['PmaNoRelation_DisableWarning'] boolean
225           Starting with version 2.3.0 phpMyAdmin offers a lot of features to
226           work with master / foreign - tables (see
227           $cfg['Servers'][$i]['pmadb']).
228           If you tried to set this up and it does not work for you, have a look
229           on the "Structure" page of one database where you would like to use
230           it. You will find a link that will analyze why those features have
231           been disabled.
232           If you do not want to use those features set this variable to TRUE to
233           stop this message from appearing.
234 
235    $cfg['blowfish_secret'] string
236           Starting with version 2.5.2, the 'cookie' auth_type uses blowfish
237           algorithm to encrypt the password.
238           If  you  are  using the 'cookie' auth_type, enter here a random
239           passphrase of your choice. It will be used internally by the blowfish
240           algorithm: you won't be prompted for this passphrase. The maximum
241           number of characters for this parameter seems to be 46.
242 
243    $cfg['Servers'] array
244           Since  version 1.4.2, phpMyAdmin supports the administration of
245           multiple MySQL servers. Therefore, a $cfg['Servers']-array has been
246           added which contains the login information for the different servers.
247           The first $cfg['Servers'][$i]['host'] contains the hostname of the
248           first server, the second $cfg['Servers'][$i]['host'] the hostname of
249           the second server, etc. If you have only one server to administer,
250           simply leave free the hostname of the other $cfg['Server']-entries.
251 
252    $cfg['Servers'][$i]['host'] string
253           The  hostname  or  IP  address of your $i-th MySQL-server. E.g.
254           localhost.
255 
256    $cfg['Servers'][$i]['port'] string
257           The port-number of your $i-th MySQL-server. Default is 3306 (leave
258           blank). If you use "localhost" as the hostname, MySQL ignores this
259           port number and connects with the socket, so if you want to connect
260           to a port different from the default port, use "127.0.0.1" or the
261           real hostname in $cfg['Servers'][$i]['host'].
262 
263    $cfg['Servers'][$i]['socket'] string
264           The path to the socket to use. Leave blank for default.
265           To use the socket feature you must run PHP 3.0.10 or more.
266 
267    $cfg['Servers'][$i]['connect_type'] string
268           What type connection to use with the MySQL server. Your options are
269           'socket' & 'tcp'. It defaults to 'tcp' as that is nearly guaranteed
270           to be available on all MySQL servers, while sockets are not supported
271           on some platforms.
272           To use the socket mode, your MySQL server must be on the same machine
273           as the Web server.
274 
275    $cfg['Servers'][$i]['extension'] string
276           What php MySQL extension to use for the connection. Valid options
277           are:
278           mysql :  The classic MySQL extension. This is the recommended and
279           default method at this time.
280           mysqli :   The  improved MySQL extension. This extension became
281           available with php 5.0.0 and is the recommended way to connect to a
282           server running MySQL 4.1.x.
283           Note: phpMyAdmin's MySQL 4.1 support is experimental!
284 
285    $cfg['Servers'][$i]['compress'] boolean
286           Whether to use a compressed protocol for the MySQL server connection
287           or not (experimental).
288           This feature requires PHP >= 4.3.0.
289 
290    $cfg['Servers'][$i]['controluser'] string
291           $cfg['Servers'][$i]['controlpass'] string
292           Note: starting with phpMyAdmin 2.6.1, configuring the controluser to
293           enable HTTP and cookie authentication applies only to MySQL servers
294           older than 4.1.2.
295           This  special  account is used for 2 distinct purposes: to make
296           possible all relational features (see $cfg['Servers'][$i]['pmadb'])
297           and, for a MySQL server older than 4.1.2, to enable a multi-user
298           installation (http or cookie authentication mode).
299           When  using  HTTP  or  cookie authentication modes (or 'config'
300           authentication mode since phpMyAdmin 2.2.1), you need to supply the
301           details  of  a  MySQL  account that has SELECT privilege on the
302           mysql.user (all columns except "Password"), mysql.db (all columns) &
303           mysql.tables_priv  (all columns except "Grantor" & "Timestamp")
304           tables. This account is used to check what databases the user will
305           see at login.
306           Please see the install section on "Using authentication modes" for
307           more information.
308           Note that if you try login to phpMyAdmin with this "controluser", you
309           could get some errors, depending the exact privileges you gave to the
310           "controluser". phpMyAdmin does not support a direct login with the
311           "controluser".
312           In   phpMyAdmin   versions  before  2.2.5,  those  were  called
313           "stduser/stdpass".
314 
315    $cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
316           Whether config or cookie or http authentication should be used for
317           this server.
318 
319           + 'config' authentication ($auth_type = 'config') is the plain old
320             way: username and password are stored in config.inc.php.
321           + 'cookie' authentication mode ($auth_type = 'cookie') as introduced
322             in 2.2.3 allows you to log in as any valid MySQL user with the help
323             of cookies. Log name and password are stored in cookies during the
324             session and password is deleted when it ends. This can also allow
325             you to login in arbitrary server if $cfg['AllowArbitraryServer']
326             enabled.
327           + 'http' authentication (was called 'advanced' in older versions)
328             ($auth_type = 'http') as introduced in 1.3.0 allows you to log in
329             as any valid MySQL user via HTTP-Auth.
330 
331           Please see the install section on "Using authentication modes" for
332           more information.
333 
334    $cfg['Servers'][$i]['user'] string
335           $cfg['Servers'][$i]['password'] string
336           The user/password-pair which phpMyAdmin will use to connect to this
337           MySQL-server. This user/password pair is not needed when HTTP or
338           cookie authentication is used, and should be empty.
339 
340    $cfg['Servers'][$i]['only_db'] string or array
341           If  set  to a (an array of) database name(s), only this (these)
342           database(s)  will be shown to the user. Since phpMyAdmin 2.2.1,
343           this/these database(s) name(s) may contain MySQL wildcards characters
344           ("_"  and  "%"):  if you want to use literal instances of these
345           characters, escape them (I.E. use 'my\_db' and not 'my_db').
346           This setting is an efficient way to lower the server load since the
347           latter does not need to send MySQL requests to build the available
348           database list. But it does not replace the privileges rules of the
349           MySQL database server. If set, it just means only these databases
350           will be displayed but not that all other databases can't be used.
351           An    example    of    using    more    that    one   database:
352           $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
353           As of phpMyAdmin 2.5.5 the order inside the array is used for sorting
354           the databases in the left frame, so that you can individually arrange
355           your databases.
356           If you want to have certain databases at the top, but don't care
357           about the others, you do not need to specify all other databases.
358           Use: $cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '*');
359           instead to tell phpMyAdmin that it should display db3 and db4 on top,
360           and the rest in alphabetic order.
361 
362    $cfg['Servers'][$i]['verbose'] string
363           Only useful when using phpMyAdmin with multiple server entries. If
364           set, this string will be displayed instead of the hostname in the
365           pull-down menu on the main page. This can be useful if you want to
366           show only certain databases on your system, for example.
367 
368    $cfg['Servers'][$i]['pmadb'] string
369           The name of the database containing the linked-tables infrastructure.
370           See the Linked-tables infrastructure section in this document to see
371           the benefits of this infrastructure, and for a quick way of creating
372           this database and the needed tables.
373           If you are the only user of this phpMyAdmin installation, you can use
374           your current database to store those special tables; in this case,
375           just put your current database name in $cfg['Servers'][$i]['pmadb'].
376           For a multi-user installation, set this parameter to the name of your
377           central database containing the linked-tables infrastructure.
378 
379    $cfg['Servers'][$i]['bookmarktable'] string
380           Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can
381           be useful for queries you often run.
382           To allow the usage of this functionality:
383 
384           + set up pmadb and the linked-tables infrastructure
385           + enter the table name in $cfg['Servers'][$i]['bookmarktable']
386 
387    $cfg['Servers'][$i]['relation'] string
388           Since release 2.2.4 you can describe, in a special 'relation' table,
389           which field is a key in another table (a foreign key). phpMyAdmin
390           currently uses this to
391 
392           + make clickable, when you browse the master table, the data values
393             that point to the foreign table;
394           + display in an optional tool-tip the "display field" when browsing
395             the master table, if you move the mouse to a column containing a
396             foreign key (use also the 'table_info' table);
397             (see FAQ 6.7)
398           + in edit/insert mode, display a drop-down list of possible foreign
399             keys (key value and "display field" are shown)
400             (see FAQ 6.21)
401           + display links on the table properties page, to check referential
402             integrity (display missing foreign keys) for each described key;
403           + in query-by-example, create automatic joins (see FAQ 6.6)
404           + enable you to get a PDF schema of your database (also uses the
405             table_coords table).
406 
407           The keys can be numeric or character.
408           To allow the usage of this functionality:
409 
410           + set up pmadb and the linked-tables infrastructure
411           + put the relation table name in $cfg['Servers'][$i]['relation']
412           + now as normal user open phpMyAdmin and for each one of your tables
413             where you want to use this feature, click "Structure/Relation
414             view/" and choose foreign fields.
415 
416           Please note that in the current version, master_db must be the same
417           as foreign_db. Those fields have been put in future development of
418           the cross-db relations.
419 
420    $cfg['Servers'][$i]['table_info'] string
421           Since release 2.3.0 you can describe, in a special 'table_info'
422           table, which field is to be displayed as a tool-tip when moving the
423           cursor over the corresponding key.
424           This configuration variable will hold the name of this special table.
425           To allow the usage of this functionality:
426 
427           + set up pmadb and the linked-tables infrastructure
428           + put the table name in $cfg['Servers'][$i]['table_info']
429           + then for each table where you want to use this feature, click
430             "Structure/Relation view/Choose field to display" to choose the
431             field.
432 
433           Usage tip: Display field.
434 
435    $cfg['Servers'][$i]['table_coords'] string
436           $cfg['Servers'][$i]['pdf_pages'] string
437           Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
438           the relations between your tables. To do this it needs two tables
439           "pdf_pages" (storing information about the available PDF pages) and
440           "table_coords" (storing coordinates where each table will be placed
441           on a PDF schema output).
442           You must be using the "relation" feature.
443           To allow the usage of this functionality:
444 
445           + set up pmadb and the linked-tables infrastructure
446           + put the correct table names in $cfg['Servers'][$i]['table_coords']
447             and $cfg['Servers'][$i]['pdf_pages']
448 
449           Usage tips: PDF output.
450 
451    $cfg['Servers'][$i]['column_info'] string
452           Since release 2.3.0 you can store comments to describe each column
453           for each table. These will then be shown on the "printview".
454           Starting with release 2.5.0, comments are consequently used on the
455           table property pages and table browse view, showing up as tool-tips
456           above the column name (properties page) or embedded within the header
457           of table in browse view. They can also be shown in a table dump.
458           Please see the relevant configuration directives later on.
459           Also new in release 2.5.0 is a MIME-transformation system which is
460           also based on the following table structure. See Transformations for
461           further information. To use the MIME-transformation system, your
462           column_info  table has to have the three new fields 'mimetype',
463           'transformation', 'transformation_options'.
464           To allow the usage of this functionality:
465 
466           + set up pmadb and the linked-tables infrastructure
467           + put the table name in $cfg['Servers'][$i]['column_info']
468           + to update your PRE-2.5.0 Column_comments Table use this:
469                  ALTER TABLE `pma_column_comments`
470                    ADD `mimetype` VARCHAR( 255 ) NOT NULL ,
471                    ADD `transformation` VARCHAR( 255 ) NOT NULL ,
472                    ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;
473             and remember that the Variable in config.inc.php has been renamed
474             from
475             $cfg['Servers'][$i]['column_comments']                     to
476             $cfg['Servers'][$i]['column_info']
477 
478    $cfg['Servers'][$i]['history'] string
479           Since release 2.5.0 you can store your SQL history, which means all
480           queries you entered manually into the phpMyAdmin interface. If you
481           don't  want  to  use  a  table-  based history, you can use the
482           JavaScript-based history. Using that, all your history items are
483           deleted when closing the window.
484           Using $cfg['QueryHistoryMax'] you can specify an amount of history
485           items you want to have on hold. On every login, this list gets cut to
486           the maximum amount.
487           The query history is only available if you use the JavaScript-based
488           query window, see $cfg['QueryFrame'].
489           To allow the usage of this functionality:
490 
491           + set up pmadb and the linked-tables infrastructure
492           + put the table name in $cfg['Servers'][$i]['history']
493 
494    $cfg['Servers'][$i]['verbose_check'] boolean
495           Because release 2.5.0 introduced the new MIME-transformation support,
496           the column_info table got enhanced with three new fields. If the
497           above variable is set to TRUE (default) phpMyAdmin will check if you
498           have the latest table structure available. If not, it will emit a
499           warning to the superuser.
500           You can disable this checking behavior by setting the variable to
501           false, which should offer a performance increase.
502           Recommended to set to FALSE, when you are sure, your table structure
503           is up to date.
504 
505    $cfg['Servers'][$i]['AllowRoot'] boolean
506           Whether to allow root access, This is just simplification of rules
507           below.
508 
509    $cfg['Servers'][$i]['AllowDeny']['order'] string
510           If your rule order is empty, then IP authentication is disabled.
511           If your rule order is set to 'deny,allow' then the system applies all
512           deny rules followed by allow rules. Access is allowed by default. Any
513           client which does not match a Deny command or does match an Allow
514           command will be allowed access to the server.
515           If your rule order is set to 'allow,deny' then the system applies all
516           allow rules followed by deny rules. Access is denied by default. Any
517           client which does not match an Allow directive or does match a Deny
518           directive will be denied access to the server.
519           If  your rule order is set to 'explicit', the authentication is
520           performed in a similar fashion to rule order 'deny,allow', with the
521           added restriction that your host/username combination must be listed
522           in the allow rules, and not listed in the deny rules. This is the
523           most secure means of using Allow/Deny rules, and was available in
524           Apache by specifying allow and deny rules without setting any order.
525 
526    $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
527           The general format for the rules is as such:
528                 <'allow' | 'deny'> <username> [from] <ipmask>
529           If you wish to match all users, it is possible to use a '%' as a
530           wildcard in the username field.
531           There are a few shortcuts you can use in the ipmask field as well:
532                'all' -> 0.0.0.0/0
533                'localhost' -> 127.0.0.1/8
534           Having an empty rule list is equivalent to either using 'allow % from
535           all' if your rule order is set to 'deny,allow' or 'deny % from all'
536           if your rule order is set to 'allow,deny' or 'explicit'.
537           For the IP matching system, the following work:
538           xxx.xxx.xxx.xxx (an exact IP address)
539           xxx.xxx.xxx.[yyy-zzz] (an IP address range)
540           xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type IP
541           addresses)
542           But the following does not work:
543           xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
544 
545    $cfg['ServerDefault'] integer
546           If  you  have  more  than  one  server  configured, you can set
547           $cfg['ServerDefault'] to any one of them to autoconnect to that
548           server when phpMyAdmin is started, or set it to 0 to be given a list
549           of servers without logging in.
550           If you have only one server configured, $cfg['ServerDefault'] MUST be
551           set to that server.
552 
553    $cfg['OBGzip'] string/boolean
554           Defines whether to use GZip output buffering for increased speed in
555           HTTP transfers.
556           Set  to  true/false  for enabling/disabling. When set to 'auto'
557           (string),  phpMyAdmin tries to enable output buffering and will
558           automatically disable it, if your browser has some problems with
559           buffering. IE6 with a certain patch is known to cause data corruption
560           having enabled buffering.
561 
562    $cfg['PersistentConnections'] boolean
563           Whether persistent connections should be used or not (mysql_connect
564           or mysql_pconnect).
565 
566    $cfg['ExecTimeLimit'] integer [number of seconds]
567           Set the number of seconds a script is allowed to run. If seconds is
568           set to zero, no time limit is imposed.
569           This setting is used while importing/exporting dump files but has no
570           effect when PHP is running in safe mode.
571 
572    $cfg['SkipLockedTables'] boolean
573           Mark used tables and make it possible to show databases with locked
574           tables (since 3.23.30).
575 
576    $cfg['ShowSQL'] boolean
577           Defines  whether  SQL-queries generated by phpMyAdmin should be
578           displayed or not.
579 
580    $cfg['AllowUserDropDatabase'] boolean
581           Defines whether normal users (non-administrator) are allowed to
582           delete their own database or not. If set as FALSE, the link "Drop
583           Database" will not be shown, and even a "DROP DATABASE mydatabase"
584           will be rejected. Quite practical for ISP's with many customers.
585 
586    $cfg['Confirm'] boolean
587           Whether a warning ("Are your really sure...") should be displayed
588           when you're about to lose data.
589 
590    $cfg['LoginCookieRecall'] boolean
591           Define whether the previous login should be recalled or not in cookie
592           authentication mode.
593 
594    $cfg['UseDbSearch'] boolean
595           Define whether the "search string inside database" is enabled or not.
596 
597    $cfg['IgnoreMultiSubmitErrors'] boolean
598           Define whether phpMyAdmin will continue executing a multi-query
599           statement if one of the queries fails. Default is to abort execution.
600 
601    $cfg['VerboseMultiSubmit'] boolean
602           Define whether phpMyAdmin will output the results of each query of a
603           multi-query  statement  embedded  into the SQL output as inline
604           comments. Defaults to TRUE.
605 
606    $cfg['AllowArbitraryServer'] boolean
607           If enabled allows you to login to arbitrary server using cookie auth.
608           NOTE: Please use this carefully, as this may allow to access MySQL
609           servers behind firewall where your http server is placed.
610 
611    $cfg['LeftFrameLight'] boolean
612           Defines whether to use select-based menu and display only the current
613           tables in the left frame (smaller page). Only in Non-Lightmode you
614           can   use   the   feature   to  display  nested  folders  using
615           $cfg['LeftFrameTableSeparator']
616 
617    $cfg['LeftFrameTableSeparator'] string
618           Defines a string to be used to nest table spaces. Defaults to '__'.
619           This means if you have tables like 'first__second__third' this will
620           be shown as a three-level hierarchie like: first > second > third. If
621           set to FALSE or empty, the feature is disabled. NOTE: You shall not
622           use this Separator in a table name at the beginning or end of a table
623           name, or multiple times after another without any other characters in
624           between.
625 
626    $cfg['LeftFrameTableLevel'] string
627           Defines how many sublevels should be displayed when splitting up
628           tables by the above Separator.
629 
630    $cfg['ShowTooltip'] boolean
631           Defines whether to display table comment as tool-tip in left frame or
632           not.
633 
634    $cfg['ShowTooltipAliasDB'] boolean
635           If tool-tips are enabled and a DB comment is set, this will flip the
636           comment and the real name. That means, if you have a table called
637           'user0001' and add the comment 'MyName' on it, you will see the name
638           'MyName' used consequently in the left frame and the tool-tip shows
639           the real name of the DB.
640 
641    $cfg['ShowTooltipAliasTB'] boolean/string
642           Same as $cfg['ShowTooltipAliasDB'], except this works for table
643           names. When setting this to 'nested', the Alias of the Tablename is
644           only   used   to   split/nest   the  tables  according  to  the
645           $cfg['LeftFrameTableSeparator'] directive. So only the folder is
646           called like the Alias, the tablename itself stays the real tablename.
647 
648    $cfg['LeftDisplayLogo'] boolean
649           Defines whether to display the phpMyAdmin logo at the top of the left
650           frame or not. Defaults to TRUE.
651 
652    $cfg['LeftDisplayServers'] boolean
653           Defines whether to display a server choice at the top of the left
654           frame or not. Defaults to FALSE.
655 
656    $cfg['DisplayServersList'] boolean
657           Defines whether to display this server choice as links instead of in
658           a drop-down. Defaults to FALSE (drop-down).
659 
660    $cfg['ShowStats'] boolean
661           Defines whether to display space usage and statistics about databases
662           and tables or not.
663           Note that statistics requires at least MySQL 3.23.3 and that, at this
664           date, MySQL doesn't return such information for Berkeley DB tables.
665 
666    $cfg['ShowMysqlInfo'] boolean
667           $cfg['ShowMysqlVars'] boolean
668           $cfg['ShowPhpInfo'] boolean
669           $cfg['ShowChgPassword'] boolean
670           Defines whether to display the "MySQL runtime information", "MySQL
671           system variables", "PHP information" and "Change password " links or
672           not for simple users at the starting main (right) frame. This setting
673           does not check MySQL commands entered directly.
674           Please note that to block the usage of phpinfo() in scripts, you have
675           to put this in your php.ini:
676               disable_functions = phpinfo()
677           Also note that enabling the "Change password " link has no effect
678           with "config" authentication mode: because of the hard coded password
679           value in the configuration file, end users can't be allowed to change
680           their passwords.
681 
682    $cfg['SuggestDBName'] boolean
683           Defines whether to suggest a database name on the "Create Database"
684           form or to keep the textfield empty.
685 
686    $cfg['ShowBlob'] boolean
687           Defines whether BLOB fields are shown when browsing a table's content
688           or not.
689 
690    $cfg['NavigationBarIconic'] boolean
691           Defines whether navigation bar buttons contain text or symbols only.
692 
693    $cfg['ShowAll'] boolean
694           Defines whether an user should be displayed a "show all (records)"
695           button in browse mode or not.
696 
697    $cfg['MaxRows'] integer
698           Number of rows displayed when browsing a result set. If the result
699           set contains more rows, Previous/Next links will be shown.
700 
701    $cfg['Order'] string [DESC|ASC|SMART]
702           Defines whether fields are displayed in ascending (ASC) order, in
703           descending  (DESC)  order  or in a "smart" (SMART) order - I.E.
704           descending order for fields of type TIME, DATE, DATETIME & TIMESTAMP,
705           ascending order else- by default.
706 
707    $cfg['ProtectBinary'] boolean or string
708           Defines whether BLOB or BINARY fields are protected from edition when
709           browsing a table's content or not. Valid values are:
710           - FALSE to allow edition of all fields;
711           - blob to allow edition of all fields except BLOBS;
712           - all to disallow edition of all BINARY or BLOB fields.
713 
714    $cfg['ShowFunctionFields'] boolean
715           Defines whether MySQL functions fields should be displayed or not in
716           edit/insert mode.
717 
718    $cfg['CharEditing'] string
719           Defines which type of editing controls should be used for CHAR and
720           VARCHAR fields. Possible values are:
721 
722           + input - this allows to limit size of text to size of field in
723             MySQL, but has problems with newlines in fields
724           + textarea - no problems with newlines in fields, but also no length
725             limitations
726 
727           Default is old behavior so input.
728 
729    $cfg['ZipDump'] boolean
730           $cfg['GZipDump'] boolean
731           $cfg['BZipDump'] boolean
732           Defines whether to allow the use of zip/GZip/BZip2 compression when
733           creating a dump file or not.
734 
735    $cfg['CompressOnFly'] boolean
736           Defines  whether to allow on the fly compression for GZip/BZip2
737           compressed exports. This doesn't affect smaller dumps and allows to
738           create larger dumps, that won't fit otherwise in memory due to php
739           memory limit. Produced files contain more GZip/BZip2 headers, but all
740           normal programs handle this correctly.
741 
742    $cfg['LightTabs'] string
743           If set to True, do use less graphically intense tabs on the top of
744           the mainframe.
745 
746    $cfg['PropertiesIconic'] string
747           If set to True, will display icons instead of text for db and table
748           properties links (like 'Browse', 'Select', 'Insert', ...).
749           Can be set to 'both' if you want icons AND text.
750           When set to False, will only show text.
751 
752    $cfg['PropertiesNumColumns'] integer
753           How  many columns will be utilized to display the tables on the
754           database property view? Default is 1 column. When setting this to a
755           value larger than 1, the type of the database will be omitted for
756           more display space.
757 
758    $cfg['DefaultTabServer'] string
759           Defines the tab displayed by default on server view. Possible values:
760           "main.php"     (recommended     for     multi-user     setups),
761           "server_databases.php","server_status.php","server_variables.php",
762           "server_privileges.php" or "server_processlist.php".
763 
764    $cfg['DefaultTabDatabase'] string
765           Defines the tab displayed by default on database view. Possible
766           values:    "db_details_structure.php",    "db_details.php"   or
767           "db_search.php".
768 
769    $cfg['DefaultTabTable'] string
770           Defines the tab displayed by default on table view. Possible values:
771           "tbl_properties_structure.php",           "tbl_properties.php",
772           "tbl_select.php" or "tbl_change.php".
773 
774    $cfg['MySQLManualBase'] string
775           If  set to an URL which points to the MySQL documentation (type
776           depends on $cfg['MySQLManualType']), appropriate help links are
777           generated.
778           See MySQL Documentation page for more information about MySQL manuals
779           and their types.
780 
781    $cfg['MySQLManualType'] string
782           Type of MySQL documentation:
783 
784           + old - old style used in phpMyAdmin 2.3.0 and earlier
785           + searchable - "Searchable, with user comments"
786           + chapters - "HTML, one page per chapter"
787           + big - "HTML, all on one page"
788           + none - do not show documentation links
789 
790    $cfg['DefaultLang'] string
791           Defines  the default language to use, if not browser-defined or
792           user-defined.
793           See the select_lang.inc.php scri