.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "m17nDebug" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
m17nDebug_\-_Debug \-  \- Support for m17n library users to debug their programs\&.  

.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBMFace\fP * \fBmdebug_dump_face\fP (\fBMFace\fP *face, int indent)"
.br
.RI "Dump a face\&. "
.ti -1c
.RI "\fBMInputMethod\fP * \fBmdebug_dump_im\fP (\fBMInputMethod\fP *im, int indent)"
.br
.RI "Dump an input method\&. "
.ti -1c
.RI "int \fBmdebug_hook\fP ()"
.br
.RI "Hook function called on an error\&. "
.ti -1c
.RI "\fBMText\fP * \fBmdebug_dump_mtext\fP (\fBMText\fP *mt, int indent, int fullp)"
.br
.RI "Dump an M-text\&. "
.ti -1c
.RI "MSymbol \fBmdebug_dump_symbol\fP (MSymbol symbol, int indent)"
.br
.RI "Dump a symbol\&. "
.ti -1c
.RI "MSymbol \fBmdebug_dump_all_symbols\fP (int indent)"
.br
.RI "Dump all symbol names\&. "
.in -1c
.SH "Detailed Description"
.PP 
Support for m17n library users to debug their programs\&. 

The m17n library provides the following facilities to support the library users to debug their programs\&.
.PP
.PD 0
.IP "\(bu" 2
Environment variables to control printing of various information to stderr\&.
.PP
.PD 0
.IP "  \(bu" 4
MDEBUG_INIT \-\- If set to 1, print information about the library initialization on the call of \fBM17N_INIT()\fP\&.
.PP

.IP "  \(bu" 4
MDEBUG_FINI \-\- If set to 1, print counts of objects that are not yet freed on the call of \fBM17N_FINI()\fP\&.
.PP

.IP "  \(bu" 4
MDEBUG_CHARSET \-\- If set to 1, print information about charsets being loaded from the m17n database\&.
.PP

.IP "  \(bu" 4
MDEBUG_CODING \-\- If set to 1, print information about coding systems being loaded from the m17n database\&.
.PP

.IP "  \(bu" 4
MDEBUG_DATABASE \-\- If set to 1, print information about data being loaded from the m17n database\&.
.PP

.IP "  \(bu" 4
MDEBUG_FONT \-\- If set to 1, print information about fonts being selected and opened\&.
.PP

.IP "  \(bu" 4
MDEBUG_FLT \-\- If set to 1, 2, or 3, print information about which command of Font Layout Table are being executed\&. The bigger number prints the more detailed information\&.
.PP

.IP "  \(bu" 4
MDEBUG_INPUT \-\- If set to 1, print information about how an input method is running\&.
.PP

.IP "  \(bu" 4
MDEBUG_ALL \-\- Setting this variable to 1 is equivalent to setting all the above variables to 1\&.
.PP

.IP "  \(bu" 4
MDEBUG_OUTPUT_FILE \-\- If set to a file name, the above debugging information is appended to the file\&. If set to 'stdout', the information is printed to stdout\&.
.PP

.PP
.PP

.IP "\(bu" 2
Functions to print various objects in a human readable way\&. See the documentation of mdebug_dump_XXXX() functions\&.
.PP

.IP "\(bu" 2
The hook function called on an error\&. See the documentation of \fBmdebug_hook()\fP\&.
.PP

.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for The m17n Library from the source code\&.
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.