Add examples to man page

[colorize.git] / colorize.1

diff --git a/colorize.1 b/colorize.1
index 6bd04b3c61c98d940c0b043d60cb9a5ce94d5e71..3b114dd63de46e5a0d7585834bb6480687f3eb09 100644 (file)
--- a/colorize.1
+++ b/colorize.1
@@ -1,6 +1,6 @@
-.TH COLORIZE 1 "2017-04-21" "colorize v0.61" "User Commands"
+.TH COLORIZE 1 "2019-02-23" "colorize v0.64" "User Commands"
 .SH NAME
-colorize \- colorize text with escape sequences
+colorize \- colorize text on terminal with ANSI escape sequences
 .SH SYNOPSIS
 \fBcolorize\fR [\fIoption\fR]... (\fIforeground\fR) [\fIfile\fR]
 .PP
@@ -43,6 +43,9 @@ clean text from all valid color escape sequences
 .BR \-\-exclude\-random=\fICOLOR\fR
 text color to be excluded when selecting a random foreground color
 .TP
+.BR \-\-omit\-color\-empty
+omit printing color escape sequences for empty lines
+.TP
 .BR \-h ", " \-\-help
 show help screen and exit
 .TP
@@ -59,5 +62,21 @@ as follows:
 40-47,49 (background colors)
 .IP * 4
 0 (reset)
+.SH EXAMPLES
+.TP
+$ \fBcolorize green /etc/motd\fR
+Print file /etc/motd with green as foreground color
+.TP
+$ \fBcolorize green/black /etc/motd\fR
+Print file /etc/motd with green as foreground and black as background color
+.TP
+$ \fBcolorize green /etc/motd | colorize --clean\fR
+Print input from stdin with color escape sequences omitted
+.TP
+$ \fBgit log -1 -p --color | colorize --clean-all\fR
+Print input from stdin with all color escape sequences omitted
+.TP
+$ \fBcolorize --attr=bold green /etc/motd\fR
+Print file /etc/motd with bold green as foreground color
 .SH AUTHOR
 Steven Schubiger <stsc@refcnt.org>