libansilove

Library for converting ANSI, ASCII, and other formats to PNG
Log | Files | Refs | README | LICENSE

libansilove.3 (2726B)


      1 .\"
      2 .\" Copyright (c) 2011-2021, Stefan Vogt, Brian Cassidy, and Frederic Cambus
      3 .\" All rights reserved.
      4 .\"
      5 .\" Redistribution and use in source and binary forms, with or without
      6 .\" modification, are permitted provided that the following conditions are met:
      7 .\"
      8 .\"   * Redistributions of source code must retain the above copyright
      9 .\"     notice, this list of conditions and the following disclaimer.
     10 .\"
     11 .\"   * 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     16 .\" AND 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 COPYRIGHT HOLDER OR CONTRIBUTORS
     19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     25 .\" POSSIBILITY OF SUCH DAMAGE.
     26 .\"
     27 .Dd $Mdocdate: February 14 2021 $
     28 .Dt LIBANSILOVE 3
     29 .Os
     30 .Sh NAME
     31 .Nm libansilove
     32 .Nd Library for converting ANSI, ASCII, and other formats to PNG
     33 .Sh DESCRIPTION
     34 .Nm
     35 is a library to convert ANSi and artscene related file formats into PNG
     36 images, supporting ANSI (.ANS), PCBoard (.PCB), Binary (.BIN), Artworx
     37 (.ADF), iCE Draw (.IDF), Tundra (.TND) and XBin (.XB) formats.
     38 .Pp
     39 It creates size optimized 4-bit PNG files and supports 80x25 and 80x50
     40 PC fonts (including all the 14 MS-DOS charsets), Amiga fonts, and
     41 iCE colors.
     42 .Pp
     43 All library functions take a context, defined as an
     44 .Em ansilove_ctx
     45 structure in
     46 .Pa include/ansilove.h :
     47 .Bd -literal
     48 struct ansilove_ctx {
     49         uint8_t *buffer;
     50         size_t maplen;
     51         size_t length;
     52         struct ansilove_png png;
     53         uint8_t error;
     54 };
     55 .Ed
     56 .Pp
     57 Options are passed to the different loaders using the
     58 .Em ansilove_options
     59 structure in
     60 .Pa include/ansilove.h :
     61 .Bd -literal
     62 struct ansilove_options {
     63         bool diz;
     64         bool dos;
     65         bool icecolors;
     66         bool truecolor;
     67         int16_t columns;
     68         uint8_t font;
     69         uint8_t bits;
     70         uint8_t mode;
     71         uint8_t scale_factor;
     72 };
     73 .Ed
     74 .Sh AUTHORS
     75 .An -nosplit
     76 .Nm
     77 was written by
     78 .An Stefan Vogt ,
     79 .An Brian Cassidy ,
     80 and
     81 .An Frederic Cambus .