- Added short description for control files

[infodrom/dtaus] / dtaus.5

diff --git a/dtaus.5 b/dtaus.5
new file mode 100644 (file)
index 0000000..8203529
--- /dev/null
+++ b/dtaus.5
@@ -0,0 +1,80 @@
+.\" dtaus - Converter for DTAUS files
+.\" Copyright (c) 2000  Martin Schulze <joey@infodrom.north.de>
+.\"
+.\" This program is free software; you can redistribute it and/ormodify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 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 program; if not, write to the Free Software
+.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+.\"
+.TH DTAUS 5 "4 January 2000" "" ""
+.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
+.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 .
+
+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
+.BR dtaus (1)
+program reads and writes such a control file and generates a proper
+DTAUS file if requested.
+
+.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.
+
+Here's a short sample for a control file:
+
+  BEGIN {
+    Art   LK
+    Name  Martin Schulze
+    Konto 123545
+    BLZ   2004002
+  }
+
+  {
+    Transaktion Einzug
+    Name   Martha Schulze
+    Konto  98832
+    BLZ    2004003
+    Betrag 20.00
+    Zweck  Gebühr Wohnheimnetz
+    Text   Anschluß u. 11+12.97
+  }
+
+  ...
+
+German Umlauts are converted on the fly so you don't need to care
+about them.  Since the
+.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
+.IR dtaus.txt .