OSSP CVS Repository

ossp - Check-in [983]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 983
Date: 2001-Sep-13 15:45:12 (local)
2001-Sep-13 13:45:12 (UTC)
User:thl
Branch:
Comment: revamping and polishing documentation files for release
Tickets:
Inspections:
Files:
ossp-pkg/lmtp2nntp/AUTHORS      1.2 -> 1.3     9 inserted, 2 deleted
ossp-pkg/lmtp2nntp/INSTALL      1.5 -> 1.6     116 inserted, 63 deleted
ossp-pkg/lmtp2nntp/Makefile.in      1.22 -> 1.23     1 inserted, 1 deleted
ossp-pkg/lmtp2nntp/NEWS      1.1 -> 1.2     9 inserted, 3 deleted
ossp-pkg/lmtp2nntp/README      1.5 -> 1.6     51 inserted, 11 deleted
ossp-pkg/lmtp2nntp/THANKS      1.1 -> 1.2     10 inserted, 3 deleted
ossp-pkg/lmtp2nntp/argz.html      1.1->removed
ossp-pkg/lmtp2nntp/lmtp.pod      1.2->removed
ossp-pkg/lmtp2nntp/lmtp2nntp.c      1.60 -> 1.61     1 inserted, 1 deleted
ossp-pkg/lmtp2nntp/lmtp2nntp.pod      1.20 -> 1.21     15 inserted, 46 deleted
ossp-pkg/lmtp2nntp/shpat_match.3      1.1->removed

ossp-pkg/lmtp2nntp/AUTHORS 1.2 -> 1.3

--- AUTHORS      2001/09/11 06:43:13     1.2
+++ AUTHORS      2001/09/13 13:45:12     1.3
@@ -1,11 +1,18 @@
 
+   _           _        ____              _         
+  | |_ __ ___ | |_ _ __|___ \ _ __  _ __ | |_ _ __  
+  | | '_ ` _ \| __| '_ \ __) | '_ \| '_ \| __| '_ \ 
+  | | | | | | | |_| |_) / __/| | | | | | | |_| |_) |
+  |_|_| |_| |_|\__| .__/_____|_| |_|_| |_|\__| .__/ 
+                  |_|                        |_|    
+
+  OSSP lmtp2nntp - Mail to News Gateway
+  
   AUTHORS
-  =======
 
   This is a list of authors who have written or 
   edited major parts of the OSSP lmtp2nntp sources.
 
   Ralf S. Engelschall   <ralf.engelschall@cw.com>
   Thomas Lotterer       <thomas.lotterer@cw.com>
-  Michael Schloh        <michael.schloh@cw.com>
 


ossp-pkg/lmtp2nntp/INSTALL 1.5 -> 1.6

