home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: SysTools / SysTools.zip / wcron2b4.zip / warpcron.doc < prev    next >
Text File  |  1998-06-17  |  13KB  |  350 lines
  1.  
  2.                       ┌───────────────────────────┐
  3.                       │ D O N ' T   P A N I C   ! │
  4.                       │          ;-)              │
  5.                       └───────────────────────────┘
  6.  
  7.  
  8.         !  New features / bugfixes are not in this docu now. !
  9.         !           See files "history" and "fixed".         !
  10.  
  11.                       !!! THIS IS THE OLD DOCU !!!
  12.       I'M WORKING ON A NEW DOCU IN HTML FORMAT, PLEASE LOOK IN THE    
  13.                  /DOC DIRECTORY AND BROWSE TO index.htm. 
  14.             I SUGGEST NETSCAPE OR OPERA TO USE THE HTML DOCU.
  15.                WEBEXPLORER DOESN'T SUPPORT COLOURED TABLES.
  16.  
  17.         NEW: http://sungate.fh-wedel.de with little 
  18.                      Warpcron homepage.
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27. Disclaimer
  28. ----------
  29.  
  30. THIS  SOFTWARE CARRIES NO   WARRANTY, EXPRESSED OR IMPLIED.  THE  USER
  31. ASSUMES ALL RISKS, KNOWN OR UNKNOWN, DIRECT OR INDIRECT, WHICH INVOLVE
  32. THIS SOFTWARE IN ANY WAY. IN PARTICULAR, THE  AUTHOR DOES NOT TAKE ANY
  33. COMMITMENT IN VIEW OF ANY POSSIBLE THIRD PARTY RIGHTS.
  34.  
  35. WarpCron 
  36. ────────┘
  37.  
  38.                                 WARNING
  39.  
  40. This is postcardware. It is not guaranteed to do anything, or
  41. not to do anything. Use it at your own risk. See disclaimer above.
  42.  
  43. Version: 2.0 alpha 1 xmas release
  44. Dated  : 24 December 1997
  45.  
  46.                    This docu is under construction! 
  47.  
  48.          ────────────────────────────────────────────────────────────
  49.  
  50. Now with grapical configuration program!
  51. Try the alpha version included in this package and share your
  52. expierences with others on the warpware mailing list!
  53.  
  54.          ────────────────────────────────────────────────────────────
  55. NEW!
  56. Mailinglist for warpcron and all other warpware products availible!
  57. Send a mail with "subcribe" in its body to warpware-request@deadend.argh.org.
  58. Then send mails to warpware@deadend.argh.org. 
  59.  
  60.          ────────────────────────────────────────────────────────────
  61.  
  62.  
  63. Description:
  64. ────────────┘
  65.  
  66. I've ever searched a good, small, textmode scheduler for my mailbox system
  67. running under OS/2 Warp. But I didn't find anything that suits me... every
  68. other scheduler is graphical (for PM) or cruel to configure, so I decided
  69. to write my own ;-).
  70. As time passes WarpCron is now in alpha for 2.0 and has a graphical config
  71. program (my first real project with sibyl).
  72. I still have many, many ideas for very nice and smart features and everything
  73. is only limited by my time ;-)
  74.  
  75. I'm very glad that some other people like my WarpCron (it's fantastic to
  76. get postcards from all over the world :-) ) and the more people like WarpCron
  77. the more I'll enhance it.
  78.  
  79. Features:
  80. ─────────┘
  81.  
  82.  * graphical configuration program
  83.  * smart but rich featured scheduler, just about 50KB!
  84.  * needs nearly no CPU-Time
  85.  * can kill started programs by other events
  86.  * can reread its config during runtime
  87.  * notices a config change and reread its config then
  88.  * can edit its config directly out of the program
  89.  * can start missed events at startup
  90.    f.e. an event should run at 12:30, but you shut down WarpCron at
  91.    11:00 and start it again at 14:00. Then WarpCron can run the missed
  92.    event when it starts.
  93.  * native textmode (no PM required! Perfectly for systems with low memory
  94.    and for example TShell)
  95.  * native 32bit OS/2 application (OS/2 2.x, 3.x. 4.x)
  96.  * can start OS/2-Window, OS/2-Fullscreen, OS/2-PM, DOS-Fullscreen and
  97.    DOS (Windows? Not tested ;-) ) applications
  98.  * can start applications every X minutes/hours/days/months
  99.  * can start applications NOT on a time interval
  100.    (do not run between 5:00 and 7:30 or so)
  101.  * can start applications on specific weekdays
  102.  * can start applications on a specific date
  103.  * can start applications on a semaphore (0-byte file)
  104.  * can start applocations NOT on a semaphore
  105.    (do not run if this file exists)
  106.  * can start applications manually
  107.  * can start applications minimized
  108.  * can start applications at startup and/or end of program
  109.  * writes log file with date/time
  110.  * automatically recognize a *.CMD as a progam, this means that you can
  111.    simply start a *.CMD like an EXE; you do NOT have to write
  112.    "cmd.exe /c start "bla.cmd" ".
  113.    WarpCron will do this automatically for you.
  114.  * WarpCron changes the directory when starting a program to the directory
  115.    which is specified in the event.
  116.    For example: PROGRAM          f:\utils\test\warprobot.exe
  117.    When starting this event WarpCron changes the current directory
  118.    to f:\utils\test.
  119.    Some programs require this.
  120.  * email support
  121.    WarpCron sends you an email if something happens (starting,
  122.    trapping...) or sends you the log of the day at midnight.
  123.    See warpcron.cfg and later this doc for details.
  124.  * supports 4os2 and 4os2 btm-files
  125.    Just use btm-files as normal exe-files ;-)
  126.  
  127.          ────────────────────────────────────────────────────────────
  128.  
  129. NEW FEATURES / BUGS FIXED
  130. ─────────────────────────┘
  131. See file "history".
  132. Bugs fixed: see file "fixed".
  133.  
  134.          ────────────────────────────────────────────────────────────
  135.  
  136. Getting started:
  137. ────────────────┘
  138. Start the wcrsetup.exe. It is an alpha version, but useable.
  139. I think it is self explained... but I will write a docu for it 
  140. when everything else is done. 
  141.  
  142. You can edit the warpcron.cfg manually; it's a plain text file. 
  143. But do so only if you really know what you're doing!
  144.  
  145. Hints:
  146.  * try 'warpcron ?' for param's info.
  147.  * try key 'h' for help on keys.
  148.  * if you want to use the "kill event" feature, you HAVE TO set
  149.    StartRelated to true!
  150.    But be warned! With this option set any active program started by
  151.    warpcron will be terminated if warpcron ends!
  152.  * make an event "unmissable" with an "unmissable true;" in its config.
  153.  * you can theoretically specify up to 99 events, but 23 lines on the screen
  154.    are not enough for 99 events ;-)
  155.    So WarpCron will change to 50-lines mode if you specify more than 18 events.
  156.  * for every weekday you can specify TRUE or FALSE; but in fact just the word
  157.    FALSE is recognized by the program; so you can write everything for TRUE or
  158.    simply write nothing.
  159.  * program types are:
  160.    "w" for OS/2-Window
  161.    "f" for OS/2-Fullscreen
  162.    "p" for OS/2-PM
  163.    "d" for DOS-Window
  164.    "D" for DOS-Fullscreen
  165.    "k" for a kill event (event name to kill as parameter)
  166.  * you can lock an event for writing into the logfile with the LOG <false>
  167.    statement
  168.  * CAUTION!
  169.    DO NOT specify a RunEveryXDay or RunEveryXMon without a DATE!!!
  170.    CAUTION!
  171.  * You CAN change your warpcron.cfg while WarpCron is running!
  172.    If you change it externally, simply press 'r' on WarpCron's window or
  173.    create a semaphore and WarpCron will reread it.
  174.    The path of the semaphore has to be specified in the warpcron.cfg.
  175.    Or change it directly via key 'c'.
  176.    WarpCron can notice a config change - and reread it's config then.
  177.    So you never have to end WarpCron... perfect for 24h-systems, eh?
  178.  * DoNotRunFrom and DonNotRunUntil AFFECTS ONLY events with a
  179.    RunEveryXMin or RunEveryXHour!
  180.  * if you want WarpCron to use 25 or 50 line modes permantly use
  181.    "LargeScreen true;" or "SmallScreen true;"
  182.  
  183. Keys in WarpCron:
  184.  h      help
  185.  c      change config file. WarpCron will start the specified editor
  186.         (keyword EDIT) with its config. When finished WarpCron will
  187.         reread its config.
  188.  CAUTION!
  189.         WarpCron is NOT ACTIVE during editing! Probably an event will
  190.         be missed!
  191.  e      show an event with all parameters
  192.  l      turn logging on / off
  193.  s      start an event right now
  194.  m      toggle short infos / long infos on screen
  195.  r      reread the config right now
  196.  w      show some internal parameters
  197.  q      quit program
  198.  
  199.          ────────────────────────────────────────────────────────────
  200.  
  201. Running DOS-programs
  202. ────────────────────┘
  203.  
  204. No problem.
  205. Just write a 'd' as ProgramType for DOS-window or a 'D' for DOS-Fullscreen.
  206. I don't know if this functions with windoze-programs too... but, who care's
  207. anyway? :-)
  208.  
  209. Email-Support
  210. ──────────────┘
  211.  
  212. WarpCron can send you an email with the log of the day or a message if 
  213. something happens. 
  214. In detail WarpCron can:
  215. - send you the log of the day
  216. - a mail when something causes WarpCron to trap
  217. - a mail when WarpCron starts and/or ends
  218.  
  219. This function uses the sendmail program. Every OS/2 with installed TCP/IP 
  220. (Warp 3 with InternetAccessKit, WarpConnect or Warp 4 with TCP/IP) has 
  221. it. Information about sendmail can be found in the TCP/IP documentation 
  222. of OS/2. 
  223. Sendmail has to be setup correctly before WarpCron can use it!
  224. To test sendmail you can write a textfile that contains:
  225. --- textfile ---
  226. To: your@email.address
  227. From: warpcron@somewhere
  228. Subject: test
  229.  
  230. that's a test!
  231. --- end of textfile ---
  232.  
  233. and save it, f.e. as test.txt . 
  234. Then you try to send it as email with sendmail with the following command:
  235. Warp 3: "sendmail -t -af test.txt"
  236. Warp 4: "sendmail -t -a test.txt"
  237.  
  238. Sendmail should start and send the email if it's configured correctly. 
  239. By the way: this is a function for bullet-proofed users who know what TCP/IP is
  240. and who have a network or internet-access. If you have a single machine you
  241. would not need it. So don't be sad if you're not able to setup sendmail...
  242. thousands of users became crazy because of sendmail.. ;-))))
  243.  
  244.          ────────────────────────────────────────────────────────────
  245.  
  246. Contact
  247. ───────┘
  248.  
  249. I'm looking forward for suggestions, critics, bugreports etc.!
  250.  
  251. Please mail to the warpware mailing list at warpware@deadend.argh.org.
  252. You subscribe to this list with a mail to
  253.   warpware-request@deadend.argh.org
  254. with "subscribe" as subject.
  255.  
  256. If you want to contact me personally:
  257. email: julian@deadend.argh.org
  258. fido : Julian Buss@2:240/5210
  259. fax  : ++49-4103-91 92 55
  260. BBS  :                 55 (V34)
  261.                        54 (ISDN)
  262. Newest WarpCron is always available via file request, magic "warpcron"
  263. at 2:240/5210 (V34) or 2:240/5211 (ISDN).
  264.  
  265. This address is valid until 1/1/98.
  266.  
  267.          ────────────────────────────────────────────────────────────
  268.  
  269. Money
  270. ─────┘
  271.  
  272. This program is postardware.
  273. If this program is the thing you ever want to have, please send me a nice
  274. postcard!
  275. Send it to:
  276.  
  277. Julian Buss
  278. WG "Zehn Vorne"
  279. Tinsdaler Weg 127
  280. 22880 Wedel
  281. Germany
  282.  
  283. This adress is valid until 1/1/98.
  284.  
  285. Then I will be *very* glad :-) and send you a code via email, and the "will
  286. I get a postcard..." will change and the startup time will be shorter.
  287.  
  288. A little hint for a "wanna-be" hacker: the reg code has something to do with
  289. the famous book "Hitchiker's Guide to the Galaxy"... if you find the code on
  290. you own, please let me know ;-)
  291.  
  292.          ────────────────────────────────────────────────────────────
  293.  
  294. My english
  295. ──────────┘
  296.  
  297. hey, it's not perfect, I know ;-)
  298. If you see a big bug in this text, please email me and I'll change it.
  299.  
  300.          ────────────────────────────────────────────────────────────
  301.  
  302. Guarantee
  303. ─────────┘
  304.  
  305. no guarantee for anything except the program will take space on your harddisk
  306. (but not much ;-) ).
  307.  
  308.          ────────────────────────────────────────────────────────────
  309.  
  310. Compiled
  311. ────────┘
  312.  
  313. with VirtualPascal 1.10. A damn good pascal compiler... I just love it!
  314. The exe-file is compressed with LxLite 1.18 to save space and enhance the
  315. startup time. If you don't know LxLite... try it! It's fantastic!
  316.  
  317. WcrSetup is developed with Sibyl, a very good delphi like compiler.
  318. If you're searching a "delphi for OS/2", take Sibyl. 
  319.  
  320.          ────────────────────────────────────────────────────────────
  321.  
  322. ToDo
  323. ────┘
  324.  
  325. - writing a better documentation ;-)
  326.   I plan to rewrite it as html with an html help system.
  327. - running an event on special times, f.e. on 3:00, 4:30 and 8:00 or so.
  328.   Like the scheduler in Xenia.
  329. - support memory semaphores, not just 0-Byte files
  330. - support for pipes, even in networks,
  331.   so that the output of the logfile cames through a pipe, too.
  332. - wildcards for semaphores ("*", "?")
  333. - DoNotRun with special dates/times (like a list)
  334.   Will be in 2.0.
  335. - global holidays / special days
  336.   Will be in 2.0.
  337. - ...
  338.   I have many, many other ideas... wait and see ;-)
  339. - your idea :-). Email me, if you have a good idea.
  340.  
  341. Ideas from users which I plan to implement:
  342. - a shutdown function which kills every VIO and DOS sessions and shuts
  343.   the OS/2 system down.
  344. - more than one semaphore per event
  345. - running events on every ultimo of one month
  346.  
  347.          ────────────────────────────────────────────────────────────
  348.  
  349. <Eof>
  350.