home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / c / cal26.zoo / cal.doc < prev    next >
Text File  |  1992-11-17  |  6KB  |  139 lines
  1. CAL     display a calendar      version 2.6
  2.  
  3. SYNOPSIS
  4.  
  5.         cal [-d] [[num_month] year]        (numerical arguments)
  6.         cal [-d] [word_month] [year]       (verbal month argument)
  7.  
  8. DESCRIPTION
  9.  
  10. Cal is an enhanced version of the unix cal command.  It is compatible to
  11. the unix version in that it uses the same input arguments and its output
  12. may be piped or redirected anywhere.
  13.  
  14. Cal displays a calendar for a specified year, a specified month and year,
  15. or for the current date.  By default, it displays a calendar for the current
  16. month, with the current day hilighted.  It correctly handles the transition
  17. from the Julian to Gregorian calendars in September 1752.
  18.  
  19. ARGUMENTS
  20.  
  21. A verbally-specified month may be entered without specifying a year in the
  22. argument list; however, a single numerical argument will be interpreted as
  23. a year.  Only the first 3 characters of the month name are significant for
  24. a verbally-specified month.  The command 'cal 10' refers to 10 AD, not
  25. October, and not 1910.
  26.  
  27. The -d switch is explained in the ENHANCEMENTS section below.
  28.  
  29. COMMAND EXAMPLES
  30.  
  31.         cal             display the current month
  32.         cal 1996        display the year of 1996
  33.         cal 9 1752      display the month of September 1752
  34.         cal sep 1752    same as above
  35.         cal January     display January of the current year
  36.         cal help        help message displayed for unrecognized arguments
  37.  
  38. ENHANCEMENTS OVER STANDARD 'CAL' COMMAND
  39.  
  40. If displaying the single-month format, cal will look for a file called
  41. cal.dat in the current directory and then in its own directory.  If found,
  42. cal will read the file, looking for special date descriptions for that month
  43. which will be displayed to the right of the calendar.  Up to eight special
  44. dates may be displayed per month.  If the current date happens to fall on
  45. one of these special dates, it will be flagged by an asterisk.  The special
  46. date descriptions specified in cal.dat are single lines, formatted so:
  47.  
  48. YYYY MM DD NW xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  49.  
  50. Where
  51. YYYY is the year,
  52. MM is the month (01 - 12),
  53. DD is the day (00 if the NW field is used),
  54. NW is the weekday-of-month code (00 if the DD field is used)
  55. xxxx... is the message, if longer than 50 characters it will be truncated.
  56.  
  57. The data MUST occupy the character fields as shown.  If YYYY is specified
  58. as -999, the month and day are assumed to be annual events such as holidays,
  59. and the description will be displayed for any year.  If MM is specified as
  60. -9, the day is assumed to be a monthly event for the specified year.  In the
  61. weekday-of-month code NW, N signifies on which weekday W the special date
  62. occurs.  For example, 31 indicates the third sunday.  Values of W range from
  63. 1 to 7, for Sunday to Saturday, respectively.  A value of 9 for N indicates
  64. "last" as in 95 for "last thursday."
  65.  
  66. A line in cal.dat must start with -999 or a 4-digit number to be considered
  67. as data.  The data lines may be in any order, but cal will stop reading the
  68. file once it finds eight dates for the month being displayed.  All special
  69. dates will be displayed in chronological order.
  70.  
  71. The -d commandline switch provides a way for MORE than eight date
  72. descriptions to be displayed.  This switch causes any date description older
  73. than today's date to be ignored, thereby giving room for other descriptions
  74. with future dates to be displayed.  As time progresses through the month,
  75. old descriptions are discarded and newer ones are used.  The -d switch
  76. affects only the current month display.
  77.  
  78. MS-DOS ENHANCEMENTS
  79.  
  80. Cal modifies the display attributes behind its output in order to display
  81. the calendar in attractive colors.  Display manipulation is not done if
  82. cal's output is redirected somewhere else.  When cal starts up, it looks
  83. for a file called cal.col, first in the current directory, and then in
  84. cal's originating directory.  The colors have defaults if the file is not
  85. found.
  86.  
  87. Example of a color definition file:
  88.  
  89. 15 02   video colors for month name
  90. 01 03   video colors for weekday header
  91. 07 01   video colors for normal calendar days
  92. 13 01   video colors for sundays
  93. 14 02   video colors for current day
  94. 07 06   background color for yearly calendar (the space between months)
  95. 11 00   video colors for special day descriptions
  96. 12 08   video colors for asterisk indicating that a description=today
  97.  
  98. FG BG
  99.  
  100. Color definitions must appear as above, as a two-character field for the
  101. foreground color, followed by a space, folowed by a two-character field for
  102. the background color.  The color definitions must start on the first line,
  103. and must not contain blank lines.  Comments may appear after the second
  104. field, provided that the total line length does not exceed 80 characters.
  105.  
  106. Possible colors:
  107.  
  108.         black           0
  109.         blue            1
  110.         green           2
  111.         cyan            3
  112.         red             4
  113.         violet          5
  114.         orange          6
  115.         light gray      7
  116.  
  117.         dark gray       8
  118.         bright blue     9
  119.         bright green    10
  120.         bright cyan     11
  121.         bright red      12
  122.         bright violet   13
  123.         yellow          14
  124.         white           15
  125.  
  126. Specifying a background color from 8 to 15 will result in a background
  127. color of 0 to 7, with flashing text.
  128.  
  129. AUTHOR
  130.  
  131.         Alex Matulich  -  uucp:     alex@bilver.uucp
  132.                           internet: alex%bilver@peora.sdc.ccur.com
  133.                                     alex@bilver.oau.org
  134.                                     alex.matulich@oau.org
  135.                           fidonet:  1:363/140, Alex Matulich
  136.  
  137.         (c) 1992 by Unicorn Research Corporation.  All rights reserved.
  138.         Inspired by an Amiga program by Gary L. Brant.
  139.