home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / h2uni110.zip / h2unit.zip / H2Unit.txt < prev   
Text File  |  2001-10-31  |  10KB  |  265 lines
  1. ==============================================================================
  2.                English and German documentation for H2Unit
  3. ==============================================================================
  4.  
  5. ------------------------------------------------------------------------------
  6. H2Unit  Version 1.10  Copyright (c) 1997-2001 by ws it-service, Wolfram Schmid
  7. ------------------------------------------------------------------------------
  8.  
  9. What is H2Unit?
  10.  
  11.   H2Unit reads preprocessor #DEFINE definitions out of C header file (.H)
  12.   and creates a Pascal interface Unit (.PAS) with corresponding constants
  13.   (CONST).
  14.  
  15.   The assortment of the Pascal constants in the created unit can optional
  16.   be carried out by name or by the value of the constants.
  17.  
  18.   As version information for your projects, constants (with counter,
  19.   date and time) are being set out in the created Pascal unit.
  20.   (refer to 'Usage and options')
  21.  
  22.   H2Unit is available for OS/2 and for Windows 95/NT (Win32).
  23.   The OS/2 Version runs with OS/2 2.x, OS/2 Warp 3 and OS/2 Warp 4.
  24.  
  25.   H2Unit was developed with Virtual Pascal/2 v1.1 and Virtual Pascal 2.0
  26.   from fPrint UK Ltd (http://www.fprint.co.uk).
  27.  
  28.  
  29. For whome is H2Unit:
  30.  
  31.   H2Unit is for software developers, who develope under OS2 with Pascal
  32.   (eg. with Virtual Pascal/2 or Speed Pascal/2) and who want to use the
  33.   #define constants out of .H files in their Pascal programs.
  34.  
  35.   Thus you are able to use in your Pascal project the .H file, witch is
  36.   created by the URE (Universal Resource Editor, Prominare Inc) automaticaly.
  37.  
  38.  
  39. Contents:
  40.  
  41.   The following files are contained in H2Unit.Zip:
  42.  
  43.   H2Unit.exe  The OS/2 program
  44.   H2Unit.txt  This documentation
  45.  
  46.  
  47. Usage and options:
  48.  
  49.   Usage:    h2unit Source[.h] [Dest[.pas]] [Options]
  50.  
  51.   Source:   The name of the C source file. If no extension is given, then .H is
  52.             assumed as default.
  53.  
  54.   Dest:     The name of the C destination file. If no destination name is
  55.             given, the name will be taken from the soure file. If no extension
  56.             is given, then .PAS is assumed as default.
  57.  
  58.  
  59.   Optionen: /sn   The generated constants are sorted by the name.
  60.  
  61.             /sv   The generated constants are sorted by the value
  62.                   of the constants.
  63.  
  64.             /o    Overwrite an existng destination file without prompting.
  65.  
  66.   If you use H2Unit without any arguments, than a short helptext will be shown.
  67.  
  68.  
  69. Version Information:
  70.  
  71.   H2Unit creates in the produced Pascal Unit additional constants which you
  72.   can use as version information in your project.
  73.  
  74.   Following constants are created:
  75.  
  76.     xxxBuild            A counter which is increased at each use of H2Unit
  77.                         for a certain destination file.
  78.  
  79.     xxxBuildDate        Date and Time, when the destination file was created.
  80.     xxxBuildTime
  81.  
  82.     xxxBuildDateStr     Date and Time, when the destination file was created
  83.     xxxBuildTimeStr     as Pascal String.
  84.  
  85.     xxxBuildDateFirst   Date and Time, when the destination file was created
  86.     xxxBuildTimeFirst   for the first time.
  87.  
  88.     xxx stands for the Pascal destination file name.
  89.  
  90.   In order to create this data, H2Unit creates a data file with the extension
  91.   .H2U on the first use for every destination file. There, the counter as well
  92.   as date and time are stored of the first use.
  93.   For example if you create out of ABC.H the unit ABC.PAS, then the file
  94.   ABC.H2U is created on the first use, the counter is initialized to 1 and
  95.   date and time are stored.
  96.  
  97.  
  98. Restrictions:
  99.  
  100.   At the moment only #define instructions with constant values
  101.   are read (eg. #define xyz 0815).
  102.   Calculated expressions as #define xyz abc+10 are not processd.
  103.   Maximum 4096 #defines are processed.
  104.  
  105.  
  106. Freeware:
  107.  
  108.    H2Unit is free of charge and may be distributed freely under the following
  109.    conditions: Copyright notices must not be removed, all files contained in
  110.    the file inventory below must be distributed together (you may not remove
  111.    any files), and you may not charge for the program.
  112.  
  113.    If you find the program useful then send an email to: w.schmid@swol.de.
  114.  
  115.    Of course, no liability is taken for eventual damages which come from
  116.    H2Unit.
  117.  
  118.  
  119. Ideas, requests and errors:
  120.  
  121.   In case you need a function urgently, or if you have suggestions
  122.   for improvements or changes or you found a mistake, please contact
  123.   me by e-mail: w.schmid@elo-soft.com.
  124.  
  125.   Please also send an e-mail if you are using this program.
  126.  
  127.  
  128. Wolfram Schmid
  129.  
  130.  
  131. * All registered trademarks mentioned on these document are registered 
  132.   trademarks or trademarks of their respective holders.
  133.  
  134.  
  135. ------------------------------------------------------------------------------
  136. H2Unit  Version 1.10  Copyright (c) 1997-2001 by ws it-service, Wolfram Schmid
  137. ------------------------------------------------------------------------------
  138.  
  139. Was ist H2Unit?
  140.  
  141.   H2Unit liest Präprozessor #DEFINE Anweisungen aus einer C Headerdatei (.H)
  142.   ein und erzeugt eine Pascal Interface Unit (.PAS) mit entsprechenden Pascal
  143.   Konstanten (CONST).
  144.  
  145.   Die Ausgabe der Pascal Konstanten in der erzeugten Unit kann optional
  146.   aufsteigend nach Namen oder nach dem Wert der Konstanten sortiert werden.
  147.  
  148.   Als Versionsinformationen für Ihre Projekte werden in der erzeugten
  149.   Pascal Unit Konstanten mit Zähler, Datum und Uhrzeit angelegt
  150.   (Siehe: Aufruf und Optionen).
  151.  
  152.   H2Unit ist verfügbar für OS/2 und für Windows 95/NT (Win32).
  153.   Die OS/2 Version läuft mit OS/2 2.x, OS/2 Warp 3 und OS/2 Warp 4.
  154.  
  155.   H2Unit wurde mit Virtual Pascal/2 v1.1 und Virtual Pascal 2.0 von 
  156.   fPrint UK Ltd entwickelt (http://www.fprint.co.uk/vpascal).
  157.  
  158.  
  159. Für wen ist H2Unit:
  160.  
  161.   H2Unit ist für Programmierer die unter OS2 mit Pascal programmieren
  162.   (z. B. mit Virtual Pascal/2 oder Speed Pascal/2) und die #define Konstanten
  163.   aus .H Dateien in ihrem Pascal Programm verwenden möchten.
  164.  
  165.   Sie können so z. B. die vom URE (Universal Resource Editor, Prominare Inc.)
  166.   automatisch erzeugte .H Datei in Ihrem Pascal Projekt nutzen.
  167.  
  168.  
  169. Inhalt:
  170.  
  171.   The following files are contained in H2Unit.Zip:
  172.  
  173.   H2Unit.exe  OS/2 Programmdatei
  174.   H2Unit.txt  Diese Datei
  175.  
  176.  
  177. Aufruf und Optionen:
  178.  
  179.   Aufruf:   h2unit Source[.h] [Dest[.pas]] [Options]
  180.  
  181.   Source:   Der Name der C Quelldatei. Wird keine Erweiterung angegeben, so
  182.             wird standardmäßig .H angenommen.
  183.  
  184.   Dest:     Der Name der Pascal Zieldatei. Wird keine Datei angegeben, wird
  185.             der Namen aus der Quelldatei übernommen. Wird keine Erweiterung
  186.             angegeben, wird .PAS angenommen.
  187.  
  188.   Optionen: /sn   Sortiert die erzeugten Konstanten aufsteigend nach dem Namen.
  189.  
  190.             /sv   Sortiert die erzeugten Konstanten aufsteigend nach dem Wert
  191.                   der Konstan.
  192.  
  193.             /o    Überschreiben einer schon vorhandenen Zieldatei ohne
  194.                   vorherige Abfrage.
  195.  
  196.   Rufen sie H2Unit ohne Argumente auf, dann wird ein kurzer Hilfetext
  197.   ausgegeben.
  198.  
  199.  
  200. Versionsinformationen:
  201.  
  202.   H2Unit legt in der erzeugten Pascal Unit zusätzlich Konstanten an, die Sie
  203.   als Versioninformationen in Ihrem Projekt benutzen können.
  204.   Folgende Konstanten werden angelegt:
  205.  
  206.     xxxBuild            Ein Zähler, der bei jedem Aufruf von H2Unit erhöht
  207.                         wird (für eine bestimmte Zieldatei).
  208.  
  209.     xxxBuildDate        Datum und Uhrzeit, wann die Zeildatei erzeigt wurde.
  210.     xxxBuildTime
  211.  
  212.     xxxBuildDateStr     Datum und Uhrzeit, wann die Zeildatei erzeigt wurde
  213.     xxxBuildTimeStr     als Pascal String
  214.  
  215.     xxxBuildDateFirst   Datum und Uhrzeit, wann die Zieldatei das erste mal
  216.     xxxBuildTimeFirst   erzeugt wurde.
  217.  
  218.     xxx Steht für den Namen der Zieldatei (Dest).
  219.  
  220.   Um diese Daten generieren zu können, legt H2Unit beim ersten Aufruf für
  221.   jede Zieldatei .PAS eine Datendatei mit der Endung .H2U an. Darin wird der
  222.   Zähler sowie Datum und Uhrzeit des ersten Aufrufs gespeichert.
  223.   Erzeugen Sie beispielsweise aus ABC.H die Datei ABC.PAS, wird beim ersten
  224.   Aufruf die Datei ABC.H2U angelegt.
  225.  
  226.  
  227. Beschränkungen:
  228.  
  229.   Im Augenblick werden nur #define Anweisungen mit konstanten Werten
  230.   (z. B in der Form #define xyz 0815) eingelesen.
  231.   Berechnete Ausdrücke wie (z. B. #define xyz abc+10) werden nicht verarbeitet.
  232.   Es werden maximal 4096 Konstanten verarbeitet.
  233.  
  234.  
  235. Freeware:
  236.  
  237.   H2Unit ist kostenlos und darf an dritte unter folgenden Bedingungen
  238.   weitergegeben werden: Copyright Texte dürfen nicht entfernt werden.
  239.   Alle oben aufgeführten Dateien müssen unverändert und vollständig
  240.   weitergegeben werden und sie dürfen das Programm nicht verkaufen.
  241.  
  242.   Hier genannte eingetragenen Wahrenzeichen sind Eigentum des jeweiligen
  243.   Herstellers.
  244.  
  245.   Für durch H2Unit eventuell entstandene Schäden oder Folgeschäden wird
  246.   natürlich keinerlei Haftung übernommen.
  247.  
  248.  
  249. Anregungen, Wünsche und Fehler:
  250.  
  251.   Benötigen Sie dringend eine Funktion, haben Sie Verbesserungs- oder
  252.   Änderungswünsche - oder haben sie einen Fehler entdeckt, dann wenden
  253.   Sie sich bitte per e-mail an w.schmid@elo-soft.com.
  254.  
  255.   Wenn Sie das Programm brauchbar finden senden Sie doch bitte ebenfalls
  256.   eine e-mail.
  257.  
  258.  
  259. Wolfram Schmid
  260.  
  261. =============================================================================
  262.  
  263. * Alle, in diesem Text genannten eingetragenen Warenzeichen sind alleiniges
  264.   Eigentum der jeweiligen Hersteller.
  265.