Documentation.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
   4 <!-- $Id$ -->
   5 <!--
   6     vim: expandtab ts=4 sw=4 sts=4 tw=78
   7 -->
   8
   9 <head>
  10     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  11     <title>phpMyAdmin 2.6.4-dev - Documentation</title>
  12     <link rel="stylesheet" type="text/css" href="docs.css" />
  13 </head>
  14
  15 <body>
  16 <a name="top"></a><br />
  17
  18 <div class="header">
  19 <hr noshade="noshade" width="100%" />
  20     <a href="#top">Top</a> &nbsp;-&nbsp;
  21     <a href="#require">Requirements</a> &nbsp;-&nbsp;
  22     <a href="#intro">Introduction</a> &nbsp;-&nbsp;
  23     <a href="#setup">Installation</a> &nbsp;-&nbsp;
  24     <a href="#config">Configuration</a>
  25     <br />
  26     <a href="#transformations">Transformations</a> &nbsp;-&nbsp;
  27     <a href="#faq">FAQ</a> &nbsp;-&nbsp;
  28     <a href="#developers">Developers</a> &nbsp;-&nbsp;
  29     <a href="#credits">Credits</a> &nbsp;-&nbsp;
  30     <a href="translators.html">Translators</a>
  31 <hr noshade="noshade" width="100%" />
  32 </div>
  33
  34 <h1>phpMyAdmin 2.6.4-dev Documentation</h1>
  35
  36
  37 <!-- TOP MENU -->
  38 <ul>
  39     <li>
  40         <a href="http://www.phpmyadmin.net/">
  41             SourceForge phpMyAdmin project page&nbsp;&nbsp;&nbsp;[ http://www.phpmyadmin.net/ ]
  42         </a>
  43     </li>
  44     <li>
  45         Local documents:
  46         <ul>
  47             <li>Version history: <a href="ChangeLog">ChangeLog</a></li>
  48             <li>General notes: <a href="README">README</a></li>
  49             <li>License: <a href="LICENSE">LICENSE</a></li>
  50         </ul>
  51     </li>
  52     <li>
  53         Documentation version:
  54         <i>$Id$</i>
  55     </li>
  56 </ul>
  57
  58
  59 <!-- REQUIREMENTS -->
  60 <a name="require"></a><br />
  61 <h2>Requirements</h2>
  62
  63 <ul>
  64     <li>
  65         <b>PHP</b>
  66         <ul>
  67             <li>You need PHP 4.1.0 or newer (<a href="#faqphp5">*</a>)</li>
  68             <li>If you want to display inline thumbnails of JPEGs with the
  69                 original aspect ratio, you also need GD2 support in PHP</li>
  70             <li>Starting with phpMyAdmin 2.6.1, MIME-based transformations
  71                 that use an external program need PHP 4.3.0 or newer</li>
  72         </ul>
  73     </li>
  74     <li>
  75         <b>MySQL</b> 3.23.32 or newer (<a href="#faqmysqlversions">details</a>);
  76     </li>
  77     <li>
  78         Not really a requirement but a <b>strong suggestion</b>:
  79         if you are using
  80         the &quot;cookie&quot; authentication method, having the <tt>mcrypt</tt>
  81         PHP extension on your web server accelerates not only the login
  82         phase but every other action that you do in phpMyAdmin.
  83     </li>
  84     <li>
  85         a web-browser (doh!).
  86     </li>
  87 </ul>
  88
  89
  90 <!-- INTRODUCTION -->
  91 <a name="intro"></a><br />
  92 <h2>Introduction</h2>
  93
  94 <p>
  95     phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
  96     a single database. To accomplish the latter you'll need a properly set up
  97     MySQL user who can read/write only the desired database. It's up to you to
  98     look up the appropriate part in the MySQL manual.<br />
  99     Currently phpMyAdmin can:
 100 </p>
 101
 102 <ul>
 103     <li>create and drop databases</li>
 104     <li>create, copy, drop, rename and alter tables</li>
 105     <li>do table maintenance</li>
 106     <li>delete, edit and add fields</li>
 107     <li>execute any SQL-statement, even batch-queries</li>
 108     <li>manage keys on fields</li>
 109     <li>load text files into tables</li>
 110     <li>create (*) and read dumps of tables</li>
 111     <li>export (*) data to CSV, XML and Latex formats</li>
 112     <li>administer multiple servers</li>
 113     <li>manage MySQL users and privileges</li>
 114     <li>check referential integrity in MyISAM tables</li>
 115     <li>using Query-by-example (QBE), create complex queries automatically connecting required tables</li>
 116     <li>create PDF graphics of your Database layout</li>
 117     <li>search globally in a database or a subset of it</li>
 118     <li>transform stored data into any format using a set of predefined functions,
 119         like displaying BLOB-data as image or download-link or ...</li>
 120     <li>support InnoDB tables and foreign keys <a href="#faq3_6">(see FAQ 3.6)</a></li>
 121     <li>support mysqli, the improved MySQL extension <a href="#faqmysqlversions">(see FAQ 1.17)</a></li>
 122     <li>
 123         communicate in
 124         <a href="./translators.html">50 different languages</a>
 125     </li>
 126 </ul>
 127
 128 <p class="footnote">
 129     (*)&nbsp;
 130         phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps
 131         and CSV exports if you use PHP4&nbsp;>=&nbsp;4.0.4 with Zlib support
 132         (<tt>--with-zlib</tt>) and/or Bzip2 support (<tt>--with-bz2</tt>).
 133 </p>
 134
 135
 136 <!-- INSTALLATION -->
 137 <a name="setup"></a><br />
 138 <h2>Installation</h2>
 139
 140 <p>
 141     <span class="important">NOTE: phpMyAdmin does not apply any special security
 142     methods to the MySQL database server. It is still the system administrator's job to
 143     grant permissions on the MySQL databases properly. </span>phpMyAdmin's
 144     &quot;Privileges&quot; page can be used for this.
 145 </p>
 146
 147 <p>
 148     <span class="important">Warning for Mac users:</span>if you are on a MacOS
 149     version before OS X, StuffIt unstuffs with Mac formats.<br />
 150     So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
 151     before uploading them to your server, as PHP seems not to like Mac-style
 152     end of lines character (&quot;<tt>\r</tt>&quot;).
 153 </p>
 154
 155 <h3>Quick Install</h3>
 156 <ol>
 157     <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
 158          <tt>tar -xzvf phpMyAdmin_x.x.x.tar.gz</tt> in your webserver's
 159          document root. If you don't have direct access to your document root,
 160          put the files in a directory on your local machine, and, after step 3,
 161          transfer the directory on your web server using, for example, ftp.</li>
 162     <li> Ensure that all the scripts have the appropriate owner (if PHP is
 163          running in safe mode, having some scripts with an owner different
 164          from the owner of other scripts will be a
 165          problem). See <a href="#faq4_2">FAQ 4.2</a> for suggestions.</li>
 166     <li> Open the file <tt>config.inc.php</tt> in your favorite editor and change
 167          the values for host, user, password and authentication mode to fit
 168          your environment. Here, &quot;host&quot; means the MySQL server.
 169          Have a look at
 170          <a href="#config">Configuration section</a> for an
 171          explanation of all values. Please also read the remaining of this
 172          Installation section for information about authentication modes
 173          and the linked-tables infrastructure.</li>
 174     <li> It is recommended that you protect the directory in which you
 175          installed phpMyAdmin (unless it's on a closed intranet, or you wish to
 176          use HTTP or cookie authentication), for example with HTTP-AUTH (in a
 177          <i>.htaccess</i> file). See the
 178          <a href="#faqmultiuser">multi-user sub-section of the FAQ</a>
 179          for additional information, especially <a href="#faq4_4">FAQ 4.4</a>.</li>
 180     <li> Open the file
 181          <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/index.php</i>
 182          in your browser. phpMyAdmin should now display a welcome screen
 183          and your databases, or a login dialog if using HTTP or cookie
 184          authentication mode.</li>
 185 </ol>
 186 <a name="linked-tables"></a>
 187 <h3>Linked-tables infrastructure</h3>
 188  <p>
 189      For a whole set of new features (bookmarks, comments, SQL-history,
 190      PDF-generation, field contents transformation, etc.)
 191      you need to create a set of special tables. Those tables can be located
 192      in your own database, or in a central database for a multi-user
 193      installation (this database would then be accessed by the controluser,
 194      so no other user should have rights to it).
 195      <br /> <br />
 196      Please look at your scripts/
 197          directory, where you should find a file called <i>create_tables.sql</i>.
 198          (If you are using a Windows server, pay special attention to <a href="#faq1_23">FAQ 1.23</a>).
 199      <br /> <br />
 200          If your MySQL server's version is 4.1.2 or later, please use
 201          <i>create_tables_mysql_4_1_2+.sql</i> instead, for a new installation.
 202      <br /> <br />
 203          If you already had this infrastructure and upgraded to MySQL 4.1.2
 204          or later, please use <i>upgrade_tables_mysql_4_1_2+.sql</i>.
 205      <br /> <br />
 206          You can use your phpMyAdmin to create the tables for you. Please be
 207          aware that you may need special (administrator) privileges to create
 208          the database and tables, and that the script may need some tuning,
 209          depending on the database name.
 210      <br /> <br />
 211       After having imported the <i>create_tables.sql</i> file,
 212       you should specify the table names in your <i>config.inc.php</i> file. The directives
 213          used for that can be found in the <a href="#config">Configuration section</a>.
 214          You will also need to have a controluser with the proper rights to
 215          those tables (see section <i>Using authentication modes</i> below).
 216  </p>
 217
 218 <h3>Upgrading from an older version</h3>
 219 <ul>
 220     <li>
 221         You can safely copy your older <i>config.inc.php</i> over a new one, if
 222         you can live with default values for possible new parameters (you can
 223         check release notes to see what new features were added). This
 224         compatibility will stay for long time, current version supports
 225         importing config files from 2.2 and maybe even older (nobody has tried
 226         that).
 227     </li>
 228 </ul>
 229
 230 <h3>Using authentication modes</h3>
 231 <ul>
 232     <li>HTTP and cookie authentication modes are recommended in a <b>multi-user
 233         environment</b> where you want to give users access to their own
 234         database and don't want them to play around with others.
 235         <br />
 236         Nevertheless be aware that MS Internet Explorer seems to be really
 237         buggy about cookies, at least till version 6. And PHP 4.1.1 is also a
 238         bit buggy in this area!<br />
 239         Even in a <b>single-user environment</b>, you might prefer to use
 240         HTTP or cookie mode so that your user/password pair are not in clear
 241         in the configuration file.<br /><br /></li>
 242
 243     <li>HTTP and cookie authentication modes are more secure: the MySQL
 244         login information does not need to be set in the phpMyAdmin
 245         configuration file
 246         (except possibly for the <a href="#controluser">controluser</a>).
 247         <br />
 248         However, keep in mind that the password travels in plain text, unless
 249         you are using the HTTPS protocol.
 250         <br />
 251         In cookie mode, the password is stored, encrypted with the blowfish
 252         algorithm, in a temporary cookie.
 253         <br /><br /></li>
 254
 255     <li>
 256         <b>Note: starting with phpMyAdmin 2.6.1, configuring the controluser
 257         to enable HTTP and cookie authentication applies <i>only
 258         to MySQL servers older than 4.1.2</i>.</b>
 259         <br /><br />
 260         For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
 261         <b>only</b> the <tt>SELECT</tt> privilege on the <i>mysql.user (all
 262         columns except &quot;Password&quot;)</i>, <i>mysql.db (all
 263         columns)</i>, <i>mysql.host (all columns)</i> and
 264         <i>mysql.tables_priv (all columns except
 265         &quot;Grantor&quot; &amp; &quot;Timestamp&quot;) </i>tables.<br /> You
 266         must specify the details for the <a href="#controluser">controluser</a>
 267         in the <i>config.inc.php</i> file under the
 268         <tt>$cfg['Servers'][$i]['controluser']</tt>&amp;
 269         <tt>$cfg['Servers'][$i]['controlpass']</tt> settings.<br /> The
 270         following example assumes you want to use <tt>pma</tt> as the
 271         controluser and <tt>pmapass</tt> as the controlpass, but <b>this is
 272         only an example: use something else in your file!</b><br /> Of course
 273         you have to replace <tt>localhost</tt> by the webserver's host if it's
 274         not the same as the MySQL server's one.
 275         <pre>
 276
 277 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
 278 GRANT SELECT (
 279     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
 280     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
 281     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
 282     Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
 283     Execute_priv, Repl_slave_priv, Repl_client_priv
 284     ) ON mysql.user TO 'pma'@'localhost';
 285 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
 286 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
 287 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
 288     ON mysql.tables_priv TO 'pma'@'localhost';
 289         </pre>
 290         If you are using an old MySQL version (below 4.0.2), please replace
 291         the first GRANT SELECT query by this one:
 292         <pre>
 293
 294 GRANT SELECT (
 295     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
 296     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
 297     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
 298     ) ON mysql.user TO 'pma'@'localhost';
 299         </pre>
 300         ... and if you want to use the many new relation and bookmark
 301         features:
 302         <pre>
 303
 304 GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO 'pma'@'localhost';
 305         </pre>
 306         (this of course requires you to have a special DB for phpMyAdmin, the
 307         contents will be explained later)<br />
 308         Of course, the above queries only work if your MySQL version supports
 309         the GRANT command. This is the case since 3.22.11.
 310     </li>
 311     <li>
 312         Then each of the <i>true</i> users should be granted a set of
 313         privileges on a set of particular databases. Normally you shouldn't
 314         give global privileges to an ordinary user, unless you understand
 315         the impact of those privileges (for example, you are creating
 316         a superuser).<br />
 317         For example, to grant the user <i>real_user</i> with
 318         all privileges on the database <i>user_base</i>:<br />
 319         &nbsp;&nbsp;&nbsp;<tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';</tt>
 320         <br />
 321         What the user may now do is controlled entirely by the MySQL user
 322         management system.<br />
 323         With HTTP or cookie authentication mode, you don't need to fill the
 324         user/password fields inside the <tt>$cfg['Servers']</tt> array.<br />
 325     </li>
 326 </ul>
 327
 328 <h4>'http' authentication mode</h4>
 329 <ul>
 330     <li>Was called 'advanced' in versions before 2.2.3.</li>
 331     <li>Introduced in 1.3.0, it uses Basic HTTP authentication method and
 332         allows you to login as any valid MySQL user.</li>
 333     <li>Is supported with PHP running as an Apache module. For IIS (ISAPI)
 334         support using CGI PHP, see <a href="#faq1_32">FAQ 1.32</a>.</li>
 335     <li>See also <a href="#faq4_4">FAQ 4.4</a> about not using the <i>.htaccess</i> mechanism along
 336         with 'http' authentication mode.</li>
 337 </ul>
 338
 339 <h4>'cookie' authentication mode</h4>
 340 <ul>
 341     <li>You can use this method as a replacement for the HTTP
 342         authentication (for example, if you're running IIS).
 343     </li>
 344     <li>Obviously, the user must enable cookies in the browser.</li>
 345     <li>With this mode, the user can truly logout of phpMyAdmin and login back
 346         with the same username.</li>
 347     <li>If you want to login to arbitrary server see
 348     <tt><a href="#AllowArbitraryServer">$cfg['AllowArbitraryServer']</a></tt> directive.</li>
 349     <li>See also the <a href="#require">requirements</a> section for a way
 350         to improve the interface speed while using this mode.</li>
 351 </ul>
 352
 353 <h4>'config' authentication mode</h4>
 354 <ul>
 355     <li>This mode is the less secure one because it requires you to fill the
 356         <tt><a href="#servers_user">$cfg['Servers'][$i]['user']</a></tt> and
 357         <tt><a href="#servers_user">$cfg['Servers'][$i]['password']</a></tt> fields.<br />
 358         But you don't need to setup a &quot;controluser&quot; here:
 359         using the <tt><a href="#servers_only_db">$cfg['Servers'][$i]['only_db']</a></tt> might be enough.</li>
 360     <li>In the <a href="#faqmultiuser">ISP FAQ</a> section, there is an entry explaining how to protect
 361         your configuration file.<br /></li>
 362     <li>For additional security in this mode, you may wish to consider the
 363         Host authentication <tt><a href="#servers_allowdeny_order">$cfg['Servers'][$i]['AllowDeny']['order']</a></tt>
 364         and <tt><a href="#servers_allowdeny_rules">$cfg['Servers'][$i]['AllowDeny']['rules']</a></tt> configuration
 365         directives.</li>
 366 </ul>
 367
 368
 369 <!-- CONFIGURATION -->
 370 <a name="config"></a><br />
 371 <h2>Configuration</h2>
 372
 373 <p>
 374     <span class="important">Warning for Mac users:</span> PHP seems not to like
 375     Mac end of lines character (&quot;<tt>\r</tt>&quot;). So ensure you choose
 376     the option that allows to use the *nix end of line character
 377     (&quot;<tt>\n</tt>&quot;) in your text editor before registering a script
 378     you have modified.
 379 </p>
 380
 381 <p>
 382     <span class="important">Configuration note:</span>
 383     Almost all configurable data is placed in <i>config.inc.php</i>. The
 384     parameters which relate to design (like colors) are placed in
 385     <tt>themes/themename/layout.inc.php</tt>. You
 386     might also want to modify <i>config.footer.inc.php</i> and
 387     <i>config.header.inc.php</i> files to add your site specific code to be
 388     included on start and end of each page.
 389 </p>
 390
 391 <dl>
 392     <dt><b>$cfg['PmaAbsoluteUri']</b> string</dt>
 393     <dd>
 394         Sets here the complete URL (with full path) to your phpMyAdmin
 395         installation's directory.
 396         E.g. <tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/</tt>.
 397         <br /><br />
 398         Starting with version 2.3.0, it is advisable to try leaving this
 399         blank. In most cases phpMyAdmin automatically detects the proper
 400         setting. Additional details are in the configuration file. If you
 401         leave it blank, see the notes for
 402         <tt>$cfg['PmaAbsoluteUri_DisableWarning']</tt>; you probably want
 403         to change that to <tt>TRUE</tt>.
 404         <br /><br />
 405         Don't forget the slash at the end of your URL. The URL must contain
 406         characters that are valid for a URL, and on some servers, the path
 407         is case-sensitive.
 408         <br /><br />
 409     </dd>
 410     <dt><b>$cfg['PmaAbsoluteUri_DisableWarning']</b> boolean</dt>
 411     <dd>
 412     By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
 413     detects your absolute URI automatically, we display a warning to remind
 414     you. If you have tested the automatic detection, and it works perfectly
 415     for your setup, then you can set this variable to squelch the warning.
 416         <br /><br />
 417     </dd>
 418
 419     <dt><b>$cfg['PmaNoRelation_DisableWarning']</b> boolean</dt>
 420     <dd>
 421         Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
 422         with master / foreign - tables (see
 423         <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>).
 424         <br />
 425         If you tried to set this up and it does not work for you, have a look on
 426         the &quot;Structure&quot; page of one database where you would like to
 427         use it. You will find a link that will analyze why those features have
 428         been disabled.<br />
 429         If you do not want to use those features set this variable to
 430         <tt>TRUE</tt> to stop this message from appearing.
 431         <br /><br />
 432     </dd>
 433
 434     <dt><b>$cfg['blowfish_secret']</b> string</dt>
 435     <dd>
 436         Starting with version 2.5.2, the 'cookie' auth_type uses blowfish
 437         algorithm to encrypt the password.
 438         <br />
 439         If you are using the 'cookie' auth_type, enter here a random
 440         passphrase of your choice. It will be used internally by the blowfish
 441         algorithm: you won't be prompted for this passphrase. The maximum
 442         number of characters for this parameter seems to be 46.
 443   </dd>
 444
 445     <dt><b>$cfg['Servers']</b> array</dt>
 446     <dd>
 447         Since version 1.4.2, phpMyAdmin supports the administration of multiple
 448         MySQL servers.
 449         Therefore, a $cfg['Servers']-array has been added which contains
 450         the login information for the different servers. The first
 451         <tt>$cfg['Servers'][$i]['host']</tt> contains the hostname of the first
 452         server, the second <tt>$cfg['Servers'][$i]['host']</tt> the hostname of
 453         the second server, etc.
 454         If you have only one server to administer, simply leave free the
 455         hostname of the other $cfg['Server']-entries.
 456         <br /><br />
 457     </dd>
 458
 459     <dt><b>$cfg['Servers'][$i]['host']</b> string</dt>
 460     <dd>
 461         The hostname or IP address of your $i-th MySQL-server. E.g. localhost.
 462         <br /><br />
 463     </dd>
 464
 465     <dt><b>$cfg['Servers'][$i]['port']</b> string</dt>
 466     <dd>
 467         The port-number of your $i-th MySQL-server. Default is 3306 (leave
 468         blank). If you use &quot;localhost&quot; as the hostname, MySQL
 469         ignores this port number and connects with the socket, so if you want
 470         to connect to a port different from the default port, use
 471         &quot;127.0.0.1&quot; or the real hostname in
 472         $cfg['Servers'][$i]['host'].
 473         <br /><br />
 474     </dd>
 475
 476     <dt><b>$cfg['Servers'][$i]['socket']</b> string</dt>
 477     <dd>
 478         The path to the socket to use. Leave blank for default.<br />
 479         To use the socket feature you must run PHP 3.0.10 or more.
 480         <br /><br />
 481     </dd>
 482
 483     <dt><b>$cfg['Servers'][$i]['connect_type']</b> string</dt>
 484     <dd>
 485         What type connection to use with the MySQL server. Your options are
 486         <tt>'socket'</tt> &amp; <tt>'tcp'</tt>. It defaults to 'tcp' as that
 487         is nearly guaranteed to be available on all MySQL servers, while
 488         sockets are not supported on some platforms.
 489         <br /><br />
 490         To use the socket mode, your MySQL server must be on the same machine
 491         as the Web server.
 492         <br /><br />
 493     </dd>
 494
 495     <dt><b>$cfg['Servers'][$i]['extension']</b> string</dt>
 496     <dd>
 497         What php MySQL extension to use for the connection. Valid options are:
 498         <br /><br />
 499         <tt><i>mysql</i></tt>&nbsp;:&nbsp;
 500         The classic MySQL extension. This is the recommended and default
 501         method at this time.
 502         <br /><br />
 503         <tt><i>mysqli</i></tt>&nbsp;:&nbsp;
 504         The improved MySQL extension. This extension became available
 505         with php 5.0.0 and is the recommended way to connect to a server
 506         running MySQL 4.1.x.
 507         <br />
 508         Note: phpMyAdmin's MySQL 4.1 support is experimental!
 509         <br /><br />
 510     </dd>
 511
 512     <dt><b>$cfg['Servers'][$i]['compress']</b> boolean</dt>
 513     <dd>
 514         Whether to use a compressed protocol for the MySQL server connection
 515         or not (experimental).<br />
 516         This feature requires PHP&nbsp;&gt;=&nbsp;4.3.0.
 517         <br /><br />
 518     </dd>
 519
 520     <dt>
 521 <a name="controluser"></a><br />
 522         <b>$cfg['Servers'][$i]['controluser']</b> string<br />
 523         <b>$cfg['Servers'][$i]['controlpass']</b> string
 524     </dt>
 525     <dd>
 526         <i>Note: starting with phpMyAdmin 2.6.1, configuring the controluser
 527         to enable HTTP and cookie authentication applies only
 528         to MySQL servers older than 4.1.2.</i>
 529         <br /><br />
 530         This special account is used for 2 distinct purposes: to make possible
 531         all relational features
 532         (see <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>) and, for a
 533         MySQL server older than 4.1.2, to enable a multi-user installation
 534         (http or cookie authentication mode).
 535         <br /><br />
 536         When using HTTP or cookie authentication modes (or 'config'
 537         authentication mode since phpMyAdmin 2.2.1), you need to supply the
 538         details of a MySQL account that has <tt>SELECT</tt> privilege on the
 539         <i>mysql.user (all columns except &quot;Password&quot;)</i>,
 540         <i>mysql.db (all columns)</i> &amp; <i>mysql.tables_priv (all columns
 541         except &quot;Grantor&quot; &amp; &quot;Timestamp&quot;) </i>tables.
 542         This account is used to check what databases the user will see at
 543         login.
 544         <br />
 545         Please see the <a href="#setup">install section</a> on
 546         &quot;Using authentication modes&quot; for more information.
 547         <br /><br />
 548         Note that if you try login to phpMyAdmin with this
 549         &quot;controluser&quot;, you could get some errors, depending the exact
 550         privileges you gave to the &quot;controluser&quot;. phpMyAdmin does not
 551         support a direct login with the &quot;controluser&quot;.
 552         <br /><br />
 553         In phpMyAdmin versions before 2.2.5, those were called
 554         &quot;stduser/stdpass&quot;.
 555         <br /><br />
 556     </dd>
 557
 558     <dt><b>$cfg['Servers'][$i]['auth_type']</b> string
 559     <tt>['http'|'cookie'|'config']</tt></dt>
 560     <dd>
 561         Whether config or cookie or http authentication should be used for this
 562         server.
 563
 564         <ul>
 565             <li>
 566                 'config' authentication
 567                 (<tt>$auth_type&nbsp;=&nbsp;'config'</tt>) is the plain old
 568                 way: username and password are stored in
 569                 <i>config.inc.php</i>.
 570             </li>
 571             <li>
 572                 'cookie' authentication mode
 573                 (<tt>$auth_type&nbsp;=&nbsp;'cookie'</tt>) as introduced in
 574                 2.2.3 allows you to log in as any valid MySQL user with the
 575                 help of cookies. Log name and password are stored in
 576                 cookies during the session and password is deleted when it
 577                 ends. This can also allow you to login in arbitrary server if
 578                 <tt><a href="#AllowArbitraryServer">$cfg['AllowArbitraryServer']</a></tt> enabled.
 579             </li>
 580             <li>
 581                 'http' authentication (was called 'advanced' in older versions)
 582                 (<tt>$auth_type&nbsp;=&nbsp;'http'</tt>) as introduced in 1.3.0
 583                 allows you to log in as any valid MySQL user via HTTP-Auth.
 584             </li>
 585         </ul><br />
 586
 587         Please see the <a href="#setup">install section</a> on &quot;Using authentication modes&quot;
 588         for more information.
 589         <br /><br />
 590     </dd>
 591     <dt>
 592 <a name="servers_user"></a><br />
 593         <b>$cfg['Servers'][$i]['user']</b> string<br />
 594         <b>$cfg['Servers'][$i]['password']</b> string
 595     </dt>
 596     <dd>
 597         The user/password-pair which phpMyAdmin will use to connect to this
 598         MySQL-server. This user/password pair is not needed when HTTP or
 599         cookie authentication is used, and should be empty.<br /><br />
 600     </dd>
 601     <dt>
 602 <a name="servers_only_db"></a><br />
 603 <b>$cfg['Servers'][$i]['only_db']</b> string or array</dt>
 604     <dd>
 605         If set to a (an array of) database name(s), only this (these) database(s)
 606         will be shown to the user. Since phpMyAdmin 2.2.1, this/these
 607         database(s) name(s) may contain MySQL wildcards characters
 608         (&quot;_&quot; and &quot;%&quot;): if you want to use literal instances
 609         of these characters, escape them (I.E. use <tt>'my\_db'</tt> and not
 610         <tt>'my_db'</tt>).<br />
 611         This setting is an efficient way to lower the server load since the
 612         latter does not need to send MySQL requests to build the available
 613         database list. But <span class="important">it does not replace the
 614         privileges rules of the MySQL database server</span>. If set, it just
 615         means only these databases will be displayed but
 616         <span class="important">not that all other databases can't be used.</span>
 617         <br /><br />
 618         An example of using more that one database:
 619         <tt>$cfg['Servers'][$i]['only_db'] = array('db1', 'db2'); </tt>
 620         <br /><br />
 621         As of phpMyAdmin 2.5.5 the order inside the array is used for sorting the
 622         databases in the left frame, so that you can individually arrange your databases.<br />
 623         If you want to have certain databases at the top, but don't care about the others, you do not
 624         need to specify all other databases. Use:
 625         <tt>$cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '*');</tt>
 626         instead to tell phpMyAdmin that it should display db3 and db4 on top, and the rest in alphabetic
 627         order.
 628     </dd>
 629
 630     <dt><b>$cfg['Servers'][$i]['verbose']</b> string</dt>
 631     <dd>
 632         Only useful when using phpMyAdmin with multiple server entries. If set,
 633         this string will be displayed instead of the hostname in the pull-down
 634         menu on the main page. This can be useful if you want to show only
 635         certain databases on your system, for example.
 636         <br /><br />
 637     </dd>
 638
 639     <dt>
 640         <a name="pmadb"></a><br />
 641         <b>$cfg['Servers'][$i]['pmadb']</b> string
 642     </dt>
 643     <dd>
 644         The name of the database containing the linked-tables infrastructure.
 645         <br /><br />
 646         See the <a href="#linked-tables">Linked-tables infrastructure</a>
 647         section in this document to see the benefits of this infrastructure,
 648         and for a quick way of creating this database and the needed tables.
 649         <br /><br />
 650         If you are the only user of this phpMyAdmin installation, you can
 651         use your current database to store those special tables; in this
 652         case, just put your current database name in
 653         <tt>$cfg['Servers'][$i]['pmadb']</tt>. For a multi-user installation,
 654         set this parameter to the name of your central database containing
 655         the linked-tables infrastructure.
 656         <br /><br />
 657     </dd>
 658
 659     <dt>
 660         <a name="bookmark"></a><br />
 661         <b>$cfg['Servers'][$i]['bookmarktable']</b> string
 662     </dt>
 663     <dd>
 664         Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can be
 665         useful for queries you often run.<br /><br />
 666
 667         To allow the usage of this functionality:
 668         <ul>
 669             <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
 670             <li>enter the table name in
 671                 <tt>$cfg['Servers'][$i]['bookmarktable']</tt></li>
 672         </ul><br />
 673     </dd>
 674
 675     <dt>
 676         <a name="relation"></a><br />
 677         <b>$cfg['Servers'][$i]['relation']</b> string
 678     </dt>
 679     <dd>
 680         Since release 2.2.4 you can describe, in a special 'relation' table,
 681         which field is a key in another table (a foreign key). phpMyAdmin
 682         currently uses this to
 683         <ul>
 684            <li>
 685               make clickable, when you browse the master table, the data values
 686               that point to the foreign table;
 687            </li>
 688            <li>
 689               display in an optional tool-tip the &quot;display field&quot;
 690               when browsing the master table, if you move the mouse to a column
 691               containing a foreign key (use also the 'table_info' table);<br />
 692               (see <a href="#faqdisplay">FAQ 6.7</a>)
 693            </li>
 694            <li>
 695               in edit/insert mode, display a drop-down list of possible
 696               foreign keys (key value and &quot;display field&quot; are
 697               shown)<br />
 698               (see <a href="#faq6_21">FAQ 6.21</a>)
 699            </li>
 700            <li>
 701               display links on the table properties page, to check referential
 702               integrity (display missing foreign keys) for each described key;
 703            </li>
 704            <li>
 705               in query-by-example, create automatic joins (see <a href="#faq6_6">FAQ 6.6</a>)
 706            </li>
 707            <li>
 708               enable you to get a PDF schema of your database (also uses the
 709               table_coords table).
 710            </li>
 711         </ul>
 712         <br />
 713
 714         The keys can be numeric or character.
 715         <br /><br />
 716
 717         To allow the usage of this functionality:
 718         <ul>
 719             <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
 720             <li>
 721                 put the relation table name in
 722                 <tt>$cfg['Servers'][$i]['relation']</tt>
 723             </li>
 724             <li>
 725                 now as normal user open phpMyAdmin and for each one of your
 726                 tables where you want to use this feature, click
 727                 &quot;Structure/Relation view/&quot; and choose foreign fields.
 728             </li>
 729         </ul><br />
 730         Please note that in the current version, <tt>master_db</tt>
 731         must be the same as <tt>foreign_db</tt>.  Those fields have been put in
 732         future development of the cross-db relations.<br /><br />
 733     </dd>
 734
 735     <dt>
 736         <a name="table_info"></a><br />
 737         <b>$cfg['Servers'][$i]['table_info']</b> string
 738     </dt>
 739     <dd>
 740         Since release 2.3.0 you can describe, in a special 'table_info'
 741         table, which field is to be displayed as a tool-tip when moving the
 742         cursor over the corresponding key.
 743         <br />
 744         This configuration variable will hold the name of this special
 745         table.
 746         To allow the usage of this functionality:
 747         <ul>
 748             <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
 749             <li>
 750                 put the table name in
 751                 <tt>$cfg['Servers'][$i]['table_info']</tt>
 752             </li>
 753             <li>
 754                 then for each table where you want to use this feature,
 755                 click &quot;Structure/Relation view/Choose field to display&quot;
 756                 to choose the field.
 757             </li>
 758         </ul><br />
 759         Usage tip: <a href="#faqdisplay">Display field</a>.
 760         <br /><br />
 761     </dd>
 762     <dt>
 763         <a name="table_coords"></a><br />
 764         <b>$cfg['Servers'][$i]['table_coords']</b> string<br />
 765         <b>$cfg['Servers'][$i]['pdf_pages']</b> string
 766     </dt>
 767     <dd>
 768         Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
 769         the relations between your tables. To do this it needs two tables
 770         &quot;pdf_pages&quot; (storing information about the available PDF
 771         pages) and &quot;table_coords&quot; (storing coordinates where each
 772         table will be placed on a PDF schema output).
 773         <br /><br />
 774         You must be using the &quot;relation&quot; feature.
 775         <br /><br />
 776         To allow the usage of this functionality:
 777         <ul>
 778             <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
 779             <li>
 780                 put the correct table names in
 781                 <tt>$cfg['Servers'][$i]['table_coords']</tt> and
 782                 <tt>$cfg['Servers'][$i]['pdf_pages']</tt>
 783             </li>
 784         </ul><br />
 785         Usage tips: <a href="#faqpdf">PDF output</a>.
 786         <br /><br />
 787     </dd>
 788
 789     <dt>
 790         <a name="col_com"></a><br />
 791         <b>$cfg['Servers'][$i]['column_info']</b> string
 792     </dt>
 793     <dd>
 794         <!-- This part requires a content update! -->
 795         Since release 2.3.0 you can store comments to describe each column
 796         for each table. These will then be shown on the &quot;printview&quot;.
 797         <br /><br />
 798         Starting with release 2.5.0, comments are consequently used on the table property
 799         pages and table browse view, showing up as tool-tips above the column name (properties page)
 800         or embedded within the header of table in browse view. They can also be shown
 801         in a table dump. Please see the relevant configuration directives later on.
 802         <br /><br />
 803         Also new in release 2.5.0 is a MIME-transformation system which is also based on
 804         the following table structure. See <a href="#transformations">Transformations</a>
 805         for further information. To use the MIME-transformation system, your column_info
 806         table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
 807         <br /><br />
 808         To allow the usage of this functionality:
 809         <ul>
 810             <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
 811             <li>
 812                 put the table name in
 813                 <tt>$cfg['Servers'][$i]['column_info']</tt>
 814             </li>
 815             <li>
 816                 to update your PRE-2.5.0 Column_comments Table use this:<br />
 817                 <tt>
 818                 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ALTER TABLE `pma_column_comments` <br />
 819                 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `mimetype` VARCHAR( 255 ) NOT NULL ,<br />
 820                 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `transformation` VARCHAR( 255 ) NOT NULL ,<br />
 821                 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;<br />
 822                 </tt>
 823                 and remember that the Variable in <i>config.inc.php</i> has been renamed
 824                 from <br /><tt>$cfg['Servers'][$i]['column_comments']</tt> to <tt>$cfg['Servers'][$i]['column_info']</tt>
 825             </li>
 826         </ul><br />
 827     </dd>
 828
 829     <dt>
 830         <a name="history"></a><br />
 831         <b>$cfg['Servers'][$i]['history']</b> string
 832     </dt>
 833     <dd>
 834         Since release 2.5.0 you can store your SQL history, which means all queries you
 835         entered manually into the phpMyAdmin interface. If you don't want to use a table-
 836         based history, you can use the JavaScript-based history. Using that, all your
 837         history items are deleted when closing the window.<br /><br />
 838
 839         Using <b>$cfg['QueryHistoryMax']</b> you can specify an amount of history items
 840         you want to have on hold. On every login, this list gets cut to the maximum amount.
 841         <br /><br />
 842
 843         The query history is only available if you use the JavaScript-based query window,
 844         see <b>$cfg['QueryFrame']</b>.
 845         <br /><br />
 846
 847         To allow the usage of this functionality:
 848         <ul>
 849             <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
 850             <li>
 851                 put the table name in
 852                 <tt>$cfg['Servers'][$i]['history']</tt>
 853             </li>
 854         </ul><br />
 855     </dd>
 856
 857     <dt>
 858         <b>$cfg['Servers'][$i]['verbose_check']</b> boolean
 859     </dt>
 860     <dd>
 861         Because release 2.5.0 introduced the new MIME-transformation support, the
 862         column_info table got enhanced with three new fields. If the above variable is
 863         set to <tt>TRUE</tt> (default) phpMyAdmin will check if you have the latest table structure
 864         available. If not, it will emit a warning to the superuser.<br /><br />
 865
 866         You can disable this checking behavior by setting the variable to false, which
 867         should offer a performance increase.<br /><br />
 868
 869         Recommended to set to FALSE, when you are sure, your table structure is up to date.
 870         <br /><br />
 871     </dd>
 872     <dt>
 873         <b>$cfg['Servers'][$i]['AllowRoot']</b> boolean
 874     </dt>
 875     <dd>
 876         Whether to allow root access, This is just simplification of rules below.
 877         <br /><br />
 878     </dd>
 879     <dt>
 880 <a name="servers_allowdeny_order"></a><br />
 881         <b>$cfg['Servers'][$i]['AllowDeny']['order']</b> string
 882     </dt>
 883     <dd>
 884         If your rule order is empty, then IP authentication is disabled.
 885         <br /><br />
 886         If your rule order is set to <tt>'deny,allow'</tt> then the system
 887         applies all deny rules followed by allow rules.
 888         Access is allowed by default. Any client which does not match a Deny
 889         command or does match an Allow command will be allowed access to the
 890         server.
 891         <br /><br />
 892         If your rule order is set to <tt>'allow,deny'</tt> then the system
 893         applies all allow rules followed by deny rules. Access is denied by
 894         default.  Any client which does not match an Allow directive or does
 895         match a Deny directive will be denied access to the server.
 896         <br /><br />
 897         If your rule order is set to 'explicit', the authentication is
 898         performed in a similar fashion to rule order 'deny,allow', with the
 899         added restriction that your host/username combination <b>must</b> be
 900         listed in the <i>allow</i> rules, and not listed in the <i>deny</i>
 901         rules. This is the <b>most</b> secure means of using Allow/Deny rules,
 902         and was available in Apache by specifying allow and deny rules without
 903         setting any order.
 904         <br /><br />
 905     </dd>
 906     <dt>
 907 <a name="servers_allowdeny_rules"></a><br />
 908         <b>$cfg['Servers'][$i]['AllowDeny']['rules']</b> array of strings
 909     </dt>
 910     <dd>
 911         The general format for the rules is as such:<br />
 912         <tt>
 913         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 914         &lt;'allow' | 'deny'&gt; &lt;username&gt; [from] &lt;ipmask&gt;
 915         </tt>
 916         <br /><br />
 917
 918         If you wish to match all users, it is possible to use a <tt>'%'</tt> as
 919         a wildcard in the <i>username</i> field.<br />
 920         There are a few shortcuts you can use in the <i>ipmask</i> field as
 921         well:<br />
 922         <tt>
 923         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'all' -&gt; 0.0.0.0/0<br />
 924         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'localhost' -&gt; 127.0.0.1/8
 925         </tt>
 926         <br /><br />
 927
 928         Having an empty rule list is equivalent to either using
 929         <tt>'allow % from all'</tt> if your rule order is set to
 930         <tt>'deny,allow'</tt> or <tt>'deny % from all'</tt> if your rule order
 931         is set to <tt>'allow,deny'</tt> or <tt>'explicit'</tt>.
 932         <br /><br />
 933
 934         For the IP matching system, the following work:<br />
 935         <tt>xxx.xxx.xxx.xxx</tt>        (an exact IP address)<br />
 936         <tt>xxx.xxx.xxx.[yyy-zzz]</tt>  (an IP address range)<br />
 937         <tt>xxx.xxx.xxx.xxx/nn</tt>     (CIDR, Classless Inter-Domain Routing type IP addresses)<br />
 938         But the following does not work:<br />
 939         <tt>xxx.xxx.xxx.xx[yyy-zzz]</tt> (partial IP address range)
 940         <br /><br />
 941     </dd>
 942
 943     <dt><b>$cfg['ServerDefault']</b> integer</dt>
 944     <dd>
 945         If you have more than one server configured, you can set
 946         <tt>$cfg['ServerDefault']</tt> to any one of them to autoconnect to
 947         that server when phpMyAdmin is started, or set it to 0 to be given a
 948         list of servers without logging in.<br />
 949         If you have only one server configured, <tt>$cfg['ServerDefault']</tt>
 950         MUST be set to that server.
 951         <br /><br />
 952     </dd>
 953
 954     <dt><b>$cfg['OBGzip'] </b>string/boolean</dt>
 955     <dd>
 956         Defines whether to use GZip output buffering for increased
 957         speed in HTTP transfers.<br />
 958         Set to true/false for enabling/disabling. When set to 'auto' (string),
 959         phpMyAdmin tries to enable output buffering and will automatically disable
 960         it, if your browser has some problems with buffering. IE6 with a certain patch
 961         is known to cause data corruption having enabled buffering.
 962         <br /><br />
 963     </dd>
 964
 965     <dt><b>$cfg['PersistentConnections'] </b>boolean</dt>
 966     <dd>
 967         Whether persistent connections should be used or not (mysql_connect or
 968         mysql_pconnect).
 969         <br /><br />
 970     </dd>
 971
 972     <dt><b>$cfg['ExecTimeLimit'] </b>integer [number of seconds]</dt>
 973     <dd>
 974         Set the number of seconds a script is allowed to run. If seconds is set
 975         to zero, no time limit is imposed.<br />
 976         This setting is used while importing/exporting dump files but has no
 977         effect when PHP is running in safe mode.
 978         <br /><br />
 979     </dd>
 980
 981     <dt><b>$cfg['SkipLockedTables'] </b>boolean</dt>
 982     <dd>
 983         Mark used tables and make it possible to show databases with locked
 984         tables (since 3.23.30).
 985         <br /><br />
 986     </dd>
 987
 988     <dt><b>$cfg['ShowSQL'] </b>boolean</dt>
 989     <dd>
 990         Defines whether SQL-queries generated by phpMyAdmin should be displayed
 991         or not.
 992         <br /><br />
 993     </dd>
 994
 995     <dt><b>$cfg['AllowUserDropDatabase'] </b>boolean</dt>
 996     <dd>
 997         Defines whether normal users (non-administrator) are allowed to
 998         delete their own database or not. If set as FALSE, the link &quot;Drop
 999         Database&quot; will not be shown, and even a &quot;DROP DATABASE
1000         mydatabase&quot; will be rejected. Quite practical for ISP's with many
1001         customers.
1002         <br /><br />
1003   </dd>
1004
1005     <dt><b>$cfg['Confirm'] </b>boolean</dt>
1006     <dd>
1007         Whether a warning (&quot;Are your really sure...&quot;) should be
1008         displayed when you're about to lose data.
1009         <br /><br />
1010     </dd>
1011
1012     <dt><b>$cfg['LoginCookieRecall'] </b>boolean</dt>
1013     <dd>
1014         Define whether the previous login should be recalled or not in cookie
1015         authentication mode.
1016         <br /><br />
1017     </dd>
1018
1019     <dt><b>$cfg['UseDbSearch'] </b>boolean</dt>
1020     <dd>
1021         Define whether the "search string inside database" is enabled or not.
1022         <br /><br />
1023     </dd>
1024
1025     <dt><b>$cfg['IgnoreMultiSubmitErrors'] </b>boolean</dt>
1026     <dd>
1027         Define whether phpMyAdmin will continue executing a multi-query
1028         statement if one of the queries fails. Default is to abort execution.
1029         <br /><br />
1030     </dd>
1031
1032     <dt><b>$cfg['VerboseMultiSubmit'] </b>boolean</dt>
1033     <dd>
1034         Define whether phpMyAdmin will output the results of each query of a
1035         multi-query statement embedded into the SQL output as inline comments.
1036         Defaults to <tt>TRUE</tt>.
1037         <br /><br />
1038     </dd>
1039     <dt>
1040 <a name="AllowArbitraryServer"></a><br />
1041 <b>$cfg['AllowArbitraryServer'] </b>boolean</dt>
1042     <dd>
1043         If enabled allows you to login to arbitrary server using cookie auth.
1044         <br /><br />
1045         <b>NOTE:</b> Please use this carefully, as this may allow to access
1046         MySQL servers behind firewall where your http server is placed.
1047         <br /><br />
1048     </dd>
1049
1050     <dt><b>$cfg['LeftFrameLight']</b> boolean</dt>
1051     <dd>
1052         Defines whether to use select-based menu and display only the current
1053         tables in the left frame (smaller page).
1054         Only in Non-Lightmode you can use the feature to display nested folders
1055         using $cfg['LeftFrameTableSeparator']
1056         <br /><br />
1057     </dd>
1058
1059     <dt><b>$cfg['LeftFrameTableSeparator']</b> string</dt>
1060     <dd>
1061         Defines a string to be used to nest table spaces. Defaults to '__'.
1062         This means if you have tables like 'first__second__third' this will be
1063         shown as a three-level hierarchie like: first &gt; second &gt; third.
1064         If set to FALSE or empty, the feature is disabled.  NOTE: You shall
1065         not use this Separator in a table name at the beginning or end of a
1066         table name, or multiple times after another without any other
1067         characters in between.
1068         <br /><br />
1069     </dd>
1070
1071     <dt><b>$cfg['LeftFrameTableLevel']</b> string</dt>
1072     <dd>
1073         Defines how many sublevels should be displayed when splitting
1074         up tables by the above Separator.
1075         <br /><br />
1076     </dd>
1077
1078     <dt><b>$cfg['ShowTooltip'] </b>boolean</dt>
1079     <dd>
1080         Defines whether to display table comment as tool-tip in left frame or
1081         not.
1082         <br /><br />
1083     </dd>
1084
1085     <dt><b>$cfg['ShowTooltipAliasDB'] </b>boolean</dt>
1086     <dd>
1087         If tool-tips are enabled and a DB comment is set, this will flip the
1088         comment and the real name. That means, if you have a table called
1089         'user0001' and add the comment 'MyName' on it, you will see the name
1090         'MyName' used consequently in the left frame and the tool-tip shows
1091         the real name of the DB.
1092         <br /><br />
1093     </dd>
1094
1095     <dt><b>$cfg['ShowTooltipAliasTB'] </b>boolean/string</dt>
1096     <dd>
1097         Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1098
1099         When setting this to 'nested', the Alias of the Tablename is only used
1100         to split/nest the tables according to the $cfg['LeftFrameTableSeparator']
1101         directive. So only the folder is called like the Alias, the tablename itself
1102         stays the real tablename.
1103         <br /><br />
1104     </dd>
1105     <dt><b>$cfg['LeftDisplayLogo'] </b>boolean</dt>
1106     <dd>Defines whether to display the phpMyAdmin logo at the top of the left frame or not.
1107 Defaults to <tt>TRUE</tt>. <br />
1108     <br />
1109     </dd>
1110     <dt><b>$cfg['LeftDisplayServers'] </b>boolean</dt>
1111     <dd>Defines whether to display a server choice at the top of the left frame or not.
1112 Defaults to FALSE. <br />
1113     <br />
1114     </dd>
1115     <dt><b>$cfg['DisplayServersList'] </b>boolean</dt>
1116     <dd>Defines whether to display this server choice as links instead of in a drop-down.
1117 Defaults to FALSE (drop-down). <br />
1118     <br />
1119     </dd>
1120     <dt><b>$cfg['ShowStats'] </b>boolean</dt>
1121     <dd>
1122         Defines whether to display space usage and statistics about databases
1123         and tables or not.<br />
1124         Note that statistics requires at least MySQL 3.23.3 and that, at this
1125         date, MySQL doesn't return such information for Berkeley DB tables.
1126         <br /><br />
1127     </dd>
1128
1129     <dt>
1130         <b>$cfg['ShowMysqlInfo'] </b>boolean<br />
1131         <b>$cfg['ShowMysqlVars'] </b>boolean<br />
1132         <b>$cfg['ShowPhpInfo'] </b>boolean<br />
1133         <b>$cfg['ShowChgPassword'] </b>boolean
1134     </dt>
1135     <dd>
1136         Defines whether to display the &quot;MySQL runtime information&quot;,
1137         &quot;MySQL system variables&quot;, &quot;PHP information&quot; and
1138         &quot;Change password &quot; links or not for simple users at the
1139         starting main (right) frame. This setting does not check MySQL
1140         commands entered directly.
1141         <br /><br />
1142
1143         Please note that to block the usage of phpinfo() in scripts, you
1144         have to put this in your <i>php.ini</i>:<br />
1145         &nbsp;&nbsp;&nbsp;&nbsp;<tt>disable_functions = phpinfo()</tt>
1146         <br /><br />
1147
1148         Also note that enabling the &quot;Change password &quot; link has no
1149         effect with &quot;config&quot; authentication mode: because of the
1150         hard coded password value in the configuration file, end users can't
1151         be allowed to change their passwords.
1152         <br /><br />
1153     </dd>
1154
1155     <dt><b>$cfg['SuggestDBName']</b> boolean</dt>
1156     <dd>
1157         Defines whether to suggest a database name on the
1158         &quot;Create Database&quot; form or to keep the textfield empty.
1159         <br /><br />
1160     </dd>
1161
1162     <dt><b>$cfg['ShowBlob'] </b>boolean</dt>
1163     <dd>
1164         Defines whether <tt>BLOB</tt> fields are shown when browsing a table's
1165         content or not.
1166         <br /><br />
1167     </dd>
1168
1169     <dt><b>$cfg['NavigationBarIconic'] </b>boolean</dt>
1170     <dd>
1171         Defines whether navigation bar buttons contain text or symbols only.
1172         <br /><br />
1173     </dd>
1174
1175     <dt><b>$cfg['ShowAll'] </b>boolean</dt>
1176     <dd>
1177         Defines whether an user should be displayed a
1178         &quot;show all (records)&quot; button in browse mode or not.
1179         <br /><br />
1180     </dd>
1181
1182     <dt><b>$cfg['MaxRows'] </b>integer</dt>
1183     <dd>
1184         Number of rows displayed when browsing a result set. If the result set
1185         contains more rows, Previous/Next links will be shown.
1186         <br /><br />
1187     </dd>
1188
1189     <dt><b>$cfg['Order'] </b>string [<tt>DESC</tt>|<tt>ASC</tt>|<tt>SMART</tt>]</dt>
1190     <dd>
1191         Defines whether fields are displayed in ascending (<tt>ASC</tt>) order,
1192         in descending (<tt>DESC</tt>) order or in a &quot;smart&quot;
1193         (<tt>SMART</tt>) order - I.E. descending order for fields of type TIME,
1194         DATE, DATETIME &amp; TIMESTAMP, ascending order else- by default.
1195         <br /><br />
1196     </dd>
1197
1198     <dt><b>$cfg['ProtectBinary'] </b>boolean or string</dt>
1199     <dd>
1200         Defines whether <tt>BLOB</tt> or <tt>BINARY</tt> fields are protected
1201         from edition when browsing a table's content or not.
1202         Valid values are:<br />
1203         - <tt>FALSE</tt> to allow edition of all fields;<br />
1204         - <tt>blob</tt> to allow edition of all fields except <tt>BLOBS</tt>;
1205           <br />
1206         - <tt>all</tt> to disallow edition of all <tt>BINARY</tt> or
1207           <tt>BLOB</tt> fields.
1208         <br /><br />
1209     </dd>
1210
1211     <dt><b>$cfg['ShowFunctionFields'] </b>boolean</dt>
1212     <dd>
1213         Defines whether MySQL functions fields should be displayed or not in
1214         edit/insert mode.
1215         <br /><br />
1216     </dd>
1217
1218     <dt><b>$cfg['CharEditing'] </b>string</dt>
1219     <dd>
1220         Defines which type of editing controls should be used for CHAR and
1221         VARCHAR fields. Possible values are:
1222         <ul>
1223             <li>
1224                 input - this allows to limit size of text to size of field in
1225                 MySQL, but has problems with newlines in fields
1226             </li>
1227             <li>
1228                 textarea - no problems with newlines in fields, but also no
1229                 length limitations
1230             </li>
1231         </ul>
1232         Default is old behavior so input.
1233         <br /><br />
1234         </dd>
1235
1236     <dt><b>$cfg['InsertRows']</b> integer</dt>
1237     <dd>
1238         Defines the maximum number of concurrent entries for the Insert page.
1239     </dd>
1240
1241     <dt><b>$cfg['ForeignKeyMaxLimit']</b> integer</dt>
1242     <dd>
1243     If there are fewer items than this in the set of foreign keys, then a
1244     drop-down box of foreign keys is presented, in the style described by the
1245     <b>$cfg['ForeignKeyDropdownOrder']</b> setting.
1246     </dd>
1247
1248     <dt><b>$cfg['ForeignKeyDropdownOrder']</b> array</dt>
1249     <dd>
1250         For the foreign key drop-down fields, there are several methods of
1251         display, offering both the key and value data. The contents of the
1252         array should be one or both of the following strings:
1253         <i>'content-id'</i>, <i>'id-content'</i>.
1254     </dd>
1255
1256     <dt>
1257         <b>$cfg['ZipDump'] </b>boolean<br />
1258         <b>$cfg['GZipDump'] </b>boolean<br />
1259         <b>$cfg['BZipDump'] </b>boolean
1260     </dt>
1261     <dd>
1262         Defines whether to allow the use of zip/GZip/BZip2 compression when
1263         creating a dump file or not.
1264         <br /><br />
1265     </dd>
1266
1267     <dt>
1268         <b>$cfg['CompressOnFly'] </b>boolean<br />
1269     </dt>
1270     <dd>
1271         Defines whether to allow on the fly compression for GZip/BZip2
1272         compressed exports. This doesn't affect smaller dumps and allows to
1273         create larger dumps, that won't fit otherwise in memory due to php
1274         memory limit. Produced files contain more GZip/BZip2 headers, but all
1275         normal programs handle this correctly.
1276         <br /><br />
1277     </dd>
1278
1279     <dt><b>$cfg['LightTabs'] </b>string</dt>
1280     <dd>
1281         If set to True, do use less graphically intense tabs on the top of the
1282         mainframe.
1283         <br /><br />
1284     </dd>
1285
1286     <dt><b>$cfg['PropertiesIconic'] </b>string</dt>
1287     <dd>
1288         If set to True, will display icons instead of text for db and table
1289         properties links (like 'Browse', 'Select', 'Insert', ...).<br />
1290         Can be set to 'both' if you want icons AND text.<br />
1291         When set to False, will only show text.
1292         <br /><br />
1293     </dd>
1294
1295     <dt><b>$cfg['PropertiesNumColumns'] </b>integer</dt>
1296     <dd>
1297         How many columns will be utilized to display the tables on the
1298         database property view?  Default is 1 column. When setting this to a
1299         value larger than 1, the type of the database will be omitted for more
1300         display space.
1301         <br /><br />
1302     </dd>
1303
1304
1305     <dt><b>$cfg['DefaultTabServer'] </b>string</dt>
1306     <dd>
1307         Defines the tab displayed by default on server view. Possible
1308         values: &quot;main.php&quot; (recommended for multi-user setups),
1309         &quot;server_databases.php&quot;, &quot;server_status.php&quot;,
1310         &quot;server_variables.php&quot;, &quot;server_privileges.php&quot;
1311         or &quot;server_processlist.php&quot;.
1312         <br /><br />
1313     </dd>
1314
1315     <dt><b>$cfg['DefaultTabDatabase'] </b>string</dt>
1316     <dd>
1317         Defines the tab displayed by default on database view. Possible
1318         values: &quot;db_details_structure.php&quot;,
1319         &quot;db_details.php&quot; or &quot;db_search.php&quot;.
1320         <br /><br />
1321     </dd>
1322
1323     <dt><b>$cfg['DefaultTabTable'] </b>string</dt>
1324     <dd>
1325         Defines the tab displayed by default on table view. Possible
1326         values: &quot;tbl_properties_structure.php&quot;,
1327         &quot;tbl_properties.php&quot;, &quot;tbl_select.php&quot; or
1328         &quot;tbl_change.php&quot;.
1329         <br /><br />
1330     </dd>
1331
1332     <dt><b>$cfg['MySQLManualBase']</b> string</dt>
1333     <dd>
1334         If set to an URL which points to the MySQL documentation (type depends
1335         on <tt>$cfg['MySQLManualType']</tt>), appropriate help links are
1336         generated.
1337         <br />
1338         See <a href="http://www.mysql.com/documentation/index.html">MySQL
1339         Documentation page</a> for more information about MySQL manuals and
1340         their types.
1341         <br /><br />
1342     </dd>
1343
1344     <dt><b>$cfg['MySQLManualType']</b> string</dt>
1345     <dd>
1346          Type of MySQL documentation:
1347          <ul>
1348             <li>old - old style used in phpMyAdmin 2.3.0 and earlier</li>
1349             <li>searchable - &quot;Searchable, with user comments&quot;</li>
1350             <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1351             <li>big - &quot;HTML, all on one page&quot;</li>
1352             <li>none - do not show documentation links</li>
1353         </ul>
1354         <br /><br />
1355     </dd>
1356
1357     <dt><b>$cfg['DefaultLang'] </b>string</dt>
1358     <dd>
1359         Defines the default language to use, if not browser-defined or
1360         user-defined.<br />
1361         See the <i>select_lang.lib.php</i> script to know the valid values for
1362         this setting.
1363         <br /><br />
1364     </dd>
1365
1366     <dt><b>$cfg['Lang'] </b>string</dt>
1367     <dd>
1368         Force: always use this language (must be defined in the
1369         <i>select_lang.lib.php</i> script).
1370         <br /><br />
1371     </dd>
1372
1373     <dt><b>$cfg['DefaultCharset'] </b>string</dt>
1374     <dd>
1375         Default character set to use for recoding of MySQL queries. This must be
1376         enabled and it's described by <tt>$cfg['AllowAnywhereRecoding']</tt>
1377         option.<br />
1378         You can give here any character set which is in
1379         <tt>$cfg['AvailableCharsets']</tt> array and this is just default
1380         choice, user can select any of them.
1381         <br /><br />
1382     </dd>
1383
1384     <dt><b>$cfg['AllowAnywhereRecoding'] </b>boolean</dt>
1385     <dd>
1386         Allow character set recoding of MySQL queries. You need recode or iconv
1387         support (compiled in or module) in PHP to allow MySQL queries recoding
1388         and used language file must have it enabled (by default only these
1389         which are in Unicode, just to avoid losing some characters).
1390         <br /><br />
1391         Setting this to <tt>TRUE</tt> also activates a pull-down menu
1392         in the Export page, to choose the character set when exporting a file.
1393         <br /><br />
1394     </dd>
1395
1396     <dt><b>$cfg['RecodingEngine'] </b>string</dt>
1397     <dd>
1398         You can select here which functions will be used for character set
1399         conversion.
1400         Possible values are:<br />
1401         <ul>
1402             <li>auto   - automatically use available one (first is tested
1403                 iconv, then recode)</li>
1404             <li>iconv  - use iconv or libiconv functions</li>
1405             <li>recode - use recode_string function</li>
1406         </ul>
1407         Default is auto.
1408         <br /><br />
1409     </dd>
1410
1411     <dt><b>$cfg['IconvExtraParams'] </b>string</dt>
1412     <dd>
1413         Specify some parameters for iconv used in charset conversion. See
1414         <a href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1415         documentation</a> for details.
1416         <br /><br />
1417     </dd>
1418
1419     <dt><b>$cfg['AvailableCharsets'] </b>array</dt>
1420     <dd>
1421         Available character sets for MySQL conversion. You can add your own (any of
1422         supported by recode/iconv) or remove these which you don't use.
1423         Character sets will be shown in same order as here listed, so if you
1424         frequently use some of these move them to the top.
1425         <br /><br />
1426     </dd>
1427
1428     <dt><b>$cfg['GD2Available'] </b>string</dt>
1429     <dd>
1430         Specifies whether GD &gt;= 2 is available. If yes it can be used for
1431         MIME transformations.<br />
1432         Possible values are:<br />
1433         <ul>
1434             <li>
1435                 auto   - automatically detect, this is a bit expensive
1436                 operation for php &lt; 4.3.0 so it is preferred to change this
1437                 according to your server real possibilities
1438             </li>
1439             <li>yes - GD 2 functions can be used</li>
1440             <li>no - GD 2 function cannot be used</li>
1441         </ul>
1442         Default is auto.
1443         <br /><br />
1444     </dd>
1445
1446     <dt><b>$cfg['LeftWidth'] </b>integer</dt>
1447     <dd>
1448         Left frame width in pixel. See <tt>themes/themename/layout.inc.php</tt>.
1449         <br /><br />
1450     </dd>
1451
1452     <dt>
1453         <b>$cfg['LeftBgColor'] </b>string [HTML color]<br />
1454         <b>$cfg['RightBgColor'] </b>string [HTML color]
1455     </dt>
1456     <dd>
1457         The background colors (HTML) used for both the frames.
1458         See <tt>themes/themename/layout.inc.php</tt>.
1459         <br /><br />
1460     </dd>
1461
1462     <dt>
1463         <b>$cfg['RightBgImage'] </b>string
1464     </dt>
1465     <dd>
1466         The URI of the background image used for the right frame. It must be
1467         an absolute URI. See <tt>themes/themename/layout.inc.php</tt>.
1468     </dd>
1469
1470     <dt><b>$cfg['LeftPointerColor'] </b>string [HTML color]</dt>
1471     <dd>
1472         The color (HTML) used for the pointer in the left frame (does not work
1473         with Netscape 4). See <tt>themes/themename/layout.inc.php</tt>.
1474         <br /><br />
1475     </dd>
1476
1477     <dt><b>$cfg['LeftPointerEnable'] </b>boolean</dt>
1478     <dd>
1479         A value of <tt>TRUE</tt> activates the left pointer (when LeftFrameLight is <tt>FALSE</tt>).
1480         <br /><br />
1481     </dd>
1482
1483     <dt><b>$cfg['Border'] </b>integer</dt>
1484     <dd>
1485         The size of a table's border. See <tt>themes/themename/layout.inc.php</tt>.
1486         <br /><br />
1487     </dd>
1488
1489     <dt><b>$cfg['ThBgcolor'] </b>string [HTML color]</dt>
1490     <dd>
1491         The color (HTML) used for table headers. See <tt>themes/themename/layout.inc.php</tt>.
1492         <br /><br />
1493     </dd>
1494
1495     <dt><b>$cfg['BgcolorOne'] </b>string [HTML color]</dt>
1496     <dd>
1497         The color (HTML) #1 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1498         <br /><br />
1499     </dd>
1500
1501     <dt><b>$cfg['BgcolorTwo'] </b>string [HTML color]</dt>
1502     <dd>
1503         The color (HTML) #2 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1504         <br /><br />
1505     </dd>
1506
1507     <dt>
1508         <b>$cfg['BrowsePointerColor'] </b>string [HTML color]<br />
1509         <b>$cfg['BrowseMarkerColor'] </b>string [HTML color]
1510     </dt>
1511     <dd>
1512         The colors (HTML) uses for the pointer and the marker in browse mode
1513         (does not work with Netscape 4).<br />
1514         The former feature highlights the row over which your mouse is passing
1515         and the latter lets you visually mark/unmark rows by clicking on
1516         them.<br />
1517         See <tt>themes/themename/layout.inc.php</tt>.
1518         <br /><br />
1519     </dd>
1520
1521     <dt><b>$cfg['BrowsePointerEnable'] </b>boolean</dt>
1522     <dd>
1523         Whether to activate the browse pointer or not.
1524         <br /><br />
1525     </dd>
1526
1527     <dt><b>$cfg['BrowseMarkerEnable'] </b>boolean</dt>
1528     <dd>
1529         Whether to activate the browse marker or not.
1530         <br /><br />
1531     </dd>
1532
1533     <dt>
1534         <b>$cfg['TextareaCols'] </b>integer<br />
1535         <b>$cfg['TextareaRows'] </b>integer<br />
1536         <b>$cfg['CharTextareaCols'] </b>integer<br />
1537         <b>$cfg['CharTextareaRows'] </b>integer
1538     </dt>
1539     <dd>
1540         Number of columns and rows for the textareas.<br />
1541         This value will be emphasized (*2) for SQL query textareas and (*1.25) for
1542         SQL textareas inside the query window.<br />
1543         The Char* values are used for CHAR and VARCHAR editing (if configured
1544         via $cfg['CharEditing']).
1545         <br /><br />
1546     </dd>
1547
1548     <dt>
1549         <b>$cfg['LongtextDoubleTextarea'] </b>boolean<br />
1550     </dt>
1551     <dd>
1552         Defines whether textarea for LONGTEXT fields should have double size.
1553         <br /><br />
1554     </dd>
1555
1556     <dt>
1557         <b>$cfg['TextareaAutoSelect'] </b>boolean<br />
1558     </dt>
1559     <dd>
1560         Defines if the whole textarea of the query box will be selected on
1561         click.
1562         <br /><br />
1563     </dd>
1564     <dt>
1565 <a name="CtrlArrowsMoving"></a><br />
1566         <b>$cfg['CtrlArrowsMoving'] </b>boolean<br />
1567     </dt>
1568     <dd>
1569         Enable Ctrl+Arrows (Option+Arrows in Safari) moving between fields when editing?
1570         <br /><br />
1571     </dd>
1572
1573     <dt><b>$cfg['LimitChars'] </b>integer</dt>
1574     <dd>
1575         Maximal number of Chars showed in any non-numeric
1576         field on browse view. Can be turned off by a toggle button on the
1577         browse page.
1578         <br /><br />
1579     </dd>
1580
1581     <dt>
1582         <b>$cfg['ModifyDeleteAtLeft'] </b>boolean<br />
1583         <b>$cfg['ModifyDeleteAtRight'] </b>boolean
1584     </dt>
1585     <dd>
1586         Defines the place where modify and delete links would be put when
1587         tables contents are displayed (you may have them displayed both at the
1588         left and at the right).
1589         &quot;Left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
1590         and &quot;bottom&quot; with vertical display mode.
1591         <br /><br />
1592     </dd>
1593
1594     <dt><b>$cfg['DefaultDisplay'] </b>string<br />
1595         <b>$cfg['HeaderFlipType'] </b>string
1596     </dt>
1597     <dd>
1598         There are 3 display modes: horizontal, horizontalflipped and vertical.
1599         Define which one is displayed by default. The first mode displays each
1600         row on a horizontal line, the second rotates the headers by 90
1601         degrees, so you can use descriptive headers even though fields only
1602         contain small values and still print them out. The vertical mode sorts
1603         each row on a vertical lineup.
1604         <br /><br />
1605         The HeaderFlipType can be set to 'css' or 'faked'. When using 'css'
1606         the rotation of the header for horizontalflipped is done via CSS. If
1607         set to 'faked' PHP does the transformation for you, but of course this
1608         does not look as good as CSS.
1609         <br /><br />
1610     </dd>
1611     <dt>
1612
1613 <a name="DefaultPropDisplay"></a><br />
1614 <b>$cfg['DefaultPropDisplay'] </b>string</dt>
1615     <dd>
1616         When editing/creating new columns in a table all fields normally get
1617         lined up one field a line. (default: 'horizontal'). If you set this to
1618         'vertical' you can have each field lined up vertically beneath each
1619         other. You can save up a lot of place on the horizontal direction and
1620         no longer have to scroll.
1621         <br /><br />
1622     </dd>
1623
1624     <dt><b>$cfg['ShowBrowseComments'] </b>boolean<br />
1625         <b>$cfg['ShowPropertyComments'] </b>boolean<br />
1626     </dt>
1627     <dd>
1628         By setting the corresponding variable to <tt>TRUE</tt> you can enable the
1629         display of column comments in Browse or Property display. In browse
1630         mode, the comments are show inside the header. In property mode,
1631         comments are displayed using a CSS-formatted dashed-line below the
1632         name of the field. The comment is shown as a tool-tip for that field.
1633         <br /><br />
1634     </dd>
1635
1636     <dt><b>$cfg['UploadDir'] </b>string</dt>
1637     <dd>
1638         The name of the directory, where SQL files have been uploaded by other
1639         means than phpMyAdmin (for example, ftp).  Those files are available
1640         under a drop-down box when you click the database name, then the SQL
1641         tab.
1642         <br /><br />
1643         Please note that the file names must have the suffix &quot;.sql&quot;
1644         (or &quot;.sql.bz2&quot; or &quot;.sql.gz&quot; if support for
1645         compressed formats is enabled).
1646         <br /><br />
1647         This feature is useful when your file is too big to be uploaded via
1648         HTTP, or when file uploads are disabled in PHP.
1649         <br /><br />
1650         Please note that if PHP is running in safe mode, this directory must
1651         be owned by the same user as the owner of the phpMyAdmin scripts.
1652         <br /><br />
1653         See also <a href="#faq1_16">FAQ 1.16</a> for alternatives.
1654         <br /><br />
1655     </dd>
1656
1657     <dt><b>$cfg['docSQLDir'] </b>string</dt>
1658     <dd>
1659         The name of the directory, where docSQL files can be uploaded for
1660         import into phpMyAdmin.
1661         <br /><br />
1662         Please note that if PHP is running in safe mode, this directory must
1663         be owned by the same user as the owner of the phpMyAdmin scripts.
1664         <br /><br />
1665     </dd>
1666
1667     <dt><b>$cfg['SaveDir'] </b>string</dt>
1668     <dd>
1669         The name of the directory, where dumps can be saved.
1670         <br /><br />
1671         Please note that the directory has to be writable for user running
1672         webserver.
1673         <br /><br />
1674         Please note that if PHP is running in safe mode, this directory must
1675         be owned by the same user as the owner of the phpMyAdmin scripts.
1676         <br /><br />
1677     </dd>
1678
1679     <dt><b>$cfg['TempDir'] </b>string</dt>
1680     <dd>
1681         The name of the directory, where temporary files can be stored.
1682         <br /><br />
1683         This is needed for native MS Excel export, see <a href="#faq6_23">FAQ
1684         6.23</a>
1685         <br /><br />
1686     </dd>
1687
1688     <dt><b>$cfg['Export'] </b>array</dt>
1689     <dd>
1690         In this array are defined default parameters for export, names of
1691         items are similar to texts seen on export page, so you can easily
1692         identify what they mean.
1693         <br /><br />
1694     </dd>
1695
1696     <dt><b>$cfg['RepeatCells'] </b>integer</dt>
1697     <dd>
1698         Repeat the headers every X cells, or 0 to deactivate.
1699     <br /><br />
1700     </dd>
1701
1702     <dt><b>$cfg['QueryFrame'] </b>boolean<br />
1703         <b>$cfg['QueryFrameJS'] </b>boolean<br />
1704         <b>$cfg['QueryWindowWidth'] </b>integer<br />
1705         <b>$cfg['QueryWindowHeight'] </b>integer<br />
1706         <b>$cfg['QueryHistoryDB'] </b>boolean<br />
1707         <b>$cfg['QueryWindowDefTab'] </b>string<br />
1708         <b>$cfg['QueryHistoryMax'] </b>integer
1709     </dt>
1710     <dd>
1711         All those variables affect the query box feature. When
1712         $cfg['QueryFrame'] is set to true, a link or icon is displayed
1713         on the left panel. Clicking on it opens the query box, a direct
1714         interface to enter SQL queries.
1715         <br /><br />
1716         When $cfg['QueryFrameJS'] is set to true, clicking on that link opens
1717         the query box, a new custom sized browser window
1718         ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] - both integers
1719         for the size in pixels).
1720         Also, a click on [Edit] from the results page (in the &quot;Showing
1721         Rows&quot; section) opens the query box and puts the current query
1722         inside it.  If set to false, clicking on the link only opens the SQL
1723         input in the main frame.
1724         <br /><br />
1725         The usage of the JavaScript query window is recommended if you have a
1726         JavaScript enabled browser. Basic functions are used to exchange quite
1727         a few variables, so most 4th generation browsers should be capable to
1728         use that feature. It currently is only tested with Internet Explorer 6
1729         and Mozilla 1.x.
1730         <br /><br />
1731         If $cfg['QueryHistoryDB'] is set to <tt>TRUE</tt>, all your Queries are logged
1732         to a table, which has to be created by you (see <a
1733         href="#history">$cfg['Servers'][$i]['history']</a>).  If set to FALSE,
1734         all your queries will be appended to the form, but only as long as
1735         your window is opened they remain saved.
1736         <br /><br />
1737         When using the JavaScript based query window, it will always get
1738         updated when you click on a new table/db to browse and will focus if
1739         you click on "Edit SQL" after using a query. You can suppress updating
1740         the query window by checking the box "Do not overwrite this query from
1741         outside the window" below the query textarea. Then you can browse
1742         tables/databases in the background without losing the contents of the
1743         textarea, so this is especially useful when composing a query with
1744         tables you first have to look in. The checkbox will get automatically
1745         checked whenever you change the contents of the textarea. Please
1746         uncheck the button whenever you definitely want the query window to
1747         get updated even though you have made alterations.
1748         <br /><br />
1749         If $cfg['QueryHistoryDB'] is set to <tt>TRUE</tt> you can specify the amount of
1750         saved history items using $cfg['QueryHistoryMax'].
1751         <br /><br />
1752         The query window also has a custom tabbed look to group the features.
1753         Using the variable $cfg['QueryWindowDefTab'] you can specify the
1754         default tab to be used when opening the query window. It can be set to
1755         either 'sql', 'files', 'history' or 'full'.
1756         <br /><br />
1757     </dd>
1758
1759     <dt><b>$cfg['BrowseMIME'] </b>boolean</dt>
1760     <dd>
1761         Enable <a href="#transformations">MIME-transformations</a>.
1762     <br /><br />
1763     </dd>
1764
1765     <dt><b>$cfg['MaxExactCount'] </b>integer</dt>
1766     <dd>
1767         Determines for how large tables phpMyAdmin should get exact row count by
1768     <code>SELECT COUNT</code>. If approximate row count is smaller than this
1769     value, <code>SELECT COUNT</code> will be used, otherwise only value
1770     returned by <code>SHOW TABLE STATUS</code>. This has currently an impact
1771     only on InnoDB tables.
1772     <br /><br />
1773     </dd>
1774
1775     <dt><a name="wysiwyg"></a>
1776     <b>$cfg['WYSIWYG-PDF'] </b>boolean</dt>
1777     <dd>
1778         Utilizes a WYSIWYG editing control to easily place elements of a PDF
1779         page.  By clicking on the button 'toggle scratchboard' on the page
1780         where you edit x/y coordinates of those elements you can activate a
1781         scratchboard where all your elements are placed. By clicking on an
1782         element, you can move them around in the pre-defined area and the x/y
1783         coordinates will get updated dynamically. Likewise, when entering a
1784         new position directly into the input field, the new position in the
1785         scratchboard changes after your cursor leaves the input field.
1786         <br />
1787         You have to click on the 'OK'-button below the tables to save the new
1788         positions.  If you want to place a new element, first add it to the
1789         table of elements and then you can drag the new element around.
1790         <br />
1791         By changing the paper size and the orientation you can change the size
1792         of the scratchboard as well. You can do so by just changing the
1793         dropdown field below, and the scratchboard will resize automatically,
1794         without interfering with the current placement of the elements.
1795         <br />
1796         If ever an element gets out of range you can either enlarge the paper
1797         size or click on the 'reset' button to place all elements below each
1798         other.
1799         <br />
1800         <b>NOTE:</b> You have to use a recent browser like IE6 or Mozilla to
1801         get this control to work. The basic Drag&amp;Drop script functionality
1802         was kindly borrowed from www.youngpup.net and is underlying so
1803         specific license.
1804         <br /><br />
1805     </dd>
1806
1807     <dt><b>$cfg['NaturalOrder'] </b>boolean</dt>
1808     <dd>
1809         Sorts database and table names according to natural order (for example,
1810         t1, t2, t10). Currently implemented in the left panel (Light mode)
1811         and in Database view, for the table list.
1812     <br /><br />
1813     </dd>
1814
1815     <dt><b>$cfg['ShowHttpHostTitle'] </b>boolean</dt>
1816     <dd>
1817         Shows the HTTP host name in window's title bar.
1818     <br /><br />
1819     </dd>
1820
1821     <dt><b>$cfg['SetHttpHostTitle'] </b>string</dt>
1822     <dd>
1823         If <tt>$cfg['ShowHttpHostTitle']</tt> is <tt>TRUE</tt>, it shows the real
1824         HTTP host name, unless an alternate name is set here.
1825     <br /><br />
1826     </dd>
1827
1828     <dt><b>$cfg['ErrorIconic'] </b>boolean</dt>
1829     <dd>
1830         Uses icons for warnings, errors and informations.
1831     <br /><br />
1832     </dd>
1833
1834     <dt><b>$cfg['MainPageIconic'] </b>boolean</dt>
1835     <dd>
1836         Uses icons on main page in lists, on right panel top menu and menu tabs.
1837     <br /><br />
1838     </dd>
1839
1840     <dt><b>$cfg['ReplaceHelpImg'] </b>boolean</dt>
1841     <dd>
1842         Shows a help button instead of the &quot;Documentation&quot; message.
1843     <br /><br />
1844     </dd>
1845
1846     <dt><b>$cfg['ThemePath'] </b>string</dt>
1847     <dd>
1848         If theme manager is active, use this as the path of the subdirectory
1849         containing all the themes.
1850     <br /><br />
1851     </dd>
1852
1853     <dt><b>$cfg['ThemeManager'] </b>boolean</dt>
1854     <dd>
1855         Enables user-selectable themes. See <a href="#faqthemes">FAQ 2.7</a>.
1856     <br /><br />
1857     </dd>
1858
1859     <dt><b>$cfg['ThemeDefault'] </b>string</dt>
1860     <dd>
1861         The default theme (a subdirectory under <tt>cfg['ThemePath']</tt>).
1862     <br /><br />
1863     </dd>
1864
1865     <dt><b>$cfg['ThemePerServer'] </b>boolean</dt>
1866     <dd>
1867         Whether to allow different theme for each server.
1868     <br /><br />
1869     </dd>
1870
1871     <dt><b>$cfg['DefaultQueryTable']</b> string</dt>
1872     <dt><b>$cfg['DefaultQueryDatabase']</b> string</dt>
1873     <dd>
1874         Default queries that will be displayed in query boxes when user didn't
1875         specify any. Use %d for database name, %t for table name and %f for a
1876         comma separated list of field names. Note that %t and %f are only
1877         applicable to $cfg['DefaultQueryTable'].
1878         <br /><br />
1879     </dd>
1880
1881     <dt><b>$cfg['SQP']['fmtType']</b> string [<tt>html</tt>|<tt>none</tt>]</dt>
1882     <dd>
1883         The main use of the new SQL Parser is to pretty-print SQL queries. By
1884         default we use HTML to format the query, but you can disable this by
1885         setting this variable to <tt>'none'</tt>.
1886         <br /><br />
1887     </dd>
1888
1889     <dt><b>$cfg['SQP']['fmtInd']</b> float<br />
1890     <b>$cfg['SQP']['fmtIndUnit']</b> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
1891     <dd>
1892     For the pretty-printing of SQL queries, under some cases the part of a
1893     query inside a bracket is indented. By changing
1894     <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
1895     <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
1896     specifies the units of the indent amount that you specified. This is
1897     used via stylesheets.
1898     <br /><br />
1899     </dd>
1900
1901     <dt><b>$cfg['SQP']['fmtColor']</b> array of string tuples</dt>
1902     <dd>
1903     This array is used to define the colours for each type of element of
1904     the pretty-printed SQL queries. The tuple format is<br />
1905     <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
1906     If you specify an empty string for the color of a class, it is ignored
1907     in creating the stylesheet.
1908     You should not alter the class names, only the colour strings.<br />
1909     <b>Class name key:</b><br />
1910     <ul>
1911         <li><b>comment</b> Applies to all comment sub-classes</li>
1912         <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
1913         <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
1914         <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
1915         <li><b>digit</b> Applies to all digit sub-classes</li>
1916         <li><b>digit_hex</b> Hexadecimal numbers</li>
1917         <li><b>digit_integer</b> Integer numbers</li>
1918         <li><b>digit_float</b> Floating point numbers</li>
1919         <li><b>punct</b> Applies to all punctuation sub-classes</li>
1920         <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
1921         <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
1922         <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
1923         <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
1924         <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
1925         <li><b>alpha</b> Applies to all alphabetic classes</li>
1926         <li><b>alpha_columnType</b> Identifiers matching a column type</li>
1927         <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
1928         <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
1929         <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
1930         <li><b>alpha_variable</b> Identifiers matching a SQL variable <tt>"@foo"</tt></li>
1931         <li><b>alpha_identifier</b> All other identifiers</li>
1932         <li><b>quote</b> Applies to all quotation mark classes</li>
1933         <li><b>quote_double</b> Double quotes <tt>"</tt></li>
1934         <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1935         <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1936     </ul><br />
1937     </dd>
1938
1939     <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1940     <dd>
1941     phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1942     as originally published on
1943     <a  href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
1944     <br />
1945     For help in setting up your system to use the service, see the
1946     <a href="#faqsqlvalidator">FAQ #6.14</a>.
1947     <br /><br />
1948     </dd>
1949
1950     <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1951     <b>$cfg['SQLValidator']['password']</b> string</dt>
1952     <dd>
1953     The SOAP service allows you to login with <tt>anonymous</tt>
1954     and any password, so we use those by default. Instead, if
1955     you have an account with them, you can put your login details
1956     here, and it will be used in place of the anonymous login.
1957     <br /><br />
1958     </dd>
1959
1960     <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1961     <dd>
1962     <b>DEVELOPERS ONLY!</b><br />
1963     Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1964     the code.
1965     <br />
1966     For help in setting up your system to this, see the
1967     <a href="#developersdbg">Developers</a> section.
1968     </dd>
1969
1970     <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1971     <dd>
1972     <b>DEVELOPERS ONLY!</b><br />
1973     Enable profiling support for phpMyAdmin. This will append a chunk of data
1974     to the end of every page displayed in the main window with profiling
1975     statistics for that page.<br />
1976     You may need to increase the maximum execution time for this to
1977     complete successfully.
1978     </dd>
1979
1980     <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1981     <dd>
1982     <b>DEVELOPERS ONLY!</b><br />
1983     When profiling data is displayed, this variable controls the threshold of
1984     display for any profiling data, based on the average time each time has
1985     taken. If it is over the threshold it is displayed, otherwise it is not
1986     displayed. This takes a value in milliseconds. In most cases you don't need
1987     to edit this.
1988     </dd>
1989
1990     <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1991     <dd>
1992         All possible types of a MySQL column. In most cases you don't need to
1993         edit this.
1994         <br /><br />
1995     </dd>
1996
1997     <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1998     <dd>
1999         Possible attributes for fields. In most cases you don't need to edit
2000         this.
2001         <br /><br />
2002     </dd>
2003
2004     <dt><b>$cfg['Functions'] </b>array</dt>
2005     <dd>
2006         A list of functions MySQL supports. In most cases you don't need to
2007         edit this.
2008         <br /><br />
2009     </dd>
2010
2011     <dt><b>$cfg['RestrictColumnTypes'] </b>array</dt>
2012     <dd>
2013         Mapping of column types to meta types used for preferring displayed
2014         functions. In most cases you don't need to edit this.
2015         <br /><br />
2016     </dd>
2017
2018     <dt><b>$cfg['RestrictFunctions'] </b>array</dt>
2019     <dd>
2020         Functions preferred for column meta types as defined in
2021         <code>$cfg['RestrictColumnTypes']</code>. In most cases you don't need
2022         to edit this.
2023         <br /><br />
2024     </dd>
2025
2026     <dt><b>$cfg['DefaultFunctions'] </b>array</dt>
2027     <dd>
2028         Functions selected by default when insering/changing row, Functions
2029         are defined for meta types from
2030         <code>$cfg['RestrictColumnTypes']</code> and for
2031         <code>first_timestamp</code>, which is used for first timestamp column
2032         in table.
2033         <br /><br />
2034     </dd>
2035
2036     <dt><b>$cfg['NumOperators'] </b>array</dt>
2037     <dd>
2038         Operators available for search operations on numeric and date fields.
2039         <br /><br />
2040     </dd>
2041
2042     <dt><b>$cfg['TextOperators'] </b>array</dt>
2043     <dd>
2044         Operators available for search operations on character fields.
2045         Note that we put <code>LIKE</code> by default instead of
2046         <code>LIKE %...%</code>, to avoid unintended performance problems
2047         in case of huge tables.
2048         <br /><br />
2049     </dd>
2050
2051     <dt><b>$cfg['EnumOperators'] </b>array</dt>
2052     <dd>
2053         Operators available for search operations on enum fields.
2054         <br /><br />
2055     </dd>
2056
2057     <dt><b>$cfg['NullOperators'] </b>array</dt>
2058     <dd>
2059         Additionnal operators available for search operations when the
2060         field can be null.
2061         <br /><br />
2062     </dd>
2063
2064 </dl>
2065
2066 <!-- TRANSFORMATIONS -->
2067 <a name="transformations"></a><br />
2068 <h2>Transformations</h2>
2069
2070 <p>
2071 <a href="#transformationsintro">Introduction</a> &nbsp;-&nbsp;
2072 <a href="#transformationshowto">Usage</a> &nbsp;-&nbsp;
2073 <a href="#transformationsfiles">File structure</a>
2074 </p>
2075
2076 <a name="transformationsintro"></a><br />
2077 <h3>[1. Introduction]</h3>
2078
2079 <p>To enable transformations, you have to setup the column_info table and the proper
2080 directives. Please see the <a href="#config">Configuration section</a> on how to do so.</p>
2081 <br />
2082
2083 <p>You can apply different transformations to the contents of each field. The
2084 transformation will take the content of each field and transform it with
2085 certain rules defined in the selected transformation.</p><br />
2086
2087 <p>Say you have a field 'filename' which contains a filename. Normally you would see
2088 in phpMyAdmin only this filename. Using transformations you can transform that filename
2089 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
2090 link and will see the file displayed in a new browser window. Using transformation
2091 options you can also specify strings to append/prepend to a string or the format you
2092 want the output stored in.</p><br />
2093
2094 <p>For a general overview of all available transformations and their options, you can
2095 consult your <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/libraries/transformations/overview.php</i>
2096 installation.</p>
2097
2098 <p><br />For a tutorial on how to effectively use transformations, see our <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on the official phpMyAdmin-homepage.</p>
2099
2100 <a name="transformationshowto"></a><br />
2101 <h3>[2. Usage]</h3>
2102
2103 <p>Go to your <i>tbl_properties.inc.php</i> page (i.e. reached through clicking on the
2104 'properties' link for a table). There click on &quot;Change&quot; (or change
2105 icon) and there you will see three new fields at the end of the line. They are
2106 called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
2107 <br />
2108
2109 <ul>
2110 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
2111 empty or to use 'auto' [this feature is not yet available]. Please note that
2112 transformations are inactive as long as no MIME-type is selected.</li>
2113
2114 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
2115 hopefully growing amount of pre-defined transformations. See below for information on
2116 how to build your own transformation.<br />
2117
2118 There are global transformations and mimetype-bound transformations. Global transformations
2119 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
2120 Mimetype-bound transformations usually only operate on a certain mimetype. There are
2121 transformations which operate on the main mimetype (like 'image'), which will most likely
2122 take the subtype into regard, and those who only operate on a
2123 specific subtype (like 'image/jpeg').<br />
2124
2125 You can use transformations on mimetypes for which the function was not defined for. There
2126 is no security check for you selected the right transformation, so take care of what the
2127 output will be like.</li>
2128
2129 <li>The field 'Transformation options' is a free-type textfield. You have to enter
2130 transform-function specific options here. Usually the transforms can operate with default
2131 options, but it is generally a good idea to look up the overview to see which options are
2132 necessary.<br />
2133
2134 Much like the ENUM/SET-Fields, you have to split up several options using the format
2135 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
2136 parsed as an array, leaving the first value the first element in the array, and so
2137 forth.<br />
2138
2139 If you want to specify a MIME character set you can define it in the transformation_options.
2140 You have to put that outside of the pre-defined options of the specific mime-transform,
2141 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
2142 for which you can specify 2 options and you want to append a character set, enter "'first
2143 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
2144 the parameters: "'','','charset=us-ascii'".</li>
2145 </ul>
2146
2147 <a name="transformationsfiles"></a><br />
2148 <h3>[3. File structure]</h3>
2149
2150 <p>All mimetypes and their transformations are defined through single files in
2151 the directory 'libraries/transformations/'.</p><br />
2152
2153 <p>They are stored in files to ease up customization and easy adding of new
2154 transformations.</p><br />
2155
2156 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
2157 always work. It makes no sense to apply a transformation to a mimetype, the
2158 transform-function doesn't know to handle.</p><br />
2159
2160 <p>One can, however, use empty mime-types and global transformations which should work
2161 for many mimetypes. You can also use transforms on a different mimetype they where built
2162 for, but pay attention to option usage as well as what the transformation does to your
2163 field.</p><br />
2164
2165 <p>There is a basic file called '<i>global.inc.php</i>'. This function can be included by
2166 any other transform function and provides some basic functions.</p><br />
2167
2168 <p>There are 5 possible file names:</p>
2169
2170 <ol>
2171 <li>A mimetype+subtype transform:<br /><br />
2172
2173     [mimetype]_[subtype]__[transform].inc.php<br /><br />
2174
2175     Please not that mimetype and subtype are separated via '_', which shall not be
2176     contained in their names. The transform function/filename may contain only
2177     characters which cause no problems in the file system as well as the PHP function
2178     naming convention.<br /><br />
2179
2180     The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
2181
2182     <b>Example:</b><br /><br />
2183
2184     text_html__formatted.inc.php<br />
2185     PMA_transform_text_html__formatted()</li>
2186
2187 <li>A mimetype (w/o subtype) transform:<br /><br />
2188
2189     [mimetype]__[transform].inc.php<br /><br />
2190
2191     Please note that there are no single '_' characters.
2192     The transform function/filename may contain only characters which cause no problems
2193     in the file system as well as the PHP function naming convention.<br /><br />
2194
2195     The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
2196
2197     <b>Example:</b><br /><br />
2198
2199     text__formatted.inc.php<br />
2200     PMA_transform_text__formatted()</li>
2201
2202 <li>A mimetype+subtype without specific transform function<br /><br />
2203
2204     [mimetype]_[subtype].inc.php<br /><br />
2205
2206     Please note that there are no '__' characters in the filename. Do not use special
2207     characters in the filename causing problems with the file system.<br /><br />
2208
2209     No transformation function is defined in the file itself.<br /><br />
2210
2211     <b>Example:</b><br /><br />
2212
2213     text_plain.inc.php<br />
2214     (No function)</li>
2215
2216 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2217
2218     [mimetype].inc.php<br /><br />
2219
2220     Please note that there are no '_' characters in the filename. Do not use special
2221     characters in the filename causing problems with the file system.<br /><br />
2222
2223     No transformation function is defined in the file itself.<br /><br />
2224
2225     <b>Example:</b><br /><br />
2226
2227     text.inc.php<br />
2228     (No function)</li>
2229
2230 <li>A global transform function with no specific mimetype<br /><br />
2231
2232     global__[transform].inc.php<br /><br />
2233
2234     The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
2235
2236     <b>Example:</b><br /><br />
2237
2238     global__formatted<br />
2239     PMA_transform_global__formatted()</li>
2240 </ol>
2241
2242 <br />
2243 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
2244 transform function.</p><br />
2245
2246 <p>All filenames containing no '__' in themselves are not shown as valid transform
2247 functions in the dropdown.</p><br />
2248
2249 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
2250 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2251 without a transform function. Also note the introduction of a function description in
2252 the language files. For each function a $strTransformation_[filename without .inc.php]
2253 has to exist.</p><br />
2254
2255 <p>You can use the template generator to generate new functions and entries in the
2256 language file.</p><br />
2257
2258 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2259 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2260
2261 <p>A transform function always gets passed three variables:</p>
2262 <ol>
2263     <li><b>$buffer</b> - Contains the text inside of the column. This is the text, you want to transform.</li>
2264     <li><b>$options</b> - Contains any user-passed options to a transform function as an array.</li>
2265     <li><b>$meta</b> - Contains an object with field information to your column. The data is drawn from the output of the
2266     <a href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a> function. This means, all object properties described
2267     on the <a href="http://www.php.net/mysql_fetch_field">manual page</a> are available in this variable and can be used to
2268     transform a field accordingly to unsigned/zerofill/not_null/... properties.<br />
2269     The $meta-&gt;mimetype variable contains the original MIME-type of the field (i.e. 'text/plain', 'image/jpeg' etc.)</li>
2270 </ol>
2271
2272 <!-- FAQ -->
2273 <a name="faq"></a><br />
2274 <h2>FAQ - Frequently Asked Questions</h2>
2275
2276 <p>
2277 <a href="#faqserver">Server</a> &nbsp;-&nbsp;
2278 <a href="#faqconfig">Configuration</a> &nbsp;-&nbsp;
2279 <a href="#faqlimitations">Limitations</a> &nbsp;-&nbsp;
2280 <a href="#faqmultiuser">Multi-user</a> &nbsp;-&nbsp;
2281 <a href="#faqbrowsers">Browsers</a> &nbsp;-&nbsp;
2282 <a href="#faqusing">Usage tips</a> &nbsp;-&nbsp;
2283 <a href="#faqproject">Project</a> &nbsp;-&nbsp;
2284 <a href="#faqsecurity">Security</a>
2285 </p>
2286
2287 <p><br />
2288    Please have a look at our <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's features and/or interface.
2289 </p>
2290
2291 <a name="faqserver"></a><br />
2292 <h3>[1. Server]</h3>
2293
2294 <h4>
2295     [1.1] I'm running PHP 4+ and my server is crashing each time a specific
2296     action is required or phpMyAdmin sends a blank page or a page full of
2297     cryptic characters to my browser, what can I do?
2298 </h4>
2299 <p>
2300     There are some known PHP bugs with output buffering and compression.<br />
2301     Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2302     <i>config.inc.php</i> file and the
2303     <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2304     configuration file.<br />
2305     Furthermore, we know about such problems connected to the release
2306     candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2307     MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2308 </p>
2309
2310 <h4>
2311     [1.2] My Apache server crashes when using phpMyAdmin.
2312 </h4>
2313 <p>
2314     You should first try the latest versions of Apache (and possibly MySQL).
2315     <br />
2316     See also the other FAQ entry about PHP bugs with output buffering.
2317     <br />
2318     If your server keeps crashing, please ask for help in the various
2319     Apache support groups.
2320 </p>
2321
2322 <h4>
2323     [1.3] I'm running phpMyAdmin with "cookie" authentication mode under
2324     PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2325     script: I'm always displayed the login screen.
2326 </h4>
2327 <p>
2328     This is a known PHP bug (see this
2329     <a href="http://bugs.php.net/bug.php?id=16626">bug report</a>) from the
2330     official PHP bug database. It means there is and won't be any phpMyAdmin
2331     fix against it because there is no way to code a fix.
2332 </p>
2333
2334 <h4>
2335     [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
2336     &quot;The specified CGI application misbehaved by not returning a
2337     complete set of HTTP headers...&quot;.
2338 </h4>
2339 <p>
2340     You just forgot to read the <i>install.txt</i> file from the php
2341     distribution. Have a look at the last message in this
2342     <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2343     official PHP bug database.
2344 </p>
2345
2346 <h4>
2347     [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2348     messages with the HTTP or advanced authentication mode.
2349 </h4>
2350 <p>
2351     This is a known problem with the PHP ISAPI filter: it's not so stable. For
2352     some more information and complete testings see the messages posted by
2353     Andr&eacute; B. aka &quot;djdeluxe76&quot; in
2354     <a href="http://www.phpwizard.net/phorum/read.php?f=1&amp;i=6624&amp;t=6300">this&nbsp;thread</a>
2355     from the phpWizard forum.<br />
2356     Please use instead the cookie authentication mode.
2357 </p>
2358
2359 <h4>
2360     [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2361 <p>
2362     This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2363     time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2364     declarations (2 lines) from the scripts <i>header.inc.php</i>,
2365     <i>header_printview.inc.php</i>, <i>index.php</i>, <i>left.php</i> and
2366     <i>libraries/common.lib.php</i>.
2367 </p>
2368
2369 <h4>
2370     [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2371     work.
2372 </h4>
2373 <p>
2374     These features are based on the <tt>gzencode()</tt> and
2375     <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2376     (Unix/Windows, Safe Mode or not, and so on).
2377     So, you must have PHP4&nbsp;>=&nbsp;4.0.4 and Zlib/Bzip2 support
2378     (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2379     We faced PHP crashes when trying to download a dump with MS Internet
2380     Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2381     this case you should switch to the release version of PHP 4.2.0.
2382 </p>
2383
2384 <h4>
2385     [1.8] I cannot insert a text file in a table, and I get an error about
2386     safe mode being in effect.
2387 </h4>
2388 <p>
2389     Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2390     defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2391     the system default is <i>/tmp</i>).
2392     <br />
2393     We recommend the following setup for Apache servers running in safe mode,
2394     to enable uploads of files while being reasonably secure:
2395 </p>
2396 <ul>
2397    <li>create a separate directory for uploads:
2398            <tt>mkdir /tmp/php</tt></li>
2399    <li>give ownership to the Apache server's user.group:
2400            <tt>chown apache.apache /tmp/php</tt></li>
2401    <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2402    <li>put <tt>upload_tmp_dir = /tmp/php</tt> in <i>php.ini</i></li>
2403    <li>restart Apache</li>
2404 </ul>
2405
2406 <h4>
2407     [1.9] I'm having troubles when uploading files. In general file uploads
2408     don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2409     header in the first line.
2410 </h4>
2411 <p>
2412     It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2413     and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2414     <br />
2415     So the problem is that this package has a serious bug that was corrected
2416     ages ago in PHP (2001-01-28: see
2417     <a href="http://www.php.net/bugs.php?id=8966">PHP's bug tracking system</a>
2418     for more details). The problem is that the bugged package is still
2419     available though it was corrected (see
2420     <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933">RedHat's BugZilla</a>
2421     for more details).
2422     <br />
2423     So please download
2424     <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2425     and the problem should go away.
2426     <br />
2427     And that fixes the \r\n problem with file uploads!
2428 </p>
2429
2430 <h4>
2431     [1.10] I'm having troubles when uploading files with phpMyAdmin running
2432     on a secure server. My browser is Internet Explorer and I'm using the
2433     Apache server.
2434 </h4>
2435 <p>
2436     As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2437     your <i>httpd.conf</i>:<br />
2438     &nbsp;&nbsp;&nbsp;&nbsp;<tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2439     It seems to clear up many problems between Internet Explorer and SSL.
2440 </p>
2441
2442 <h4>
2443     [1.11] I get an 'open_basedir restriction' while uploading a file from
2444     the query box.
2445 </h4>
2446 <p>
2447     Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2448     restrictions. Assuming that the restriction allows you to open files in the
2449     current directory ('.'), all you have to do is create a 'tmp' directory
2450     under the phpMyAdmin install directory, with permissions 777 and the same
2451     owner as the owner of your phpMyAdmin directory. The  uploaded files will
2452     be moved there, and after execution of your SQL commands, removed.
2453 </p>
2454
2455 <h4>
2456     [1.12] I have lost my MySQL root password, what can I do?
2457 </h4>
2458 <p>
2459     The MySQL manual explains how to
2460     <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html">
2461     reset the permissions</a>.
2462 </p>
2463
2464 <h4>
2465     [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2466 </h4>
2467 <p>
2468     If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2469     cannot access the uploaded query.
2470 </p>
2471
2472 <h4>
2473     [1.14] I get an error 'No SQL query' when trying to submit a query from
2474     the convenient text area.
2475 </h4>
2476 <p>
2477     Check the <tt>post_max_size</tt> directive from your PHP configuration file
2478     and try to increase it.
2479 </p>
2480
2481 <h4>
2482     [1.15] I have problems with <i>mysql.user</i> field names.
2483 </h4>
2484 <p>
2485     In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2486     were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2487     names to align with current standards.
2488 </p>
2489 <h4><a name="faq1_16"></a>
2490     [1.16] I cannot upload big dump files (memory, http or timeout problems).
2491 </h4>
2492 <p>
2493     The first things to check (or ask your host provider to check) are the
2494     values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2495     <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2496     All of these three settings limit the maximum size of data that can be
2497     submitted and handled by PHP. One user also said that post_max_size
2498     and memory_limit need to be larger than upload_max_filesize.
2499     <br /> <br />
2500     There exist several workarounds if your upload is too big or your
2501     hosting provider is unwilling to change the settings:
2502 </p>
2503 <ul>
2504     <li>Look at the <tt>$cfg['UploadDir']</tt> feature. This allows one to
2505     upload a file to the server via scp, ftp, or your favorite file transfer
2506     method. PhpMyAdmin is then able to import the files from the temporary
2507     directory. More information is available in the <a href="#config">Configuration
2508     section</a> of this document.</li>
2509     <li>Using a utility (such as <a href="http://www.ozerov.de/bigdump.php">
2510     BigDump</a>) to split the files before uploading. We cannot support this
2511     or any third party applications, but are aware of users having success
2512     with it.</li>
2513     <li>If you have shell (command line) access, use MySQL to import the files
2514     directly. You can do this by issuing the &quot;source&quot; command from
2515     within MySQL: <tt>source <i>filename.sql</i></tt>.</li>
2516 </ul>
2517
2518 <a name="faqmysqlversions"></a>
2519 <h4>
2520     [1.17] Which MySQL versions does phpMyAdmin support?
2521 </h4>
2522 <p>
2523     All MySQL versions from 3.23.32 till 5.0 (except for 4.1.0 and 4.1.1) are
2524     fully supported. Please note that the older your MySQL version is, the more
2525     limitations you will have to face.
2526     <br />
2527     phpMyAdmin may connect to your MySQL server using php's classic
2528     <a href="http://php.net/mysql">MySQL extension</a> as well as the
2529     <a href="http://php.net/mysqli">improved MySQL extension (MySQLi)</a> that
2530     is available in php 5.0.
2531     <br />
2532     Either way, the developers of both extensions recommend to use the classic
2533     extension for MySQL 4.0 and below and MySQLi for MySQL 4.1 and newer.
2534     <br />
2535     When compiling php, we strongly recommend that you manually link the MySQL
2536     extension of your choice to a MySQL client library of at least the same
2537     minor version since the one that is bundled with some php distributions is
2538     rather old and might cause problems (see also FAQ 1.17a).<br />
2539     MySQL&nbsp;5.1 is not yet supported.
2540 </p>
2541
2542 <h4>
2543     [1.17a] I cannot connect to the MySQL server. It always returns the error
2544     message, &quot;Client does not support authentication protocol requested
2545     by server; consider upgrading MySQL client&quot;
2546 </h4>
2547 <p>
2548     You tried to access MySQL with an old MySQL client library. The version of
2549     your MySQL client library can be checked in your phpinfo() output.
2550     <br />
2551     In general, it should have at least the same minor version as your server
2552     - as mentioned in FAQ 1.17.
2553     <br />
2554     The only way to fix this problem is manually compiling php and its MySQL
2555     extension against a current MySQL client library.
2556     <br />
2557     If you still face this problem, please compile your MySQL client library
2558     against the same or a newer MySQL release.
2559 </p>
2560
2561 <h4>
2562     [1.18] I'm running MySQL&nbsp;&lt;=&nbsp;4.0.1 having
2563     <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2564     capital letter in its name it is changed to lowercase as it should. But
2565     if I try to DROP this table MySQL is unable to find the corresponding
2566     file.
2567 </h4>
2568 <p>
2569     This is a bug of MySQL&nbsp;&lt;=&nbsp;4.0.1. Please upgrade to at least
2570     MySQL&nbsp;4.0.2 or turn off your <tt>lower_case_table_names</tt>
2571     directive.
2572 </p>
2573
2574 <h4>
2575     [1.19] I can't run the &quot;display relations&quot; feature because the
2576     script seems not to know the font face I'm using!
2577 </h4>
2578 <p>
2579     The &quot;FPDF&quot; library we're using for this feature requires some
2580     special files to use font faces.<br />
2581     Please refers to the
2582     <a href="http://www.fpdf.org/" target="_blank">FPDF manual</a> to build
2583     these files.
2584 </p>
2585
2586 <a name="faqmysql"></a><br />
2587 <h4>
2588     [1.20] I receive the error &quot;cannot load MySQL extension, please
2589     check PHP Configuration&quot;.
2590 </h4>
2591 <p>
2592     To connect to a MySQL server, PHP needs a set of MySQL functions called
2593     &quot;MySQL extension&quot;.
2594     This extension may be part of the PHP distribution (compiled-in), otherwise
2595     it needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2596     <i>php_mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2597     <br /><br />
2598     Usually, the problem is solved by installing a software package called
2599     &quot;PHP-MySQL&quot; or something similar.
2600 </p>
2601
2602 <h4>
2603     [1.21] I am running the CGI version of PHP under Unix, and I cannot
2604     login using cookie auth.
2605 </h4>
2606 <p>
2607     In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2608 </p>
2609
2610 <h4>
2611     [1.22] I don't see the &quot;Location of text file&quot; field, so
2612     I cannot upload.
2613 </h4>
2614 <p>
2615     This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2616     parameter is not set to &quot;on&quot;.
2617 </p>
2618 <a name="faq1_23"></a><br />
2619 <h4>
2620     [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2621     table the table and field names are changed to lowercase!
2622 </h4>
2623 <p>
2624     This happens because the MySQL directive <tt>lower_case_table_names</tt>
2625     defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2626     this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2627     Just edit your <tt>my.ini</tt> file that should be located in your Windows
2628     directory and add the following line to the group [mysqld]:<br />
2629     <tt>set-variable = lower_case_table_names=0</tt><br />
2630     Next, save the file and restart the MySQL service. You can always check the
2631     value of this directive using the query<br />
2632     <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2633 </p>
2634
2635 <h4>
2636     [1.24] Some characters are being truncated in my queries, or I get
2637     characters randomly added. I am running PHP 4.2.3.
2638 </h4>
2639 <p>
2640     This is a
2641     <a href="http://bugs.php.net/bug.php?id=19404">PHP 4.2.3 bug</a>.
2642 </p>
2643
2644 <h4>
2645     [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2646     and I get problems, such as undefined variables when I run a SQL query.
2647 </h4>
2648 <p>
2649     A tip from Jose Fandos: put a comment on the following two lines
2650     in httpd.conf, like this:<br />
2651     <tt># mod_gzip_item_include file \.php$</tt><br />
2652     <tt># mod_gzip_item_include mime "application/x-httpd-php.*"</tt><br />
2653     as this version of mod_gzip on Apache (Windows) has problems handling
2654     PHP scripts. Of course you have to restart Apache.
2655 </p>
2656
2657 <h4>
2658     [1.26] I just installed phpMyAdmin in my document root of IIS but
2659     I get the error &quot;No input file specified&quot; when trying to
2660     run phpMyAdmin.
2661 </h4>
2662 <p>
2663     This is a permission problem. Right-click on the phpmyadmin folder
2664     and choose properties. Under the tab Security, click on &quot;Add&quot;
2665     and select the user &quot;IUSR_machine&quot; from the list. Now set his
2666     permissions and it should work.
2667 </p>
2668
2669 <h4>
2670     [1.27] I get empty page when I want to view huge page (eg.
2671     db_details_structure.php with plenty of tables).
2672 </h4>
2673 <p>
2674     This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2675     GZIP output buffering is enabled. If you turn off it (by <code>$cfg['OBGzip']
2676     = FALSE</code> in <i>config.inc.php</i>), it should work. This bug will be
2677     fixed in PHP 5.0.0.
2678 </p>
2679
2680 <h4>
2681     [1.28] My MySQL server sometimes refuses queries and returns the message
2682     'Errorcode: 13'. What does this mean?
2683 </h4>
2684 <p>
2685     This can happen due to a MySQL bug when having database / table names with
2686     upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2687     To fix this, turn off this directive, convert all database and table names
2688     to lower case and turn it on again. Alternatively, there's a bug-fix
2689     available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.
2690 </p>
2691
2692 <a name="faq-1-29"></a>
2693 <h4>
2694     [1.29] When I create a table or modify a field, I get an error
2695     and the fields are duplicated.
2696 </h4>
2697 <p>
2698     It is possible to configure Apache in such a way that PHP has problems
2699     interpreting .php files.
2700     <br /><br />
2701     The problems occur when two different (and conflicting) set of directives
2702     are used:
2703     <br /><br />
2704     <tt>
2705     SetOutputFilter PHP<br />
2706     SetInputFilter PHP<br />
2707     </tt>
2708     &amp;
2709     <br />
2710     <tt>
2711     AddType application/x-httpd-php .php
2712     </tt>
2713     <br /><br />
2714     In the case we saw, one set of directives was in
2715     <tt>/etc/httpd/conf/httpd.conf</tt>, while
2716     the other set was in <tt>/etc/httpd/conf/addon-modules/php.conf</tt>.<br />
2717     The recommended way is with <tt>AddType</tt>, so just comment out
2718     the first set of lines and restart Apache:
2719     <br /><br />
2720     <tt><b>
2721     #SetOutputFilter PHP<br />
2722     #SetInputFilter PHP<br /></b>
2723     </tt>
2724 </p>
2725
2726 <h4>
2727     [1.30] I get the error &quot;left.php: Missing hash&quot;.
2728 </h4>
2729 <p>
2730     This problem is known to happen when the server is running Turck MMCache
2731     but upgrading MMCache to version 2.3.21 solves the problem.
2732 </p>
2733
2734 <a name="faqphp5"></a>
2735 <h4>
2736     [1.31] Does phpMyAdmin support php5?
2737 </h4>
2738 <p>
2739     Yes.
2740     <br />
2741     However, phpMyAdmin needs to be backwards compatible to php4. This is why
2742     you won't be able to run phpMyAdmin having enabled E_STRICT in your
2743     error_reporting settings.
2744 </p>
2745 <a name="faq1_32"></a><br />
2746 <h4>
2747     [1.32] Can I use HTTP authentication with IIS?
2748 </h4>
2749 <p>
2750     Yes. This procedure was tested with phpMyAdmin 2.6.1, PHP 4.3.9 in ISAPI
2751     mode under IIS 5.1.</p>
2752     <ol>
2753         <li>In your <tt>php.ini</tt> file, set <tt>cgi.rfc2616_headers = 0</tt></li>
2754
2755         <li>In <tt>Web Site Properties -> File/Directory Security -> Anonymous Access</tt> dialog box, check the <tt>Anonymous access</tt> checkbox and uncheck any other checkboxes (i.e. uncheck <tt>Basic authentication</tt>, <tt>Integrated Windows authentication</tt>, and <tt>Digest</tt> if it's enabled.) Click <tt>OK</tt>. </li>
2756
2757         <li>In <tt>Custom Errors</tt>, select the range of <tt>401;1</tt> through <tt>401;5</tt> and click the <tt>Set to Default</tt> button. </li>
2758     </ol>
2759
2760 <a name="faqconfig"></a><br />
2761 <h3>[2. Configuration]</h3>
2762
2763 <h4>
2764     [2.1] The error message &quot;Warning: Cannot add header information -
2765     headers already sent by ...&quot; is displayed, what's the problem?
2766 </h4>
2767 <p>
2768     Edit your <i>config.inc.php or .php</i> file and ensure there is nothing
2769     (I.E. no blank lines, no spaces, no characters...) neither before the
2770     <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
2771     tag at the end.
2772 </p>
2773
2774 <h4>
2775     [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2776 </h4>
2777 <p>
2778     Either there is an error with your PHP setup or your username/password is
2779     wrong. Try to make a small script which uses mysql_connect and see if it
2780     works. If it doesn't, it may be you haven't even compiled MySQL support
2781     into PHP.
2782 </p>
2783
2784 <h4>
2785     [2.3] The error message &quot;Warning: MySQL Connection Failed: Can't
2786     connect to local MySQL server through socket '/tmp/mysql.sock'
2787     (111)...&quot; is displayed. What can I do?
2788 </h4>
2789 <p><br />
2790     For RedHat users, Harald Legner suggests this on the mailing list:
2791     <br /><br />
2792     On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2793     In your <i>php.ini</i> you will find a line
2794     <br />
2795     &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /tmp/mysql.sock</tt>
2796     <br />
2797     change it to
2798     <br />
2799     &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2800     <br />
2801     Then restart apache and it will work.
2802     <br /><br />
2803     Here is a fix suggested by Brad Ummer in the phpwizard forum:
2804 </p>
2805 <ul>
2806     <li>
2807         First, you need to determine what socket is being used by MySQL.
2808         <br />
2809         To do this, telnet to your server and go to the MySQL bin directory. In
2810         this directory there should be a file named <i>mysqladmin</i>. Type
2811         <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2812         info about your MySQL server, including the socket
2813         (<i>/tmp/mysql.sock</i>, for example).
2814     </li>
2815     <li>
2816         Then, you need to tell PHP to use this socket.<br />Assuming you are
2817         using PHP 3.0.10 or better, you can specify the socket to use when you
2818         open the connection. To do this in phpMyAdmin, you need to complete the
2819         socket information in the <i>config.inc.php</i>.<br />
2820         For example:
2821         <tt>$cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</tt><br /><br />
2822         Please also make sure that the permissions of this file allow to be readable
2823         by your webserver (i.e. '0755').
2824     </li>
2825 </ul>
2826 <p>
2827     Have also a look at the
2828     <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html" target="_blank">
2829          corresponding section of the MySQL documentation</a>.
2830 </p>
2831
2832 <h4>
2833     [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2834     what can I do?
2835 </h4>
2836 <p>
2837     Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2838     phpMyAdmin configuration file. It helps sometime.<br />
2839     Also have a look at your PHP version number: if it contains
2840     &quot;4.0b...&quot; it means you're running a beta version of PHP. That's
2841     not a so good idea, please upgrade to a plain revision.
2842 </p>
2843
2844 <h4>
2845     [2.5] Each time I want to insert or change a record or drop a database
2846     or a table, an error 404 (page not found) is displayed or, with HTTP or
2847     cookie authentication, I'm asked to login again. What's wrong?
2848 </h4>
2849 <p>
2850     Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2851     in the phpMyAdmin configuration file.
2852 </p>
2853
2854 <h4>
2855     [2.6] I get an &quot;Access denied for user: 'root@localhost' (Using
2856     password: YES)&quot;-error when trying to access a MySQL-Server on a
2857     host which is port-forwarded for my localhost.
2858 </h4>
2859 <p>
2860     When you are using a port on your localhost, which you redirect via
2861     port-forwarding to another host, MySQL is not resolving the localhost
2862     as expected.<br />
2863     Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
2864     MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2865     connection for speeding up things. And that doesn't work in this configuration
2866     with port forwarding.<br />
2867     If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
2868     TCP connection.
2869 </p>
2870
2871 <a name="faqthemes"></a><br />
2872 <h4>
2873     [2.7] Using and creating themes
2874 </h4>
2875 <p>
2876     Themes are configured with <tt>$cfg['ThemePath']</tt>,
2877     <tt>$cfg['ThemeManager']</tt> and <tt>$cfg['ThemeDefault']</tt>.<br />
2878     <br />
2879     Under <tt>$cfg['ThemePath']</tt>, you should not delete the directory
2880     &quot;original&quot; or its underlying structure, because this is
2881     the system theme used by phpMyAdmin. &quot;original&quot; contains all
2882     images and styles, for backwards compatibility and for all themes that
2883     would not include images or css-files.<br />
2884     <br />
2885     If <tt>$cfg['ThemeManager']</tt> is enabled, you can select your
2886     favorite theme on the main page. Your selected theme will be stored
2887     in a cookie.<br />
2888     <br />
2889     </p>
2890     <p>
2891     To create a theme:
2892     </p>
2893     <ul>
2894         <li>make a new subdirectory (for example &quot;your_theme_name&quot;) under <tt>$cfg['ThemePath']</tt> (by default <tt>themes</tt>)</li>
2895         <li>copy the files and directories from &quot;original&quot; to &quot;your_theme_name&quot;</li>
2896         <li>edit the css-files in &quot;your_theme_name/css&quot;</li>
2897         <li>put your new images in &quot;your_theme_name/img&quot;</li>
2898         <li>edit <tt>layout.inc.php</tt> in &quot;your_theme_name&quot;</li>
2899         <li>edit <tt>info.inc.php</tt> in &quot;your_theme_name&quot; to
2900         contain your chosen theme name, that will be visible in user interface</li>
2901         <li>make a new screenshot of your theme and save it under &quot;your_theme_name/screen.png&quot;</li>
2902     </ul>
2903     <br />
2904     <p>
2905     In theme directory there is file <tt>info.inc.php</tt> which contains
2906     theme verbose name, theme generation and theme version. These versions and
2907     generations are enumerated from 1 and do not have any direct dependance on
2908     phpMyAdmin version. Themes within same generation should be backwards
2909     compatible - theme with version 2 should work in phpMyAdmin requiring
2910     version 1. Themes with different generation are incompatible.
2911     </p>
2912     <p>
2913     If you do not want to use your own symbols and buttons, remove the
2914     directory &quot;img&quot; in &quot;your_theme_name&quot;. phpMyAdmin will
2915     use the default icons and buttons (from the system-theme &quot;original&quot;).
2916     </p>
2917 <a name="faqmissingparameters"></a><br />
2918 <h4>
2919     [2.8] I get &quot;Missing parameters&quot; errors, what can I do?
2920 </h4>
2921 <p>
2922     Here are a few points to check:</p>
2923     <ul>
2924         <li>
2925         In <tt>config.inc.php</tt>, try to leave the
2926         <tt>$cfg['PmaAbsoluteUri']</tt>directive empty. See also FAQ 4.7.
2927         </li>
2928         <li>
2929         Maybe you have a broken PHP installation or you need to upgrade
2930         your Zend Optimizer. See
2931         <a href="http://bugs.php.net/bug.php?id=31134">
2932         http://bugs.php.net/bug.php?id=31134</a>.
2933         </li>
2934         <li>
2935         If you are using Hardened PHP with the ini directive <tt>varfilter.max_request_variables</tt>
2936         set to the default (200) or another low value, you could get this
2937         error if your table has a high number of columns. Adjust this setting
2938         accordingly. (Thanks to Klaus Dorninger for the hint).
2939         </li>
2940     </ul>
2941
2942 <a name="faqlimitations"></a><br />
2943 <h3>[3. Known limitations]</h3>
2944 <a name="login_bug"></a><br />
2945 <h4>
2946     [3.1] When using HTTP authentication, an user who logged out can not
2947     relogin in with the same nick.
2948 </h4>
2949 <p>
2950     This is related to the authentication mechanism (protocol) used by
2951     phpMyAdmin. To bypass this problem: just close all the opened
2952     browser windows and then go back to phpMyAdmin. You should be able to
2953     log in again.
2954 </p>
2955
2956 <h4>
2957     [3.2] When dumping a large table in compressed mode, I get a memory
2958     limit error or a time limit error.
2959 </h4>
2960 <p>
2961     Compressed dumps are built in memory and because of this are limited to
2962     php's memory limit. For GZip/BZip2 exports this can be overcome since
2963     2.5.4 using <tt>$cfg['CompressOnFly']</tt> (enabled by default). Zip
2964     exports can not be handled this way, so if you need Zip files for larger
2965     dump, you have to use another way.
2966 </p>
2967
2968 <h4>
2969     [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2970     or alter a table.
2971 </h4>
2972 <p>
2973     This seems to be a InnoDB bug (fixed in MySQL 3.23.50?).
2974 </p>
2975
2976 <h4>
2977     [3.4] I am unable to import dumps I created with the mysqldump tool
2978     bundled with the MySQL server distribution.
2979 </h4>
2980 <p>
2981     The problem is that mysqldump creates invalid comments like this:
2982 </p>
2983
2984 <pre>
2985 -- MySQL dump 8.22
2986 --
2987 -- Host: localhost Database: database
2988 ---------------------------------------------------------
2989 -- Server version 3.23.54
2990 </pre>
2991 <p>
2992     The invalid part of the code is the horizontal line made of dashes that
2993     appears once in every dump created with mysqldump. If you want to run your
2994     dump you have to turn it into valid MySQL. This means, you have to add a
2995     whitespace after the first two dashes of the line or add a # before it:
2996     <br />
2997     <code>
2998         -- -------------------------------------------------------<br />
2999     </code>
3000     or<br />
3001     <code>
3002         #---------------------------------------------------------
3003     </code>
3004 </p>
3005
3006 <h4>
3007     [3.5] When using nested folders ($cfg['LeftFrameTableSeparator']) there
3008      are some multiple hierarchies displayed in a wrong manner?!
3009 </h4>
3010 <p>
3011     Please note that you should not use the separating string multiple times
3012     without any characters between them, or at the beginning/end of your table
3013     name. If you have to, think about using another TableSeparator or disabling
3014     that feature
3015 </p>
3016 <a name="faq3_6"></a><br />
3017 <h4>
3018     [3.6] What is currently not supported in phpMyAdmin about InnoDB?
3019 </h4>
3020 <p>
3021     In Relation view, being able to choose a table in another database,
3022     or having more than one index field in the foreign key.<br /><br/>
3023     In Query-by-example (Query), automatic generation of the query
3024     LEFT JOIN from the foreign table.<br /><br/>
3025     In PDF schema editing, automatic layout.
3026 </p>
3027
3028 <h4>
3029     [3.7] I have table with many (100+) fields and when I try to browse table
3030     I get series of errors like &quot;Warning: unable to parse url&quot;. How
3031     can this be fixed?
3032 </h4>
3033 <p>
3034     Your table neither have a primary key nor an unique one, so we must use a
3035     long expression to identify this row. This causes problems to parse_url
3036     function. The workaround is to create a primary or unique key.
3037     <br />
3038 </p>
3039
3040 <h4>
3041     [3.8] I cannot use (clickable) HTML-forms in fields where I put a <a href="#transformations">MIME-Transformation</a> onto!
3042 </h4>
3043 <p>
3044     Due to a surrounding form-container (for multi-row delete checkboxes), no nested forms can be put inside the table where
3045     phpMyAdmin displays the results. You can, however, use any form inside of a table if keep the parent form-container with
3046     the target to tbl_row_delete.php and just put your own input-elements inside. If you use a custom submit input field, the
3047     form will submit itself to the displaying page again, where you can validate the $HTTP_POST_VARS in a transformation.
3048
3049     For a tutorial on how to effectively use transformations, see our <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a>
3050     on the official phpMyAdmin-homepage.
3051 </p>
3052
3053 <h4>
3054     [3.9] I get error messages when using "--sql_mode=ANSI" for the MySQL server
3055 </h4>
3056 <p>
3057     When MySQL is running in ANSI-compatibility mode, there are some major differences in how SQL is structured (see <a href="http://dev.mysql.com/doc/mysql/en/ANSI_mode.html">http://dev.mysql.com/doc/mysql/en/ANSI_mode.html</a>). Most important of all, the quote-character (") is interpreted as an identifier quote character and not as a string quote character, which makes many internal phpMyAdmin operations into invalid SQL statements. There is no workaround to this behaviour. News to this item will be posted in Bug report <a href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=816858&amp;group_id=23067&amp;atid=377408">#816858</a>
3058 </p>
3059
3060 <h4>
3061     [3.10] Homonyms and no primary key: When the results of a SELECT display
3062     more that one column with the same value
3063     (for example <tt>SELECT lastname from employees where firstname like 'A%'</tt> and two &quot;Smith&quot; values are displayed),
3064     if I click Edit I cannot be sure that I am editing the intended row.
3065 </h4>
3066 <p>
3067     Please make sure that your table has a primary key, so that phpMyAdmin
3068     can use it for the Edit and Delete links.
3069 </p>
3070
3071 <h4>
3072     [3.11] The number of records for InnoDB tables is not correct.
3073 </h4>
3074 <p>
3075     phpMyAdmin uses a quick method to get the row count, and this method
3076     only returns an approximate count in the case of InnoDB tables. See
3077     <tt>$cfg['MaxExactCount']</tt> for a way to modify those results, but
3078     this could have a serious impact on performance.
3079 </p>
3080 <h4>
3081     [3.12] What are the phpMyAdmin limitations for MySQL 3?
3082 </h4>
3083 <p>
3084     The number of records in queries containing COUNT and GROUP BY is
3085     not correctly calculated. Also, sorting results of a query like
3086     &quot;SELECT * from table GROUP BY&quot; ... is problematic.
3087 </p>
3088 <h4>
3089     [3.13] I get an error when entering <tt>USE</tt> followed by a db name
3090     containing an hyphen.
3091 </h4>
3092 <p>
3093     The tests I have made with current MySQL 4.1.11 API shows that the
3094     API does not accept this syntax for the USE command. Enclosing the
3095     db name with backquotes works. For further confusion, no backquotes
3096     are needed with command-line mysql.
3097 </p>
3098
3099 <a name="faqmultiuser"></a><br />
3100 <h3>[4. ISPs, multi-user installations ]</h3>
3101
3102 <h4>
3103     [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
3104     need to install it for each customer.
3105 </h4>
3106 <p>
3107     Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
3108     your users. The development of this feature was kindly sponsored by
3109     NetCologne GmbH.
3110     This requires a properly setup MySQL user management and phpMyAdmin
3111     HTTP or cookie authentication. See the install section on
3112     &quot;Using HTTP authentication&quot;.
3113 </p>
3114
3115 <a name="faq4_2"></a><br />
3116 <h4>
3117     [4.2] What's the preferred way of making phpMyAdmin secure against evil
3118     access.
3119 </h4>
3120 <p>
3121     This depends on your system.<br />
3122     If you're running a server which cannot be accessed by other people, it's
3123     sufficient to use the directory protection bundled with your webserver
3124     (with Apache you can use <i>.htaccess</i> files, for example).<br />
3125     If other people have telnet access to your server, you should use
3126     phpMyAdmin's HTTP authentication feature.
3127     <br /><br />
3128     Suggestions:
3129 </p>
3130 <ul>
3131     <li>
3132         Your <i>config.inc.php</i> file should be <tt>chmod 660</tt>.
3133     </li>
3134     <li>
3135         All your phpMyAdmin files should be chown -R phpmy.apache, where phpmy
3136         is a user whose password is only known to you, and apache is the
3137         group under which Apache runs.
3138     </li>
3139     <li>
3140         You should use PHP safe mode, to protect from other users that try
3141         to include your <i>config.inc.php</i> in their scripts.
3142     </li>
3143 </ul>
3144
3145 <h4>
3146     [4.3] I get errors about not being able to include a file in
3147     <i>/lang</i> or in <i>/libraries</i>.
3148 </h4>
3149 <p>
3150     Check <i>php.ini</i>, or ask your sysadmin to check it. The
3151     <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
3152     <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
3153     &quot;./lang&quot; to allow normal operation of phpMyAdmin.
3154 </p>
3155 <a name="faq4_4"></a><br />
3156 <h4>
3157     [4.4] phpMyAdmin always gives &quot;Access denied&quot; when using HTTP
3158     authentication.
3159 </h4>
3160 <p>
3161     This could happen for several reasons:
3162 </p>
3163 <ul>
3164     <li>
3165         <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
3166         <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
3167     </li>
3168     <li>
3169         The username/password you specify in the login-dialog are invalid.
3170     </li>
3171     <li>
3172         You have already setup a security mechanism for the
3173         phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
3174         phpMyAdmin's authentication, so remove it.
3175     </li>
3176 </ul>
3177
3178 <h4>
3179     [4.5] Is it possible to let users create their own databases?
3180 </h4>
3181 <p>
3182     Starting with 2.2.5, in the user management page, you can enter a wildcard
3183     database name for a user (for example &quot;joe%&quot;),
3184     and put the privileges you want.  For example,
3185     adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
3186     would let a user create/manage his/her database(s).
3187 </p>
3188
3189 <h4>
3190     [4.6] How can I use the Host-based authentication additions?
3191 </h4>
3192 <p>
3193     If you have existing rules from an old .htaccess file, you can take them
3194     and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
3195     <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
3196     be a major benefit here if your installation is suited to using it. Then
3197     you can just add those updated lines into the
3198     <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
3199     <br /><br />
3200     If you want a pre-made sample, you can try this fragment. It stops the
3201     'root' user from logging in from any networks other than the private
3202     network IP blocks.
3203     <br />
3204     <tt>
3205     &nbsp;&nbsp;&nbsp;&nbsp;//block root from logging in except from the private networks<br />
3206     &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
3207     &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
3208     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'deny root from all',<br />
3209     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from localhost',<br />
3210     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 10.0.0.0/8',<br />
3211     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 192.168.0.0/16',<br />
3212     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 172.16.0.0/12',<br />
3213     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);
3214     </tt>
3215 </p>
3216 <h4>
3217     [4.7] Authentication window is displayed more than once, why?
3218 </h4>
3219 <p>
3220     This happens if you are using a URL to start phpMyAdmin which is
3221     different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
3222     For example, a missing &quot;www&quot;, or entering with an IP address
3223     while a domain name is defined in the config file.
3224 </p>
3225
3226 <a name="faqbrowsers"></a><br />
3227 <h3>[5. Browsers or client OS]</h3>
3228
3229 <h4>
3230     [5.1] I get an out of memory error, and my controls are non-functional,
3231     when trying to create a table with more than 14 fields.
3232 </h4>
3233 <p>
3234     We could reproduce this problem only under Win98/98SE. Testing under
3235     WinNT4 or Win2K, we could easily create more than 60 fields.
3236     <br />
3237     A workaround is to create a smaller number of fields, then come back to
3238     your table properties and add the other fields.
3239 </p>
3240
3241 <h4>
3242     [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
3243 </h4>
3244 <p>
3245     This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
3246     with each script/website that use forms.<br />
3247     Upgrade or downgrade your Xitami server.
3248 </p>
3249
3250 <h4>
3251     [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
3252 </h4>
3253 <p>
3254     With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
3255     the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
3256     don't seem to work.<br />
3257
3258     With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
3259     the user's temporary directory, so they must be moved before closing
3260     Konqueror, or else they disappear. GZip dumps give an error message.<br />
3261
3262     Testing needs to be done for Konqueror 2.2.2.<br />
3263 </p>
3264
3265 <h4>
3266     [5.4] I can't use the cookie authentication mode because Internet
3267     Explorer never stores the cookies.
3268 </h4>
3269 <p>
3270     MS Internet Explorer seems to be really buggy about cookies, at least till
3271     version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
3272     in this area!
3273     <br />
3274     Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
3275     work!
3276 </p>
3277
3278 <h4>
3279     [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
3280     rows.
3281 </h4>
3282 <p>
3283     Upgrade to at least Internet Explorer 5.5 SP2.<br />
3284 </p>
3285
3286 <h4>
3287     [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
3288     when trying to modify a row in a table with many fields, or with a text field
3289 </h4>
3290 <p>
3291     Your table neither have a primary key nor an unique one, so we must use a
3292     long URL to identify this row. There is a limit on the length of the URL in
3293     those browsers, and this not happen in Netscape, for example. The
3294     workaround is to create a primary or unique key, or use another browser.
3295     <br />
3296 </p>
3297
3298 <h4>
3299     [5.7] I refresh (reload) my browser, and come back to the welcome
3300     page.
3301 </h4>
3302 <p>
3303     Some browsers support right-clicking into the frame you want to refresh,
3304     just do this in the right frame.<br />
3305 </p>
3306
3307 <h4>
3308     [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
3309     query box.
3310 </h4>
3311 <p>
3312     Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
3313     Mozilla versions.<br />
3314 </p>
3315
3316 <h4>
3317     [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
3318     whitespace in the SQL-Query edit area: the page scrolls down.
3319 </h4>
3320 <p>
3321     This is a Mozilla bug (see bug #26882 at
3322     <a href="http://bugzilla.mozilla.org/" target="_blank">BugZilla</a>).<br />
3323 </p>
3324
3325 <h4>
3326     [5.10] With Netscape 4.75 I get empty rows between each row of data in a
3327     CSV exported file.
3328 </h4>
3329 <p>
3330     This is a known Netscape 4.75 bug: it adds some line feeds when exporting
3331     data in octet-stream mode. Since we can't detect the specific Netscape
3332     version, we cannot workaround this bug.
3333 </p>
3334
3335 <h4>
3336     [5.11] Extended-ASCII characters like German umlauts are displayed
3337     wrong.
3338 </h4>
3339 <p>
3340     Please ensure that you have set your browser's character set to the one of the
3341     language file you have selected on phpMyAdmin's start page.
3342     Alternatively, you can try the auto detection mode that is supported by the
3343     recent versions of the most browsers.
3344 </p>
3345
3346 <h4>
3347     [5.12] Apple OS X: Safari browser changes special characters to
3348     &quot;?&quot;.
3349 </h4>
3350 <p>
3351     This issue has been reported by a OS X user, who adds that Chimera,
3352     Netscape and Mozilla do not have this problem.
3353 </p>
3354
3355 <h4>
3356     [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
3357     I cannot manage two servers: I login to the first one, then the other one,
3358     but if I switch back to the first, I have to login on each operation.
3359 </h4>
3360 <p>
3361     This is a bug in Internet Explorer, other browsers do not behave this way.
3362 </p>
3363
3364 <h4>
3365     [5.14] Using Opera6, I can manage to get to the authentication, but nothing
3366     happens after that, only a blank screen.
3367 </h4>
3368 <p>
3369     Having $cfg['QueryFrameJS'] set to <tt>TRUE</tt>, this leads to a bug in Opera6, because it
3370     is not able to interpret frameset definitiions written by JavaScript. Please upgrade
3371     to Opera7 at least.
3372 </p>
3373 <h4>
3374     [5.15] I have display problems with Safari.
3375 </h4>
3376 <p>
3377     Please upgrade to at least version 1.2.3.
3378 </p>
3379 <h4>
3380     [5.16] With Internet Explorer, I get &quot;Access is denied&quot;
3381     Javascript errors. Or I cannot make phpMyAdmin work under Windows.
3382 </h4>
3383 <p>
3384     Please check the following points:</p>
3385     <ul>
3386         <li>
3387             Maybe you have defined your <tt>PmaAbsoluteUri</tt> setting
3388             in <tt>config.inc.php</tt> to an IP address and you are starting
3389             phpMyAdmin with a URL containing a domain name, or the reverse situation.
3390         </li>
3391         <li>
3392             Security settings in IE and/or Microsoft Security Center are
3393             too high, thus blocking scripts execution.
3394         </li>
3395         <li>
3396             The Windows Firewall is blocking Apache and MySQL. You must
3397             allow http ports (80 or 443) and MySQL port (usually 3306)
3398             in the &quot;in&quot; and &quot;out&quot; directions.
3399         </li>
3400     </ul>
3401 <h4>
3402     [5.17] With Firefox, I cannot delete rows of data or drop a database.
3403 </h4>
3404 <p> Many users have confirmed that the Tabbrowser Extensions plugin they
3405     installed in their Firefox is causing the problem.
3406 </p>
3407
3408 <a name="faqusing"></a><br />
3409 <h3>[6. Using phpMyAdmin]</h3>
3410
3411 <h4>
3412     [6.1] I can't insert new rows into a table / I can't create a table
3413     - MySQL brings up a SQL-error.
3414 </h4>
3415 <p>
3416     Examine the SQL error with care. Often the problem is caused by
3417     specifying a wrong field-type.<br />
3418     Common errors include:
3419 </p>
3420 <ul>
3421     <li>Using <tt>VARCHAR</tt> without a size argument</li>
3422     <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
3423 </ul>
3424 <p>
3425     Also, look at the syntax chapter in the MySQL manual to confirm that your
3426     syntax is correct.
3427 </p>
3428
3429 <h4>
3430     [6.2] When I create a table, I click the Index checkbox for 2 fields and
3431     phpMyAdmin generates only one index with those 2 fields.
3432 </h4>
3433 <p>
3434     In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
3435     index. If you want two indexes, create the first one when creating the
3436     table, save, then display the table properties and click the Index link to
3437     create the other index.
3438 </p>
3439
3440 <h4>
3441     [6.3] How can I insert a null value into my table?
3442 </h4>
3443 <p>
3444     Since version 2.2.3, you have a checkbox for each field that can be null.
3445     Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
3446     field's value. Since version 2.5.5, you have to use the checkbox to get
3447     a real NULL value, so if you enter &quot;NULL&quot; this means you want
3448     a literal NULL in the field, and not a NULL value (this works in PHP4).
3449 </p>
3450
3451 <h4>
3452     [6.4] How can I backup my database or table?
3453 </h4>
3454 <p>
3455     Click on a database or table name in the left frame, the properties will be
3456     displayed.  Then on the menu, click &quot;Export&quot;, you can dump
3457     the structure, the data, or both. This will generate standard SQL
3458     statements that can be used to recreate your database/table.
3459     <br /><br />
3460     You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
3461     transmit the resulting dump to your station. Depending on your PHP
3462     configuration, you will see options to compress the dump. See also the
3463     <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
3464     <br /><br />
3465     For additional help on this subject, look for the word &quot;dump&quot; in
3466     this document.
3467 </p>
3468
3469 <h4>
3470     [6.5] How can I restore (upload) my database or table using a dump?
3471     How can I run a &quot;.sql&quot; file.
3472 </h4>
3473 <p>
3474     Click on a database name in the left frame, the properties will be
3475     local displayed.  Then in the &quot;Run SQL query&quot; section, type in
3476     your dump filename, or use the Browse button. Then click Go.
3477     <br /><br />
3478     For additional help on this subject, look for the word &quot;upload&quot;
3479     in this document.
3480 </p>
3481 <a name="faq6_6"></a><br />
3482 <h4>
3483     [6.6] How can I use the relation table in Query-by-example?
3484 </h4>
3485 <p>
3486     Here is an example with the tables persons, towns and countries, all
3487     located in the database mydb. If you don't have a <tt>pma_relation</tt>
3488     table, create it as explained in the configuration section. Then create the
3489     example tables:
3490     <br /><br />
3491     <tt>
3492     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_countries (<br />
3493     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
3494     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(10) NOT NULL default '',<br />
3495     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (country_code)<br />
3496     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3497     <br />
3498     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
3499     <br />
3500     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_persons (<br />
3501     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id tinyint(4) NOT NULL auto_increment,<br />
3502     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;person_name varchar(32) NOT NULL default '',<br />
3503     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) default '0',<br />
3504     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
3505     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (id)<br />
3506     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3507     <br />
3508     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
3509     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
3510     <br />
3511     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_towns (<br />
3512     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) NOT NULL default '0',<br />
3513     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(30) NOT NULL default '',<br />
3514     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (town_code)<br />
3515     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3516     <br />
3517     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
3518     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');<br />
3519     <br />
3520     </tt>
3521     To setup appropriate links and display information:
3522 </p>
3523 <ul>
3524     <li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
3525     <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
3526     <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
3527     <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
3528     <li>in &quot;Choose field to display&quot;, choose &quot;description&quot;</li>
3529     <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
3530 </ul>
3531
3532 <p>
3533     Then test like this:
3534 </p>
3535 <ul>
3536     <li>Click on your db name in the left frame</li>
3537     <li>Choose &quot;Query&quot;</li>
3538     <li>Use tables: persons, towns, countries</li>
3539     <li>Click &quot;Update query&quot;</li>
3540     <li>In the fields row, choose persons.person_name and click the
3541         &quot;Show&quot; tickbox </li>
3542     <li>Do the same for towns.description and countries.descriptions in the
3543         other 2 columns</li>
3544     <li>Click &quot;Update query&quot; and you will see in the query box that
3545         the correct joins have been generated</li>
3546     <li>Click &quot;Submit query&quot;</li>
3547 </ul>
3548 <br />
3549
3550 <a name="faqdisplay"></a><br />
3551 <h4>
3552     [6.7] How can I use the &quot;display field&quot; feature?
3553 </h4>
3554 <p>
3555     Starting from the previous example, create the pma_table_info as explained
3556     in the configuration section, then browse your persons table,
3557     and move the mouse over a town code or country code.
3558     <br /><br />
3559     See also <a href="#faq6_21">FAQ 6.21</a> for an additionnal feature that &quot;display field&quot;
3560     enables: drop-down list of possible values.
3561 </p>
3562
3563 <a name="faqpdf"></a><br />
3564 <h4>
3565     [6.8] How can I produce a PDF schema of my database?
3566 </h4>
3567 <p>
3568     First the configuration variables &quot;relation&quot;,
3569     &quot;table_coords&quot; and &quot;pdf_pages&quot; have to be filled in.
3570     <br /><br />
3571     Then you need to think about your schema layout. Which tables will go on
3572     which pages?
3573 </p>
3574 <ul>
3575     <li>Select your database in the left frame.</li>
3576     <li>Choose &quot;Operations&quot; in the navigation bar at the top.</li>
3577     <li>Choose &quot;Edit PDF Pages&quot; near the bottom of the page.</li>
3578     <li>Enter a name for the first PDF page and click Go. If you like, you
3579         can use the &quot;automatic layout,&quot; which will put all your
3580         linked tables onto the new page.</li>
3581     <li>Select the name of the new page (the action choice being set to Edit)
3582         and click Go.</li>
3583     <li>Select a table from the list, enter its coordinates and click Go.<br />
3584         Coordinates are relative; your diagram will
3585         be automatically scaled to fit the page. When initially placing tables
3586         on the page, just pick any coordinates -- say, 50x50. After clicking
3587         Go, you can then use the <a href="#wysiwyg">graphical editor</a> to
3588         position the element correctly.</li>
3589     <li>When you'd like to look at your PDF, first be sure to click the Go
3590         button beneath the list of tables and coordinates, to save any changes
3591         you made there. Then scroll all the way down, select the PDF options
3592         you want, and click Go.</li>
3593     <li>Internet Explorer for Windows may suggest an incorrect filename when
3594         you try to save a generated PDF. When saving a generated PDF, be
3595         sure that the filename ends in &quot;.pdf&quot;, for example
3596         &quot;schema.pdf&quot;. Browsers on other operating systems, and other
3597         browsers on Windows, do not have this problem.</li>
3598 </ul>
3599
3600 <h4>
3601     [6.9] phpMyAdmin is changing the type of one of my columns!
3602 </h4>
3603 <p>
3604     No, it's MySQL that is doing
3605     <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3606 </p>
3607
3608 <a name="underscore"></a><br />
3609 <h4>
3610     [6.10] When creating a privilege, what happens with underscores in
3611     the database name?
3612 </h4>
3613 <p>
3614     If you do not put a backslash before the underscore, this is a wildcard
3615     grant, and the underscore means &quot;any character&quot;. So, if the
3616     database name is &quot;john_db&quot;, the user would get rights to john1db,
3617     john2db...<br /><br />
3618     If you put a backslash before the underscore, it means that the database
3619     name will have a real underscore.
3620 </p>
3621
3622 <h4>
3623     [6.11] What is the curious symbol &oslash; in the statistics pages?
3624 </h4>
3625 <p>
3626     It means &quot;average&quot;.
3627 </p>
3628
3629 <a name="faqexport"></a><br />
3630 <h4>
3631     [6.12] I want to understand some Export options.
3632 </h4>
3633     <p><b>Structure:</b></p>
3634     <ul>
3635         <li>&quot;Add DROP TABLE&quot; will add a line telling MySQL to
3636         <a href="http://dev.mysql.com/doc/mysql/en/drop-table.html">drop the table</a>,
3637         if it already exists during the import. It does NOT drop the table after
3638         your export, it only affects the import file.</li>
3639         <li>&quot;If Not Exists&quot; will only create the table if it doesn't exist. Otherwise,
3640         you may get an error if the table name exists but has a different structure.</li>
3641         <li>&quot;Add AUTO_INCREMENT value&quot; ensures that AUTO_INCREMENT value
3642         (if any) will be included in backup.</li>
3643         <li>&quot;Enclose table and field names with backquotes&quot; ensures that
3644         field and table names formed with special characters are protected.</li>
3645         <li>&quot;Add into comments&quot; includes column comments, relations, and MIME
3646         types set in the pmadb in the dump as SQL comments (<i>/* xxx */</i>).</li>
3647     </ul>
3648     <p><b>Data:</b></p>
3649     <ul>
3650         <li>&quot;Complete inserts&quot; adds the column names on every INSERT command,
3651         for better documentation (but resulting file is bigger).</li>
3652         <li>&quot;Extended inserts&quot; provides a shorter dump file by using only
3653         once the INSERT verb and the table name.</li>
3654         <li>&quot;Delayed inserts&quot; are best explained in the
3655         <a href="http://dev.mysql.com/doc/mysql/en/insert-delayed.html">MySQL manual</a>.</li>
3656         <li>&quot;Ignore inserts&quot; treats errors as a warning instead. Again, more info
3657         is provided in the <a href="http://dev.mysql.com/doc/mysql/en/insert.html">MySQL
3658         manual</a>, but basically with this selected, invalid values are adjusted and inserted
3659         rather than causing the entire statement to fail.</li>
3660     </ul>
3661
3662 <h4>
3663     [6.13] I would like to create a database with a dot in its name.
3664 </h4>
3665 <p>
3666     This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
3667     is the normal way to reference a database and table name. Worse, MySQL
3668     will usually let you create a database with a dot, but then you cannot
3669     work with it, nor delete it.<br />
3670 </p>
3671
3672 <a name="faqsqlvalidator"></a><br />
3673 <h4>
3674     [6.14] How do I set up the SQL Validator?
3675 </h4>
3676 <p>
3677     To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3678     XML, PCRE and PEAR support. On your system command line, run
3679     <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3680       SOAP"</tt> to get the necessary PEAR modules for usage.
3681     <br />
3682     On a more recent pear version, I had problems with the state of Net_DIME
3683     being beta, so this single command
3684     <tt>"pear -d preferred_state=beta install -a SOAP"</tt> installed
3685     all the needed modules.
3686     <br />
3687     If you use the Validator, you should be aware that any SQL statement you
3688     submit will be stored anonymously (database/table/column names,
3689     strings, numbers replaced with generic values). The Mimer SQL
3690     Validator itself, is &copy; 2001 Upright Database Technology.
3691     We utilize it as free SOAP service.
3692 </p>
3693
3694 <h4>
3695     [6.15] I want to add a BLOB field and put an index on it, but MySQL
3696     says &quot;BLOB column '...' used in key specification without a key
3697     length&quot;.
3698 </h4>
3699 <p>
3700     The right way to do this, is to create the field without any indexes,
3701     then display the table structure and use the &quot;Create an index&quot;
3702     dialog. On this page, you will be able to choose your BLOB field, and
3703     set a size to the index, which is the condition to create an index on
3704     a BLOB field.
3705     <br />
3706 </p>
3707
3708 <h4>
3709     [6.16] How can I simply move in page with plenty editing fields?
3710 </h4>
3711 <p>
3712     You can use Ctrl+arrows (Option+Arrows in Safari) for moving on most pages
3713     with many editing fields (table structure changes, row editing, etc.)
3714     (must be enabled in configuration - see.
3715     <a href="#CtrlArrowsMoving">$cfg['CtrlArrowsMoving']</a>). You can also have
3716     a look at the directive
3717     <a href="#DefaultPropDisplay">$cfg['DefaultPropDisplay']</a> ('vertical') and
3718     see if this eases up editing for you.
3719     <br />
3720 </p>
3721
3722 <h4>
3723     [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3724     then useful for?
3725 </h4>
3726 <p>
3727     Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3728     Otherwise you could just put a comment on the field. Because entering your own mimetype will
3729     cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3730     situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3731     <br />
3732     Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3733     he/she can enter it at will?
3734     <br />
3735 </p>
3736
3737 <a name="faqbookmark"></a>
3738 <h4>
3739     [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3740      What is this variable for?
3741 </h4>
3742 <p>
3743     Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3744     You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3745     As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3746     now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3747     <br />
3748     Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3749     <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3750     box on the query box page will replace the string &quot;/*[VARIABLE]*/&quot; in your stored query.
3751     Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3752     stored in the database.<br />
3753     Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3754     the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3755     <code>/*, [VARIABLE] AS myname */</code><br /><br />
3756     which will be expanded to<br /><br />
3757     <code>, VARIABLE as myname</code><br /><br />
3758     in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3759     provided, no replacements are made.<br />
3760     <br />
3761     A more complex example. Say you have stored this query:<br /><br />
3762     <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3763     Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query, the full query will
3764     be:<br /><br />
3765     <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3766     <br />
3767     <br />
3768     You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3769     <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any spaces inserted there
3770     will be later also inserted as spaces in your query and may lead to unexpected results especially when
3771     using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
3772     Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3773     you can store the bookmark. You may have that to work around using well positioned &quot;/**/&quot;
3774     comments.<br />
3775 </p>
3776
3777 <h4>
3778     [6.19] How can I create simple LaTeX document to include exported table?
3779 </h4>
3780 <p>
3781     You can simply include table in your LaTeX documents, minimal sample
3782     document should look like following one (assuming you have table
3783     exported in file <code>table.tex</code>):
3784 </p>
3785
3786 <pre>
3787 \documentclass{article} % or any class you want
3788 \usepackage{longtable}  % for displaying table
3789 \begin{document}        % start of document
3790 \include{table}         % including exported table
3791 \end{document}          % end of document
3792 </pre>
3793
3794 <h4>
3795     [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3796     access them.
3797 </h4>
3798 <p>
3799     Upgrading to MySQL 4 usually gives users those global privileges: CREATE
3800     TEMPORARY TABLES, SHOW DATABASES, LOCK TABLES. Those privileges also
3801     enables users to see all the database names, until you upgrade the grant
3802     tables
3803     <a href="http://dev.mysql.com/doc/mysql/en/Upgrading-grant-tables.html">
3804         as described in the MySQL manual</a>.
3805     See this <a href="http://bugs.mysql.com/179">bug report</a>.    <br /><br />
3806     So if your users do not need those privileges, you can remove them and their
3807     databases list will shorten.
3808 </p>
3809 <a name="faq6_21"></a><br />
3810 <h4>
3811     [6.21] In edit/insert mode, how can I see a list of possible values for
3812     a field, based on some foreign table?
3813 </h4>
3814 <p>
3815     You have to setup appropriate links between the tables, and also
3816     setup the &quot;display field&quot; in the foreign table. See <a href="#faq6_6">FAQ
3817     6.6</a> for an example. Then, if there are 200 values or less in the
3818     foreign table, a drop-down list of values will be available.
3819     You will see two lists of values, the first list containing the key
3820     and the display field, the second list containing the display field
3821     and the key. The reason for this is to be able to type the first
3822     letter of either the key or the display field.
3823     <br /><br />
3824     For 200 values or more, a distinct window will appear, to browse foreign
3825     key values and choose one.
3826
3827 </p>
3828 <h4>
3829     [6.22] Bookmarks: Can I execute a default bookmark automatically
3830     when entering Browse mode for a table?
3831 </h4>
3832 <p>
3833     Yes. If a bookmark has the same label as a table name, it will be
3834     executed.
3835 </p>
3836 <h4>
3837     <a name="faq6_23"></a>
3838     [6.23] Export: I heard phpMyAdmin can export Microsoft Excel files, how
3839     can I enable that?
3840 </h4>
3841 <p>
3842     Current version does support direct export ot Microsoft Excel and Word
3843     versions 2000 and newer. If you need export older versions, you can use
3844     CSV suitable for Microsoft Excel, which works out of the box or you can
3845     try native <b>experimental</b> MS Excel exporter. <b>This export has
3846     several problems, most important are limitation of cell content to 255
3847     chars and no support for charsets, so think carefully whether you want to
3848     enable this.</b>.  For enabling this you need to set $cfg['TempDir'] to
3849     place where web server user can write (for example <tt>'./tmp'</tt>) and
3850     install PEAR module Spreadsheet_Excel_Writer into php include path. The
3851     installation can be done by following command:
3852 </p>
3853 <pre>
3854     pear -d preferred_state=beta install -a Spreadsheet_Excel_Writer
3855 </pre>
3856 <p>
3857     First part of switches set we want to install beta version of that module
3858     (no stable version available yet) and then we tell pear we want to satisfy
3859     dependencies.
3860 </p>
3861 <p>
3862     If you are running in PHP safe mode, you will have to set
3863     in <tt>php.ini</tt> the <tt>safe_mode_include_dir</tt> to the directory
3864     where your PEAR modules are located, for example:
3865 </p>
3866 <pre>
3867     safe_mode_include_dir = /usr/local/lib/php
3868 </pre>
3869 <p>
3870     To create the temporary directory on a UNIX-based system, you can do:
3871 </p>
3872 <pre>
3873     cd phpMyAdmin
3874     mkdir tmp
3875     chmod o+rwx tmp
3876 </pre>
3877 <h4>
3878     [6.24] Now that phpMyAdmin supports native MySQL 4.1.x column comments,
3879     what happens to my column comments stored in pmadb?
3880 </h4>
3881 <p> Automatic migration of a table's pmadb-style column comments to the native
3882     ones is done whenever you enter Structure page for this table.
3883 </p>
3884 <a name="faqproject"></a><br />
3885 <h3>[7. phpMyAdmin project]</h3>
3886
3887 <h4>
3888     [7.1] I have found a bug. How do I inform developers?
3889 </h4>
3890 <p>
3891     Our Bug Tracker is located at
3892     <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3893     under the Bugs section.
3894     <br /><br />
3895     But please first discuss your bug with other users:
3896     <br />
3897     <a href="http://sourceforge.net/projects/phpmyadmin/">
3898         http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3899 </p>
3900
3901 <h4>
3902     [7.2] I want to translate the messages to a new language or upgrade an
3903     existing language, where do I start?
3904 </h4>
3905 <p>
3906     Always use the current CVS version of your language file.
3907     For a new language, start from <i>english-iso-8859-1.inc.php</i>. If you
3908     don't  know how to get the CVS version, please ask one of the developers.
3909     <br />
3910     Please note that we try not to use HTML entities like &amp;eacute; in
3911     the translations, since we define the right character set in the file.
3912     With HTML entities, the text on JavaScript messages would not
3913     display correctly.
3914     However there are some entities that need to be there, for quotes
3915     ,non-breakable spaces, ampersands, less than, greater than.
3916     <br />
3917     You can then put your translations, as a zip file to avoid losing special
3918     characters, on the sourceforge.net translation tracker.
3919     <br />
3920     It would be a good idea to subscribe to the phpmyadmin-translators mailing
3921     list, because this is where we ask for translations of new messages.
3922     <br />
3923 </p>
3924
3925 <h4>
3926     [7.3] I would like to help out with the development of phpMyAdmin. How
3927     should I proceed?
3928 </h4>
3929 <p>
3930     The following method is preferred for new developers:
3931 </p>
3932 <ol>
3933     <li>
3934         fetch the current CVS tree over anonymous CVS:<br />
3935         <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3936         [Password: simply press the Enter key]<br />
3937         <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3938         [This will create a new sub-directory named phpMyAdmin]
3939     </li>
3940     <li>
3941         add your stuff
3942     </li>
3943     <li>
3944         put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3945         the
3946         <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3947     </li>
3948 </ol>
3949 <p>
3950     Write access to the CVS tree is granted only to experienced developers who
3951     have already contributed something useful to phpMyAdmin.<br />
3952     Also, have a look at the
3953     <a href="#developers">Developers section</a>.
3954 </p>
3955 <a name="faqsecurity"></a><br />
3956 <h3>[8. Security ]</h3>
3957
3958 <h4>
3959     [8.1] Security alert, dated 2003-06-18.
3960 </h4>
3961 <p>
3962     Last update of this FAQ: 2003-07-22.
3963     <br /><br />
3964     The phpMyAdmin development team received notice of this security alert:
3965     <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3966     <br /><br />
3967
3968     The team regrets that the author did not communicate with us before
3969     sending this alert. However, here is our current reply to the points mentionned:
3970 </p>
3971
3972 <ul>
3973     <li>&quot;Directory transversal attack&quot;
3974     <br /><br />
3975
3976     This problem had been fixed in version 2.5.0, even if the author reports
3977     the 2.5.2 development version as vulnerable, which we could not reproduce.
3978     <br /><br />
3979     </li>
3980     <li>&quot;Remote local file retrieving&quot;
3981     <br /><br />
3982     This is a misleading title, as the author tells in his text:
3983     &quot;Note that you can't request files ( only dirs )&quot;.
3984     <br /><br />
3985     </li>
3986
3987     <li>&quot;Remote internal directory listing&quot;
3988     <br /><br />
3989     It was possible to retrieve the list of phpMyAdmin's directory (which we
3990     doubt can cause any damage), but we fixed this in the
3991     2.5.2 version.
3992     <br /><br />
3993     </li>
3994
3995     <li>&quot;XSS and Path disclosures&quot;
3996     <br /><br />
3997     Most of the XSS problems have been fixed in version 2.5.0. The rest
3998     have been fixed in the 2.5.2 version.
3999     <br /><br />
4000     We believe that the Path disclosures problems have also been fixed
4001     in version 2.5.2.
4002     <br /><br />
4003     </li>
4004     <li>&quot;Information encoding weakness&quot;
4005     <br /><br />
4006     We believe that an exploit for this weakness would be difficult
4007     to achieve.  However version 2.5.2 now encrypts the password
4008     with the well-known blowfish algorithm.
4009     <br /><br />
4010     </li>
4011 </ul>
4012 <h4>
4013     [8.2] Security alert, dated 2004-06-29.
4014 </h4>
4015 <p>
4016     Last update of this FAQ: 2004-06-30.
4017     <br /><br />
4018     The phpMyAdmin development team received notice of this security alert:
4019     <a href="http://securityfocus.com/archive/1/367486/2004-06-26/2004-07-02/0" target="_blank">http://securityfocus.com/archive/1/367486/2004-06-26/2004-07-02/0</a>
4020     <br /><br />
4021     We would like to put emphasis on the disappointment we feel when a
4022     bugreporter does not contact the authors of a software first, before
4023     posting any exploits. The common way to report this, is to give the
4024     developers a reasonable amount of time to respond to an exploit before
4025     it is made public.
4026     <br /><br />
4027     We acknowledge that phpMyAdmin versions 2.5.1 to 2.5.7 are vulnerable
4028     to this problem, if each of the following conditions are met:
4029 </p>
4030 <ul>
4031     <li>
4032     The Web server hosting phpMyAdmin is not running in safe mode.
4033     </li>
4034     <li>
4035     In config.inc.php, <tt>$cfg['LeftFrameLight']</tt> is set to FALSE
4036     (the default value of this parameter is <tt>TRUE</tt>).
4037     </li>
4038     <li>
4039     There is no firewall blocking requests from the Web server to the
4040     attacking host.
4041     </li>
4042 </ul>
4043 <p>
4044     <br />
4045     Version 2.5.7-pl1 was released with a fix for this vulnerability.
4046 </p>
4047 <h4>
4048     [8.3] About new security alerts
4049 </h4>
4050 <p>
4051     Please refer to
4052     <a href="http://www.phpmyadmin.net">http://www.phpmyadmin.net</a>
4053     for the complete list of security alerts.
4054 </p>
4055
4056 <!-- DEVELOPERS -->
4057 <a name="developers"></a><br />
4058 <h2>Developers Information</h2>
4059
4060 <p>
4061     phpMyAdmin is Open Source, so you're invited to contribute to it. Many
4062     great features have been written by other people and you too can help to
4063     make phpMyAdmin a useful tool.
4064 </p>
4065
4066 <p>
4067     If you're planning to contribute source, please read the following
4068     information:
4069 </p>
4070 <ul>
4071     <li>
4072         All files include <i>header.inc.php</i> (layout),
4073         <i>libraries/common.lib.php</i> (common functions) and
4074         <i>config.inc.php</i>.
4075         <br />
4076         Only configuration data should go in <i>config.inc.php</i>. Please keep
4077         it free from other code.
4078         <br />
4079         Commonly used functions should be added to
4080         <i>libraries/common.lib.php</i> and more specific ones may be added
4081         within a library stored into the <i>libraries</i> sub-directory.
4082     </li>
4083     <li>
4084         Obviously, you're free to use whatever coding style you want. But
4085         please try to keep your code as simple as possible: beginners are
4086         using phpMyAdmin as an example application.<br />
4087         As far as possible, we want the scripts to be XHTML1.0 and CSS2
4088         compliant on one hand, they fit the
4089         <a href="http://pear.php.net/" target="_blank">PEAR coding standards</a>
4090         on the other hand. Please pay attention to this.
4091     </li>
4092     <li>
4093         Please try to keep up the file-naming conventions. Table-related stuff
4094         goes to <i>tbl_*.php</i>, db-related code to <i>db_*.php</i>,
4095         server-related tools to <i>server_*.php</i> and so on.
4096     </li>
4097     <li>
4098         Please don't use verbose strings in your code, instead add the string
4099         (at least) to <i>english-iso-8859-1.inc.php</i> and print() it out.
4100     </li>
4101     <li>
4102         If you want to be really helpful, write an entry for the ChangeLog.
4103     </li>
4104     <li id="developersdbg">
4105         The DBG extension (<a href="http://dd.cron.ru/dbg/" target="_blank">PHP
4106           Debugger DBG</a>) is now supported by phpMyAdmin for developers to
4107         better debug and profile their code.<br />
4108         Please see the <tt>$cfg['DBG']*</tt> configuration options for more
4109         information.<br />
4110         This is in memoriam of the Space Shuttle Columbia (STS-107) which was
4111         lost during its re-entry into Earth's atmosphere and in memory of the
4112         brave men and women who gave their lives for the people of Earth.
4113     </li>
4114
4115 </ul>
4116
4117 <!-- CREDITS -->
4118 <a name="credits"></a><br />
4119 <h2>Credits</h2>
4120
4121 <pre>
4122
4123 phpMyAdmin - Credits
4124 ====================
4125
4126 CREDITS, in chronological order
4127 -------------------------------
4128
4129 - Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4130     * creator of the phpmyadmin project
4131     * maintainer from 1998 to summer 2000
4132
4133 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt;
4134     * multi-language version
4135     * various fixes and improvements
4136     * SQL analyser (most of it)
4137     * current project maintainer
4138
4139 - Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
4140     * started SourceForge phpMyAdmin project in March 2001
4141     * sync'ed different existing CVS trees with new features and bugfixes
4142     * multi-language improvements, dynamic language selection
4143     * current project maintainer
4144     * many bugfixes and improvements
4145
4146 - Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
4147     * rewrote and optimized javascript, DHTML and DOM stuff
4148     * rewrote the scripts so they fit the PEAR coding standards and
4149       generate XHTML1.0 and CSS2 compliant codes
4150     * improved the language detection system
4151     * many bugfixes and improvements
4152
4153 - Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4154     * database maintenance controls
4155     * table type code
4156     * Host authentication IP Allow/Deny
4157     * DB-based configuration (Not completed)
4158     * SQL parser and pretty-printer
4159     * SQL validator
4160     * many bugfixes and improvements
4161
4162 - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
4163     * bookmarks feature
4164     * multiple dump feature
4165     * gzip dump feature
4166     * zip dump feature
4167
4168 - Geert Lund &lt;glund_at_silversoft.dk&gt;
4169     * various fixes
4170     * moderator of the phpMyAdmin users forum at phpwizard.net
4171
4172 - Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
4173     * &quot;insert as new row&quot; feature
4174
4175 - Pete Kelly &lt;webmaster_at_trafficg.com&gt;
4176     * rewrote and fix dump code
4177     * bugfixes
4178
4179 - Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
4180     * rewrote dump code for PHP4
4181     * mySQL table statistics
4182     * bugfixes
4183
4184 - Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
4185     * main author of the version 2.1.0.1
4186     * bugfixes
4187
4188 - Alexander M. Turek &lt;me_at_derrabus.de&gt;
4189     * MySQL 4.0 / 4.1 / 5.0 compatibility
4190     * abstract database interface (PMA_DBI) with MySQLi support
4191     * privileges administration
4192     * XML exports
4193     * various features and fixes
4194     * German language file updates
4195
4196 - Mike Beck &lt;mike.beck_at_web.de&gt;
4197     * automatic joins in QBE
4198     * links column in printview
4199     * Relation view
4200
4201 - Michal &#268;iha&#345; &lt;michal_at_cihar.com&gt;
4202     * enhanced index creation/display feature
4203     * feature to use a different charset for HTML than for MySQL
4204     * improvements of export feature
4205     * various features and fixes
4206     * Czech language file updates
4207
4208 - Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
4209   (http://sourceforge.net/projects/phpmysqlformgen/)
4210     * suggested the patch for multiple table printviews
4211
4212 - Garvin Hicking &lt;me_at_supergarv.de&gt;
4213     * built the patch for vertical display of table rows
4214     * built the Javascript based Query window + SQL history
4215     * Improvement of column/db comments
4216     * (MIME)-Transformations for columns
4217     * Use custom alias names for Databases in left frame
4218     * hierarchical/nested table display
4219     * PDF-scratchboard for WYSIWYG-distribution of PDF relations
4220     * new icon sets
4221     * vertical display of column properties page
4222     * some bugfixes, features, support, German language additions
4223
4224 - Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
4225     * japanese kanji encoding conversion feature
4226
4227 - Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
4228     * the Cookie authentication mode
4229
4230 - Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
4231     * table relation-links feature
4232
4233 - Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
4234     * PDF schema output, thanks also to Olivier Plathey for the
4235       &quot;FPDF&quot; library (see <a href="http://www.fpdf.org/">http://www.fpdf.org/</a>) and Steven Wittens
4236       for the &quot;UFPDF&quot; library (see <a href="http://www.acko.net/node/56">http://www.acko.net/node/56</a>).
4237
4238 - Olof Edlund &lt;olof.edlund_at_upright.se&gt;
4239     * SQL validator server
4240
4241 - Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
4242     * phpMyAdmin logo (until June 2004)
4243
4244 - Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
4245     * blowfish library from the Horde project
4246
4247 - Marcel Tschopp &lt;ne0x_at_users.sourceforge.net&gt;
4248     * mysqli support
4249     * many bugfixes and improvements
4250
4251 - Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4252     * redesign for 2.6.0
4253     * phpMyAdmin sailboat logo (June 2004)
4254
4255 - Mathias Landh&auml;u&szlig;er
4256     * Representation at conferences
4257
4258 And also to the following people who have contributed minor changes,
4259 enhancements, bugfixes or support for a new language since version 2.1.0:
4260
4261 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
4262 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
4263 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
4264 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
4265 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
4266 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
4267 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
4268 Luís V., Martijn W. van der Lee,
4269 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
4270 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
4271
4272
4273 Original Credits of Version 2.1.0
4274 ---------------------------------
4275
4276     This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
4277     to create a web-based interface to MySQL using PHP3. Although I have not
4278     used any of his source-code, there are some concepts I've borrowed from
4279     him. phpMyAdmin was created because Peter told me he wasn't going to
4280     further develop his (great) tool.
4281     Thanks go to
4282     - Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
4283       code for the check when dropping a table or database. He also suggested
4284       that you should be able to specify the primary key on tbl_create.php3. To
4285       version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
4286       well as a bug-report. Plus many smaller improvements.
4287     - Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
4288       were introduced in 1.3.0 (including quite significant ones like the
4289       authentication). For 1.4.1 he enhanced the table-dump feature. Plus
4290       bug-fixes and help.
4291     - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
4292       language-independent by outsourcing the strings to a separate file. He
4293       also contributed the French translation.
4294     - Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
4295       tbl_select.php3, a feature to display only some fields from a table.
4296     - Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
4297       functions in tbl_change.php3. He also added the
4298       &quot;Query by Example&quot; feature in 2.0.
4299     - Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
4300       servers and is a regular contributor for bug-fixes.
4301     - Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
4302       features for 2.0.6.
4303     The following people have contributed minor changes, enhancements, bugfixes
4304     or support for a new language:
4305     Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
4306     Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
4307     Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
4308     G. Wieggers.
4309
4310     And thanks to everyone else who sent me email with suggestions, bug-reports
4311     and or just some feedback.
4312 </pre>
4313
4314
4315
4316 <a name="bottom"></a><br />
4317 <p align="right">
4318     <a href="http://validator.w3.org/check/referer" target="w3c">
4319         <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
4320     &nbsp;&nbsp;&nbsp;&nbsp;
4321     <a href="http://jigsaw.w3.org/css-validator/" target="w3c">
4322         <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
4323 </p>
4324
4325 </body>
4326 </html>