Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Reference Manual for GoldED 2.51 - Norton Guide http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]

                             Using the QWK features


     GoldED supports import and export of the QWK offline packet  format
     for BBS conferences and Internet e-mail and newsgroups. Using  this
     feature, you can use GoldED as QWK offline reader.

     A QWK packet  consists of the  files CONTROL.DAT, MESSAGES.DAT  and
     possibly a number  of other files.  GoldED uses only  the two files
     mentioned, other files are ignored.

     A  QWK  reply  packet  generated  by  GoldED  consists  of the file
     <BBSID>.MSG,  which  contains  the  messages  that  you  wrote with
     GoldED. <BBSID> is the QWK  BBS identification name of the  BBS you
     use.

     GoldED  currently   doesn't  support   unpacking  and   packing  of
     compressed .QWK  and .REP  packets. You  must unpack  and pack your
     QWK/REP packets manually or using a batchfile.

     When  exporting  message  to  QWK  reply packetfiles, GoldED will *
     overwrite* any existing reply  packet (<BBSID>.MSG), so you  should
     not export until you are actually ready to upload your packet.

     After processing the CONTROL.DAT  file, GoldED writes a  file named
     <BBSID>.GLD in the  GOLDPATH. The file  is used by  GoldED to store
     the relationship between  conference numbers and  conference names,
     for  use  when  later  replying  or  entering new messages. For QWK
     export to work, you must  have previously imported a QWK  packet so
     that the <BBSID>.GLD file is created.

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

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

        QWKIMPORTPATH <path>
            Path where incoming QWK packet files (CONTROL.DAT and
            MESSAGES.DAT) can be found.

        QWKEXPORTPATH <path>
            Path where outgoing QWK reply files (BBSID.MSG) can be placed.

        QWKBADMSGS <echoid>
            Specifies the area where messages in unknown conferences are
            put. If you get messages tossed here by accident, you must move
            them manually to the correct area. If the badmsgs area is not
            defined, the messages will silently disappear. Messages tossed
            to the badmsgs area will have the control line
            "AREA:<bbsid>_<confno>" at the top of the message.

        QWKCONFMAP <bbsid> ["]<confname>["] <echoid>
            Defines the mapping between the BBSID and conference names in
            the QWK packets and the echoid name of the conference as
            required by GoldED. You MUST define a mapping for every
            conference that you subscribe to. If you don't, the messages
            will be tossed to the area defined by QWKBADMSGS or disappear.
            The <bbsid> is the name listed on line 5 in CONTROL.DAT after
            the comma. The <confname> is the conference names listed on line
            13 and on alternate lines onwards in CONTROL.DAT. If a
            conference name contains embedded spaces, the <confname> must be
            enclosed in double quotes, like this: "Main Board". The area
            <echoid> must be already defined either in an AREAFILE or using
            the AREADEF or AREA keywords.

         QWKTOSSLOG <file>
            Name of a file where GoldED puts the echoids 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.

         QWKREPLYLINKER <cmd>
            Commandline for a replylinker program to call after QWK import.

         QWKOPTIONS <bbsid> <options>
            Defines various options for the QWK support.

         INTERNETRFCBODY <yes/no>
            Enable this in areas with Internet RFC headerlines at the top of
            messages. See the "Using the SOUP features" chapter for details.

         CTRLINFO <tearline/origin/no>
            Enables or disables tearline and/or origin in random system
            groups.

     In  areas  where  INTERNETRFCBODY  is  enabled,  or RFC headers are
     present  as  FTN  kludges,  GoldED  will  convert  the  RFC headers
     Message-ID, References and In-Reply-To to MSGID and REPLY  kludges,
     so  that  MSGID/REPLY  replylinkers  can  be  used  instead of dumb
     subject  linkers.  GoldED  will  also  get  the full-length To/From
     /Subject lines and store them in the messages instead of the  short
     25 character  QWK fields.  Finally if  the INTERNETGATE  keyword is
     defined, GoldED will add  the FSC-35 kludges REPLYTO  and REPLYADDR
     in the messages.

     Example setup in GOLDED.CFG: (for Internet setup, see also the SOUP
     chapter).

        // Basic QWK setup
        QWKIMPORTPATH C:\QWK\
        QWKEXPORTPATH C:\QWK\
        QWKBADMSGS BAD_QWK

        // Replylinking when using GEcho and Hudson areas:
        QWKTOSSLOG     C:\GECHO\IMPORT.HMB
        QWKREPLYLINKER C:\GECHO\MBUTIL Link

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

        // Replylinking when using Squish and Squish areas:
        QWKTOSSLOG     C:\SQUISH\QWKTOSS.LOG
        QWKREPLYLINKER C:\SQUISH\SQUISH LINK -fC:\SQUISH\QWKTOSS.LOG

        // QWK conference mapping
        QWKCONFMAP GOLDWARE GoldED GOLDED
        QWKCONFMAP GOLDWARE "GoldED Beta" GOLDED.BETA
        QWKCONFMAP GOLDWARE "BBS Users" BBS.USERS
        QWKCONFMAP WHOKNOWS EMail EMAIL
        QWKCONFMAP WHOKNOWS dk.chat DK.CHAT
        QWKCONFMAP WHOKNOWS dk.test DK.TEST

        // Area definitions for the QWK conferences
        AREADEF BAD_QWK "Bad QWK msgs" 0 Echo Opus C:\QWK\CONF\BADQWK
        AREADEF GOLDED "GoldED support" 0 Echo JAM C:\QWK\CONF\GOLDED
        AREADEF GOLDED.BETA "GoldED beta" 0 Echo JAM C:\QWK\CONF\GOLDBETA
        AREADEF BBS.USERS "BBS Users" 0 Echo JAM C:\QWK\CONF\BBSUSERS
        AREADEF EMAIL "E-Mail" 0 EMail Opus C:\QWK\CONF\EMAIL
        AREADEF DK.CHAT "dk.chat" 0 News JAM C:\QWK\CONF\DKCHAT
        AREADEF DK.TEST "dk.test" 0 News JAM C:\QWK\CONF\DKTEST

        // Group for the EMAIL area
        GROUP EMAIL
          CTRLINFO        NO
          EDITHARDTERM    YES
          TEMPLATE        INTERNET.TPL
          INTERNETADDRESS odinn@whoknows.where
          INTERNETMSGID   YES
          INTERNETRFCBODY YES
        ENDGROUP

        // Group for the Internet newsgroups
        GROUP Newsgroups:
          MEMBER          dk.*
          CTRLINFO        NO
          EDITHARDTERM    YES
          INTERNETADDRESS odinn@whoknows.where
          INTERNETMSGID   YES
          INTERNETRFCBODY YES
          QUOTECHARS      ":;|"
          TEMPLATE        INTERNET.TPL
          WHOTO           All
        ENDGROUP


     Planned QWK features:

        * Support for BlueWave and perhaps other offline packet formats.
        * Support for compressed .QWK and .REP packets.
        * Built-in replylinker.
        * Your suggestions :-)

See Also: Configuration Keyword Reference

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson