Improved the documentation to reflect the current state, except for
authorJoey Schulze <joey@infodrom.org>
Sat, 17 Nov 2001 22:45:22 +0000 (22:45 +0000)
committerJoey Schulze <joey@infodrom.org>
Sat, 17 Nov 2001 22:45:22 +0000 (22:45 +0000)
what I missed.

dtaus.1
dtaus.5

diff --git a/dtaus.1 b/dtaus.1
index d38a53b..01635f4 100644 (file)
--- a/dtaus.1
+++ b/dtaus.1
@@ -15,7 +15,7 @@
 .\" along with this program; if not, write to the Free Software
 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
 .\"
-.TH DTAUS 1 "11 November 2001" "" ""
+.TH DTAUS 1 "17 November 2001" "" ""
 .SH NAME
 dtaus \- Converter for DTAUS files
 .SH SYNOPSIS
@@ -30,41 +30,185 @@ dtaus \- Converter for DTAUS files
 .IR kontroll " ]"
 .BR -dtaus " | " -control
 .SH DESCRIPTION
-This program can read and write german DTAUS files.  DTAUS is an
-acronym for 
+This program can read and write German DTAUS files.  DTAUS is an
+semi-acronym for 
 .BR D aten T räger AUS tausch.
-It is used by german credit institutes in order to manage money
-exchanges between accounts and credit institutes.
+It is used by German credit institutes in order to manage mass money
+exchanges between customer accounts and credit institutes.
 
-.SH OPTIONS
-You have to specify at one of
-.BR \-dtaus " or " \-control .
-
-  -dtaus        Erzeugt eine Bankdatei
-  -control      Liest eine Bankdatei und erzeugt die Kontrolldateien
-
-  -d <dtaus>    Bankdatei [dtaus0.txt]
-  -c <control>  Steuerdatei [dtaus0.ctl]
-  -b <begleit>  Begleitzettel für die Bank dtaus0.doc]
-  -o <kontroll> Kontrolldatei zum Abheften [dtaus0.sik]
+Due to its limited availability and usefulness most of the
+documentation is held in German.  This program is only useful in
+Germany or for companies that act in Germany.
 
-.SH "CONTROL FILE"
-The control file has a very simple format.  Empty lines and those
-beginning with a hash mark are ignored.  The remainder is splitted
-into three parts, one BEGIN record, several regular records and one
-END record, which is being ignored and created by the program.
-
-For a complete description please refer to
+For a complete description of the control file please refer to
 .I dtaus.txt
 and
 .BR dtaus (5)
 from this distribution.
+.SH OPTIONS
+You have to specify exactly one of
+.BR \-dtaus " or " \-control .
+.TP
+.B \-dtaus
+Liest die Kontrolldatei ein und erzeugt daraus die Bankdatei sowie
+alle anderen benötigten Dateien.
+.TP
+.B \-control
+Liest eine Bankdatei ein und erzeugt daraus die Kontrolldatei,
+dekodiert eine bereits erstellte Bankdatei.
+.TP
+.BI \-d " dtaus"
+Explizite Angabe des Dateinamens für die Bankdatei.  Voreingestellt
+ist
+.BR dtaus0.txt ,
+was von der Bank als einziger Dateiname auf der Diskette erwartet
+wird.  Für Testzwecke oder zur Weiterverarbeitung darf hier die
+spezielle Datei ``-'' angegeben werden, wodurch
+.B dtaus
+angewiesen wird, auf die Standardausgabe zu schreiben.
+.TP
+.BI \-c " control"
+Explizite Angabe des Dateinamens der Steuerdatei.  Voreingestellt ist
+.BR dtaus0.ctl .
+Da dieser Name jedoch nur intern verwendet wird, ist er keinen
+Beschränkungen unterlegen.  In dieser Datei befinden sich die gesamten
+visuell lesbaren Informationen für den Geldverkehr.  Diese Datei muß
+für die Bank in das spezielle DTAUS-Format konvertiert werden.  Das
+geschieht mit dem Schalter
+.BR \-dtaus .
+.TP
+.BI \-b " begleit"
+Explizite Angabe des Dateinamens des Begleitzettels.  Voreingestellt ist
+.BR dtaus0.doc .
+Da dieser Name jedoch nur intern verwendet wird, ist er keinen
+Beschränkungen unterlegen.  Diese Datei muß ausgedruckt und der
+Diskette unterschrieben beigelegt werden.
+.TP
+.BI \-o " kontroll"
+Explizite Angabe des Dateinamens für die Kontrolldatei.  Voreingestellt ist
+.BR dtaus0.sik .
+Da dieser Name jedoch nur intern verwendet wird, ist er keinen
+Beschränkungen unterlegen.  Es ist ratsam, diese Datei gut
+aufzubewahren oder auszudrucken und abzuheften.  Dieses ist neben der
+Steuer- und Bankdatei die einzige Aufschlüsselung des getätigten
+Geldverkehrs.
+.SH BESCHREIBUNG
+Deutsche Banken bieten für Großkunden oder Kunden mit vielen ähnlichen
+Überweisungen oder Bankeinzügen (auch Lastschriften genannt) die
+Möglichkeit des papierlosen Geldverkehrs über den Beleglosen
+Datenträgeraustausch an.  Hierbei wird nicht mehr für jede Überweisung
+oder jeden Einzug ein eigenes Formular benötigt, sondern
+zusammengehörige Aufträge werden in einer Massensendung verpackt
+gemeinsam verarbeitet.
 