--- INSTALL      2001/09/13 12:57:49     1.5
+++ INSTALL      2001/09/13 13:45:12     1.6
@@ -1,67 +1,120 @@
-   
-Sendmail Integration
-====================
-
-Create an cf/mailer/lmtp2nntp.m4 files with the following contents:
-______________________________________________________________________
-
-PUSHDIVERT(-1)
-_DEFIFNOT(`LMTP2NNTP_MAILER_PATH',         `/usr/local/bin/lmtp2nntp')
-_DEFIFNOT(`LMTP2NNTP_MAILER_FLAGS',        `mDFMuXz')
-_DEFIFNOT(`LMTP2NNTP_MAILER_ARGS',         `')
-_DEFIFNOT(`LMTP2NNTP_MAILER_BINDADDR',     '0.0.0.0')
-_DEFIFNOT(`LMTP2NNTP_MAILER_DELIVERYMODE', `post')
-_DEFIFNOT(`LMTP2NNTP_MAILER_GROUPMODE',    `envelope')
-_DEFIFNOT(`LMTP2NNTP_MAILER_MAILFROM',     `.+@(?:[^.]+\.)+\.[^.]+')
-_DEFIFNOT(`LMTP2NNTP_MAILER_NODENAME',     `confDOMAIN_NAME')
-_DEFIFNOT(`LMTP2NNTP_MAILER_SIZE',         `800000')
-_DEFIFNOT(`LMTP2NNTP_MAILER_LOGLEVEL',     `notice:/var/log/lmtp2nntp')
-_DEFIFNOT(`LMTP2NNTP_MAILER_WAITTIME',     `60')
-_DEFIFNOT(`LMTP2NNTP_MAILER_NEWSGROUP',    `\*')
-POPDIVERT
-
-#########################################
-###   LMTP2NNTP Mailer specification  ###
-#########################################
-
-Mlmtp2nntp, P=LMTP2NNTP_MAILER_PATH, F=LMTP2NNTP_MAILER_FLAGS,
-            S=EnvFromSMTP/HdrFromSMTP, R=MasqSMTP, E=\r\n,
-            L=990, T=DNS/RFC822/SMTP, M=LMTP2NNTP_MAILER_MAX,
-            A=lmtp2nntp LMTP2NNTP_MAILER_ARGS dnl
-                        -b LMTP2NNTP_MAILER_BINDADDR dnl
-                        -d LMTP2NNTP_MAILER_DELIVERYMODE dnl
-                        -g LMTP2NNTP_MAILER_GROUPMODE dnl
-                        -h $h dnl
-                        -m LMTP2NNTP_MAILER_MAILFROM dnl
-                        -n LMTP2NNTP_MAILER_NODENAME dnl
-                        -s LMTP2NNTP_MAILER_SIZE dnl
-                        -l LMTP2NNTP_MAILER_LOGLEVEL dnl
-                        -w LMTP2NNTP_MAILER_WAITTIME dnl
-                        LMTP2NNTP_MAILER_NEWSGROUP
-______________________________________________________________________
-
-Add to your sendmail.m4 (or sendmail.mc) the following entry:
-
-______________________________________________________________________
-
-dnl #  Mailer: LMTP2NNTP (mail to news gateway)
-dnl define(`LMTP2NNTP_MAILER_PATH', `/path/to/your/lmtp2nntp')
-dnl MAILER(lmtp2nntp)
-______________________________________________________________________
-
-
-Add to your virtualusertable:
-______________________________________________________________________
-
-posting@gateway.example.com    posting@lmtp2nntp.invalid
-posting+*@gateway.example.com  %2@lmtp2nntp.invalid
-@news.example.com              %1@lmtp2nntp.invalid
-______________________________________________________________________
 
+   _           _        ____              _         
+  | |_ __ ___ | |_ _ __|___ \ _ __  _ __ | |_ _ __  
+  | | '_ ` _ \| __| '_ \ __) | '_ \| '_ \| __| '_ \ 
+  | | | | | | | |_| |_) / __/| | | | | | | |_| |_) |
+  |_|_| |_| |_|\__| .__/_____|_| |_|_| |_|\__| .__/ 
+                  |_|                        |_|    
+
+  OSSP lmtp2nntp - Mail to News Gateway
+
+  INSTALLATION
+
+  To install OSSP lmtp2nntp into /path/to/lmtp2nntp/{bin,man}/ perform
+  the following steps in your shell:
+      
+    $ ./configure --prefix=/path/to/lmtp2nntp
+    $ make
+    $ make check
+    $ make install
+
+  CONFIGURATION
+
+  In order to use OSSP lmtp2nntp, the program has to be integrated into
+  a Mail Transfer Agent (MTA) which speaks Local Mail Transfer Protocol
+  (LMTP). OSSP lmtp2nntp was developed with Sendmail 8.11, but should
+  also work with other MTAs who provide an LMTP interface. The detailed
+  integration into Sendmail 8.11 is shown below.
+
+  Sendmail Integration
+
+  1. Create a "cf/mailer/lmtp2nntp.m4" macro file with the following contents:
+
+     | PUSHDIVERT(-1)
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_PATH',         `/usr/local/bin/lmtp2nntp')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_FLAGS',        `mDFMuXz')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_ARGS',         `')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_BINDADDR',     '0.0.0.0')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_DELIVERYMODE', `post')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_GROUPMODE',    `envelope')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_MAILFROM',     `.+@(?:[^.]+\.)+\.[^.]+')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_NODENAME',     `confDOMAIN_NAME')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_SIZE',         `800000')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_LOGLEVEL',     `notice:/var/log/lmtp2nntp')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_WAITTIME',     `60')
+     | _DEFIFNOT(`LMTP2NNTP_MAILER_NEWSGROUP',    `\*')
+     | POPDIVERT
+     |   
+     | #########################################
+     | ###   LMTP2NNTP Mailer specification  ###
+     | #########################################
+     | 
+     | Mlmtp2nntp, P=LMTP2NNTP_MAILER_PATH, F=LMTP2NNTP_MAILER_FLAGS,
+     |             S=EnvFromSMTP/HdrFromSMTP, R=MasqSMTP, E=\r\n,
+     |             L=990, T=DNS/RFC822/SMTP, M=LMTP2NNTP_MAILER_MAX,
+     |             A=lmtp2nntp LMTP2NNTP_MAILER_ARGS dnl
+     |                         -b LMTP2NNTP_MAILER_BINDADDR dnl
+     |                         -d LMTP2NNTP_MAILER_DELIVERYMODE dnl
+     |                         -g LMTP2NNTP_MAILER_GROUPMODE dnl
+     |                         -h $h dnl
+     |                         -m LMTP2NNTP_MAILER_MAILFROM dnl
+     |                         -n LMTP2NNTP_MAILER_NODENAME dnl
+     |                         -s LMTP2NNTP_MAILER_SIZE dnl
+     |                         -l LMTP2NNTP_MAILER_LOGLEVEL dnl
+     |                         -w LMTP2NNTP_MAILER_WAITTIME dnl
+     |                         LMTP2NNTP_MAILER_NEWSGROUP
+
+     This changes nothing in your Sendmail configuration, but just adds
+     a new mailer named "lmtp2nntp" to Sendmail.
+
+  2. Add to your Sendmail M4 configuration (file "sendmail.m4" or
+     "sendmail.mc" according to your installation) the following entry:
+
+     | dnl #  Mailer: LMTP2NNTP (mail to news gateway)
+     | define(`LMTP2NNTP_MAILER_PATH', `/path/to/lmtp2nntp/bin/lmtp2nntp')
+     | MAILER(lmtp2nntp)
+
+     This defines the new "lmtp2nntp" mailer in your Sendmail
+     configuration, but still does not activate it. Additionally feel
+     free to overwrite more LMTP2NNTP_MAILER_XXXX variables in order
+     to adjust the run-time behaviour of OSSP lmtp2nntp. See the
+     lmtp2nntp(1) manual page for more details about the commmand line
+     parameters.
+
+  3. Add the following entries to both your virtual user table (file
+     "virtusertable") and your mailer table (file "mailertable") in order
+     to finally activate the mail to news gateway:
+
+     virtusertable:
+
+     | posting+*@gateway.example.com  %2@lmtp2nntp.invalid
+
+     mailertable:
+
+     | lmtp2nntp.invalid              lmtp2nntp:news.example.com
+
+     Notice that we use the RFC2606 top-level domain name ".invalid"
+     for the internal mapping between virtual user table and the
+     mailer table. This is neccessary because Sendmail cannot directly
+     map individual recipient mailbox addresses to outgoing mailers.
+
+     In this example configrution we assumed that the machine
+     "gateway.example.com" is the FQDN of machine running Sendmail
+     and OSSP lmtp2nntp and "news.example.com" is the remote Usenet
+     News server speaking NNTP. This means that mails addressed to
+     "posting+foo.bar@gateway.example.com" are posted via NNTP as news
+     articles into the newsgroup foo.bar on "news.example.com".
+
+     Additionally, if just the MX DNS record for "news.example.com"
+     points to the address of "gateway.example.com" you can add the
+     following additional entry to your virtual user table in order
+     to let "news.example.com" virtually provide mail to news gateway
+     functionality:
 
-Add to your mailertable:
-______________________________________________________________________
+     virtusertable:
 
-lmtp2nntp.invalid    lmtp2nntp:news.example.com
-______________________________________________________________________
+     | @news.example.com              %1@lmtp2nntp.invalid
+
+     Notice that there are more delivery modes supported by OSSP
+     lmtp2nntp. Refer to the lmtp2nntp(1) manual page for more details.
 


ossp-pkg/lmtp2nntp/Makefile.in 1.22 -> 1.23

--- Makefile.in  2001/09/13 12:21:34     1.22
+++ Makefile.in  2001/09/13 13:45:12     1.23
@@ -116,7 +116,7 @@
         @$(SHTOOL) fixperm -v .; \
         V=`$(SHTOOL) version -lc -dshort version.c`; \
         $(SHTOOL) tarball -o lmtp2nntp-$${V}.tar.gz -d lmtp2nntp-$${V} -u ossp -g ossp \
-                          -e 'CVS,\.cvsignore,\.[ao],^\.,/\.,autogen.sh,*.tar.gz,*.bak' -c 'gzip --best' .
+                          -e 'CVS,\.cvsignore,\.[ao],^\.,/\.,autogen.sh,*.tar.gz,*.bak,TODO' -c 'gzip --best' .
 
 check: lmtp2nntp
         @./test.sh


ossp-pkg/lmtp2nntp/NEWS 1.1 -> 1.2

--- NEWS 2001/09/11 06:43:13     1.1
+++ NEWS 2001/09/13 13:45:12     1.2
@@ -1,8 +1,14 @@
 
-  NEWS
-  ====
+   _           _        ____              _         
+  | |_ __ ___ | |_ _ __|___ \ _ __  _ __ | |_ _ __  
+  | | '_ ` _ \| __| '_ \ __) | '_ \| '_ \| __| '_ \ 
+  | | | | | | | |_| |_) / __/| | | | | | | |_| |_) |
+  |_|_| |_| |_|\__| .__/_____|_| |_|_| |_|\__| .__/ 
+                  |_|                        |_|    
+
+  OSSP lmtp2nntp - Mail to News Gateway
 
-  OSSP lmtp2nntp - mail to news gateway
+  NEWS
 
   This is the initial public release. Thanks to Cable & Wireless Deutschland
   GmbH for supporting open source software. Those folks who tested and


ossp-pkg/lmtp2nntp/README 1.5 -> 1.6

--- README       2001/09/11 06:43:13     1.5
+++ README       2001/09/13 13:45:12     1.6
@@ -1,15 +1,55 @@
 
-  README
-  ======
+   _           _        ____              _         
+  | |_ __ ___ | |_ _ __|___ \ _ __  _ __ | |_ _ __  
+  | | '_ ` _ \| __| '_ \ __) | '_ \| '_ \| __| '_ \ 
+  | | | | | | | |_| |_) / __/| | | | | | | |_| |_) |
+  |_|_| |_| |_|\__| .__/_____|_| |_|_| |_|\__| .__/ 
+                  |_|                        |_|    
 
