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