First draft of --omit-color-empty

[colorize.git] / colorize.1

diff --git a/colorize.1 b/colorize.1
index d209a4975d6d5b757574bbee836e268f6b0a5f3e..66d16782da09a2c8e63193f1259a80c80063c2d1 100644 (file)
--- a/colorize.1
+++ b/colorize.1
@@ -1,22 +1,22 @@
-.TH COLORIZE 1 "2013-10-20" "colorize v0.51" "User Commands"
+.TH COLORIZE 1 "2017-07-16" "colorize v0.63" "User Commands"
 .SH NAME
-colorize \- colorize text with escape sequences
+colorize \- colorize text on terminal with ANSI escape sequences
 .SH SYNOPSIS
-\fBcolorize\fR [option] (foreground) \fIfile\fR
+\fBcolorize\fR [\fIoption\fR]... (\fIforeground\fR) [\fIfile\fR]
 .PP
-\fBcolorize\fR [option] (foreground)/(background) \fIfile\fR
+\fBcolorize\fR [\fIoption\fR]... (\fIforeground\fR)/(\fIbackground\fR) [\fIfile\fR]
 .PP
-\fBcolorize\fR \-\-clean[\-all] \fIfile\fR
+\fBcolorize\fR \-\-clean[\-all] [\fIfile\fR]
 .PP
-\fBcolorize\fR \-hv
+\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
+one of following color values: none, black, red, green, yellow, blue, magenta,
+cyan, 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
@@ -28,6 +28,12 @@ were emitted by colorize (see NOTES for list), whereas \-\-clean\-all
 omits all valid ones.  If in doubt, consider using \-\-clean\-all.
 .SH OPTIONS
 .TP
+.BR \-\-attr=\fIATTR1,ATTR2,...\fR
+set attributes by name
+.RS
+Attributes: bold, underscore, blink, reverse and concealed.
+.RE
+.TP
 .BR \-\-clean
 clean text from color escape sequences emitted by colorize
 .TP
@@ -38,9 +44,9 @@ clean text from all valid color escape sequences
 text color to be excluded when selecting a random foreground color
 .TP
 .BR \-h ", " \-\-help
-show usage screen and exit
+show help screen and exit
 .TP
-.BR \-v ", " \-\-version
+.BR \-V ", " \-\-version
 display version data and exit
 .SH NOTES
 The list of color escape sequence codes being emitted and omitted is
@@ -48,7 +54,7 @@ as follows:
 .IP * 4
 30-37,39 (foreground colors)
 .IP * 4
-1;30-37,39 (bold foreground colors)
+1-9;30-37,39 (foreground colors with attributes)
 .IP * 4
 40-47,49 (background colors)
 .IP * 4