home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume40 / plod / part01 / README < prev   
Text File  |  1993-11-02  |  4KB  |  101 lines
  1. PLOD is a tool designed to help administrators (and others) keep track
  2. of their daily activities.  Since your management will typically have
  3. no idea what you are doing to justify such an exorbitant salary (any
  4. amount of money they may be paying you being classified as
  5. "exorbitant"), and since most people forget what they do themselves,
  6. it's good to keep a record.  Trot your logs out around performance
  7. review time, and show them to your management (after suitable
  8. sanitization) on a regular basis.
  9.  
  10. The interface is designed to make it quick to dash off a simple note
  11. to yourself.  Since most folks who are going to use PLOD also use
  12. email, I've based the interface on Berkeley mail-- tilde escapes and
  13. all (for a list of escapes, try ~h or ~?).  By default, your logs will
  14. be encrypted using the /bin/crypt command-- not secure in the least,
  15. but marginally safe from casual browsing (I tend to vent into my logs
  16. sometimes rather than at those who might be offended and fire me).
  17. You can turn off the encryption if you find it more a hassle than a
  18. comfort.
  19.  
  20. Which brings us to the subject of customization.  Many escape
  21. sequences and variables have already been defined, but you can make
  22. your own changes using your ~/.plodrc file.  This file is interpreted
  23. using eval(), so any valid Perl syntax is acceptable.  Variables may
  24. be customized by editing this script directly, setting an environment
  25. variable with the same name as the PLOD variable, or by doing an
  26. assignment in your .plodrc (.plodrc value supersedes environment value
  27. which beats default value in script).  New tilde escapes may be
  28. defined by assigning a type glob, say *foo, to the global array
  29. %funcs-- the index of the type glob in the array being the character
  30. (single chars only!) of the escape sequence.  &foo should be a
  31. function which performs the escape (any arguments after the escape are
  32. passed in as a single string in @_), and $foo can be a descriptive
  33. help string (see &helpuser()).  Your functions may reference any of
  34. the PLOD customization variables as well as the list @lines, which
  35. contains all information in the current log entry (including the
  36. date/time stamp PLOD adds to the beginning of each entry).  For
  37. examples, consult the PLOD source code or the manual page.
  38.  
  39. PLOD is a living, growing entity.  If you have suggestions for
  40. improvements or new features, or find any bugs, please send them to me
  41. via email.  Share and enjoy!
  42.  
  43. Hal Pomeranz, pomeranz@aqm.com
  44.  
  45. ===============================================================================
  46.  
  47. History:
  48.  
  49. v1.0 (Original release to comp.lang.perl)
  50.  
  51.  
  52. v1.1 (Second release to comp.lang.perl)
  53. ** &pipetocmd() unlinks all temporary files it creates (Pomeranz)
  54.  
  55. ** Variable assignment idiom cleaned up (Rantapaa)
  56.  
  57. ** LOGDIR and HOME are only prepended to LOGFILE and DEADLOG after
  58.    .plodrc has been eval-ed and if LOGFILE and DEADLOG are relative
  59.    paths.  This means that you can change LOGDIR in your .plodrc and
  60.    really affect where the log files go. (Rantapaa)
  61.  
  62. ** eval of .plodrc is done with "do" rather than "cat" (Rantapaa)
  63.  
  64. ** You can now do quick one-liner entries on the command line, e.g.
  65.    "plod Completed modifications to PLOD" (Rantapaa)
  66.  
  67. ** Time/date stamp only printed if user is entering info directly from
  68.    a tty (Rantapaa)
  69.  
  70. ** PLOD attempts to create logging directory if it does not exist (Ellis)
  71.  
  72.  
  73. v1.2 (not publicly released)
  74. ** Page/Edit/Visual log files from interactive mode or from the shell
  75.    (Tizard)
  76.  
  77.  
  78. v1.3 (comp.lang.perl again, and also comp.sources.misc)
  79. ** Multi-line Perl input function, ~M (Crabb)
  80.  
  81. ** Manual page generated (Pomeranz)
  82.  
  83.  
  84. v1.4 (not publicly released)
  85. ** Trap for empty log entries and don't add them to log file (Pomeranz)
  86.  
  87. ** -C flag to cat logfile to STDOUT (Prestemon)
  88.  
  89. ** /etc/plodrc (Lachowski)
  90.  
  91. ** $STAMP customization variable (Lachowski/Pomeranz)
  92.  
  93.  
  94. v1.5 (not publicly released)
  95. ** Trap for non-existant/zero size/non-executable CRYPTCMD
  96.  
  97.  
  98. v1.6 (current)
  99. ** Minor fix to above trap.  Would have been part of v1.5 but I had already
  100.    distributed v1.5 to a few people.
  101.