summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Gilfillan <github@greenman.co.za>2020-02-28 16:55:51 +0200
committerAnel <an3l@users.noreply.github.com>2020-03-04 16:50:17 +0100
commitd62766a8905b66236f842b711f61cfa3de52be29 (patch)
treebf14b8e4d4503808566264d0a5e60bd3aa9b1dd6
parent8a25eb666daad18cf93f65aeea2603952cb7fbcd (diff)
downloadmariadb-git-d62766a8905b66236f842b711f61cfa3de52be29.tar.gz
MDEV-21228: mariadb-conv man page
-rw-r--r--man/CMakeLists.txt2
-rw-r--r--man/mariadb-conv.1104
2 files changed, 105 insertions, 1 deletions
diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
index 58c1efaebf1..5570557d3b2 100644
--- a/man/CMakeLists.txt
+++ b/man/CMakeLists.txt
@@ -15,7 +15,7 @@
SET(MAN1_SERVER innochecksum.1 my_print_defaults.1 myisam_ftdump.1 myisamchk.1
aria_chk.1 aria_dump_log.1 aria_ftdump.1 aria_pack.1 aria_read_log.1
- myisamlog.1 myisampack.1 mysql.server.1
+ myisamlog.1 myisampack.1 mysql.server.1 mariadb-conv.1
mysql_convert_table_format.1 mysql_fix_extensions.1
mysql_install_db.1
mysql_secure_installation.1 mysql_setpermission.1
diff --git a/man/mariadb-conv.1 b/man/mariadb-conv.1
new file mode 100644
index 00000000000..9a045ea05e2
--- /dev/null
+++ b/man/mariadb-conv.1
@@ -0,0 +1,104 @@
+'\" t
+.\"
+.TH "\FBMARIADB-CONV" "1" "28 Feb 2020" "MariaDB 10\&.5" "MariaDB Database System"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.\" mariadb\-conv
+.SH "NAME"
+mariadb\-conv \- character set conversion utility for MariaDB
+.SH "SYNOPSIS"
+.HP \w'\fBmariadb\-conv\ [\fR\fB\fIOPTION...\fR\fR\fB]\ [\fR\fB\fIFILE...\fR\fR\fB]\ 'u
+\fBmariadb\-conv [\fR\fB\fIOPTION...\fR\fR\fB] [\fR\fB\fIFILE...\fR\fR\fB] \fR
+.SH "DESCRIPTION"
+.PP
+\fBmariadb\-conv\fR
+is a character set conversion utility for MariaDB\&.
+.PP
+\fBmariadb-conv\fR
+supports the following options\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mariadb-conv: from option
+.\" from option: mariadb-conv
+\fB\-\-from=\fR\fB\fIname\fR\fR,
+\fB\-f \fR\fB\fIname\fR\fR
+.sp
+Specifies the encoding of the input\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mariadb-conv: to option
+.\" to option: mariadb-conv
+\fB\-\-to=\fR\fB\fIname\fR\fR,
+\fB\-t \fR\fB\fIname\fR\fR
+.sp
+Specifies the encoding of the output\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mariadb-conv: continue option
+.\" continue option: mariadb-conv
+\fB\-\-continue\fR,
+\fB\-c \fR
+.sp
+Silently ignore conversion errors\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mariadb-conv: continue option
+.\" continue option: mariadb-conv
+\fB\-\-delimiter=\fR\fB\fIname\fR\fR,
+.sp
+Treat the specified characters as delimiters\&.
+.RE
+.SH "COPYRIGHT"
+.br
+.PP
+Copyright 2020 MariaDB Foundation
+.PP
+This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
+.PP
+This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+.PP
+You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA or see http://www.gnu.org/licenses/.
+.sp
+.SH "SEE ALSO"
+For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/en/mariadb-conv/
+.SH AUTHOR
+MariaDB Foundation (http://www.mariadb.org/).