Skip to content

Commit 8032d6d

Browse files
author
[email protected]
committed
What started as an attempt to fix BUG#2270 (Substitute paths in mysql
manpage) turned out as a major overhaul of all man pages: - renamed all *.1 files to *.1.in to act as templates which are being processed at build time - replaced some hard-coded values with place holder that are being replaced with the proper values at build time - Updated list of available man pages in the SEE ALSO section and added a hint to the manual for more details - Added a BUGS section to all pages, referring to the bugs DB - Updated some obsolete URLs and mail addresses The actual content of these man pages should probably be cross-checked for correctness, though...
1 parent 56e8554 commit 8032d6d

16 files changed

Lines changed: 378 additions & 265 deletions

‎man/Makefile.am‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,26 @@ man_MANS = mysql.1 isamchk.1 isamlog.1 mysql_zap.1 mysqlaccess.1 \
2121
mysqladmin.1 mysqld.1 mysqld_multi.1 mysqldump.1 mysqlshow.1 \
2222
perror.1 replace.1 mysqld_safe.1 mysql_fix_privilege_tables.1
2323

24-
EXTRA_DIST = $(man_MANS)
24+
EXTRA_DIST = mysql.1.in isamchk.1.in isamlog.1.in mysql_zap.1.in \
25+
mysqlaccess.1.in mysqladmin.1.in mysqld.1.in mysqld_multi.1.in \
26+
mysqldump.1.in mysqlshow.1.in perror.1.in replace.1.in \
27+
mysqld_safe.1.in mysql_fix_privilege_tables.1.in
28+
29+
CLEANFILES = $(man_MANS)
30+
31+
SUFFIXES = .in
32+
33+
.in:
34+
@RM@ -f $@ $@-t
35+
@SED@ \
36+
-e 's!@''MYSQL_BASE_VERSION''@!@MYSQL_BASE_VERSION@!' \
37+
-e 's!@''sysconfdir''@!@sysconfdir@!' \
38+
-e 's!@''bindir''@!$(bindir)!g' \
39+
-e 's!@''libexecdir''@!$(libexecdir)!g' \
40+
-e 's!@''localstatedir''@!$(localstatedir)!g' \
41+
-e 's!@''MYSQL_NO_DASH_VERSION''@!@MYSQL_NO_DASH_VERSION@!' \
42+
$< > $@-t
43+
@MV@ $@-t $@
2544

2645
# Don't update the files from bitkeeper
2746
%::SCCS/s.%

