home *** CD-ROM | disk | FTP | other *** search
/ World of Ham Radio 1994 January / AMSOFT_1994.iso / misc / suntime / prog / sunchart.doc < prev    next >
Encoding:
Text File  |  1993-12-31  |  6.9 KB  |  152 lines

  1.                   Sun-Chart Version 1.2  by RejTech
  2.                   - - - - - - - - - - - - - - - - -
  3.                      Copyright(c) 1993, RejTech
  4.                             P.O. Box 721247
  5.                   Oklahoma City, Oklahoma 73172-1247
  6.  
  7.    OVERVIEW:
  8.    ---------
  9.       "SunChart"  is an add-on report generator for the SUNTIME.EXE
  10.       program from RejTech.  It is a DOS command line utility which
  11.       will produce a  report of sunrise/sunset/twilight times for a
  12.       user specified list of cities and dates.  Headings and fields
  13.       on the report may be adjusted by the user.
  14.  
  15.    OPERATION:
  16.    ----------
  17.       This program requires that the two data files (CITIES.DAT and
  18.       TIMEZONE.DAT) reside in the same directory with SUNCHART.EXE.
  19.  
  20.       A driver file which lists the cities and dates  to include on
  21.       the report is also required.  The report format is defined in
  22.       the SUNCHART.CFG file.   Program command line usage:
  23.  
  24.                        C:>SUNCHART driverfile
  25.  
  26.       The  program will read  "driverfile"  to determine cities and
  27.       dates to print on each line.   Output is  directed to the DOS
  28.       standard output  device (your monitor) and can  be redirected
  29.       to a file or printer as desired.
  30.  
  31.       Assuming that your  driver  file is named "SUNCHART.DRV", the
  32.       following command will redirect output to the printer:
  33.  
  34.                      C:>SUNCHART SUNCHART.DRV >PRN
  35.  
  36.    DRIVER FILE:
  37.    -----------
  38.       The driver file is a standard ASCII text file which lists the
  39.       cities and dates to print on the report:
  40.  
  41.                 Columns 1-24   = City name to print
  42.                 Columns 25-26  = blank
  43.                 Columns 27-36  = Date to print for this city.
  44.                 Column  37     = blank
  45.                 Columns 38-40  = Time Zone Overide
  46.  
  47.       City Name -  MUST BE SPELLED AND SPACED EXACTLY  as  it is in
  48.                    the "CITIES.DAT" file (case does not matter). If
  49.                    this field is left blank, the previous city will
  50.                    be computed for the new date specified,  however
  51.                    the city name will not print on the report.
  52.       Date      -  Must be the full 10 character date in the format
  53.                    specified in the  "SUNCHART.CFG" file (including
  54.                    using the same delimiter character).
  55.       Time Zone -  Use  this  to overide the time zone specified in
  56.                    the CITIES.DAT file.   This is useful for cities
  57.                    where the "AUTO-DST" flag is not set in the file
  58.                    (because they don't use the US standard) but are
  59.                    on daylight-savings time for the specified date.
  60.  
  61.       A sample driver file SUNCHART.DRV is supplied as an example.
  62.  
  63.                   Sun-Chart Version 1.2  by RejTech
  64.                   - - - - - - - - - - - - - - - - -
  65.  
  66.    CONFIGURATION FILE:
  67.    ------------------
  68.       The report format is determined by the SUNCHART.CFG file.  It
  69.       is a simple ASCII text file which may be edited with any text
  70.       editor to change the report appearance.    It must contains 3
  71.       seperate text lines:
  72.                  Line 1  =  Report Parameters
  73.                  Line 2  =  Report Fields
  74.                  Line 3  =  Heading Line 1
  75.                  Line 4  =  Heading Line 2
  76.                  Line 5  =  Heading Line 3
  77.                  Line 6  =  Heading Line 4
  78.  
  79.       The Parameter line must contain the following data:
  80.              Columns 1-3 =  Lines per Page (zero = continuous)
  81.              Column  5   =  Date Format:  Y = YYYY/MM/DD,
  82.                                           M = MM/DD/YYYY,
  83.                                           D = DD/MM/YYYY
  84.              Column  7   =  Time Format:  2 = 12hr (HH:MM Am),
  85.                                           4 = 24hr (HH:MM)
  86.              Column  9   =  Twilight time to use:
  87.                                       C = Civil Twilight,
  88.                                       N = Nautical Twilight,
  89.                                       A = Astronomical Twilight.
  90.              Column  11  =  Line spacing Between Cities (1-9)
  91.              Column  13  =  Line spacing for same City (1-9)
  92.              Column  15  =  Date Seperator Character (Default = '/')
  93.              Column  17  =  Time Seperator Character (Default = ':')
  94.  
  95.       Field definitions  consist of a one byte  "Field Code"  which
  96.       is immediately followed  by the length of the field to print.
  97.       The number of spaces between field definitions determines the
  98.       number of spaces between fields on the report.
  99.  
  100.       Field Codes:  C = City Name(max 24 bytes),
  101.                     Z = Time Zone(max 3 bytes),
  102.                     D = Date(max 8 bytes),
  103.                     R = Sunrise Time(max 8 bytes),
  104.                     S = Sunset Time(max 8 bytes),
  105.                     W = Dawn Time(max 8 bytes),
  106.                     K = Dusk Time(max 8 bytes),
  107.                     L = Sunlight Duration (max 5 bytes),
  108.                     T = Twilight Duration (max 5 bytes),
  109.                     B = Light Duration (Sunlight+Twilight) (max 5),
  110.                     N = Night(dark) Duration (max 5 bytes)
  111.  
  112.       Example:  if line  1 contains: 055 M-2-C-2-1
  113.                 and line 2 contains: C24  D8  R8  S8  Z3
  114.             - 55 lines will be printed on each page,
  115.             - Dates will be displayed in mm/dd/yyyy format,
  116.             - Times will be displayed in 12 hour format,
  117.             - Twilight times  will be computed using civil dawn and
  118.               and dusk,
  119.             - Lines will be double spaced between cities and single
  120.               spaced for the same city,
  121.             - Fields will print starting in column 1:
  122.                 CITY (for 24 bytes), 2 spaces, then the DATE (for
  123.                 8 bytes), 2 spaces, then the SUNRISE-TIME (8 bytes),
  124.                 2 spaces, then the SUNSET-TIME (8 bytes), 2 spaces,
  125.                 then the TIME-ZONE (3 bytes).
  126.  
  127.                   Sun-Chart Version 1.2  by RejTech
  128.                   - - - - - - - - - - - - - - - - -
  129.  
  130.    SOFTWARE LICENSE REGISTRATION:
  131.    ------------------------------
  132.       This program is supplied as a free add-on to the SUNTIME/ANYTIME
  133.       package by RejTech.  It is copyrighted and may not be altered or
  134.       sold except by RejTech.
  135.  
  136.  
  137.    WARRANTY:
  138.    ---------
  139.       This program is provided on an AS-IS basis WITHOUT warranty of
  140.       any kind.  As with all computer software, it may contain logic
  141.       errors which might give erroneous results.  RejTech will not be
  142.       held liable for any damages, whether direct or consequential,
  143.       arising from the use of this software.
  144.  
  145.       Please direct any comments or report any bugs to the address at
  146.       the top of this document.  You may also leave me a message on
  147.       CompuServe...
  148.  
  149.                                      -  Rob Jordan
  150.                                         CompuServe ID: 70515,722
  151.  
  152.