home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Amiga 13 / MA_Cover_13.bin / source / c / stefanb_src / ums / networks / rfc / readme.umsrfc
Encoding:
Text File  |  1995-05-14  |  10.5 KB  |  306 lines
  1. UMS RFC 0.9 - RFC Converters for UMS                               14-May-1995
  2.  
  3.  
  4.    Permission is granted to make and distribute verbatim copies  of  this
  5. manual provided the copyright  notice  and  this  permission  notice  are
  6. preserved on all copies.
  7.  
  8. COPYRIGHT
  9.  
  10.    Copyright (C) 1992-1995 Stefan Becker
  11.  
  12.    No program, document, data file or  source  code  from  this  software
  13. package, neither in whole nor in part, may be included or used  in  other
  14. software packages unless it is authorized by a  written  permission  from
  15. the author.
  16.  
  17.  
  18. NO WARRANTY
  19.  
  20.    There is no warranty for this software package.  Although  the  author
  21. has tried to prevent errors, he can't guarantee that the software package
  22. described in this document is 100% reliable. You are therefore using this
  23. material at your own risk. The author cannot be made responsible for  any
  24. damage which is caused by using this software package.
  25.  
  26.  
  27. DISTRIBUTION
  28.  
  29.  This package should be regarded as beta version, so the distribution  is
  30. limited. Please don't upload the archive on any BBS or FTP server.
  31.  
  32.  
  33. USAGE RESTRICTIONS
  34.  
  35.    No program, document, data file or  source  code  from  this  software
  36. package, neither in whole nor in part, may be used on any  machine  which
  37. is used
  38.  
  39.    * for the research, development, construction, testing  or  production
  40.      of weapons or other military applications. This  also  includes  any
  41.      machine which is  used  in  the  education  for  any  of  the  above
  42.      mentioned purposes.
  43.  
  44.    * by people who accept, support or use violence against other  people,
  45.      e.g. citizens from foreign countries.
  46.  
  47.  
  48. NOTE TO NEW USERS
  49.  
  50.  Use this package ONLY if your REALLY must. Please use the UMS  UUCP  0.8
  51.  package in every other case. Before using this  package  you  should  at
  52.  least read the UMS UUCP 0.8 documentation, because the documentation  to
  53.  UMS RFC is still incomplete.
  54.  
  55.  
  56. NOTE TO UMS UUCP 0.8 USERS
  57.  
  58.  Please read the complete  text  before  installing  this  package.  Many
  59.  things have changed, especially  the  configuration  (plus  the  changes
  60.  required for UMS V11).  You  better  should  try  to  convert  your  old
  61.  configuration to UMS V11 and UMS RFC, and use this  configuration  on  a
  62.  test message base.
  63.  
  64.  
  65. Introduction
  66.  
  67.  This package is the successor of UMS UUCP, the UUCP im/exporter  package
  68.  for UMS. Now UMS can be used in conjunction with NNTP,  POP3,  SMTP  and
  69.  UUCP. The RFC <-> UMS  conversion  code  has  been  moved  to  a  shared
  70.  library, which eases the creation of new RFC related im/exporters.
  71.  
  72.  These programs should be regarded as beta versions,  so  they  are  only
  73.  useful for users who know what they are doing. They have been tested  on
  74.  several different configurations, but there still may be some bugs left.
  75.  Just try them out and tell me what you think.
  76.  
  77.  
  78. Requirements
  79.  
  80.   umsserver      Version 11.12 or newer
  81.  
  82.   umsrfc.libray  Version 0.9. Copy it from UMS/Libs to LIBS:.
  83.  
  84.                  NOTE: You MUST remove old versions of this library from
  85.                        memory (e.g. with "avail flush") before using ANY
  86.                        of the programs from this package!
  87.  
  88.   AmiTCP         Needed for TCP/IP connections. I have tested AmiTCP 3.0b2,
  89.                  4.0 Demo and 4.1/2 Commercial, but AmiTCP 2.x may work too.
  90.  
  91.  
  92. Programs
  93.  
  94.   ums2uucp    UUCP exporter
  95.               Syntax: ums2uucp <options>
  96.  
  97.   umsnntp     This program exports news articles to another host via NNTP.
  98.               Syntax: umsnntp <options>
  99.  
  100.   umsnntpd    NNTP server (can only be started by inetd)
  101.  
  102.   umsnntpget  This program retrieves news articles from another host via NNTP.
  103.               Syntax: umsnntpget <options> [<param> [<param> ...]]
  104.  
  105.   umspop3     This program retrieves mail messages from a mail box on another
  106.               host via POP3.
  107.               Syntax: umspop3 <options>
  108.  
  109.   umssmtp     This program exports mail messages to another host via SMTP.
  110.               Syntax: umssmtp <options>
  111.  
  112.   umssmtpd    SMTP server (can only be started by inetd)
  113.  
  114.   uuxqt       UUCP importer
  115.               Syntax: uuxqt <options> [<system name>]
  116.  
  117.  
  118. Command line options
  119.  
  120.  All programs (except uuxqt):
  121.  
  122.   -h <host name>  Name of the NNTP/POP3/SMTP/UUCP server. You must specify this
  123.                   option.
  124.  
  125.   -s <server>     Name of the UMS server
  126.                   Default: default UMS server
  127.  
  128.   -p <password>   UMS user password
  129.                   Default: no password
  130.  
  131.   -u <user>       Name of the UMS user account
  132.                   Default: NNTP, NNTPD, POP3, SMTP, SMTPD or UUCP
  133.  
  134.   -S <service>    Name/Port of the TCP/IP service
  135.                   Default: Use the default service name
  136.  
  137.  umssmtp/umsnntp:
  138.  
  139.   -b <bit>        Export only messages which have this bit set in the user
  140.                   flags. Useful in conjunction with filter programs.
  141.                   Default: No select bit
  142.  
  143.   -c              Export mail/news continously. After each export run, the
  144.                   program will wait 1 minute and then scan for new messages.
  145.                   Default: Export only once
  146.  
  147.   -r <period>     Rescan the message base completely after <period> export
  148.                   runs. This will re-export all messages which couldn't be
  149.                   exported in previous runs.
  150.                   Default: 360
  151.  
  152.  umsnntp:
  153.  
  154.   -i              Use "IHAVE" command for sending news articles to the server.
  155.                   Default: Use "POST" command
  156.  
  157.  umsnntpget:
  158.  
  159.   -c              Use parameters from command line (groups or message ids).
  160.                   Default: Use "nntpget.groups" variable
  161.  
  162.   -g              Use GROUP/STAT/NEXT commands to scan for new articles. Try
  163.                   this option if the NNTP server administrator complains about
  164.                   too much load because of the NEWNEWS command.
  165.                   Default: Use "NEWNEWS" command
  166.  
  167.   -P              Number of parallel article fetch processes (max. 5).
  168.                   Default: Only one fetch process
  169.  
  170.  umspop3:
  171.  
  172.   -c              Import mail continously. After each import run, the program
  173.                   will wait 1 minute and then look for new messages.
  174.                   Default: Import only once
  175.  
  176.   -i              User password for the mail box. You must specify this option.
  177.  
  178.   -n              User name for the mail box. You must specify this option.
  179.  
  180.  ums2uucp:
  181.  
  182.   -b <bit>        Export only messages which have this bit set in the user
  183.                   flags. Useful in conjunction with filter programs.
  184.                   Default: No select bit
  185.  
  186.  uuxqt:
  187.  
  188.   -p <password>   UMS user password. Note that this password will be used for ALL
  189.                   logins!
  190.                   Default: no password
  191.  
  192.  
  193. Variables
  194.  
  195.   nntpd.access     Access rights for users of the NNTP server. Sever
  196.                    Multiple lines may be specified.
  197.                    Example:
  198.  
  199.                     ( nntpd.access
  200.                        "localhost       uucp.lilly,Y,Y\n"
  201.                        "*.ping.de       uucp.lilly,Y,N\n"
  202.                        "*               uucp.lilly,N,N\n" )
  203.                         |               |          | |---- Remote host is
  204.                         |               |          |       NNTP server?
  205.                         |               |          |------ Posting allowed?
  206.                         |               |----------------- UMS user name
  207.                         |--------------------------------- address pattern
  208.  
  209.   nntpget.groups   Group descriptions. Multiple lines may be specified.
  210.  
  211.                    Example for "NEWNEWS" command (see RFC 977):
  212.  
  213.                     ( nntpget.groups "de.comp.sys.amiga.*\n"
  214.                                      "de.comm.sofware.ums\n" )
  215.  
  216.                    Example for "GROUP" command (one group per line):
  217.  
  218.                     ( nntpget.groups "de.comp.sys.amiga.advocacy\n"
  219.                                      "de.comp.sys.amiga.archives\n"
  220.                                      "de.comp.sys.amiga.comm\n"
  221.                                      "de.comp.sys.amiga.misc\n"
  222.                                      "de.comm.sofware.ums\n" )
  223.  
  224.   rfc.domainname   Replaces uucp.domainname
  225.  
  226.   rfc.mailencoding
  227.   rfc.newsencoding Replace uucp.encoding. Meaning changed since UMS UUCP 0.8.
  228.                    It is now a number which specifies the encoding type for
  229.                    non-ASCII characters:
  230.  
  231.                       0 - no encoding (default)
  232.                       1 - quoted-printable
  233.                       2 - base64 (not yet implemented)
  234.  
  235.                    You can specify separate encodings for mail and news.
  236.  
  237.   rfc.export.*     Replaces uucp.export.*
  238.  
  239.   rfc.import.*     Replaces uucp.import.*
  240.  
  241.   rfc.pathname     Replaces uucp.pathname
  242.  
  243.   rfc.username     Replaces uucp.username
  244.  
  245.   uucp.filtercr    Filter CRs from batches before processing them.
  246.                    (UUCP only) Default: Don't filter CRs.
  247.  
  248.   uucp.logdupes    Include dupe messages in the error log.
  249.                    (UUCP only) Default: Log dupes.
  250.  
  251.   uucp.recipients  Limit number of recipients for one mail file. If there are more
  252.                    recipients then ums2uucp will create several mail files for one
  253.                    mail.
  254.                    (UUCP only) Default: Unlimited number of recipients.
  255.  
  256.  
  257. Attributes
  258.  
  259.  UMS RFC supports the following parameters in the attributes field:
  260.  
  261.   ALIAS/K            Use this alias for the address generation. UMS RFC checks
  262.                      if this alias is valid for the creator of the message.
  263.  
  264.   RECEIPT-REQUEST/K  Send a receipt message to this address.
  265.                      Creates "Return-Receipt-To: <string>" header.
  266.  
  267.                      Examples:
  268.  
  269.                       RECEIPT-REQUEST <name>
  270.  
  271.                       RECEIPT-REQUEST <account@domain>
  272.  
  273.                       RECEIPT-REQUEST <name>,<account@domain>
  274.  
  275.  
  276.   URGENT/S           Flag this message as urgent.
  277.                      Creates "Priority: urgent" header.
  278.  
  279.  
  280. AmiTCP configuration hints
  281.  
  282.  Please check that the following lines are included in AmiTCP:db/services:
  283.  
  284.   smtp      25/tcp      mail
  285.   pop3      110/tcp     postoffice v3
  286.   nntp      119/tcp     readnews untp
  287.  
  288.  Otherwise some programs abort with the error "Can't get connection data".
  289.  
  290.  The NNTP/SMTP server have to be started by inetd. You have to add the
  291.  following lines to AmiTCP:db/inetd.conf:
  292.  
  293.  smtp stream tcp nowait root <UMS Path>umssmtpd umssmtpd [<user> [<passwd> [<server>]]]
  294.  nntp stream tcp nowait root <UMS Path>umsnntpd umsnntpd [<user> [<passwd> [<server>]]]
  295.  
  296.  
  297. Regards,
  298.  
  299.    Stefan
  300.  
  301. --
  302. Mail    : Stefan Becker, Verkehrsstrasse 11, D-44809 Bochum  ///    Only
  303. Phone   : +49-234-9562803 (8-15 CET)         Germany        ///  Amiga makes
  304. InterNet: stefanb@yello.ping.de                         \\\///  it possible..
  305. ADSP    : stefanb@yello.adsp.sub.org          ECG148     \XX/  -->A3000/25<--
  306.