usr.bin/iconv/iconv.1

   1 .\" $NetBSD: iconv.1,v 1.1 2003/07/04 06:59:55 tshiozak Exp $
   2 .\" $DragonFly: src/usr.bin/iconv/iconv.1,v 1.3 2007/05/17 08:19:02 swildner Exp $
   3 .\"
   4 .\" Copyright (c)2003 Citrus Project,
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd July 4, 2003
  29 .Dt ICONV 1
  30 .Os
  31 .\" ----------------------------------------------------------------------
  32 .Sh NAME
  33 .Nm iconv
  34 .Nd codeset conversion utility
  35 .\" ----------------------------------------------------------------------
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl cs
  39 .Fl f
  40 .Ar from_name
  41 .Fl t
  42 .Ar to_name
  43 .Op Ar file ...
  44 .Nm
  45 .Fl l
  46 .\" ----------------------------------------------------------------------
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility converts the codeset of
  51 .Ar file
  52 (or from standard input if no file is specified) from codeset
  53 .Ar from_name
  54 to codeset
  55 .Ar to_name
  56 and outputs the
  57 converted text on standard output.
  58 .Pp
  59 The following options are available:
  60 .Bl -tag -width 0123
  61 .It Fl c
  62 Prevent output of any invalid characters.
  63 By default,
  64 .Nm
  65 outputs an
  66 .Dq invalid character
  67 specified by the
  68 .Ar to_name
  69 codeset when it encounters a character which is valid in the
  70 .Ar from_name
  71 codeset but does not have a corresponding character in the
  72 .Ar to_name
  73 codeset.
  74 .It Fl f
  75 Specifies the source codeset name as
  76 .Ar from_name .
  77 .It Fl l
  78 Lists available codeset names.
  79 Note that not all combinations of
  80 .Ar from_name
  81 and
  82 .Ar to_name
  83 are valid.
  84 .It Fl s
  85 Silent.
  86 By default,
  87 .Nm
  88 outputs the number of
  89 .Dq invalid characters
  90 to standard error if they exist.
  91 This option prevents this behaviour.
  92 .It Fl t
  93 Specifies the destination codeset name as
  94 .Ar to_name .
  95 .El
  96 .\" ----------------------------------------------------------------------
  97 .Sh DIAGNOSTICS
  98 .Ex -std iconv
  99 .\" ----------------------------------------------------------------------
 100 .Sh SEE ALSO
 101 .Xr iconv 3
 102 .\" ----------------------------------------------------------------------
 103 .Sh STANDARDS
 104 .Nm
 105 conform to
 106 .St -p1003.1-2001 .
 107 .\" ----------------------------------------------------------------------
 108 .Sh HISTORY
 109 .Nm
 110 first appeared in
 111 .Nx 2.0 .