Use preprocessor defines for default filenames, so that they won't be
[infodrom/dtaus] / dtaus.5
1 .\" dtaus - Converter for DTAUS files
2 .\" Copyright (c) 2000,1,3  Martin Schulze <joey@infodrom.org>
3 .\"
4 .\" This program is free software; you can redistribute it and/ormodify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
8 .\"
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 .\" GNU General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program; if not, write to the Free Software
16 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 .\"
18 .TH DTAUS 5 "17 November 2001" "" ""
19 .SH NAME
20 dtaus \- Converter for DTAUS files
21 .SH DESCRIPTION
22 The
23 .BR dtaus (1)
24 program reads and writes German DTAUS files.  DTAUS is an semi-acronym for
25 .BR D aten T räger AUS tausch.
26 It is used by German credit institutes in order to implement money
27 exchanges between accounts and credit institutes.  These files are
28 always called
29 .IR DTAUS0.TXT .
30
31 Since they are shipped in a weird ascii format that is not quite
32 readable and writable for human beings a special control format was
33 invented.  The
34 .BR dtaus (1)
35 program reads and writes such a control file and generates a proper
36 DTAUS file if requested or decodes one.
37 .SH "CONTROL FILE"
38 The control file implements a very simple format which was invented
39 only for use with the
40 .BR dtaus (1)
41 program.  Like with many *nix configuration files empty lines and
42 those beginning with a hash mark (``#'') are ignored.  The remaining
43 file is splitted into three major parts: one BEGIN record
44 (representing the A record), several regular records (representing C
45 records) and one optional END record (representing the E record),
46 which is ignored when the control file is read but is extracted from
47 the bank file if one is decoded.
48
49 Here's a short sample for a control file:
50
51   BEGIN {
52     Art   \fItype\fR
53     Name  Martin Schulze
54     Konto 123545
55     BLZ   2004002
56     Ausfuehrung 23.12.2001
57     Euro
58   }
59
60   {
61     Transaktion \fItransaction\fR
62     Name   Martha Schulze
63     Konto  98832
64     BLZ    2004003
65     Betrag 20.00
66     Zweck  Gebühr Wohnheimnetz
67     Text   Anschluß u. 11+12.97
68   }
69
70   ...
71
72 Please note that several field names are used in both the BEGIN and
73 the regular record.  When used in the BEGIN record they denote your
74 name and your bank account.  When used in a regular record they are
75 affiliated with your customers data.
76
77 You may use up to 15 fields entitled as
78 .BR Text .
79 They will be recorded one by one and stored into additional data
80 records using the same order.  This way you could add a detailed
81 description of the type of money transfer if you like.  The contents
82 of the field
83 .B Zweck
84 are most probably what the customer will see on their bank statements.
85
86 The field
87 .B Ausfuehrung
88 is optional and denotes the day when the entire transaction should be
89 processed.  The date has to be given as DD.MM.YYYY and will be
90 translated into the resulting bank file literally.  It may not be
91 younger than the creation date of the file which will automatically be
92 inserted by
93 .BR dtaus (1).
94 The processing date also may not be more than 15 years later than the
95 creation date.
96 .SS Explanation of type
97 One of the following:
98 .TP
99 .I LK
100 Lastschrift Kundenseitig
101 .TP
102 .I GK
103 Gutschrift Kundenseitig
104 .TP
105 .I LB
106 Lastschrift Bankseitig
107 .TP
108 .I GB
109 Gutschrift Bankseitig
110 .SS Explanation of transaction
111 One of the following:
112 .TP
113 .I Einzug
114 Bankeinzug
115 .TP
116 .I Gutschrift
117 Überweisung
118 .TP
119 .IR Vermögen " [JJJJ]"
120 Vermögenswirksame Leistung mit Sparzulage.  Als Argument kann das Jahr
121 angegeben werden, für das diese Leistung gilt.  Wenn es weggelassen,
122 wird, verwendet
123 .B dtaus
124 das aktuelle Jahr.  Vom Jahr wird nur die letzte Ziffer verwendet, es
125 muß daher auch nicht vollständig angegeben werden.
126 .TP
127 .IR Vermoegen " [JJJJ]"
128 Wie
129 .IR Vermögen ,
130 jedoch ohne Umlaut.
131 .TP
132 .I E-Cash
133 Lastschrift aus Verfügung im elecctronic Cash-System
134 .TP
135 .I E-Cash-A
136 Lastschrift aus Verfügung im elecctronic Cash-System mit ausländischer Karte.
137 .PP
138 You may only use one of these for the entire file.  You are not
139 allowed to switch between Einzug and Gutschrift within the same file.
140 If you require the credit institute to process both types, you'll have
141 to provide two separate diskettes.
142 .SS "Support for Euro"
143 From January 1st 2002 the currency in many European countries, Germany
144 is among these, changes to Euro.  Hence, money transfer changes from DM
145 (formerly known as ``Deutsche Mark'') to Euro.  The format
146 specification of DTAUS was meant for DM but was modified in 2001 to
147 support Euro as well.  The current version of
148 .BR dtaus (1)
149 supports both currencies.  It defaults to using Euro, however.  To
150 switch to DM, simply add the keyword
151 .B DM
152 (or
153 .B Euro
154 respectively if this version was compiled without Euro support as default)
155 to the BEGIN record.  If no currency keyword is given, the compiled in
156 decides (upstream source defaults to Euro).
157 .SS "Character Encoding"
158 German Umlauts are converted into two 7-bit characters on the fly so you
159 don't need to care about them.  Since the
160 .I DTAUS0.TXT
161 file only uses uppercase letters every text is also converted to
162 uppercase.
163
164 Except for the way records are delimited the format should be self
165 explanatory.
166 .SH "SEE ALSO"
167 .BR dtaus (1).
168
169 DTAUS files use a special but simple and publically documented format.
170 It is included in the distribution of
171 .BR dtaus (1)
172 as
173 .IR dtaus.txt .