bd14ee13f3f3282d31576ffaf83bf1c51ba8e71e
[dragonfly.git] / usr.bin / mkesdb / mkesdb.1
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: src/usr.bin/mkesdb/mkesdb.1,v 1.2 2011/05/25 14:13:53 ru Exp $
36 .\"
37 .Dd June 2, 2011
38 .Dt MKESDB 1
39 .Os
40 .Sh NAME
41 .Nm mkesdb
42 .Nd generates conversion catalog for
43 .Xr iconv 3
44 .Sh SYNOPSIS
45 .Nm
46 .Op Fl md
47 .Fl o
48 .Ar outfile
49 .Ar infile
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility generates conversion catalog for the
54 .Xr iconv 3
55 library.
56 The generated data includes a list of supported encodings
57 and their most important characteristics, like the pluggable
58 module to use
59 .Pp
60 The following options are available:
61 .Bl -tag -width 0123
62 .It Fl d
63 Turns on debug mode.
64 .It Fl m
65 Process directory catalog or alias file.
66 If not specified, the input file is treated as an encoding description.
67 .It Fl o Ar outfile
68 Put generated binary data to
69 .Ar outfile .
70 .El
71 .Sh EXIT STATUS
72 .Ex -std mkesdb
73 .Sh SEE ALSO
74 .Xr iconv 1 ,
75 .Xr mkcsmapper 1 ,
76 .Xr iconv 3
77 .Sh HISTORY
78 .Nm
79 first appeared in
80 .Nx 2.0
81 and was ported to
82 .Dx 1.1 .
83 .Sh AUTHORS
84 This manual page was written by
85 .An Gabor Kovesdan Aq gabor@FreeBSD.org .