home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / uucp / KiwiElm.lha / README
Text File  |  1993-07-26  |  7KB  |  182 lines
  1. ELM for the Amiga
  2. =================
  3.  
  4. This is a direct port of unix Elm, and is intended for use as a mailer
  5. for InterNet connected BBS's. Although you can use this implementation
  6. of Elm on a single user system, Amiga Elm may be a better option for that
  7. situation.
  8.  
  9. Since there already exists a version of Elm for the Amiga, this port
  10. shall be known as the 'Kiwi'[see note 1] port in order to prevent
  11. confusion.
  12.  
  13. Or aims in doing this port were:
  14.  
  15. 1.  Ability to run Elm over a serial link.
  16.  
  17. 2.  Removal of security loopholes.
  18.  
  19. 3.  Generic BBS mailer functionality.
  20.  
  21. 4.  Compatibility with Unix Elm.
  22.  
  23. As a consequence of these aims some functions have been removed from Elm,
  24. primarily those which allowed shell access etc. We have also compiled without
  25. MIME support, since we didn't feel it would be useful on a BBS.
  26.  
  27. Since we run Elm on a DLG BBS, some of the scripts in this distributon
  28. reflect that. There should be no problems setting up Elm on other BBS's
  29. as Elm itself contains nothing which is BBS-specific.
  30.  
  31. Archive Contents
  32. ================
  33.  
  34. README                  This file.
  35. c/foreach               Used by mail_daemon and bouncemail
  36. c/gawk                  Gnu Awk, used by bounce
  37. c/move                  Move file, used by elm.batch and mail_daemon
  38. c/exec                  Allows execution of resident program or batch from DLG
  39. c/head                  Simple text-only head, used by bounce
  40. c/linefix               Format output of Dlgedit for elm, used by elm.edit
  41. c/localset              Same as Amigados SET, but can be run from DLG menuscript
  42. docs/Alias.man          Elm alias manunal
  43. docs/Beginners.help     Read this first for new users
  44. docs/Form.man           Elm form mode manual
  45. docs/Ref.man            Elm reference manual
  46. docs/Users.man          Elm users manual
  47. elm/elm                 The Elm executable
  48. elm/elm.batch           Sets up the environment for Elm.
  49. elm/elm.edit            Script to run an editor from within Elm
  50. elm/elm.sigset          Convert DLG signature to unix style .sig
  51. elm/elm.toggle          Switch .mailer between DLG and ELM
  52. s/bounce                Bounce all mail in bounce:
  53. s/bouncemail            Bounce one mail 
  54. s/get_sender.awk        Extract sender from mail, used by bounce
  55. s/mail_daemon           Sort out mail for DLG, Elm, and bouncing
  56. uulib/elm/elm-help.0    Online help files
  57. uulib/elm/elm-help.1    
  58. uulib/elm/elm-help.2 
  59. uulib/elm/elm-help.3 
  60. uulib/elm/elm.rc        Default system configuration file
  61.  
  62. Installation
  63. ============
  64.  
  65. Assign elm: to your elm directory, and install the support files in the
  66. appropriate directories. For security reasons the scripts reference
  67. executables using explicit paths. You will have to change these if you
  68. put the files somewhere else.
  69.  
  70. Edit elm:elm.batch and change NODENAME and DOMAIN to reflect your site.
  71. Change ELM_TZ to suit your timezone [you must have a timezone!!].
  72.  
  73. Edit elm.edit to suit the editor you wish to use.
  74.  
  75. If you wish to use the bouncemail script you will have to write a script
  76. similar to mail_daemon which moves mail to be bounced into bounce:
  77.  
  78. Elm expects your incoming mail to be put in uumail:
  79.  
  80. Care should be exercised when modifying the uulib:elm/elm.rc file. This is
  81. used as a template for all user elmrc files, and some of the security
  82. depends on settings in this file [e.g. it is possible by modifying this file
  83. to allow users to select their own mail directories etc]. Since the Amiga
  84. does not have the security features of unix, an incorrectly configured
  85. elm.rc file could provide a big security loophole. Similarly you should
  86. not allow users to edit their own elmrc files.
  87.  
  88. DLG Installation
  89. ================
  90.  
  91. How you call Elm will depend on your setup. I call elm.batch from an Arexx
  92. script as I need to do some conditional stuff before running Elm. If
  93. you want to run elm.batch directly from a DLG menu the easiest option would
  94. be to set up as an executable which runs exec which runs elm.batch,
  95. passing the appropriate parameters. For example:
  96.  
  97. c:exec elm:elm.batch %uname %alias %sclength %scwidth
  98.  
  99. Another option would be to use a menu script which calls a batch file for
  100. everything between 'elm.sigset' and 'elm' and uses exec as above to run elm.
  101. You would also need to use exec or a batch file to do the 'resident elm 
  102. remove' as you can't execute an internal command from a menu script.
  103. For example:
  104.  
  105. EXE localset NODENAME foobar
  106. EXE localset DOMAIN .blarg.wibble
  107. EXE localset REALNAME "{real}"
  108. EXE localset USERNAME {name}
  109. EXE localset HOME user:{name}
  110. EXE localset LINES {lines}
  111. EXE localset COLUMNS {cols}
  112. EXE localset EDITOR elm:elm.edit
  113. EXE localset ELM_TZ NZST12
  114. EXE elm:elm.sigset
  115. BATCH elm:elm.setup
  116. EXE exec -s 20000 elm:elm %uname %alias %sclength %scwidth
  117. EXE exec resident elm remove >nil:
  118. EXE exec echo "*E[0;0H*E[J" ; clear screen
  119.  
  120. Where elm:elm.setup contains the portion of elm.batch between 'elm.sigset'
  121. and 'elm'.
  122.  
  123. If you're running a single line system you may want to remove the resident
  124. stuff.
  125.  
  126. You will have to decide if you wish to run Elm exclusively, or if you will
  127. let users use DLG for uucp mail as well. The scripts supplied are set up
  128. a system using both mailers. If you use Elm exclusively things will be
  129. simpler.
  130.  
  131. Using DLG and Elm mailers
  132. =========================
  133.  
  134. In order to support both the DLG and Elm mailers, you will need to create
  135. a .mailer file in each users home directory, which simply contains:
  136.  
  137. DLG
  138.  
  139. Provide a menu option which calls elm.toggle - the mail_daemon script
  140. provided will handle mail appropriately depending on how the user has
  141. their .mailer set. Mail addressed to users who do not have .mailer
  142. files will be bounced, so you can use the existence of this file to
  143. determine who can receive uucp mail. Remember to create this file
  144. for new users!
  145.  
  146. Create two new assignments, bounce: and xxmail: - these should both be
  147. in separate directories. Use a hex editor to patch dlg:uucp2dlg so that
  148. each instance of uumail: is changed to xxmail:
  149.  
  150. Set up mail_daemon to be run periodically by cron.
  151.  
  152. Problems?
  153. =========
  154.  
  155. If your screen display shows ridiculous numbers instead of a valid date,
  156. make sure you are setting the ELM_TZ variable to something sensible.
  157. e.g. NZST12
  158.          ^^ Hours ahead of GMT
  159.      ^^^^ Timezone [3 or 4 characters]
  160.  
  161. If all your posts are coming from <name>@foobar.blarg.wibble, change the
  162. NODENAME and DOMAIN settings from the defaults.
  163.  
  164. If you don't have a domain address, get one!
  165.  
  166. We have been using Elm on our BBS for several weeks without problems,
  167. nevertheless it is possible that you may find some bugs.
  168.  
  169. Please report all bugs and problems to:
  170.  
  171. Geoff McCaughan <geoff@equinox.gen.nz>
  172.  
  173. Mark Tomlinson <mark@garden.equinox.gen.nz>
  174.  
  175. Notes
  176. =====
  177.  
  178. 1. For the benefit of the terminally confused, we observe here that the
  179. Kiwi is the national bird of New Zealand. Referring to a Kiwi as a fruit
  180. while using this program will result in all your disks being erased.
  181.  
  182.