Ignore:
Timestamp:
Nov 7, 2007, 10:27:43 AM (12 years ago)
Author:
Jean-Yves Lamoureux
Message:
  • Updated img2txt man page
File:
1 moved

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/doc/img2txt.1

    r1899 r1915  
    1 .TH img2irc 1 "2006-11-10" "libcaca"
     1.TH img2txt 1 "2007-11-07" "libcaca"
    22.SH NAME
    3 img2irc \- convert images to IRC coloured files
     3img2txt \- convert images to various text-based coloured files
    44.SH SYNOPSIS
    5 .B img2irc IMAGE [COLUMNS]
     5.B img2txt
     6[
     7.B \-W
     8.I width
     9]
     10[
     11.B \-H
     12.I height
     13]
     14.PD 0
     15.IP
     16.PD
     17 [
     18.B \-b
     19.I brightness
     20]
     21[
     22.B \-c
     23.I contrast
     24]
     25[
     26.B \-g
     27.I gamma
     28]
     29.PD 0
     30.IP
     31.PD
     32 [
     33.B \-d
     34.I dither
     35]
     36[
     37.B \-f
     38.I format
     39]
     40.I FILE
    641.RI
    742.SH DESCRIPTION
    8 .B img2irc
    9 convert images to colour ASCII characters and outputs them to text using
    10 mIRC colour codes.
     43.B img2txt
     44converts images to colour ASCII characters and outputs them to text-based
     45coloured files.
    1146.PP
    12 .B img2irc
    13 can load the most widespread image formats: PNG, JPEG, GIF, PNG, BMP etc.
    14 By default the output text is 60 columns wide; this value can be changed
    15 by appending a second argument to the commandline.
     47.B img2txt
     48can load the most widespread image formats: PNG, JPEG, GIF, PNG, BMP etc (see
     49.B NOTES
     50for details).
     51By default the output text is 60 columns wide, and the line count is
     52computed accordingly to respect aspect ratio of original file.
     53The default output format is standard ANSI coloured text.
     54
     55.SH OPTIONS
     56.TP
     57.B \-W, \-\-width=<width>
     58Change output column count. If not given, the default is set to 60.
     59.TP
     60.B \-H, \-\-height=<height>
     61Change output line count. If not given, the height is computed to match correct aspect ratio.
     62.TP
     63.B \-b, \-\-brightness=<brightness>
     64Change image brightness. Default to 1.0.
     65.TP
     66.B \-c, \-\-contrast=<contrast>
     67Change image contrast. Default to 1.0.
     68.TP
     69.B \-g, \-\-gamma=<gamma>
     70Change image gamma. Default to 1.0.
     71.TP
     72.B \-d, \-\-dither=<dither>
     73Change dithering algorithm. This can be one of the following (default to fstein) :
     74  none     : Nearest color
     75  ordered2 : Ordered 2x2
     76  ordered4 : Ordered 4x4
     77  ordered8 : Ordered 8x8
     78  random   : Random
     79  fstein   : Floyd Steinberg
     80.TP
     81.B \-f, \-\-format=<format>
     82Change output format. This can be one of the following (default to ansi) :
     83  ansi  : coloured ANSI
     84  caca  : internal libcaca format
     85  utf8  : UTF8 with CR
     86  utf8  : UTF8 with CRLF (MS Windows)
     87  html  : HTML with CSS and DIV support
     88  html3 : Pure HTML3 with tables
     89  irc   : IRC with ctrl-k codes
     90  ps    : Postscript
     91  svg   : Scalable Vector Graphics
     92  tga   : Targa Image
     93
    1694.SH EXAMPLES
    17 img2irc hello.jpg > hello.txt
     95img2txt hello.jpg > hello.ans
    1896
    19 img2irc hello.jpg 40 > tinyhello.txt
    20 .SH BUGS
    21 This program could be merged into
    22 .B cacaview
    23 or expanded to support multiple output formats.
     97img2txt \-\-width=40 \-\-format=svg hello.jpg > tinyhello.svg
     98
     99.SH NOTES
     100Setting both column and line count (using
     101\-\-width
     102and
     103\-\-height) will let you choose the exact output size without taking aspect ratio in account.
     104
     105You must compile libcaca package with support of
     106.I Imlib2
     107to be able to load a wide variety of image formats. Otherwise you will only  be able to load regular BMP files.
     108
    24109.SH SEE ALSO
    25110cacaview(1)
    26111.SH AUTHOR
    27 This manual page was written by Sam Hocevar <sam@zoy.org>.
     112This manual page was written by Sam Hocevar <sam@zoy.org> and Jean-Yves Lamoureux <jylam@lnxscene.org>.
Note: See TracChangeset for help on using the changeset viewer.