xref: /freebsd/usr.bin/mkcsmapper/mkcsmapper.1 (revision 61e21613)
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 at
33.\" https://www.opengroup.org/membership/forums/platform/unix
34.\"
35.Dd July 9, 2016
36.Dt MKCSMAPPER 1
37.Os
38.Sh NAME
39.Nm mkcsmapper
40.Nd generates hashed conversion data for
41.Xr iconv 3
42.Sh SYNOPSIS
43.Nm
44.Op Fl d
45.Op Fl m | Fl p
46.Op Fl o Ar outfile
47.Op Ar infile
48.Sh DESCRIPTION
49The
50.Nm
51utility generates binary conversion data from plain text conversion tables
52for the
53.Xr iconv 3
54library.
55The conversion data has two components:
56The conversion mapping between specific character encodings.
57A pivot file, which the possible source and destination encoding
58pairs or the set of mappings to use for a compound encoding.
59.Pp
60The following options are available:
61.Bl -tag -width XoXoutfileXX
62.It Fl d
63Turns on debug mode.
64.It Fl m
65Generate mapping data from
66.Ar infile .
67.It Fl o Ar outfile
68Put generated binary data to
69.Ar outfile .
70.It Fl p
71Generate pivot data from
72.Ar outfile .
73.El
74.Sh EXIT STATUS
75.Ex -std mkcsmapper
76.Sh SEE ALSO
77.Xr iconv 1 ,
78.Xr mkesdb 1 ,
79.Xr iconv 3
80.Sh HISTORY
81.Nm
82first appeared in
83.Nx 2.0 ,
84and made its appearance in
85.Fx 9.0 .
86.Sh AUTHORS
87This manual page was written by
88.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org .
89