.gitignore: Update
[AROS.git] / tools / dtdesc / README
blob93846d923de9dfbc98fbb33cd862fb5ca42a7c68
1 dtdesc - The DataType Descriptor Tools
3 Here you have two tools to create and disassemble DataType descriptors.
4 DataType descriptors are those little files in Devs:DataTypes/ , which
5 are used by the DataType system to recognice the type of a file.
6 DataType descriptors are IFF-FORMs of type DTYP.
7 They contain different chunks. The most important are:
9 NAME : Name of the DataType, in most cases identical to the filename
11 FVER : Amiga-version-string (optional)
13 DTHD : DataTypeHeader The most important chunk.
14        Contains a struct DataTypeHeader as descriped in <datatypes/datatypes.h>
15        and the strings for this struct.
17 DTCD : Code-chunk This chunk contains executable code. So you can have
18        a function to decide the type of a file.
19        Because this is not portable to AROS, it is not supported by dtdesc.
21 For more informations see the header <datatypes/datatypes.h> .
23 examinedtdesc is used to disassemble an existing DataType descriptor.
24 It accepts as its only argument the filename of a DataType descriptor.
25 It outputs a DataType description suitable for createdtdesc (see below)
26 to stdout. This DataType description is an ASCII-file, for details see
27 the file FORMAT .
29 createdtdesc is a tool to create a DataType descriptor.
30 It has one required argument: the filename of a DataType description (*.dtd file).
31 Optional with the "-o" switch you can define the Name of the output
32 DataType descriptor.
33 When no output-name is given, the name for the Datatype descriptor is taken
34 from the "Name" keyword from the Datatype description. The resulting
35 Datatype descriptor is placed in the current directory.
37 Yes I know my naming convention is a bit confusing, come with better names!