xref: /netbsd/usr.bin/iconv/iconv.1 (revision 691c0c54)
1*691c0c54Srodent.\" $NetBSD: iconv.1,v 1.5 2013/05/12 12:25:12 rodent Exp $
26a491b80Stshiozak.\"
36a491b80Stshiozak.\" Copyright (c)2003 Citrus Project,
46a491b80Stshiozak.\" All rights reserved.
56a491b80Stshiozak.\"
66a491b80Stshiozak.\" Redistribution and use in source and binary forms, with or without
76a491b80Stshiozak.\" modification, are permitted provided that the following conditions
86a491b80Stshiozak.\" are met:
96a491b80Stshiozak.\" 1. Redistributions of source code must retain the above copyright
106a491b80Stshiozak.\"    notice, this list of conditions and the following disclaimer.
116a491b80Stshiozak.\" 2. Redistributions in binary form must reproduce the above copyright
126a491b80Stshiozak.\"    notice, this list of conditions and the following disclaimer in the
136a491b80Stshiozak.\"    documentation and/or other materials provided with the distribution.
146a491b80Stshiozak.\"
156a491b80Stshiozak.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
166a491b80Stshiozak.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
176a491b80Stshiozak.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
186a491b80Stshiozak.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
196a491b80Stshiozak.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
206a491b80Stshiozak.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
216a491b80Stshiozak.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
226a491b80Stshiozak.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
236a491b80Stshiozak.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
246a491b80Stshiozak.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
256a491b80Stshiozak.\" SUCH DAMAGE.
266a491b80Stshiozak.\"
270b9f4942Stnozaki.Dd March 20, 2008
28ab7901a8Swiz.Dt ICONV 1
296a491b80Stshiozak.Os
306a491b80Stshiozak.\" ----------------------------------------------------------------------
316a491b80Stshiozak.Sh NAME
326a491b80Stshiozak.Nm iconv
336a491b80Stshiozak.Nd codeset conversion utility
346a491b80Stshiozak.\" ----------------------------------------------------------------------
356a491b80Stshiozak.Sh SYNOPSIS
366a491b80Stshiozak.Nm
376a491b80Stshiozak.Op Fl cs
386a491b80Stshiozak.Fl f
396a491b80Stshiozak.Ar from_name
406a491b80Stshiozak.Fl t
416a491b80Stshiozak.Ar to_name
426a491b80Stshiozak.Op Ar file ...
436a491b80Stshiozak.Nm
440b9f4942Stnozaki.Fl f
450b9f4942Stnozaki.Ar from_name
460b9f4942Stnozaki.Op Fl cs
470b9f4942Stnozaki.Op Fl t Ar to_name
480b9f4942Stnozaki.Op Ar file ...
490b9f4942Stnozaki.Nm
500b9f4942Stnozaki.Fl t
510b9f4942Stnozaki.Ar to_name
520b9f4942Stnozaki.Op Fl cs
530b9f4942Stnozaki.Op Fl f Ar from_name
540b9f4942Stnozaki.Op Ar file ...
550b9f4942Stnozaki.Nm
566a491b80Stshiozak.Fl l
576a491b80Stshiozak.\" ----------------------------------------------------------------------
586a491b80Stshiozak.Sh DESCRIPTION
596a491b80StshiozakThe
606a491b80Stshiozak.Nm
61ab7901a8Swizutility converts the codeset of
62ab7901a8Swiz.Ar file
63ab7901a8Swiz(or from standard input if no file is specified) from codeset
64ab7901a8Swiz.Ar from_name
65ab7901a8Swizto codeset
66ab7901a8Swiz.Ar to_name
67ab7901a8Swizand outputs the
68ab7901a8Swizconverted text on standard output.
696a491b80Stshiozak.Pp
706a491b80StshiozakThe following options are available:
716a491b80Stshiozak.Bl -tag -width 0123
726a491b80Stshiozak.It Fl c
73ab7901a8SwizPrevent output of any invalid characters.
74ab7901a8SwizBy default,
756a491b80Stshiozak.Nm
76ab7901a8Swizoutputs an
77ab7901a8Swiz.Dq invalid character
78ab7901a8Swizspecified by the
796a491b80Stshiozak.Ar to_name
807525158fSdhollandcodeset when it encounters a character which is valid in the
816a491b80Stshiozak.Ar from_name
82ab7901a8Swizcodeset but does not have a corresponding character in the
836a491b80Stshiozak.Ar to_name
846a491b80Stshiozakcodeset.
856a491b80Stshiozak.It Fl f
866a491b80StshiozakSpecifies the source codeset name as
876a491b80Stshiozak.Ar from_name .
886a491b80Stshiozak.It Fl l
896a491b80StshiozakLists available codeset names.
906a491b80StshiozakNote that not all combinations of
916a491b80Stshiozak.Ar from_name
926a491b80Stshiozakand
936a491b80Stshiozak.Ar to_name
946a491b80Stshiozakare valid.
95ab7901a8Swiz.It Fl s
96ab7901a8SwizSilent.
97ab7901a8SwizBy default,
98ab7901a8Swiz.Nm
99ab7901a8Swizoutputs the number of
100ab7901a8Swiz.Dq invalid characters
101ab7901a8Swizto standard error if they exist.
102ab7901a8SwizThis option prevents this behaviour.
103ab7901a8Swiz.It Fl t
104ab7901a8SwizSpecifies the destination codeset name as
105ab7901a8Swiz.Ar to_name .
1066a491b80Stshiozak.El
1076a491b80Stshiozak.\" ----------------------------------------------------------------------
1086a491b80Stshiozak.Sh EXIT STATUS
109ab7901a8Swiz.Ex -std iconv
1106a491b80Stshiozak.\" ----------------------------------------------------------------------
1116a491b80Stshiozak.Sh SEE ALSO
112ab7901a8Swiz.Xr iconv 3
1136a491b80Stshiozak.\" ----------------------------------------------------------------------
1146a491b80Stshiozak.Sh STANDARDS
1156a491b80Stshiozak.Nm
116*691c0c54Srodentconforms to
1176a491b80Stshiozak.St -p1003.1-2001 .
118ab7901a8Swiz.\" ----------------------------------------------------------------------
119ab7901a8Swiz.Sh HISTORY
120ab7901a8Swiz.Nm
121ab7901a8Swizfirst appeared in
122ab7901a8Swiz.Nx 2.0 .
123