-  OSSP lmtp2nntp - mail to news gateway
+  OSSP lmtp2nntp - Mail to News Gateway
+  Version 0.1.0 (08-Sep-2001)
 
-  The lmtp2nntp program is a LMTP service which is usually invoked by a MTA.
-  Input messages get their headers slightly reformatted to match network news
-  article format. The article is then posted or fed into a NNTP service.
-  Delivery must take place immediately or the transaction fails.  A LMTP
-  service relies on the queuing capabilities of its MTA. To support this, the
-  program returns proper delivery status notification which indicates
-  successful completed action, persistent transient failure or permanent
-  failure.
+  ABSTRACT
+
+  The OSSP lmtp2nntp program is an LMTP service for use in conjunction
+  with an MTA (like Sendmail), providing a reliable real-time mail to news
+  gateway. Input messages get their headers slightly reformatted to match
+  Usenet news article format. The article is then posted or feeded into
+  a remote NNTP service (like INN). Delivery must take place immediately
+  or the transaction fails. OSSP lmtp2nntp relies on the queuing
+  capabilities of the MTA in order to provide a fully reliable service.
+  For this the program returns proper delivery status notification which
+  indicates successful completed action, persistent transient failure or
+  permanent failure.
+
+  COPYRIGHT AND LICENSE
+
+  Copyright (c) 2001 The OSSP Project <http://www.ossp.org/>
+  Copyright (c) 2001 Cable & Wireless Deutschland <http://www.cw.com/de/>
+
+  This file is part of OSSP lmtp2nntp, an LMTP speaking local
+  mailer which forwards mails as Usenet news articles via NNTP.
+  It can be found at http://www.ossp.org/pkg/lmtp2nntp/.
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public  License
+  as published by the Free Software Foundation; either version
+  2.0 of the License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this file; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+  USA, or contact the OSSP project <ossp@ossp.org>.
+
+  HOME AND DOCUMENTATION
+
+  The documentation and latest release can be found on
+
+  o http://www.ossp.org/pkg/lmtp2nntp/ [STILL NOT AVAILABLE]
+  o  ftp://ftp.ossp.org/pkg/lmtp2nntp/
 


