home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d564 / mscalendar.lha / MSCalendar / MSCal.doc < prev    next >
Text File  |  1991-11-21  |  10KB  |  236 lines
  1. ==========================================================================
  2. ============================== MSCal V1.10 ===============================
  3. ==========================================================================
  4.  
  5.                       A freeware Calendar-Utility from
  6.              Markus Stipp, (c) Copyright 1991 by Markus Stipp
  7.                            all Rights reserved
  8.  
  9. ==========================================================================
  10.  
  11.  First:  Sorry  for this documentation.  It is  not  so  detailed  as the
  12.  german one but I hope it tells you what you want to know about MSCal.  I
  13.  know, that my english is not as perfect as it should be,  but I hope you
  14.  will always understand what I mean. By the way, this is the first manual
  15.  I'm writing in english. Hope the next one will be better.
  16.  
  17.  The author will not be liable for any  damge arising from the failure of
  18.  MSCal to perform as described,  or any  destruction of other programs or
  19.  data residing on a system attempting to run the program. While I know of
  20.  no damaging errors,  the user of this program  uses it at his or her own
  21.  risk.
  22.  
  23. ==========================================================================
  24.                                C O N T E N T S
  25. ==========================================================================
  26.  
  27.         1. Introduction
  28.             1.1 Copyright
  29.             1.2 History of MSCal
  30.         2. Handling of MSCal
  31.             2.1 starting from CLI
  32.             2.2 starting from WorkBench
  33.             2.3 starting at boot-time
  34.             2.4 working with MSCal
  35.         3. Compiling
  36.         4. Various things
  37.         5. Author
  38.  
  39. ==========================================================================
  40.  
  41. ==========================================================================
  42.  1                               Introduction
  43. ==========================================================================
  44.  1.1                              Copyright
  45. ==========================================================================
  46.  
  47.  MSCal is freeware. It is not public domain but you may freely copy MSCal
  48.  if  this  description,  the  program  and  the  sourcecode  are included
  49.  unchanged into the distribution.
  50.  
  51.  The source-code is included in the archieve. It is not allowed to use it
  52.  in any  commercial way  (except if you contact me  and I will allow it).
  53.  The usage of some routines in non-commercial PD- or freeware-programs is
  54.  allowed if the author of MSCal is informed about this.  The usage of any
  55.  piece of the source-code in any military ways ist strictly forbidden.
  56.  
  57.  The distributor  may charge a fee to recover distribution costs. The fee
  58.  for diskette distribution should not be more than the cost to obtain the
  59.  same diskette from Fred Fish.
  60.  
  61.  The Author accepts little gifts and won't refuse any money. :-)
  62.  
  63. ==========================================================================
  64.  1.2                               History
  65. ==========================================================================
  66.  
  67.  I  often need  a  calendar-utility on  my AMIGA  because I don't like to
  68.  search for a "hardware-calendar" only to see what date the next saturday
  69.  is.  First I looked for  existing utilities but I haven't found any good
  70.  ones which work well with bigger fonts under Kick 2.0.
  71.  
  72.  Most programs displaying free  memory and a clock have the same problems
  73.  and often they use too much CPU-time.
  74.  
  75.  So I decided to  write my own utility which has (hopefully) none of this
  76.  problems.  The  result is  MSCal that  is combining  the  two  utilities
  77.  (calendar and memory/clock-display).  I hope  you will find it as useful
  78.  as I do.
  79.  
  80. ==========================================================================
  81.  2                            Handling of MSCal
  82. ==========================================================================
  83.  2.1                          starting from CLI
  84. ==========================================================================
  85.  
  86.  You can run MSCal from the CLI or from WB.  The call from CLI looks like
  87.  this:
  88.  
  89.       MSCal [option] [option] [...]
  90.  
  91.  Following options are available:
  92.  
  93.       -x###   ### is the x-position of the Calendar-Window
  94.       -y###   ### is the y-position of the Calendar-Window
  95.       -u###   ### is the x-position of the Clock-Window
  96.       -v###   ### is the y-position of the Clock-Window
  97.       -f      puts the Clock-Window always in front of all other windows
  98.       -b      calls DisplayBeep() at full hours
  99.       -i      starts with the Clock-Window
  100.  
  101.  If you  specify  an  unknown option  or type "MSCal ?" in the CLI, MSCal
  102.  will print  out a little help.  MSCal doesn't detach itself from the CLI
  103.  so you have to Run or RunBack it to do so.
  104.  
  105.  example usage:
  106.  
  107.       MSCal -x50 -u80 -i -f
  108.  
  109. ==========================================================================
  110.  2.2                       starting from WorkBench
  111. ==========================================================================
  112.  
  113.  To start MSCal from WorkBench just doubleclick its Icon.
  114.  
  115.  You may  specify a few ToolTypes as parameters for MSCal.  The following
  116.  ToolTypes are available:
  117.  
  118.       XPOS=###       ### is the x-position of the Calendar-Window
  119.       YPOS=###       ### is the y-position of the Calendar-Window
  120.       IXPOS=###      ### is the x-position of the Clock-Window
  121.       IYPOS=###      ### is the y-position of the Clock-Window
  122.       FLAGS=[Flags]  Following flags are available:
  123.                        FRONT    puts the Clock-Window always in front of
  124.                                 all other windows (like -f).
  125.                        BEEP     calls DisplayBeep() at full hours
  126.                                 (like -b).
  127.                        ICONIFY  starts with the Clock-Window.
  128.  
  129.  The flags may be combined with '|'. Following ToolTypes are valid:
  130.  
  131.       XPOS=-1 (open window as right as posible)
  132.       IYPOS=50
  133.       FLAGS=ICONIFY|FRONT
  134.  
  135.  The keywords should be capitals !
  136.  
  137. ==========================================================================
  138.  2.3                        startup at boot time
  139. ==========================================================================
  140.  
  141.  You may  want to place  MSCal in your startup-sequence.  To do this just
  142.  place one of the following lines in your startup-sequence:
  143.  
  144.       RunBack c:MSCal [option] [...]
  145.  
  146.  or
  147.  
  148.       Run >nil: <nil: c:MSCal [option] [...]
  149.  
  150.  Now the initial CLI could be closed without any problems.
  151.  
  152.  If you  are running  Kickstart 2.0 there is a better way to start MSCal.
  153.  Just put the  Icon of it into the WBStartup-Directory  and  include  the
  154.  ToolType  'DONOTWAIT'  to  the Icon.  This  tells WB not to wait for the
  155.  reply of the wbstartup-message.  All  other  ToolTypes  may  be  used as
  156.  described above.
  157.  
  158. ==========================================================================
  159.  2.4                         working with MSCal
  160. ==========================================================================
  161.  
  162.  All functions of MSCal are easily and quickly described.
  163.  
  164.  Key-Funktions:
  165.  
  166.   Cursor Up/Down:    This  increases / decreases  the  year by 1.  If the
  167.                      SHIFT-Key is pressed  the same time the year will be
  168.                      increased/decreased by 10.
  169.  
  170.   Cursor Right/Left: This  switches  to the next / previous month. If the
  171.                      SHIFT-Key  is pressed  at  the  same time MSCal will
  172.                      jump 3 months forward/backward.
  173.  
  174.   Key 'i'            This switches to the Clock-Window.
  175.   Key 't'            This switches to the Calendar of the current date.
  176.  
  177.  Mouse-Functions:
  178.  
  179.   Right Mousebutton: This is a switch between the Calendar- and the
  180.                      Clock-Window.
  181.  
  182.   Gadget:            The  field  which shows the current date is a Gadget
  183.                      with which you always  can switch to the Calendar of
  184.                      the current date.
  185.  
  186. ==========================================================================
  187.  3                              compiling
  188. ==========================================================================
  189.  
  190.  MSCal  was  developed  with the  registered version of DICE 2.06.18.  To
  191.  create  an  executable like  the  distributed  one  you  must  type  the
  192.  following command or just call dmake:
  193.  
  194.       dcc -ms -mc -md -mRR -r -2.0 cal.c -oMSCal
  195.  
  196.  You need the amigasr20.lib and the include files from Kickstart/WB 2.0.
  197.  
  198.  To create a german version of MSCal add '-D GERMAN' to the above call.
  199.  
  200. ==========================================================================
  201.  4                            various things
  202. ==========================================================================
  203.  
  204.  If you use MSCal please contact me.  I can be reached through one of the
  205.  adresses  given  at  the end  of this document.  I'm  always happy about
  206.  receiving mail. :-)
  207.  
  208.  Thanks going out to all guys who helped me to develop MSCal.
  209.  
  210.  If you have any Ideas to improve MSCal -> contact me !
  211.  
  212. ==========================================================================
  213.  5                                author
  214. ==========================================================================
  215.  
  216.  MSCal was written by:
  217.  
  218.  Markus Stipp
  219.  
  220.  Waldemeinestr. 35
  221.  DW-4902 Bad Salzuflen 1
  222.  Germany
  223.  
  224.  Tel: +49-5222-12862
  225.   or: +49-5254-7444
  226.  
  227.  E-Mail-adresses:
  228.  
  229.  Fido  : Markus Stipp@2:242/25.25
  230.  E-Mail: corwin@uni-paderborn.de
  231.  
  232. ==========================================================================
  233.                                   The End
  234. ==========================================================================
  235.  
  236.