diff --git a/config.rst b/config.rst index 775858db08..320b2e3324 100644 --- a/config.rst +++ b/config.rst @@ -33,7 +33,7 @@ Basic settings Sets here the complete :abbr:`URL (Uniform Resource Locator)` (with full path) to your phpMyAdmin installation's directory. E.g. -``http://www.your\_web.net/path\_to\_your\_phpMyAdmin\_directory/``. +``http://www.your_web.net/path_to_your_phpMyAdmin_directory/``. Note also that the :abbr:`URL (Uniform Resource Locator)` on some web servers are case–sensitive. Don’t forget the trailing slash at the end. Starting with version 2.3.0, it is advisable to try leaving this @@ -235,9 +235,9 @@ for more information. In phpMyAdmin versions before 2.2.5, those were called Whether config or cookie or :abbr:`HTTP (HyperText Transfer Protocol)` or signon authentication should be used for this server. -* 'config' authentication (``$auth\_type = 'config'``) is the plain old +* 'config' authentication (``$auth_type = 'config'``) is the plain old way: username and password are stored in :file:`config.inc.php`. -* 'cookie' authentication mode (``$auth\_type = 'cookie'``) as +* 'cookie' authentication mode (``$auth_type = 'cookie'``) as introduced in 2.2.3 allows you to log in as any valid MySQL user with the help of cookies. Username and password are stored in cookies during the session and password is deleted when it ends. This can also @@ -247,7 +247,7 @@ or signon authentication should be used for this server. 'http') (``$auth\_type = ':abbr:`HTTP (HyperText Transfer Protocol)`'``) as introduced in 1.3.0 allows you to log in as any valid MySQL user via HTTP-Auth. -* 'signon' authentication mode (``$auth\_type = 'signon'``) as +* 'signon' authentication mode (``$auth_type = 'signon'``) as introduced in 2.10.0 allows you to log in from prepared PHP session data or using supplied PHP script. This is useful for implementing single signon from another application. Sample way how to seed session @@ -322,14 +322,14 @@ If set to a (an array of) database name(s), only this (these) database(s) will be shown to the user. Since phpMyAdmin 2.2.1, this/these database(s) name(s) may contain MySQL wildcards characters ("\_" and "%"): if you want to use literal instances of these -characters, escape them (I.E. use ``'my\\_db'`` and not ``'my\_db'``). +characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``). This setting is an efficient way to lower the server load since the latter does not need to send MySQL requests to build the available database list. But **it does not replace the privileges rules of the MySQL database server**. If set, it just means only these databases will be displayed but **not that all other databases can't be used.** An example of using more that one database: -``$cfg['Servers'][$i]['only\_db'] = array('db1', 'db2');`` As of +``$cfg['Servers'][$i]['only_db'] = array('db1', 'db2');`` As of phpMyAdmin 2.5.5 the order inside the array is used for sorting the databases in the navigation panel, so that you can individually arrange your databases. If you want to have certain databases at the @@ -437,8 +437,8 @@ functionality: where you want to use this feature, click "Structure/Relation view/" and choose foreign columns. -Please note that in the current version, ``master\_db`` must be the -same as ``foreign\_db``. Those columns have been put in future +Please note that in the current version, ``master_db`` must be the +same as ``foreign_db``. Those columns have been put in future development of the cross-db relations. .. _table_info: @@ -806,7 +806,7 @@ IPv6 addresses are not supported. :type: boolean :default: true -Disable using ``INFORMATION\_SCHEMA`` to retrieve information (use +Disable using ``INFORMATION_SCHEMA`` to retrieve information (use ``SHOW`` commands instead), because of speed issues when many databases are present. Currently used in some parts of the code, more to come. @@ -837,7 +837,7 @@ the list of databases for the navigation panel. Name of PHP script to be sourced and executed to obtain login credentials. This is alternative approach to session based single signon. The script needs to provide function -``get\_login\_credentials`` which returns list of username and +``get_login_credentials`` which returns list of username and password, accepting single parameter of existing username (can be empty). See ``examples/signon-script.php`` for an example. @@ -1115,7 +1115,7 @@ configuration option `session.gc\_maxlifetime `_ might limit session validity and if session is lost, login cookie is also invalidated. So it is a good idea to set -``session.gc\_maxlifetime`` not lower than the value of +``session.gc_maxlifetime`` not lower than the value of $cfg['LoginCookieValidity']. .. config:option:: $cfg['LoginCookieStore'] @@ -2104,9 +2104,9 @@ the phpMyAdmin scripts. The name of the directory where temporary files can be stored. This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to -work around limitations of ``open\_basedir`` for uploaded files, see +work around limitations of ``open_basedir`` for uploaded files, see :ref:`faq1_11`. If the directory where phpMyAdmin is installed is -subject to an ``open\_basedir`` restriction, you need to create a +subject to an ``open_basedir`` restriction, you need to create a temporary directory in some directory accessible by the web server. However for security reasons, this directory should be outside the tree published by webserver. If you cannot avoid having this directory @@ -2309,7 +2309,7 @@ all visual sliders, use ``'disabled'``. Contains names of configuration options (keys in ``$cfg`` array) that users can't set through user preferences. For possible values, refer -to ``libraries/config/user\_preferences.forms.php``. +to :file:`libraries/config/user_preferences.forms.php`. .. config:option:: $cfg['UserprefsDeveloperTab'] @@ -2514,6 +2514,6 @@ displayed in the bottom of main page (right frame). Functions selected by default when inserting/changing row, Functions are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR, -FUNC\_SPATIAL, FUNC\_UUID) and for ``first\_timestamp``, which is used +FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used for first timestamp column in table. diff --git a/faq.rst b/faq.rst index 2658fe05de..e70175d77d 100644 --- a/faq.rst +++ b/faq.rst @@ -19,7 +19,7 @@ Server --------------------------------------------------------------------------------------------------------------------------------------------------------------------- Try to set the :config:option:`$cfg['OBGzip']` directive to ``FALSE`` in your :file:`config.inc.php` file -and the ``zlib.output\_compression`` directive to ``Off`` in your php +and the ``zlib.output_compression`` directive to ``Off`` in your php configuration file. .. _faq1_2: @@ -82,7 +82,7 @@ Safe Mode or not, and so on). So, you must have Zlib/Bzip2 support ----------------------------------------------------------------------------------------------- Your uploaded file is saved by PHP in the "upload dir", as defined in -*php.ini* by the variable ``upload\_tmp\_dir`` (usually the system +*php.ini* by the variable ``upload_tmp_dir`` (usually the system default is */tmp*). We recommend the following setup for Apache servers running in safe mode, to enable uploads of files while being reasonably secure: @@ -91,7 +91,7 @@ reasonably secure: * give ownership to the Apache server's user.group: ``chown apache.apache /tmp/php`` * give proper permission: ``chmod 600 /tmp/php`` -* put ``upload\_tmp\_dir = /tmp/php`` in *php.ini* +* put ``upload_tmp_dir = /tmp/php`` in *php.ini* * restart Apache .. _faq1_9: @@ -161,11 +161,11 @@ these problems should not occur. If possible, upgrade your phpMyAdmin to the latest version to take advantage of the new import features. The first things to check (or ask your host provider to check) are the -values of ``upload\_max\_filesize``, ``memory\_limit`` and -``post\_max\_size`` in the *php.ini* configuration file. All of these +values of ``upload_max_filesize``, ``memory_limit`` and +``post_max_size`` in the *php.ini* configuration file. All of these three settings limit the maximum size of data that can be submitted -and handled by PHP. One user also said that ``post\_max\_size`` and -``memory\_limit`` need to be larger than ``upload\_max\_filesize``. +and handled by PHP. One user also said that ``post_max_size`` and +``memory_limit`` need to be larger than ``upload_max_filesize``. There exist several workarounds if your upload is too big or your hosting provider is unwilling to change the settings: @@ -250,14 +250,14 @@ or something similar. 1.21 I am running the :abbr:`CGI (Common Gateway Interface)` version of PHP under Unix, and I cannot log in using cookie auth. ------------------------------------------------------------------------------------------------------------------------------ -In *php.ini*, set ``mysql.max\_links`` higher than 1. +In *php.ini*, set ``mysql.max_links`` higher than 1. .. _faq1_22: 1.22 I don't see the "Location of text file" field, so I cannot upload. ----------------------------------------------------------------------- -This is most likely because in *php.ini*, your ``file\_uploads`` +This is most likely because in *php.ini*, your ``file_uploads`` parameter is not set to "on". .. _faq1_23: @@ -265,7 +265,7 @@ parameter is not set to "on". 1.23 I'm running MySQL on a Win32 machine. Each time I create a new table the table and column names are changed to lowercase! ------------------------------------------------------------------------------------------------------------------------------ -This happens because the MySQL directive ``lower\_case\_table\_names`` +This happens because the MySQL directive ``lower_case_table_names`` defaults to 1 (``ON``) in the Win32 version of MySQL. You can change this behavior by simply changing the directive to 0 (``OFF``): Just edit your ``my.ini`` file that should be located in your Windows @@ -330,7 +330,7 @@ output buffering is enabled. If you turn off it (by :config:option:`$cfg['OBGzip ------------------------------------------------------------------------------------------------------------ This can happen due to a MySQL bug when having database / table names -with upper case characters although ``lower\_case\_table\_names`` is +with upper case characters although ``lower_case_table_names`` is set to 1. To fix this, turn off this directive, convert all database and table names to lower case and turn it on again. Alternatively, there's a bug-fix available starting with MySQL 3.23.56 / @@ -398,7 +398,7 @@ Yes. This procedure was tested with phpMyAdmin 2.6.1, PHP 4.3.9 in :abbr:`ISAPI (Internet Server Application Programming Interface)` mode under :abbr:`IIS (Internet Information Services)` 5.1. -#. In your ``php.ini`` file, set ``cgi.rfc2616\_headers = 0`` +#. In your ``php.ini`` file, set ``cgi.rfc2616_headers = 0`` #. In ``Web Site Properties -> File/Directory Security -> Anonymous Access`` dialog box, check the ``Anonymous access`` checkbox and uncheck any other checkboxes (i.e. uncheck ``Basic authentication``, @@ -576,7 +576,7 @@ details. -------------------------------------------------------------------------------------------------- The MySQL server's privilege tables are not up to date, you need to -run the ``mysql\_upgrade`` command on the server. +run the ``mysql_upgrade`` command on the server. .. _faq1_42: @@ -764,17 +764,17 @@ Here are a few points to check: Zend Optimizer. See `http://bugs.php.net/bug.php?id=31134 `_. * If you are using Hardened PHP with the ini directive - ``varfilter.max\_request\_variables`` set to the default (200) or + ``varfilter.max_request_variables`` set to the default (200) or another low value, you could get this error if your table has a high number of columns. Adjust this setting accordingly. (Thanks to Klaus Dorninger for the hint). -* In the ``php.ini`` directive ``arg\_separator.input``, a value of ";" +* In the ``php.ini`` directive ``arg_separator.input``, a value of ";" will cause this error. Replace it with "&;". * If you are using `Hardened-PHP `_, you might want to increase `request limits `_. * The directory specified in the ``php.ini`` directive - ``session.save\_path`` does not exist or is read-only. + ``session.save_path`` does not exist or is read-only. .. _faq2_9: @@ -790,7 +790,7 @@ has to be enabled in your PHP. If using APC, you must set ``apc.rfc1867`` to ``on`` in your php.ini. If using PHP 5.4.0 or higher, you must set -``session.upload\_progress.enabled`` to ``1`` in your php.ini. +``session.upload_progress.enabled`` to ``1`` in your php.ini. .. _faqlimitations: @@ -1034,8 +1034,8 @@ Protocol)` or cookie authentication features. Suggestions: -------------------------------------------------------------------------------------- Check *php.ini*, or ask your sysadmin to check it. The -``include\_path`` must contain "." somewhere in it, and -``open\_basedir``, if used, must contain "." and "./lang" to allow +``include_path`` must contain "." somewhere in it, and +``open_basedir``, if used, must contain "." and "./lang" to allow normal operation of phpMyAdmin. .. _faq4_4: @@ -1107,12 +1107,12 @@ Protocol)` address while a domain name is defined in the config file. 4.8 Which parameters can I use in the URL that starts phpMyAdmin? ----------------------------------------------------------------- -When starting phpMyAdmin, you can use the ``db``, ``pma\_username``, -``pma\_password`` and ``server`` parameters. This last one can contain +When starting phpMyAdmin, you can use the ``db``, ``pma_username``, +``pma_password`` and ``server`` parameters. This last one can contain either the numeric host index (from ``$i`` of the configuration file) or one of the host names present in the configuration file. Using -``pma\_username`` and ``pma\_password`` has been tested along with the -usage of 'cookie' ``auth\_type``. +``pma_username`` and ``pma_password`` has been tested along with the +usage of 'cookie' ``auth_type``. .. _faqbrowsers: @@ -1283,7 +1283,7 @@ installed in their Firefox is causing the problem. ----------------------------------------------------------------------------------------- This happens only when both of these conditions are met: using the -``http`` authentication mode and ``register\_globals`` being set to +``http`` authentication mode and ``register_globals`` being set to ``On`` on the server. It seems to be a browser-specific problem; meanwhile use the ``cookie`` authentication mode. @@ -1373,7 +1373,7 @@ look for the word "upload" in this document. --------------------------------------------------------- Here is an example with the tables persons, towns and countries, all -located in the database mydb. If you don't have a ``pma\_relation`` +located in the database mydb. If you don't have a ``pma_relation`` table, create it as explained in the configuration section. Then create the example tables: diff --git a/setup.rst b/setup.rst index d97bd5c993..4887e9541c 100644 --- a/setup.rst +++ b/setup.rst @@ -28,7 +28,7 @@ Quick Install We'll assume you chose a kit whose name looks like ``phpMyAdmin-x.x.x -all-languages.tar.gz``. #. Untar or unzip the distribution (be sure to unzip the subdirectories): - ``tar -xzvf phpMyAdmin\_x.x.x-all-languages.tar.gz`` in your + ``tar -xzvf phpMyAdmin_x.x.x-all-languages.tar.gz`` in your webserver's document root. If you don't have direct access to your document root, put the files in a directory on your local machine, and, after step 4, transfer the directory on your web server using, @@ -140,12 +140,12 @@ Now the file is ready to be used. You can choose to review or edit the file with your favorite editor, if you prefer to set some advanced options which the setup script does not provide. -#. If you are using the ``auth\_type`` "config", it is suggested that you +#. If you are using the ``auth_type`` "config", it is suggested that you protect the phpMyAdmin installation directory because using config does not require a user to enter a password to access the phpMyAdmin installation. Use of an alternate authentication method is recommended, for example with HTTP–AUTH in a :term:`.htaccess` file or switch to using - ``auth\_type`` cookie or http. See the :ref:`faqmultiuser` + ``auth_type`` cookie or http. See the :ref:`faqmultiuser` for additional information, especially :ref:`faq4_4`. #. Open the `main phpMyAdmin directory `_ in your browser. phpMyAdmin should now display a welcome screen and your databases, or @@ -206,7 +206,7 @@ Simply copy :file:`config.inc.php` from your previous installation into the newly unpacked one. Configuration files from old versions may require some tweaking as some options have been changed or removed. For compatibility with PHP 6, remove a -``set\_magic\_quotes\_runtime(0);`` statement that you might find near +``set_magic_quotes_runtime(0);`` statement that you might find near the end of your configuration file. You should **not** copy ``libraries/config.default.php`` over @@ -217,7 +217,7 @@ If you have upgraded your MySQL server from a version previous to 4.1.2 to version 5.x or newer and if you use the phpMyAdmin configuration storage, you should run the :abbr:`SQL (structured query language)` script found in -``examples/upgrade\_tables\_mysql\_4\_1\_2+.sql``. +:file:`examples/upgrade_tables_mysql_4_1_2+.sql`. .. _authentication_modes: diff --git a/transformations.rst b/transformations.rst index bb39c20572..a0626698b6 100644 --- a/transformations.rst +++ b/transformations.rst @@ -8,7 +8,7 @@ Transformations Introduction ++++++++++++ -To enable transformations, you have to setup the ``column\_info`` +To enable transformations, you have to setup the ``column_info`` table and the proper directives. Please see the :ref:`config` on how to do so. You can apply different transformations to the contents of each @@ -117,8 +117,8 @@ libraries/plugins/transformations/TEMPLATE\_ABSTRACT files for adding your own transformation plug-in. You can also generate a new transformation plug-in (with or without the abstract transformation class), by using -``libraries/plugins/transformations/generator\_plugin.sh`` or -``libraries/plugins/transformations/generator\_main\_class.sh``. +:file:`libraries/plugins/transformations/generator_plugin.sh` or +:file:`libraries/plugins/transformations/generator_main_class.sh`. The applyTransformation() method always gets passed three variables: