diff options
| -rw-r--r-- | colorize.1 | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/colorize.1 b/colorize.1 new file mode 100644 index 0000000..f5b11ec --- /dev/null +++ b/colorize.1 @@ -0,0 +1,43 @@ +.TH COLORIZE 1 "2013-04-29" "colorize v0.50" "User Commands" +.SH NAME +colorize \- colorize text with escape sequences +.SH SYNOPSIS +\fBcolorize\fR [option] (foreground) \fIfile\fR +.PP +\fBcolorize\fR [option] (foreground)/(background) \fIfile\fR +.PP +\fBcolorize\fR \-\-clean[\-all] \fIfile\fR +.PP +\fBcolorize\fR \-hv +.SH DESCRIPTION +Colorizes text read from standard input stream or file by using ANSI +escape sequences (and also vice versa, i.e. cleaning text from sequences) +and prints resulting output to the terminal. +.PP +When colorizing text, (foreground) and eventually (background) may be either +one of following color values: none, black, red, green, yellow, blue, cyan, +magenta, white, default or random. First character of color name in upper +case denotes increased intensity, whereas for lower case colors will be of +normal intensity. If "none" is chosen, no escape sequences will be emitted. +.PP +When de-colorizing text, \-\-clean omits color escape sequences which +were emitted by colorize, whereas \-\-clean\-all omits all valid ones. +If in doubt, consider using \-\-clean\-all. +.SH OPTIONS +.TP +.BR \-\-clean +clean text from color escape sequences emitted by colorize +.TP +.BR \-\-clean\-all +clean text from all valid color escape sequences +.TP +.BR \-\-exclude\-random=\fICOLOR\fR +text color to be excluded when selecting a random foreground color +.TP +.BR \-h ", " \-\-help +show usage screen and exit +.TP +.BR \-v ", " \-\-version +display version data and exit +.SH AUTHOR +Steven Schubiger <stsc@refcnt.org> |