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