+Hier ist jedoch Vorsicht geboten, denn auf dem eigenen Konto erscheint
+lediglich eine einzige Kontobewegung.  Wenn Geld eingezogen wird,
+enthält der Kontoauszug nur die Gesamtsumme, wenn Geld überwiesen
+wird, ist auf dem Kontoauszug nur die Gesamtsumme notiert.  Es ist
+daher immens wichtig, die Ursprungsdaten aufzubewahren bzw. die
+Kontrolldatei auszudrucken und abzuheften.
+
+Um an diesem Verfahren teilzunehmen, das den Geldverkehr für
+Organisationen erheblich vereinfachen kann, muß mit der jeweiligen Bank
+eine gesonderte Vereinbarung getroffen werden, in der die speziellen
+Bestimmungen für diesen Datenträgeraustausch akzeptiert werden.
+
+Durch das einfache Format der Steuerdatei läßt sich dieses Verfahren
+leicht mit einer Datenbank oder einem größeren Programm koppeln.  In
+der Tat entstand das Programm nach Aufbau des ersten Wohnheimnetzes in
+Oldenburg (Oldbg.) und der ernüchternden Erkenntnis, daß die vom
+Kassenwart verwendeten Programme für den Datenträgeraustausch weder
+zuverlässig noch nachvollziehbar arbeiteten und somit Ersatz
+geschaffen werden mußte.  Die technische und finanzielle Verwaltung
+des Wohnheimnetzes fand über ein Linux-System mit Datenbankanbindung
+sowie
+.B dtaus
+statt.
+.SH BESONDERHEITEN
+Bei der Verwendung dieses Programms müssen wenigstens die folgenden
+Dinge beachtet werden, es sind Vorgaben von den beteiligten Banken.
+.TP
+1.
+Die Diskette muß mit dem MSDOS-Dateisystem beschrieben sein.
+.TP
+2.
+Auf einer Diskette darf nur eine einzige DTAUS-Datei enthalten sein,
+die den Dateinamen
+.B DTAUS0.TXT
+trägt.
+.TP
+3.
+Der Diskette muß ein Begleitzettel beigelegt werden, der einige
+Angaben erneut enthält sowie persönlich unterschrieben ist.  Dieser
+Begleitzettel wird von
+.B dtaus
+automatisch erzeugt und voreingestellt in der Datei
+.B dtaus0.doc
+gespeichert, die nur noch ausgedruckt und unterschrieben werden muß.
+.TP
+4.
+Um den Beleglosen Datenträgeraustausch nutzen zu können, muß vorher
+eine Zusatzvereinbarung mit der Bank getroffen werden.
+.TP
+5.
+Die Angaben zum Verwendungszweck haben sich ausschließlich auf den
+jeweiligen Zahlungsverkehrsvorgang zu beziehen.
+Verwendungszweckangaben dürfen nicht die Übermittlung einer
+gesonderten Nachricht außerhalb des Zahlungsverkehrs (z.B. Rechnung,
+Lohn- und Gehaltsabrechnung) ersetzen.  Werbetexte dürfen in den
+Verwendungszweckangaben nicht enthalten sein.
+.TP
+6.
+Der Kunde ist verpflichtet, den Inhalt der von ihm gelieferten
+Datenträger mindestens für einen Zeitraum von zehn Kalendertagen ab
+Einlieferung in der Form nachweisbar zu halten, daß dem Institut auf
+Anforderung kurzfristig besonders gekennzeichnete Duplikatsdatenträger
+geliefert werden können.
+.TP
+7.
+Der Rückruf eines Datenträgers ist ausgeschlossen, sobald das
+Kreditinstitut mit dessen Verarbeitung begonnen hat.  Einzelne
+Überweisungen und Lastschriften können nach Verarbeitung eines
+Datenträgers nur außerhalb des Datenträgeraustauschverfahrens
+zurückgerufen werden.
+.TP
+8.
+Das Kreditinstitut führt Konsistenzprüfungen der auf dem Datenträger
+gespeicherten Datei durch.  Schlägt diese fehl, können einzelne
+Datensätze von der Bearbeitung ausgeschlossen oder der gesamte
+Auftrag verworfen werden.
+.TP
+9.
+Ergeben sich bei der Kontrolle der Datenträger durch das
+Kreditinstitut Fehler, so wird es die fehlerhaften Datensätze in ihrem
+vollständigen Inhalt nachweisen und sie dem Kunden unverzüglich
+mitteilen.
+.TP
+10.
+Das Kreditinstitut gibt dem Kunden die von ihm erhaltenen Datenträger
+zurück.  Sie können meistens schon am nächsten Werktag in der Filiale
+abgeholt werden.
+.TP
+11.
+Gutschriften und Belastungen, die auf einem an den Kunden
+ausgelieferten Datenträger enthalten sind, werden als Sammelbuchungen
+auf dem Konto des Kunden gebucht.
+.TP
+12.
+In einer Bankdatei kann ein Ausführungsdatum angegeben werden, wenn
+die Bearbeitung der Diskette zu einem späteren Zeitpunkt als der
+Abgabe der Datei gewünscht wird.  Dieses Datum darf jedoch nicht
+jünger als das Erstellungsdatum (wird automatisch von
+.B dtaus
+eingefügt) sein und höchstens 15 Kalendertage über dem
+Erstellungsdatum liegen.
 .SH "RETURN VALUES"
 On success, zero is returned.  On error, 1  is  returned.