ossp-pkg/lmtp2nntp/THANKS 1.1 -> 1.2

--- THANKS       2001/09/11 06:43:13     1.1
+++ THANKS       2001/09/13 13:45:12     1.2
@@ -1,10 +1,17 @@
 
+   _           _        ____              _         
+  | |_ __ ___ | |_ _ __|___ \ _ __  _ __ | |_ _ __  
+  | | '_ ` _ \| __| '_ \ __) | '_ \| '_ \| __| '_ \ 
+  | | | | | | | |_| |_) / __/| | | | | | | |_| |_) |
+  |_|_| |_| |_|\__| .__/_____|_| |_|_| |_|\__| .__/ 
+                  |_|                        |_|    
+
+  OSSP lmtp2nntp - Mail to News Gateway
+
   THANKS
-  ======
 
   This is a list of contributors who have written or edited
   parts of the OSSP lmtp2nntp sources or inspired the AUTHORS.
 
-  Christoph Schug <christoph.schug@cw.com>
-  - LMTP idea as an alternative to piping into a script
+  Christoph Schug    <christoph.schug@cw.com>
 


ossp-pkg/lmtp2nntp/argz.html 1.1 -> 1.2



ossp-pkg/lmtp2nntp/lmtp.pod 1.2 -> 1.3



