Author: paul
Date: 2008-06-16 17:41:00 +0200 (Mon, 16 Jun 2008)
New Revision: 10958
Log:
r32048@frost: paul | 2008-06-16 10:22:38 -0500
mysql internal commands:
- syntax corrections
- revisions/expansions of command descriptions
Modified:
trunk/it/refman-5.1/programs-client-core.xml
trunk/pt/refman-5.1/programs-client-core.xml
trunk/refman-4.1/programs-client.xml
trunk/refman-5.0/programs-client-core.xml
trunk/refman-5.1/programs-client-core.xml
trunk/refman-6.0/programs-client-core.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:32046
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:31698
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:32048
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:31698
Modified: trunk/it/refman-5.1/programs-client-core.xml
===================================================================
--- trunk/it/refman-5.1/programs-client-core.xml 2008-06-16 15:40:51 UTC (rev 10957)
+++ trunk/it/refman-5.1/programs-client-core.xml 2008-06-16 15:41:00 UTC (rev 10958)
Changed blocks: 12, Lines Added: 68, Lines Deleted: 46; 8901 bytes
@@ -1848,7 +1848,8 @@
</para>
<para>
- Clears the current input.
+ Clears the current input. Use this if you change your mind
+ about executing the statement that you are entering.
</para>
</listitem>
@@ -1900,8 +1901,8 @@
between SQL statements. The default is the semicolon
character (<quote><literal>;</literal></quote>). You should
avoid the use of the backslash
- (<quote><literal>\</literal></quote>) character because that
- is the escape character for MySQL.
+ (<quote><literal>\</literal></quote>) character within the
+ delimiter because that is the escape character for MySQL.
</para>
<para>
@@ -1909,7 +1910,7 @@
set to something other than the default of
<quote><literal>;</literal></quote>, instances of that
character are sent to the server without interpretation.
- However, the server itself interprets
+ However, the server itself still interprets
<quote><literal>;</literal></quote> as a statement delimiter
and processes statements accordingly. This behavior on the
server side comes into play for multiple-statement execution
@@ -2025,12 +2026,12 @@
</para>
<para>
- The <command>nopager</command> command works only in Unix.
+ Disables output paging. See the description for
+ <command>pager</command>.
</para>
<para>
- Disables output paging. See the description for
- <command>pager</command>.
+ The <command>nopager</command> command works only in Unix.
</para>
</listitem>
@@ -2093,15 +2094,19 @@
</para>
<para>
- By using the <option>--pager</option> option, it is possible
- to browse or search query results in interactive mode with
- Unix programs such as <command>less</command>,
- <command>more</command>, or any other similar program. If
- you specify no value for the option,
- <command>mysql</command> checks the value of the
+ By using the <option>--pager</option> option when you invoke
+ <command>mysql</command>, it is possible to browse or search
+ query results in interactive mode with Unix programs such as
+ <command>less</command>, <command>more</command>, or any
+ other similar program. If you specify no value for the
+ option, <command>mysql</command> checks the value of the
<literal>PAGER</literal> environment variable and sets the
- pager to that. Output paging can be enabled interactively
- with the <command>pager</command> command and disabled with
+ pager to that.
+ </para>
+
+ <para>
+ Output paging can be enabled interactively with the
+ <command>pager</command> command and disabled with
<command>nopager</command>. The command takes an optional
argument; if given, the paging program is set to that. With
no argument, the pager is set to the pager that was set on
@@ -2113,9 +2118,9 @@
Output paging works only in Unix because it uses the
<literal>popen()</literal> function, which does not exist on
Windows. For Windows, the <command>tee</command> option can
- be used instead to save query output, although this is not
- as convenient as <command>pager</command> for browsing
- output in some situations.
+ be used instead to save query output, although it is not as
+ convenient as <command>pager</command> for browsing output
+ in some situations.
</para>
</listitem>
@@ -2135,7 +2140,7 @@
</para>
<para>
- Prints the current input statement.
+ Prints the current input statement without executing it.
</para>
</listitem>
@@ -2151,15 +2156,21 @@
<secondary>mysql</secondary>
</indexterm>
- <command>prompt <replaceable>str</replaceable></command>,
- <command>\R <replaceable>str</replaceable></command>
+ <command>prompt [<replaceable>str</replaceable>]</command>,
+ <command>\R [<replaceable>str</replaceable>]</command>
</para>
<para>
- Reconfigures the <command>mysql</command> prompt. The
- special character sequences that can be used in the prompt
- string are described later in this section.
+ Reconfigures the <command>mysql</command> prompt to the
+ given string. The special character sequences that can be
+ used in the prompt are described later in this section.
</para>
+
+ <para>
+ If you specify the <literal>prompt</literal> command with no
+ argument, <command>mysql</command> resets the prompt to the
+ default of <literal>mysql></literal>.
+ </para>
</listitem>
<listitem>
@@ -2198,9 +2209,10 @@
</para>
<para>
- Rebuilds the completion hash that enables, database, table,
+ Rebuilds the completion hash that enables database, table,
and column name completion while you are entering
- statements.
+ statements. (See the description for the
+ <option>--auto-rehash</option> option.)
</para>
</listitem>
@@ -2292,24 +2304,27 @@
<secondary>mysql</secondary>
</indexterm>
- <command>tee <replaceable>file_name</replaceable></command>,
- <command>\T <replaceable>file_name</replaceable></command>
+ <command>tee
+ [<replaceable>file_name</replaceable>]</command>,
+ <command>\T [<replaceable>file_name</replaceable>]</command>
</para>
<para>
- To log queries and their output, use the
- <command>tee</command> command. All the data displayed on
- the screen is appended into a given file. This can be very
- useful for debugging purposes also. You can enable this
- feature on the command line with the <option>--tee</option>
- option, or interactively with the <command>tee</command>
- command. The <command>tee</command> file can be disabled
- interactively with the <command>notee</command> command.
+ By using the <option>--tee</option> option when you invoke
+ <command>mysql</command>, you can log statements and their
+ output. All the data displayed on the screen is appended
+ into a given file. This can be very useful for debugging
+ purposes also. <command>mysql</command> flushes results to
+ the file after each statement, just before it prints its
+ next prompt.
+ </para>
+
+ <para>
+ You can enable this feature interactively with the
+ <command>tee</command> command. Without a parameter, the
+ previous file is used. The <command>tee</command> file can
+ be disabled with the <command>notee</command> command.
Executing <command>tee</command> again re-enables logging.
- Without a parameter, the previous file is used. Note that
- <command>tee</command> flushes query results to the file
- after each statement, just before <command>mysql</command>
- prints its next prompt.
</para>
</listitem>
@@ -2406,6 +2421,19 @@
<listitem>
<para>
+ The <option>-F</option> and <option>-X</option> options may
+ be used with <command>less</command> to cause it to exit if
+ output fits on one screen, which is convenient when no
+ scrolling is necessary:
+ </para>
+
+<programlisting>
+mysql> <userinput>pager less -n -i -S -F -X</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
You can specify very complex pager commands for handling
query output:
</para>
@@ -2586,12 +2614,6 @@
</para>
<para>
- If you specify the <literal>prompt</literal> command with no
- argument, <command>mysql</command> resets the prompt to the
- default of <literal>mysql></literal>.
- </para>
-
- <para>
You can set the prompt in several ways:
</para>
Modified: trunk/pt/refman-5.1/programs-client-core.xml
===================================================================
--- trunk/pt/refman-5.1/programs-client-core.xml 2008-06-16 15:40:51 UTC (rev 10957)
+++ trunk/pt/refman-5.1/programs-client-core.xml 2008-06-16 15:41:00 UTC (rev 10958)
Changed blocks: 12, Lines Added: 68, Lines Deleted: 46; 8901 bytes
@@ -1848,7 +1848,8 @@
</para>
<para>
- Clears the current input.
+ Clears the current input. Use this if you change your mind
+ about executing the statement that you are entering.
</para>
</listitem>
@@ -1900,8 +1901,8 @@
between SQL statements. The default is the semicolon
character (<quote><literal>;</literal></quote>). You should
avoid the use of the backslash
- (<quote><literal>\</literal></quote>) character because that
- is the escape character for MySQL.
+ (<quote><literal>\</literal></quote>) character within the
+ delimiter because that is the escape character for MySQL.
</para>
<para>
@@ -1909,7 +1910,7 @@
set to something other than the default of
<quote><literal>;</literal></quote>, instances of that
character are sent to the server without interpretation.
- However, the server itself interprets
+ However, the server itself still interprets
<quote><literal>;</literal></quote> as a statement delimiter
and processes statements accordingly. This behavior on the
server side comes into play for multiple-statement execution
@@ -2025,12 +2026,12 @@
</para>
<para>
- The <command>nopager</command> command works only in Unix.
+ Disables output paging. See the description for
+ <command>pager</command>.
</para>
<para>
- Disables output paging. See the description for
- <command>pager</command>.
+ The <command>nopager</command> command works only in Unix.
</para>
</listitem>
@@ -2093,15 +2094,19 @@
</para>
<para>
- By using the <option>--pager</option> option, it is possible
- to browse or search query results in interactive mode with
- Unix programs such as <command>less</command>,
- <command>more</command>, or any other similar program. If
- you specify no value for the option,
- <command>mysql</command> checks the value of the
+ By using the <option>--pager</option> option when you invoke
+ <command>mysql</command>, it is possible to browse or search
+ query results in interactive mode with Unix programs such as
+ <command>less</command>, <command>more</command>, or any
+ other similar program. If you specify no value for the
+ option, <command>mysql</command> checks the value of the
<literal>PAGER</literal> environment variable and sets the
- pager to that. Output paging can be enabled interactively
- with the <command>pager</command> command and disabled with
+ pager to that.
+ </para>
+
+ <para>
+ Output paging can be enabled interactively with the
+ <command>pager</command> command and disabled with
<command>nopager</command>. The command takes an optional
argument; if given, the paging program is set to that. With
no argument, the pager is set to the pager that was set on
@@ -2113,9 +2118,9 @@
Output paging works only in Unix because it uses the
<literal>popen()</literal> function, which does not exist on
Windows. For Windows, the <command>tee</command> option can
- be used instead to save query output, although this is not
- as convenient as <command>pager</command> for browsing
- output in some situations.
+ be used instead to save query output, although it is not as
+ convenient as <command>pager</command> for browsing output
+ in some situations.
</para>
</listitem>
@@ -2135,7 +2140,7 @@
</para>
<para>
- Prints the current input statement.
+ Prints the current input statement without executing it.
</para>
</listitem>
@@ -2151,15 +2156,21 @@
<secondary>mysql</secondary>
</indexterm>
- <command>prompt <replaceable>str</replaceable></command>,
- <command>\R <replaceable>str</replaceable></command>
+ <command>prompt [<replaceable>str</replaceable>]</command>,
+ <command>\R [<replaceable>str</replaceable>]</command>
</para>
<para>
- Reconfigures the <command>mysql</command> prompt. The
- special character sequences that can be used in the prompt
- string are described later in this section.
+ Reconfigures the <command>mysql</command> prompt to the
+ given string. The special character sequences that can be
+ used in the prompt are described later in this section.
</para>
+
+ <para>
+ If you specify the <literal>prompt</literal> command with no
+ argument, <command>mysql</command> resets the prompt to the
+ default of <literal>mysql></literal>.
+ </para>
</listitem>
<listitem>
@@ -2198,9 +2209,10 @@
</para>
<para>
- Rebuilds the completion hash that enables, database, table,
+ Rebuilds the completion hash that enables database, table,
and column name completion while you are entering
- statements.
+ statements. (See the description for the
+ <option>--auto-rehash</option> option.)
</para>
</listitem>
@@ -2292,24 +2304,27 @@
<secondary>mysql</secondary>
</indexterm>
- <command>tee <replaceable>file_name</replaceable></command>,
- <command>\T <replaceable>file_name</replaceable></command>
+ <command>tee
+ [<replaceable>file_name</replaceable>]</command>,
+ <command>\T [<replaceable>file_name</replaceable>]</command>
</para>
<para>
- To log queries and their output, use the
- <command>tee</command> command. All the data displayed on
- the screen is appended into a given file. This can be very
- useful for debugging purposes also. You can enable this
- feature on the command line with the <option>--tee</option>
- option, or interactively with the <command>tee</command>
- command. The <command>tee</command> file can be disabled
- interactively with the <command>notee</command> command.
+ By using the <option>--tee</option> option when you invoke
+ <command>mysql</command>, you can log statements and their
+ output. All the data displayed on the screen is appended
+ into a given file. This can be very useful for debugging
+ purposes also. <command>mysql</command> flushes results to
+ the file after each statement, just before it prints its
+ next prompt.
+ </para>
+
+ <para>
+ You can enable this feature interactively with the
+ <command>tee</command> command. Without a parameter, the
+ previous file is used. The <command>tee</command> file can
+ be disabled with the <command>notee</command> command.
Executing <command>tee</command> again re-enables logging.
- Without a parameter, the previous file is used. Note that
- <command>tee</command> flushes query results to the file
- after each statement, just before <command>mysql</command>
- prints its next prompt.
</para>
</listitem>
@@ -2406,6 +2421,19 @@
<listitem>
<para>
+ The <option>-F</option> and <option>-X</option> options may
+ be used with <command>less</command> to cause it to exit if
+ output fits on one screen, which is convenient when no
+ scrolling is necessary:
+ </para>
+
+<programlisting>
+mysql> <userinput>pager less -n -i -S -F -X</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
You can specify very complex pager commands for handling
query output:
</para>
@@ -2586,12 +2614,6 @@
</para>
<para>
- If you specify the <literal>prompt</literal> command with no
- argument, <command>mysql</command> resets the prompt to the
- default of <literal>mysql></literal>.
- </para>
-
- <para>
You can set the prompt in several ways:
</para>
Modified: trunk/refman-4.1/programs-client.xml
===================================================================
--- trunk/refman-4.1/programs-client.xml 2008-06-16 15:40:51 UTC (rev 10957)
+++ trunk/refman-4.1/programs-client.xml 2008-06-16 15:41:00 UTC (rev 10958)
Changed blocks: 12, Lines Added: 68, Lines Deleted: 46; 8877 bytes
@@ -1688,7 +1688,8 @@
</para>
<para>
- Clears the current input.
+ Clears the current input. Use this if you change your mind
+ about executing the statement that you are entering.
</para>
</listitem>
@@ -1740,8 +1741,8 @@
between SQL statements. The default is the semicolon
character (<quote><literal>;</literal></quote>). You should
avoid the use of the backslash
- (<quote><literal>\</literal></quote>) character because that
- is the escape character for MySQL.
+ (<quote><literal>\</literal></quote>) character within the
+ delimiter because that is the escape character for MySQL.
</para>
<para>
@@ -1749,7 +1750,7 @@
set to something other than the default of
<quote><literal>;</literal></quote>, instances of that
character are sent to the server without interpretation.
- However, the server itself interprets
+ However, the server itself still interprets
<quote><literal>;</literal></quote> as a statement delimiter
and processes statements accordingly. This behavior on the
server side comes into play for multiple-statement execution
@@ -1862,12 +1863,12 @@
</para>
<para>
- The <command>nopager</command> command works only in Unix.
+ Disables output paging. See the description for
+ <command>pager</command>.
</para>
<para>
- Disables output paging. See the description for
- <command>pager</command>.
+ The <command>nopager</command> command works only in Unix.
</para>
</listitem>
@@ -1910,15 +1911,19 @@
</para>
<para>
- By using the <option>--pager</option> option, it is possible
- to browse or search query results in interactive mode with
- Unix programs such as <command>less</command>,
- <command>more</command>, or any other similar program. If
- you specify no value for the option,
- <command>mysql</command> checks the value of the
+ By using the <option>--pager</option> option when you invoke
+ <command>mysql</command>, it is possible to browse or search
+ query results in interactive mode with Unix programs such as
+ <command>less</command>, <command>more</command>, or any
+ other similar program. If you specify no value for the
+ option, <command>mysql</command> checks the value of the
<literal>PAGER</literal> environment variable and sets the
- pager to that. Output paging can be enabled interactively
- with the <command>pager</command> command and disabled with
+ pager to that.
+ </para>
+
+ <para>
+ Output paging can be enabled interactively with the
+ <command>pager</command> command and disabled with
<command>nopager</command>. The command takes an optional
argument; if given, the paging program is set to that. With
no argument, the pager is set to the pager that was set on
@@ -1930,9 +1935,9 @@
Output paging works only in Unix because it uses the
<literal>popen()</literal> function, which does not exist on
Windows. For Windows, the <command>tee</command> option can
- be used instead to save query output, although this is not
- as convenient as <command>pager</command> for browsing
- output in some situations.
+ be used instead to save query output, although it is not as
+ convenient as <command>pager</command> for browsing output
+ in some situations.
</para>
</listitem>
@@ -1952,7 +1957,7 @@
</para>
<para>
- Prints the current input statement.
+ Prints the current input statement without executing it.
</para>
</listitem>
@@ -1968,15 +1973,21 @@
<secondary>mysql</secondary>
</indexterm>
- <command>prompt <replaceable>str</replaceable></command>,
- <command>\R <replaceable>str</replaceable></command>
+ <command>prompt [<replaceable>str</replaceable>]</command>,
+ <command>\R [<replaceable>str</replaceable>]</command>
</para>
<para>
- Reconfigures the <command>mysql</command> prompt. The
- special character sequences that can be used in the prompt
- string are described later in this section.
+ Reconfigures the <command>mysql</command> prompt to the
+ given string. The special character sequences that can be
+ used in the prompt are described later in this section.
</para>
+
+ <para>
+ If you specify the <literal>prompt</literal> command with no
+ argument, <command>mysql</command> resets the prompt to the
+ default of <literal>mysql></literal>.
+ </para>
</listitem>
<listitem>
@@ -2015,9 +2026,10 @@
</para>
<para>
- Rebuilds the completion hash that enables, database, table,
+ Rebuilds the completion hash that enables database, table,
and column name completion while you are entering
- statements.
+ statements. (See the description for the
+ <option>--auto-rehash</option> option.)
</para>
</listitem>
@@ -2109,24 +2121,27 @@
<secondary>mysql</secondary>
</indexterm>
- <command>tee <replaceable>file_name</replaceable></command>,
- <command>\T <replaceable>file_name</replaceable></command>
+ <command>tee
+ [<replaceable>file_name</replaceable>]</command>,
+ <command>\T [<replaceable>file_name</replaceable>]</command>
</para>
<para>
- To log queries and their output, use the
- <command>tee</command> command. All the data displayed on
- the screen is appended into a given file. This can be very
- useful for debugging purposes also. You can enable this
- feature on the command line with the <option>--tee</option>
- option, or interactively with the <command>tee</command>
- command. The <command>tee</command> file can be disabled
- interactively with the <command>notee</command> command.
+ By using the <option>--tee</option> option when you invoke
+ <command>mysql</command>, you can log statements and their
+ output. All the data displayed on the screen is appended
+ into a given file. This can be very useful for debugging
+ purposes also. <command>mysql</command> flushes results to
+ the file after each statement, just before it prints its
+ next prompt.
+ </para>
+
+ <para>
+ You can enable this feature interactively with the
+ <command>tee</command> command. Without a parameter, the
+ previous file is used. The <command>tee</command> file can
+ be disabled with the <command>notee</command> command.
Executing <command>tee</command> again re-enables logging.
- Without a parameter, the previous file is used. Note that
- <command>tee</command> flushes query results to the file
- after each statement, just before <command>mysql</command>
- prints its next prompt.
</para>
</listitem>
@@ -2202,6 +2217,19 @@
<listitem>
<para>
+ The <option>-F</option> and <option>-X</option> options may
+ be used with <command>less</command> to cause it to exit if
+ output fits on one screen, which is convenient when no
+ scrolling is necessary:
+ </para>
+
+<programlisting>
+mysql> <userinput>pager less -n -i -S -F -X</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
You can specify very complex pager commands for handling
query output:
</para>
@@ -2379,12 +2407,6 @@
</para>
<para>
- If you specify the <literal>prompt</literal> command with no
- argument, <command>mysql</command> resets the prompt to the
- default of <literal>mysql></literal>.
- </para>
-
- <para>
You can set the prompt in several ways:
</para>
Modified: trunk/refman-5.0/programs-client-core.xml
===================================================================
--- trunk/refman-5.0/programs-client-core.xml 2008-06-16 15:40:51 UTC (rev 10957)
+++ trunk/refman-5.0/programs-client-core.xml 2008-06-16 15:41:00 UTC (rev 10958)
Changed blocks: 12, Lines Added: 68, Lines Deleted: 46; 8892 bytes
@@ -1800,7 +1800,8 @@
</para>
<para>
- Clears the current input.
+ Clears the current input. Use this if you change your mind
+ about executing the statement that you are entering.
</para>
</listitem>
@@ -1852,8 +1853,8 @@
between SQL statements. The default is the semicolon
character (<quote><literal>;</literal></quote>). You should
avoid the use of the backslash
- (<quote><literal>\</literal></quote>) character because that
- is the escape character for MySQL.
+ (<quote><literal>\</literal></quote>) character within the
+ delimiter because that is the escape character for MySQL.
</para>
<para>
@@ -1861,7 +1862,7 @@
set to something other than the default of
<quote><literal>;</literal></quote>, instances of that
character are sent to the server without interpretation.
- However, the server itself interprets
+ However, the server itself still interprets
<quote><literal>;</literal></quote> as a statement delimiter
and processes statements accordingly. This behavior on the
server side comes into play for multiple-statement execution
@@ -1976,12 +1977,12 @@
</para>
<para>
- The <command>nopager</command> command works only in Unix.
+ Disables output paging. See the description for
+ <command>pager</command>.
</para>
<para>
- Disables output paging. See the description for
- <command>pager</command>.
+ The <command>nopager</command> command works only in Unix.
</para>
</listitem>
@@ -2045,15 +2046,19 @@
</para>
<para>
- By using the <option>--pager</option> option, it is possible
- to browse or search query results in interactive mode with
- Unix programs such as <command>less</command>,
- <command>more</command>, or any other similar program. If
- you specify no value for the option,
- <command>mysql</command> checks the value of the
+ By using the <option>--pager</option> option when you invoke
+ <command>mysql</command>, it is possible to browse or search
+ query results in interactive mode with Unix programs such as
+ <command>less</command>, <command>more</command>, or any
+ other similar program. If you specify no value for the
+ option, <command>mysql</command> checks the value of the
<literal>PAGER</literal> environment variable and sets the
- pager to that. Output paging can be enabled interactively
- with the <command>pager</command> command and disabled with
+ pager to that.
+ </para>
+
+ <para>
+ Output paging can be enabled interactively with the
+ <command>pager</command> command and disabled with
<command>nopager</command>. The command takes an optional
argument; if given, the paging program is set to that. With
no argument, the pager is set to the pager that was set on
@@ -2065,9 +2070,9 @@
Output paging works only in Unix because it uses the
<literal>popen()</literal> function, which does not exist on
Windows. For Windows, the <command>tee</command> option can
- be used instead to save query output, although this is not
- as convenient as <command>pager</command> for browsing
- output in some situations.
+ be used instead to save query output, although it is not as
+ convenient as <command>pager</command> for browsing output
+ in some situations.
</para>
</listitem>
@@ -2087,7 +2092,7 @@
</para>
<para>
- Prints the current input statement.
+ Prints the current input statement without executing it.
</para>
</listitem>
@@ -2103,15 +2108,21 @@
<secondary>mysql</secondary>
</indexterm>
- <command>prompt <replaceable>str</replaceable></command>,
- <command>\R <replaceable>str</replaceable></command>
+ <command>prompt [<replaceable>str</replaceable>]</command>,
+ <command>\R [<replaceable>str</replaceable>]</command>
</para>
<para>
- Reconfigures the <command>mysql</command> prompt. The
- special character sequences that can be used in the prompt
- string are described later in this section.
+ Reconfigures the <command>mysql</command> prompt to the
+ given string. The special character sequences that can be
+ used in the prompt are described later in this section.
</para>
+
+ <para>
+ If you specify the <literal>prompt</literal> command with no
+ argument, <command>mysql</command> resets the prompt to the
+ default of <literal>mysql></literal>.
+ </para>
</listitem>
<listitem>
@@ -2150,9 +2161,10 @@
</para>
<para>
- Rebuilds the completion hash that enables, database, table,
+ Rebuilds the completion hash that enables database, table,
and column name completion while you are entering
- statements.
+ statements. (See the description for the
+ <option>--auto-rehash</option> option.)
</para>
</listitem>
@@ -2244,24 +2256,27 @@
<secondary>mysql</secondary>
</indexterm>
- <command>tee <replaceable>file_name</replaceable></command>,
- <command>\T <replaceable>file_name</replaceable></command>
+ <command>tee
+ [<replaceable>file_name</replaceable>]</command>,
+ <command>\T [<replaceable>file_name</replaceable>]</command>
</para>
<para>
- To log queries and their output, use the
- <command>tee</command> command. All the data displayed on
- the screen is appended into a given file. This can be very
- useful for debugging purposes also. You can enable this
- feature on the command line with the <option>--tee</option>
- option, or interactively with the <command>tee</command>
- command. The <command>tee</command> file can be disabled
- interactively with the <command>notee</command> command.
+ By using the <option>--tee</option> option when you invoke
+ <command>mysql</command>, you can log statements and their
+ output. All the data displayed on the screen is appended
+ into a given file. This can be very useful for debugging
+ purposes also. <command>mysql</command> flushes results to
+ the file after each statement, just before it prints its
+ next prompt.
+ </para>
+
+ <para>
+ You can enable this feature interactively with the
+ <command>tee</command> command. Without a parameter, the
+ previous file is used. The <command>tee</command> file can
+ be disabled with the <command>notee</command> command.
Executing <command>tee</command> again re-enables logging.
- Without a parameter, the previous file is used. Note that
- <command>tee</command> flushes query results to the file
- after each statement, just before <command>mysql</command>
- prints its next prompt.
</para>
</listitem>
@@ -2358,6 +2373,19 @@
<listitem>
<para>
+ The <option>-F</option> and <option>-X</option> options may
+ be used with <command>less</command> to cause it to exit if
+ output fits on one screen, which is convenient when no
+ scrolling is necessary:
+ </para>
+
+<programlisting>
+mysql> <userinput>pager less -n -i -S -F -X</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
You can specify very complex pager commands for handling
query output:
</para>
@@ -2538,12 +2566,6 @@
</para>
<para>
- If you specify the <literal>prompt</literal> command with no
- argument, <command>mysql</command> resets the prompt to the
- default of <literal>mysql></literal>.
- </para>
-
- <para>
You can set the prompt in several ways:
</para>
Modified: trunk/refman-5.1/programs-client-core.xml
===================================================================
--- trunk/refman-5.1/programs-client-core.xml 2008-06-16 15:40:51 UTC (rev 10957)
+++ trunk/refman-5.1/programs-client-core.xml 2008-06-16 15:41:00 UTC (rev 10958)
Changed blocks: 12, Lines Added: 68, Lines Deleted: 46; 8892 bytes
@@ -1848,7 +1848,8 @@
</para>
<para>
- Clears the current input.
+ Clears the current input. Use this if you change your mind
+ about executing the statement that you are entering.
</para>
</listitem>
@@ -1900,8 +1901,8 @@
between SQL statements. The default is the semicolon
character (<quote><literal>;</literal></quote>). You should
avoid the use of the backslash
- (<quote><literal>\</literal></quote>) character because that
- is the escape character for MySQL.
+ (<quote><literal>\</literal></quote>) character within the
+ delimiter because that is the escape character for MySQL.
</para>
<para>
@@ -1909,7 +1910,7 @@
set to something other than the default of
<quote><literal>;</literal></quote>, instances of that
character are sent to the server without interpretation.
- However, the server itself interprets
+ However, the server itself still interprets
<quote><literal>;</literal></quote> as a statement delimiter
and processes statements accordingly. This behavior on the
server side comes into play for multiple-statement execution
@@ -2025,12 +2026,12 @@
</para>
<para>
- The <command>nopager</command> command works only in Unix.
+ Disables output paging. See the description for
+ <command>pager</command>.
</para>
<para>
- Disables output paging. See the description for
- <command>pager</command>.
+ The <command>nopager</command> command works only in Unix.
</para>
</listitem>
@@ -2093,15 +2094,19 @@
</para>
<para>
- By using the <option>--pager</option> option, it is possible
- to browse or search query results in interactive mode with
- Unix programs such as <command>less</command>,
- <command>more</command>, or any other similar program. If
- you specify no value for the option,
- <command>mysql</command> checks the value of the
+ By using the <option>--pager</option> option when you invoke
+ <command>mysql</command>, it is possible to browse or search
+ query results in interactive mode with Unix programs such as
+ <command>less</command>, <command>more</command>, or any
+ other similar program. If you specify no value for the
+ option, <command>mysql</command> checks the value of the
<literal>PAGER</literal> environment variable and sets the
- pager to that. Output paging can be enabled interactively
- with the <command>pager</command> command and disabled with
+ pager to that.
+ </para>
+
+ <para>
+ Output paging can be enabled interactively with the
+ <command>pager</command> command and disabled with
<command>nopager</command>. The command takes an optional
argument; if given, the paging program is set to that. With
no argument, the pager is set to the pager that was set on
@@ -2113,9 +2118,9 @@
Output paging works only in Unix because it uses the
<literal>popen()</literal> function, which does not exist on
Windows. For Windows, the <command>tee</command> option can
- be used instead to save query output, although this is not
- as convenient as <command>pager</command> for browsing
- output in some situations.
+ be used instead to save query output, although it is not as
+ convenient as <command>pager</command> for browsing output
+ in some situations.
</para>
</listitem>
@@ -2135,7 +2140,7 @@
</para>
<para>
- Prints the current input statement.
+ Prints the current input statement without executing it.
</para>
</listitem>
@@ -2151,15 +2156,21 @@
<secondary>mysql</secondary>
</indexterm>
- <command>prompt <replaceable>str</replaceable></command>,
- <command>\R <replaceable>str</replaceable></command>
+ <command>prompt [<replaceable>str</replaceable>]</command>,
+ <command>\R [<replaceable>str</replaceable>]</command>
</para>
<para>
- Reconfigures the <command>mysql</command> prompt. The
- special character sequences that can be used in the prompt
- string are described later in this section.
+ Reconfigures the <command>mysql</command> prompt to the
+ given string. The special character sequences that can be
+ used in the prompt are described later in this section.
</para>
+
+ <para>
+ If you specify the <literal>prompt</literal> command with no
+ argument, <command>mysql</command> resets the prompt to the
+ default of <literal>mysql></literal>.
+ </para>
</listitem>
<listitem>
@@ -2198,9 +2209,10 @@
</para>
<para>
- Rebuilds the completion hash that enables, database, table,
+ Rebuilds the completion hash that enables database, table,
and column name completion while you are entering
- statements.
+ statements. (See the description for the
+ <option>--auto-rehash</option> option.)
</para>
</listitem>
@@ -2292,24 +2304,27 @@
<secondary>mysql</secondary>
</indexterm>
- <command>tee <replaceable>file_name</replaceable></command>,
- <command>\T <replaceable>file_name</replaceable></command>
+ <command>tee
+ [<replaceable>file_name</replaceable>]</command>,
+ <command>\T [<replaceable>file_name</replaceable>]</command>
</para>
<para>
- To log queries and their output, use the
- <command>tee</command> command. All the data displayed on
- the screen is appended into a given file. This can be very
- useful for debugging purposes also. You can enable this
- feature on the command line with the <option>--tee</option>
- option, or interactively with the <command>tee</command>
- command. The <command>tee</command> file can be disabled
- interactively with the <command>notee</command> command.
+ By using the <option>--tee</option> option when you invoke
+ <command>mysql</command>, you can log statements and their
+ output. All the data displayed on the screen is appended
+ into a given file. This can be very useful for debugging
+ purposes also. <command>mysql</command> flushes results to
+ the file after each statement, just before it prints its
+ next prompt.
+ </para>
+
+ <para>
+ You can enable this feature interactively with the
+ <command>tee</command> command. Without a parameter, the
+ previous file is used. The <command>tee</command> file can
+ be disabled with the <command>notee</command> command.
Executing <command>tee</command> again re-enables logging.
- Without a parameter, the previous file is used. Note that
- <command>tee</command> flushes query results to the file
- after each statement, just before <command>mysql</command>
- prints its next prompt.
</para>
</listitem>
@@ -2406,6 +2421,19 @@
<listitem>
<para>
+ The <option>-F</option> and <option>-X</option> options may
+ be used with <command>less</command> to cause it to exit if
+ output fits on one screen, which is convenient when no
+ scrolling is necessary:
+ </para>
+
+<programlisting>
+mysql> <userinput>pager less -n -i -S -F -X</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
You can specify very complex pager commands for handling
query output:
</para>
@@ -2586,12 +2614,6 @@
</para>
<para>
- If you specify the <literal>prompt</literal> command with no
- argument, <command>mysql</command> resets the prompt to the
- default of <literal>mysql></literal>.
- </para>
-
- <para>
You can set the prompt in several ways:
</para>
Modified: trunk/refman-6.0/programs-client-core.xml
===================================================================
--- trunk/refman-6.0/programs-client-core.xml 2008-06-16 15:40:51 UTC (rev 10957)
+++ trunk/refman-6.0/programs-client-core.xml 2008-06-16 15:41:00 UTC (rev 10958)
Changed blocks: 12, Lines Added: 68, Lines Deleted: 46; 8892 bytes
@@ -1850,7 +1850,8 @@
</para>
<para>
- Clears the current input.
+ Clears the current input. Use this if you change your mind
+ about executing the statement that you are entering.
</para>
</listitem>
@@ -1902,8 +1903,8 @@
between SQL statements. The default is the semicolon
character (<quote><literal>;</literal></quote>). You should
avoid the use of the backslash
- (<quote><literal>\</literal></quote>) character because that
- is the escape character for MySQL.
+ (<quote><literal>\</literal></quote>) character within the
+ delimiter because that is the escape character for MySQL.
</para>
<para>
@@ -1911,7 +1912,7 @@
set to something other than the default of
<quote><literal>;</literal></quote>, instances of that
character are sent to the server without interpretation.
- However, the server itself interprets
+ However, the server itself still interprets
<quote><literal>;</literal></quote> as a statement delimiter
and processes statements accordingly. This behavior on the
server side comes into play for multiple-statement execution
@@ -2027,12 +2028,12 @@
</para>
<para>
- The <command>nopager</command> command works only in Unix.
+ Disables output paging. See the description for
+ <command>pager</command>.
</para>
<para>
- Disables output paging. See the description for
- <command>pager</command>.
+ The <command>nopager</command> command works only in Unix.
</para>
</listitem>
@@ -2095,15 +2096,19 @@
</para>
<para>
- By using the <option>--pager</option> option, it is possible
- to browse or search query results in interactive mode with
- Unix programs such as <command>less</command>,
- <command>more</command>, or any other similar program. If
- you specify no value for the option,
- <command>mysql</command> checks the value of the
+ By using the <option>--pager</option> option when you invoke
+ <command>mysql</command>, it is possible to browse or search
+ query results in interactive mode with Unix programs such as
+ <command>less</command>, <command>more</command>, or any
+ other similar program. If you specify no value for the
+ option, <command>mysql</command> checks the value of the
<literal>PAGER</literal> environment variable and sets the
- pager to that. Output paging can be enabled interactively
- with the <command>pager</command> command and disabled with
+ pager to that.
+ </para>
+
+ <para>
+ Output paging can be enabled interactively with the
+ <command>pager</command> command and disabled with
<command>nopager</command>. The command takes an optional
argument; if given, the paging program is set to that. With
no argument, the pager is set to the pager that was set on
@@ -2115,9 +2120,9 @@
Output paging works only in Unix because it uses the
<literal>popen()</literal> function, which does not exist on
Windows. For Windows, the <command>tee</command> option can
- be used instead to save query output, although this is not
- as convenient as <command>pager</command> for browsing
- output in some situations.
+ be used instead to save query output, although it is not as
+ convenient as <command>pager</command> for browsing output
+ in some situations.
</para>
</listitem>
@@ -2137,7 +2142,7 @@
</para>
<para>
- Prints the current input statement.
+ Prints the current input statement without executing it.
</para>
</listitem>
@@ -2153,15 +2158,21 @@
<secondary>mysql</secondary>
</indexterm>
- <command>prompt <replaceable>str</replaceable></command>,
- <command>\R <replaceable>str</replaceable></command>
+ <command>prompt [<replaceable>str</replaceable>]</command>,
+ <command>\R [<replaceable>str</replaceable>]</command>
</para>
<para>
- Reconfigures the <command>mysql</command> prompt. The
- special character sequences that can be used in the prompt
- string are described later in this section.
+ Reconfigures the <command>mysql</command> prompt to the
+ given string. The special character sequences that can be
+ used in the prompt are described later in this section.
</para>
+
+ <para>
+ If you specify the <literal>prompt</literal> command with no
+ argument, <command>mysql</command> resets the prompt to the
+ default of <literal>mysql></literal>.
+ </para>
</listitem>
<listitem>
@@ -2200,9 +2211,10 @@
</para>
<para>
- Rebuilds the completion hash that enables, database, table,
+ Rebuilds the completion hash that enables database, table,
and column name completion while you are entering
- statements.
+ statements. (See the description for the
+ <option>--auto-rehash</option> option.)
</para>
</listitem>
@@ -2294,24 +2306,27 @@
<secondary>mysql</secondary>
</indexterm>
- <command>tee <replaceable>file_name</replaceable></command>,
- <command>\T <replaceable>file_name</replaceable></command>
+ <command>tee
+ [<replaceable>file_name</replaceable>]</command>,
+ <command>\T [<replaceable>file_name</replaceable>]</command>
</para>
<para>
- To log queries and their output, use the
- <command>tee</command> command. All the data displayed on
- the screen is appended into a given file. This can be very
- useful for debugging purposes also. You can enable this
- feature on the command line with the <option>--tee</option>
- option, or interactively with the <command>tee</command>
- command. The <command>tee</command> file can be disabled
- interactively with the <command>notee</command> command.
+ By using the <option>--tee</option> option when you invoke
+ <command>mysql</command>, you can log statements and their
+ output. All the data displayed on the screen is appended
+ into a given file. This can be very useful for debugging
+ purposes also. <command>mysql</command> flushes results to
+ the file after each statement, just before it prints its
+ next prompt.
+ </para>
+
+ <para>
+ You can enable this feature interactively with the
+ <command>tee</command> command. Without a parameter, the
+ previous file is used. The <command>tee</command> file can
+ be disabled with the <command>notee</command> command.
Executing <command>tee</command> again re-enables logging.
- Without a parameter, the previous file is used. Note that
- <command>tee</command> flushes query results to the file
- after each statement, just before <command>mysql</command>
- prints its next prompt.
</para>
</listitem>
@@ -2408,6 +2423,19 @@
<listitem>
<para>
+ The <option>-F</option> and <option>-X</option> options may
+ be used with <command>less</command> to cause it to exit if
+ output fits on one screen, which is convenient when no
+ scrolling is necessary:
+ </para>
+
+<programlisting>
+mysql> <userinput>pager less -n -i -S -F -X</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
You can specify very complex pager commands for handling
query output:
</para>
@@ -2588,12 +2616,6 @@
</para>
<para>
- If you specify the <literal>prompt</literal> command with no
- argument, <command>mysql</command> resets the prompt to the
- default of <literal>mysql></literal>.
- </para>
-
- <para>
You can set the prompt in several ways:
</para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r10958 - in trunk: . it/refman-5.1 pt/refman-5.1 refman-4.1 refman-5.0 refman-5.1 refman-6.0 | paul | 16 Jun |
