=head1	NAME

dkcp - codepage handling

=head1	SYNOPSIS

  #include <dkcp.h>

  unsigned char *
  dkcp_open (dk_stream_t *st);
  
  unsigned char
  dkcp_convert (unsigned char *codepage, unsigned char c);
  
  void
  dkcp_fputs (FILE *out, unsigned char *cp, char *str);

=head1	DESCRIPTION

Some systems need codepage support to output text. On Windows different
bytes are needed to write i.e. german umlauts to a console window
or to a text edited in notepad.

Codepages can be used for translation. A codepage can be initialized
using a I<dk_stream_t> structure. The dkcp_open() function creates
a new codepage structure and initializes it. The function returns a valid
pointer to the codepage on success, NULL on error.

After usage the codepage must be released using the dk_delete() function
from the dkmem module.

The dkcp_convert() function returns the character which is needed to
print character I<c>.

The dkcp_fputs() function writes a string to a file using the specified
codepage for translation.

=head1	AUTHOR

Dirk Krause

=head1	COPYRIGHT AND LICENSE

Copyright (c) 2001-2008, Dirk Krause
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.

 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials
   provided with the distribution.

 * Neither the name of the Dirk Krause nor the names of
   contributors may be used to endorse or promote products
   derived from this software without specific prior written
   permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
