home *** CD-ROM | disk | FTP | other *** search
/ Der Mediaplex Sampler - Die 6 von Plex / 6_v_plex.zip / 6_v_plex / DISK5 / DOS_17 / YACPU11.ZIP / YACPU.DOC < prev    next >
Text File  |  1992-08-03  |  13KB  |  361 lines
  1. ------------------------------------------------------------------------------
  2.             YACPU 1.1 - (C) Copyright 1991-1992 by Anders Ohlsson
  3. ------------------------------------------------------------------------------
  4.  
  5. PROGRAM
  6.  
  7.     YACPU - Yet Another Calendar Printing Utility for HP LaserJet III
  8.  
  9. VERSION
  10.  
  11.     1.1
  12.  
  13. COPYRIGHT
  14.  
  15.     YACPU is (C) copyright 1991-1992 by Anders Ohlsson
  16.  
  17.     YACPU is not public domain, share-ware, or free-ware. It's like-ware...
  18.     If you like it, send me a postcard, a dollar, or whatever you think
  19.     it's worth.
  20.  
  21. PURPOSE
  22.  
  23.     YACPU prints three kinds of planning calendars:
  24.  
  25.         1. Six-month calendars for the first or second half of a year
  26.         2. Monthly calendars
  27.         3. Weekly calendars
  28.  
  29.     Nine languages are currently supported (English, Swedish, German, French,
  30.     Spanish, Finnish, Norwegian, Italian and Latin).
  31.  
  32.     YACPU prints an optional title at the top, names of the months, days of
  33.     the week, and week numbers. Sundays and other holidays are highlighted.
  34.     Optional day quotes are printed in the day boxes. YACPU also prints the
  35.     moon phases and optionally the times for them.
  36.  
  37. THANKS
  38.  
  39.     Many thanks to all of you who sent me postcards, supported me with more
  40.     languages, Gauss Easter formula, moon phase formulas, suggestions and
  41.     other useful stuff.
  42.  
  43. HISTORY
  44.  
  45.     1.0 Initial release (1991-09-03)
  46.  
  47.     1.1 Released 1992-08-03
  48.  
  49.           - Added a monthly calendar
  50.           - Added a weekly calendar
  51.           - Holidays can now be on fixed dates, offset to Easter Day, or
  52.               on a given weekday after a given date
  53.           - Output is now sent to standard output
  54.           - Added moon phases and switches to control them
  55.           - Added switch for time zone, and for DST correction (both are
  56.               required for correct calculation of the moon phases)
  57.           - Added support for Finnish, Norwegian, Italian and Latin
  58.           - Spelled March correctly (used to be Mars)
  59.           - The user can specify the holiday file
  60.           - Added user specified day quotes
  61.           - Added switch to select paper size (A4/letter/legal)
  62.           - Added switch to highlight Saturdays
  63.           - Added switch to suppress highlighting of Sundays
  64.           - Added switch to suppress highlighting of holidays
  65.           - Added switch to suppress printing of week numbers
  66.  
  67. AUTHOR
  68.  
  69.     Anders Ohlsson
  70.     Tjadervagen 4
  71.     S-746 34 Balsta
  72.     Sweden
  73.  
  74.     InterNet: ao@elixir.e.kth.se, ao@octopus.tds.kth.se or ao@infovox.se
  75.  
  76. FILES
  77.  
  78.     Files included in this archive are:
  79.  
  80.           YACPU    DOC     - This file
  81.           YACPU    EXE     - The executable
  82.           HOLIDAYS TXT     - Sample holiday file
  83.  
  84.     The sample file is for Swedish holidays!
  85.  
  86. RECOMMENDED USE
  87.  
  88.     Put YACPU.EXE and HOLIDAYS.TXT in your utilities directory and make sure
  89.     you have your utilities directory in your PATH.
  90.  
  91.     Now you can run YACPU from any directory and it'll be able to find the
  92.     holiday file.
  93.  
  94. SYNTAX
  95.  
  96.     YACPU -c<calendar type> -d<date>
  97.           [-h<holiday file>] [-l<language>] [-p<paper size>] [-t<title>]
  98.           [-z<time zone>] [-S] [-D] [-s] [-H] [-Q] [-w] [-m] [-M]
  99.  
  100.     Output is sent to standard output. You probably want to redirect it to a
  101.     printer or a file, e.g.:
  102.  
  103.         YACPU -c1 -d19920803 > prn          (prints July-December, 1992)
  104.  
  105.     Required parameters:
  106.  
  107.       -c<calendar type>   1 - six-months, 2 - month, 3 - week
  108.       -d<date>            a date in the period for which you want a calendar
  109.  
  110.     Optional parameters:
  111.  
  112.       -h<holiday file>    the holiday file
  113.       -l<language>        en, sw, ge, fr, sp, fi, no, it or la
  114.       -p<paper size>      1 - A4, 2 - letter, 3 - legal
  115.       -t<title>           the title enclosed in quotation marks
  116.                           (Note: The title is not printed on weekly calendars)
  117.       -z<time zone>       the time zone (e.g. -z-5 gives GMT-5)
  118.  
  119.     Optional switches:
  120.  
  121.       -S                  highlight Saturdays
  122.       -D                  don't use DST correction
  123.       -s                  don't highlight Sundays
  124.       -H                  don't highlight holidays
  125.       -Q                  don't print the day quotes
  126.       -w                  don't print week numbers
  127.       -m                  don't print moon phases
  128.       -M                  don't print moon times
  129.  
  130.     Default values:
  131.  
  132.       <holiday file>      HOLIDAYS.TXT
  133.       <language>          English (en)
  134.       <paper size>        A4
  135.       <title>             the calendar year (and month for monthly calendars)
  136.       <time zone>         1 (GMT+1)
  137.  
  138.     (<...> denotes parameter names and [...] denotes optional parameters)
  139.  
  140. NOTES
  141.  
  142.     *  For correct calculation of the moon phases, the time zone and use
  143.        of DST correction must be correctly specified.
  144.  
  145.     *  en, sw, ge, fr, sp, fi, no, it and la are language initials and stands
  146.        for English, Swedish, German, French, Spanish, Finnish, Norwegian,
  147.        Italian and Latin respectively.
  148.  
  149.     *  Parameters can be typed in any order. You can even specify the same
  150.        parameter more than once (the last overrides the previous ones).
  151.  
  152.     *  You can use "/" instead of "-" as switch character if you wish. You can
  153.        mix them if you like.
  154.  
  155.     *  If you don't specify a title, the year will be printed at the top of the
  156.        calendar sheet. If you don't want a title, nor the year to be printed,
  157.        specify an empty title (i.e. -t"").
  158.  
  159.     *  ASCII 32-165 except 127,156-159 are currently supported. The width table
  160.        I use is not perfect, see the "SUPPORT" section below. Using characters
  161.        other than ASCII 32-165 may cause unpredictable results.
  162.  
  163.     *  This program is based on the Gregorian calendar. Concerning the intro-
  164.        duction of this calendar system in different countries, please consult
  165.        a history book. It should however work for all Western countries after
  166.        AD 1802.
  167.  
  168. EXAMPLES
  169.  
  170.     Print a calendar for Jul-Dec, 1991 in English:
  171.  
  172.         YACPU -c1 -d19910701 > prn
  173.  
  174.     Print a calendar for August, 1992 in Italian:
  175.  
  176.         YACPU -c2 -d19920801 -lit > prn
  177.  
  178.     Print a calendar for week #32, 1992 in Swedish:
  179.  
  180.         YACPU -c3 -d19920806 -lsw > prn
  181.  
  182.     Print a calendar for Jan-Jun, 2001 in German:
  183.  
  184.         YACPU -c1 -d20010101 -lge > prn
  185.  
  186.     Print a calendar for Jan-Jun, 1995 in English with a title:
  187.  
  188.         YACPU -c1 -d19950101 -t"Planning Calendar for 1995" > prn
  189.  
  190.     Print a calendar on COM2:
  191.  
  192.         YACPU -c1 -d19910701 > com2
  193.  
  194.     Print a calendar on D:\TEST\YACPU.OUT:
  195.  
  196.         YACPU -c1 -d19920101 > d:\test\yacpu.out
  197.  
  198.     Print a calendar using a different holiday file:
  199.  
  200.         YACPU -c1 -d19920701 -hd:\t\holidays -lit -p2 -z-6 > prn
  201.  
  202. HOLIDAYS AND QUOTES
  203.  
  204.     The holidays and day quotes are listed in a special holiday file. If YACPU
  205.     can't find this file, YACPU says so, but still prints the calendar. There's
  206.     one exception: If you specify a different holiday file with -h, and that
  207.     file doesn't exist, YACPU will say so, and no calendar will be printed.
  208.  
  209.     The holiday file is one of these:
  210.  
  211.         *  The filename specified with -h
  212.         *  HOLIDAYS.TXT in the current directory
  213.         *  HOLIDAYS.TXT in the directory where YACPU.EXE is
  214.  
  215.     That way, you can have YACPU.EXE and HOLIDAYS.TXT in your utilities
  216.     directory. If you have your utilities directory in your PATH, you'll be
  217.     able to run YACPU from any drive and directory and it'll still find the
  218.     holiday file.
  219.  
  220.     The holiday file is a text file used to specify dates to be highlighted
  221.     and day quotes to be printed. Holidays can be of three different types,
  222.     namely:
  223.  
  224.         1. Fixed dates, e.g. New Year's Day (January 1st)
  225.         2. A given weekday after a given date, e.g. Midsummer Day (the
  226.              Saturday after June 19th)
  227.         3. Offset to Easter Day, e.g. Good Friday (2 days before Easter Day)
  228.  
  229.     A few example lines in the holiday file could look like this:
  230.  
  231.         1  1  1  1        New Year's Day
  232.         2  2  6 18  5     Midsummer Eve
  233.         2  1  6 19  6     Midsummer Day
  234.         3  1 -2           Good Friday
  235.  
  236.     The first number is the holiday type as given above.
  237.  
  238.     The second number specifies how the day should be handled:
  239.  
  240.         1. The day counts as a Sunday and will be highlighted unless
  241.              -H or -s is specified.
  242.         2. The day counts as a Saturday and will only be highlighted if -S is
  243.              specified.
  244.         3. The quote will be printed unless -Q is specified. The day will not
  245.              be highlighted.
  246.  
  247.     The following numbers depends on the holiday type:
  248.  
  249.         1. Month and day.
  250.         2. Month, day and weekday (1 - Monday, 7 - Sunday)
  251.         3. Offset from Easter Day
  252.  
  253.     Now, the example lines above can be interpreted as:
  254.  
  255.         1. January 1st (counts as a Sunday)
  256.         2. The Friday after June 18th (counts as a Saturday)
  257.         3. The Saturday after June 19th (counts as a Sunday)
  258.         4. 2 days before Easter Day (counts as a Sunday)
  259.  
  260.     Note 1: The file format is rather user-unfriendly. Entries must be
  261.             in fixed columns as in the example files.
  262.     Note 2: No checking is done to see if the date is valid or not.
  263.     Note 3: Sundays are highlighted by default, you don't have to specify
  264.             these.
  265.  
  266. MOON PHASES
  267.  
  268.     The formulas used to calculate the phases of the moon are taken from
  269.     Jean Meeus excellent book, "Astronomical Formulae for Calculators",
  270.     second edition, 1982.
  271.  
  272.     To be able to print the moon bitmaps on the correct dates, YACPU needs
  273.     to know the time zone and if it should use DST correction. Specify the
  274.     time zone with -z. DST correction is on by default, turn off with -D.
  275.  
  276.     I checked the moon phases and times against an astronomical calendar for
  277.     1992, and they are correct down to +/- 2 minutes!
  278.  
  279. DST CORRECTION
  280.  
  281.     In Sweden we use Daylight Savings Time (DST) between the last Sunday
  282.     in March 2.00 AM, and the last Sunday in September 3.00 AM. If your
  283.     country uses other dates, please tell me, and I will add options for
  284.     this in later versions of YACPU, see the "SUPPORT" section below.
  285.  
  286.     Another problem with DST, could be different years of introduction in
  287.     different countries.
  288.  
  289. SUPPORT
  290.  
  291.     1. If you like this program and want to support it:
  292.  
  293.            Send me postcard, a dollar, or whatever you think it's worth.
  294.  
  295.     2. If you want this program to support more languages:
  296.  
  297.            Send me a letter (snail or e-mail) containing the following:
  298.  
  299.                1. The name of the language
  300.                2. The name of the months (January through December)
  301.                3. The name of the days (Monday through Sunday)
  302.                4. The word for "week" (used as a prefix before the week
  303.                   number)
  304.                5. The word for "notes" (used on the weekly calendar)
  305.  
  306.     3. If you find bugs or other problems with YACPU:
  307.  
  308.            Send a postcard, e-mail or a letter describing the problem
  309.            to me at the address given in the "AUTHOR" section above.
  310.  
  311.     4. If you want more dates to be highlighted by default:
  312.  
  313.            Send me a list containing these dates and how to determine when they
  314.            occur for a given year. E.g. Easter Day is the first Sunday after
  315.            the first full moon after Vernal Equinox, and can be calculated by
  316.            using Gauss' Easter Formula.
  317.  
  318. FORMATS
  319.  
  320.     In Sweden, weeks start on Mondays. If for instance, you want a calendar
  321.     where weeks start on Sundays, drop me a note and I will include this
  322.     feature either as optional or as a language dependent feature.
  323.  
  324. FUTURE
  325.  
  326.     *  Flag days with small flag symbols
  327.     *  Sun/moon rise/set times and switches for latitude and longitude
  328.     *  Support for more languages
  329.     *  Support for the full extended ASCII character set
  330.     *  User-friendlier file formats
  331.     *  And more...
  332.  
  333. FEED-BACK
  334.  
  335.     If you have any questions/comments relating to this program, please feel
  336.     free to send me mail or e-mail (e-mail is faster). See the "AUTHOR"
  337.     section above for the address.
  338.  
  339. DISCLAIMER
  340.  
  341.     You use this program at your own risk. In no event whatsoever, shall I
  342.     (the author of this program) be held responsible for any damage inflicted
  343.     by this program. (Damage is not very likely to be inflicted, I just want
  344.     to make sure that you don't blame me, should you accidentally overwrite
  345.     some of your other files, by redirecting output to COMMAND.COM or something
  346.     like that).
  347.  
  348. FEATURES (A.K.A. DOCUMENTED BUGS)
  349.  
  350.     *  Two or more quotes falling on the same day overwrite each other.
  351.        This will probably be fixed in future versions.
  352.  
  353. BUGS (A.K.A. UNDOCUMENTED FEATURES)
  354.  
  355.     If you find any, please let me know, and I will try to fix them.
  356.  
  357. ------------------------------------------------------------------------------
  358.             YACPU 1.1 - (C) Copyright 1991-1992 by Anders Ohlsson
  359. ------------------------------------------------------------------------------
  360.  
  361.