colorize.1

   1 .TH COLORIZE 1 "2018-01-31" "colorize v0.64" "User Commands"
   2 .SH NAME
   3 colorize \- colorize text on terminal with ANSI escape sequences
   4 .SH SYNOPSIS
   5 \fBcolorize\fR [\fIoption\fR]... (\fIforeground\fR) [\fIfile\fR]
   6 .PP
   7 \fBcolorize\fR [\fIoption\fR]... (\fIforeground\fR)/(\fIbackground\fR) [\fIfile\fR]
   8 .PP
   9 \fBcolorize\fR \-\-clean[\-all] [\fIfile\fR]
  10 .PP
  11 \fBcolorize\fR \-hV
  12 .SH DESCRIPTION
  13 Colorizes text read from standard input stream or file by using ANSI
  14 escape sequences (and also vice versa, i.e. cleaning text from sequences)
  15 and prints resulting output to the terminal.
  16 .PP
  17 When colorizing text, (foreground) and eventually (background) may be either
  18 one of following color values: none, black, red, green, yellow, blue, magenta,
  19 cyan, white, default or random.  First character of color name in upper
  20 case denotes increased intensity, whereas for lower case colors will be of
  21 normal intensity.  If "none" is chosen, no escape sequences will be emitted.
  22 .PP
  23 Color escape sequences are added per each line, hence colored lines can be
  24 safely extracted.
  25 .PP
  26 When de-colorizing text, \-\-clean omits color escape sequences which
  27 were emitted by colorize (see NOTES for list), whereas \-\-clean\-all
  28 omits all valid ones.  If in doubt, consider using \-\-clean\-all.
  29 .SH OPTIONS
  30 .TP
  31 .BR \-\-attr=\fIATTR1,ATTR2,...\fR
  32 set attributes by name
  33 .RS
  34 Attributes: bold, underscore, blink, reverse and concealed.
  35 .RE
  36 .TP
  37 .BR \-\-clean
  38 clean text from color escape sequences emitted by colorize
  39 .TP
  40 .BR \-\-clean\-all
  41 clean text from all valid color escape sequences
  42 .TP
  43 .BR \-\-exclude\-random=\fICOLOR\fR
  44 text color to be excluded when selecting a random foreground color
  45 .TP
  46 .BR \-\-omit\-color\-empty
  47 omit printing color escape sequences for empty lines
  48 .TP
  49 .BR \-h ", " \-\-help
  50 show help screen and exit
  51 .TP
  52 .BR \-V ", " \-\-version
  53 display version data and exit
  54 .SH NOTES
  55 The list of color escape sequence codes being emitted and omitted is
  56 as follows:
  57 .IP * 4
  58 30-37,39 (foreground colors)
  59 .IP * 4
  60 1-9;30-37,39 (foreground colors with attributes)
  61 .IP * 4
  62 40-47,49 (background colors)
  63 .IP * 4
  64 0 (reset)
  65 .SH AUTHOR
  66 Steven Schubiger <stsc@refcnt.org>