summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorBrandon Nesterenko <brandon.nesterenko@mariadb.com>2021-10-07 11:28:49 -0600
committerBrandon Nesterenko <brandon.nesterenko@mariadb.com>2021-10-07 11:30:22 -0600
commit478020171dd048e2584fd774e3cb30a9c4ae690b (patch)
treef7450115c0d34f567135ec93c4298e5f89fbbb3b /man
parent1ce35c327ed90fa67da53a3f9d470f195d879417 (diff)
downloadmariadb-git-478020171dd048e2584fd774e3cb30a9c4ae690b.tar.gz
MDEV-25444: mysql --binary-mode is not able to replay some mysqlbinlog outputsbb-10.2-MDEV-25444-docs
This is a documentation-only patch to refine the description of binary mode for the mariadb client. Reviewed By: ============ Andrei Elkin <andrei.elkin@mariadb.com>
Diffstat (limited to 'man')
-rw-r--r--man/mysql.19
1 files changed, 8 insertions, 1 deletions
diff --git a/man/mysql.1 b/man/mysql.1
index 56e753160ce..6c05bbab311 100644
--- a/man/mysql.1
+++ b/man/mysql.1
@@ -206,7 +206,14 @@ option\&.
.\" binary-mode option: mysql
\fB\-\-binary\-mode\fR
.sp
-By default, ASCII '\e0' is disallowed and '\er\en' is translated to '\en'\&. This switch turns off both features, and also turns off parsing of all client commands except \eC and DELIMITER, in non-interactive mode (for input piped to mysql or loaded using the 'source' command)\&. This is necessary when processing output from mysqlbinlog that may contain blobs\&.
+Binary mode allows certain character sequences to be processed as data that
+would otherwise be treated with a special meaning by the parser\&.
+Specifically, this switch turns off parsing of all client commands except \eC
+and DELIMITER in non-interactive mode (i\&.e\&., when binary mode is combined
+with either 1) piped input, 2) the --batch mysql option, or 3) the 'source'
+command)\&. Also, in binary mode, occurrences of '\er\en' and ASCII '\e0' are
+preserved within strings, whereas by default, '\er\en' is translated to '\en'
+and '\e0' is disallowed in user input\&.
.RE
.sp
.RS 4