Skip to content

Commit 5077509

Browse files
iangilfillanvuvova
authored andcommitted
MDEV-7680: Update man pages
1 parent 6dd4114 commit 5077509

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+3290
-1486
lines changed

man/aria_chk.1

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,5 +241,4 @@ Read this file after the global files are read.
241241
.SH "SEE ALSO"
242242
\fBmyisamchk(1)\fR
243243
.PP
244-
For more information, please refer to the MariaDB Knowledge Base,
245-
which is available online at http://mariadb.com/kb/
244+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

man/aria_dump_log.1

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,6 @@ Only read default options from the given file #.
5050
Read this file after the global files are read.
5151
.PP
5252
.SH "SEE ALSO"
53-
For more information, please refer to the MariaDB Knowledge Base,
54-
which is available online at http://mariadb.com/kb/
53+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
54+
.SH AUTHOR
55+
MariaDB Foundation (http://www.mariadb.org/).

man/aria_ftdump.1

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,4 @@ Be verbose.
2525
.SH "SEE ALSO"
2626
\fBmyisam_ftdump(1)\fR
2727
.PP
28-
For more information, please refer to the MariaDB Knowledge Base,
29-
which is available online at http://mariadb.com/kb/
28+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

man/aria_pack.1

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,4 @@ Read this file after the global files are read.
7272
.SH "SEE ALSO"
7373
\fBmyisampack(1)\fR
7474
.PP
75-
For more information, please refer to the MariaDB Knowledge Base,
76-
which is available online at http://mariadb.com/kb/
75+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

man/aria_read_log.1

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,5 +104,4 @@ Read this file after the global files are read.
104104
.SH "SEE ALSO"
105105
\fBmyisamlog(1)\fR
106106
.PP
107-
For more information, please refer to the MariaDB Knowledge Base,
108-
which is available online at http://mariadb.com/kb/
107+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

man/comp_err.1

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
'\" t
2-
.\" Title: \fBcomp_err\fR
3-
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4-
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5-
.\" Date: 04/06/2010
6-
.\" Manual: MySQL Database System
7-
.\" Source: MySQL 5.1
8-
.\" Language: English
92
.\"
10-
.TH "\FBCOMP_ERR\FR" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
3+
.TH "\FBCOMP_ERR\FR" "1" "04/08/2015" "MariaDB 10\&.0" "MariaDB Database System"
114
.\" -----------------------------------------------------------------
125
.\" * set default formatting
136
.\" -----------------------------------------------------------------
@@ -20,7 +13,7 @@
2013
.\" -----------------------------------------------------------------
2114
.\" comp_err
2215
.SH "NAME"
23-
comp_err \- compile MySQL error message file
16+
comp_err \- compile MariaDB error message file
2417
.SH "SYNOPSIS"
2518
.HP \w'\fBcomp_err\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
2619
\fBcomp_err [\fR\fB\fIoptions\fR\fR\fB]\fR
@@ -33,11 +26,11 @@ file that is used by
3326
\fBmysqld\fR
3427
to determine the error messages to display for different error codes\&.
3528
\fBcomp_err\fR
36-
normally is run automatically when MySQL is built\&. It compiles the
29+
normally is run automatically when MariaDB is built\&. It compiles the
3730
errmsg\&.sys
3831
file from the plaintext file located at
3932
sql/share/errmsg\&.txt
40-
in MySQL source distributions\&.
33+
in MariaDB source distributions\&.
4134
.PP
4235
\fBcomp_err\fR
4336
also generates
@@ -254,7 +247,7 @@ Display version information and exit\&.
254247
.SH "COPYRIGHT"
255248
.br
256249
.PP
257-
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
250+
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 MariaDB Foundation
258251
.PP
259252
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.
260253
.PP
@@ -263,8 +256,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
263256
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-1301 USA or see http://www.gnu.org/licenses/.
264257
.sp
265258
.SH "SEE ALSO"
266-
For more information, please refer to the MySQL Reference Manual,
267-
which may already be installed locally and which is also available
268-
online at http://dev.mysql.com/doc/.
259+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
269260
.SH AUTHOR
270-
Sun Microsystems, Inc. (http://www.mysql.com/).
261+
MariaDB Foundation (http://www.mariadb.org/).

man/innochecksum.1

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
'\" t
2-
.\" Title: \fBinnochecksum\fR
3-
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4-
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5-
.\" Date: 04/06/2010
6-
.\" Manual: MySQL Database System
7-
.\" Source: MySQL 5.1
8-
.\" Language: English
92
.\"
10-
.TH "\FBINNOCHECKSUM\FR" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
3+
.TH "\FBINNOCHECKSUM\FR" "1" "04/08/2015" "MariaDB 10\&.0" "MariaDB Database System"
114
.\" -----------------------------------------------------------------
125
.\" * set default formatting
136
.\" -----------------------------------------------------------------
@@ -69,7 +62,7 @@ supports the following options\&. For options that refer to page numbers, the nu
6962
.sp -1
7063
.IP \(bu 2.3
7164
.\}
72-
\fB\-c\fR
65+
\fB\-c, --count\fR
7366
.sp
7467
Print a count of the number of pages in the file\&.
7568
.RE
@@ -82,7 +75,7 @@ Print a count of the number of pages in the file\&.
8275
.sp -1
8376
.IP \(bu 2.3
8477
.\}
85-
\fB\-d\fR
78+
\fB\-d, --debug\fR
8679
.sp
8780
Debug mode; prints checksums for each page\&.
8881
.RE
@@ -95,7 +88,7 @@ Debug mode; prints checksums for each page\&.
9588
.sp -1
9689
.IP \(bu 2.3
9790
.\}
98-
\fB\-e \fR\fB\fInum\fR\fR
91+
\fB\-e \fR\fB\fInum\fB, --end-page=#\fR\fR
9992
.sp
10093
End at this page number\&.
10194
.RE
@@ -108,7 +101,7 @@ End at this page number\&.
108101
.sp -1
109102
.IP \(bu 2.3
110103
.\}
111-
\fB\-p \fR\fB\fInum\fR\fR
104+
\fB\-p \fR\fB\fInum\fB, --page-num=#\fR\fR
112105
.sp
113106
Check only this page number\&.
114107
.RE
@@ -121,7 +114,7 @@ Check only this page number\&.
121114
.sp -1
122115
.IP \(bu 2.3
123116
.\}
124-
\fB\-s \fR\fB\fInum\fR\fR
117+
\fB\-s \fR\fB\fInum\fB, --start-page\fR\fR
125118
.sp
126119
Start at this page number\&.
127120
.RE
@@ -134,14 +127,27 @@ Start at this page number\&.
134127
.sp -1
135128
.IP \(bu 2.3
136129
.\}
137-
\fB\-v\fR
130+
\fB\-u, --skip-corrupt\fR\fR
131+
.sp
132+
Skip corrupt pages\&.
133+
.RE
134+
.sp
135+
.RS 4
136+
.ie n \{\
137+
\h'-04'\(bu\h'+03'\c
138+
.\}
139+
.el \{\
140+
.sp -1
141+
.IP \(bu 2.3
142+
.\}
143+
\fB\-v, --verbose\fR
138144
.sp
139145
Verbose mode; print a progress indicator every five seconds\&.
140146
.RE
141147
.SH "COPYRIGHT"
142148
.br
143149
.PP
144-
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
150+
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 MariaDB Foundation
145151
.PP
146152
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.
147153
.PP
@@ -150,8 +156,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
150156
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-1301 USA or see http://www.gnu.org/licenses/.
151157
.sp
152158
.SH "SEE ALSO"
153-
For more information, please refer to the MySQL Reference Manual,
154-
which may already be installed locally and which is also available
155-
online at http://dev.mysql.com/doc/.
159+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
156160
.SH AUTHOR
157-
Sun Microsystems, Inc. (http://www.mysql.com/).
161+
MariaDB Foundation (http://www.mariadb.org/).

man/make_win_bin_dist.1

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
'\" t
2-
.\" Title: \fBmake_win_bin_dist\fR
3-
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4-
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5-
.\" Date: 04/06/2010
6-
.\" Manual: MySQL Database System
7-
.\" Source: MySQL 5.1
8-
.\" Language: English
92
.\"
10-
.TH "\FBMAKE_WIN_BIN_DIST" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
3+
.TH "\FBMAKE_WIN_BIN_DIST" "1" "04/08/2015" "MariaDB 10\&.0" "MariaDB Database System"
114
.\" -----------------------------------------------------------------
125
.\" * set default formatting
136
.\" -----------------------------------------------------------------
@@ -169,7 +162,7 @@ directories)\&.
169162
.SH "COPYRIGHT"
170163
.br
171164
.PP
172-
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
165+
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 MariaDB Foundation
173166
.PP
174167
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.
175168
.PP
@@ -178,8 +171,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
178171
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-1301 USA or see http://www.gnu.org/licenses/.
179172
.sp
180173
.SH "SEE ALSO"
181-
For more information, please refer to the MySQL Reference Manual,
182-
which may already be installed locally and which is also available
183-
online at http://dev.mysql.com/doc/.
174+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
184175
.SH AUTHOR
185-
Sun Microsystems, Inc. (http://www.mysql.com/).
176+
MariaDB Foundation (http://www.mariadb.org/).

man/msql2mysql.1

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
'\" t
2-
.\" Title: \fBmsql2mysql\fR
3-
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4-
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5-
.\" Date: 04/06/2010
6-
.\" Manual: MySQL Database System
7-
.\" Source: MySQL 5.1
8-
.\" Language: English
92
.\"
10-
.TH "\FBMSQL2MYSQL\FR" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
3+
.TH "\FBMSQL2MYSQL\FR" "1" "04/08/2015" "MariaDB 10\&.0" "MariaDB Database System"
114
.\" -----------------------------------------------------------------
125
.\" * set default formatting
136
.\" -----------------------------------------------------------------
@@ -60,7 +53,7 @@ utility to make the function name substitutions\&. See
6053
.SH "COPYRIGHT"
6154
.br
6255
.PP
63-
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
56+
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 MariaDB Foundation
6457
.PP
6558
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.
6659
.PP
@@ -69,8 +62,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
6962
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-1301 USA or see http://www.gnu.org/licenses/.
7063
.sp
7164
.SH "SEE ALSO"
72-
For more information, please refer to the MySQL Reference Manual,
73-
which may already be installed locally and which is also available
74-
online at http://dev.mysql.com/doc/.
65+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
7566
.SH AUTHOR
76-
Sun Microsystems, Inc. (http://www.mysql.com/).
67+
MariaDB Foundation (http://www.mariadb.org/).

man/my_print_defaults.1

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
'\" t
2-
.\" Title: \fBmy_print_defaults\fR
3-
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4-
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5-
.\" Date: 04/06/2010
6-
.\" Manual: MySQL Database System
7-
.\" Source: MySQL 5.1
8-
.\" Language: English
92
.\"
10-
.TH "\FBMY_PRINT_DEFAULTS" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
3+
.TH "\FBMY_PRINT_DEFAULTS" "1" "04/08/2015" "MariaDB 10\&.0" "MariaDB Database System"
114
.\" -----------------------------------------------------------------
125
.\" * set default formatting
136
.\" -----------------------------------------------------------------
@@ -87,7 +80,9 @@ Display a help message and exit\&.
8780
\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR,
8881
\fB\-c \fR\fB\fIfile_name\fR\fR
8982
.sp
90-
Read only the given option file\&.
83+
Read only the given option file\&. If no extension is given, default extension(.ini or .cnf) will
84+
be used\&. \fB\-\-config-file\fR is deprecated, use \fB\-\-defaults\-file\fR instead\&. If \fB\-\-defaults\-file\fR is
85+
the first option, then read this file only, do not read global or per\-user config files; should be the first option.
9186
.RE
9287
.sp
9388
.RS 4
@@ -126,7 +121,8 @@ string is
126121
\fB\-\-extra\-file=\fR\fB\fIfile_name\fR\fR,
127122
\fB\-e \fR\fB\fIfile_name\fR\fR
128123
.sp
129-
Read this option file after the global option file but (on Unix) before the user option file\&.
124+
Read this option file after the global option file but (on Unix) before the user option
125+
file\&. Should be the first option\&. \fB\-\-extra\-file\fR is deprecated, use \fB\-\-defaults\-extra\-file\fR\&.
130126
.RE
131127
.sp
132128
.RS 4
@@ -153,12 +149,27 @@ In addition to the groups named on the command line, read groups that have the g
153149
.sp -1
154150
.IP \(bu 2.3
155151
.\}
152+
.\" my_print_defaults: --mysqld option
153+
.\" mysqld option: my_print_defaults
154+
\fB\-\-mysqld\fR
155+
.sp
156+
Read the same set of groups that the mysqld binary does.
157+
.RE
158+
.sp
159+
.RS 4
160+
.ie n \{\
161+
\h'-04'\(bu\h'+03'\c
162+
.\}
163+
.el \{\
164+
.sp -1
165+
.IP \(bu 2.3
166+
.\}
156167
.\" my_print_defaults: no-defaults option
157168
.\" no-defaults option: my_print_defaults
158169
\fB\-\-no\-defaults\fR,
159170
\fB\-n\fR
160171
.sp
161-
Return an empty string\&.
172+
Return an empty string (useful for scripts)\&.
162173
.RE
163174
.sp
164175
.RS 4
@@ -195,7 +206,7 @@ Display version information and exit\&.
195206
.SH "COPYRIGHT"
196207
.br
197208
.PP
198-
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
209+
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 MariaDB Foundation
199210
.PP
200211
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.
201212
.PP
@@ -204,8 +215,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
204215
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-1301 USA or see http://www.gnu.org/licenses/.
205216
.sp
206217
.SH "SEE ALSO"
207-
For more information, please refer to the MySQL Reference Manual,
208-
which may already be installed locally and which is also available
209-
online at http://dev.mysql.com/doc/.
218+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
210219
.SH AUTHOR
211-
Sun Microsystems, Inc. (http://www.mysql.com/).
220+
MariaDB Foundation (http://www.mariadb.org/).

0 commit comments

Comments
 (0)