summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Steven Schubiger <stsc@refcnt.org>2019-02-23 19:56:20 +0100
committerGravatar Steven Schubiger <stsc@refcnt.org>2019-02-23 19:56:20 +0100
commitb43f59e2d6ec6eb895b7d2d6c59911791dfc8727 (patch)
treeb4607e506d6a55522a4323bbab4e12e03db1e5c2
parentdcfc29ba4e971cb4d510ddfa518c7dff934b248b (diff)
downloadcolorize-b43f59e2d6ec6eb895b7d2d6c59911791dfc8727.tar.gz
colorize-b43f59e2d6ec6eb895b7d2d6c59911791dfc8727.tar.bz2
Add examples to man page
-rw-r--r--colorize.118
1 files changed, 17 insertions, 1 deletions
diff --git a/colorize.1 b/colorize.1
index 9bd2229..3b114dd 100644
--- a/colorize.1
+++ b/colorize.1
@@ -1,4 +1,4 @@
-.TH COLORIZE 1 "2018-01-31" "colorize v0.64" "User Commands"
+.TH COLORIZE 1 "2019-02-23" "colorize v0.64" "User Commands"
.SH NAME
colorize \- colorize text on terminal with ANSI escape sequences
.SH SYNOPSIS
@@ -62,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>