Author: paul
Date: 2006-04-28 21:05:56 +0200 (Fri, 28 Apr 2006)
New Revision: 1967
Log:
r7123@polar: paul | 2006-04-28 14:06:17 -0500
De-cruft.
Modified:
trunk/
trunk/administrator/administrator.xml
trunk/gui-common/appendix-common-files.xml
trunk/gui-common/appendix-connection-storage.xml
trunk/gui-common/appendix-source-install.xml
trunk/gui-common/appendix-translator-notes.xml
trunk/gui-common/appendix-troubleshooting.xml
trunk/gui-common/chapter-options-connections.xml
trunk/gui-common/chapter-options-introduction.xml
trunk/query-browser/query-browser.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:7031
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:9874
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:4590
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:7123
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:9874
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:4590
Modified: trunk/administrator/administrator.xml
===================================================================
--- trunk/administrator/administrator.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/administrator/administrator.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -53,38 +53,36 @@
<para>
Most tasks can be performed using a command-line client such as
- <ulink
-url="http://dev.mysql.com/doc/mysql/en/mysqladmin.html"><command>mysqladmin</command>
+ <ulink url="http://dev.mysql.com/doc/mysql/en/mysqladmin.html"><command>mysqladmin</command>
</ulink> or
- <ulink
- url="http://dev.mysql.com/doc/mysql/en/mysql.html"><command>mysql</command></ulink>,
+ <ulink url="http://dev.mysql.com/doc/mysql/en/mysql.html"><command>mysql</command></ulink>,
but &administrator; is advantageous in the following respects:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- Its graphical user interface makes it more intuitive.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Its graphical user interface makes it more intuitive.
+ </para>
+ </listitem>
- <listitem>
- <para>
- It provides a better overview of the settings that are
- crucial for the performance, reliability, and security of
- your MySQL servers.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ It provides a better overview of the settings that are crucial
+ for the performance, reliability, and security of your MySQL
+ servers.
+ </para>
+ </listitem>
- <listitem>
- <para>
- It displays performance indicators graphically, thus making
- it easier to determine and tune server settings.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ It displays performance indicators graphically, thus making it
+ easier to determine and tune server settings.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
<para>
&administrator; is designed to work with MySQL versions 4.0 and
@@ -208,21 +206,19 @@
<para>
To see all files in the tarball, run this command:
+ </para>
<programlisting>
-
- shell> tar -tzf mysql-administrator-<replaceable>version</replaceable>-linux.tar.gz
- </programlisting>
- </para>
+shell> tar -tzf mysql-administrator-<replaceable>version</replaceable>-linux.tar.gz
+</programlisting>
<para>
To install &administrator;, run this command:
+ </para>
<programlisting>
-
- shell> tar --directory=/opt -xzvf mysql-administrator-<replaceable>version</replaceable>-linux.tar.gz
- </programlisting>
- </para>
+shell> tar --directory=/opt -xzvf mysql-administrator-<replaceable>version</replaceable>-linux.tar.gz
+</programlisting>
<para>
This installs the application binary in
@@ -271,52 +267,54 @@
<para>
The way you start &administrator; depends on the operating
system you are using:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- On Windows, start &administrator; by double-clicking its
- desktop icon, or by selecting its item from the
- <literal>Start</literal> menu. Alternatively, you can open
- a DOS window and start it from the command line:
+ <listitem>
+ <para>
+ On Windows, start &administrator; by double-clicking its
+ desktop icon, or by selecting its item from the
+ <literal>Start</literal> menu. Alternatively, you can open a
+ DOS window and start it from the command line:
+ </para>
<programlisting>
- C:\> C:\<replaceable>program
+C:\> C:\<replaceable>program
directory</replaceable>\MySQL\&administrator; 1.0\MySQLAdministrator.exe
- </programlisting>
+</programlisting>
- <replaceable>program directory</replaceable> is the
- default directory for programs on your machine, for
- example <literal>C:\Program Files</literal> or
- <literal>C:\programme</literal>. If your path contains
- spaces, you should enclose the command within quote
- characters. For example:
+ <para>
+ <replaceable>program directory</replaceable> is the default
+ directory for programs on your machine, for example
+ <literal>C:\Program Files</literal> or
+ <literal>C:\programme</literal>. If your path contains
+ spaces, you should enclose the command within quote
+ characters. For example:
+ </para>
<programlisting>
- C:\> "C:\Program Files\MySQL\&administrator; 1.0\MySQLAdministrator.exe"
- </programlisting>
- </para>
- </listitem>
+C:\> "C:\Program Files\MySQL\&administrator; 1.0\MySQLAdministrator.exe"
+</programlisting>
+ </listitem>
- <listitem>
- <para>
- On Linux desktops, start &administrator; by changing
- directory into
- <literal>/opt/mysql-administrator/bin</literal>, and then
- running <literal>mysql-administrator</literal>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ On Linux desktops, start &administrator; by changing
+ directory into
+ <literal>/opt/mysql-administrator/bin</literal>, and then
+ running <literal>mysql-administrator</literal>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- On Mac OSX, navigate to the &administrator; installation
- directory and double-click on the &administrator; icon.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ On Mac OSX, navigate to the &administrator; installation
+ directory and double-click on the &administrator; icon.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</section>
@@ -338,9 +336,7 @@
<para>
As an alternative to connecting to a running MySQL server, you
can run &administrator; in
- <link
-
-linkend="mysql-administrator-starting-configure-service">configure
+ <link linkend="mysql-administrator-starting-configure-service">configure
-service mode</link>.
</para>
@@ -367,17 +363,13 @@
If the server connection is successfully established, all of the
values filled in the fields of the connection dialog will be
saved for future connections (see the section that describes
- <link
- linkend="mysql-gui-appendix-store-connections">how
+ <link linkend="mysql-gui-appendix-store-connections">how
&administrator; stores connection information</link>). The
<literal>Password</literal> field, however, will always be
empty: For security reasons, the password is not stored along
with the other options, unless you explicitly specify otherwise
- in the
- <link
-
-linkend="mysql-gui-options-general-options">Gen
- eral Options section of the Options dialog</link>.
+ in the <link linkend="mysql-gui-options-general-options">General
+ Options section of the Options dialog</link>.
</para>
<para>
@@ -396,8 +388,7 @@
dialog window in the description of the
<literal>Connections</literal> section of the
<literal>Options</literal> dialog (see
- <link
- linkend="mysql-gui-options-connections">Options
+ <link linkend="mysql-gui-options-connections">Options
dialog</link>).
</para>
@@ -413,57 +404,52 @@
Normally, you will use &administrator; to connect to a running
MySQL server. This is done by starting the program and
specifying in the
- <link
-
-linkend="mysql-administrator-starting-connection">Connection</link
->
+ <link linkend="mysql-administrator-starting-connection">Connection</link>
dialog which server to connect to.
</para>
<para>
Alternatively, you can run &administrator; in configure-service
mode. This is useful in the following cases:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- When you want to start a MySQL server from within MySQL
- Administrator. Obviously, you cannot connect to a server
- that is not running, so you will have to use the
- configure-service mode to start that server. Note that, at
- the moment, you can only start servers on the same machine
- where &administrator; is running (that is on the local
- host).
- </para>
- </listitem>
+ <listitem>
+ <para>
+ When you want to start a MySQL server from within MySQL
+ Administrator. Obviously, you cannot connect to a server
+ that is not running, so you will have to use the
+ configure-service mode to start that server. Note that, at
+ the moment, you can only start servers on the same machine
+ where &administrator; is running (that is on the local
+ host).
+ </para>
+ </listitem>
- <listitem>
- <para>
- When you have
- <ulink
+ <listitem>
+ <para>
+ When you have
+ <ulink
url="http://dev.mysql.com/doc/mysql/en/Multiple_servers.html">multiple
- servers</ulink> running on your machine. On Windows, MySQL
- Administrator only allows you to configure the Windows
- service that is listed first in the Windows services
- management when running in normal mode. This means that if
- you have more than one Windows service, you can only
- configure the first one of those, no matter which server
- you have connected to. If you want to configure a service
- other than the first service, you will have to run
- &administrator; in configure-service mode.
- </para>
- </listitem>
+ servers</ulink> running on your machine. On Windows, MySQL
+ Administrator only allows you to configure the Windows
+ service that is listed first in the Windows services
+ management when running in normal mode. This means that if
+ you have more than one Windows service, you can only
+ configure the first one of those, no matter which server you
+ have connected to. If you want to configure a service other
+ than the first service, you will have to run &administrator;
+ in configure-service mode.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
<para>
To start &administrator; in configure-service mode, hold down
the <keycap>CTRL</keycap> key in the
- <link
-
-linkend="mysql-administrator-starting-connection">Connection</link
+ <link linkend="mysql-administrator-starting-connection">Connection</link
>
dialog. The <guibutton>Cancel</guibutton> button will toggle to
<guibutton>Skip</guibutton> when that key is pressed.
@@ -502,38 +488,37 @@
<para>
Under <literal>Installed Services</literal> in the
- <link
- linkend="mysql-administrator-sidebar">sidebar</link>,
- you can select the service that you wish to configure, or the
- server that you want to stop or start. In configure-service
- mode, as opposed to normal mode, there is only a subset of the
- sections in the sidebar avaiable:
+ <link linkend="mysql-administrator-sidebar">sidebar</link>, you
+ can select the service that you wish to configure, or the server
+ that you want to stop or start. In configure-service mode, as
+ opposed to normal mode, there is only a subset of the sections
+ in the sidebar avaiable:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- The
- <link
- linkend="mysql-administrator-service-control">Service
- Control</link> section allows you to start and stop a
- MySQL server, and to configure the Windows service
- managing that server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The
+ <link linkend="mysql-administrator-service-control">Service
+ Control</link> section allows you to start and stop a MySQL
+ server, and to configure the Windows service managing that
+ server.
+ </para>
+ </listitem>
- <listitem>
- <para>
- The
- <link
- linkend="mysql-administrator-startup-variables">Startup
- Variables</link> section allows you to set variables for
- server startup.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The
+ <link linkend="mysql-administrator-startup-variables">Startup
+ Variables</link> section allows you to set variables for
+ server startup.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
Both of those sections are described in detail below.
</para>
@@ -586,109 +571,106 @@
<para>
The sidebar consists of the following sections:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <link
- linkend="mysql-administrator-server-information">Server
- Information</link>: Information about the MySQL server you
- are connected to, about &administrator; and the machine
- that it runs on, and about your connection.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <link linkend="mysql-administrator-server-information">Server
+ Information</link>: Information about the MySQL server you
+ are connected to, about &administrator; and the machine that
+ it runs on, and about your connection.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
+ <listitem>
+ <para>
+ <link
linkend="mysql-administrator-service-control">Service
- Control</link>: Start and stop the MySQL server. On
- Windows, you can also configure the MySQL service.
- </para>
- </listitem>
+ Control</link>: Start and stop the MySQL server. On Windows,
+ you can also configure the MySQL service.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
- linkend="mysql-administrator-startup-variables">Startup
- Variables</link>: Configure the startup variables for the
- MySQL server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <link linkend="mysql-administrator-startup-variables">Startup
+ Variables</link>: Configure the startup variables for the
+ MySQL server.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
- linkend="mysql-administrator-server-connections">Server
- Connections</link>: View or kill current connections to
- the MySQL server (also called threads).
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <link linkend="mysql-administrator-server-connections">Server
+ Connections</link>: View or kill current connections to the
+ MySQL server (also called threads).
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
+ <listitem>
+ <para>
+ <link
linkend="mysql-administrator-user-administration">User
- Administration</link>: Administer existing users, add new
- users, and delete existing users.
- </para>
- </listitem>
+ Administration</link>: Administer existing users, add new
+ users, and delete existing users.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
+ <listitem>
+ <para>
+ <link
linkend="mysql-administrator-health">Health</link>:
- Graphical displays of a number of usage or hitrate values
- that affect server performance, and a hierarchical view of
- system and status variables.
- </para>
- </listitem>
+ Graphical displays of a number of usage or hitrate values
+ that affect server performance, and a hierarchical view of
+ system and status variables.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link linkend="mysql-administrator-server-logs">Server
- Logs</link>: View log file entries.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <link linkend="mysql-administrator-server-logs">Server
+ Logs</link>: View log file entries.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
+ <listitem>
+ <para>
+ <link
linkend="mysql-administrator-backup">Backup</link>:
- Plan and administer backup projects, select the databases
- to be backed up, and start the backup process.
- </para>
- </listitem>
+ Plan and administer backup projects, select the databases to
+ be backed up, and start the backup process.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
+ <listitem>
+ <para>
+ <link
linkend="mysql-administrator-restore">Restore</link>:
- Restore databases from existing backups.
- </para>
- </listitem>
+ Restore databases from existing backups.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
- linkend="mysql-administrator-replication-status">Replication
- Status</link>: View information about replication master
- and slave servers.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <link linkend="mysql-administrator-replication-status">Replication
+ Status</link>: View information about replication master and
+ slave servers.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <link
- linkend="mysql-administrator-catalogs">Catalogs</link>:
- View information about databases, tables, columns,
- indexes, and rows; optimize tables.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <link linkend="mysql-administrator-catalogs">Catalogs</link>:
+ View information about databases, tables, columns, indexes,
+ and rows; optimize tables.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
The following sections describe each of these in detail.
</para>
@@ -724,8 +706,7 @@
<para>
While the
- <link
- linkend="mysql-administrator-sidebar">sidebar</link>
+ <link linkend="mysql-administrator-sidebar">sidebar</link>
allows you to select the sections, the working area displays
information, or fields, that pertain to the selected section.
For some sections, the working area is split into two or more
@@ -751,8 +732,7 @@
<para>
Opens the
- <link
- linkend="mysql-administrator-starting-connection">Connection
+ <link linkend="mysql-administrator-starting-connection">Connection
dialog</link>, allowing you to open another connection to a
MySQL server. You may open an arbitrary number of
connections. MySQL Administrator opens a new main window for
@@ -768,14 +748,11 @@
<title>Manage Connections ...</title>
<para>
- Opens the
- <link
- linkend="mysql-gui-options">Options
+ Opens the <link linkend="mysql-gui-options">Options
dialog</link>, with the
- <link
-
-linkend="mysql-gui-options-connections">Con
- nections section</link> preselected.
+ <link
+linkend="mysql-gui-options-connections">Con nections
+ section</link> preselected.
</para>
</section>
@@ -786,16 +763,13 @@
<title>Save current Connection ...</title>
<para>
- Opens the
- <link
- linkend="mysql-gui-options">Options
+ Opens the <link linkend="mysql-gui-options">Options
dialog</link>, with the
- <link
-
-linkend="mysql-gui-options-connections">Con
- nections section</link> preselected. Furthermore, a new
- connection profile labeled <literal>New Connection</literal>
- is created, which is also preselected. The fields are filled
+ <link
+linkend="mysql-gui-options-connections">Con nections
+ section</link> preselected. Furthermore, a new connection
+ profile labeled <literal>New Connection</literal> is
+ created, which is also preselected. The fields are filled
with the values of the most recent connection. You can edit
the values and save the settings in the new profile. You may
also want to rename the profile from <literal>New
@@ -834,8 +808,7 @@
The <guimenu>Cut</guimenu>, <guimenu>Copy</guimenu>, and
<guimenu>Paste</guimenu> commands allow you to cut, copy, or
paste selected text in the
- <link
- linkend="mysql-administrator-working-area">working
+ <link linkend="mysql-administrator-working-area">working
area</link>.
</para>
@@ -844,9 +817,7 @@
<title>Options</title>
<para>
- Opens the
- <link
- linkend="mysql-gui-options">Options
+ Opens the <link linkend="mysql-gui-options">Options
dialog</link> window.
</para>
@@ -864,8 +835,7 @@
<para>
The <guimenu>View</guimenu> menu selects sections from the
- <link
- linkend="mysql-administrator-sidebar">sidebar</link>.
+ <link linkend="mysql-administrator-sidebar">sidebar</link>.
Selecting an item from this menu is the same as clicking the
section with the same name from the sidebar.
</para>
@@ -898,8 +868,7 @@
<literal>mysql.exe</literal>. If it is found, you can start
the command-line client with this command. &administrator;
will use the credentials provided in the
- <link
- linkend="mysql-administrator-starting-connection">Connection
+ <link linkend="mysql-administrator-starting-connection">Connection
dialog</link> to start a server connection using the
command-line client.
</para>
@@ -1008,39 +977,39 @@
<para>
Information about the parameters used to connect to the MySQL
server.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>User</literal>: Username used for the current
- connection to the MySQL server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>User</literal>: Username used for the current
+ connection to the MySQL server.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Host</literal>: The hostname of the machine
- where the MySQL server runs. This is either identical to
- the name listed in <literal>Network Name</literal>, or
- it is <literal>localhost</literal>. The former indicates
- that you are connecting to a server that either runs on
- a remote machine, or that you have specified a hostname
- different from <literal>localhost</literal> when
- connecting. The latter indicates that the MySQL server
- runs on the same machine where MySQL Administrator runs.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Host</literal>: The hostname of the machine where
+ the MySQL server runs. This is either identical to the
+ name listed in <literal>Network Name</literal>, or it is
+ <literal>localhost</literal>. The former indicates that
+ you are connecting to a server that either runs on a
+ remote machine, or that you have specified a hostname
+ different from <literal>localhost</literal> when
+ connecting. The latter indicates that the MySQL server
+ runs on the same machine where MySQL Administrator runs.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Port</literal>: The port used for the
- connection to the MySQL server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Port</literal>: The port used for the connection
+ to the MySQL server.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</listitem>
<listitem>
@@ -1051,37 +1020,37 @@
<para>
Information about the MySQL server and the host where it is
running.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>MySQL Version</literal>: The version of the
- MySQL server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>MySQL Version</literal>: The version of the MySQL
+ server.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Network Name</literal>: The hostname of the
- machine where the MySQL server runs.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Network Name</literal>: The hostname of the
+ machine where the MySQL server runs.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <remark>
- [PD] "IP" is ambiguous because there are IP numbers
- and IP addresses.
- </remark>
+ <listitem>
+ <para>
+ <remark>
+ [PD] "IP" is ambiguous because there are IP numbers and
+ IP addresses.
+ </remark>
- <literal>IP</literal>: The IP number of the host where
- the MySQL server runs.
- </para>
- </listitem>
+ <literal>IP</literal>: The IP number of the host where the
+ MySQL server runs.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</listitem>
<listitem>
@@ -1092,47 +1061,47 @@
<para>
Information about &administrator; and the client host on which
it is running.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Version</literal>: The version of
- &administrator;, and the version number of the MySQL
- client/server protocol.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Version</literal>: The version of
+ &administrator;, and the version number of the MySQL
+ client/server protocol.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Network name</literal>: The name of the host
- where MySQL Administrator runs.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Network name</literal>: The name of the host
+ where MySQL Administrator runs.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>IP</literal>: The IP number of the host where
- MySQL Administrator runs.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>IP</literal>: The IP number of the host where
+ MySQL Administrator runs.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Operating System</literal>: Information about
- the operating system on which &administrator; runs.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Operating System</literal>: Information about the
+ operating system on which &administrator; runs.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Hardware</literal>: Information about the
- hardware on which &administrator; runs.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Hardware</literal>: Information about the
+ hardware on which &administrator; runs.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</listitem>
</itemizedlist>
@@ -1189,27 +1158,31 @@
Under <literal>Log Messages</literal>, you will find messages
that the MySQL server produces when it starts or stops. Messages
produced by the server during startup look something like this:
+ </para>
<programlisting>
- Trying to start the server ...
- 040119 18:33:41 InnoDB: Started
- MySql: ready for connections.
- Version: '4.0.16-max-nt-log' socket: '' port: 3306
- Server was started.
- </programlisting>
+Trying to start the server ...
+040119 18:33:41 InnoDB: Started
+MySql: ready for connections.
+Version: '4.0.16-max-nt-log' socket: '' port: 3306
+Server was started.
+</programlisting>
+ <para>
When the server stops, it produces messages such as these:
+ </para>
<programlisting>
- Trying to stop the server ...
- 040119 18:31:45 MySql: Normal shutdown
- 040119 18:31:46 MySql: Forcing close of thread 11 user:
+Trying to stop the server ...
+040119 18:31:45 MySql: Normal shutdown
+040119 18:31:46 MySql: Forcing close of thread 11 user:
'superuser'
- 040119 18:31:46 MySql: Forcing close of thread 8 user: 'superuser'
- ...
- Server was stopped.
- </programlisting>
+040119 18:31:46 MySql: Forcing close of thread 8 user: 'superuser'
+...
+Server was stopped.
+</programlisting>
+ <para>
The details and format of the messages might vary depending on
the version of the MySQL server you are using and its
configuration.
@@ -1241,8 +1214,7 @@
<para>
Note that if you have more than one MySQL server running as a
Windows service, you should run &administrator; in
- <link
-
+ <link
linkend="mysql-administrator-starting-configure-service">configure
-service mode</link> to administer these services. In normal
mode, you can only administer the Windows service listed first
@@ -1258,225 +1230,219 @@
<para>
The following settings are available:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- Service Settings
+ <listitem>
+ <para>
+ Service Settings
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Launch MySQL server
- automatically</literal>: If checked, the Windows
- service starts the MySQL server automatically on
- operating system startup.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Launch MySQL server automatically</literal>: If
+ checked, the Windows service starts the MySQL server
+ automatically on operating system startup.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Display Name</literal>: The display name of
- the Windows service (not the service name!) as it
- will appear in the Windows services manager when
- displaying the properties of that service.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Display Name</literal>: The display name of the
+ Windows service (not the service name!) as it will
+ appear in the Windows services manager when displaying
+ the properties of that service.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Service Description</literal>: The
- description of the Windows service as it will appear
- in the Windows services manager.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Service Description</literal>: The description
+ of the Windows service as it will appear in the Windows
+ services manager.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
- </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>
- Option File
+ <listitem>
+ <para>
+ Option File
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Config Filename</literal>:
+ <listitem>
+ <para>
+ <literal>Config Filename</literal>:
- <remark>
- [SH] Mike: "Config" is ugly. Suggestion: Filename
- </remark>
+ <remark>
+ [SH] Mike: "Config" is ugly. Suggestion: Filename
+ </remark>
- <remark>
- [PD] Right. Don't use truncated words like Config
- in labels. Should either be written out, or, if
- that's too long, try to pick a different term.
- </remark>
+ <remark>
+ [PD] Right. Don't use truncated words like Config in
+ labels. Should either be written out, or, if that's
+ too long, try to pick a different term.
+ </remark>
- You can enter the pathname of the server option
- file. MySQL will enter that information in the
- Windows registry, and the Windows service starting
- the MySQL server will use that file, rather than the
- default file (<literal>C:\<replaceable>windows
- installation
- directory</replaceable>\my.ini</literal>).
- <emphasis>Note that this is available for MySQL
- servers as of version 4.0.3 only.</emphasis> Details
- about the server option files can be found in the
- <ulink
+ You can enter the pathname of the server option file.
+ MySQL will enter that information in the Windows
+ registry, and the Windows service starting the MySQL
+ server will use that file, rather than the default file
+ (<literal>C:\<replaceable>windows installation
+ directory</replaceable>\my.ini</literal>).
+ <emphasis>Note that this is available for MySQL servers
+ as of version 4.0.3 only.</emphasis> Details about the
+ server option files can be found in the
+ <ulink
url="http://dev.mysql.com/doc/mysql/en/Windows_create_option_file.html">Creating
- an Option File</ulink> section.
+ an Option File</ulink> section.
- <remark>
- [PD] If this file is passed to the server as the
- --defaults-option (which I suspect is the case),
- the server will read only the [mysqld] option
- group in the file.
- </remark>
- </para>
- </listitem>
+ <remark>
+ [PD] If this file is passed to the server as the
+ --defaults-option (which I suspect is the case), the
+ server will read only the [mysqld] option group in the
+ file.
+ </remark>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Section Name</literal>:
+ <listitem>
+ <para>
+ <literal>Section Name</literal>:
- <remark>
- [SH] FILL IN
- </remark>
+ <remark>
+ [SH] FILL IN
+ </remark>
- Setting a value other than <literal>mysqld</literal>
- is most useful when running multiple servers; see
- <ulink
+ Setting a value other than <literal>mysqld</literal> is
+ most useful when running multiple servers; see
+ <ulink
url="http://dev.mysql.com/doc/mysql/en/Multiple_Windows_servers.html">Running
- Multiple Servers on Windows</ulink>.
+ Multiple Servers on Windows</ulink>.
- <remark>
- [SH] This is likely to change; need to document
- the changed behaviour.
- </remark>
- </para>
- </listitem>
+ <remark>
+ [SH] This is likely to change; need to document the
+ changed behaviour.
+ </remark>
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
- </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>
- Server Features
- </para>
+ <listitem>
+ <para>
+ Server Features
+ </para>
- <para>
- <emphasis>Note that all server features will only take
- effect after the MySQL server has been
- restarted.</emphasis>
+ <para>
+ <emphasis>Note that all server features will only take
+ effect after the MySQL server has been restarted.</emphasis>
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Support for InnoDB</literal>: If checked,
- the MySQL server is started with support for InnoDB
- tables. If unchecked, it doesn't start the InnoDB
- storage engine; this saves memory, but InnoDB tables
- cannot be used. If this checkbox is unchecked and
- greyed out, it means that your MySQL server isn't
- compiled with support for InnoDB tables. (This is,
- for example, true for some versions that run under a
- commercial license.) You can find more information
- on InnoDB tables in the
- <ulink url="http://dev.mysql.com/doc/mysql/en/Storage_engines.html">MySQL
- Storage Engines and Table Types</ulink> section.
- </para>
+ <listitem>
+ <para>
+ <literal>Support for InnoDB</literal>: If checked, the
+ MySQL server is started with support for InnoDB tables.
+ If unchecked, it doesn't start the InnoDB storage
+ engine; this saves memory, but InnoDB tables cannot be
+ used. If this checkbox is unchecked and greyed out, it
+ means that your MySQL server isn't compiled with support
+ for InnoDB tables. (This is, for example, true for some
+ versions that run under a commercial license.) You can
+ find more information on InnoDB tables in the
+ <ulink url="http://dev.mysql.com/doc/mysql/en/Storage_engines.html">MySQL
+ Storage Engines and Table Types</ulink> section.
+ </para>
- <para>
- <emphasis>Be careful when disabling this option! If
- any databases on the MySQL server contain InnoDB
- tables, disabling this option makes those tables
- inaccessible.</emphasis>
- </para>
- </listitem>
+ <para>
+ <emphasis>Be careful when disabling this option! If any
+ databases on the MySQL server contain InnoDB tables,
+ disabling this option makes those tables
+ inaccessible.</emphasis>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Support for BDB</literal>: If checked, the
- MySQL server is started with support for BDB tables.
- If unchecked, it doesn't start the BDB storage
- engine; this saves memory, but BDB tables cannot be
- used. If this checkbox is unchecked and greyed out,
- it means that your MySQL server isn't compiled with
- support for BDB tables. (This is, for example, true
- for non-max versions.) You can find more information
- on BDB tables in the
- <ulink
+ <listitem>
+ <para>
+ <literal>Support for BDB</literal>: If checked, the
+ MySQL server is started with support for BDB tables. If
+ unchecked, it doesn't start the BDB storage engine; this
+ saves memory, but BDB tables cannot be used. If this
+ checkbox is unchecked and greyed out, it means that your
+ MySQL server isn't compiled with support for BDB tables.
+ (This is, for example, true for non-max versions.) You
+ can find more information on BDB tables in the
+ <ulink
url="http://dev.mysql.com/doc/mysql/en/Storage_engines.html">MySQL
- Storage Engines and Table Types</ulink> section.
- </para>
+ Storage Engines and Table Types</ulink> section.
+ </para>
- <para>
- <emphasis>Be careful when disabling this option! If
- any databases on the MySQL server contain BDB
- tables, disabling this option makes those tables
- inaccessible.</emphasis>
- </para>
- </listitem>
+ <para>
+ <emphasis>Be careful when disabling this option! If any
+ databases on the MySQL server contain BDB tables,
+ disabling this option makes those tables
+ inaccessible.</emphasis>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Named Pipes</literal>: On operating systems
- of the Windows NT family, including Windows NT,
- Windows 2000, and Windows XP, you may use named
- pipes to connect to a MySQL server running on the
- local machine, rather than connecting via TCP/IP. If
- this option is checked, named pipe connections are
- allowed. Note that named pipes are slower than
- TCP/IP in many Windows configurations. See the
- <ulink
+ <listitem>
+ <para>
+ <literal>Named Pipes</literal>: On operating systems of
+ the Windows NT family, including Windows NT, Windows
+ 2000, and Windows XP, you may use named pipes to connect
+ to a MySQL server running on the local machine, rather
+ than connecting via TCP/IP. If this option is checked,
+ named pipe connections are allowed. Note that named
+ pipes are slower than TCP/IP in many Windows
+ configurations. See the
+ <ulink
url="http://dev.mysql.com/doc/mysql/en/Windows_select_server.html">Selecting
- a MySQL Server type</ulink> section for details.
- </para>
- </listitem>
+ a MySQL Server type</ulink> section for details.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Debug Information (slow)</literal>: If
- checked, the MySQL server is started with an option
- that allows for easier debugging of problems. Using
- this option slows down the server significantly, so
- it is recommended only for debugging purposes. If
- the MySQL server has not been compiled with
- debugging support, this option is greyed out. See
- the
- <ulink
+ <listitem>
+ <para>
+ <literal>Debug Information (slow)</literal>: If checked,
+ the MySQL server is started with an option that allows
+ for easier debugging of problems. Using this option
+ slows down the server significantly, so it is
+ recommended only for debugging purposes. If the MySQL
+ server has not been compiled with debugging support,
+ this option is greyed out. See the
+ <ulink
url="http://dev.mysql.com/doc/mysql/en/Server_options.html"><command>mysqld</command>
- Command-line Options</ulink> section for details.
- </para>
- </listitem>
+ Command-line Options</ulink> section for details.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Path to Binary</literal>: Contains the
- pathname of the MySQL server binary file as it is
- listed in the Windows service manager (for example
- <literal>C:\mysql\bin\mysqld-max-nt</literal>). Note
- that the the Windows service manager does not
- display the <literal>.exe</literal> extension.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Path to Binary</literal>: Contains the pathname
+ of the MySQL server binary file as it is listed in the
+ Windows service manager (for example
+ <literal>C:\mysql\bin\mysqld-max-nt</literal>). Note
+ that the the Windows service manager does not display
+ the <literal>.exe</literal> extension.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
- </listitem>
+ </itemizedlist>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</section>
@@ -1519,50 +1485,64 @@
effect. You can do this using the <guibutton>Stop
Server</guibutton> and <guibutton>Start Server</guibutton>
buttons in the
- <link
-
+ <link
linkend="mysql-administrator-service-control-start-stop-service">Service
Control</link> section.</emphasis>
</para>
<!--
- <para>
- The <literal>Startup Variables</literal> section has three tabs: one
-for general variables, one for variables specific for the MyISAM
-storage engine, and one for variables specific for the InnoDB storage
-engine.
- </para>
- <para>
- Each tab has two buttons labeled <guibutton>Apply changes</guibutton>
-and <guibutton>Discard changes</guibutton> <remark>[SH] Mike: Capitalise
-"changes"?</remark>.
-<itemizedlist>
-<listitem><para>
-If you click <guibutton>Apply changes</guibutton>, the variables and
-their values will be written to the option file. If a parameter exists
-in that file, it will be assigned a new value; if it does not exist, a
-new line is added to the option file with this parameter. Above that
-line, and additional comment is written giving a short explanation for
-that parameter.
-</para></listitem>
+ <para>
+ The <literal>Startup Variables</literal> section has three tabs:
+ one for general variables, one for variables specific for the
+ MyISAM storage engine, and one for variables specific for the
+ InnoDB storage engine.
+ </para>
-<listitem><para>
-Clicking <guibutton>Discard</guibutton> discards
-any changes made in the fields of the tab, and resets them to their
-previous values. You will be prompted to confirm that you really want to
-discard the changes. If you click <guibutton>Yes</guibutton>, nothing
-will be changed in the option file (<literal>my.ini</literal> or
-<literal>my.cnf</literal>).
-</para></listitem>
-</itemizedlist>
- </para>
- <para>
- Some fields include a drop-down box where you can either select
-<guimenu>K</guimenu> to indicate that the value is specified in
-kilobytes, or <guimenu>M</guimenu> to indicate that it is in
-megabytes.
- </para>
+ <para>
+ Each tab has two buttons labeled <guibutton>Apply
+ changes</guibutton> and <guibutton>Discard changes</guibutton>.
+
+ <remark>
+ [SH] Mike: Capitalise "changes"?
+ </remark>
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ If you click <guibutton>Apply changes</guibutton>, the
+ variables and their values will be written to the option
+ file. If a parameter exists in that file, it will be
+ assigned a new value; if it does not exist, a new line is
+ added to the option file with this parameter. Above that
+ line, and additional comment is written giving a short
+ explanation for that parameter.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Clicking <guibutton>Discard</guibutton> discards any changes
+ made in the fields of the tab, and resets them to their
+ previous values. You will be prompted to confirm that you
+ really want to discard the changes. If you click
+ <guibutton>Yes</guibutton>, nothing will be changed in the
+ option file (<literal>my.ini</literal> or
+ <literal>my.cnf</literal>).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Some fields include a drop-down box where you can either select
+ <guimenu>K</guimenu> to indicate that the value is specified in
+ kilobytes, or <guimenu>M</guimenu> to indicate that it is in
+ megabytes.
+ </para>
+
-->
</section>
@@ -1872,9 +1852,8 @@
<para>
Note that you will see an additional thread for the user under
which you are connected when you have clicked the
- <link
- linkend="mysql-administrator-health">Health</link>
- section within your current &administrator; session. The values
+ <link linkend="mysql-administrator-health">Health</link> section
+ within your current &administrator; session. The values
displayed in that section are retrieved from the MySQL server
via a separate connection.
</para>
@@ -1933,8 +1912,7 @@
<para>
This tab displays all connections to the server (threads), but
in a different way than the
- <link
-
+ <link
linkend="mysql-administrator-server-connections-threads">Threads</link>
tab does: You will rather see users, not individual threads in
the first place. The number of connections a user has currently
@@ -1944,8 +1922,7 @@
the <literal>Full Name</literal> and the
<literal>Description</literal>, as specified in the
<literal>User Information</literal> tab of the
- <link
-
+ <link
linkend="mysql-administrator-user-administration-user-information"
>User
Administration</link> section. Initially, users are sorted by
@@ -2019,9 +1996,8 @@
<para>
Existing users are listed in the lower left area of the
- <link
- linkend="mysql-administrator-sidebar">sidebar</link>.
- If there are many user accounts on your MySQL server, the field
+ <link linkend="mysql-administrator-sidebar">sidebar</link>. If
+ there are many user accounts on your MySQL server, the field
with the magnifying-glass icon may be handy for filtering the
users you are looking for. Typing in <literal>t</literal> or
<literal>T</literal>, for example, will set the filter to users
@@ -2089,82 +2065,78 @@
<para>
Right-clicking on a username, or on one of the subcategories a
user might have, provides access to the following commands:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Add a new User</literal>: Selecting this command
- adds a new user with the default name <literal>New
- User</literal> to the user list. You will have to fill in
- at least a username in the <literal>MySQL User</literal>
- field of the
- <link
-
+ <listitem>
+ <para>
+ <literal>Add a new User</literal>: Selecting this command
+ adds a new user with the default name <literal>New
+ User</literal> to the user list. You will have to fill in at
+ least a username in the <literal>MySQL User</literal> field
+ of the
+ <link
linkend="mysql-administrator-user-administration-user-information">User
- Information</link> tab, which, after applying this change,
- will also rename that user in the user accounts list.
- </para>
- </listitem>
+ Information</link> tab, which, after applying this change,
+ will also rename that user in the user accounts list.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Add Host from which the User can
- connect</literal>: Allows you to specify a host from which
- the user can connect. This command is unavailable if you
- highlight a subcategory.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Add Host from which the User can connect</literal>:
+ Allows you to specify a host from which the user can
+ connect. This command is unavailable if you highlight a
+ subcategory.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Remove Host from which the User can
- connect</literal>: Allows you to remove a host from which
- the user can connect. If there are no sub-categories, the
- user will be removed (you will be prompted to confirm the
- removal).
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Remove Host from which the User can
+ connect</literal>: Allows you to remove a host from which
+ the user can connect. If there are no sub-categories, the
+ user will be removed (you will be prompted to confirm the
+ removal).
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Clone User</literal>: Makes a copy of the
- selected user, including all subcategories. The new user
- is called <literal>New User</literal> until you specify
- another name in the <literal>MySQL User</literal> field of
- the
- <link
-
+ <listitem>
+ <para>
+ <literal>Clone User</literal>: Makes a copy of the selected
+ user, including all subcategories. The new user is called
+ <literal>New User</literal> until you specify another name
+ in the <literal>MySQL User</literal> field of the
+ <link
linkend="mysql-administrator-user-administration-user-information">User
- Information</link> tab. With that command, you can
- therefore create a user with identical privileges.
+ Information</link> tab. With that command, you can therefore
+ create a user with identical privileges.
- <remark>
- [SH] Not yet implemented.
- </remark>
- </para>
- </listitem>
+ <remark>
+ [SH] Not yet implemented.
+ </remark>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Delete User</literal>: Allows you to delete the
- selected user. You will be prompted to confirm that you
- really want to delete that user.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Delete User</literal>: Allows you to delete the
+ selected user. You will be prompted to confirm that you
+ really want to delete that user.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Refresh User List</literal>: Rereads the user
- list from the MySQL server. This is helpful when other
- users (on other connections) are editing user accounts.
- Note that selecting that command will collapse all
- subcategories.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Refresh User List</literal>: Rereads the user list
+ from the MySQL server. This is helpful when other users (on
+ other connections) are editing user accounts. Note that
+ selecting that command will collapse all subcategories.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</section>
@@ -2176,13 +2148,11 @@
<para>
The fields in this tab are unavailable unless you either click
on a username in the
- <link
-
+ <link
linkend="mysql-administrator-user-administration-user-accounts">Us
er Accounts</link> area of the
- <link
- linkend="mysql-administrator-sidebar">sidebar</link>,
- or create a new user in that sidebar or using the <guibutton>New
+ <link linkend="mysql-administrator-sidebar">sidebar</link>, or
+ create a new user in that sidebar or using the <guibutton>New
User</guibutton> button on this tab. In the former case, the
fields are filled with the information stored for that user, in
the latter case, all fields are empty.
@@ -2218,136 +2188,135 @@
<literal>mysql</literal> database. The latter table is created
the first time you add a new user, or change an existing user.
Its contents may look like this:
+ </para>
<programlisting>
- mysql> SELECT * FROM mysql.user-info \G
- *************************** 1. row ************
- User: superuser
- Full-name: Stefan Hinz
- Description: MySQL Documentation Team
- Email: stefan@stripped
- Contact-information: Phone: +49 30 123456789
- Fax: +49 30 987654321
- ICQ: 123456789
- Icon:
- </programlisting>
+mysql> SELECT * FROM mysql.user-info \G
+ *************************** 1. row ************
+ User: superuser
+ Full-name: Stefan Hinz
+ Description: MySQL Documentation Team
+ Email: stefan@stripped
+ Contact-information: Phone: +49 30 123456789
+ Fax: +49 30 987654321
+ ICQ: 123456789
+ Icon:
+</programlisting>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- Login Information
+ <listitem>
+ <para>
+ Login Information
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>MySQL User</literal>: Username that is
- specified when connecting to the MySQL server. Note
- that this username has nothing to do with usernames
- you might use elsewhere on your operating system. It
- is recommendable not to use special characters or
- spaces for that username.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>MySQL User</literal>: Username that is
+ specified when connecting to the MySQL server. Note that
+ this username has nothing to do with usernames you might
+ use elsewhere on your operating system. It is
+ recommendable not to use special characters or spaces
+ for that username.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Password</literal>: Password that is
- specified when connecting to the MySQL server. Note
- that this password has nothing to do with passwords
- you might use elsewhere on your operating system. It
- is recommendable not to use special characters or
- spaces for that password. It is, however,
- recommendable to use non-trivial passwords. A very
- trivial password might be <literal>abcde</literal>,
- while a non-trivial password might be
- <literal>lEtusMak3iThartdoGesz</literal>. Note that
- it is not mandatory to specify a password, although
- it is highly recommendable to do so.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Password</literal>: Password that is specified
+ when connecting to the MySQL server. Note that this
+ password has nothing to do with passwords you might use
+ elsewhere on your operating system. It is recommendable
+ not to use special characters or spaces for that
+ password. It is, however, recommendable to use
+ non-trivial passwords. A very trivial password might be
+ <literal>abcde</literal>, while a non-trivial password
+ might be <literal>lEtusMak3iThartdoGesz</literal>. Note
+ that it is not mandatory to specify a password, although
+ it is highly recommendable to do so.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Confirm Password</literal>: Fill in the
- password once again to make sure you do not
- accidentally introduce a typo.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Confirm Password</literal>: Fill in the
+ password once again to make sure you do not accidentally
+ introduce a typo.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
- </listitem>
+ </itemizedlist>
+ </listitem>
- <listitem>
- <para>
- Additional Information
- </para>
+ <listitem>
+ <para>
+ Additional Information
+ </para>
- <para>
- All information specified here is optional.
+ <para>
+ All information specified here is optional.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Full Name</literal>: As opposed to the
- username in <literal>MySQL User</literal>, the full
- name may contain any characters, including spaces.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Full Name</literal>: As opposed to the username
+ in <literal>MySQL User</literal>, the full name may
+ contain any characters, including spaces.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Description</literal>: Additional
- description of user.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Description</literal>: Additional description
+ of user.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Email</literal>: Email address of user.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Email</literal>: Email address of user.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Contact Information</literal>: More contact
- information, like postal address, or messenger
- information.
+ <listitem>
+ <para>
+ <literal>Contact Information</literal>: More contact
+ information, like postal address, or messenger
+ information.
- <remark>
- [SH] Mike: messager -> messenger
- </remark>
- </para>
- </listitem>
+ <remark>
+ [SH] Mike: messager -> messenger
+ </remark>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Icon</literal>: Rather than using the
- default icon, you may select a different icon by
- pressing the <guibutton>Load from Disk</guibutton>
- button. You can either use one of the buttons that
- are shipped with &administrator;
+ <listitem>
+ <para>
+ <literal>Icon</literal>: Rather than using the default
+ icon, you may select a different icon by pressing the
+ <guibutton>Load from Disk</guibutton> button. You can
+ either use one of the buttons that are shipped with
+ &administrator;,
- <remark>
- [SH] Mike: In which directory?
- </remark>
+ <remark>
+ [SH] Mike: In which directory?
+ </remark>
- , or use an icon of your own. In the latter case, be
- aware that the icon has to be exactly 48 by 48
- pixels in size, and its file format has to be
- <literal>PNG</literal> (portable network graphics).
- </para>
- </listitem>
+ or use an icon of your own. In the latter case, be aware
+ that the icon has to be exactly 48 by 48 pixels in size,
+ and its file format has to be <literal>PNG</literal>
+ (portable network graphics).
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
- </listitem>
+ </itemizedlist>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</section>
@@ -2361,10 +2330,9 @@
<para>
This tab is available only if the <literal>Show Global
Privileges</literal> checkbox in the
- <link
-
-linkend="mysql-gui-options-administrator">Admin
- istrator section of the Options dialog</link> has been checked.
+ <link
+linkend="mysql-gui-options-administrator">Admin istrator
+ section of the Options dialog</link> has been checked.
</para>
<para>
@@ -2431,12 +2399,10 @@
<para>
This tab is available only if the <literal>Show Table/Column
Privileges</literal> checkbox in the
- <link
-
-linkend="mysql-gui-options-administrator">Admin
- istrator section of the Options dialog</link> has been checked.
- It allows you to grant privileges on a table level or on a
- column level.
+ <link
+linkend="mysql-gui-options-administrator">Admin istrator
+ section of the Options dialog</link> has been checked. It allows
+ you to grant privileges on a table level or on a column level.
</para>
<para>
@@ -2444,8 +2410,7 @@
containing that table. You will not see and cannot grant
privileges on a schema level in this tab; if you want to do
that, use the
- <link
-
+ <link
linkend="mysql-administrator-user-administration-global-privileges">Global
Privileges</link> tab instead. Also, you cannot select more than
one table at a time.
@@ -2528,8 +2493,7 @@
variables and system variables. Note that clicking on the status
pages will open an additional connection to the MySQL server,
which you can see when viewing threads and users in the
- <link
- linkend="mysql-administrator-server-connections">Server
+ <link linkend="mysql-administrator-server-connections">Server
Connections</link> section.
</para>
@@ -2940,8 +2904,7 @@
Also note that some tabs may be disabled. If a tab is disabled
it indicates that the log file in question has not been enabled
on the MySQL server. You can enable the various log files in the
- <link
- linkend="mysql-administrator-startup-variables">Startup
+ <link linkend="mysql-administrator-startup-variables">Startup
Variables</link> section.
</para>
@@ -3037,8 +3000,7 @@
<para>
Displays the MySQL server's slow query log. If enabled (which
you can do in the
- <link
- linkend="mysql-administrator-startup-variables">Startup
+ <link linkend="mysql-administrator-startup-variables">Startup
Variables</link> section), the MySQL server writes a log file
containing all SQL commands that took more than a specific
number of seconds to execute. (That number can be configured by
@@ -4040,85 +4002,71 @@
Besides the documentation you are just reading (which is written
in DocBook XML), &administrator; uses a number of XML files for
internal purposes.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>mysqlx-options.xml</literal>: Stores options
- selected in the <link
+ <listitem>
+ <para>
+ <literal>mysqlx-options.xml</literal>: Stores options selected
+ in the <link
linkend="mysql-gui-options">Options
- dialog</link>.
- </para>
- </listitem>
+ dialog</link>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx-status-variables.xml</literal>: Stores the
- status variables known to &administrator;, so that they can
- be assigned descriptions in various languages (see below for
- the XML file containing those descriptions). Those
- descriptions will show up in the
- <link
- linkend="mysql-administrator-health-status-variables">Status
- Variables</link> tab of the
- <link
- linkend="mysql-administrator-health">Health</link>
- section. You can select the language of the descriptions in
- the
- <link
-
-linkend="mysql-gui-options-general-options"
->General
- Options</link> section of the
- <link
- linkend="mysql-gui-options">Options
- dialog</link>. That file also determines in which categories
- or subcategories a variable will appear, and the order in
- which categories and subcategories appear. It does not,
- however, determine in which order variables appear within a
- category or subcategory, as those are sorted lexically by
- &administrator;.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlx-status-variables.xml</literal>: Stores the
+ status variables known to &administrator;, so that they can be
+ assigned descriptions in various languages (see below for the
+ XML file containing those descriptions). Those descriptions
+ will show up in the
+ <link linkend="mysql-administrator-health-status-variables">Status
+ Variables</link> tab of the
+ <link linkend="mysql-administrator-health">Health</link>
+ section. You can select the language of the descriptions in
+ the <link linkend="mysql-gui-options-general-options">General
+ Options</link> section of the
+ <link linkend="mysql-gui-options">Options dialog</link>. That
+ file also determines in which categories or subcategories a
+ variable will appear, and the order in which categories and
+ subcategories appear. It does not, however, determine in which
+ order variables appear within a category or subcategory, as
+ those are sorted lexically by &administrator;.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx-system-variables.xml</literal>: Stores the
- system variables known to &administrator;, so that they can
- be assigned descriptions in various languages (see below for
- the XML file containing those descriptions). Those
- descriptions will show up in the
- <link
- linkend="mysql-administrator-health-system-variables">System
- Variables</link> tab of the
- <link
- linkend="mysql-administrator-health">Health</link>
- section. You can select the language of the descriptions in
- the
- <link
-
-linkend="mysql-gui-options-general-options"
->General
- Options</link> section of the
- <link
- linkend="mysql-gui-options">Options
- dialog</link>. That file also determines in which categories
- or subcategories a variable will appear, and the order in
- which categories and subcategories appear. It does not,
- however, determine in which order variables appear within a
- category or subcategory, as those are sorted lexically by
- &administrator;.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlx-system-variables.xml</literal>: Stores the
+ system variables known to &administrator;, so that they can be
+ assigned descriptions in various languages (see below for the
+ XML file containing those descriptions). Those descriptions
+ will show up in the
+ <link linkend="mysql-administrator-health-system-variables">System
+ Variables</link> tab of the
+ <link linkend="mysql-administrator-health">Health</link>
+ section. You can select the language of the descriptions in
+ the <link linkend="mysql-gui-options-general-options">General
+ Options</link> section of the
+ <link linkend="mysql-gui-options">Options dialog</link>. That
+ file also determines in which categories or subcategories a
+ variable will appear, and the order in which categories and
+ subcategories appear. It does not, however, determine in which
+ order variables appear within a category or subcategory, as
+ those are sorted lexically by &administrator;.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx-translations-administrator.xml</literal> :
- Stores descriptions specific to &administrator;, like
- descriptions for status and server variables, or category
- names, or labels used in dialogs. Here is an excerpt from
- that file, which contains English and German texts:
+ <listitem>
+ <para>
+ <literal>mysqlx-translations-administrator.xml</literal> :
+ Stores descriptions specific to &administrator;, like
+ descriptions for status and server variables, or category
+ names, or labels used in dialogs. Here is an excerpt from that
+ file, which contains English and German texts:
+ </para>
<programlisting>
<textgroup id="MySQLVariables">
@@ -4156,72 +4104,73 @@
...
</programlisting>
- From that excerpt, you can learn a number of things:
+ <para>
+ From that excerpt, you can learn a number of things:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- A description (called <emphasis>text</emphasis>) does
- not necessarily have to be translated (see
- <literal>status-var-Uptime</literal>). If it isn't,
- English will be used instead.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ A description (called <emphasis>text</emphasis>) does not
+ necessarily have to be translated (see
+ <literal>status-var-Uptime</literal>). If it isn't,
+ English will be used instead.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Adding another translation is as simple as adding
- another <literal><trans
- xml:lang="<replaceable>language</replaceable>"></literal>
- tag.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Adding another translation is as simple as adding another
+ <literal><trans
+ xml:lang="<replaceable>language</replaceable>"></literal>
+ tag.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- Therefore, translating the software is a painless task;
- however, please have a look at the
- <link linkend="mysql-gui-appendix-notes-for-translators">Notes
- for Translators</link> below!
- </para>
- </listitem>
+ <para>
+ Therefore, translating the software is a painless task;
+ however, please have a look at the
+ <link linkend="mysql-gui-appendix-notes-for-translators">Notes
+ for Translators</link> below!
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx-translations-general.xml</literal>: Stores
- terms and descriptions that appear not only in
- &administrator;, but also in other graphical MySQL programs.
- Its format, however, is identical with the format of the
- <literal>mysqlx-translations-administrator.xml</literal>
- file. Here is an excerpt from that file:
+ <listitem>
+ <para>
+ <literal>mysqlx-translations-general.xml</literal>: Stores
+ terms and descriptions that appear not only in
+ &administrator;, but also in other graphical MySQL programs.
+ Its format, however, is identical with the format of the
+ <literal>mysqlx-translations-administrator.xml</literal> file.
+ Here is an excerpt from that file:
+ </para>
<programlisting>
- <textgroup id="ResourceStrings">
- <text id="OKBtn">
- <trans xml:lang="en">OK</trans>
- </text>
- <text id="CancelBtn">
- <trans xml:lang="en">Cancel</trans>
- <trans xml:lang="de">Abbruch</trans>
- </text>
- ...
- </programlisting>
- </para>
- </listitem>
+<textgroup id="ResourceStrings">
+ <text id="OKBtn">
+ <trans xml:lang="en">OK</trans>
+ </text>
+ <text id="CancelBtn">
+ <trans xml:lang="en">Cancel</trans>
+ <trans xml:lang="de">Abbruch</trans>
+ </text>
+ ...
+</programlisting>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx-user-connections.xml</literal>: This file is
- described in
- <link
- linkend="mysql-gui-appendix-store-connections">How
- &administrator; Stores Connections</link>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlx-user-connections.xml</literal>: This file is
+ described in
+ <link linkend="mysql-gui-appendix-store-connections">How
+ &administrator; Stores Connections</link>.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</appendix>
Modified: trunk/gui-common/appendix-common-files.xml
===================================================================
--- trunk/gui-common/appendix-common-files.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/appendix-common-files.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -13,30 +13,30 @@
<replaceable>UserName</replaceable> is the name of the current
Windows user. On Linux, the files are stored in the
<literal>~/.mysqlgui</literal> directory.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>mysqlx_common_options.xml</literal>: Stores options
- selected in the <link
+ <listitem>
+ <para>
+ <literal>mysqlx_common_options.xml</literal>: Stores options
+ selected in the <link
linkend="mysql-gui-options">Options
- dialog</link>.
- </para>
- </listitem>
+ dialog</link>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx_user_connections.xml</literal>: This file is
- described in
- <link
+ <listitem>
+ <para>
+ <literal>mysqlx_user_connections.xml</literal>: This file is
+ described in
+ <link
linkend="mysql-gui-appendix-store-connections">How
- Connections are Stored</link>.
- </para>
- </listitem>
+ Connections are Stored</link>.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</appendix>
<!-- END COMMON XML FILES -->
Modified: trunk/gui-common/appendix-connection-storage.xml
===================================================================
--- trunk/gui-common/appendix-connection-storage.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/appendix-connection-storage.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -14,29 +14,30 @@
<literal>~/.mysqlgui</literal> directory. The settings are stored in
a file called <literal>mysqlx_user_connections.xml</literal>. The
contents of that file look like this:
+ </para>
<programlisting>
+<?xml version="1.0"?>
+ <user_connections>
+ <last_connection>1</last_connection>
+ <password_storage_type>2</password_storage_type>
+ <user_connection>
+ <connection_name></connection_name>
+ <username>root</username>
+ <hostname>localhost</hostname>
+ <port>3306</port>
+ <schema></schema>
+ <advanced_options/>
+ <storage_path></storage_path>
+ <notes></notes>
+ <connection_type>0</connection_type>
+ <storage_type>2</storage_type>
+ <password></password>
+ </user_connection>
+ ...
+</programlisting>
- <?xml version="1.0"?>
- <user_connections>
- <last_connection>1</last_connection>
- <password_storage_type>2</password_storage_type>
- <user_connection>
- <connection_name></connection_name>
- <username>root</username>
- <hostname>localhost</hostname>
- <port>3306</port>
- <schema></schema>
- <advanced_options/>
- <storage_path></storage_path>
- <notes></notes>
- <connection_type>0</connection_type>
- <storage_type>2</storage_type>
- <password></password>
- </user_connection>
- ...
- </programlisting>
-
+ <para>
You can edit the file manually, but take care not to invalidate the
XML. When applying changes by editing and saving the file, those
changes will show up the next time you open the
Modified: trunk/gui-common/appendix-source-install.xml
===================================================================
--- trunk/gui-common/appendix-source-install.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/appendix-source-install.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -416,59 +416,61 @@
<para>
To be able to build the MySQL GUI tools from source, you need
the following software:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- g++ development suite
- </para>
- </listitem>
+ <listitem>
+ <para>
+ g++ development suite
+ </para>
+ </listitem>
- <listitem>
- <para>
- gtk-2.x
- </para>
- </listitem>
+ <listitem>
+ <para>
+ gtk-2.x
+ </para>
+ </listitem>
- <listitem>
- <para>
- gtkmm-2.0 or gtkmm-2.2
- </para>
- </listitem>
+ <listitem>
+ <para>
+ gtkmm-2.0 or gtkmm-2.2
+ </para>
+ </listitem>
- <listitem>
- <para>
- libglade-2.x
- </para>
- </listitem>
+ <listitem>
+ <para>
+ libglade-2.x
+ </para>
+ </listitem>
- <listitem>
- <para>
- libxml-2.6.x
- </para>
- </listitem>
+ <listitem>
+ <para>
+ libxml-2.6.x
+ </para>
+ </listitem>
- <listitem>
- <para>
- mysql client libraries (4.0 or newer, 5.0 prefered)
- </para>
- </listitem>
+ <listitem>
+ <para>
+ mysql client libraries (4.0 or newer, 5.0 prefered)
+ </para>
+ </listitem>
- <listitem>
- <para>
- pcre-1.4
- </para>
- </listitem>
+ <listitem>
+ <para>
+ pcre-1.4
+ </para>
+ </listitem>
- <listitem>
- <para>
- autoconf-2.54, automake-1.7.x
- </para>
- </listitem>
+ <listitem>
+ <para>
+ autoconf-2.54, automake-1.7.x
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
In addition, you will need gtkhtml-3.0.x to build the
&query_browser;.
</para>
Modified: trunk/gui-common/appendix-translator-notes.xml
===================================================================
--- trunk/gui-common/appendix-translator-notes.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/appendix-translator-notes.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -19,53 +19,55 @@
would like to translate (the tools, their documentation, or even the
whole MySQL reference manual if you dare), and give some information
regarding your background:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- What is your name?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ What is your name?
+ </para>
+ </listitem>
- <listitem>
- <para>
- In which country and city are you located?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ In which country and city are you located?
+ </para>
+ </listitem>
- <listitem>
- <para>
- How long have you used MySQL?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ How long have you used MySQL?
+ </para>
+ </listitem>
- <listitem>
- <para>
- Have you done other translations?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Have you done other translations?
+ </para>
+ </listitem>
- <listitem>
- <para>
- Will you work alone, or with a group of translators?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Will you work alone, or with a group of translators?
+ </para>
+ </listitem>
- <listitem>
- <para>
- What's your timetable regarding the translation?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ What's your timetable regarding the translation?
+ </para>
+ </listitem>
- <listitem>
- <para>
- What is your motivation for translating?
- </para>
- </listitem>
+ <listitem>
+ <para>
+ What is your motivation for translating?
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
We will get back to you as soon as possible.
</para>
Modified: trunk/gui-common/appendix-troubleshooting.xml
===================================================================
--- trunk/gui-common/appendix-troubleshooting.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/appendix-troubleshooting.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -49,12 +49,14 @@
this button will send an ICMP PING request to the MySQL server
host machine. If the host machine is available over the network,
you will see something like this:
+ </para>
<programlisting>
- Reply from 127.0.0.1: Time=0ms TTL=128
- Reply from 127.0.0.1: Time=1ms TTL=128
- </programlisting>
+Reply from 127.0.0.1: Time=0ms TTL=128
+Reply from 127.0.0.1: Time=1ms TTL=128
+</programlisting>
+ <para>
This would indicate that the machine is reachable, and that the
cause of connection failure is not a network problem.
</para>
Modified: trunk/gui-common/chapter-options-connections.xml
===================================================================
--- trunk/gui-common/chapter-options-connections.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/chapter-options-connections.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -54,80 +54,79 @@
<literal>Connections</literal> or <literal>History</literal> trees,
the <literal>Connection Parameters</literal> tab displays the
following fields:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Connection</literal>: The connection profile label.
- This is the name by which you refer to the profile and that
- appears in the <literal>Connection</literal> drop-down box of
- the Connection dialog. It may contain any characters,
- including spaces. Choose distinctive names so that you can
- easily tell which profiles they refer to. The names can help
- you distinguish connections to different MySQL servers, or
- connections as different MySQL users to a given server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Connection</literal>: The connection profile label.
+ This is the name by which you refer to the profile and that
+ appears in the <literal>Connection</literal> drop-down box of
+ the Connection dialog. It may contain any characters, including
+ spaces. Choose distinctive names so that you can easily tell
+ which profiles they refer to. The names can help you distinguish
+ connections to different MySQL servers, or connections as
+ different MySQL users to a given server.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Username</literal>: The username used to connect to
- the MySQL server.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Username</literal>: The username used to connect to the
+ MySQL server.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Password</literal>: The password used to connect to
- the MySQL server. Note that passwords are not stored in the
- connection profile, unless you specify otherwise in the
- <link
+ <listitem>
+ <para>
+ <literal>Password</literal>: The password used to connect to the
+ MySQL server. Note that passwords are not stored in the
+ connection profile, unless you specify otherwise in the
+ <link
linkend="mysql-gui-options-general-options">General
- Options section</link>.
- </para>
- </listitem>
+ Options section</link>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Hostname</literal>: The name of the host machine
- where the MySQL server runs, or its IP address.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Hostname</literal>: The name of the host machine where
+ the MySQL server runs, or its IP address.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Port</literal>: The TCP/IP port that the MySQL server
- listens to on the host machine.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Port</literal>: The TCP/IP port that the MySQL server
+ listens to on the host machine.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Type</literal>: Specifies the protocol used to
- connect to the database server. The default protocol is
- <literal>MySQL</literal> (which uses the native MySQL
- protocol).
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Type</literal>: Specifies the protocol used to connect
+ to the database server. The default protocol is
+ <literal>MySQL</literal> (which uses the native MySQL protocol).
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Schema</literal>: The default database for a
- connection when using the &query_browser;.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Schema</literal>: The default database for a connection
+ when using the &query_browser;.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Notes</literal>: You can use this field to enter
- comments or additional information describing the connection
- profile.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Notes</literal>: You can use this field to enter
+ comments or additional information describing the connection
+ profile.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
<note>
@@ -146,85 +145,85 @@
<literal>Connections</literal> or <literal>History</literal> list,
the <literal>Advanced Parameters</literal> tab displays the
following checkboxes:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Use compressed protocol</literal>: If checked, the
- communication between the application and the MySQL server
- will be compressed, which may increase transfer rates. This
- corresponds to starting a MySQL command-line tool with the
- <literal>--compress</literal> option.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Use compressed protocol</literal>: If checked, the
+ communication between the application and the MySQL server will
+ be compressed, which may increase transfer rates. This
+ corresponds to starting a MySQL command-line tool with the
+ <literal>--compress</literal> option.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Return number of found rows, not number of affected
- rows</literal>: By default, MySQL returns the number of rows
- changed by the last <literal>UPDATE</literal>, deleted by the
- last <literal>DELETE</literal> or inserted by the last
- <literal>INSERT</literal> statement. When this option is
- checked, the server returns the number of rows matched by the
- <literal>WHERE</literal> statement for
- <literal>UPDATE</literal> statements.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Return number of found rows, not number of affected
+ rows</literal>: By default, MySQL returns the number of rows
+ changed by the last <literal>UPDATE</literal>, deleted by the
+ last <literal>DELETE</literal> or inserted by the last
+ <literal>INSERT</literal> statement. When this option is
+ checked, the server returns the number of rows matched by the
+ <literal>WHERE</literal> statement for <literal>UPDATE</literal>
+ statements.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Ignore spaces after function names, make them
- reserved words</literal>: Normally, any reference to a
- function name in an SQL statement must be followed immediately
- by an opening parenthesis. If this option is checked, spaces
- may appear between the function name and the parenthesis, like
- this:
+ <listitem>
+ <para>
+ <literal>Ignore spaces after function names, make them reserved
+ words</literal>: Normally, any reference to a function name in
+ an SQL statement must be followed immediately by an opening
+ parenthesis. If this option is checked, spaces may appear
+ between the function name and the parenthesis, like this:
+ </para>
<programlisting>
- COUNT (*)
- </programlisting>
+COUNT (*)
+</programlisting>
- Enabling this option has the effect that function names become
- reserved words. This option corresponds to starting a MySQL
- command-line tool with the <literal>--ignore-spaces</literal>
- option.
- </para>
- </listitem>
+ <para>
+ Enabling this option has the effect that function names become
+ reserved words. This option corresponds to starting a MySQL
+ command-line tool with the <literal>--ignore-spaces</literal>
+ option.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Allow interactive_timeout seconds of inactivity
- before disconnect</literal>: Normally, the connection is
- closed by the MySQL server after a certain period of
- inactivity on the client side. This period can be set with the
- <literal>interactive_timeout</literal> variable. If checked,
- the server will not close the connection unless the period of
- inactivity exceeds the value set by
- <literal>interactive_timeout</literal>. This corresponds to
- starting a MySQL command-line tool with the
- <literal>--connect-timeout=<replaceable>seconds</replaceable>
- </literal> option.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Allow interactive_timeout seconds of inactivity before
+ disconnect</literal>: Normally, the connection is closed by the
+ MySQL server after a certain period of inactivity on the client
+ side. This period can be set with the
+ <literal>interactive_timeout</literal> variable. If checked, the
+ server will not close the connection unless the period of
+ inactivity exceeds the value set by
+ <literal>interactive_timeout</literal>. This corresponds to
+ starting a MySQL command-line tool with the
+ <literal>--connect-timeout=<replaceable>seconds</replaceable>
+ </literal> option.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Enable LOAD DATA LOCAL handling</literal>: By
- default, the <literal>LOCAL</literal> option of the
- <literal>LOAD DATA</literal> statement is disabled for
- security reasons. Enabling this option will allow you to load
- data from the local machine (the machine where the client GUI
- application is running). This option corresponds to starting a
- MySQL command-line tool with the
- <literal>--local-infile=1</literal> option. (Note that this
- option is ineffective unless the MySQL server allows
- <literal>LOCAL</literal> handling.)
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Enable LOAD DATA LOCAL handling</literal>: By default,
+ the <literal>LOCAL</literal> option of the <literal>LOAD
+ DATA</literal> statement is disabled for security reasons.
+ Enabling this option will allow you to load data from the local
+ machine (the machine where the client GUI application is
+ running). This option corresponds to starting a MySQL
+ command-line tool with the <literal>--local-infile=1</literal>
+ option. (Note that this option is ineffective unless the MySQL
+ server allows <literal>LOCAL</literal> handling.)
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</section>
<!-- END CONNECTIONS -->
Modified: trunk/gui-common/chapter-options-introduction.xml
===================================================================
--- trunk/gui-common/chapter-options-introduction.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/gui-common/chapter-options-introduction.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -14,67 +14,69 @@
connection profiles, general program settings, and more. You can
open the <literal>Options</literal> dialog window using one of the
following methods:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- In the connection dialog window, click the
- <guibutton>...</guibutton> button.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ In the connection dialog window, click the
+ <guibutton>...</guibutton> button.
+ </para>
+ </listitem>
- <listitem>
- <para>
- In the main application window select <guimenu>Options
- ...</guimenu> from the <guimenu>Tools</guimenu> menu.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ In the main application window select <guimenu>Options
+ ...</guimenu> from the <guimenu>Tools</guimenu> menu.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <figure>
- <title>Options dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/options.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Options dialog</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Options dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/options.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Options dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
In the sidebar of the dialog, you can select the section you wish to
configure. There are three action buttons in the lower right corner
of the window:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <guibutton>Apply</guibutton>: Applies and saves changes.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <guibutton>Apply</guibutton>: Applies and saves changes.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <guibutton>Discard</guibutton>: Discards any changes you have
- made.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <guibutton>Discard</guibutton>: Discards any changes you have
+ made.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <guibutton>Close</guibutton>: Closes the
- <literal>Options</literal> dialog window. If you have not
- applied or discarded your changes, you will be prompted to do
- so.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <guibutton>Close</guibutton>: Closes the
+ <literal>Options</literal> dialog window. If you have not
+ applied or discarded your changes, you will be prompted to do
+ so.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</section>
<!-- END INTRODUCTION -->
Modified: trunk/query-browser/query-browser.xml
===================================================================
--- trunk/query-browser/query-browser.xml 2006-04-28 13:25:12 UTC (rev 1966)
+++ trunk/query-browser/query-browser.xml 2006-04-28 19:05:56 UTC (rev 1967)
@@ -191,21 +191,19 @@
<para>
To see all files in the tarball, run this command:
+ </para>
<programlisting>
-
- shell> tar -tzf mysql-query-browser-<replaceable>version</replaceable>-linux.tar.gz
- </programlisting>
- </para>
+shell> tar -tzf mysql-query-browser-<replaceable>version</replaceable>-linux.tar.gz
+</programlisting>
<para>
To install &query_browser;, run this command:
+ </para>
<programlisting>
-
- shell> tar --directory=<replaceable>/opt</replaceable> -xzvf mysql-query-browser-<replaceable>version</replaceable>-linux.tar.gz
- </programlisting>
- </para>
+shell> tar --directory=<replaceable>/opt</replaceable> -xzvf mysql-query-browser-<replaceable>version</replaceable>-linux.tar.gz
+</programlisting>
<para>
This installs the application binary in
@@ -259,24 +257,26 @@
<literal>Start</literal> menu). Alternatively, you can open
a DOS window and start the &query_browser; from the command
line:
+ </para>
<programlisting>
C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL Query Browser 1.1\MySQLQueryBrowser.exe
</programlisting>
+ <para>
<replaceable>%PROGRAMFILES%</replaceable> is the default
directory for programs on your machine. For example,
<literal>C:\Program Files</literal> or
<literal>C:\programme</literal>. If your path contains
spaces, you should enclose the command within double quotes.
For example:
+ </para>
<programlisting>
C:\> "C:\program files\MySQL\GUITools\MySQLQueryBrowser.exe"
</programlisting>
- </para>
</listitem>
<listitem>
@@ -441,81 +441,81 @@
<para>
The main query window is divided up into several sections:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <emphasis>Query Toolbar:</emphasis> The query toolbar is
- where you create and execute your queries. It is composed
- of three navigation buttons (<guibutton>Go
- Back</guibutton>, <guibutton>Next</guibutton>,
- <guibutton>Refresh</guibutton>), the query area, two
- action buttons (<guibutton>Execute</guibutton> and
- <guibutton>Stop</guibutton>), and a status indicator.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis>Query Toolbar:</emphasis> The query toolbar is
+ where you create and execute your queries. It is composed of
+ three navigation buttons (<guibutton>Go Back</guibutton>,
+ <guibutton>Next</guibutton>,
+ <guibutton>Refresh</guibutton>), the query area, two action
+ buttons (<guibutton>Execute</guibutton> and
+ <guibutton>Stop</guibutton>), and a status indicator.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <emphasis>Advanced Toolbar:</emphasis> The advanced
- toolbar contains three sets of buttons: the Transaction
- Buttons (<guibutton>Start</guibutton>,
- <guibutton>Commit</guibutton>,
- <guibutton>Rollback</guibutton>), the query management
- buttons (<guibutton>Explain</guibutton>,
- <guibutton>Compare</guibutton>), and the query building
- buttons (<guibutton>Select</guibutton>,
- <guibutton>From</guibutton>, <guibutton>Where</guibutton>,
- and so on.)
- </para>
+ <listitem>
+ <para>
+ <emphasis>Advanced Toolbar:</emphasis> The advanced toolbar
+ contains three sets of buttons: the Transaction Buttons
+ (<guibutton>Start</guibutton>,
+ <guibutton>Commit</guibutton>,
+ <guibutton>Rollback</guibutton>), the query management
+ buttons (<guibutton>Explain</guibutton>,
+ <guibutton>Compare</guibutton>), and the query building
+ buttons (<guibutton>Select</guibutton>,
+ <guibutton>From</guibutton>, <guibutton>Where</guibutton>,
+ and so on.)
+ </para>
- <para>
- The Advanced Toolbar is only visible as illustrated when
- the <literal>Show advanced toolbars</literal> and
- <literal>Show composer buttons toolbar</literal> options
- in the Browser Options screen are checked. See
- <xref
+ <para>
+ The Advanced Toolbar is only visible as illustrated when the
+ <literal>Show advanced toolbars</literal> and <literal>Show
+ composer buttons toolbar</literal> options in the Browser
+ Options screen are checked. See
+ <xref
linkend="gui-options-query-browser"/>.
- </para>
- </listitem>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <emphasis>Result Area:</emphasis> All query results are
- displayed in the result area. You can have multiple tabs
- active at one time, allowing you to work on multiple
- queries. The result area can be split vertically and
- horizontally for performing comparisons, and queries in
- different parts of a split result area can be joined
- together for master-detail analysis.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis>Result Area:</emphasis> All query results are
+ displayed in the result area. You can have multiple tabs
+ active at one time, allowing you to work on multiple
+ queries. The result area can be split vertically and
+ horizontally for performing comparisons, and queries in
+ different parts of a split result area can be joined
+ together for master-detail analysis.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <emphasis>Object Browser:</emphasis> The object browser is
- part of the sidebar and allows you to manage your
- databases, bookmarks, and history. You can choose which
- database and tables to query, add commonly-used queries to
- a collection of bookmarks, and browse through previously
- issued queries to use them again.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis>Object Browser:</emphasis> The object browser is
+ part of the sidebar and allows you to manage your databases,
+ bookmarks, and history. You can choose which database and
+ tables to query, add commonly-used queries to a collection
+ of bookmarks, and browse through previously issued queries
+ to use them again.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <emphasis>Information Browser:</emphasis> The Information
- Browser is part of the sidebar and is used to look up
- built-in functions, and to manage queries that contain
- parameters. One example of this is when establishing a
- master-detail pair of queries. The data in the master
- query is available as parameters to the detail query.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis>Information Browser:</emphasis> The Information
+ Browser is part of the sidebar and is used to look up
+ built-in functions, and to manage queries that contain
+ parameters. One example of this is when establishing a
+ master-detail pair of queries. The data in the master query
+ is available as parameters to the detail query.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
<para>
Most of these sections can be displayed and hidden using the
@@ -2135,12 +2135,14 @@
<para>
The following PHP code will be used as an example:
+ </para>
<programlisting>
- $SQL = "SELECT Id, Name, Country FROM City" .
- "WHERE Name LIKE $cityname";
- </programlisting>
+$SQL = "SELECT Id, Name, Country FROM City" .
+ "WHERE Name LIKE $cityname";
+</programlisting>
+ <para>
To copy the listing into the &query_browser;, copy the block of
code (including the assignment portion), right click within the
query area of the &query_browser;, and choose the <guimenu>Paste
@@ -2237,54 +2239,54 @@
Besides the <link linkend="mysql-gui-appendix-xml-files">common
files</link>, &query_browser; uses a number of XML files for
internal purposes.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>mysqlqb_functions.xml</literal>: Stores list of
- functions and operators for use in the
- <link linkend="mysql-query-browser-tour-pandf-functionbrowser">Function
- Browser</link>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlqb_functions.xml</literal>: Stores list of
+ functions and operators for use in the
+ <link linkend="mysql-query-browser-tour-pandf-functionbrowser">Function
+ Browser</link>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx_dbm_data types.xml</literal>: Stores a list
- of the available MySQL data types for use with
- auto-completion and with the
- <link linkend="gui-table-editor">&table_editor;</link>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlx_dbm_data types.xml</literal>: Stores a list of
+ the available MySQL data types for use with auto-completion
+ and with the
+ <link linkend="gui-table-editor">&table_editor;</link>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlx_dbm_charsets.xml</literal>: Stores the
- available MySQL character sets.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlx_dbm_charsets.xml</literal>: Stores the
+ available MySQL character sets.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlqb_history.xml</literal> : Stores the queries
- that make up the
- <link linkend="mysql-query-browser-tour-objectbrowser-history">History
- Browser</link>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlqb_history.xml</literal> : Stores the queries
+ that make up the
+ <link linkend="mysql-query-browser-tour-objectbrowser-history">History
+ Browser</link>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>mysqlqb_bookmark.xml</literal>: Stores the queries
- that form the
- <link linkend="mysql-query-browser-tour-objectbrowser-bookmarks">Bookmark
- Browser</link>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>mysqlqb_bookmark.xml</literal>: Stores the queries
+ that form the
+ <link linkend="mysql-query-browser-tour-objectbrowser-bookmarks">Bookmark
+ Browser</link>
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
</appendix>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1967 - in trunk: . administrator gui-common query-browser | paul | 28 Apr |
