| 1 |
.\" Copyright, the authors of the Linux man-pages project |
| 2 |
.\" |
| 3 |
.\" SPDX-License-Identifier: GPL-2.0-or-later |
| 4 |
.\" |
| 5 |
.TH iconvconfig 8 2025-05-17 "Linux man-pages 6.18" |
| 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 |
| 14 |
.BR iconv (3) |
| 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 |
| 21 |
programs that use |
| 22 |
.BR iconv (3), |
| 23 |
so a caching mechanism is employed. |
| 24 |
.P |
| 25 |
The |
| 26 |
.B iconvconfig |
| 27 |
program reads iconv module configuration files and writes |
| 28 |
a fast-loading gconv module configuration cache file. |
| 29 |
.P |
| 30 |
In addition to the system provided gconv modules, the user can specify |
| 31 |
custom gconv module directories with the environment variable |
| 32 |
.BR GCONV_PATH . |
| 33 |
However, iconv module configuration caching is used only when |
| 34 |
the environment variable |
| 35 |
.B GCONV_PATH |
| 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 \-\-output= outputfile |
| 44 |
.TQ |
| 45 |
.BI \-o\~ outputfile |
| 46 |
Use |
| 47 |
.I outputfile |
| 48 |
for output instead of the system default cache location. |
| 49 |
.TP |
| 50 |
.BI \-\-prefix= pathname |
| 51 |
Set the prefix to be prepended to the system pathnames. |
| 52 |
See FILES, below. |
| 53 |
By default, the prefix is empty. |
| 54 |
Setting the prefix to |
| 55 |
.IR foo , |
| 56 |
the gconv module configuration would be read from |
| 57 |
.I foo/usr/lib/gconv/gconv\-modules |
| 58 |
and the cache would be written to |
| 59 |
.IR foo/usr/lib/gconv/gconv\-modules.cache . |
| 60 |
.TP |
| 61 |
.B \-\-help |
| 62 |
.TQ |
| 63 |
.B \-? |
| 64 |
Print a usage summary and exit. |
| 65 |
.TP |
| 66 |
.B \-\-usage |
| 67 |
Print a short usage summary and exit. |
| 68 |
.TP |
| 69 |
.B \-\-version |
| 70 |
.TQ |
| 71 |
.B \-V |
| 72 |
Print the version number, license, and disclaimer of warranty for |
| 73 |
.BR iconv . |
| 74 |
.SH EXIT STATUS |
| 75 |
Zero on success, nonzero on errors. |
| 76 |
.SH FILES |
| 77 |
.TP |
| 78 |
.I /usr/lib/gconv |
| 79 |
Usual default gconv module path. |
| 80 |
.TP |
| 81 |
.I /usr/lib/gconv/gconv\-modules |
| 82 |
Usual system default gconv module configuration file. |
| 83 |
.TP |
| 84 |
.I /usr/lib/gconv/gconv\-modules.cache |
| 85 |
Usual system gconv module configuration cache. |
| 86 |
.P |
| 87 |
Depending on the architecture, |
| 88 |
the above files may instead be located at directories with the path prefix |
| 89 |
.IR /usr/lib64 . |
| 90 |
.SH SEE ALSO |
| 91 |
.BR iconv (1), |
| 92 |
.BR iconv (3) |