-
 .SH "SEE ALSO"
 .BR dtaus (5).
 
-DTAUS files use a special but simple and freely documented format.
-It is included in the distribution of dtaus as dtaus.txt.
+DTAUS files use a special but simple and publically documented format.
+It is included in the distribution of
+.B dtaus
+as
+.IR dtaus.txt .
diff --git a/dtaus.5 b/dtaus.5
index 372f5ac..cfd0e80 100644 (file)
--- a/dtaus.5
+++ b/dtaus.5
 .\" along with this program; if not, write to the Free Software
 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
 .\"
-.TH DTAUS 5 "11 November 2001" "" ""
+.TH DTAUS 5 "17 November 2001" "" ""
 .SH NAME
 dtaus \- Converter for DTAUS files
 .SH DESCRIPTION
 The
 .BR dtaus (1)
-program reads and writes German DTAUS files.  DTAUS is an acronym for
+program reads and writes German DTAUS files.  DTAUS is an semi-acronym for
 .BR D aten T räger AUS tausch.
 It is used by German credit institutes in order to implement money
 exchanges between accounts and credit institutes.  These files are
 always called
-.IR dtaus0.txt .
+.IR DTAUS0.TXT .
 
 Since they are shipped in a weird ascii format that is not quite
-readable and writable for humans a special control format was
-implemented.  The
+readable and writable for human beings a special control format was
+invented.  The
 .BR dtaus (1)
 program reads and writes such a control file and generates a proper
