Odin Bug Report Tool Version 0.4.0
==================================

0. DISCLAIMER

OdinBug is free, but copyrighted software. It is not guaranteed 
to fulfill any particular purpose. Use it at your own risk. It may 
be included free of charge with every application that comes with 
Odin files.

1. INTRODUCTION

This little program makes creating proper bug reports for Team Odin
quite comfortable. As it is in a rather early stage, please do not
expect it to be bug free or feature complete!

I don't want to know how often Sander Van Leeuwen and other Team Odin 
members have written emails, telling us users to bring in proper bug 
reports (I don't exclude myself).

Well, I would like Sander and all the others to spend there time on
Odin and not writing emails about things that should be a non-issue.

2. WHAT IT DOES

This program presents a notebook of forms to fill in the information 
needed by Team Odin and generates a report that follows the standards 
presented in ReportingBugs.TXT which is part of every Odin build.

As soon as the user specifies the Odin buildfile and the log file, all
the other information is gathered from CONFIG.SYS, SYSLEVEL files, 
the WarpIN database, from ODIN.INI and also from the odin32_?.log files. 
Only minor adjustments should have to be made (especially users with 
non-Scitech Display Drivers).

It also scans the odin_?.log file to find the exception information 
and the stack dump in case an application traps. Be aware that these 
logfiles can become quite large and that it might take a while until 
processing is complete.

3. INSTALLATION

As OdinBug.EXE is written in VX-REXX it needs the VROBJ.DLL runtime.

VROBJ.DLL can be found in the directory x:\IMAGES (x=CD-ROM drive) of 
your original Warp 4 CD-ROM and has to be copied into into d:\OS2\DLL
(d=bootdrive), or somewhere else in your LIBPATH.

There is also a VROBJ.WPI package at the following location:

    http://groups.yahoo.com/group/odinusers/files/vrobj.wpi

This package can be installed the usual way using WarpIN.

Put OdinBug.EXE in a directory in your path. 

Put OdinBug.CFG into the same directory within your path. If you are not
familiar with REXX code, you can also delete OdinBug.CFG, the program 
itself has reasonable default values. If OdinBug.CFG is invalid OdinBug.EXE
crashes.

4. CREATING A BUG REPORT

Ideally OdinBug should be called immediately after you experienced a crash
in a Win32 program and after you have created a log file.

Step 1: 

OdinBug prompts you to enter the currently installed Odin-build file (i.e
odin32bin-200?????.ZIP or odin32bin-200?????.WPI) in a standard OS/2 file
open dialogue.

Step 2:

OdinBug prompts you to enter the logfile (odin32_?.log) that was created 
during the execution of the Win32 program.

Step 3:

Application page:

Complete name, version and eventually a location, where the program can be 
downloaded. Then enter your own verbal description of the problem.

All other fields on the other pages of the notebook have probably been
filled automatically. Complete any missing information.

Step 4:

When everything is complete press "Create report" button. The program 
checks for empty fields, and if everything is filled out creates a report.

Pressing "Send EMail" starts Netscape Messenger (or any other email 
program; see OdinBug.CFG) with the appropriate email address and copies 
the newly created report into the clipboard, so it can be pasted into 
the email.

5. BUG REPORTS AND FEATURE REQUEST FOR THIS PROGRAM

Just email me and tell me what you think or what you want! 
I will try to realize it.

Known problem: If logfile is given before the buildfile (which is not
recommended anyway), you get the errornous message, that odininst has 
not been installed.

6. AUTHOR:

Herwig Bauernfeind, 17.08.2001
EMail: herwig.bauernfeind@aon.at
