colorize Screenshots

From 4ff7de954891bd8b72268d20f5150240994283d0 Mon Sep 17 00:00:00 2001 From: Steven Schubiger Date: Tue, 11 Apr 2017 19:30:07 +0200 Subject: [PATCH] Add plain documentation --- doc/colorize.html | 120 ++++++++++++++++--- doc/screenshots/colorize.html | 20 ++++ doc/{ => screenshots}/colorize/colorize1.jpg | Bin doc/{ => screenshots}/colorize/colorize2.jpg | Bin doc/{ => screenshots}/colorize/colorize3.jpg | Bin doc/{ => screenshots}/colorize/colorize4.jpg | Bin doc/{ => screenshots}/colorize/colorize5.jpg | Bin doc/{ => screenshots}/colorize/colorize6.jpg | Bin doc/{ => screenshots}/colorize/colorize7.jpg | Bin doc/{ => screenshots}/colorize/colorize8.jpg | Bin 10 files changed, 121 insertions(+), 19 deletions(-) create mode 100644 doc/screenshots/colorize.html rename doc/{ => screenshots}/colorize/colorize1.jpg (100%) rename doc/{ => screenshots}/colorize/colorize2.jpg (100%) rename doc/{ => screenshots}/colorize/colorize3.jpg (100%) rename doc/{ => screenshots}/colorize/colorize4.jpg (100%) rename doc/{ => screenshots}/colorize/colorize5.jpg (100%) rename doc/{ => screenshots}/colorize/colorize6.jpg (100%) rename doc/{ => screenshots}/colorize/colorize7.jpg (100%) rename doc/{ => screenshots}/colorize/colorize8.jpg (100%) diff --git a/doc/colorize.html b/doc/colorize.html index 3b0aaba..8084cc7 100644 --- a/doc/colorize.html +++ b/doc/colorize.html @@ -1,20 +1,102 @@ - - - - - colorize Screenshots - - - - - - - - - - - -

- + + + + + + +colorize + + +

+[sts@apollo ~/colorize]$ ./colorize --help
+Usage: ./colorize (foreground) OR (foreground)/(background) OR --clean[-all] [-|file]
+
+	Colors (foreground) (background)
+		{-} none         none
+		{#} [Bb]lack     black
+		{#} [Rr]ed       red
+		{#} [Gg]reen     green
+		{#} [Yy]ellow    yellow
+		{#} [Bb]lue      blue
+		{#} [Mm]agenta   magenta
+		{#} [Cc]yan      cyan
+		{#} [Ww]hite     white
+		{#} [Dd]efault   default
+		{*} [Rr]andom    random [--exclude-random=<foreground color>]
+
+	First character of color name in upper case denotes increased intensity,
+	whereas for lower case colors will be of normal intensity.
+
+	Options
+		    --clean
+		    --clean-all
+		    --exclude-random
+		-h, --help
+		-V, --version
+

+[sts@apollo ~/colorize]$ ./colorize cyan /etc/motd
+
+The programs included with the Debian GNU/Linux system are free software;
+the exact distribution terms for each program are described in the
+individual files in /usr/share/doc/*/copyright.
+
+Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
+permitted by applicable law.
+

+[sts@apollo ~/colorize]$ ./colorize cyan /etc/motd | ./colorize --clean
+
+The programs included with the Debian GNU/Linux system are free software;
+the exact distribution terms for each program are described in the
+individual files in /usr/share/doc/*/copyright.
+
+Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
+permitted by applicable law.
+

+[sts@apollo ~/colorize]$ ./colorize Yellow /etc/motd
+
+The programs included with the Debian GNU/Linux system are free software;
+the exact distribution terms for each program are described in the
+individual files in /usr/share/doc/*/copyright.
+
+Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
+permitted by applicable law.
+

+[sts@apollo ~/colorize]$ ./colorize white/blue /etc/motd
+
+The programs included with the Debian GNU/Linux system are free software;
+the exact distribution terms for each program are described in the
+individual files in /usr/share/doc/*/copyright.
+
+Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
+permitted by applicable law.
+

+[sts@apollo ~/colorize]$ ./colorize --exclude-random=black random /etc/motd
+
+The programs included with the Debian GNU/Linux system are free software;
+the exact distribution terms for each program are described in the
+individual files in /usr/share/doc/*/copyright.
+
+Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
+permitted by applicable law.
+

+[sts@apollo ~/colorize]$ ./colorize green /etc/motd | head -n2 | tail -n1
+The programs included with the Debian GNU/Linux system are free software;
+

+[sts@apollo ~/colorize]$ ./colorize --version
+colorize v0.59-16-gf340b58 (compiled at Mar 18 2017, 00:08:31)
+Compiler flags: "-ansi -pedantic "
+Linker flags: ""
+Preprocessor flags: ""
+Buffer size: 4K
+Color separator: '/'
+Debugging: no
+

+ diff --git a/doc/screenshots/colorize.html b/doc/screenshots/colorize.html new file mode 100644 index 0000000..3b0aaba --- /dev/null +++ b/doc/screenshots/colorize.html @@ -0,0 +1,20 @@ + + + + + colorize Screenshots + + + + + + + + + + + +

+ + diff --git a/doc/colorize/colorize1.jpg b/doc/screenshots/colorize/colorize1.jpg similarity index 100% rename from doc/colorize/colorize1.jpg rename to doc/screenshots/colorize/colorize1.jpg diff --git a/doc/colorize/colorize2.jpg b/doc/screenshots/colorize/colorize2.jpg similarity index 100% rename from doc/colorize/colorize2.jpg rename to doc/screenshots/colorize/colorize2.jpg diff --git a/doc/colorize/colorize3.jpg b/doc/screenshots/colorize/colorize3.jpg similarity index 100% rename from doc/colorize/colorize3.jpg rename to doc/screenshots/colorize/colorize3.jpg diff --git a/doc/colorize/colorize4.jpg b/doc/screenshots/colorize/colorize4.jpg similarity index 100% rename from doc/colorize/colorize4.jpg rename to doc/screenshots/colorize/colorize4.jpg diff --git a/doc/colorize/colorize5.jpg b/doc/screenshots/colorize/colorize5.jpg similarity index 100% rename from doc/colorize/colorize5.jpg rename to doc/screenshots/colorize/colorize5.jpg diff --git a/doc/colorize/colorize6.jpg b/doc/screenshots/colorize/colorize6.jpg similarity index 100% rename from doc/colorize/colorize6.jpg rename to doc/screenshots/colorize/colorize6.jpg diff --git a/doc/colorize/colorize7.jpg b/doc/screenshots/colorize/colorize7.jpg similarity index 100% rename from doc/colorize/colorize7.jpg rename to doc/screenshots/colorize/colorize7.jpg diff --git a/doc/colorize/colorize8.jpg b/doc/screenshots/colorize/colorize8.jpg similarity index 100% rename from doc/colorize/colorize8.jpg rename to doc/screenshots/colorize/colorize8.jpg -- 2.39.2