COMP\_ERR(1) MySQL Database System COMP\_ERR(1)

# [NAME](#NAME)

comp\_err - compile MySQL error message file

# [SYNOPSIS](#SYNOPSIS)

**comp\_err \[options]**

# [DESCRIPTION](#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**, **-?** Display a help message and exit.

•**--charset=dir\_name**, **-C dir\_name** The character set directory. The default is ../sql/share/charsets.

•**--debug=debug\_options**, **-# debug\_options** 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** Print some debugging information when the program exits.

•**--errmsg-file=file\_name**, **-H file\_name** 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** The name of the error header file. The default is mysqld\_error.h.

•**--in-file=file\_name**, **-F file\_name** 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** 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** 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** The name of the error name file. The default is mysqld\_ername.h.

•**--out-dir=dir\_name**, **-D dir\_name** The name of the output base directory. The default is ../sql/share/.

•**--out-file=file\_name**, **-O file\_name** The name of the output file. The default is errmsg.sys.

•**--version**, **-V** Display version information and exit.

# [COPYRIGHT](#COPYRIGHT)

Copyright © 1997, 2023, 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 02110-1301 USA or see http://www.gnu.org/licenses/.

# [SEE ALSO](#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](#AUTHOR)

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

08/31/2023 MySQL 8.0

---

Document: comp_err(1) from percona-xtrabackup-8.0 8.0.35.36-r5 (Chainguard OS)
Source: https://github.com/percona/percona-xtrabackup