source: libcaca/trunk/doc/img2txt.1 @ 2104

Last change on this file since 2104 was 2104, checked in by Jean-Yves Lamoureux, 12 years ago
  • Added BBCode (French) format to img2txt's help and doc
File size: 2.9 KB
Line 
1.TH img2txt 1 "2007-11-07" "libcaca"
2.SH NAME
3img2txt \- convert images to various text-based coloured files
4.SH SYNOPSIS
5.B img2txt
6[
7.B \-W
8.I width
9]
10[
11.B \-H
12.I height
13]
14[
15.B \-x
16.I font-width
17]
18[
19.B \-y
20.I font-height
21]
22.PD 0
23.IP
24.PD
25 [
26.B \-b
27.I brightness
28]
29[
30.B \-c
31.I contrast
32]
33[
34.B \-g
35.I gamma
36]
37.PD 0
38.IP
39.PD
40 [
41.B \-d
42.I dither
43]
44[
45.B \-f
46.I format
47]
48.I FILE
49.RI
50.SH DESCRIPTION
51.B img2txt
52converts images to colour ASCII characters and outputs them to text-based
53coloured files.
54.PP
55.B img2txt
56can load the most widespread image formats: PNG, JPEG, GIF, PNG, BMP etc (see
57.B NOTES
58for details).
59By default the output text is 60 columns wide, and the line count is
60computed accordingly to respect aspect ratio of original file.
61The default output format is standard ANSI coloured text.
62
63.SH OPTIONS
64.TP
65.B \-W, \-\-width=<width>
66Change output column count. If not given, the default is set to 60.
67.TP
68.B \-H, \-\-height=<height>
69Change output line count. If not given, the height is computed to match correct aspect ratio.
70.TP
71.B \-x, \-\-font-width=<width>
72Change output font width. If not given, the default is set to 6. This value will be used for computing aspect ratio.
73.TP
74.B \-y, \-\-font-height=<height>
75Change output font height. If not given, the default is set to 10. This value will be used for computing aspect ratio.
76.TP
77.B \-b, \-\-brightness=<brightness>
78Change image brightness. Default to 1.0.
79.TP
80.B \-c, \-\-contrast=<contrast>
81Change image contrast. Default to 1.0.
82.TP
83.B \-g, \-\-gamma=<gamma>
84Change image gamma. Default to 1.0.
85.TP
86.B \-d, \-\-dither=<dither>
87Change dithering algorithm. This can be one of the following (default to fstein) :
88  none     : Nearest color
89  ordered2 : Ordered 2x2
90  ordered4 : Ordered 4x4
91  ordered8 : Ordered 8x8
92  random   : Random
93  fstein   : Floyd Steinberg
94.TP
95.B \-f, \-\-format=<format>
96Change output format. This can be one of the following (default to ansi) :
97  ansi  : coloured ANSI
98  caca  : internal libcaca format
99  utf8  : UTF8 with CR
100  utf8  : UTF8 with CRLF (MS Windows)
101  html  : HTML with CSS and DIV support
102  html3 : Pure HTML3 with tables
103  irc   : IRC with ctrl-k codes
104  bbfr  : BBCode (French)
105  ps    : Postscript
106  svg   : Scalable Vector Graphics
107  tga   : Targa Image
108.TP
109.B \-h, \-\-help
110Display help message and exit.
111.TP
112.B \-v, \-\-version
113Display version of the program and exit.
114
115.SH EXAMPLES
116img2txt hello.jpg > hello.ans
117
118img2txt \-\-width=40 \-\-format=svg hello.jpg > tinyhello.svg
119
120.SH NOTES
121Setting both column and line count (using
122\-\-width
123and
124\-\-height) will let you choose the exact output size without taking aspect ratio in account.
125
126You must compile libcaca package with support of
127.I Imlib2
128to be able to load a wide variety of image formats. Otherwise you will only  be able to load regular BMP files.
129
130.SH SEE ALSO
131cacaview(1)
132.SH AUTHOR
133This manual page was written by Sam Hocevar <sam@zoy.org> and Jean-Yves Lamoureux <jylam@lnxscene.org>.
Note: See TracBrowser for help on using the repository browser.