1icat - image cat
2================
3Outputs an image on a 256-color or 24-bit color enabled terminal with UTF-8 locale,
4such as gnome-terminal, konsole or rxvt-unicode (urxvt).
5
6Building
7--------
8
9Build requirements: icat depends on imlib2.
10
11On Ubuntu, `apt-get install libimlib2-dev`
12
13On Darwin (Mac OS X), `brew install imlib2`
14
15Note that for Darwin (Mac OS X), you will need to install [XQuartz](http://xquartz.macosforge.org/landing/) first, the version of the X.Org X Window System (X11) that runs on OS X.
16
17To compile:
18
19	make
20
21Running
22-------
23
24Run icat with a local file:
25
26	icat sample.png
27
28or with multiple files:
29
30	icat img1.jpg img2.jpg > newfile.txt
31
32or, if `-` is used as as file name, it reads from standard input:
33
34	curl -sL https://raw.github.com/atextor/icat/master/sample.png | icat -
35
36The above commands results the following output in 256-color terminal, see [`sample.256-color.txt`](sample.256-color.txt) for the actual output:
37
38![Output of sample.png](sample.256-color.png)
39
40For terminals that support 24-bit color (such as Konsole and Yakuake, see [this document](https://gist.github.com/XVilka/8346728) for more information about terminals and their color support), this can be enabled using:
41
42	icat -m 24bit sample.png
43
44
45Author
46------
47
48icat was written by Andreas Textor <textor.andreas@googlemail.com>.
49The sample icon is from the Nuvola icon theme by David Vignoni.
50
51
52