man/isamchk.1 renamed to man/isamchk.1.in

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH isamchk 1 "19 December 2000" "MySQL 4.0" "MySQL database"
1+
.TH isamchk 1 "19 December 2000" "MySQL @MYSQL_BASE_VERSION@" "MySQL database"
22
.SH NAME
33
.BR isamchk
44
\- Description, check and repair of ISAM tables.
@@ -114,24 +114,29 @@ Print version and exit.
114114
.BR \-w | \-\-wait
115115
Wait if table is locked.
116116
.SH "SEE ALSO"
117-
isamchk (1),
118-
isamlog (1),
119-
mysqlaccess (1),
120-
mysqladmin (1),
121-
mysqlbug (1),
122-
mysqld (1),
123-
mysqldump (1),
124-
mysqlshow (1),
125-
msql2mysql (1),
126-
perror (1),
127-
replace (1),
128-
mysqld_safe (1),
129-
which1 (1),
130-
zap (1),
117+
isamlog(1),
118+
mysql(1),
119+
mysqlaccess(1),
120+
mysqladmin(1),
121+
mysqld(1),
122+
mysqld_multi(1),
123+
mysqld_safe(1),
124+
mysqldump(1),
125+
mysql_fix_privilege_tables(1),
126+
mysqlshow(1),
127+
mysql_zap(1),
128+
perror(1),
129+
replace(1)
130+
.P
131+
For more information please refer to the MySQL reference
132+
manual, which may already be installed locally and which
133+
is also available online at http://www.mysql.com/doc/en/
134+
.SH BUGS
135+
Please refer to http://bugs.mysql.com/ to report bugs.
131136
.SH AUTHOR
132-
Ver 1.0, distribution 3.23.29a
133-
Michael (Monty) Widenius (monty@tcx.se),
134-
TCX Datakonsult AB (http://www.tcx.se).
137+
Ver 1.0, distribution @MYSQL_NO_DASH_VERSION@
138+
Michael (Monty) Widenius (monty@mysql.com),
139+
MySQL AB (http://www.mysql.com/).
135140
This software comes with no warranty.
136141
Manual page by L. (Kill-9) Pedersen
137142
(kill-9@kill\-9.dk), Mercurmedia Data Model Architect /

man/isamlog.1 renamed to man/isamlog.1.in

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH isamlog 1 "19 December 2000" "MySQL 4.0" "MySQL database"
1+
.TH isamlog 1 "19 December 2000" "MySQL @MYSQL_BASE_VERSION@" "MySQL database"
22
.SH NAME
33
isamlog - Write info about whats in a nisam log file.
44
.SH USAGE
@@ -71,27 +71,31 @@ If one gives table names as arguments only these tables will be updated
7171

7272

7373
.SH "SEE ALSO"
74-
75-
isamchk (1),
76-
isamlog (1),
77-
mysqlaccess (1),
78-
mysqladmin (1),
79-
mysqlbug (1),
80-
mysqld (1),
81-
mysqldump (1),
82-
mysqlshow (1),
83-
msql2mysql (1),
84-
perror (1),
85-
replace (1),
86-
mysqld_safe (1),
87-
which1 (1),
88-
zap (1),
74+
isamchk(1),
75+
mysql(1),
76+
mysqlaccess(1),
77+
mysqladmin(1),
78+
mysqld(1),
79+
mysqld_multi(1),
80+
mysqld_safe(1),
81+
mysqldump(1),
82+
mysql_fix_privilege_tables(1),
83+
mysqlshow(1),
84+
mysql_zap(1),
85+
perror(1),
86+
replace(1)
87+
.P
88+
For more information please refer to the MySQL reference
89+
manual, which may already be installed locally and which
90+
is also available online at http://www.mysql.com/doc/en/
91+
.SH BUGS
92+
Please refer to http://bugs.mysql.com/ to report bugs.
8993

9094
.SH AUTHOR
9195

92-
Ver 1.0, distribution 3.23.29a
93-
Michael (Monty) Widenius (monty@tcx.se),
94-
TCX Datakonsult AB (http://www.tcx.se).
96+
Ver 1.0, distribution @MYSQL_NO_DASH_VERSION@
97+
Michael (Monty) Widenius (monty@mysql.com),
98+
MySQL AB (http://www.mysql.com/).
9599
This software comes with no warranty.
96100
Manual page by L. (Kill-9) Pedersen
97101
([email protected]), Mercurmedia Data Model Architect /

man/mysql.1 renamed to man/mysql.1.in

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
.TH mysql 1 "19 December 2000" "MySQL 4.0" "MySQL database"
1+
.TH mysql 1 "19 December 2000" "MySQL @MYSQL_BASE_VERSION@" "MySQL database"
22
.SH NAME
33
mysql \- text-based client for mysqld, a SQL-based relational database daemon
4+
.SH USAGE
5+
mysql [OPTIONS] [Database]
46
.SH SYNOPSIS
57
.B mysql
68
.RB [ \-B | \-\-batch ]
@@ -105,16 +107,19 @@ version number and exit.
105107
Wait and retry if the database server connection is down.
106108
.SH FILES
107109
.TP 2.2i
108-
.I /depot/bin/mysql
109-
executable
110+
.I @sysconfdir@/my.cnf
111+
MySQL configuration file
110112
.TP
111-
.I /depot/bin/mysqld
112-
executable
113+
.I @bindir@/mysql
114+
Client executable
113115
.TP
114-
.I /depot/bin/mysqld_safe
116+
.I @libexecdir@/mysqld
117+
Server executable
118+
.TP
119+
.I @bindir@/mysqld_safe
115120
executable shell script for starting mysqld safely
116121
.TP
117-
.I /site/var/mysql/data
122+
.I @localstatedir@
118123
location of database files
119124
.SH EXAMPLE
120125
You can also read a backup dump file back into MySQL with:
@@ -124,24 +129,29 @@ You can also read a backup dump file back into MySQL with:
124129
.BR <
125130
backup-file.sql
126131
.SH "SEE ALSO"
127-
isamchk (1),
128-
isamlog (1),
129-
mysqlaccess (1),
130-
mysqladmin (1),
131-
mysqlbug (1),
132-
mysqld (1),
133-
mysqldump (1),
134-
mysqlshow (1),
135-
msql2mysql (1),
136-
perror (1),
137-
replace (1),
138-
mysqld_safe (1),
139-
which1 (1),
140-
zap (1),
132+
isamchk(1),
133+
isamlog(1),
134+
mysqlaccess(1),
135+
mysqladmin(1),
136+
mysqld(1),
137+
mysqld_multi(1),
138+
mysqld_safe(1),
139+
mysqldump(1),
140+
mysql_fix_privilege_tables(1),
141+
mysqlshow(1),
142+
mysql_zap(1),
143+
perror(1),
144+
replace(1)
145+
.P
146+
For more information please refer to the MySQL reference
147+
manual, which may already be installed locally and which
148+
is also available online at http://www.mysql.com/doc/en/
149+
.SH BUGS
150+
Please refer to http://bugs.mysql.com/ to report bugs.
141151
.SH AUTHOR
142-
Ver 6.3, distribution 3.20.20
143-
Michael (Monty) Widenius (monty@tcx.se),
144-
TCX Datakonsult AB (http://www.tcx.se).
152+
Ver 6.3, distribution @MYSQL_NO_DASH_VERSION@
153+
Michael (Monty) Widenius (monty@mysql.com),
154+
MySQL AB (http://www.mysql.com/)
145155
This software comes with no warranty.
146156
Manual page by R. P. C. Rodgers,
147157
Lister Hill National Center for Biomedical Communication,

man/mysql_fix_privilege_tables.1 renamed to man/mysql_fix_privilege_tables.1.in

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH mysql 1 "17 March 2003" "MySQL 4.0" "MySQL database"
1+
.TH mysql 1 "17 March 2003" "MySQL @MYSQL_BASE_VERSION@" "MySQL database"
22
.SH NAME
33
mysql_fix_privilege_tables \- Fixes MySQL privilege tables.
44
.SH SYNOPSIS
@@ -14,7 +14,25 @@ If you get 'Access denied' errors, run the script again
1414
and give the MySQL root user password as an argument.
1515

1616
.SH "SEE ALSO"
17-
mysql (1), mysqld (1)
17+
isamchk(1),
18+
isamlog(1),
19+
mysql(1),
20+
mysqlaccess(1),
21+
mysqladmin(1),
22+
mysqld(1),
23+
mysqld_multi(1),
24+
mysqld_safe(1),
25+
mysqldump(1),
26+
mysqlshow(1),
27+
mysql_zap(1),
28+
perror(1),
29+
replace(1)
30+
.P
31+
For more information please refer to the MySQL reference
32+
manual, which may already be installed locally and which
33+
is also available online at http://www.mysql.com/doc/en/
34+
.SH BUGS
35+
Please refer to http://bugs.mysql.com/ to report bugs.
1836
.SH AUTHOR
1937
This manpage was written by Christian Hammers <[email protected]>.
2038

‎man/mysql_zap.1‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎man/mysql_zap.1.in‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.TH zap 1 "19 December 2000" "MySQL @MYSQL_BASE_VERSION@" "MySQL database"
2+
.SH NAME
3+
zap - a perl script used to kill processes
4+
.SH USAGE
5+
/usr/bin/mysql_zap [-signal] [-?Ift] pattern
6+
.SH SYNOPSIS
7+
.B zap
8+
.RB [ \-I | \-? ]
9+
.RB [ \-f ]
10+
.RB [ \-t ]
11+
.SH DESCRIPTION
12+
.TP
13+
.BR zap
14+
supports by executing
15+
.TP
16+
.BR \-I | \-?
17+
info
18+
.TP
19+
.BR \-f
20+
force
21+
.TP
22+
.BR \-t
23+
test
24+
.SH NOTE
25+
If
26+
.BR -f
27+
isn't given, ask user for confirmation for each process to kill. If signal isn't given, try first with signal 15 and after that with signal 9. If
28+
.BR -t
29+
is given the processes is only shown on stdout.
30+
.SH "SEE ALSO"
31+
isamchk(1),
32+
isamlog(1),
33+
mysql(1),
34+
mysqlaccess(1),
35+
mysqladmin(1),
36+
mysqld(1),
37+
mysqld_multi(1),
38+
mysqld_safe(1),
39+
mysqldump(1),
40+
mysql_fix_privilege_tables(1),
41+
mysqlshow(1),
42+
perror(1),
43+
replace(1)
44+
.P
45+
For more information please refer to the MySQL reference
46+
manual, which may already be installed locally and which
47+
is also available online at http://www.mysql.com/doc/en/
48+
.SH BUGS
49+
Please refer to http://bugs.mysql.com/ to report bugs.
50+
.SH AUTHOR
51+
Ver 1.0, distribution @MYSQL_NO_DASH_VERSION@ Michael (Monty) Widenius ([email protected]), MySQL AB (http://www.mysql.com/). This software comes with no warranty. Manual page by L. (Kill-9) Pedersen ([email protected]), Mercurmedia Data Model Architect / system developer (http://www.mercurmedia.com)
52+
.\" end of man page

man/mysqlaccess.1 renamed to man/mysqlaccess.1.in

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH mysqlaccess 1 "19 December 2000" "MySQL 4.0" "MySQL database"
1+
.TH mysqlaccess 1 "19 December 2000" "MySQL @MYSQL_BASE_VERSION@" "MySQL database"
22
.SH NAME
33
.BR mysqlaccess
44
\- Create new users to mysql.
@@ -95,24 +95,29 @@ If no host is given, `localhost' is assumed
9595
Wildcards (*,?,%,_) are allowed for host, user and db, but be sure
9696
to escape them from your shell!! (i.e., type \\* or '*')
9797
.SH "SEE ALSO"
98-
isamchk (1),
99-
isamlog (1),
100-
mysqlaccess (1),
101-
mysqladmin (1),
102-
mysqlbug (1),
103-
mysqld (1),
104-
mysqldump (1),
105-
mysqlshow (1),
106-
msql2mysql (1),
107-
perror (1),
108-
replace (1),
109-
mysqld_safe (1),
110-
which1 (1),
111-
zap (1),
98+
isamchk(1),
99+
isamlog(1),
100+
mysql(1),
101+
mysqladmin(1),
102+
mysqld(1),
103+
mysqld_multi(1),
104+
mysqld_safe(1),
105+
mysqldump(1),
106+
mysql_fix_privilege_tables(1),
107+
mysqlshow(1),
108+
mysql_zap(1),
109+
perror(1),
110+
replace(1)
111+
.P
112+
For more information please refer to the MySQL reference
113+
manual, which may already be installed locally and which
114+
is also available online at http://www.mysql.com/doc/en/
115+
.SH BUGS
116+
Please refer to http://bugs.mysql.com/ to report bugs.
112117
.SH AUTHOR
113-
Ver 1.0, distribution 3.23.29a
114-
Michael (Monty) Widenius (monty@tcx.se),
115-
TCX Datakonsult AB (http://www.tcx.se).
118+
Ver 1.0, distribution @MYSQL_NO_DASH_VERSION@
119+
Michael (Monty) Widenius (monty@mysql.com),
120+
MySQL AB (http://www.mysql.com/).
116121
This software comes with no warranty.
117122
Manual page by L. (Kill-9) Pedersen
118123
(kill-9@kill\-9.dk), Mercurmedia Data Model Architect /

0 commit comments

Comments
 (0)