ansilove

ANSI and ASCII art to PNG converter in C
Log | Files | Refs | README | LICENSE

ansilove.1 (5582B)


      1 .\"
      2 .\" Copyright (c) 2011-2020, 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 17 2020 $
     28 .Dt ANSILOVE 1
     29 .Os
     30 .Sh NAME
     31 .Nm ansilove
     32 .Nd ANSI / ASCII art to PNG converter
     33 .Sh SYNOPSIS
     34 .Nm
     35 .Op Fl dhiqrsv
     36 .Op Fl b Ar bits
     37 .Op Fl c Ar columns
     38 .Op Fl f Ar font
     39 .Op Fl m Ar mode
     40 .Op Fl o Ar file
     41 .Op Fl R Ar factor
     42 .Op Fl t Ar type
     43 .Ar file
     44 .Sh DESCRIPTION
     45 .Nm
     46 is an ANSI / ASCII art to PNG converter, allowing to convert ANSI and
     47 artscene-related file formats into PNG images, supporting ANSI (.ANS),
     48 PCBoard (.PCB), Binary (.BIN), Artworx (.ADF), iCE Draw (.IDF),
     49 Tundra (.TND) and XBin (.XB) formats.
     50 .Pp
     51 It creates size optimized 4-bit PNG files and supports SAUCE (Standard
     52 Architecture for Universal Comment Extensions), 80x25 and 80x50 PC fonts
     53 (including all the 14 MS-DOS charsets), Amiga fonts, and iCE colors.
     54 .Pp
     55 The options are as follows:
     56 .Bl -tag -width 10n
     57 .It Fl b Ar bits
     58 Set to 9 to render 9th column of block characters (default: 8).
     59 .It Fl c Ar columns
     60 Adjust number of columns for ANSI, BIN, and TND files.
     61 .It Fl d
     62 Enable DOS aspect ratio.
     63 .It Fl f Ar font
     64 Select font for supported formats.
     65 .Pp
     66 Valid options for PC fonts are:
     67 .Bl -tag -width Er
     68 .It Ic 80x25
     69 Default (Code page 437)
     70 .It Ic 80x50
     71 80x50 mode (Code page 437)
     72 .It Ic cp737
     73 Greek (Code page 737)
     74 .It Ic cp775
     75 Baltic (Code page 775)
     76 .It Ic cp850
     77 Latin1 (Code page 850)
     78 .It Ic cp852
     79 Latin2 (Code page 852)
     80 .It Ic cp855
     81 Cyrillic (Code page 855)
     82 .It Ic cp857
     83 Turkish (Code page 857)
     84 .It Ic cp860
     85 Portuguese (Code page 860)
     86 .It Ic cp861
     87 Icelandic (Code page 861)
     88 .It Ic cp862
     89 Hebrew (Code page 862)
     90 .It Ic cp863
     91 French Canadian (Code page 863)
     92 .It Ic cp865
     93 Nordic (Code page 865)
     94 .It Ic cp866
     95 Russian (Code page 866)
     96 .It Ic cp869
     97 Greek (Code page 869)
     98 .It Ic terminus
     99 Terminus (Modern font, code page 437)
    100 .El
    101 .Pp
    102 Valid options for Amiga fonts are:
    103 .Bl -tag -width Er
    104 .It Ic amiga
    105 Alias to Topaz, see below
    106 .It Ic microknight
    107 Original MicroKnight version
    108 .It Ic microknight+
    109 Modified MicroKnight version
    110 .It Ic mosoul
    111 Original mO'sOul font
    112 .It Ic pot-noodle
    113 Original P0T-NOoDLE font
    114 .It Ic topaz
    115 Original Topaz Kickstart 2.x version
    116 .It Ic topaz+
    117 Modified Topaz Kickstart 2.x+ version
    118 .It Ic topaz500
    119 Original Topaz Kickstart 1.x version
    120 .It Ic topaz500+
    121 Modified Topaz Kickstart 1.x version
    122 .El
    123 .It Fl h
    124 Show help.
    125 .It Fl i
    126 Enable iCE colors.
    127 .It Fl m Ar mode
    128 Set rendering mode for ANS files.
    129 .Pp
    130 Valid options are:
    131 .Bl -tag -width Ds
    132 .It Ic ced
    133 Black on gray, with 78 columns.
    134 .It Ic transparent
    135 Render with transparent background.
    136 .It Ic workbench
    137 Use Amiga Workbench palette.
    138 .El
    139 .It Fl o Ar file
    140 Specify output filename/path.
    141 .It Fl q
    142 Suppress output messages (quiet).
    143 .It Fl r
    144 Create Retina @2x output file.
    145 .It Fl R Ar factor
    146 Create Retina output file with custom scale factor.
    147 .It Fl t Ar type
    148 Specify input file type.
    149 .Pp
    150 Valid types are:
    151 .Bl -tag -width Ds
    152 .It Ic ans
    153 ANSi (ANSI escape sequences: ANSI X3.64 standard)
    154 .It Ic adf
    155 Artworx format, supporting custom character sets and palettes
    156 .It Ic bin
    157 Binary format (raw memory copy of text mode video memory)
    158 .It Ic idf
    159 iCE Draw format, supporting custom character sets and palettes
    160 .It Ic pcb
    161 PCBoard Bulletin Board System (BBS) own file format
    162 .It Ic tnd
    163 TundraDraw format, supporting 24-bit color mode
    164 .It Ic xb
    165 XBin format, supporting custom character sets and palettes
    166 .El
    167 .It Fl s
    168 Show SAUCE record without generating output.
    169 .It Fl v
    170 Show version information.
    171 .El
    172 .Sh EXAMPLES
    173 To render a file with iCE colors enabled:
    174 .Pp
    175 .Dl $ ansilove -i file.ans
    176 .Pp
    177 To create a Retina @2x output file:
    178 .Pp
    179 .Dl $ ansilove -r file.ans
    180 .Pp
    181 To creates a Retina output file with a custom scale factor:
    182 .Pp
    183 .Dl $ ansilove -R 3 file.ans
    184 .Pp
    185 To only display SAUCE record without generating output:
    186 .Pp
    187 .Dl $ ansilove -s file.ans
    188 To render a file with transparent background:
    189 .Pp
    190 .Dl $ ansilove -m transparent file.ans
    191 .Pp
    192 To render a file using a custom font:
    193 .Pp
    194 .Dl $ ansilove -f amiga file.txt
    195 .Pp
    196 To render a file using a custom font, rendering the 9th column, enabling
    197 iCE colors, and using DOS aspect ratio:
    198 .Pp
    199 .Dl $ ansilove -f 80x50 -b 9 -d -i file.ans
    200 .Sh AUTHORS
    201 .An -nosplit
    202 .Nm
    203 was written by
    204 .An Stefan Vogt ,
    205 .An Brian Cassidy ,
    206 and
    207 .An Frederic Cambus .