
 Kivi QWK reader v2.00
                        Kivi QWK reader v2.00
  1  Offline readers                       3 Menu
     1.1  What is offline reading?           3.1  Kivi QWK 
                                             3.2  File 
  2  Kivi QWK reader                         3.3  Activity 
     2.1  The idea behind Kivi QWK           3.4  Options 
     2.11 General information                3.5  Window 
     2.2  Shareware                          3.6  Sort 
     2.3  Installation                       3.7  Help 
     2.4  Quick start 
                                           4 Other
                                             4.1 Signature
                                             4.2 Taglines
                                             4.3 Kill
                                             4.4 The file: Kivi.BBS 
                                             4.5 Toolbar
Kivi QWK made by Arto Jalkanen               4.6 History

            Documentation by: Jari Paajanen & Teemu Hukkanen

1  Offline readers

    1.1    What is offline reading?

        The idea of offline-reading is to save online time. You
        don't have to spend so much time on the BBS and so you will
        save in phonebills. The system is simple, you just call a BBS
        and ask it to send your messages as a file. After you've
        downloaded the message-packet, you just start your offline-
        reader and load the messages into it. Then you can read them,
        and reply to the messages, if you want to and then send the
        reply packet back to the BBS.
           The most common offline reader-type is QWK. It is sup-
        ported by nearly every BBS nowadays. There's also a few other,
        not so commonly used offline-types: OMEN and MBBS.

        This is where Kivi QWK comes in.





 The idea behind Kivi QWK

2.1 The idea behind Kivi QWK

        The Original idea behind Kivi QWK was to make a good
        MultiTOS compatible QWK-reader, since the existing QWK readers
        didn't work with MultiTOS.
        Kivi QWK is supposed to be an easy-to-use, MultiTOS and
        generally everything else compatible, very stable and well
        documented QWK-reader.


       Disclaimer:
       
        Kivi QWK has no warranty, if it would damage your software,
        hardware, relationship, reality or mind, the author has no
        responsibility whatsoever. I (the writer of this document)
        have used Kivi QWK for months without any major (or even
        minor) damage.

2.11 General information about Kivi QWK reader

        Kivi QWK supports the Drag & Drop protocol, so you can
        drop a .QWK -file to any of Kivi's windows and it will be
        loaded immedeatly. The QWK packet name can also be obtained
        from the command-line.

