************************************************************************
*    Please set tab stop to 4 for a best display of this file.
************************************************************************


For years, a multi-tabbed rxvt has been requested by the users with
no luck. Now, things have changed! Mrxvt (previously named as materm)
is a tabbed X terminal emulator based on aterm/rxvt. It's small,
fast, portable, feature rich and only depends on X library.

Multi-aterm was first developed by Alexis from 2002 based on aterm.
But the development seems to stop in 2004. So I took over the
project, began to hack it and renamed it to materm. I have made
lots of changes to the code since I dislike the original code
style. Hopefully, I have not broken too many things. ;-)

Due to the limits of aterm, many features are not well implemented,
such as XIM support. So after release 0.2, I decided to pick up the
latest rxvt as the base of new development branch. So the name of
the project is changed to mrxvt. This branch is completely new
compared to the branch prior to 0.2. I have found that rxvt coding
style is much better than aterm (except the indent is horrible ;-)),
and it is enjoyable to work on it. Be aware that some features in
the new branch are slightly different from the release 0.2, e.g.,
color background tinting for each individual terminal.

Bug reports are very welcome! Mrxvt by default is built with debug
support. So if you have gdb in your system, you may run mrxvt in
gdb with the source to track down the bug, and report it to me.
Patches are extremely welcome! In addition, I have no time to update
the documents by now. Feel free to help me and the users to improve
them.


To build and install from the source, please read INSTALL file. If
you want to disable the verbose debug information, run the configure
script as:
	$ ./configure --enable-whatever-options --disable-debug


To run mrxvt with your own preferences, you can set X resources in
~/.Xdefaults. A sample xdefaults-sample.txt is included in the doc/
directory, and you can start to hack your own ~/.Xdefaults from it.


Several hot key combinations are available for keyboard users. Please
read the doc/TIPS for a list of them. Be aware that they may be
changed in the near future in order to conform with gnome-terminal
and konsole.


To input Chinese, you can do the following:
	. Configure mrxvt with "--enable-gb --enable-big5 --enable-gbk
--enable-xim" options, and build it.
	. Set environment variable LC_CTYPE to zh_CN. Make sure to unset
environment variable LC_ALL, otherwise LC_CTYPE is overrided.
	. Set X resources in ~/.Xdefaults:
		mrxvt*multichar_encoding: GB
		mrxvt*inputMethod:        SCIM
	. Start the SCIM X input server as usual
	. Execute mrxvt
	. Focus on the mrxvt window, click Ctrl_Space to invoke SCIM


Major features (* are new features compared with rxvt, + are enhanced
features compared with rxvt):
	* multi-tab support
	* runtime changedable tab title
	* simple session support for each terminal
	. pseudo-transparent terminal background
	* pseudo-transparent tabbar background
	* pseudo-transparent scrollbar background
	* pseudo-transparent menubar background
	+ user supplied background image per terminal
	* user supplied background image for tabbar
	* user supplied background image for scrollbar
	* user supplied background image for menubar
	+ xpm/jpeg/png background image
	* background color tinting, runtime changedable color and shade
	* color text shadow
	* fading and off-focus fading
	+ NeXT/Rxvt/Xterm/SGI/Plain style scrollbar
	. only depends on X, no GTK, no Qt
	. small and fast
	+ XIM and multi-languages (Chinese/Korea/Japanese) suppport
	+ freetype font
	. multiple platforms
	. utmp/wtmp/lastlog logging
For a complete list of all features, please read README.configure file.


Tested Platform:
	Slackware Linux 10.0
	RedHat Linux 9.0
	Debian Linux (Testing)
	Gentoo Linux (Testing)
	SUN Solaris (SPARC) 8/9
	FreeBSD 5.2.1
	IRIX 6.5
	Mac OS X 10.3 (Panther)
	Cygwin


Known Issues:
	. Background image support requires libxpm, libpng and libjpeg
be installed.
	. Thai support is incomplete since I do not know too much about
it and do not have the Thai fonts.
	. XFT support is experimental by now.
	. If swap screen option is disabled, screen scrolling may behave
randomly. ;-)  So the safe choice is to always enable it.
	. Tinting and transparent are global since 0.3.0. Well, we could
implement tinting and transparent for each individual terminal (not
a technical difficulty), but it will significantly increase the
X resources usage since each terminal needs at least one pixmap.
	. If you use true translucent windows supported by the X server,
e.g., Xorg R116.8, you need to turn off transparent support.

	If you run into certain problems, please read the FAQ file before
trying to contact me. Your question may be answered by FAQ already.


Security Issue:
	By default, mrxvt binary is installed as setuid root. Although
	we have tried hard to avoid security problems raised by setuid
	root permission, we do not guarantee 100% safety. You have been
	warned!!!

	From 0.3.5, mrxvt supports utempter library, which means if you
	have installed the utempter library, you can remove the setuid
	root permission from mrxvt binary without losing the logging
	feature. But doing so may cause trouble to chown the tty on some
	systems.


Copyright/License Issues:
	According to section 4 of the GPL, SCO Corporation of Lindon,
	Utah (formerly Caldera) has no rights to redistribute any
	versions of Mrxvt and/or Materm in any of their products,
	including (without limitation) OpenLinux, Skunkware, OpenServer,
	and UNIXWare.
