aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 159291eb96b63f2607797b42b90265e88310a7be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
colorize
========

Description
-----------
Colorize aims at being a small, independent and handy command-line
text colorizing tool.  It emits ANSI escape sequences in order to
color lines of text; also, sequences emitted by colorize or foreign
programs may be cleared.

The main code is written in C (c89 mostly), whereas the test script
consists of Perl code.

Colorize is known to build and test successfully on Linux and
Net/Open/MirBSD.  Other platforms are untested, so be prepared for
it to eventually not work as expected there.

Requirements
------------
gcc
make
perl

Build instructions
------------------
Issue `make' to build colorize.

Once completed, run the tests with `make check'.

Then you should most likely have a working binary.  There are
currently no make targets to install it as such.

Finally, remove it through `make clean'.

For the sake of completeness, colorize can be also built with
debugging output by issuing `make FLAGS=-DDEBUG'.  The intention
is to provide some memory allocation diagnostics (and might be
extended in future).  Usually, a debugging build is not required.

Documentation
-------------
See man page source file: colorize.1.

Afterword
---------
Let me know, if you have ideas, bug reports, patches, etc.

Author
------
Steven Schubiger <stsc@refcnt.org>