[thirdparty/man-pages.git] / man8 / iconvconfig.8

.\" Copyright (C) 2014 Marko Myllynen <myllynen@redhat.com>
.\"
.\" SPDX-License-Identifier: GPL-2.0-or-later
.\"
.TH ICONVCONFIG 8 2021-08-27 "Linux man-pages (unreleased)"
.SH NAME
iconvconfig \- create iconv module configuration cache
.SH SYNOPSIS
.B iconvconfig
.RI [ options ]
.RI [ directory ]...
.SH DESCRIPTION
The
.BR iconv (3)
function internally uses
.I gconv
modules to convert to and from a character set.
A configuration file is used to determine the needed modules
for a conversion.
Loading and parsing such a configuration file would slow down
programs that use
.BR iconv (3),
so a caching mechanism is employed.
.PP
The
.B iconvconfig
program reads iconv module configuration files and writes
a fast-loading gconv module configuration cache file.
.PP
In addition to the system provided gconv modules, the user can specify
custom gconv module directories with the environment variable
.BR GCONV_PATH .
However, iconv module configuration caching is used only when
the environment variable
.B GCONV_PATH
is not set.
.SH OPTIONS
.TP
.B "\-\-nostdlib"
Do not search the system default gconv directory,
only the directories provided on the command line.
.TP
.BI \-o " outputfile" ", \-\-output=" outputfile
Use
.I outputfile
for output instead of the system default cache location.
.TP
.BI \-\-prefix= pathname
Set the prefix to be prepended to the system pathnames.
See FILES, below.
By default, the prefix is empty.
Setting the prefix to
.IR foo ,
the gconv module configuration would be read from
.I foo/usr/lib/gconv/gconv\-modules
and the cache would be written to
.IR foo/usr/lib/gconv/gconv\-modules.cache .
.TP
.BR \-? ", " \-\-help
Print a usage summary and exit.
.TP
.B "\-\-usage"
Print a short usage summary and exit.
.TP
.BR \-V ", " \-\-version
Print the version number, license, and disclaimer of warranty for
.BR iconv .
.SH EXIT STATUS
Zero on success, nonzero on errors.
.SH FILES
.TP
.I /usr/lib/gconv
Usual default gconv module path.
.TP
.I /usr/lib/gconv/gconv\-modules
Usual system default gconv module configuration file.
.TP
.I /usr/lib/gconv/gconv\-modules.cache
Usual system gconv module configuration cache.
.PP
Depending on the architecture,
the above files may instead be located at directories with the path prefix
.IR /usr/lib64 .
.SH SEE ALSO
.BR iconv (1),
.BR iconv (3)
Commit	Line	Data
63f2595f MM	1	.\" Copyright (C) 2014 Marko Myllynen <myllynen@redhat.com>
63f2595f MM	2	.\"
e4a74ca8	3	.\" SPDX-License-Identifier: GPL-2.0-or-later
63f2595f	4	.\"
45186a5d	5	.TH ICONVCONFIG 8 2021-08-27 "Linux man-pages (unreleased)"
63f2595f MM	6	.SH NAME
	7	iconvconfig \- create iconv module configuration cache
	8	.SH SYNOPSIS
	9	.B iconvconfig
	10	.RI [ options ]
	11	.RI [ directory ]...
	12	.SH DESCRIPTION
	13	The
b757a2ea	14	.BR iconv (3)
63f2595f MM	15	function internally uses
	16	.I gconv
	17	modules to convert to and from a character set.
	18	A configuration file is used to determine the needed modules
	19	for a conversion.
	20	Loading and parsing such a configuration file would slow down
b757a2ea MK	21	programs that use
	22	.BR iconv (3),
	23	so a caching mechanism is employed.
2a86152e	24	.PP
63f2595f MM	25	The
	26	.B iconvconfig
	27	program reads iconv module configuration files and writes
b757a2ea	28	a fast-loading gconv module configuration cache file.
2a86152e	29	.PP
91085d85	30	In addition to the system provided gconv modules, the user can specify
63f2595f MM	31	custom gconv module directories with the environment variable
63f2595f MM	32	.BR GCONV_PATH .
a7d99f7f	33	However, iconv module configuration caching is used only when
63f2595f	34	the environment variable
1ae6b2c7	35	.B GCONV_PATH
63f2595f MM	36	is not set.
	37	.SH OPTIONS
	38	.TP
	39	.B "\-\-nostdlib"
	40	Do not search the system default gconv directory,
	41	only the directories provided on the command line.
	42	.TP
	43	.BI \-o " outputfile" ", \-\-output=" outputfile
	44	Use
	45	.I outputfile
	46	for output instead of the system default cache location.
	47	.TP
	48	.BI \-\-prefix= pathname
	49	Set the prefix to be prepended to the system pathnames.
	50	See FILES, below.
	51	By default, the prefix is empty.
	52	Setting the prefix to
	53	.IR foo ,
	54	the gconv module configuration would be read from
1ae6b2c7	55	.I foo/usr/lib/gconv/gconv\-modules
63f2595f	56	and the cache would be written to
b49c2acb	57	.IR foo/usr/lib/gconv/gconv\-modules.cache .
63f2595f	58	.TP
fb787570	59	.BR \-? ", " \-\-help
63f2595f MM	60	Print a usage summary and exit.
	61	.TP
	62	.B "\-\-usage"
	63	Print a short usage summary and exit.
	64	.TP
fb787570	65	.BR \-V ", " \-\-version
63f2595f MM	66	Print the version number, license, and disclaimer of warranty for
	67	.BR iconv .
	68	.SH EXIT STATUS
777411ae	69	Zero on success, nonzero on errors.
63f2595f MM	70	.SH FILES
	71	.TP
	72	.I /usr/lib/gconv
	73	Usual default gconv module path.
	74	.TP
b49c2acb	75	.I /usr/lib/gconv/gconv\-modules
538ca136	76	Usual system default gconv module configuration file.
63f2595f	77	.TP
b49c2acb	78	.I /usr/lib/gconv/gconv\-modules.cache
538ca136	79	Usual system gconv module configuration cache.
111ccf7e MK	80	.PP
	81	Depending on the architecture,
	82	the above files may instead be located at directories with the path prefix
	83	.IR /usr/lib64 .
d282bb24	84	.SH SEE ALSO
63f2595f MM	85	.BR iconv (1),
63f2595f MM	86	.BR iconv (3)