www.LinuxHowtos.org





COMP_ERR

Section: MySQL Database System (1)
Updated: 12/11/2025
Index Return to Main Contents
 

NAME

comp_err - compile MySQL error message file  

SYNOPSIS

comp_err [options]
 

DESCRIPTION

comp_err

creates the errmsg.sys file that is used by mysqld to determine the error messages to display for different error codes. comp_err normally is run automatically when MySQL is built. It compiles the errmsg.sys file from text-format error information in MySQL source distributions:

* As of MySQL 8.0.19, the error information comes from the messages_to_error_log.txt and messages_to_clients.txt files in the share directory.

For more information about defining error messages, see the comments within those files, along with the errmsg_readme.txt file.

* Prior to MySQL 8.0.19, the error information comes from the errmsg-utf8.txt file in the sql/share directory.

comp_err also generates the mysqld_error.h, mysqld_ername.h, and mysqld_errmsg.h header files.

Invoke comp_err like this:

comp_err [options]

comp_err supports the following options.

* --help, -?
Comman-Line Format -help
Type Boolean
Default Value false

Display a help message and exit.

* --charset=dir_name, -C dir_name
Comman-Line Format -charset
Type String
Default Value

The character set directory. The default is ../sql/share/charsets.

* --debug=debug_options, -# debug_options
Comman-Line Format -debug=options
Type String
Default Value d:t:O,/tmp/comp_err.trace

Write a debugging log. A typical debug_options string is d:t:O,file_name. The default is d:t:O,/tmp/comp_err.trace.

* --debug-info, -T
Comman-Line Format -debu-info
Type Boolean
Default Value false

Print some debugging information when the program exits.

* --errmsg-file=file_name, -H file_name
Comman-Line Format -errms-file=name
Type File name
Default Value mysqld_errmsg.h

The name of the error message file. The default is mysqld_errmsg.h. This option was added in MySQL 8.0.18.

* --header-file=file_name, -H file_name
Comman-Line Format -heade-file=name
Type File name
Default Value mysqld_error.h

The name of the error header file. The default is mysqld_error.h.

* --in-file=file_name, -F file_name
Comman-Line Format -i-file=path
Type File name
Default Value [none]

The name of the input file. The default is ../share/errmsg-utf8.txt.

This option was removed in MySQL 8.0.19 and replaced by the --in-file-errlog and --in-file-toclient options.

* --in-file-errlog=file_name, -e file_name
Comman-Line Format -i-fil-errlog
Type File name
Default Value

The name of the input file that defines error messages intended to be written to the error log. The default is ../share/messages_to_error_log.txt.

This option was added in MySQL 8.0.19.

* --in-file-toclient=file_name, -c file_name
Comman-Line Format -i-fil-toclient=path
Type File name
Default Value

The name of the input file that defines error messages intended to be written to clients. The default is ../share/messages_to_clients.txt.

This option was added in MySQL 8.0.19.

* --name-file=file_name, -N file_name
Comman-Line Format -nam-file=name
Type File name
Default Value mysqld_ername.h

The name of the error name file. The default is mysqld_ername.h.

* --out-dir=dir_name, -D dir_name
Comman-Line Format -ou-dir=path
Type String
Default Value

The name of the output base directory. The default is ../sql/share/.

* --out-file=file_name, -O file_name
Comman-Line Format -ou-file=name
Type File name
Default Value errmsg.sys

The name of the output file. The default is errmsg.sys.

* --version, -V
Comman-Line Format -version
Type Boolean
Default Value false

Display version information and exit.

 

COPYRIGHT


Copyright © 1997, 2025, Oracle and/or its affiliates.

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.

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.

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 0211-1301 USA or see http://www.gnu.org/licenses/.

 

SEE ALSO

For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/.  

AUTHOR

Oracle Corporation (http://dev.mysql.com/).


 

Index

NAME
SYNOPSIS
DESCRIPTION
COPYRIGHT
SEE ALSO
AUTHOR