
Chinese terminal emulator for X Window System, Version 11 Release 5
-------------------------------------------------------------------


1. WHAT IS INCLUDED IN THIS DISTRIBUTION

Cxterm and related software:

cxterm	-- a Chinese terminal emulator for X11R5. 
dict	-- a set of dictionaries (input methods) for cxterm.

About 880K disk space is needed for the source code, and additional 1M
is needed (depends on the type of computer) to build all the binaries.


----------
2. HOW TO INSTALL ALL THESE SOFTWARE

First, you'd better make some dedicated directories (for management
purpose):
	one to put executable binaries,	recommended: ~/bin
	one to put fonts,		recommended: ~/xfonts
	one to put dictionaries,	recommended: ~/dicts
	one to put the manual pages,	recommended: ~/man/man1 (optional)

All the path names mentioned here are refer to this directory "./cxterm".
If your system have xmkmf installed properly, follow section 2.1,
otherwise follow section 2.2.

2.1  The Normal Way

First of all your system should have X11R5 installed.  The directory
containing X11R5 binaries (especially, xmkmf, imake, etc.) should
be included in the PATH.

Imakefiles are supplied in each directories and subdirectories
of cxterm, dict, and fonts.  Makefile is given in this top directory.
Simply type:

	make >& all.log

Check all.log to see if the build is successful.  If yes, you can
install most of it with:

	make install >& install.log

(If you don't have the privilege to install, see section 2.2 and 3.)
You can install man pages with:

	make install.man >& man.log

In case the top-level Makefile is corrupt during the period of making,
use
	make -f Makefile.ini World


2.2  You Don't Have xmkmf, or imake

You need to edit the file ./noimake.def yourself, according to your system
configuration.  Consult your system manager to find out where the X system
files are installed, e.g. if your Xlib is "/foo/bar/lib/Xlib.a", then
change "XLIBDIR = $(XDIR)/lib" to "XLIBDIR = /foo/bar/lib".

Put the pathnames where you want to store the binaries, dictionaries, etc.
in the "./noimake.def" file.

Then type

	make -f Makefile.noimake

Sometimes you need to change each Makefile.noimake in each subdirectory.
After successful making, you can install them by

	make -f Makefile.noimake install


----------
3. WHAT IS TO BE GENERATED

Here is the list of all subdirectories:

	./cxterm	source code of cxterm
	./dict/tit2cit	source code of cxterm dictionary compiler
	./dict/tit	cxterm external dictionaries
	./Big5		Big-5 user may want to have a look at this

If the making is successful, you will have the following executable
binaries:

	cxterm/cxterm
	cxterm/hzimpath
	dict/tit2cit/tit2cit
	dict/tit2cit/cit2tit

and the following compiled cxterm dictionaries

	dict/tit/ETZY.cit
	dict/tit/PY-b5.cit
	dict/tit/PY.cit
	dict/tit/Punct-b5.cit
	dict/tit/Punct.cit
	dict/tit/QJ-b5.cit
	dict/tit/QJ.cit
	dict/tit/TONEPY.cit

You'd better put all the executable binaries in a dedicated directory
and all the compiled cxterm dictionaries in another one, which makes
cxterm start up procedure simpler.  You can copy them by hand, or use
"make -f Makefile.noimake install" after putting the right directory
names in "./noimake.def" file.

The following useful manual pages are also installed:

	cxterm/cxterm.man
	cxterm/hzimpath.man
	dict/tit2cit/tit2cit.man


----------
4. CXTERM START UP

These start-up procedures will make some changes to your account
to facilitate the use of cxterm.

1)  cxterm/CXterm.ad

After successful installation, put the resource definitions contained
in cxterm/CXterm.ad file into your account's X window resource file.
The normal place is in the file ~/.Xdefaults (or sometimes, ~/.Xresources).

	cat cxterm/CXterm.ad >> ~/.Xdefaults

(There are more than one way for advanced users to put the resource.
 System manager may choose to put it into a system directory.)

2)  input methods directory

Before invoking cxterm, the environment variable HZINPUTDIR should be
set to the directory name contains all compiled cxterm dictionaries.
Assume you put them in a directory name ~/dicts, "csh" or "tcsh" user
can put in your ~/.cshrc:

	setenv HZINPUTDIR ~/dicts

"sh" or "ksh" user can add the following into your ~/.profile:

	HZINPUTDIR=$HOME/dicts; export HZINPUTDIR

(There are alternative way to specify the directory, see cxterm/cxterm.man.)


----------
5. COPYRIGHTS AND TERMS

This copyright and permission notice outlines the rights and
restrictions covering most parts of this distribution of cxterm.
Cxterm is modified from xterm, which is copyrighted by MIT.
Some individual files are covered by other copyrights.

X11R5 CXTERM (C) 1991 BY YONGGUANG ZHANG AND MAN-CHI PONG.

Permission to use, copy, modify, and distribute this software and
its documentation for any purpose is hereby granted without fee,
provided that this entire copyright and permission notice appear
in all such copies, and that the name of the authors may not be
used to endorse or promote products derived from this material
without specific prior written permission.  The authors make no
representations about the suitability of this software for any
purpose.  It is provided "as is" without express or implied warranty.


----------
6. COMMENTS, BUG-REPORTS, AND FIXES

Please send them to c-xterm@cs.purdu.edu.  If possible, please use
the form in the file "bug-report".  The little extra time you spend on
the report will make it much easier for us to reproduce, find, and fix
the bug.  Receipt of bug reports is generally acknowledged.

The current addresses of the authors:

Yongguang Zhang				Man-Chi Pong
Dept of Computer Sciences		Department of Computer Science
Purdue University			The Hong Kong University of Science
						and Technology
West Lafayette, IN 47906		Clear Water Bay, Kowloon, Hong Kong
E-mail: ygz@cs.purdue.edu		E-mail: mcpong@uxmail.ust.hk
