home *** CD-ROM | disk | FTP | other *** search
/ Dream 48 / Amiga_Dream_48.iso / Atari / c / sozobon-v2x / sozuti08.zoo / sozdistr / readme
Text File  |  1995-04-20  |  19KB  |  472 lines
  1. Sozobon eXtended version (ATARI)
  2.  
  3. readme in english and german
  4.  
  5. to distribution of Apr 9  1995 & Apr 16 1995
  6. (sozbin10.lzh), (sozlib13.lzh), (sozuti08.zoo)
  7.     with file sozupd08.zoo you can completetely update from
  8.     Apr 9th dist to Apr 16th dist
  9.  
  10. updating hints:
  11. bug in ar fixed, wrong libsort binary exchanged
  12.  
  13. updating from older versions (1994):
  14. The structure in 'sozdistr/doc' has completely changed, so remove
  15. this directory bevor unpacking or copying!
  16. hcc:         IEEE 64 Bit floating point support
  17. libm:        now the pml, for IEEE support
  18. libc:        IEEE support, bugfixes
  19. startups:    some new ones
  20. xgemfast:    MagiC support
  21. see '*.chg' files for further information!!
  22.  
  23.  
  24. This is the only file with 'CRLF' newlines in this distribution, I
  25. think. If anyone has trouble with missing '^M's I can change this.
  26.  
  27. This SOZOBON version is based on SOZOBON-C 2.00 release of Sozobon Limited
  28. (Tony Andrews, Johann Ruegg and Joe Treat). It includes a library based on
  29. Dale Schumacher's Dlibs and Ian Lepore's Gemfast.  Changes by Holger Weets,
  30. Christian Wempe and Jerry Geiger, with the help of Harun Scheutzow
  31. and Michel Forget.
  32. Now we have two new peolpe helping to maintain SozobonX, this is
  33. Volker Seebode for hcc, top and Thorsten Roskowetz for jas.
  34.  
  35.  
  36. The documents are based on original distributions' ones.
  37.  
  38. SozobonX is distributed in five archives:
  39. The files 'sozbinXX.lzh', 'sozlibXX.lzh', and 'sozutiXX.lzh', are the
  40. standard parts. The XX stands for each file's distribution number.
  41. The file 'sozc68XX.lzh' with Thosten Roskowetz's c68 port, and the 
  42. file 'mntsoxXX', the MiNT library (Scott Bigham) where the 'XX' is the 
  43. patch level.
  44. It is guaranteed that the highest numbers always fit together -- as far as I
  45. guarantee anything. So the mntsox44.lzh won't work using doubles at all.
  46. The files will be called sozlib, sozbin and sozuti in the documentation.
  47.  
  48.  
  49. COPYRIGHT
  50.  
  51.     The Sozobon C-Compiler is freeware.  The archives 'sozbin', 'sozlib',
  52. and 'sozutil' may be freely copied, so long as they are not sold nor
  53. changed.  This package may not be distributed in any PD-Library or
  54. Shareware series. 
  55.  
  56.    If you want to add this compiler system or parts of SOZOBONX to any
  57. commercial software distribution (CDs etc) please contact me for a 
  58. permission.
  59.  
  60.  
  61. DISCLAIMER
  62.  
  63.     IN NO EVENT WILL I AND/OR ANY OTHER PARTY BE LIABLE TO YOU FOR DAMAGES,
  64. INCLUDING ANY LOST PROFITS, LOST MONIES, OR OTHER SPECIAL, INCIDENTAL OR
  65. CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE (INCLUDING
  66. BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
  67. SUSTAINED BY THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH OTHER
  68. PROGRAMS) THE PROGRAM, EVEN IF YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF
  69. SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  70.  
  71.  
  72. CONTENTS
  73.  
  74.     In the archive 'sozbin' you will find the programs that form that
  75. Freeware C-System Sozobon eXtended version (2.xx), including the manual
  76. files and the more global Sozobon 2.0x documentation.
  77.  
  78.     The basic executables are:
  79.  
  80.     * Compiler Driver (cc)
  81.     * Compiler        (hcc)
  82.     * Optimizer       (top)
  83.     * Assembler       (jas)
  84.     * Linker          (ld)
  85.  
  86.     In the archive 'sozlib', you will find libraries and header files,
  87. and the library documentation.
  88.  
  89.     * Header Files
  90.     * Startup Modules/Libraries
  91.  
  92.     In the archive 'sozutil', you will find various utilities, to deal
  93. with sorce files, libraries and bugs.
  94.  
  95.     * Make                        (make)
  96.     * Prototypes Creation Utility (mkptypes)
  97.     * Include File Precompiler    (ipc)
  98.     * Library Mananger            (ar, har)
  99.     * Tagfile Utility             (tagfile)
  100.     * Source Analysis Utility     (clint)
  101.     * Debugger                    not in this distribution
  102.     * Debug Utility               (debug)
  103.  
  104.     In the archive 'c-desk.lzh' (if present) you will find a GEM shell for
  105. Sozobon C called C-Desk, by Holger Weets. ACE (shell and integrated editor)
  106. is available by him, too.
  107.     An identical AMIGA version is available by Holger Weets.  He can be
  108. contacted at:
  109.  
  110.     Maus: Holger Weets @ OL
  111.     Internet: Holger_Weets@OL.maus.de  (only mails <= 16KBytes !!)
  112.  
  113.     Mail: Holger Weets
  114.           Tangastra₧e 45
  115.           D-26121 Oldenburg
  116.  
  117.  
  118.     The traditional installation of many C compilers (UNIX) can be used
  119.     for Sozobon. Unpack the archives with option '-r', to get
  120.     all directories created. All three archives use the same directory
  121.     structure and will create a directory 'sozdistr' where all is placed
  122.     in. If you think of this directory 'sozdistr' as 'usr' you will see
  123.     the usual direcory structure, excepted the directory 'doc' placed
  124.     there and this file 'readme'. 
  125.  
  126.     The simplest way is now to copy or move the directories 'bin'
  127.     'include' 'lib' and 'man' to your directory '\usr\'. If you don't
  128.     have a '\usr' try the following four steps.
  129.  
  130.     1.  Put the executable files (directory 'bin') in a folder called 
  131.         '\usr\bin' or '\bin' or whatever you use for binaries.
  132.         You can also put these files in any folder that is present in the
  133.         $PATH environment variable.
  134.  
  135.     2.  Copy or move the directory 'include' where ever you 
  136.         think its a good place for. Usually you should have a directory
  137.         '\usr\include\' with some and library specific directories like
  138.     '\usr\include\mntinc' with the most include files in it.
  139.  
  140.     3.  Copy or move the directory 'lib\sozobonx' to where you want it,
  141.         usually this will result in a path '\usr\lib\sozobonx' with
  142.     all the library directories and files in it.
  143.  
  144.     4.  The man files' directories should be placed in a directory 
  145.         '\usr\man', when your environment variable $MANPATH has the
  146.         value '\usr\man'.
  147.         If you don't know what $MANPATH is keep the files where they are
  148.     or use the ones of directory 'doc' in 'sozdistr'
  149.  
  150.      Now you have to create some environment variables:
  151.  
  152.      Create an environment variable called $INCLUDEDIR that contains the
  153.      path of your include directory ('\usr\include' by default). cc uses
  154.      this variable to build a variable $INCLDUE for cpp and hcc from it.
  155.      hcc uses it to replace the buildin path for header files, if $INCLUDE
  156.      doesn't exist.
  157.  
  158.      Create an environment variable called $LIBDIR that contains the
  159.      path of your library directory ('\usr\lib'). cc will replace the
  160.      builtin library pathes with this one.
  161.  
  162.      You may need these variables, cause with TOS there are a) drives and
  163.      b) for other reasons too, no standard directories 'usr\include' and
  164.      '\usr\lib'. 
  165.  
  166.      You can use the variables $LIB and $INCLUDE, too and cc, hcc and ld
  167.      will use them instead of the above mentioned.
  168.  
  169.      Sozobon makes use of the well known (I hope) environment variables
  170.      PATH and TMPDIR. (the last one should name the path of something
  171.      like the directory '\usr\tmp'.
  172.  
  173.      If you have installed the ST-Guide program copy the '*.hyp' and
  174.      '*.ref' files from directory 'doc' in this distribution where you
  175.      keep you hypertext files (maybe '\usr\lib\hyper', maybe anywhere.
  176.      Run 'stool' to get them in the catalouge file and tell you editor,
  177.      that the C-mode-editing helpfile is 'soz_libs.ref'
  178.  
  179.     Of course you can put the files where you want, but the sozobon
  180. programs sometimes need to find the single files.  Therefore you have to
  181. set the environment variables.  C-Desk and ACE use setup files, to store
  182. the paths, but you can use environment variables, too.
  183.  
  184. These following environment variables are used by sozobon components.
  185. 'make', 'cc', and 'ld' handle and expand some $UNIXMODE path features.
  186.  
  187.        PATH       to find binaries             (list of paths)
  188.        LIBDIR     standard library path        (path)
  189.                   (there a directory 'sozobonx')
  190.                   replaces the builtin include paths
  191.        LIB          current valid library pathes  (list of paths)
  192.        INCLUDEDIR standard header file path    (path)
  193.                   (there some library directories)
  194.                   replaces the builtin include paths
  195.        INCLUDE    current valid include file paths (list of paths)
  196.  
  197.  
  198.     More detailed installation hints are to find in the documents to the
  199. shell (C-Desk.doc ...) or the driver program (cc.man) you use.
  200.  
  201. ANOTATIONS
  202.  
  203.     Now there is a 'Let'em Fly' library included, see in the original 
  204. Let'em Fly docs how to use it.
  205.  
  206.  
  207.  
  208. SUPPORT
  209. BUG REPORTS
  210.  
  211.     If you have any problems, suggestions, or comments, send a message
  212. to me. If you have a bugreport please use the bugform file, included in
  213. this distribution. At least for the first one.
  214.  
  215.     If you have a bugreport to hcc, top or jas or another part of SozobonX
  216. wich is no more maintained by me plese send you filled bugforms to the
  217. person mentioned in the man file of this tool.
  218.  
  219.  
  220. email to:
  221.         Maus:  Jerry Geiger @B
  222.     Internet:  jerry@zedat.fu-berlin.de
  223.  
  224.  
  225. --Jerry
  226.  
  227. Now the whole stuff and some lines more in german.
  228.  
  229. Update Hinweise:
  230. bug in ar fixed, falsches libsort binary ausgetauscht
  231.  
  232. von älteren Versionen (1994):
  233. Die Struktur des Verzeichnisses 'sozdistr/doc' wurde völlig geändert,
  234. löschen sie deshalb diese(s) Verzeichnis(e) vor dem Auspacken bzw Kopieren
  235. der neuen Archive. 
  236.  
  237. hcc:         IEEE 64 Bit floating point 
  238. libm:        nun die pml, wegen IEEE Unterstützung
  239. libc:        IEEE Routinen, bugfixes
  240. startups:    ein paar neue sind hinzugekommen
  241. xgemfast:    MagiC Unterstützung
  242. siehe auch die '*.chg' Dateien für weitere Informationen
  243.  
  244.  
  245. SozobonX wird in fünf Dateien verteilt:
  246. Die Dateien 'sozbinXX.lzh', 'sozlibXX.lzh' und 'sozutiXX.lzh' enthalten das
  247. Basis Paket, wobei XX jeweils für die fortlaufende Versionsnummer des
  248. jeweiligen Archivs steht. 
  249. Die Datei 'sozc68XX.lzh' enthält Thosten Roskowetzs c68 Portierung, und die
  250. Datei 'mntsoxXX' die MiNT library (Scott Bigham); wobei 'XX' jeweils den
  251. Patch Level angibt.
  252. Die Dateien mit den höchsten Nummern passen jeweils zusammen, au₧er derzeit
  253. mntsox44.lzh, das noch nicht mit den IEEE doubles umgehen kann.
  254. Im folgenden werden die Archiv-Dateien als sozlib, sozbin und sozuti 
  255. bezeichnet.
  256.  
  257. COPYRIGHT
  258.  
  259.  
  260.     Der Sozobon C-Compiler ist Freeware.  D.h. die drei hier genannten
  261. Archive sozbin, sozlib und sozutil dürfen kopiert und weitergegeben werden,
  262. solange an ihnen nichts verändert wird, und keine Kosten in Rechnung
  263. gestellt werden. 
  264.  
  265.     Eine kommerzielle Weitergabe/Verteilung sowie Verkauf von Disketten mit
  266. dem Compilersystem bzw.  Teilen davon, oder das Beilegen zu anderen
  267. Programmpaketen Bedarf des ausdrücklichen Einverständnisses der derzeitigen
  268. Autoren/Entwickler. 
  269.  
  270. HAFTUNG
  271.  
  272.     Weder ich noch Holger Weets, noch sonst jemand haftet für irgendwelche
  273. Schäden, die in Zusammanhang mit der Benutzung irgendwelcher Dateien aus dem
  274. Sozobon-Paket möglicherweise entstehen oder entstanden sind.  Dabei spielt
  275. es keine Rolle ob diese Dateien für die ihnen zugedachten Zwecke oder zu
  276. anderen Zwecken eingesetzt wurden. 
  277.  
  278.  
  279. CONTENTS
  280.  
  281.     In dem Archiv 'sozbin' befinden sich die wesentlichen Programme des
  282. Freeware C-Systems SOZOBON 2.0 eXtended version, sowie die Manual Seiten
  283. und die allgemeinere Sozobon 2.0x Dokumentation.
  284.  
  285.     Die grundlegenden Programme sind:
  286.  
  287.     * Compiler Driver (cc)
  288.     * Compiler        (hcc)
  289.     * Optimizer       (top)
  290.     * Assembler       (jas)
  291.     * Linker          (ld)
  292.  
  293.     In dem Archiv 'sozlib' befinden sich Header/Include Dateien und
  294. die Bibliotheken.
  295.  
  296.     * Header Files
  297.     * Startup Modules/Libraries
  298.  
  299.     In dem Archiv 'sozutil' finden sich folgende mehr oder weniger
  300. verzichtbare utilities: 
  301.  
  302.     * Make                        (make)
  303.     * Prototypes Creation Utility (mkptypes)
  304.     * Include File Precompiler    (ipc)
  305.     * Library Mananger            (ar, har)
  306.     * Tagfile Utility             (tagfile)
  307.     * Source Analysis Utility     (clint)
  308.     * Debugger                    not in this distribution
  309.     * Debug Utility               (debug)
  310.  
  311.  
  312.     Im Archiv 'c-desk.lzh' (wenn vorhanden) ist die GEM-Oberfläche für
  313. SOZOBON enthalten (C-Desk von Holger Weets). Von ihm kann auch ACE
  314. (Oberfläche mit integriertem Editor) bezogen werden.
  315.  
  316. Eine identische Version für den AMIGA ist ebenfalls bei Holger erhältlich,
  317. sie enthält den hcc & top sowie die neuste Version des A68K und die
  318. PD-Version des BLINK, sowie entsprechende Bibliotheken. 
  319.  
  320.     Maus: Holger Weets @ OL
  321.     Internet: Holger_Weets@ol.maus.de  (only mails <= 16KBytes !!)
  322.  
  323.     Mail: Holger Weets
  324.           Tangastra₧e 45
  325.           D-26121 Oldenburg
  326.  
  327.  
  328. INSTALLATION:
  329.  
  330.     Die traditionelle Installation eines Compilers (UNIX) ist auch 
  331.     Grundlage für Sozobon. Packen sie die Archive mit der Option '-r' aus,
  332.     um die enhaltenen Verzeichnisse zu bekommen. Alle drei Archive haben
  333.     die gleiche Verzeichnisstruktur, und erzeugen ein Verzeichnis
  334.     'sozdistr', das alles enthält. Dieses Verzeichnis entspricht dem
  335.     verzeichnis '\usr' in einer Standard-Installation, au₧er da₧ das
  336.     Verzeichnis 'doc' und diese Datei 'readme' auch darin zu finden sind.
  337.  
  338.     Der einfachtse Weg der Installation ist nun die Verzeichnisse 'bin',
  339.     'lib', 'include' und 'man' in ihr 'usr' Verzeichnis zu verschieben
  340.     oder zu kopieren. Wenn sie kein Verzeichnis 'usr' haben, probieren
  341.     sie folgende vier Schritte:
  342.  
  343.     1. In ein Verzeichnis '\usr\bin' oder '\bin' (oder ein anderes
  344.        Verzeichnis in $PATH) sollten die ausfühbare Programme (aus 'bin')
  345.        kopiert werden.
  346.  
  347.     2. Kopieren oder verschieben sie nun in das Verzeichnis
  348.        '\usr\include' oder '\include' den Inhalt von 'include' aus der
  349.        Sozobon Verteilung.  Es sollte so etwas wie '\usr\include\' mit
  350.        ein paar und die Bibliotheks spezifischen Verzeichnisse wie
  351.        '\usr\include\xdlibs\' mit dem ganzen Rest von
  352.        Header Dateien enstanden sein. 
  353.  
  354.     3. Das gleiche Spiel nun mit 'lib' aus der Verteilung. Die
  355.        Bibliotheksdateien sollten nun alle in so etwas wie
  356.        '\usr\lib\sozobonx' zu finden sein.
  357.  
  358.     4. Alle beliegenden Manual Verzeichnisse sollten in ein Verzeichnis wie
  359.        '\usr\man\' kopiert oder verschoben werden, wenn ihre 
  360.        environment Variable MANPATH den Wert '\usr\man' hat.
  361.        Wenn sie nicht wissen was $MANPATH ist und sie 'man' auch nicht
  362.        kennen lassen sie sie wo sie sind, und benützen sie die Dateien
  363.        aus dem Verzeichnis '\sozdistr\doc'
  364.  
  365.      Nun wären noch ein paar Environment Variablen zu erzeugen:
  366.        
  367.      In der environment Variablen $INCLUDEDIR sollte dann der Pfad ihres
  368.      '\usr\include' entsprechenden Verzeichnisses zu finden sein. hcc
  369.      ersetzt mit dieser Variablen die eingebauten standard Include-Pfade
  370.      wenn $INCLUDE nicht gesetzt ist. cc benutzt diese Variable um für hcc
  371.      und cpp eine passende $INCLUDE Variable zusammenzubauen
  372.  
  373.      Erzeugen sie auch eine environment Variable 'LIBDIR', die den Pfad des
  374.      Bibliotheks-Verzeichnisses ('\usr\lib') enthält. cc ersetzt mit
  375.      dieser Variablen die eingebauten standard Bibliotheks-Pfade.
  376.  
  377.      Dies ist agnz nützlich, da es unter TOS a) Laufwerke und b) nicht nur
  378.      deshalb keine Standard Verzeichnisse '\usr\include' und '\usr\lib'
  379.      gibt.
  380.      Sie können auch die Variablen $INCLDUE und $LIB benutzen cc, hcc und
  381.      ld verwenden dann die oben erwähnten nicht.
  382.  
  383.     Natürlich kann das jedeR alles machen wie sie will, wichtig ist nur, da₧
  384. die Sozobon Programme die einzelnen Dateien finden.  Dazu müssen jeweils die
  385. Environment-Variablen gesetzt werden.  Bei C-Desk und ACE werden diese Pfade
  386. in entsprechenden Setup Dateien gespeichert. 
  387.  
  388. Folgende Environment Variablen werden von den Sozobon Komponenten benutzt:
  389.  
  390.        PATH       für binaries              (Liste von Pfaden)
  391.        LIBDIR     standard Bibliothekspfad  (Pfad)
  392.               (dort ein Verzeichnis sozobonx)
  393.                   ersetzt eingebaute Pfade
  394.        LIB        die aktuelle gültigen Bibliothekspfade  (Liste von Pfaden)
  395.        INCLUDEDIR standard Include Pfad     (PFAD)
  396.                   (dort ist die Bibliotheks Verzeichnisse) 
  397.                   ersetzt die eingebauten Include Pfade.
  398.        INCLUDE    aktuell gültige Include Pfade     (Liste von Pfaden)
  399.  
  400.     Es empfielt sich generell die Defaultpfade zu verwenden.
  401.  
  402.     Für detailliertere Angaben zur Installation sollten die zur verwendeten
  403. Oberfläche gehörenden Dokumentationen zu Rate gezogen werden.  (cc.man,
  404. C-Desk.doc ...)
  405.  
  406.  
  407. ANMERKUNGEN
  408.  
  409. CC  und  MAKE  sind  für  die  Benutzung  des  Systems  mit   den
  410. Oberflächen ACE oder C-Desk nicht notwendig, jedoch die Schnittstelle zur
  411. Benutzung von SOZOBON in einer CLI-Shell, einem modernen Desktop wie
  412. etwa Gemini oder etwa von Emacs aus.
  413.  
  414. CC und MAKE wurden von mir gegenüber den ursprünglichen Versionen stark
  415. modifiziert. Ein komplettes Manual für make fehlt allerdings immer noch.
  416. Ich habe jedoch die Einführung in make von Ian Lepore (make.doc) beigelegt.
  417.  
  418. Compiler,   Optimizer,   Asembler   und   Linker   wurden   stark
  419. modifiziert, so da₧ sie
  420.    - schnelleren Code erzeugen
  421.    - keine bekannten Fehler mehr enthalten
  422.    - schneller übersetzen
  423.    - auch auf AMIGA's laufen (durch einmaliges neu übersetzen)
  424.    - viele Erweiterungen enthalten
  425.  
  426. Den Bibliotheks-Manager  hat Holger komplett  neugeschrieben,  er
  427. liegt jetzt als  GEM-Programm  vor  (ist  für  die  Amiga-Version
  428. aktuell noch nicht erhältlich) und funktioniert im Gegensatz  zum
  429. Original auch ordentlich.
  430.  
  431.  
  432. IPC und TAGFILE sind im Original SOZOBON-Paket  nicht  enthalten,
  433. sie wurden von Holger geschrieben.
  434.  
  435. Einige weitere utilities liegen der Original Verteilung ebenfalls nicht bei.
  436.  
  437.  
  438. Die Sourcecodes der modifizierten Version liegen nicht bei,  weil
  439. wir nicht möchten, da₧ es innerhalb kurzer Zeit eine Vielzahl  von
  440. verschiedenen  Versionen  dieses  Systemes  gibt.
  441.  
  442. Die Sources der Original-Version (2.0 von SOZOBON) können bei Holger
  443. gegen einen frankierten  und  adressierten  Rückumschlag  bezogen
  444. werden. Sie sind auch in diversen Mailboxen und von file-servern zu
  445. beziehen.
  446.  
  447. Ich habe eine SozobonX version der Let'em Fly lib von O. Scheel
  448. beigelegt, ich hoffe es ist in seinem Sinne.
  449. Anwendung:  '#include <ltmf_lib.h>' im source file
  450. und '-lltmf' in der cc commandline nicht vergessen.
  451.  
  452.  
  453. SUPPORT
  454. BUG REPORTS
  455.  
  456.     Generelle Bug reports, Fragen, etc. bitte an mich. Wenn sie einen Fehler
  457. (Bug) zu berichten haben benützen sie bitte die beiligende Datei 'bugform',
  458. wenigstens das erste Mal.
  459.     In den man files finden sich die Adressen der Leute die das
  460. entsprechende tool pflegen, bitte die ausgefüllten 'bugform's direkt an sie
  461. schicken. 
  462.  
  463.  
  464. email to:
  465.         Maus:  Jerry Geiger @B
  466.     Internet:  jerry@zedat.fu-berlin.de
  467.  
  468.  
  469. --Jerry
  470.  
  471. -eof
  472.