home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / souper15.zip / souper.doc < prev    next >
Text File  |  1996-03-29  |  9KB  |  326 lines
  1.  
  2.  
  3. Souper User Manual - version 1.5                                              
  4.  
  5.  
  6.                    Souper - transfer mail and news to SOUP
  7.  
  8.      Souper is a program that transfers mail and news from a POP3 mail server
  9.      and NNTP news server respectively to SOUP packets.  It can also send
  10.      messages in SOUP reply packets.  It runs on OS/2 Warp with the IBM
  11.      Internet Connection for OS/2.
  12.  
  13. INSTALLATION
  14.  
  15.      Copy the souper.exe file to a directory in your PATH.
  16.  
  17.      Edit your \tcpip\etc\services file.  Look for a line beginning with the
  18.      word "pop3".  If the file does not contain such a line, add the line
  19.  
  20.           pop3             110/tcp
  21.  
  22.      to the file.
  23.  
  24.      Souper is designed to work with the IBM Internet Connection for OS/2.  In
  25.      your PPP/SLIP settings notebook, you must fill in the entries for
  26.  
  27.           Your Host Name:
  28.           Your Domain Name:
  29.           News Server:
  30.           Mail Gateway:
  31.           POP Mail Server:
  32.           Reply Domain:
  33.           Reply (Mail) ID:
  34.           POP Login ID:
  35.           POP Password:
  36.  
  37.      Ask your Internet service provider for the correct values for these
  38.      settings.
  39.  
  40. ENVIRONMENT VARIABLES
  41.  
  42.      You can set these environment variables to change the default behaviour
  43.      of the program.
  44.  
  45.      HOME      Specifies the user's home directory.  If not set, this defaults
  46.                to the current directory.  The program looks for the newsrc
  47.                file in the home directory.
  48.  
  49.      NNTPSERVER
  50.                Specify the NNTP news server, overriding the news server given
  51.                in the PPP/SLIP settings notebook.
  52.  
  53.      MAILER    Specify the command to execute to send mail.  If this is not
  54.                set, then Souper sends the mail directly to the mail server
  55.                specified in the PPP/SLIP settings notebook.
  56.  
  57.      POSTER    Specify the command to execute to post news.  If this is not
  58.                set, then Souper posts the news directly to the news server
  59.                specified in the PPP/SLIP settings notebook.
  60.  
  61.  
  62.  
  63.  
  64.                                                                              1
  65.  
  66.  
  67.  
  68. Souper User Manual - version 1.5                                              
  69.  
  70.  
  71. CREATE NEWSRC FILE
  72.  
  73.      Use a text editor to create a file named newsrc in your home directory.
  74.      List the newsgroups you want to transfer, one per line, and end each line
  75.      with a colon.  For example:
  76.  
  77.           comp.answers:
  78.           news.answers:
  79.           rec.humor.funny:
  80.  
  81.      The program records the article numbers it has fetched by updating this
  82.      file.
  83.  
  84.      If you use Yarn, be sure to give Souper a separate newsrc file from the
  85.      one used by Yarn.  The files must be separate and are used for different
  86.      purposes.  The Souper newsrc file records the articles you have
  87.      downloaded from the news server.  The Yarn newsrc file records the
  88.      articles you have read with the Yarn news reader.
  89.  
  90. CREATE KILL FILE
  91.  
  92.      A kill file specifies criteria used to kill news articles, that is,
  93.      exclude them from the SOUP packet.  You can kill articles that have a
  94.      specific subject, are from a specific poster, or contain a particular
  95.      string anywhere in the header.
  96.  
  97.      By default, the program looks for a file named kill in your home
  98.      directory.  An entry in the kill file has the format:
  99.  
  100.           <newsgroup> {
  101.             <where> <pattern>
  102.             ...
  103.           }
  104.  
  105.      where
  106.  
  107.      <newsgroup>
  108.                is the name of the newsgroup in which the search patterns
  109.                apply.  If the name is "all", the search patterns apply in all
  110.                newsgroups.
  111.  
  112.      <where>   specifies where to search in the article.  "from" searches the
  113.                From line.  "subject" searches the Subject line.  "header"
  114.                searches all lines in the article header.
  115.  
  116.      <pattern> is the string to search for.  All searches are case-
  117.                insensitive.
  118.  
  119.      Here is an example kill file:
  120.  
  121.           all {
  122.             From netkook
  123.           }
  124.           comp.os.os2.advocacy {
  125.             Subject Microsoft
  126.             Subject crash OS/2
  127.  
  128.  
  129.                                                                              2
  130.  
  131.  
  132.  
  133. Souper User Manual - version 1.5                                              
  134.  
  135.  
  136.           }
  137.  
  138.      In all newsgroups, articles from netkook are killed.  Also in the
  139.      comp.os.os2.advocacy newsgroup, articles with a Subject containing the
  140.      string "Microsoft" or "crash OS/2" are killed.
  141.  
  142. OPERATION
  143.  
  144.      To fetch your mail and news, run the command
  145.  
  146.           souper
  147.  
  148.      You can specify a different POP3 mail server than the one specified in
  149.      the PPP/SLIP settings notebook by instead running the command
  150.  
  151.           souper <mailhost> <userid> <password>
  152.  
  153.      where
  154.  
  155.      <mailhost>
  156.                is the name of the host running the POP3 mail server
  157.  
  158.      <userid>  is your POP3 user ID
  159.  
  160.      <password>
  161.                is your POP3 password
  162.  
  163.      If you want to transfer only news, specify the -m option to disable the
  164.      mail transfer.
  165.  
  166.           souper -m
  167.  
  168.      If you want to transfer only mail, specify the -n option to disable the
  169.      news transfer.
  170.  
  171.           souper -n
  172.  
  173.  
  174.      The program creates the AREAS and *.MSG files of the SOUP packet in the
  175.      current directory.  Here's a typical batch file designed to import news
  176.      into Yarn:
  177.  
  178.           cd \temp
  179.           souper
  180.           import -u
  181.  
  182.      And to export messages from Yarn:
  183.  
  184.           cd \temp
  185.           unzip -o \home\reply.zip
  186.           del \home\reply.zip
  187.           souper -s
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                              3
  195.  
  196.  
  197.  
  198. Souper User Manual - version 1.5                                              
  199.  
  200.  
  201. OPTIONS
  202.  
  203.      The program accepts the following command line options.
  204.  
  205.      -a        Check for new newsgroups.  If any newgroups were created since
  206.                the last time Souper was run, add the new newsgroups to your
  207.                newsrc file.
  208.  
  209.      -c n      Catch up news.  Mark every article in every newsgroup as read
  210.                except for the last n articles.
  211.  
  212.      -h dir    Set home directory.  This option overrides any HOME environment
  213.                setting.  If the HOME environment variable is not set, the
  214.                default is the current directory.
  215.  
  216.      -i        Do not read the configuration from the IBM Internet Connection
  217.                for OS/2 settings notebook.  If the use this option, you must
  218.                specify the required mail and news host information through the
  219.                command line and environment variables.
  220.  
  221.      -k n      Set maximum news packet size in Kbytes.  The default is 2048
  222.                Kbytes.  If you set this to 0, the packet size is unlimited.
  223.  
  224.      -K file   Specify another kill file.  The default is the kill file in the
  225.                home directory.
  226.  
  227.      -l n      Kill articles that contain more than n lines in the body.
  228.  
  229.      -m        Do not get mail.
  230.  
  231.      -n        Do not get news.
  232.  
  233.      -N file   Specify another newsrc file.  The default is the newsrc file in
  234.                the home directory.
  235.  
  236.      -r        Set read only mode.  Do not empty your POP3 mailbox or update
  237.                the newsrc file.
  238.  
  239.      -s        Send replies.  The program expects the SOUP reply files in the
  240.                current directory.
  241.  
  242.      -u        When fetching news, create SOUP summaries instead of
  243.                transfering entire articles.
  244.  
  245.      -x        Do not process news Xref headers.
  246.  
  247. ACKNOWLEDGEMENTS
  248.  
  249.      This program is derived from popclient by Carl Harris <ceharris@vt.edu>
  250.      and uqwk by Steve Belczyk <seb3@gte.com>.
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.                                                                              4
  260.  
  261.  
  262.  
  263. Souper User Manual - version 1.5                                              
  264.  
  265.  
  266. STANDARD DISCLAIMER
  267.  
  268.      The author makes no representations about the accuracy or suitability of
  269.      this material for any purpose.  It is provided "as is", without any
  270.      express or implied warranties.  The author will assume no liability for
  271.      damages either from the direct use of this product or as a consequence of
  272.      the use of this product.
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                              5
  325.  
  326.