#	$Id: README,v 1.20 1998/04/30 17:00:36 jvuokko Exp $	


jmr 0.7.18 (ALPHA)
====================


CONTENTS
--------

1. Installing binary distribution
2. installing source distribution
3. Uninstalling jmr
4. Environment variables
5. Upgrading
6. About version numbering
7. More information
8. Bug reports and suggestions
9. New versions



1. INSTALLING BINARY DISTRIBUTION
---------------------------------

Unix : Log in as root and run script jmr.install.

Os/2 and DOS : Copy jmr.exe to some directory in path.


2. INSTALLING SOURCE DISTRIBUTION
---------------------------------

Unix : You need GNU Make and GCC to build jmr. Type 'make -v' to see if 
       your make is GNU Make, if not, then try gmake instead of make.
       
       Log in as root, change to directory, where jmr is extracted 
       (jmrsrc-x.y.z.f) and type 'make' or 'gmake' to get detailed 
       information. 

       Compiler must be at least either gcc 2.8.0 or egcs 1.0. That is
       because jmr uses exceptions that does not work with old gcc's.
              
       It is reported that jmr works fine in IRIX (mips), 
       SunOS (sparc), Linux (i386), NetBSD (i386) and FreeBSD (i386).
       If you have tested jmr on other platforms, please mail me if it
       works fine (even if it does not work).

       NOTE: if compilation fails with error message:
       `ld: cannot open -ltermcap: No such file or directory'
       Then try to change line `termlib = termcap' from the file
       src/makefile to `termlib = curses' or `termlib = ncurses'.


Os/2 : You can build jmr with Emx/Gcc (gcc 2.8.0 or newer) or Watcom C/C++.

       To compile with emx, you need GNU Make. Type 'make -f makefile.emx'
       to build (you must be in same directory, where you found
       this README file).
       
       To compile with Watcom type 'wmake -f makefile.os2'.
       

3. UNISTALLING JMR
------------------

Unix : Just type 'make uninstall' as a root, or run script jmr.uninstall.



4. ENVIRONMENT VARIABLES
------------------------

Jmr looks for two environment variables: HOME and JMRDIR.

The variable HOME is most important. By default jmr creates directory
$HOME/.jmr/ for storing all necessary data (logs etc.).

With variable JMRDIR you can specify directory path different than
$HOME/.jmr/ if you wish, and jmr will set up it's files there. Generally you
would want the JMRDIR environment variable to be a path to a subdirectory
off of your home directory.

Because OS/2 and DOS does not support home directories for individual
users, it might be a good idea to specify directory using JMRDIR.

Note that paths cannot be ralative, and if your system uses drive-letters
(like DOS), path must start with drive-letter. 

e.g. in Unix systems JMRDIR might be something like: /home/user_name/bbsmail/
and in DOS-familian systems it might be: c:\work\bbsmail\


5. UPGRADING
------------

If you're upgrading from older version than 0.5.10.0, then you need to 
move all logfiles from JMRDIR to new 'data' subdirectory:

1. Change to jmr's directory:

   cd $JMRDIR or cd ~/.jmr, depending on your settings.

2. Create subdirectory 'data':
   
   mkdir data

3. Move logfiles to directory just created:

   mv *.log data/

4. Remove obsolete files (snapshots and config files):

   rm *.sht 
   rm *.cfg 

5. That's all.


6. ABOUT VERSION NUMBERING
--------------------------

The format of version number is r.x.y.z (or r.x.y, if z is 0), where

r.x.y is release number. If one of them is incremented, then jmr has one
      or more new features. Number x has special meaning, if it is an even 
      number, then version is stable, if x is odd, then release is BETA, 
      and it might be unstable.

      Usually new features increments only number y, and r indicates that
      something very big was done (i.e. Text mode interface is changed to GUI).

      Note that all releases that have major number (r) 0, are beta releases.
      First stable release will be 1.0.0. So recardless of value of second
      number, all 0.7.0, 0.8.0 and 0.9.0 are beta releases.

z     Indicates fix-level. This is incremented after each bugfix. 

Examples:

jmr 1.0.1.3

Tells that version is stable, and three latest versions has no new features,
but bugs are fixed.

jmr 1.1.14

Tells that version is BETA, and this version has one or more new
features added since previous version.  The next stable version after
that will be jmr 1.2.0


7. MORE INFORMATION
-------------------

On unix systems, after installation you can read manual by typing 'man jmr'.
Manual is still under developing, so there are lots of empty paragraphs.

OS/2 binary distribution contains formatted manual, type 'more < jmr.txt' to
read it.

On other systems, you need groff to build readable manual. See file jmr.1 to
detailed information.


8. BUG REPORTS AND SUGGESTIONS
------------------------------

Send bug reports and suggestions via email to jvuokko@iki.fi. 


9. NEW VERSIONS
---------------

Latest version and c++ sources for jmr are available at www:
http://www.iki.fi/jvuokko/jmr/








