Click above to get retro games delivered to your door ever month!

                            Using the SOUP features


     GoldED  supports  import  and  export  of  the Internet SOUP packet
     format for e-mail and newsgroups.  Using this feature, you can  use
     GoldED as an offline reader  for Internet. The SOUP packet  format,
     version  1.2,  is  documented  in  the  SOUP12.DOC document by Rhys
     Weatherley <rhys@cs.uq.oz.au>.

     A SOUP packet consist of a number of packet files with an extension
     of  .MSG  plus  an  AREAS  file  which tells where each .MSG packet
     belongs. Other files may  be found in a  SOUP packet, but they  are
     not supported.

     A SOUP reply packet generated by GoldED consists of a  GOLDMAIL.MSG
     packet  file  for  e-mail  and/or  a  GOLDNEWS.MSG  packet file for
     newsgroups plus a REPLIES file which lists the .MSG packets.

     The  SOUP  import/export  features  are  currently activated from a
     submenu the arealist  scan menu (Alt-S).  The submenu item  is only
     present if SOUPIMPORTPATH and/or SOUPEXPORTPATH is defined.

     Below are the  keywords that are  relevant for the  SOUP support as
     currently implemented:

     SOUPIMPORTPATH <path>
        Path where incoming SOUP packet  files (AREAS and *.MSG) can  be
        found.

     SOUPEXPORTPATH <path>
        Path  where  outgoing  SOUP  reply  packet  files (REPLIES  and
        GOLD*.MSG) can be placed.

     SOUPEMAIL <echoid>
        Specifies the area where e-mails are placed.

     SOUPBADMSGS <echoid>
        Specifies the area where articles in unknown newsgroups are put.
        If you get articles tossed here by accident, you must move  them
        manually  to  the  correct  area.  If  the  badmsgs  area is not
        defined, the articles will silently disappear.

     SOUPNEWSRCFILE <file>
        Name with full path of the NEWSRC file which lists the
        newsgroups you are  connected to. GoldED  uses the list  to mark
        the matching areas as newsgroups. These will then be scanned for
        outgoing mail when starting a SOUP export.

     SOUPTOSSLOG <file>
        Name of a file where GoldED puts the echoids (newsgroup names)
        of each area where articles have been imported. The tosslog file
        is intended to be used with a replylinker. If no path is  given,
        it defaults to the GOLDPATH.

     SOUPREPLYLINKER <cmd>
        Commandline for a replylinker program to call after SOUP import.

     INTERNETADDRESS <internet-address>
        Specifies your Internet address. This must be the address only,
        no name. The INTERNETADDRESS and USERNAME will be combined to  a
        standard "From: internetaddresss (username)" headerline when you
        write e-mail or articles.

     INTERNETGATE [gatename<,>]<ftn-address>
        Specifies an FTN address which is used as the destination
        address in the FTN message  header. It is also the  address used
        in the  FSC-35 REPLYTO/REPLYADDR  kludges that  are inserted  in
        mail and news imported from SOUP packets.

     INTERNETMSGID <yes/no>
        Specifies whether the FTN MSGID kludge should contain an RFC1036
        compatible  Message-ID  or  the  normal  FTS-9 format. Note that
        using the RFC1036 format in MSGID breaks the FTS-9 (version 001)
        specification,  so  please  don't  use  this  feature in FidoNet
        netmail or echomail.  As a safeguard,  GoldED will only  use the
        RFC1036  format  in  areas  specifically  marked  as  e-mail  or
        newsgroups, using the  SOUPEMAIL and SOUPNEWSRCFILE  keywords or
        using the Email  and News area  types with the  AREADEF keyword,
        even when INTERNETMSGID is set to YES globally.

     INTERNETREPLY <yes/no>
        If set to yes (the default), GoldED uses the FSC-35 reply
        method, which puts UUCP  in the to-field and  a To: line at  the
        top of the message.  For use with SOUP,  this is ugly, so  it is
        recommended to set this keyword to NO. Note however, that due to
        limitations of  the header  field editor,  there is  currently a
        limit of 35 characters for the from and to headerfields.

     INTERNETRFCBODY <yes/no>
        Tells GoldED whether to look for and process RFC headerlines at
        the top of the message  body, before the first empty  line. Also
        tells GoldED to insert its own RFC headerlines at the top of the
        message body instead of as kludge lines. This option should only
        be used when  receiving Internet mail  as QWK packets  where the
        RFC headerlines are usually found at the top of the messages, or
        when sending Internet mail via  FTN packet to a gateway  running
        GIGO. GIGO does not recognize RFC header in kludges, but it does
        recognize them  at the  top of  the messages,  if it is properly
        configured (with  lines of  "Allow_Xxx:" in  GIGO's HEADERS.CFG,
        where Xxx are the  RFC headerlines the gate  administrator wants
        to allow).

     MAILINGLIST <echoid> <senderaddress> [contribution address]
        Defines one or more mailing lists. When importing e-mail from a
        SOUP packet,  GoldED will  look at  the Internet  address in the
        "Sender" header and if it matches one of the MAILINGLIST's,  the
        e-mail will  be tossed  to the  defined area.  Note that  GoldED
        supports only  participation in,  not hosting  of mailing lists.
        The contribution address is the destination Internet address for
        mail you write  to the mailing  list - the  address is typically
        given to you when you  subscribe to a list. If  the contribution
        address is not specified, the senderaddress is assumed.

        There are six different SOUP packet encoding formats. Four of those
        are supported by GoldED.

          u   USENET news articles                (import only)
          m   Unix mailbox articles               (import only)
          M   Mailbox articles in the MMDF format (not supported)
          b   Binary 8-bit clean mail format      (import and export)
          B   Binary 8-bit clean news format      (import and export)
          i   Index file only                     (not supported)

     The 'M' format is not yet  supported. If you need support for  this
     format, please let me know,  and send along an example  SOUP packet
     which uses the 'M'  format. There are no  plans to support the  'i'
     format in the near future.

     Articles are imported to the area matching the newsgroup name  (for
     example "rec.humor.funny" is  imported to an  area with the  echoid
     REC.HUMOR.FUNNY). E-mails are imported  to the area named  with the
     SOUPEMAIL keyword. If no matching  area can be found, the  articles
     are tossed to the area named with the SOUPBADMSGS keyword, with the
     newsgroup name in an AREA: line  at the top. If no badmsgs  area is
     defined, the articles will be silently thrown away.

     After import, the AREAS, *.MSG and *.IDX files are deleted from the
     SOUPIMPORTPATH. Be  sure to  keep backup  copies when experimenting
     with the SOUP feature. Note that there is currently no dupe check.

     In  the  imported  articles,  the  RFC headerlines are converted to
     kludges. The real names (if  any) in the From: and  To: headerlines
     are put into the message from/to  header fields. If no To: line  is
     found, "All" is used.

     When you  write or  reply to  e-mail and  articles, GoldED adds the
     echoid  (newsgroup  name)  and  message  number  to  a  file  named
     GOLDSOUP.LST  in  the  GOLDPATH.  This  file is used exclusively by
     GoldED to find outgoing mail when starting the SOUP export.

     There are three Internet specific template tokens:

        @oto          Original RFC "To:" headerline.
        @ofrom        Original RFC "From:" headerline.
        @omessageid   Original RFC "Message-ID:" headerline.

     With these tokens,  it is possible  to create templates  which look
     like one of  the defacto standard  attribution lines used  by other
     newsreaders. See the example NEWSGRPS.TPL file for examples.

     In e-mail and newsgroups, the ORIGIN keyword can be used to set the
     content of the "Organization:" headerline.

     The  Martin  Junius  <mj@sungate.fido.de>  MSGID.DOC  document   is
     supported. This means that  the Message-ID headerline is  converted
     to a MSGID kludge and the References headerline is converted to one
     or more  REPLY kludges.  This makes  MSGID/REPLY based replylinking
     possible  using   existing  FTN-based   utilities.  The    original
     Message-ID and References headerlines are preserved in the messages
     along with the MSGID/REPLY kludges.

     SOUP import and  export is currently  quite slow and  a some things
     are hardcoded that should be made  into options. There is a lot  of
     room for improvements, but this is a nice start for those who  want
     to read their  Internet mail and  news with their  favorite program
     instead of the various SOUP offline readers out there.

     For people with the IBM  OS/2 Internet Access Kit, I  can recommend
     the  "Souper"  program  which  can  make  SOUP  packets for offline
     consumption  instead   of  the   expensive  online   reading   with
     NewsReader/2  and  Ultimedia  Mail/2.  At  the time of writing, the
     latest version was SOUPER12.ZIP, ftp'd from hobbes.nmsu.edu.

     The SOUP features SHOULD NOT  be used with the GoldED  DOS version.
     Use  the  386  or  OS/2  versions.  The current implementation uses
     memory like a pig,  and in any case,  it is common that  very large
     messages (>64K) are seen in Internet e-mail and newsgroups, and the
     DOS version does not handle very large messages well at all.

     It  is  recommended  to  use  either  the JAM or the Squish msgbase
     formats to store the Internet newsgroups. These two formats support
     tree-like replylinking. JAM supports it best, with unlimited links.
     Squish only  supports up  to 9  links. GoldED  currently also  only
     supports up to 9 links, even for JAM.

     GoldED  understands  several  character  translation  standards and
     non-standards for  Internet e-mail  and newsgroups.  Please see the
     next chapter for details.

     PLEASE NOTE: GoldED can be used  purely for Internet use as a  SOUP
     packet reader, but there  are still some FidoNet-specific  keywords
     which must be  setup for GoldED  to operate correctly.  The ADDRESS
     and INTERNETGATE keywords must be set to a FTN-compatible  address.
     If you don't know  or care about any  such address, just use  this:
     "2:236/77.999" (leave out the quotes).


     Example setup in GOLDED.CFG:

          // Minimum FTN setup
          USERNAME        Odinn Sorensen
          ADDRESS         2:236/77

          // Basic Internet setup
          INTERNETADDRESS odinn@ibm.net
          INTERNETGATE    2:236/77
          INTERNETMSGID   YES
          INTERNETREPLY   NO

          // Basic SOUP setup
          SOUPIMPORTPATH  C:\SOUP\IMPORT\
          SOUPEXPORTPATH  C:\SOUP\EXPORT\
          SOUPNEWSRCFILE  C:\SOUP\NEWSRC
          SOUPEMAIL       NET_EMAIL
          SOUPBADMSGS     BAD_NEWS

          // Area definitions for e-mail and bad newsgroups
          AREADEF NET_EMAIL "E-Mail" 0 EMail Opus C:\SOUP\NETMAIL
          AREADEF BAD_NEWS  "Bad Newsgroups" 0 News Opus C:\SOUP\BADNEWS

          // Replylinking when using GEcho and JAM areas:
          SOUPTOSSLOG     C:\GECHO\IMPORT.JAM
          SOUPREPLYLINKER C:\GECHO\MBUTIL Link

          // Replylinking when using Squish and Squish areas:
          SOUPTOSSLOG     C:\SQUISH\SOUPTOSS.LOG
          SOUPREPLYLINKER C:\SQUISH\SQUISH LINK -fC:\SQUISH\SOUPTOSS.LOG

          // Setup of some mailing lists
          SOUPMAILINGLIST LIST.EMX  emx-list@eb.ele.tue.nl
          SOUPMAILINGLIST LIST.GIGO gigo-owner@gigo.com gigo@gigo.com

          // Area definitions for the mailing list areas
          AREADEF LIST.EMX  "EMX mailing list"  0 EMail Opus C:\SOUP\EMX
          AREADEF LIST.GIGO "GIGO mailing list" 0 EMail Opus C:\SOUP\GIGO

          // Setup of character translation
          XLATPATH        C:\GOLDED\XLAT\
          XLATESCSET      MNEMONIC IBMPC    MNE_IBM.ESC
          XLATCHARSET     LATIN-1  IBMPC    ISO_IBM.CHS
          XLATCHARSET     LATIN1QP IBMPC    IQP_IBM.CHS
          XLATCHARSET     MAC      IBMPC    MAC_IBM.CHS
          XLATCHARSET     IBMPC    IBMPC    IBM_IBM.CHS
          XLATCHARSET     IBMPC    LATIN-1  IBM_ISO.CHS
          XLATCHARSET     IBMPC    LATIN1QP IBM_IQP.CHS
          XLATCHARSET     IBMPC    MNEMONIC IBM_MNE.CHS

          // Main group for Internet newsgroups
          GROUP Newsgroups:
            MEMBER        alt.*, comp.*, misc.* news.*
            MEMBER        rec.*, soc.*, sci.*, talk.*
            MEMBER        bad_news
            EDITHARDTERM  YES
            QUOTECHARS    ":;|"
            TEMPLATE      INTERNET.TPL
            WHOTO         All
          ENDGROUP

          // Main group for e-mail, mailing lists and some danish
          // newsgroups with character translation
          GROUP EMail:
            MEMBER        net_email, list.*
            MEMBER        pingnet.*, dknet.*, dk.*
            EDITHARDTERM  YES
            TEMPLATE      INTERNET.TPL
            WHOTO         All
            XLATIMPORT    LATIN-1   ; Assume ISO-8859-1 is in use
            XLATEXPORT    LATIN1QP  ; Use MIME quoted-printable encoding
          ; XLATEXPORT    LATIN-1   ; Use MIME 8bit encoding
          ; XLATEXPORT    MNEMONIC  ; Use RFC1345 character mnemonics
          ENDGROUP


     Example INTERNET.TPL:

          @moved* Replying to an article in @oecho.
          @moved
          @changed* Changed by @cname, @cdate @ctime.
          @changed
          @forward* Forwarded from @oecho by @cname.
          @forward* Originally by: @ofrom, @odate @otime.
          @forward* Originally to: @oto.
          @message
          @forward
          @new
          @reply@ofrom wrote:
          @reply@position
          @comment@ofrom wrote:
          @comment@position
          @quotedIn article @omessageid, @ofrom wrote:
          @quoted@ofrom wrote:
          @quoted@position
          @quotebuf
          @quotebuf@ofrom wrote:
          @quotebuf
          @quote

          --
          Signature Signature Signature Signature Signature Signature
          Signature Signature Signature Signature Signature Signature


     Planned Internet/SOUP features:

        * Killfile.
        * Addressbook.
        * Article cancel.
        * Improved thread navigation.
        * Built-in replylinker/threader.
        * Elimination of FTN-requirements, for pure Internet use.
        * Msgbase format designed optimally for Internet and threading.
        * Your suggestions :-)