xref: /freebsd/usr.bin/mkcsmapper/mkcsmapper.1 (revision 641a6cfb86023499caafe26a4d821a0b885cf00b)
1.\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" Portions of this text are reprinted and reproduced in electronic form
26.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27.\" Portable Operating System Interface (POSIX), The Open Group Base
28.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
30.\" event of any discrepancy between this version and the original IEEE and
31.\" The Open Group Standard, the original IEEE and The Open Group Standard is
32.\" the referee document.  The original Standard can be obtained online at
33.\"     http://www.opengroup.org/unix/online.html.
34.\"
35.\" $FreeBSD$
36.\"
37.Dd Sep 6, 2009
38.Dt MKCSMAPPER 1
39.Os
40.Sh NAME
41.Nm mkcsmapper
42.Nd generates hashed conversion data for
43.Xr iconv 3
44.Sh SYNOPSIS
45.Nm
46.Op Fl mpd
47.Fl o
48.Ar outfile
49.Ar infile
50.Sh DESCRIPTION
51The
52.Nm
53utility generates binary conversion data from plain text conversion tables
54for the
55.Xr iconv 3
56library.
57The conversion data has two components:
58The conversion mapping between specific character encodings.
59A pivot file, which the possible source and destination encoding
60pairs or the set of mappings to use for a compound encoding.
61.Pp
62The following options are available:
63.Bl -tag -width 0123
64.It Fl d
65Turns on debug mode.
66.It Fl m
67Generate mapping data from
68.Ar infile .
69.It Fl o Ar outfile
70Put generated binary data to
71.Ar outfile .
72.It Fl p
73Generate pivot data from
74.Ar outfile .
75.El
76.Sh EXIT STATUS
77.Ex -std mkcsmapper
78.Sh SEE ALSO
79.Xr iconv 1 ,
80.Xr iconv 3 ,
81.Xr mkesdb 1
82.Sh HISTORY
83.Nm
84first appeared in
85.Nx 2.0 , and made its appearance in
86.Fx 9.0 .
87.Sh AUTHORS
88This manual page was written by
89.An Gabor Kovesdan Aq gabor@FreeBSD.org .
90