ossp-pkg/lmtp2nntp/lmtp2nntp.c 1.60 -> 1.61

--- lmtp2nntp.c  2001/09/13 12:20:35     1.60
+++ lmtp2nntp.c  2001/09/13 13:45:12     1.61
@@ -83,7 +83,7 @@
 #define NUL '\0'
 #endif
 
-#define ERR_EXECUTION -1
+#define ERR_EXECUTION 1
 #define ERR_DELIVERY -2
 
 #define STDSTRLEN 128


ossp-pkg/lmtp2nntp/lmtp2nntp.pod 1.20 -> 1.21

--- lmtp2nntp.pod        2001/09/12 07:29:23     1.20
+++ lmtp2nntp.pod        2001/09/13 13:45:12     1.21
@@ -28,7 +28,7 @@
 
 =head1 NAME
 
-B<lmtp2nntp> - mail to news gateway
+B<OSSP lmtp2nntp> - mail to news gateway
 
 =head1 SYNOPSIS
 
@@ -47,15 +47,18 @@
 
 =head1 DESCRIPTION
 
-The B<lmtp2nntp> program is a LMTP service which is usually invoked by a MTA.
-Input messages get their headers slightly reformatted to match network news
-article format. The article is then posted or fed into a NNTP service.
-Delivery must take place immediately or the transaction fails.  A LMTP service
-relies on the queuing capabilities of its MTA. To support this, the program
-returns proper delivery status notification which indicates successful
-completed action, persistent transient failure or permanent failure.
+The B<OSSP lmtp2nntp> program is an LMTP service for use in conjunction
+with an MTA (like Sendmail), providing a reliable real-time mail to news
+gateway. Input messages get their headers slightly reformatted to match
+Usenet news article format. The article is then posted or feeded into
+a remote NNTP service (like INN). Delivery must take place immediately
+or the transaction fails. B<OSSP lmtp2nntp> relies on the queuing
+capabilities of the MTA in order to provide a fully reliable service.
+For this the program returns proper delivery status notification which
+indicates successful completed action, persistent transient failure or
+permanent failure.
 
