Skip to content

Commit 18de829

Browse files
iangilfillansvoj
iangilfillan
authored and
svoj
committed
MDEV-11964 Add missing stub manpages
1 parent 07d89fa commit 18de829

8 files changed

+353
-0
lines changed

‎man/mariadb-service-convert.1

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
'\" t
2+
.\"
3+
.TH "\FBMARIADB-SERVICE-CONVERT\FR" "1" "26 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
mariadb-service-convert \- generate a mariadb.service file based on the current mysql/mariadb settings
13+
.SH DESCRIPTION
14+
Use: Generate a mariadb.service file based on the current mysql/mariadb settings\.
15+
This is to assist distro maintainers in migrating to systemd service definations from
16+
a user mysqld_safe settings in the my.cnf files\.
17+
.PP
18+
Redirect output to user directory like /etc/systemd/system/mariadb.service.d/migrated-from-my.cnf-settings.conf
19+
.PP
20+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

‎man/mysqld_safe_helper.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'\" t
2+
.\"
3+
.TH "\FBMYSQLD_SAFE_HELPER\FR" "1" "26 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
mysqld_safe_helper \- helper script
13+
.SH DESCRIPTION
14+
Use: Helper script\.
15+
.PP
16+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

‎man/tokuftdump.1

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
'\" t
2+
.\"
3+
.TH "\FBTOKUFTDUMP\FR" "1" "9 March 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.\" -----------------------------------------------------------------
12+
.\" * MAIN CONTENT STARTS HERE *
13+
.\" -----------------------------------------------------------------
14+
.\" tokuftdump
15+
.\" upgrading MySQL
16+
.SH "NAME"
17+
tokuftdump \- look into the fractal tree file
18+
.SH "SYNOPSIS"
19+
.HP \w'\fBtokuftdump\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
20+
\fBtokuftdump [\fR\fB\fIoptions\fR\fR\fB]\fR
21+
.SH "DESCRIPTION"
22+
.PP
23+
\fBtokuftdump\fR
24+
Investigates and diagnoses the fractal tree\&.
25+
.PP
26+
\fBtokuftdump\fR
27+
supports the following options for processing option files\&.
28+
.sp
29+
.RS 4
30+
.ie n \{\
31+
\h'-04'\(bu\h'+03'\c
32+
.\}
33+
.el \{\
34+
.sp -1
35+
.IP \(bu 2.3
36+
.\}
37+
.\" tokuftdump: interactive option
38+
.\" interactive option: tokuftdump
39+
\fB\-\-interactive\fR
40+
.sp
41+
Interactive\&.
42+
.RE
43+
.sp
44+
.RS 4
45+
.ie n \{\
46+
\h'-04'\(bu\h'+03'\c
47+
.\}
48+
.el \{\
49+
.sp -1
50+
.IP \(bu 2.3
51+
.\}
52+
.\" tokuftdump: support option
53+
.\" support option: tokuftdump
54+
\fB\-\-support \fI/path/to/fractal-tree/file\fR
55+
.sp
56+
An interactive way to see what messages and/or switch between FTs\&.
57+
.RE
58+
.sp
59+
.RS 4
60+
.ie n \{\
61+
\h'-04'\(bu\h'+03'\c
62+
.\}
63+
.el \{\
64+
.sp -1
65+
.IP \(bu 2.3
66+
.\}
67+
.\" tokuftdump: json option
68+
.\" json option: tokuftdump
69+
\fB\-\-json \fI/path/to/fractal-tree/file [output_json_file]\fR
70+
.sp
71+
If the output json file is left empty, FT\&.json will be created automatically\&.
72+
.RE
73+
.sp
74+
.RS 4
75+
.ie n \{\
76+
\h'-04'\(bu\h'+03'\c
77+
.\}
78+
.el \{\
79+
.sp -1
80+
.IP \(bu 2.3
81+
.\}
82+
.\" tokuftdump: nodata option
83+
.\" nodata option: tokuftdump
84+
\fB\-\-nodata\fR
85+
.sp
86+
Nodata\&.
87+
.RE
88+
.sp
89+
.RS 4
90+
.ie n \{\
91+
\h'-04'\(bu\h'+03'\c
92+
.\}
93+
.el \{\
94+
.sp -1
95+
.IP \(bu 2.3
96+
.\}
97+
.\" tokuftdump: dumpdata option
98+
.\" dumpdata option: tokuftdump
99+
\fB\-\-dumpdata = \fR\fB\fI0|1\fR\fR
100+
.sp
101+
Dumpdata\&.
102+
.RE
103+
.sp
104+
.RS 4
105+
.ie n \{\
106+
\h'-04'\(bu\h'+03'\c
107+
.\}
108+
.el \{\
109+
.sp -1
110+
.IP \(bu 2.3
111+
.\}
112+
.\" tokuftdump: header option
113+
.\" header option: tokuftdump
114+
\fB\-\-header\fR
115+
.sp
116+
Header\&.
117+
.RE
118+
.sp
119+
.RS 4
120+
.ie n \{\
121+
\h'-04'\(bu\h'+03'\c
122+
.\}
123+
.el \{\
124+
.sp -1
125+
.IP \(bu 2.3
126+
.\}
127+
.\" tokuftdump: rootnode option
128+
.\" rootnode option: tokuftdump
129+
\fB\-\-rootnode\fR
130+
.sp
131+
Rootnode\&.
132+
.RE
133+
.sp
134+
.RS 4
135+
.ie n \{\
136+
\h'-04'\(bu\h'+03'\c
137+
.\}
138+
.el \{\
139+
.sp -1
140+
.IP \(bu 2.3
141+
.\}
142+
.\" tokuftdump: node option
143+
.\" node option: tokuftdump
144+
\fB\-\-node \fIN\fR
145+
.sp
146+
Node\&.
147+
.RE
148+
.sp
149+
.RS 4
150+
.ie n \{\
151+
\h'-04'\(bu\h'+03'\c
152+
.\}
153+
.el \{\
154+
.sp -1
155+
.IP \(bu 2.3
156+
.\}
157+
.\" tokuftdump: fragmentation option
158+
.\" fragmentation option: tokuftdump
159+
\fB\-\-fragmentation\fR
160+
.sp
161+
Fragmentation\&.
162+
.RE
163+
.sp
164+
.RS 4
165+
.ie n \{\
166+
\h'-04'\(bu\h'+03'\c
167+
.\}
168+
.el \{\
169+
.sp -1
170+
.IP \(bu 2.3
171+
.\}
172+
.\" tokuftdump: garbage option
173+
.\" garbage option: tokuftdump
174+
\fB\-\-garbage\fR
175+
.sp
176+
Garbage\&.
177+
.RE
178+
.sp
179+
.RS 4
180+
.ie n \{\
181+
\h'-04'\(bu\h'+03'\c
182+
.\}
183+
.el \{\
184+
.sp -1
185+
.IP \(bu 2.3
186+
.\}
187+
.\" tokuftdump: tsv option
188+
.\" tsv option: tokuftdump
189+
\fB\-\-tsv\fR
190+
.sp
191+
TSV\&.
192+
.RE
193+
.sp
194+
.RS 4
195+
.ie n \{\
196+
\h'-04'\(bu\h'+03'\c
197+
.\}
198+
.el \{\
199+
.sp -1
200+
.IP \(bu 2.3
201+
.\}
202+
.\" tokuftdump: translation-table option
203+
.\" translation-table option: tokuftdump
204+
\fB\-\-translation\-table\fR
205+
.sp
206+
Translation table\&.
207+
.RE
208+
.sp
209+
.RS 4
210+
.ie n \{\
211+
\h'-04'\(bu\h'+03'\c
212+
.\}
213+
.el \{\
214+
.sp -1
215+
.IP \(bu 2.3
216+
.\}
217+
.\" tokuftdump: summary option
218+
.\" summary option: tokuftdump
219+
\fB\-\-summary\fR
220+
.sp
221+
Provide summary info\&.
222+
.RE
223+
.SH "COPYRIGHT"
224+
.br
225+
.PP
226+
Copyright 2016 MariaDB Foundation
227+
.PP
228+
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.
229+
.PP
230+
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.
231+
.PP
232+
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/.
233+
.sp
234+
.SH "SEE ALSO"
235+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
236+
.SH AUTHOR
237+
MariaDB Foundation (http://www.mariadb.org/).

‎man/wsrep_sst_common.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'\" t
2+
.\"
3+
.TH "\FBWSREP_SST_COMMON\FR" "1" "26 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
wsrep_sst_common \- common command line parser to be sourced by other SST scripts
13+
.SH DESCRIPTION
14+
Use: Common command line parser to be sourced by other SST scripts\.
15+
.PP
16+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

‎man/wsrep_sst_mysqldump.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'\" t
2+
.\"
3+
.TH "\FBWSREP_SST_MYSQLDUMP\FR" "1" "26 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
wsrep_sst_mysqldump \- mysqldump\-based state snapshot transfer
13+
.SH DESCRIPTION
14+
Use: mysqldump-based state snapshot transfer\.
15+
.PP
16+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

‎man/wsrep_sst_rsync.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'\" t
2+
.\"
3+
.TH "\FBWSREP_SST_RSYNC\FR" "1" "26 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
wsrep_sst_mysqldump \- rsync-based state snapshot transfer
13+
.SH DESCRIPTION
14+
Use: rsync-based state snapshot transfer\.
15+
.PP
16+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

‎man/wsrep_sst_xtrabackup-v2.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'\" t
2+
.\"
3+
.TH "\FBWSREP_SST_XTRABACKUP-V2\FR" "1" "26 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
wsrep_sst_xtrabackup-v2 \- xtrabackup\-based state snapshot transfer
13+
.SH DESCRIPTION
14+
Use: xtrabackup-based state snapshot transfer\.
15+
.PP
16+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

‎man/wsrep_sst_xtrabackup.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
'\" t
2+
.\"
3+
.TH "\FBWSREP_SST_XTRABACKUP\FR" "1" "24 January 2017" "MariaDB 10\&.1" "MariaDB Database System"
4+
.\" -----------------------------------------------------------------
5+
.\" * set default formatting
6+
.\" -----------------------------------------------------------------
7+
.\" disable hyphenation
8+
.nh
9+
.\" disable justification (adjust text to left margin only)
10+
.ad l
11+
.SH NAME
12+
wsrep_sst_xtrabackup \- xtrabackup\-based state snapshot transfer
13+
.SH DESCRIPTION
14+
Use: xtrabackup-based state snapshot transfer\.
15+
.PP
16+
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

0 commit comments

Comments
 (0)