man8/iconvconfig.8

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