-DTAUS file if requested.
-
+DTAUS file if requested or decodes one.
 .SH "CONTROL FILE"
-The control file implements a very simple format.  Empty lines and
-those beginning with a hash (`#') mark are ignored.  The remaining
-file is splitted into three major parts: one BEGIN record, several
-regular records and one optional END record, which is ignored when the
-file is read but is extracted from the
-.I dtaus0.txt
-file.
+The control file implements a very simple format which was invented
+only for use with the
+.BR dtaus (1)
+program.  Like with many *nix configuration files empty lines and
+those beginning with a hash mark (``#'') are ignored.  The remaining
+file is splitted into three major parts: one BEGIN record
+(representing the A record), several regular records (representing C
+records) and one optional END record (representing the E record),
+which is ignored when the control file is read but is extracted from
+the bank file if one is decoded.
 
 Here's a short sample for a control file:
 
   BEGIN {
-    Art   \fI<type>\fR
+    Art   \fItype\fR
     Name  Martin Schulze
     Konto 123545
     BLZ   2004002
+    Ausfuehrung 23.12.2001
+    Euro
   }
 
   {
-    Transaktion \fI<transaction>\fR
+    Transaktion \fItransaction\fR
     Name   Martha Schulze
     Konto  98832
     BLZ    2004003
@@ -65,13 +69,31 @@ Here's a short sample for a control file:
 
   ...
 
+Please note that several field names are used in both the BEGIN and
+the regular record.  When used in the BEGIN record they denote your
+name and your bank account.  When used in a regular record they are
+affiliated with your customers data.
+
 You may use up to 15 fields entitled as
 .BR Text .
 They will be recorded one by one and stored into additional data
 records using the same order.  This way you could add a detailed
-description of the type of money transfer if you like.
+description of the type of money transfer if you like.  The contents
+of the field
+.B Zweck
+are most probably what the customer will see on their bank statements.
 
-.SS <type>
+The field
+.B Ausfuehrung
+is optional and denotes the day when the entire transaction should be
+processed.  The date has to be given as DD.MM.YYYY and will be
+translated into the resulting bank file literally.  It may not be
+younger than the creation date of the file which will automatically be
+inserted by
+.BR dtaus (1).
+The processing date also may not be more than 15 years later than the
+creation date.
+.SS Explanation of type
 One of the following:
 .TP
 .I LK
@@ -85,27 +107,44 @@ Lastschrift Bankseitig
 .TP
 .I GB
 Gutschrift Bangseitig
-
-.SS <transaction>
+.SS Explanation of transaction
 One of the following:
 .TP
-.I Lastschrift
+.I Einzug
 Bankeinzug
 .TP
 .I Gutschrift
 Überweisung
-
-.SS Character Encoding
-German Umlauts are converted to two 7-bit characters on the fly so you
+.PP
+You may only use one of these for the entire file.  You are not
+allowed to switch between Einzug and Gutschrift within the same file.
+If you require the credit institute to process both types, you'll have
+to provide two separate diskettes.
+.SS "Support for Euro"
+From January 1st 2002 the currency in many European countries, Germany
+is among these, changes to Euro.  Hence, money transfer changes from DM
+(formerly known as ``Deutsche Mark'') to Euro.  The format
+specification of DTAUS was meant for DM but was modified in 2001 to
+support Euro as well.  The current version of
+.BR dtaus (1)
+supports both currencies.  It defaults to using DM, however.  To
+switch to Euro, simply add the keyword
+.B Euro
+to the BEGIN record.
+.SS "Character Encoding"
+German Umlauts are converted into two 7-bit characters on the fly so you
 don't need to care about them.  Since the
-.I dtaus0.txt
+.I DTAUS0.TXT
 file only uses uppercase letters every text is also converted to
 uppercase.
 
 Except for the way records are delimited the format should be self
 explanatory.
-
 .SH "SEE ALSO"
-DTAUS files use a special but simple and freely documented format.
-It is included in the distribution of dtaus as
+.BR dtaus (1).
+
+DTAUS files use a special but simple and publically documented format.
+It is included in the distribution of
+.BR dtaus (1)
+as
 .IR dtaus.txt .