2.2    Shareware

        Kivi QWK is shareware. This means that the program can be
        freely spread, copied and tested, but if you continue using
        this program, you have to register. You should register by
        sending 60 FIM, 13 GBP, 25DM, 80ff or 15USD and your name and
        address to the author, Arto Jalkanen, or to the proper Shareware
        support (no cheques to the author). Your personal registration
        key-file is then sent to you, possibly along with the latest
        version of Kivi. When you have the key-file, Kivi QWK will not
        display the info dialog for around 8 seconds every time you
        start it, as it does, if you've not registered, and therefore
        you don't have to look at that horrifying face every time you
        start Kivi QWK. (The author thinks that, that might be a good
        reason to register :) )
           If you have access to Internet, please tell your e-mail
        address, because it would be safer to send the key via
        Internet.

           You can always find the latest version of Kivi QWK in:
               Heavy Fuel BBS
               +358 (0)9 2952229
               v.32bis    Open: 24H/day
               SysOp: Pertti Ahola

        Send the registration to:

                    Arto Jalkanen
                    Everstinkuja 6 C 45
                    02600 Espoo
                    Finland

        Shareware Support for Kivi:

        Sweden:

        The Swedish fee will be 100 SEK.
            I am: Dag Dao

            Sysop Dada & Surrealismus +46 40 302993

            dag.dao@dada.ct.se

            2:200/136.0fidonet.org
            90:1102/116.0nest.ftn

            Phone:       +46 40 304993
            Snailmail:  ngelholmsgatan 12
            S-214 22 Malm
            Sweden

        UK:
            Users in the UK can register to Denesh Bhabuta. Please make
            cheques and Postal Orders for the sum of #13 Sterling
            payable to Denesh Bhabuta, and send to:

            CyberSTrider
            PO Box 78
            Manchester
            M21 8SJ
            Uk

            EMail: dbhabuta@cix.compulink.co.uk
                   denesh@cyberstrider.org

	    Latest versions of Kivi can be downloaded from the web at URL:
	    http://www.cyberstrider.org/
	    	

        US and Canada:
        
            Users in the US and Canada can register to Jeff Wisniewski.
            He will be handling all Shareware Registrations/Distribution
            of Kivi QWK in the United States and Canada.

            You can contact him at the following addresses:

            Jeff Wisniewski
            P.O. Box 1243
            Newtown, PA  18940-0871

            GEnie: J.WISNIEWSK2
            Internet: Jeffrey.WisniewskiMicroserve.com
                      dragons-egggenie.com


        You can also register by transferring money directly to
        the authors bank account. Unfortunately, because of bank
        fees, you have to transfer 80 FIM, or 1.15 times the
        normal prize in your currency.
        Transfer money to:

                    SWIFT PSPB FIHH
                    800027-11955186
                    Arto Jalkanen
                    Everstinkuja 6 C 45
                    02600 Espoo
                    Finland
                    (And don't forget to tell your address too.)

        And then something in finnish (sorry foreigners :-( ).

        Suomessa tarvitsee maksaa vain 60mk tilille ja tili on:
                   PSP 800027-11955186
        Ja oma osoite pit ilmoittaa!

2.3    Installation

        Installing Kivi QWK is very easy, you just need to put
        the files, KIVI.PRG and KIVI.RSC, in the same directory.
        And KIVI.PRG doesn't have to have the same name, you can
        change it to .APP, .GTP or even to something else, like
        ABC.APP.
          Then you have to start the reader and configure it. Go to
        the 'Options' menu and select 'General'. If you're using a
        colour monitor, activate the 'Use colours' switch. Then select
        the 'Packers' item, again from the 'Options' menu. Now double
        click on the 'Path' of a packer. You get a fileselector, and
        you should find the packer and select it. Of course put Lharc,
        Zip and Arc to their corresponding paths. You can also type
        the complete path and filename of the packer.
           Now select 'Editor' from the 'Options' menu. Click on the
        'Path'-item, and put your favourite text (ascii) editors path
        and filename in there.
           Now you are ready to load your QWK packet.
        Other options can be changed, but these are necessary for the
        reader to function properly. If you want to change other
        options, read the chapter 3.4 'Options menu'.

2.4    A quick start to reading and replying

        First you have to download a QWK packet from a BBS, and how
        it's done, depands on the BBS software used. Read the help
        files of the BBS and if you still don't know how to download a
        packet, ask the SysOp for help.
        After you've downloaded the packet, start Kivi QWK (You did
        configure Kivi, didn't you? If not, read  chapter 2.3 LINK Installation ). Now
        select the ' Load packet LINK File -menu 4 ... item in the File menu. You get a
        fileselector, and now you should select the QWK packet you've
        downloaded. Kivi QWK identifies the packer used in the packet
        and executes the right packer to depack the files. After the
        depacking Kivi reads the files and then opens a window
        containing the message area names and number of messages and
        unread messages in the areas. Now select an area by moving the
        cursor on an area, where there is messages and pressing enter,
        or by double clicking on a name with the mouse.
        Now you get a list of messages in the area you just
        selected. You can see there the sender, receiver and the
        subject of the message. Now select a message by moving the
        cursor on it with the cursor keys and pressing enter, or
        double click on a message with the mouse. You can get back to
        the list of the areas by pressing <ESC> or clicking on the
        close box of the window.
        Now let's try to reply to that message. Select the  Reply LINK Activity -menu 48 
        item in the Activity menu, then you get a dialog box
        containing your name, the receivers name and the subject of
        the message. Just leave all those alone and press the OK
        button. Now the editor you've chosen is loaded and the message
        you're replying to is given with the quote characters in the
        beginning of every line. Now write your reply, and save the
        text and exit the editor. You can now see the messages in the
        'Own messages' window by selecting  List own LINK Activity -menu 93  in th activity
        menu.

3    Menus

       3.1  Kivi QWK  
       3.2  File  
       3.3  Activity  
       3.4  Options  
       3.5  Window  
       3.6  Sort  
       3.7  Help  

3.1    Kivi

       Info...

        Here is the info dialog of Kivi QWK. (Which you have to, by
        the way, watch for around 8 seconds when starting Kivi, if you
        haven't registered.)

       And then below are the possible accessories you've loaded, and
       possibly the programs of a multi tasking operating system.


3.2    File

         Open packet 
         Pack replies
         Unpack replies

         BBS files

         Bulletins

         Directories

         Clean work-dir
         
         Create index files  
         BBS information
         Quit

Open packet <control>+ O

        With this you load a new QWK packet into the reader. This
        always destroys old messages. But if you have replies, that
        haven't been packed, Kivi will ask if you want to destroy
        them. Kivi can now load and show several packets at the same
        time. The loaded/available packets will be shown in Window
        menu bar under <Packets>. Clicking on the packet will read it
        and open window or top packet's window if it's already open.
        Closing main window will close all windows occupied by the
        packet and free the memory it used! When loading a packet
        Kivi will create subdirectory under your work directory
        (named after your packet's name) and create work and reply
        directories there.

        Every packet can have it's own confiquration. If the packet
        don't have it's own confiquration then the default
        confiquration will be used.

Pack replies           <control>+ P

        Packs the replies you have written, so you can upload them
        back to the BBS.

Unpack replies         <control>+ R

        This unpacks your reply packet, so you can view and edit the
        messages you have written.
        You can also merge the contents of a .rep -packet to the
        messages you have in the REPLY directory.

Bulletins              <control>+ B

        If the BBS has put bulletins into your QWK packet, you can
        read them here. Bulletins with ANSI control codes are
        regognized and viewed in a readable form. Use of a font
        containing IBM graphics characters is advised.

Clean work-dir        <control>+ X

        With this you can clean the work directories, meaning that you
        have to load again the QWK packet to read it.

Create index files

        Some BBS's don't include index files(or they might be corrubted)
        so use this to create or recreate them. Index files can be
        created for messages or to your replies or for both.

BBS information        <control>+ I

        With this you get some information about the BBS which QWK
        packet you've loaded. For example the SysOp's name, BBS's
        number, number of messages, etc.

Quit                   <control>+ Q

        Quit the reader, obviously.


3.3    Activity

Movement

                Next area
                Previous area
                Next reply
                Previous reply
                Jump to message  
                Find string
                Find again

Commands

                Reply
                Reply to
                Write message
                Mark message
                Read marked
                Export msg
                to Clipboard
                Print message  

Your messages

                List own messages  
                Edit message
                Kill message

Next area              <shift>+<arrow right>

        Moves you to the next area with messages.

Previous area          <shift>+<arrow left>

        Moves you to the previous area with messages.

Next reply             <control>+<arrow right>

        Goes to the next message with the same subject or RE: in
        front of the subject.

Previous reply         <control>+<arrow left>

        Same as next reply, but goes backwards.

Jump to message        <alternate>+ J

        With this you can jump to a particular message number in the
        current message area.

Find String            <control>+ F

        Search for a text string from selected parts of message.
        Those are: To: -field
                   From: -field
                   Subj. =subject field
                   Body   From the body of the message
        You can also choose the direction of search and whether
        upper=lower, ie. the case of the string dowen't have to
        match

Find again           <control>+ G

        Search again for a previously searched string.

Reply                  <alternate>+ R

        Reply to the message you are viewing. You get a dialog box
        containing your name, the receivers name and the subject of
        the message. There's also a 'Private message' button in there,
        which toggles the private status of the message. You can put
        your reply into another area by putting another number to the
        'area:' line.

Reply to               <shift>+<alternate>+ R

        Reply to the message you are reading, but to another message
        area. This option works only in a registered version.

Write message          <alternate>+ W

        Write a message to the currently selected area.

Mark message           ' '

          Mark messages for reading/replying later.

Read marked messages   <alternate>+ M

          Read marked messages. New window is opened
          where all the messages you selected are shown.

Export message         <shift>+<alternate>+ E

        Exports the current message to a file. (plain ascii) Will ask
        whether to apppend or overwrite, if the same file exists.
        Applies also to bulletins if the active window is a bulletin.
        A header can also be included in the text, and Kivi asks
        wheter to include a one or not.

        You can select part of the message (or bulletin)  and then
        export/quote or print it. To select a block just push left
        mouse button and grab the area you want to select. The selected
        area is inverted. You can expand the selected area by pressing
        down shift and pushing left mouse button where you want the
        selection expanded. Kivi will ask you if you want to export
        whole messages or just the selected part.

... to clipboard       <alternate>+ V

        Exports the current message to clipboard. Kivi will ask you
        if you want append/overwrite or cancel if clipboard file exists.

        When copying selected part of message the Kivi asks you
        will you copy hole message or the selected part of it!

Print msg              <alternate>+ P

        Prints the current message using your current printer set-up.

List own               <alternate>+ L

        Lists the messages you have written, and which are to the same
        BBS, from where the QWK-packet is and which are still unpacked
        in the 'reply' directory.

Edit message           <alternate>+ E

        When viewing the messages you've written, you can still edit
        them with this. Brings up a dialog box, in which are the From:,
        To: and Subject: -fields. You can edit the To: -field, but the
        From: -field is your name, which is obtained from the BBS,
        when you get the QWK packet. Press the Edit -button in this
        dialog to edit the message.

Kill message           <alternate>+ K

        When viewing your own messages, you can kill them, so they
        won't be sent to the BBS.

3.4    Options menu

       3.41 Work paths
       4.42 General
       3.43 Packers
       3.44 Editor
       3.45 Font
       3.46 Translation
       3.47 Colours
       3.48 Window
       3.49 Save options

Work paths             <shift>+<control>+ W

        In this dialog, there is three editable paths. By double-
        clicking on the path, you can select it with the fileselector.
        These default to the path where Kivi QWK was when it was
        started.

        Path for work directories:
           In this directory Kivi QWK will create two directories,
           WORK and REPLY. WORK is for storing the contents of the QWK
           packet you read and in REPLY will be the messages you
           write.

        Default path to open QWK-packet:
           This path is where Kivi searches for QWK packet's.
           (This path might be your download path, so the
           packets get loaded straight away)

        Default path for QWK reply packet:
           To this directory Kivi will create the .REP packet, which
           contains the messages you write and want to upload to the
           BBS. (This might be your upload path)

General                <shift>+<control>+ G

       First are the Display Options:

          Use small header:
           Use a smaller font no the header (the place, where the
           subject, sender, receiver etc. information is located)

          Only areas /w messages:
           Shows only the areas in the main window, that have
           messages.

       Then come the Misc options:

          Use TOSRUN:
           Tries to run .TOS & .TTP programs in a window. Searches for
           the environment variable TOSRUN, and runs the specified
           program. Works with Miniwin and TOSwin. (With MultiTOS this
           works automatically)

          Ask kill msg.:
           If selected, confirms the killing of one of your own
           messages, so that you don't kill them accidently. Otherwise
           no confirmation is needed when killing a message.

          Clear workdir After packing:
           If selected clear's directory's After packing.

           Clear workdir Before loading:
           If selected clear's directory's Before loading.

       Then are the message options:

          Tab size:
           Every time a tab character is encountered in the message,
           it will be converted to n number of spaces. (0 <= n <= 99)

          Quote character:
           Defines the character, that is added to the beginning of
           every line into the message which you reply to, when you go
           to the editor. Default is '>'.

       Then are the options for the Replies:

          Format quote to __ characters:
           Formats the quoted lines, so that they don't exceed the
           given lenght. Defaults to 79 characters.

          Remove extra spaces from quote:
           If selected, removes extra spaces from a quote, so that the
           quote wouldn't exceed the line length.

         Pack replies at exit:
           Packs your replies when you exit the reader. And when
           you close current window.

          Pack only .MSG to archive:
           Only .MSG packet in to your reply packet.

          Add signature:
           If selected, tries to load a BBS_id.SIG file, in which
           the BBS_id is usually the filename of the QWK packet.
           If that is not found, a file called KIVI.SIG is searched
           for. Read more about signatures in chapter 4.1.

          Use taglines:
              Taglines work only in registered versions of Kivi QWK.
              So register your copy!
              Read more about taglines in chapter 4.2.

           Select - lets you to select a tagline, if a tag file is
                    present at the same directory as Kivi QWK.
           Random - Kivi QWK selects a random tagline from the tagline
                    file.
           No     - No taglines are used.

          Add initials before quote char:
           Adds the initials of the person who wrote the message you
           reply to, in front of the quote character. (e.g. If you
           reply to a message written by Arto Jalkanen, you get AJ
           before the quote character.

          Insert quote header:
           Inserts a header to your relies that can tell something
           like:
            - The sender of the original message
            - To whom he/she directed that message
            - The subject of the original message

           The form of the header can be defined by pressing the Edit
           quote header -button. Macros usable in the header are:

           Macro:   Translates to:
            %FF  the senders first name
            %FL  the senders last name
            %TF  the receivers first name
            %TL  the receivers last name
            %S   the subject of the message

              A default header can be selcted by pressing the Default
              quote header -button. The default header is:
             %FF %FL wrote to %TF %TL

Packers                <shift>+<control>+ P

        In this dialog is the definition of packers. The packer you
        can use, are: Lharc, Zip and Arc. There is three option lines
        for each of the packers and they are:

          Path:
           Full path and filename of the packer.
          Pack parameters:
           These parameters will be sent to the packer when packing
           replies. The default setting that is there should work OK,
           but if you want to change it, there is two macros you have
           to use and they are: %I will be replaced by the input
                                   file(s).
                                %O will be replaced by the output
                                   file(s).

Editor                 <shift>+<control>+ E

        In here you give the path of the editor you want to use for
        editing the messages. Again by double clicking on the path you
        get the fileselector, so you don't have to type the path and
        the filename. In the parameters field you may put the
        parameters that are passed to the editor when it's started.
        And %i means the filename in it.

Font                   <shift>+<control>+ F

        In this dialog you can set up the font that is used in the
        message text. If you have GDOS (SpeedoGDOS/NVDI) installed,
        you can select other fonts, otherwise you can only select the
        font size.

Translation

        From this dialog you can specify which translation file
        is to be used. Translation file is a 512 bytes long file.
        First 256 bytes are used to translate incoming characters.
        For example: if in the 65:th byte in the file is character
        76, all incoming characters which ascii code is 65 are
        translated to ascii character 76. This means, that whenever
        character 'A' (ascii 65) is encountered, it is translated to
        'L' (ascii 76). In the same manner, the following 256 bytes
        in the translation file define how all the characters you
        have written to your replies are translated.
           At the time two translation files are done: SF7.TRN (used
        in Finland for translating 7-bit scandinavian characters into
        8-bit and visa versa) and ISO.TRN which is used to translate
        ISO characters (used atleast on Amiga computers) to Atari and
        visa versa. If you make a new translation file and think it's
        useful for other users, contact me and I'll include it with
        Kivi.
           BTW. if no expansion is given to file name, Kivi
        automatically adds .TRN. Thus, if you want to use ISO.TRN,
        you can just write ISO and hit enter.
           Different translation tables can be assigned to different
        BBS packet's by using KIVI.BBS file. When you want that a BBS
        which BBS id is COMPOST uses SF7.TRN as it's translation file
        you can add the following lines to KIVI.BBS file:

        BBS_ID=COMPOST
        Translation=SF7

        You can add as many bbs as you want. If you want some
        file to be used by default (or want that no file is
        used) put BBS_ID=DEFAULT. If you want that no translation
        file is used, just put Translation=.
           At the moment KIVI.BBS supports only Translation option,
        but I might add some more in the future.

       If you have AES >3.4 (eg. Falcon or MultiTOS), you can
    select a .TRN -file that is in the Kivi's directory, by
    selecting it from a popup dialog.

Colours                <shift>+<control>+ C

       In this dialog you can define all the colours Kivi uses. Just
       use the buttons with arrows in them. There is some example text
       (some nonsense in finnish, don't care about that) in the
       dialog, in which you'll see how the colours look like. There's
       also some default colours which you can select with the
       buttons: Default normal colours and Default inverted
       colours.

Window

      In here you can set up the
      window gadgets, eg. the
      scrollbars ,the full- and
      close boxes etc, that Kivi
      uses in it's windows.

Save options           <shift>+<control>+ S

        Save default options or the BBS specific!

3.5    Window

    ---------------
    | Cycle     ^W|
    | Close     ^U|
    | 0G -------------|
    | Select BBS  |
    ---------------

Cycle                  <control>+ W

        You can cycle through Kivi QWK's currently open windows with
        this. (Note that most of the dialog boxes are in a window)

Close                  <control>+ U

        With this you can close the currently active window.

Select BBS

        Open selected BBS's window to the top.

3.6    Sort

         By From
         By To
         By Subject
         By Date

By From:               <alternate>+ 1

        Sorts the messages into an alphebetical order by the from:
        -field. (eg. by the senders's names )

By To:                 <alternate>+ 2

        Same as above, but sorts by the To: -field. (eg. by the
        receivers's names)

By Subject:            <alternate>+ 3

        Again same as above, but sorts by the subject: -field.

By Date:               <alternate>+ 4

        Sorts the messages by their dates. (Oldest to newest)

Keys

          Help

4    Other features

    4.1  Signature
    4.2  Taglines
    4.3  Kill
    4.4  KIVI.BBS -file  
    4.5  Toolbar

4.1    Signature

        You can specify, if you want to use a signature, in the
        General -set up. A signature file is added to the end of your
        messages. If you want to use them, you have to create a
        textfile called kivi.sig containing the signature. Or if you
        want to use different signatures in different BBS's, you
        should create the file by the qwk-packet name of the BBS, for
        example Heavy Fuel BBS QWK packet is called HEAVY_FU.QWK
        and so you'd create a signature file called HEAVY_FU.SIG for that
        BBS.

4.2    Taglines

        Taglines are short texts that can be added to the end of
        your messages, and they usually are on the line in which the
        QWK reader puts it's name, like Kivi QWK's line:
        * Kivi 1.30 *. You can put some text in this line, and, as
        you see, it has to be quite short, so that it fits on the
        screen. Taglines can be funny, informative or just nonsense
        (most are nonsense). Taglines in Kivi QWK are taken from a
        file called KIVI.TAG. Or if you want to use different taglines
        in different BBS's, you should create the file by the qwk-
        packet name of the BBS (see Signatures an for example).
        All lines should have a carriage return at the end. And don't
        make too long taglines, because they won't be shown complitely
        on the screen.

4.3    Kill file

         Killfile ability incluted. If you don't want to see the
         messages from some person/to some person/about some subject,
         just add it to killfile. The killfile is is named KIVI.KLL or
         BBS_ID.KLL, where BBS_ID is the BBS ID of the BBS you want the
         killfile apply to. The killed strings are separated by carriage
         return and every strings that is found from the killfile and the
         packet's To, From, Subject fields is excluded.

4.4    The configuration file: Kivi.BBS

         Every packet may have it's own configuration. If
         no packet is loaded, and you configure Kivi, a
         so called Default configuration is used. This
         configuration is used if the loaded packet doesn't
         have it's own configuration saved. When saving
         configuration Kivi will ask, if it makes sense,
         if you want the configuration to become the
         Default configuration or this packet (BBS) specific.
         Of course this question comes only if you save
         options when a packet is open, otherwise Default
         options are saved. Notice that some options are
         shared among all configurations. These are work
         directory, packer paths and editor paths.
         As a result of this feature, KIVI.BBS file
         is useless, but I left KIVI.BBS working for
         compatibility. This will however probably be
         removed in future.


         Several BBS specific options can be configured in the
         Kivi.BBS -file, they are: Translation,  QuoteHeader ,  QuoteTo  
         and  UsePacker.
           The syntax in the file is as follows:

         -Lines starting with '#' are treated as comments.

        BBS_ID=<Your BBS's id> (this is usually the packet name)
        <Option>=<option>
        ...
        BBS_ID=<Another BBS>
        <Option>=<option>
        ...

        When you use BBS_ID=DEFAULT, all packets that do not have
        own entry will use this one's options.

       Here is an example Kivi.BBS file:

  #Comment

   BBS_ID=KEVYT
   Translation=ISO.TRN
   BBS_ID=DEFAULT
   Translation=
   BBS_ID=COMPOST
   Translation=SF7
   BBS_ID=AMME
   Translation=SF7
   UsePacker=ZIP
   QuoteTo=79
   QuoteHeader=

Toolbar icons

    The icons are (from left to right)

    Open packet, Pack replies, Write message, Reply, Edit
    List own, Print message, Next/Prev message, Next/Prev area
    Jump message, Find string, Bulletins info, BBS info.

    You can enable/disable toolbar from Options - Window.



    Kivi QWK is programmed by: Arto Jalkanen      ajalkane@cc.hut.fi
    Documentation by: Jari Paajanen               jaripa@megabaud.fi
    Original documentation by: Teemu Hukkanen













































