man8/iconvconfig.8

   1 .\" Copyright (C) 2014 Marko Myllynen <myllynen@redhat.com>
   2 .\"
   3 .\" SPDX-License-Identifier: GPL-2.0-or-later
   4 .\"
   5 .TH ICONVCONFIG 8 2021-08-27 "GNU" "Linux System Administration"
   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 .PP
  25 The
  26 .B iconvconfig
  27 program reads iconv module configuration files and writes
  28 a fast-loading gconv module configuration cache file.
  29 .PP
  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 \-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
  55 .I foo/usr/lib/gconv/gconv\-modules
  56 and the cache would be written to
  57 .IR foo/usr/lib/gconv/gconv\-modules.cache .
  58 .TP
  59 .BR \-? ", " \-\-help
  60 Print a usage summary and exit.
  61 .TP
  62 .B "\-\-usage"
  63 Print a short usage summary and exit.
  64 .TP
  65 .BR \-V ", " \-\-version
  66 Print the version number, license, and disclaimer of warranty for
  67 .BR iconv .
  68 .SH EXIT STATUS
  69 Zero on success, nonzero on errors.
  70 .SH FILES
  71 .TP
  72 .I /usr/lib/gconv
  73 Usual default gconv module path.
  74 .TP
  75 .I /usr/lib/gconv/gconv\-modules
  76 Usual system default gconv module configuration file.
  77 .TP
  78 .I /usr/lib/gconv/gconv\-modules.cache
  79 Usual system gconv module configuration cache.
  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 .
  84 .SH SEE ALSO
  85 .BR iconv (1),
  86 .BR iconv (3)