man8/iconvconfig.8

   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 .\"
  26 .TH ICONVCONFIG 8 2018-02-02 "GNU" "Linux System Administration"
  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
  35 .BR iconv (3)
  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
  42 programs that use
  43 .BR iconv (3),
  44 so a caching mechanism is employed.
  45 .PP
  46 The
  47 .B iconvconfig
  48 program reads iconv module configuration files and writes
  49 a fast-loading gconv module configuration cache file.
  50 .PP
  51 In addition to the system provided gconv modules, the user can specify
  52 custom gconv module directories with the environment variable
  53 .BR GCONV_PATH .
  54 However, iconv module configuration caching is used only when
  55 the environment variable
  56 .BR GCONV_PATH
  57 is not set.
  58 .SH OPTIONS
  59 .TP
  60 .B "\-\-nostdlib"
  61 Do not search the system default gconv directory,
  62 only the directories provided on the command line.
  63 .TP
  64 .BI \-o " outputfile" ", \-\-output=" outputfile
  65 Use
  66 .I outputfile
  67 for output instead of the system default cache location.
  68 .TP
  69 .BI \-\-prefix= pathname
  70 Set the prefix to be prepended to the system pathnames.
  71 See FILES, below.
  72 By default, the prefix is empty.
  73 Setting the prefix to
  74 .IR foo ,
  75 the gconv module configuration would be read from
  76 .IR foo/usr/lib/gconv/gconv-modules
  77 and the cache would be written to
  78 .IR foo/usr/lib/gconv/gconv-modules.cache .
  79 .TP
  80 .BR \-? ", " \-\-help
  81 Print a usage summary and exit.
  82 .TP
  83 .B "\-\-usage"
  84 Print a short usage summary and exit.
  85 .TP
  86 .BR \-V ", " \-\-version
  87 Print the version number, license, and disclaimer of warranty for
  88 .BR iconv .
  89 .SH EXIT STATUS
  90 Zero on success, nonzero on errors.
  91 .SH FILES
  92 .TP
  93 .I /usr/lib/gconv
  94 Usual default gconv module path.
  95 .TP
  96 .I /usr/lib/gconv/gconv-modules
  97 Usual system default gconv module configuration file.
  98 .TP
  99 .I /usr/lib/gconv/gconv-modules.cache
 100 Usual system gconv module configuration cache.
 101 .SH SEE ALSO
 102 .BR iconv (1),
 103 .BR iconv (3)