]> git.refcnt.org Git - colorize.git/blob - colorize.1
First draft of man page
[colorize.git] / colorize.1
1 .TH COLORIZE 1 "2013-04-29" "colorize v0.50" "User Commands"
2 .SH NAME
3 colorize \- colorize text with escape sequences
4 .SH SYNOPSIS
5 \fBcolorize\fR [option] (foreground) \fIfile\fR
6 .PP
7 \fBcolorize\fR [option] (foreground)/(background) \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, cyan,
19 magenta, 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 When de-colorizing text, \-\-clean omits color escape sequences which
24 were emitted by colorize, whereas \-\-clean\-all omits all valid ones.
25 If in doubt, consider using \-\-clean\-all.
26 .SH OPTIONS
27 .TP
28 .BR \-\-clean
29 clean text from color escape sequences emitted by colorize
30 .TP
31 .BR \-\-clean\-all
32 clean text from all valid color escape sequences
33 .TP
34 .BR \-\-exclude\-random=\fICOLOR\fR
35 text color to be excluded when selecting a random foreground color
36 .TP
37 .BR \-h ", " \-\-help
38 show usage screen and exit
39 .TP
40 .BR \-v ", " \-\-version
41 display version data and exit
42 .SH AUTHOR
43 Steven Schubiger <stsc@refcnt.org>