~ubuntu-branches/ubuntu/dapper/phpmyadmin/dapper-updates

« back to all changes in this revision

Viewing changes to Documentation.html

  • Committer: Bazaar Package Importer
  • Author(s): Piotr Roszatycki
  • Date: 2005-03-11 11:14:05 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20050311111405-rqgg991lcfgc69p3
Tags: 3:2.6.1-pl3-2
Fixed the bug in postinst introduced in last upload. Closes: #299034.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
2
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
4
 
<!-- $Id: Documentation.html,v 2.98 2004/12/12 21:49:52 lem9 Exp $ -->
 
4
<!-- $Id: Documentation.html,v 2.103.2.5 2005/03/03 20:54:24 rabus Exp $ -->
5
5
<!--
6
6
    vim: expandtab ts=4 sw=4 sts=4 tw=78
7
7
-->
8
8
 
9
9
<head>
10
10
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
11
 
    <title>phpMyAdmin 2.6.1-rc1 - Documentation</title>
 
11
    <title>phpMyAdmin 2.6.1-pl3 - Documentation</title>
12
12
    <link rel="stylesheet" type="text/css" href="docs.css" />
13
13
</head>
14
14
 
31
31
<hr noshade="noshade" width="100%" />
32
32
</div>
33
33
 
34
 
<h1>phpMyAdmin 2.6.1-rc1 Documentation</h1>
 
34
<h1>phpMyAdmin 2.6.1-pl3 Documentation</h1>
35
35
 
36
36
 
37
37
<!-- TOP MENU -->
51
51
    </li>
52
52
    <li>
53
53
        Documentation version:
54
 
        <i>$Id: Documentation.html,v 2.98 2004/12/12 21:49:52 lem9 Exp $</i>
 
54
        <i>$Id: Documentation.html,v 2.103.2.5 2005/03/03 20:54:24 rabus Exp $</i>
55
55
    </li>
56
56
</ul>
57
57
 
65
65
        <b>PHP</b>
66
66
        <ul>
67
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 
 
68
            <li>If you want to display inline thumbnails of JPEGs with the
69
69
                original aspect ratio, you also need GD2 support in PHP</li>
70
70
            <li>Starting with phpMyAdmin 2.6.1, MIME-based transformations
71
71
                that use an external program need PHP 4.3.0 or newer</li>
79
79
        if you are using
80
80
        the &quot;cookie&quot; authentication method, having the <tt>mcrypt</tt>
81
81
        PHP extension on your web server accelerates not only the login
82
 
        phase but every other action that you do in phpMyAdmin. 
 
82
        phase but every other action that you do in phpMyAdmin.
83
83
    </li>
84
84
    <li>
85
85
        a web-browser (doh!).
241
241
        in the configuration file.<br /><br /></li>
242
242
 
243
243
    <li>HTTP and cookie authentication modes are more secure: the MySQL
244
 
        login information does not need to be set in the phpMyAdmin 
 
244
        login information does not need to be set in the phpMyAdmin
245
245
        configuration file
246
246
        (except possibly for the <a href="#controluser">controluser</a>).
247
247
        <br />
254
254
 
255
255
    <li>
256
256
        <b>Note: starting with phpMyAdmin 2.6.1, configuring the controluser
257
 
        to enable HTTP and cookie authentication applies <i>only 
 
257
        to enable HTTP and cookie authentication applies <i>only
258
258
        to MySQL servers older than 4.1.2</i>.</b>
259
259
        <br /><br />
260
260
        For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
330
330
    <li>Was called 'advanced' in versions before 2.2.3.</li>
331
331
    <li>Introduced in 1.3.0, it uses Basic HTTP authentication method and
332
332
        allows you to login as any valid MySQL user.</li>
333
 
    <li>Is only supported with PHP running as an Apache module, not with
334
 
        CGI.</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
335
    <li>See also <a href="#faq4_4">FAQ 4.4</a> about not using the <i>.htaccess</i> mechanism along
336
336
        with 'http' authentication mode.</li>
337
337
</ul>
346
346
        with the same username.</li>
347
347
    <li>If you want to login to arbitrary server see
348
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 
 
349
    <li>See also the <a href="#require">requirements</a> section for a way
350
350
        to improve the interface speed while using this mode.</li>
351
351
</ul>
352
352
 
435
435
        Starting with version 2.5.2, the 'cookie' auth_type uses blowfish
436
436
        algorithm to encrypt the password.
437
437
        <br />
438
 
        If at least one server configuration uses 'cookie' auth_type, enter
439
 
        here a passphrase of your choice that will be used by blowfish.
 
438
        If you are using the 'cookie' auth_type, enter here a random 
 
