6 Colorize aims at being a small, independent and handy command-line
7 text colorizing tool. It emits ANSI escape sequences in order to
8 color lines of text; also, sequences emitted by colorize or foreign
9 programs may be cleared.
11 The main code is written in C (c89 mostly), whereas the test script
12 consists of Perl code.
14 Colorize is known to build and test successfully on Linux and
15 Net/Open/MirBSD. Other platforms are untested, so be prepared for
16 it to eventually not work as expected there.
27 Issue `make' to build colorize.
29 Once completed, run the tests with `make check'.
31 Then you should most likely have a working binary.
33 Next, install it with `make install' (may require elevated
36 Finally, clean up the working directory through `make clean'.
38 Customizing instructions
39 ------------------------
40 The default character ('/') which separates the foreground
41 from the background color may be redefined:
43 `make FLAGS=-DCOLOR_SEP_CHAR_COLON' -> defines as ':'
44 `make FLAGS=-DCOLOR_SEP_CHAR_SLASH' -> defines as '/'
46 Debugging instructions
47 ----------------------
48 For the sake of completeness, colorize can be also built with
49 debugging output by issuing `make FLAGS=-DDEBUG'. The intention
50 is to provide some memory allocation diagnostics (and might be
51 extended in future). Usually, a debugging build is not required.
53 Furthermore, tests can be run through valgrind by issuing, for
54 example, `make check_valgrind 2>&1 | tee valgrind.out'. The
55 file provided here for the `tee' invocation will be populated
56 with the captured output from both standard output and error
61 A user configuration file may be populated with options and
62 according values. See man page source file `colorize.1' for
67 See man page source file: colorize.1.
74 | ls "$@" | colorize green -
78 This excerpt defines an alias which will set the color being
79 printed for literal ls invocations to green.
83 Let me know, if you have ideas, bug reports, patches, etc.
87 Steven Schubiger <stsc@refcnt.org>