*************************************************************************    Please set tab stop to 4 for a best display of this file.************************************************************************		Congratulations! You have purchased an extremely fine	device that would give you thousands of years of trouble-free 	service, except	that you undoubtably will destroy it via some 	typical bonehead consumer maneuver. Which is why we ask you	to PLEASE FOR GOD'S SAKE READ THIS OWNER'S MANUAL CAREFULLY	BEFORE YOU UNPACK THE DEVICE. YOU ALREADY UNPACKED IT, DIDN'T	YOU? YOU UNPACKED IT AND PLUGGED IT IN AND TURNED IT ON AND 	FIDDLED WITH THE KNOBS, AND NOW YOUR CHILD, THE	SAME CHILD WHO	ONCE SHOVED A POLISH SAUSAGE INTO YOUR VIDEOCASSETTE RECORDER	AND SET IT ON "FAST FORWARD", THIS CHILD ALSO IS FIDDLING	WITH THE KNOBS, RIGHT?  AND YOU'RE JUST NOW STARTING TO READ 	THE INSTRUCTIONS, RIGHT???  WE MIGHT AS WELL JUST BREAK THESE 	DEVICES	RIGHT AT THE FACTORY BEFORE WE SHIP THEM OUT, YOU 	KNOW THAT? 				-- Dave	Barry, "Read This First!"00   INTRODUCTIONMrxvt is a multi-tabbed (like gnome-terminal/konsole) terminal emulatorfor the X Window System. It targets to be light-weight, so the desktopenvironment, like CDE, KDE or GTK is not required in order to run it.It achieves this without losing the common useful features, like tab,image and pseudo-transparent background, multi-style scrollbars, XIMand CJK support, etc.01   A BRIEF HISTORYYou can safely skip this section if you do not have time.For years, a multi-tabbed rxvt has been requested by the users withno 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.An early version of mrxvt is based on multi-aterm v0.1 and namedmaterm. Multi-aterm was first developed by Alexis from 2002 basedon aterm. But the development seems to stop in 2004 without reachinga usable stable status. So I took over the project, began to hack itand renamed it to materm. I have made lots of changes to the codesince I dislike the original code style. Hopefully, I have notbroken too many things. ;-)Due to the limits of aterm, many features are not well implementedin materm, such as XIM support. So after release 0.2, I decided topick up the latest rxvt as the base of new development branch. Andthe name of the project is changed to mrxvt. This branch is completelynew compared to the branch prior to 0.2. I have found that rxvt codingstyle is much better than aterm (except the indent is horrible ;-)),and it is enjoyable to work on it. I have also ported many featuresfrom aterm and eterm to mrxvt, like tinting and text shadow. Be awarethat some features in the new branch are slightly different fromrelease 0.2, e.g., color background tinting is available for eachindividual terminal in release 0.2, but is global from 0.3.0.02   BUG REPORT AND FAQBug reports are very welcome! You can build mrxvt with debugsupport. So if you have gdb in your system, you may run mrxvt ingdb with the source to track down the bug, and report it to me.To save both your time and my time, please write down detailed stepsto replicate the bug. If I cannot replicate it by myself, I willignore it even if it may destroy the universe.Patches are extremely welcome since I am not familiar with manythings, like multi-languages and accent.In addition, I may not have time to update the documents in time.Feel free to help me and the users to improve them. Translationsare also welcome. Of course, not from C to C++ or something likethat! You know my meaning of translations.If you run into certain problems, please read the FAQ file and theman page before trying to contact me! Your question may be answeredby them already. I most likely will dump your question to /dev/nullif it is already answered there.03   BUILD AND INSTALLTo build and install from the source, please read INSTALL file!A quick (lazy) choice is to configure mrxvt as the following. Afteryou --enable-everything, usually there is no need to enable otheroptions explicitly. I have found that many distributions, likegentoo, enable other options with --enable-everything. This is NOTnecessary in fact. The option is a shortcut to avoid a long list ofconfiguration options. (Apparently few people pay attention to theREADME and README.configure. Shall we burn the README? ;-))	$ ./configure --enable-everything --disable-debug04   CONFIGURATION FILETo run mrxvt with your own preferences, you can set X resources in~/.mrxvtrc. A sample mrxvtrc.sample is included in the share/directory of the source code, and you can start to hack your own~/.mrxvtrc from it. You can also customize mrxvt for all users viaa system-wide configuration file, usually /etc/mrxvt/mrxvtrc or/usr/local/etc/mrxvt/mrxvtrc. Since 0.5.0, configuration via file~/.Xdefaults and ~/.Xresources is not supported any longer. Mostoptions in the config file can be replace by a (short) commandline option if you like command line options.05   HOTKEY BINDINGSSeveral hot key combinations are available for keyboard users. Mrxvtis designed to be as flexible as possible. It can be surprising tosee that many features can be altered during runtime using hotkeysor escape sequences. Please read the manual for a list of them. Beaware that they may be changed in the near future because theshortage of combinations for all features. ;-)If you do not like the default hot key combinations, you can definethe combinations by yourself. Please read the manual page to findout how to define them.06   CJK DISPLAY AND INPUTTo display and input Chinese (Korea/Japanese), you can do thefollowing:	. Configure mrxvt with "--enable-cjk --enable-xim" options, andbuild it.	. Install the correct CJK fonts. Mrxvt will try to look for somedefault CJK fonts if you do not specify them  using the -fm optionor mfont X resource name. The default CJK fonts are listed in thesrc/encoding.h file. Notice that they are -fm and mfont, NOT -fn andfont!!! If you use freetype font, use -xftfm option to specify theCJK font family. Notice that -fm and -xftfm options use differentformats of font names. For details about the difference, read the FAQfile.	. Set environment variable LC_CTYPE to zh_CN (or zh_CN.GBK,zh_CN.GB2312, zh_CN.EUC based on your system). Make sure to unsetenvironment variable LC_ALL, otherwise LC_CTYPE is overrided. Noticethat this setting is global for all the following commands you willtype in the same shell session. You can supply the environment variableto mrxvt at runtime instead of setting it globally here. Keep readingthe following for details.	. Set X resources in ~/.mrxvtrc. Notice that the value ofinputMethod is case sensitive.		mrxvt*mfont:              hanzigb16st		mrxvt*xftmfont:           simsun		mrxvt*xftSize:            14		mrxvt*multichar_encoding: GB		mrxvt*inputMethod:        SCIM	. Start the SCIM X input server as usual. For example:		$ # for ksh/bash users		$ LC_ALL=zh_CN LANG=zh_CN scim -d		$ # for csh/tcsh users		$ env LC_ALL=zh_CN LANG=zh_CN scim -d	. Execute mrxvt. You can supply the environment variable LC_CTYPEand XMODIFIERS to mrxvt at runtime instead of setting them globallyas above. All you need to do is to run mrxvt as following:		# the following command is for bash/ksh		LC_CTYPE=zh_CN XMODIFIERS=@im=SCIM mrxvt &		# the following command is for csh/tcsh		env LC_CTYPE=zh_CN XMODIFIERS=@im=SCIM mrxvt &	. Focus on the mrxvt window, click Ctrl_Space to invoke SCIM	. For Linux and Mac OS X, setting environment variable LC_ALL(for scim) and LC_CTYPE (for mrxvt) to zh_CN or zh_CN.GBK are bothgood for SCIM/fcitx input. For FreeBSD, they must be zh_CN.eucCN forfcitx input. For OpenBSD, they can be zh_CN.EUC or zh_CN.GBK forfcitx input.Mrxvt is tested to work with SCIM, fcitx and gcin on Linux, FreeBSD,OpenBSD and Mac OS X. It should work fine with other X Input methods,like xcin, Chinput and miniChinput. It is reported to work with Frenchascent as well.07   FEATURESMajor features (* are new features compared with rxvt, + are enhancedfeatures compared with rxvt):	* multi-tab support	* runtime changedable tab title and tab order	* simple command support (session) for each tab terminal	* profiles for different tabs	* macros to define shortcut key combinations	* input broadcasting to all tab terminals	* freetype font (Xft) support	* built-in true translucent window support	* user configurable keyboard shortcuts	. 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 tinting color and shading	* color text shadow and different shadow mode	* background fading and off-focus fading	+ NeXT/Rxvt/Xterm/SGI/Plain style scrollbar	+ XIM and multi-languages (Chinese/Japanese/Korean) suppport	. multiple platforms	. utmp/wtmp/lastlog logging	. only depends on X, no GTK, no Qt	. small and fastFor a complete list of all features, please read README.configure file.08   PORTABILITYHere are tested platforms that mrxvt is known to work with:	Slackware Linux 8.1/10.0/10.1/10.2, -current	Slackintosh 10.1, 10.2 (PPC)	RedHat Linux 9.0, Enterprise 3, Fedora Core 2/3	Debian Linux	Gentoo Linux	SuSE Linux 8.2, 9.0, 9.1, 9.2	SUN Solaris (SPARC) 7/8/9/10	FreeBSD 4.8/5.2.1/5.3	OpenBSD 3.5/3.6/3.8/3.9	NetBSD 2.0	IRIX 6.5	HP-UX	Tru64/OSF 5.1	Mac OS X 10.3 (Panther), 10.4 (Tiger)	CygwinIf you cannot find mrxvt in your favorite system (especially opensource systems like Linux and BSD), you may try to contact thesystem developers and request them to add it into the system. :-)09   KNOWN ISSUESHere are several known issues of mrxvt:	. UTF-8 is not supported yet.	. Some users report that they have problem to envoke the SCIMChinese input method under Gentoo 2004.3 and Debian Sarge. I haveno idea why this is the case because it always works for me. Thesolution? Dump Gentoo/Debian and turn to Slackware, or trace theprogram and send me patch. ;-)	. To build mrxvt on HP-UX, you need to disable logging features.	. Background image support requires libxpm, libpng or libjpegbe installed. The images are only tiled on the background of theterminal window. They cannot be scaled to fit the window size.	. XFT support requires freetype, xft and fontconfig librariesbe installed. Multichar support under XFT requires GNU iconv librarybe installed, which is usually included in GLIBC for Linux systems.	. If swap screen option is disabled, screen scrolling may behaverandomly. ;-)  So the safe choice is to always enable it.	. Tinting and pseudo-transparent are global since 0.3.0. Well,we could implement tinting and pseudo-transparent for each individualterminal (not a technical difficulty), but it will significantlyincrease the X resources usage since each terminal needs at leastone pixmap.	. Off-focus fading does not work under XFT in order to saveresources. This may be fixed in the future.	. Certain characters, e.g., characters with accent in European languages may not be correctly displayed under XFT.	. If cursor blinking is enabled, to print the hold exit text onthe screen may be delayed after several blinking. Similarly, thechild may stay for a while before completely quits.10   SECURITY ISSUESHere are several security issues of mrxvt:	Before 0.3.10, 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.10, mrxvt binary will	be installed without setuid root due to security concerns. Thus,	if mrxvt is not compiled with utempter library support, you will	lose the logging features.	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.	Many escape sequences introduced in mrxvt 0.4.x to manipulate	tabs are disabled by default to avoid potential security risks. 11  COPYRIGHTMrxvt is licensed under GNU General Public License (GPL). You are freeto copy, modify and redistribute the source and binary of mrxvt underGPL. But there is a issue with SCO Corp.:	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.