439
        passphrase of your choice. It will be used internally by the blowfish
 
440
        algorithm: you won't be prompted for this passphrase. The maximum
 
441
        number of characters for this parameter seems to be 46.
440
442
  </dd>
441
443
 
442
444
    <dt><b>$cfg['Servers']</b> array</dt>
521
523
    </dt>
522
524
    <dd>
523
525
        <i>Note: starting with phpMyAdmin 2.6.1, configuring the controluser
524
 
        to enable HTTP and cookie authentication applies only 
 
526
        to enable HTTP and cookie authentication applies only
525
527
        to MySQL servers older than 4.1.2.</i>
526
528
        <br /><br />
527
529
        This special account is used for 2 distinct purposes: to make possible
528
 
        all relational features 
529
 
        (see <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>) and, for a 
530
 
        MySQL server older than 4.1.2, to enable a multi-user installation 
 
530
        all relational features
 
531
        (see <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>) and, for a
 
532
        MySQL server older than 4.1.2, to enable a multi-user installation
531
533
        (http or cookie authentication mode).
532
534
        <br /><br />
533
535
        When using HTTP or cookie authentication modes (or 'config'
1540
1542
        <b>$cfg['CtrlArrowsMoving'] </b>boolean<br />
1541
1543
    </dt>
1542
1544
    <dd>
1543
 
        Enable Ctrl+Arrows moving between fields when editing?
 
1545
        Enable Ctrl+Arrows (Option+Arrows in Safari) moving between fields when editing?
1544
1546
        <br /><br />
1545
1547
    </dd>
1546
1548
 
2695
2697
    you won't be able to run phpMyAdmin having enabled E_STRICT in your
2696
2698
    error_reporting settings.
2697
2699
</p>
 
2700
<a name="faq1_32"></a><br />
 
2701
<h4>
 
2702
    [1.32] Can I use HTTP authentication with IIS?
 
2703
</h4>
 
2704
<p>
 
2705
    Yes. This procedure was tested with phpMyAdmin 2.6.1, PHP 4.3.9 in ISAPI
 
2706
    mode under IIS 5.1. 
 
2707
    <ol>
 
2708
        <li>In your <tt>php.ini</tt> file, set <tt>cgi.rfc2616_headers = 0</tt></li>
 
2709
 
 
2710
        <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>
 
2711
 
 
2712
        <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>
 
2713
    </ol>
 
2714
</p>
2698
2715
 
2699
2716
<a name="faqconfig"></a><br />
2700
2717
<h3>[2. Configuration]</h3>
2987
3004
</h4>
2988
3005
<p>
2989
3006
    phpMyAdmin uses a quick method to get the row count, and this method
2990
 
    only returns an approximate count in the case of InnoDB tables. See 
2991
 
    <tt>$cfg['MaxExactCount']</tt> for a way to modify those results, but  
 
3007
    only returns an approximate count in the case of InnoDB tables. See
 
3008
    <tt>$cfg['MaxExactCount']</tt> for a way to modify those results, but
2992
3009
    this could have a serious impact on performance.
2993
3010
</p>
2994
3011
 
3272
3289
<p>
3273
3290
    Please upgrade to at least version 1.2.3.
3274
3291
</p>
 
3292
<h4>
 
3293
    [5.16] With Internet Explorer, I get &quot;Access is denied&quot;
 
3294
    Javascript errors. Or I cannot make phpMyAdmin work under Windows. 
 
3295
</h4>
 
3296
<p>
 
3297
    Please check the following points:
 
3298
    <ul>
 
3299
        <li>
 
3300
            Maybe you have defined your <tt>PmaAbsoluteUri</tt> setting 
 
3301
            in <tt>config.inc.php</tt> to an IP address and you are starting 
 
3302
            phpMyAdmin with a URL containing a domain name, or the reverse situation.
 
3303
        </li>
 
3304
        <li>
 
3305
            Security settings in IE and/or Microsoft Security Center are
 
3306
            too high, thus blocking scripts execution.
 
3307
        </li>
 
3308
        <li>
 
3309
            The Windows Firewall is blocking Apache and MySQL. You must
 
3310
            allow http ports (80 or 443) and MySQL port (usually 3306)
 
3311
            in the &quot;in&quot; and &quot;out&quot; directions.
 
3312
        </li>
 
3313
    </ul> 
 
3314
</p>
3275
3315
 
3276
3316
<a name="faqusing"></a><br />
3277
3317
<h3>[6. Using phpMyAdmin]</h3>
3433
3473
    [6.8] How can I produce a PDF schema of my database?
3434
3474
</h4>
3435
3475
<p>
3436
 
    First you have to fill the &quot;relation&quot;, &quot;table_coords&quot;
3437
 
    and &quot;pdf_pages&quot; configuration variables.
 
3476
    First the configuration variables &quot;relation&quot;,
 
3477
    &quot;table_coords&quot; and &quot;pdf_pages&quot; have to be filled in.
3438
3478
    <br /><br />
3439
 
    Then, think about your schema layout: which tables will go on which pages.
 
3479
    Then you need to think about your schema layout. Which tables will go on
 
3480
    which pages?
3440
3481
</p>
3441
3482
<ul>
3442
 
    <li>Click on your db name in the left frame</li>
3443
 
    <li>Choose &quot;Structure&quot; in the navigation on top</li>
3444
 
    <li>Choose &quot;Edit PDF Pages&quot; which should be somewhere at the
3445
 
        bottom of the page</li>
3446
 
    <li>Enter the name for a first pdf page and submit (you can also use
3447
 
        the &quot;Automatic layout&quot;, which will place on your page
3448
 
        all the tables that are linked)</li>
3449
 
    <li>Choose this page to edit</li>
3450
 
    <li>Now add a table you want to show on this page and its coordinates and
3451
 
        submit<br />
3452
 
        First you will have to guess those coordinates of course, so just expect
3453
 
        to have an area of about 297 * 210 and put the tables coordinates
3454
 
        somewhere in there, you will be able to have a look at what happened
3455
 
        and change them later.<br />
3456
 
        For example, x=100 and y=200 means that the table will be at 200 mm
3457
 
        down and 100 mm right from the upper left corner.<br />
3458
 
        Actually if you have a width of more than 300 or a height of more than
3459
 
        200 then it will automatically be scaled but 200*100 is a good start to
3460
 
        have an idea of what coordinates to use.</li>
3461
 
    <li>There is also a visual editor (scratchboard) available, see the
3462
 
        explanation at the <a href="#wysiwyg">$cfg['WYSIWYG-PDF']</a> section.</li>
3463
 
    <li>After every table you submitted you will have the possibility to submit
3464
 
        more tables</li>
3465
 
    <li>When you have entered enough tables Click on your db name in the left
3466
 
        frame again</li>
3467
 
    <li>Now, again at the bottom of the page you should be able to choose
3468
 
        &quot;Display PDF schema&quot;<br />
3469
 
        For testing it might be useful to show the grid as well, so you can see
3470
 
        the coordinates used.<br />
3471
 
        Maybe also choose color and submit.</li>
3472
 
    <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3473
 
        (Internet Explorer has some bug there which might make it offer it
3474
 
        without an extension. Under Windows it is important to have the
3475
 
        extension &quot;.pdf&quot;, under other OSes you should be fine just
3476
 
        saving the file under the name it offers).</li>
 
3483
    <li>Select your database in the left frame.</li>
 
3484
    <li>Choose &quot;Operations&quot; in the navigation bar at the top.</li>
 
3485
    <li>Choose &quot;Edit PDF Pages&quot; near the bottom of the page.</li>
 
3486
    <li>Enter a name for the first PDF page and click Go. If you like, you
 
3487
        can use the &quot;automatic layout,&quot; which will put all your
 
3488
        linked tables onto the new page.</li>
 
3489
    <li>Select the name of the new page (the action choice being set to Edit)
 
3490
        and click Go.</li>
 
3491
    <li>Select a table from the list, enter its coordinates and click Go.<br />
 
3492
        Coordinates are relative; your diagram will
 
3493
        be automatically scaled to fit the page. When initially placing tables
 
3494
        on the page, just pick any coordinates -- say, 50x50. After clicking
 
3495
        Go, you can then use the <a href="#wysiwyg">graphical editor</a> to
 
3496
        position the element correctly.</li>
 
3497
    <li>When you'd like to look at your PDF, first be sure to click the Go
 
3498
        button beneath the list of tables and coordinates, to save any changes
 
3499
        you made there. Then scroll all the way down, select the PDF options
 
3500
        you want, and click Go.</li>
 
3501
    <li>Internet Explorer for Windows may suggest an incorrect filename when
 
3502
        you try to save a generated PDF. When saving a generated PDF, be
 
3503
        sure that the filename ends in &quot;.pdf&quot;, for example
 
3504
        &quot;schema.pdf&quot;. Browsers on other operating systems, and other
 
3505
        browsers on Windows, do not have this problem.</li>
3477
3506
</ul>
3478
3507
 
3479
3508
<h4>
3509
3538
<h4>
3510
3539
    [6.12] I want to understand some Export options.
3511
3540
</h4>
3512
 
<p>
3513
 
    &quot;Complete inserts&quot; adds the column names on every INSERT command,
3514
 
    for better documentation (but resulting file is bigger).<br />
3515
 
    &quot;Extended inserts&quot; provides a shorter dump file by using only
3516
 
    once the INSERT verb and the table name.<br />
3517
 
    &quot;Enclose table and field names with backquotes&quot; ensures that
3518
 
    field and table names formed with special characters are protected.<br />
3519
 
    &quot;Add AUTO_INCREMENT value&quot; ensures, that AUTO_INCREMENT value
3520
 
    (if any) will be included in backup.<br />
3521
 
    &quot;Add into comments&quot; includes column comments, relations and MIME
3522
 
    types set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br />
3523
 
</p>
 
3541
    <p><b>Structure:</b></p>
 
3542
    <ul>
 
3543
        <li>&quot;Add DROP TABLE&quot; will add a line telling MySQL to
 
3544
        <a href="http://dev.mysql.com/doc/mysql/en/drop-table.html">drop the table</a>,
 
3545
        if it already exists during the import. It does NOT drop the table after
 
3546
        your export, it only affects the import file.</li>
 
3547
        <li>&quot;If Not Exists&quot; will only create the table if it doesn't exist. Otherwise,
 
3548
        you may get an error if the table name exists but has a different structure.</li>
 
3549
        <li>&quot;Add AUTO_INCREMENT value&quot; ensures that AUTO_INCREMENT value
 
3550
        (if any) will be included in backup.</li>
 
3551
        <li>&quot;Enclose table and field names with backquotes&quot; ensures that
 
3552
        field and table names formed with special characters are protected.</li>
 
3553
        <li>&quot;Add into comments&quot; includes column comments, relations, and MIME
 
3554
        types set in the pmadb in the dump as SQL comments (<i>/* xxx */</i>).</li>
 
3555
    </ul>
 
3556
    <p><b>Data:</b></p>
 
3557
    <ul>
 
3558
        <li>&quot;Complete inserts&quot; adds the column names on every INSERT command,
 
3559
        for better documentation (but resulting file is bigger).</li>
 
3560
        <li>&quot;Extended inserts&quot; provides a shorter dump file by using only
 
3561
        once the INSERT verb and the table name.</li>
 
3562
        <li>&quot;Delayed inserts&quot; are best explained in the
 
3563
        <a href="http://dev.mysql.com/doc/mysql/en/insert-delayed.html">MySQL manual</a>.</li>
 
3564
        <li>&quot;Ignore inserts&quot; treats errors as a warning instead. Again, more info
 
3565
        is provided in the <a href="http://dev.mysql.com/doc/mysql/en/insert.html">MySQL
 
3566
        manual</a>, but basically with this selected, invalid values are adjusted and inserted
 
3567
        rather than causing the entire statement to fail.</li>
 
3568
    </ul>
3524
3569
 
3525
3570
<h4>
3526
3571
    [6.13] I would like to create a database with a dot in its name.
3572
3617
    [6.16] How can I simply move in page with plenty editing fields?
3573
3618
</h4>
3574
3619
<p>
3575
 
    You can use Ctrl+arrows for moving on most pages with plenty editing
3576
 
    fields (table structure changes, row editing, etc.) (must be enabled in
3577
 
    configuration - see. <a href="#CtrlArrowsMoving">$cfg['CtrlArrowsMoving']</a>). You can also have a look
3578
 
    at the directive <a href="#DefaultPropDisplay">$cfg['DefaultPropDisplay']</a> ('vertical') and see if this
3579
 
    eases up editing for you.
 
3620
    You can use Ctrl+arrows (Option+Arrows in Safari) for moving on most pages
 
3621
    with many editing fields (table structure changes, row editing, etc.)
 
3622
    (must be enabled in configuration - see.
 
3623
    <a href="#CtrlArrowsMoving">$cfg['CtrlArrowsMoving']</a>). You can also have
 
3624
    a look at the directive
 
3625
    <a href="#DefaultPropDisplay">$cfg['DefaultPropDisplay']</a> ('vertical') and
 
3626
    see if this eases up editing for you.
3580
3627
    <br />
3581
3628
</p>
3582
3629
 
4076
4123
 
4077
4124
- Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
4078
4125
    * PDF schema output, thanks also to Olivier Plathey for the
4079
 
      &quot;FPDF&quot; library (see http://www.fpdf.org/).
 
4126
      &quot;FPDF&quot; library (see <a href="http://www.fpdf.org/">http://www.fpdf.org/</a>) and Steven Wittens
 
4127
      for the &quot;UFPDF&quot; library (see <a href="http://www.acko.net/node/56">http://www.acko.net/node/56</a>).
4080
4128
 
4081
4129
- Olof Edlund &lt;olof.edlund_at_upright.se&gt;
4082
4130
    * SQL validator server