README

   1 colorize
   2 ========
   3
   4 Description
   5 -----------
   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.
  10
  11 The main code is written in C (c89 mostly), whereas the test script
  12 consists of Perl code.
  13
  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.
  17
  18 Requirements
  19 ------------
  20 gcc
  21 make
  22 perl
  23
  24 Build instructions
  25 ------------------
  26 Issue `make' to build colorize.
  27
  28 Once completed, run the tests with `make check'.
  29
  30 Then you should most likely have a working binary.  There are
  31 currently no make targets to install it as such.
  32
  33 Finally, remove it through `make clean'.
  34
  35 Debugging instructions
  36 ----------------------
  37 For the sake of completeness, colorize can be also built with
  38 debugging output by issuing `make FLAGS=-DDEBUG'.  The intention
  39 is to provide some memory allocation diagnostics (and might be
  40 extended in future).  Usually, a debugging build is not required.
  41
  42 Documentation
  43 -------------
  44 See man page source file: colorize.1.
  45
  46 Usage example
  47 -------------
  48 In ~/.bashrc:
  49
  50 | ls_color() {
  51 |     ls "$@" | colorize green -
  52 | }
  53 | alias ls=ls_color
  54
  55 This excerpt defines an alias which will set the color being
  56 printed for literal ls invocations to green.
  57
  58 Afterword
  59 ---------
  60 Let me know, if you have ideas, bug reports, patches, etc.
  61
  62 Author
  63 ------
  64 Steven Schubiger <stsc@refcnt.org>