]>
Commit | Line | Data |
---|---|---|
63f2595f MM |
1 | '\" t -*- coding: UTF-8 -*- |
2 | .\" | |
3 | .\" Copyright (C) 2014 Marko Myllynen <myllynen@redhat.com> | |
4 | .\" | |
5 | .\" %%%LICENSE_START(GPLv2+_DOC_FULL) | |
6 | .\" This is free documentation; you can redistribute it and/or | |
7 | .\" modify it under the terms of the GNU General Public License as | |
8 | .\" published by the Free Software Foundation; either version 2 of | |
9 | .\" the License, or (at your option) any later version. | |
10 | .\" | |
11 | .\" The GNU General Public License's references to "object code" | |
12 | .\" and "executables" are to be interpreted as the output of any | |
13 | .\" document formatting or typesetting system, including | |
14 | .\" intermediate and printed output. | |
15 | .\" | |
16 | .\" This manual is distributed in the hope that it will be useful, | |
17 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | .\" GNU General Public License for more details. | |
20 | .\" | |
21 | .\" You should have received a copy of the GNU General Public | |
22 | .\" License along with this manual; if not, see | |
23 | .\" <http://www.gnu.org/licenses/>. | |
24 | .\" %%%LICENSE_END | |
25 | .\" | |
c77eace5 | 26 | .TH ICONVCONFIG 8 2014-07-08 "GNU" "Linux System Administration" |
63f2595f MM |
27 | .SH NAME |
28 | iconvconfig \- create iconv module configuration cache | |
29 | .SH SYNOPSIS | |
30 | .B iconvconfig | |
31 | .RI [ options ] | |
32 | .RI [ directory ]... | |
33 | .SH DESCRIPTION | |
34 | The | |
b757a2ea | 35 | .BR iconv (3) |
63f2595f MM |
36 | function internally uses |
37 | .I gconv | |
38 | modules to convert to and from a character set. | |
39 | A configuration file is used to determine the needed modules | |
40 | for a conversion. | |
41 | Loading and parsing such a configuration file would slow down | |
b757a2ea MK |
42 | programs that use |
43 | .BR iconv (3), | |
44 | so a caching mechanism is employed. | |
63f2595f MM |
45 | |
46 | The | |
47 | .B iconvconfig | |
48 | program reads iconv module configuration files and writes | |
b757a2ea | 49 | a fast-loading gconv module configuration cache file. |
91085d85 | 50 | In addition to the system provided gconv modules, the user can specify |
63f2595f MM |
51 | custom gconv module directories with the environment variable |
52 | .BR GCONV_PATH . | |
a7d99f7f | 53 | However, iconv module configuration caching is used only when |
63f2595f MM |
54 | the environment variable |
55 | .BR GCONV_PATH | |
56 | is not set. | |
57 | .SH OPTIONS | |
58 | .TP | |
59 | .B "\-\-nostdlib" | |
60 | Do not search the system default gconv directory, | |
61 | only the directories provided on the command line. | |
62 | .TP | |
63 | .BI \-o " outputfile" ", \-\-output=" outputfile | |
64 | Use | |
65 | .I outputfile | |
66 | for output instead of the system default cache location. | |
67 | .TP | |
68 | .BI \-\-prefix= pathname | |
69 | Set the prefix to be prepended to the system pathnames. | |
70 | See FILES, below. | |
71 | By default, the prefix is empty. | |
72 | Setting the prefix to | |
73 | .IR foo , | |
74 | the gconv module configuration would be read from | |
75 | .IR foo/usr/lib/gconv/gconv-modules | |
76 | and the cache would be written to | |
77 | .IR foo/usr/lib/gconv/gconv-modules.cache . | |
78 | .TP | |
fb787570 | 79 | .BR \-? ", " \-\-help |
63f2595f MM |
80 | Print a usage summary and exit. |
81 | .TP | |
82 | .B "\-\-usage" | |
83 | Print a short usage summary and exit. | |
84 | .TP | |
fb787570 | 85 | .BR \-V ", " \-\-version |
63f2595f MM |
86 | Print the version number, license, and disclaimer of warranty for |
87 | .BR iconv . | |
88 | .SH EXIT STATUS | |
89 | Zero on success, non-zero on errors. | |
90 | .SH FILES | |
91 | .TP | |
92 | .I /usr/lib/gconv | |
93 | Usual default gconv module path. | |
94 | .TP | |
95 | .I /usr/lib/gconv/gconv-modules | |
538ca136 | 96 | Usual system default gconv module configuration file. |
63f2595f MM |
97 | .TP |
98 | .I /usr/lib/gconv/gconv-modules.cache | |
538ca136 | 99 | Usual system gconv module configuration cache. |
63f2595f MM |
100 | .SH "SEE ALSO" |
101 | .BR iconv (1), | |
102 | .BR iconv (3) |