home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / miscutil / logman.lha / LogMan.doc < prev    next >
Encoding:
Text File  |  1992-10-13  |  10.4 KB  |  262 lines
  1.  
  2. ***************************************************************************
  3. *                                                                         *
  4. *                                 LogMan                                  *
  5. *                                                                         *
  6. *                               by Bob Rye                                *
  7. *                                                                         *
  8. *                    Public Release: Friday 25/09/1992                    *
  9. *                                                                         *
  10. ***************************************************************************
  11.  
  12. Everything contained in this release of LogMan for the Amiga is
  13. USE-AT-OWN-RISK. We, the authors, make no guarantee as to the fitness for
  14. use of this software. We accept no responsibility for possible damages
  15. incurred before, during or after execution of this software.
  16.  
  17.  
  18.  #### #    #### #### #### ####   #### #### #### ###    ##### #  # # ####   #
  19.  #  # #    #    #  # #    #      #  # #    #  # #  #     #   #  # # #      #
  20.  #### #    ###  #### #### ###    #### ###  #### #  #     #   #### # ####   #
  21.  #    #    #    #  #    # #      # #  #    #  # #  #     #   #  # #    #
  22.  #    #### #### #  # #### ####   #  # #### #  # ###      #   #  # # ####   #
  23.  
  24. *****************************************************************************
  25.  
  26.                    DID YOU PAY MONEY FOR THIS SOFTWARE?
  27.  
  28.                             LogMan is FREEWARE
  29.  
  30.  This software is FREEWARE. This software is free. If you have paid
  31.  money for this software, then you have been ripped off. I have written
  32.  this program for you, for free. If you paid for "support" from where you
  33.  got this file, then you are also being ripped off. There is only one
  34.  person who can fully help you with the operation of this program:
  35.  ME (Bob Rye, the guy who wrote this program.)
  36.  
  37.  You cannot obtain support from some unqualified desk-doofus hiding behind
  38.  the facade of "a support specialist". All that these people are doing is
  39.  making money from you, the innocent end-user, and ripping me off by
  40.  immorally making money from *MY* programs.
  41.  
  42.  Please take a stand against these companies. Please don't buy *FREE*
  43.  software from these companies. If you would like copies of any (or all)
  44.  of MY software (anything by Bob Rye) you can have them for *FREE*. That's
  45.  right, for nothing. All I ask for is a blank disk, to copy the programs
  46.  onto, and the cost of return postage (and your address!) Then if you want
  47.  "support" for my programs, send Fido Netmail to me (addresses are at the
  48.  bottom of this document) or snail-mail me and you'll get real support.
  49.  
  50.                           STAND UP AND BE COUNTED.
  51.  
  52.                       Say NO! to costly FREE software.
  53.  
  54. *****************************************************************************
  55.  
  56. If you represent a PD/Shareware/Freeware library or electronic distribution
  57. system, then please feel free to contact me to gain written permission to
  58. allow you to legally include this software in your library, for
  59. distribution. The "ADS" electronic distribution system has my written
  60. permission to redistribute this software, as does Fred Fish.
  61.  
  62. You may copy and transfer copies of this package to whoever you like,
  63. provided that this package is transferred completely intact, with all
  64. documentation and executables unmodified therein (modification of
  65. copyrighted works is called "contributory copyright infringement" and
  66. persons found infringing copyright are liable to legal action); however,
  67. if you represent a registered (or otherwise) company, and you wish to
  68. redistribute this package, you MUST obtain my written permission.  The
  69. copyright to LogMan, the documentation, the source-code, and the actual
  70. software remains the explicit property of Bob Rye, © 1988-1992 inclusive.
  71.  
  72. ANY commercial distribution of this package without the prior written
  73. consent of the author (Bob Rye) is expressly prohibited.
  74.  
  75.  
  76.  
  77.                                 DISCLAIMER
  78.                                 ¯¯¯¯¯¯¯¯¯¯
  79. ALTHOUGH OUTSTANDING BUGS IN THE CODE HAVE BEEN ELIMINATED, THERE REMAINS
  80. THE POSSIBILITY OF UNFORESEEN PROBLEMS. WE RESERVE THE RIGHT TO REFUTE THE
  81. EXISTENCE OF SUCH 'BUGS', BUT IF FOUND, WE WILL ATTEMPT TO FIX SUCH
  82. PROBLEM(S). IF, HOWEVER, UNFORESEEN BUGS ARE FOUND TO CAUSE YOU MENTAL
  83. AND/OR PHYSICAL ANGUISH, THEN THAT IS AS THEY SAY IN THE CLASSICS, BAD
  84. LUCK! WE ACCEPT NO BLAME FOR ANY LOSS OR INCONVENIENCE FOUND TO ARISE FROM
  85. THE (MIS)USAGE OF THIS PROGRAM. WE RESERVE THE RIGHT TO WITHDRAW SUPPORT
  86. AND UPGRADES AT ANY TIME. WE PROBABLY WON'T DO THIS, BUT WE HAVE THIS
  87. RIGHT.
  88.  
  89.  
  90. ALL INSTANCES OF COMPANY AND/OR PRODUCT NAMES ARE (C), (R) AND (TM)
  91. RESPECTIVELY, WHERE APPLICABLE.  "LogMan" ARE COPYRIGHT BOB RYE, 1988 -
  92. 1992 INCLUSIVE.
  93.  
  94.  
  95. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  96.  
  97. LOGMAN is a little tool which keeps it's eye on your logfiles.  If you're
  98. running a BBS, Foozle, or GCC (shame!) and/or Trapdoor, and you have
  99. multitudes of logfiles floating around your system, then LOGMAN is for you!
  100.  
  101. If you're like me, and you run a little point with Foozle and Trapdoor,
  102. then you're likely to have a logfile entry for at least one of these great
  103. programs. The logfiles can be fairly useful, once in a while, and to BBS
  104. sysops, they can be VERY important. But what if you don't check your
  105. logfiles for some time, and like me, you stumble onto them out of the blue?
  106. The logfiles can be HUMONGOUS, WHOPPING or just *AMAZING*. You know the one
  107. I mean. The 3-month old "TRAPDOOR.LOG" in your MAIL:LOGS/ directory. The one
  108. that weighs 340 kilobytes...
  109.  
  110. Anyhow, if you run a maintenance script at midnight, or lunch time or
  111. whenever, LOGMAN can slip right into your background activities without any
  112. need for checking by you.
  113.  
  114. What you need to do is this. You need to check your logfiles, and you need
  115. to figure out what you want to do with them when they hit a certain size.
  116. For instance, I want my "TRAPDOOR.LOG" archived away in my DH1:BAK
  117. directory, under the name of "TDLOGS.LHA" every time the "TRAPDOOR.LOG"
  118. file hits 128000 bytes of size.
  119.  
  120. The "TRAPDOOR.LOG" file is found in my MAIL:LOGS/ directory. I would then
  121. write a config file (by default titled "S:LOGMAN.cfg", case non-specific)
  122. and enter all of this information into it:
  123.  
  124. ; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  125. ; ** This is the name of the logfile I want checked
  126. MAIL:LOGS/TRAPDOOR.LOG
  127.  
  128. ; ** This is the size comparison that I want done (ie. 128000 bytes or bigger)
  129. >127999
  130.  
  131. ; ** Here are the action lines to be executed upon the above being TRUE
  132. lha -q a DH1:BAK/TDLOGS MAIL:LOGS/TRAPDOOR.LOG
  133. delete >nil: MAIL:LOGS/TRAPDOOR.LOG
  134. echo "Trapdoor's logfile is now under control!"
  135. echo "LOGMAN is GreetingWare!"
  136.  
  137. ; When you're finished describing actions to LOGMAN, end with "#"
  138.  
  139. #
  140.  
  141.  
  142. So, if my current "TRAPDOOR.LOG" is 126000 bytes in size, it wont be acted
  143. upon, during this pass. If you run Trapdoor later, and you get the busy
  144. signal for 39 minutes, and your TRAPDOOR.LOG file grows to 128334 bytes in
  145. size, LOGMAN will then act upon the TRAPDOOR.LOG actions when you later run
  146. LOGMAN.
  147.  
  148. Usage for LOGMAN is as follows:
  149.  1> LOGMAN {logman-cfg-name}
  150.  
  151. NOTE: You don't have to supply a cfg filename, as LOGMAN will first
  152. search for S:LOGMAN.cfg, although, if you DO specify a cfg filename, LOGMAN
  153. will attempt to use that cfg file instead.
  154.  
  155. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  156.  
  157. * The first "non-comment", and "non-blank" line must be the first
  158.   logfile's name, including the full path structure!
  159.  
  160. * The second such line must begin with a "<" or a ">" sign, which tells
  161.   LOGMAN just which way to act, and straight after this sign, you must
  162.   include your logfile-size preference. This works in this way:
  163.  - you may specify that you want actions taken on the preferred logfile
  164.    if the preferred logfile is SMALLER in size than the size that you
  165.    have nominated, or;
  166.  - you may specify that you want actions taken on the preferred logfile
  167.    if the preferred logfile is LARGER in size than the size that you
  168.    have nominated.
  169.  
  170. * This means that in the example below, the actions will only be made if
  171.   the file "vd0:trapdoor.log" is smaller than 40000 bytes.
  172.  
  173. * Only one entry per line is allowed.
  174.  
  175. * Also take care to include only one action per line.
  176.  
  177. * You can have as many actions per logfile as you like, so long as each
  178.   action line is a viable "executable" action line. That is, that the action
  179.   can be used in an AmigaDOS scriptfile and executed without error.
  180.  
  181. * You can stack more than one LOGFILE entry per cfg file.
  182.  
  183. * The "#" character tells LOGMAN to stop taking/making actions based on
  184.   the current logfile, and to continue with the next logfile, if one exists.
  185.  
  186.  
  187. vd0:trapdoor.log
  188. <40000
  189. lha -q a ram:logs vd0:trapdoor.log
  190. delete >nil: vd0:trapdoor.log
  191. #
  192.  
  193. * In this next example, the string "Hello! Look what happened" will be echoed
  194.   to the screen only if the file "LOGS:tick.log" is LARGER than 10000 bytes.
  195.  
  196. * The "#" character tells LOGMAN to stop taking/making actions based on
  197.   the current logfile, and to continue with the next logfile, if one exists.
  198.  
  199.  
  200. LOGS:tick.log
  201. >10000
  202. echo "Hello! Look what happened!"
  203. #
  204.  
  205.  
  206. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  207.  
  208.  
  209. THINGS YOU MUST REMEMBER!
  210.  
  211. 1. Comment lines and blank lines are allowed. A comment line is a line
  212.    which starts (in column 1) with the ";" semi-colon character. A blank line
  213.    is any line which ONLY contains a line-feed (the {return} key).
  214.  
  215. 2. LOGNAME, SIZE, ACTION and END lines *must* start in column 1 of the
  216.    config file.
  217.  
  218. 3. I personally run LOGMAN in a script like this:
  219.  
  220. ;;;;;;;;;;;;;;;;;;
  221. cd MAIL:
  222.  
  223. LOGMAN
  224. if WARN
  225.     quit 0
  226. endif
  227.  
  228. run foozle
  229. ;;;;;;;;;;;;;;;;;;
  230.  
  231. If LOGMAN fails to execute correctly, it will return WARN.
  232.  
  233. 4. LOGMAN is pure, re-entrant, and residentable.
  234.  
  235.  
  236. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  237.  
  238. Author contacts/bug reports etc.
  239. --------------------------------
  240.  
  241. Snail-Mail:
  242.    BOB RYE
  243.    11 BEAVER STREET
  244.    ST. ALBANS, VICTORIA
  245.    AUSTRALIA, 3021
  246.  
  247.  
  248. Bob's electronic mail addresses:
  249.    Bob_Rye@guru.apana.org.au (preferred)
  250.    3:633/359.7@fido          (preferred)
  251.    41:300/359.7@amiganet
  252.    42:8699/8.7@trinet
  253.    bobrye@csource.oz.au
  254.  
  255.    CRAZY DIAMOND 3:633/359@fido
  256.    Phone: [Intl. +61 3 5698873] [National 03 5698873] up to 14.4k
  257.    SysOp: Chris Quonoey
  258.  
  259. The latest PUBLIC version of LogMan will always be available on this BBS,
  260. in the Amiga files section.
  261.  
  262.