Changeset 3866 for trunk/doc


Ignore:
Timestamp:
Jul 20, 2000, 1:36:45 AM (25 years ago)
Author:
sandervl
Message:

updated installation instructions in readme

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/Readme.txt

    r3811 r3866  
    55WANTED: We are still looking for talented developers that want to
    66        contribute! Please take a look at the last section!
     7
     8NOTE:   LICENSE.TXT describes the Project Odin Software License.
    79
    810
     
    4648run well and to make much more visible progress.
    4749
    48 
    49 2.0 Installing Odin
    50 -------------------
    51 Odin installation must be done manually at this time. However, only
    52 a few simple tasks must be completed:
    53   - Unzip the odin zipfile into a new directory (i.e. C:\ODIN)
    54   - Add this directory to the LIBPATH and PATH statements of your config.sys
    55   - Optionally install the win32k device driver (see 2.3.3)
    56   - Reboot your machine
     501.3 Changes and additions in alpha 5
     51------------------------------------
     52- Removed Open32 dependacy in User32 code: windows, dialogs, buttons and
     53  other controls creation and manipulation is now implemented fully in Odin32.
     54  Applications have Win32 look: Win32 specific controls are also supported
     55  (Open32 is still a requirement as other Odin32 functions use it!)
     56- New and improved PE2LX converter
     57- New Portable Executable Loader (PE) that overcomes some differences
     58  between OS/2 and Win32 memory models (this does not include 512MB
     59  per-process memory limitation in OS/2, you still need the Aurora-level
     60  kernel for that)
     61- New WIN32K32k.SYS driver that automates loading of Win32 binaries (no
     62  conversion or invocation through PE.EXE loader is needed), now
     63  compatible with WSeB (Aurora) and no longer dependant of code under
     64  GNU license
     65- Wine ports of common controls (comctl32), shell extensions (shell32) and
     66  OLE
     67- Full implementation of memory mapped files
     68- Joystick support (winmm)
     69- Direct Input (DirectX keyboard & mouse) added (Wine Port)
     70- Rewrite of DirectDraw. More complete implementation.
     71- Couple of (not core Win32 API, but often used) new DLLs (winasp32, lz32,
     72  avifil32...), so users don't have to have Windows license at all to run
     73  Windows programs
     74- Many new API functions implemented or ported from Wine, allows
     75  developers to port Win32 apps directly to OS/2 with little to no rewriting
     76- Many bugfixes and enhancements
     77- Many new programs that load and/or work with Odin
     78- Full source code available
     79
     802.0 Installing Odin (UPDATED)
     81-----------------------------
     82
     83Odin daily builds are now also distributed as WarpIn archives.
     84WarpIn is a generic OS/2 installation application that can be
     85downloaded from warpin.netlabs.org.
     86
     87To install Odin run warpin.exe with the name of the daily build archive
     88as parameter.
     89Follow the instructions to complete the installation.
     90The Odin installation consists of:
     91  - creating an Odin directory and copying the included files to
     92    x:\odin and x:\odin\system32
     93  - creating empty directories in x:\odin (to create a similar directory
     94    structure as found in Windows)
     95  - creating a basic registry for executing win32 applications in OS/2
     96
     97NOTE: You MUST install Odin at least once using WarpIn (unless you know
     98      what you're doing). Afterwards you can use the daily build zipfiles
     99      to upgrade to a newer version.
     100
     101To run DirectDraw games or Quake 2 in Voodoo mode, you must install Holger
     102Veit's XFree86/2 support driver (XF86SUP.SYS).
     103Visit http://ais.gmd.de/~veit/os2/xf86sup.html to download it.
    57104
    581052.0.1 Log files
    59106---------------
    60 The alpha 5 binaries and daily build zipfiles can generate logfiles to show
     107The alpha 5 binaries and daily build zipfiles can generate logfiles to show 
    61108what a win32 application is doing. This can be very useful to determine
    62109why certain applications don't run correctly.
    63110
    64 The major disadvantage of loggging is the overhead. Therefor it has been
     111The major disadvantage of loggging is the overhead. Therefor it has been 
    65112disabled by default in the alpha 5 release and daily builds.
    66113To enable logging set the environment variable WIN32LOG_ENABLED:
     
    84131also not necessary. Be sure to put the Odin binary directory into
    85132both the PATH and LIBPATH (alternatively you can use a batch file
    86 with SET PATH=C:\Odin\bin;%PATH% and SET BEGINLIBPATH=C:\Odin\bin;)
     133with SET PATH=C:\Odin;%PATH% and SET BEGINLIBPATH=C:\Odin;)
    87134and then call pe.exe winprog.exe param1 param2 ... If you wanted
    88135to start the Windows calculator, you would type
     
    122169
    123170
    124 2.3.0 Win32k.sys - native OS/2 PE-"loader"
    125 ----------------------------------------
     1712.3 The Ring0 conversion utility driver (WIN32K.SYS)
     172----------------------------------------------------
    126173
    127174The win32k.sys driver makes PE (Win32) executables equal to native OS/2
     
    148195-------------
    149196
    150 The Win32k.sys is quite alpha software and any bugs which haven't been found
     197The Win32k.sys is alpha software and any bugs which haven't been found
    151198yet may crash and/or corrupt you entire system! Make sure you have backed up
    152199important stuff first!
     
    164211
    165212Win32k should work on any Warp 4 or Warp Server for e-business installations
    166 which Odin32 works on. It no longer requires a kernel file for non-debug
    167 kernels. Win32k does now contain a "database" for the most recent retail
    168 kernels. Currently this is:
    169     Warp 4 fp#5 -> fp#12
     213which Odin32 works on. It requires only one thing, a kernel symbol file. The
     214kernel symbol is looked for in \OS2\PDPSI\PMDF\WARP4 and
     215\OS2\PDPSI\PMDF\WARP45_U/S. All warp 4 and WE4eB installations should have
     216those direcotries (we hope). It is updated when you install a new fixpack - so
     217there is really nothing to worry about for the common user.
     218
     219For those playing with debug-kernels, make sure that OS2KRNL.SYM is matching
     220the running kernel, while this file too is investigated. (The complete list
     221is found in src\Win32k\dev16\probkrnl.c,apszSym[] - odin32 source tree.)
     222
     223
     2242.3.2.1 Warp 3
     225--------------
     226
     227Win32k is not tested with Warp 3. It is supposed to work with Warp 3 provided
     228that the os2krnl.sym file is present. Warp Server 4 has this, common Warp 3
     229doesn't.
     230
     231
     2322.3.3 Installation
     233------------------
     234
     235To use Win32k.sys you have to add the following line into your config.sys:
     236    device=<d:\path\>win32k.sys
     237
     238Where <d:\path\> is the path to the win32k.sys, i.e. the odin32 executables
     239directory.
     240
     241After doing this, you'll have to reboot your machine to load the driver. During
     242the boot process you will on a successful installation see some lines of
     243technical info and finally a line saying:
     244    'Win32k.sys succesfully initiated!'
     245
     246If you don't see the line above something is wrong.
     247
     248
     2492.3.4 Win32k parameters
     250-----------------------
     251
     252There are some useful parameters for Win32k:
     253-Q             Quiet driver initiation. (Default is verbose (-V) initiation.)
     254-V             Verbose driver initiation. Default.
     255-S:<filename>  Full path to the current OS/2 kernel symbol file.
     256-K:<filename>  Full path to the running OS/2 kernel.
     257
     258
     2592.3.5 Rings - Ring 0 / Ring 3
     260-----------------------------
     261
     262FYI. Ring 0 is the most priveleged level of execution in OS/2. The OS/2 kernel
     263and device drivers execute at this level, while user applications execute in
     264Ring 3, the least priveleged executing level.
    170265
    171266
     
    195290- Windiff (part of Win32 SDK)
    196291
     292Note that many other applications load and/or partly work.
    197293
    1982944.0 Reporting Problems and Successes
     
    214310----------------
    215311
    216 This readme is intended for making people more familiar with ODIN and to
    217 describe various aspects of the project such as accessing latest sources via
    218 cvs, building the binaries, running win32 applications, how to identify and
    219 report problems and bugs, as well as how to participate in this very
     312This readme is intended for making people more familiar with ODIN and to 
     313describe various aspects of the project such as accessing latest sources via 
     314cvs, building the binaries, running win32 applications, how to identify and 
     315report problems and bugs, as well as how to participate in this very 
    220316promising project.
    221317
     
    228324          (version 3.6 might also work, but version 4 is not
    229325           recommended)
    230         - OS/2 Warp 4 Toolkit (project apparently doesn't compile with
     326        - OS/2 Warp 4 Toolkit (project apparently doesn't compile with 
    231327          VAC's OS/2 headers)
    232328          Might also work with EMX headers. (haven't tried this!)
     
    237333
    238334Changes from last source code release:
    239         - Uses Wine headers and a stripped down version of os2win.h (Open32
     335        - Uses Wine headers and a stripped down version of os2win.h (Open32 
    240336          header)
    241337        - All Open32 apis have the 'O32_' prefix.
    242         - All Open32 declarations are appended with '_O32' (mostly due to
     338        - All Open32 declarations are appended with '_O32' (mostly due to 
    243339          calling convention differences)
    244340        - nmake DEBUG=1 builds the debug version
     
    263359          default value (150b))
    264360        - Use the correct Win32 api when there are two version (ascii & unicode)
    265           Calling the standard one (SendMessage) causes a error during
     361          Calling the standard one (SendMessage) causes a error during 
    266362          compilation.
    267363          Use SendMessageA instead.
     
    272368--------------------------------------
    273369
    274 Please check out http://www.netlabs.org/ and http://www.netlabs.org/odin.
     370Please check out http://www.netlabs.org/ and http://www.netlabs.org/odin. 
    275371
    276372
     
    278374-------------------------
    279375
    280 Basically, if your system setup meets above stated requirements, everything you
     376Basically, if your system setup meets above stated requirements, everything you 
    281377need to do for a binary build is:
    282378
     
    287383  nmake release (not working right now!)
    288384
    289 As the current state of the project is still known to be alpha level, one should
    290 expect some functions not to work properly. Therefore, we recommend the use of
    291 the debug-version which creates long logfiles for problem determination purpose
     385As the current state of the project is still known to be alpha level, one should 
     386expect some functions not to work properly. Therefore, we recommend the use of 
     387the debug-version which creates long logfiles for problem determination purpose 
    292388and to allow active debugging with debuggers such as IPMD, ICAT, KDB, etc.
    293389
    294 Please note if you do not want to suffer from the performance loss of writing
    295 logfiles, you can disable logging even with the debug binaries of ODIN by
     390Please note if you do not want to suffer from the performance loss of writing 
     391logfiles, you can disable logging even with the debug binaries of ODIN by 
    296392setting:
    297393
     
    308404------------------
    309405
    310 ODIN is moving at a fast pace. Sometimes side effects of source dependencies may
     406ODIN is moving at a fast pace. Sometimes side effects of source dependencies may 
    311407require you to do a full rebuild of the binaries instead of an incremental build.
    312408
    313 However, rarely it also happens the sources contained in the CVS repository do
    314 not build completely due to erroneous source code. Usually, this is fixed within
     409However, rarely it also happens the sources contained in the CVS repository do 
     410not build completely due to erroneous source code. Usually, this is fixed within 
    315411two days at maximum.
    316412In such event, one can normally stick with the previous version of the particular
     
    323419------------------------------------
    324420
    325 http://www.os2.org/ has setup an ftp server that hosts the automatically
    326 built binaries on daily basis. For people that do not have a suitable
     421http://www.os2.org/ has setup an ftp server that hosts the automatically 
     422built binaries on daily basis. For people that do not have a suitable 
    327423development setup for ODIN, we provide the latest binary code that way.
    328424
     
    331427-------------------------
    332428
    333 As ODIN became an open source project, everybody is kindly invited to
     429As ODIN became an open source project, everybody is kindly invited to 
    334430contribute his/her share to the progress of the project. May it be
    335 active coding, fixing bugs or just providing detailed information about
     431active coding, fixing bugs or just providing detailed information about 
    336432examined problems.
    337433
    338434We suggest you subscribe to win32os2-wai and the corresponsing mailing lists
    339435on http://www.egroups.com.
    340 In case you are interested in participating, every member of the project will
    341 be happy to give you direction to the right places and to give a personal
     436In case you are interested in participating, every member of the project will 
     437be happy to give you direction to the right places and to give a personal 
    342438introduction to further development of the particular modules.
    343439
Note: See TracChangeset for help on using the changeset viewer.