-The following options are available:
+The following command line options and arguments are available:
 
 =over 4
 
@@ -157,37 +160,11 @@
 
 =back
 
-=head1 SENDMAIL INTEGRATION
-
-t.virtusertable
-
-    # mail to news gateway
-    posting+*@first.gateway.example %2@lmtp2nntp
-
-t.mailertable
-
-    # mail to news gateway
-    lmtp2nntp       lmtp2nntp:second.gateway.example
-
-sendmail.m4
-
-    dnl #  Mailer: LMTP2NNTP (mail to news gateway)
-    define(`LMTP2NNTP_MAILER_PATH',         `confMYBINDIR/lmtp2nntp')
-    define(`LMTP2NNTP_MAILER_MAX',          `100000')
-    define(`LMTP2NNTP_MAILER_DELIVERYMODE', `post')
-    define(`LMTP2NNTP_MAILER_GROUPMODE',    `envelope')
-    define(`LMTP2NNTP_MAILER_ARGS',         `-t confMYVARDIR/lmtp2nntp.log')
-    define(`LMTP2NNTP_MAILER_GROUPS',       `alt.test.\* alt.binaries.test')
-    MAILER(lmtp2nntp)
-
 =head1 DIAGNOSTICS
 
-when invoked as LMTP server
-
- 0 = successful execution
- 1 = execution failed
-
-Returning proper delivery status notification is part of the LMTP protocol.
+If invoked it returns 0 on successful execution (not neccessarily
+meaning successful delivery!) or 1 on failed execution. Returning proper
+delivery status notification is part of the LMTP protocol.
 
 =head1 STANDARDS
 
@@ -264,13 +241,5 @@
 
 =back
 
-=head1 AUTHOR
-
- The OSSP Project
- Cable & Wireless Deutschland GmbH
- Thomas Lotterer
- <thomas.lotterer@cw.com>
-
 =cut
 
-


ossp-pkg/lmtp2nntp/shpat_match.3 1.1 -> 1.2

--- shpat_match.3        2001/08/06 10:51:11     1.1
+++ shpat_match.3        2001/09/13 13:45:12     1.2
@@ -1,7 +1,10 @@
 .rn '' }`
-''' $RCSfile: shpat_match.3,v $$Revision: 1.1 $$Date: 2001/08/06 10:51:11 $
+''' $RCSfile: shpat_match.3,v $$Revision: 1.2 $$Date: 2001/09/13 13:45:12 $
 '''
 ''' $Log: shpat_match.3,v $
+''' Revision 1.2  2001/09/13 13:45:12  thl
+''' revamping and polishing documentation files for release
+'''
 ''' Revision 1.1  2001/08/06 10:51:11  thl
 ''' add shpat_match from OSSP shpat library
 '''

CVSTrac 2.0.1