Souper User Manual - version 1.2                                               


                    Souper - transfer mail and news to SOUP

     Souper is a network mail and news client program for OS/2 Warp's Internet
     Access Kit and IBM TCP/IP.  It creates a SOUP packet from mail and news
     fetched from a POP3 server and NNTP server respectively.  It can also send
     messages in SOUP reply packets.

INSTALLATION

     Copy the SOUPER.EXE and INEWS.EXE files to a directory in your PATH.  You
     also need the emx run-time DLLs.  You can get these from

          ftp-os2.cdrom.com:/os2/32bit/unix/emx09a/emxrt.zip

     Make sure the emx run-time DLLs are in a directory in your LIBPATH.

     Edit your \tcpip\etc\services file.  If the file contains the line

          pop             109/tcp         postoffice

     replace it with the line

          pop             110/tcp         postoffice


     If you installed OS/2 Warp's Internet Access Kit, you'll find a file named
     sendmail.uml in the \tcpip\etc directory.  Copy that file to a file named
     sendmail.cf in the same directory, then edit the sendmail.cf file.  You
     have to change two settings relating to your mail server host.  For
     example, suppose the mail server is running on a host named mail.io.org.
     Replace the line

          DVYourMailRelay

     with

          DVmail

     and replace the line

          DHYour.Mail.Hub

     with

          DHio.org


ENVIRONMENT VARIABLES

     Make sure your environment variables are set correctly.

     HOME      Specifies the user's home directory.  The program looks for the
               newsrc file in the home directory.





                                                                              1



Souper User Manual - version 1.2                                               


     NNTPSERVER
               Specifies the NNTP news server.

     MAILER    Command to send mail.  This defaults to "sendmail -t".

     POSTER    Command to post news.  This defaults to "inews".

CREATE NEWSRC FILE

     If you don't already have a newsrc file in your home directory, then
     create one.  Use a text editor to create a file named newsrc.  List the
     newsgroups you want to transfer, one per line, and end each line with a
     colon.  For example:

          comp.answers:
          news.answers:
          rec.humor.funny:

     The program records the article numbers it has fetched by updating this
     file.

CREATE KILL FILE

     A kill file records the criteria used to kill news articles, that is,
     exclude them from the SOUP packet.  You can kill articles that have a
     specific subject, are from a specific poster, or contain a particular
     string anywhere in the header.

     By default, the program looks for a file named kill in your home
     directory.  An entry in the kill file has the format:

          <newsgroup> {
            <where> <pattern>
            ...
          }

     where

     <newsgroup>
               is the name of the newsgroup in which the search patterns apply.
               If the name is "all", the search patterns apply in all
               newsgroups.

     <where>   specifies where to search in the article.  "from" searches the
               From line.  "subject" searches the Subject line.  "header"
               searches all lines in the article header.

     <pattern> is the string to search for.  All searches are case-insensitive.

     Here is an example kill file:

          all {
            From netkook
          }
          comp.os.os2.advocacy {
            Subject Microsoft


                                                                              2



Souper User Manual - version 1.2                                               


            Subject crash OS/2
          }

     In all newsgroups, articles from netkook are killed.  Also in the
     comp.os.os2.advocacy newsgroup, articles with a Subject containing the
     string "Microsoft" or "crash OS/2" are killed.

OPERATION

     To fetch your mail and news run

          souper mailhost userid password

     where

     mailhost  is the name of the host running the POP3 mail server

     userid    is your POP3 user ID

     password  is your POP3 password

     The program creates the AREAS and *.MSG files of the SOUP packet in the
     current directory.

     If you want to transfer only news, specify the -m option to disable the
     mail transfer.  It this case, you don't need to give the mailhost, userid
     and password.

          souper -m

     Here's a typical batch file designed to import news into Yarn:

          cd \temp
          souper mailhost userid password
          zip -0m soup.zip areas *.msg
          import soup.zip

     And to export messages from Yarn:

          cd \temp
          unzip -o \home\soup.zip
          del \home\soup.zip
          souper -s


OPTIONS

     The program accepts the following command line options.

     -c n      Catch up news.  Mark every article in every newsgroup as read
               except for the last n articles.

     -h dir    Set home directory.  This option overrides any HOME environment
               setting.  If the HOME environment variable is not set, the
               default is the current directory.



                                                                              3



Souper User Manual - version 1.2                                               


     -k n      Set maximum news packet size in Kbytes.  The default is 2048
               Kbytes.  If you set this to 0, the packet size is unlimited.

     -K file   Specify another kill file.  The default is the kill file in the
               home directory.

     -m        Do not get mail.

     -n        Do not get news.

     -N file   Specify another newsrc file.  The default is the newsrc file in
               the home directory.

     -r        Set read only mode.  Do not empty your POP3 mailbox or update
               the newsrc file.

     -s        Send replies.  The program expects the SOUP reply files in the
               current directory.

     -x        Do not process news Xref headers.

ACKNOWLEDGEMENTS

     This program is derived from popclient by Carl Harris <ceharris@vt.edu>
     and uqwk by Steve Belczyk <seb3@gte.com>.

STANDARD DISCLAIMER

     The author makes no representations about the accuracy or suitability of
     this material for any purpose.  It is provided "as is", without any
     express or implied warranties.  The author will assume no liability for
     damages either from the direct use of this product or as a consequence of
     the use of this product.

























                                                                              4