Permalink
Browse files

add README file

  • Loading branch information...
1 parent a556bea commit 5ea9d0e6b6095b147cd31c752deb0e2e71cdaac5 @melborne committed Dec 19, 2010
Showing with 83 additions and 0 deletions.
  1. +83 −0 README.rdoc
View
83 README.rdoc
@@ -0,0 +1,83 @@
+== NAME
+
+ calour is an alternative to cal command, which displays a colored,
+ holiday plot calendar with block or line styled.
+
+== SYNOPSIS
+
+ calour [-3lmnty] [-c [country_code]] [--color color_set] [[month] year]
+
+== DESCRIPTION
+
+ The options are as follows:
+
+ -3 3 months block mode
+
+ -l line mode
+
+ -b block mode (default)
+
+ -m monday first
+
+ -s sunday first (default)
+
+ -n no color mode
+
+ -k color mode (default)
+
+ -c country_code
+ holidays mark on/off. without country code, let it off.
+ acceptable code: ja us au ja_ja cn fr de it kr tw gb
+
+ -t append holiday titles
+
+ -f no holiday titles (default)
+
+ -y this year
+
+ -h display this help
+
+ -v display version
+
+== COLOR SETTINGS
+
+ Colors can be changed with --color COLOR_SET option. COLOR_SET is constructed
+ as combination of target-color-pairs.
+
+ examples;
+
+ --color year:magenta,today:on_green,holiday:red
+
+ --color mon:yel,hol:blu,nei:bla
+
+ --color 'sat:blue sun:red tod:blink'
+
+ Like examples, each pairs are joined with ','(comma), target and color are
+ joined with ':'(colon). names of targets and colors can be reduced.
+
+ Target names are as follows:
+
+ year: year label color (default: yellow)
+
+ month: month label color (default: green)
+
+ today: today date color (default: green, underline])
+
+ saturday: saturday dates color (default: cyan)
+
+ sunday: sunday dates color (default: magenta)
+
+ holiday: holiday dates color (default: red)
+
+ neightbor: neighbor months dates color (default: nil)
+
+ Color names are as follows:
+
+ black, red, green, yellow, blue, magenta, cyan, white,
+ on_black, on_red, on_green, on_yellow, on_blue, on_magenta,
+ on_cyan, on_white, bold, underline, blink
+
+== Copyright
+
+ Copyright (c) 2010 Kyo Endo <http://d.hatena.ne.jp/keyesberry> released under the MIT license.
+

0 comments on commit 5ea9d0e

Please sign in to comment.