[ViewVC] Diff of: cvs/cvsroot/rxvt-unicode/doc/rxvt.1.txt

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.16 by root, Wed Feb 16 22:16:30 2005 UTC

…		…
4		4
5	SYNOPSIS	5	SYNOPSIS
6	rxvt [options] [-e command [ args ]]	6	rxvt [options] [-e command [ args ]]
7		7
8	DESCRIPTION	8	DESCRIPTION
9	rxvt-unicode, version 4.9, is a colour vt102 terminal emulator intended	9	rxvt-unicode, version 5.2, is a colour vt102 terminal emulator intended
10	as an xterm(1) replacement for users who do not require features such	10	as an xterm(1) replacement for users who do not require features such
11	as Tektronix 4014 emulation and toolkit-style configurability. As a	11	as Tektronix 4014 emulation and toolkit-style configurability. As a
12	result, rxvt-unicode uses much less swap space -- a significant	12	result, rxvt-unicode uses much less swap space -- a significant
13	advantage on a machine serving many X sessions.	13	advantage on a machine serving many X sessions.
14		14
15	FREQUENTLY ASKED QUESTIONS	15	FREQUENTLY ASKED QUESTIONS
16	See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions	16	See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17	and answer to them and some common problems.	17	and answer to them and some common problems. That document is also
		18	accessible on the World-Wide-Web at
		19	<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
18		20
19	RXVT-UNICODE VS. RXVT	21	RXVT-UNICODE VS. RXVT
20	Unlike the original rxvt, rxvt-unicode stores all text in Unicode	22	Unlike the original rxvt, rxvt-unicode stores all text in Unicode
21	internally. That means it can store and display most scripts in the	23	internally. That means it can store and display most scripts in the
22	world. Being a terminal emulator, however, some things are very	24	world. Being a terminal emulator, however, some things are very
…		…
309		311
310	-ssr\|+ssr	312	-ssr\|+ssr
311	Turn on/off secondary screen scroll (default enabled); resource	313	Turn on/off secondary screen scroll (default enabled); resource
312	secondaryScroll.	314	secondaryScroll.
313		315
314	-xrm resourcestring	316	-keysym.sym: string
315	No effect on rxvt-unicode. Simply passes through an argument to be	317	Remap a key symbol. See resource keysym.
316	made available in the instance's argument list. Appears in	318
317	WM_COMMAND in some window managers.	319	-embed: windowid
		320	Tells rxvt to embed it's windows into an already-existing window,
		321	which enables applications to easily embed a terminal.
		322
		323	Right now, rxvt will first unmap/map the specified window, so it
		324	shouldn't be a top-level window. rxvt will also reconfigure it quite
		325	a bit, so don't expect it to keep some specific state. It's best to
		326	create an extra subwindow for rxvt and leave it alone.
		327
		328	The window will not be destroyed when rxvt exits.
		329
		330	It might be useful to know that rxvt will not close file descriptors
		331	passed to it (except for stdin/out/err, of course), so you can use
		332	file descriptors to communicate with the programs within the
		333	terminal. This works regardless of wether the "-embed" option was
		334	used or not.
318		335
319	RESOURCES (available also as long-options)	336	RESOURCES (available also as long-options)
320	Note: `rxvt --help' gives a list of all resources (long options)	337	Note: `rxvt --help' gives a list of all resources (long options)
321	compiled into your version.	338	compiled into your version.
322		339
323	There are two different methods that rxvt can use to get the Xresource	340	There are two different methods that rxvt can use to get the Xresource
324	data: using the X libraries (Xrm*-functions) or internal Xresources	341	data: using the X libraries (Xrm*-functions) or internal Xresources
325	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists	342	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326	XGetDefaults), you can set and change the resources using X11 tools like	343	XGetDefaults), you can set and change the resources using X11 tools like
327	xset. Many distribution do also load settings from the ~/.Xresources	344	xrdb. Many distribution do also load settings from the ~/.Xresources
328	file when X starts.	345	file when X starts. rxvt will consult the following files/resources in
		346	order, with later settings overwriting earlier ones:
		347
		348	1. system-wide app-defaults file, either locale-dependent OR global
		349	2. app-defaults file in $XAPPLRESDIR
		350	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		351	4. SCREEN_RESOURCES for the current screen
		352	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329		353
330	If compiled with internal Xresources support (i.e. rxvt -h lists	354	If compiled with internal Xresources support (i.e. rxvt -h lists
331	.Xdefaults) then rxvt accepts application defaults set in	355	.Xdefaults) then rxvt accepts application defaults set in
332	XAPPLOADDIR/URxvt (compile-time defined: usually	356	XAPPLOADDIR/URxvt (compile-time defined: usually
333	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or	357	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
…		…
576	True: scroll to bottom when tty receives output; option -si. False:	600	True: scroll to bottom when tty receives output; option -si. False:
577	do not scroll to bottom when tty receives output; option +si.	601	do not scroll to bottom when tty receives output; option +si.
578		602
579	scrollWithBuffer: boolean	603	scrollWithBuffer: boolean
580	True: scroll with scrollback buffer when tty receives new lines (and	604	True: scroll with scrollback buffer when tty receives new lines (and
581	scrollTtyOutput is False); option +sw. False: do not scroll with	605	scrollTtyOutput is False); option -sw. False: do not scroll with
582	scrollback buffer when tty recieves new lines; option -sw.	606	scrollback buffer when tty recieves new lines; option +sw.
583		607
584	scrollTtyKeypress: boolean	608	scrollTtyKeypress: boolean
585	True: scroll to bottom when a non-special key is pressed. Special	609	True: scroll to bottom when a non-special key is pressed. Special
586	keys are those which are intercepted by rxvt-unicode for special	610	keys are those which are intercepted by rxvt-unicode for special
587	handling and are not passed onto the shell; option -sk. False: do	611	handling and are not passed onto the shell; option -sk. False: do
…		…
739	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,	763	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740	"\000": octal number) or verbatim control characters ("^?": delete,	764	"\000": octal number) or verbatim control characters ("^?": delete,
741	"^@": null, "^A" ...) and may be enclosed with double quotes so that	765	"^@": null, "^A" ...) and may be enclosed with double quotes so that
742	it can start or end with whitespace.	766	it can start or end with whitespace.
743		767
		768	Please note that you need to double the "\" when using
		769	"--enable-xgetdefault", as X itself does it's own de-escaping (you
		770	can use "\033" instead of "\e" (and so on), which will work with
		771	both Xt and rxvt's own processing).
		772
744	You can define a range of keysyms in one shot by providing a	773	You can define a range of keysyms in one shot by providing a
745	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter	774	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746	`/' should be a character not used by the strings.	775	`/' should be a character not used by the strings.
747		776
748	Its usage can be demonstrated by an example:	777	Its usage can be demonstrated by an example:
749		778
750	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>	779	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
751		780
752	The above line is equivalent to the following three lines:	781	The above line is equivalent to the following three lines:
753		782
754	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>	783	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>	784	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>	785	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757		786
758	If string takes the form of "proto:STRING", the specified STRING	787	If string takes the form of "command:STRING", the specified STRING
759	is interpreted and executed as rxvt's control sequence. For example	788	is interpreted and executed as rxvt's control sequence. For example
760	the following means "change the current locale to "zh_CN.GBK" when	789	the following means "change the current locale to "zh_CN.GBK" when
761	Control-Meta-c is being pressed":	790	Control-Meta-c is being pressed":
762		791
763	URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007	792	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
764		793
765	The following example will map Control-Meta-1 and Control-Meta-2 to	794	The following example will map Control-Meta-1 and Control-Meta-2 to
766	the fonts "suxuseuro" and "9x15bold", so you cna have some limited	795	the fonts "suxuseuro" and "9x15bold", so you can have some limited
767	font-switching at runtime:	796	font-switching at runtime:
768		797
769	URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007	798	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770	URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007	799	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771		800
772	"proto:\033]701;zh_CN.GBK\007" means: change the current locale to	801	Other things are possible, e.g. resizing (see rxvt(7) for more
773	"zh_CN.GBK".	802	info):
		803
		804	URxvt.keysym.M-C-3: command:\033[8;25;80t
		805	URxvt.keysym.M-C-4: command:\033[8;48;110t
774		806
775	THE SCROLLBAR	807	THE SCROLLBAR
776	Lines of text that scroll off the top of the rxvt window (resource:	808	Lines of text that scroll off the top of the rxvt window (resource:
777	saveLines) and can be scrolled back using the scrollbar or by	809	saveLines) and can be scrolled back using the scrollbar or by
778	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is	810	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
…		…
788	normal text selection/insertion, hold either the Shift or the Meta (Alt)	820	normal text selection/insertion, hold either the Shift or the Meta (Alt)
789	key while performing the desired mouse action.	821	key while performing the desired mouse action.
790		822
791	If mouse reporting mode is active, the normal scrollbar actions are	823	If mouse reporting mode is active, the normal scrollbar actions are
792	disabled -- on the assumption that we are using a fullscreen	824	disabled -- on the assumption that we are using a fullscreen
793	application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next)	825	application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794	and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down	826	(Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795	arrows sends ESC[A (Up) and ESC[B (Down), respectively.	827	up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796		828
797	TEXT SELECTION AND INSERTION	829	TEXT SELECTION AND INSERTION
798	The behaviour of text selection and insertion mechanism is similar to	830	The behaviour of text selection and insertion mechanism is similar to
799	xterm(1).	831	xterm(1).
800		832
…		…
929	rxvt -fg Black -bg White -rv	961	rxvt -fg Black -bg White -rv
930	would yield White on Black, while on xterm(1) it would yield Black	962	would yield White on Black, while on xterm(1) it would yield Black
931	on White.	963	on White.
932		964
933	ENVIRONMENT	965	ENVIRONMENT
934	rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The	966	rxvt sets and/or uses the following environment variables:
935	environment variable WINDOWID is set to the X window id number of the	967
936	rxvt window and it also uses and sets the environment variable DISPLAY	968	TERM
937	to specify which display terminal to use. rxvt uses the environment	969	Normally set to "rxvt-unicode", unless overwritten at configure
938	variables RXVTPATH and PATH to find XPM files.	970	time, via resources or on the commandline.
		971
		972	COLORTERM
		973	Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
		974	with XPM support, and optionally with the added extension "-mono" to
		975	indicate that rxvt-unicode runs on a monochrome screen.
		976
		977	COLORFGBG
		978	Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
		979	the colour code used as default foreground/text colour (or the
		980	string "default" to indicate that the default-colour escape sequence
		981	is to be used), "bg" is the colour code used as default background
		982	colour (or the string "default"), and "xpm" is the string "default"
		983	if rxvt was compiled with XPM support. Libraries like "ncurses" and
		984	"slang" can (and do) use this information to optimize screen output.
		985
		986	WINDOWID
		987	Set to the (decimal) X Window ID of the rxvt window (the toplevel
		988	window, which usually has subwindows for the scrollbar, the terminal
		989	window and so on).
		990
		991	TERMINFO
		992	Set to the terminfo directory iff rxvt was configured with
		993	"--with-terminfo=PATH".
		994
		995	DISPLAY
		996	Used by rxvt to connect to the display and set to the correct
		997	display in it's child processes.
		998
		999	SHELL
		1000	The shell to be used for command execution, defaults to "/bin/sh".
		1001
		1002	RXVTPATH
		1003	The path where rxvt looks for support files such as menu and xpm
		1004	files.
		1005
		1006	PATH
		1007	Used in the same way as "RXVTPATH".
		1008
		1009	RXVT_SOCKET
		1010	The unix domain socket path used by rxvtc(1) and rxvtd(1).
		1011
		1012	Default "$HOME/.rxvt-unicode-<nodename".
		1013
		1014	HOME
		1015	Used to locate the default directory for the unix domain socket for
		1016	daemon communications and to locate various resource files (such as
		1017	".Xdefaults")
		1018
		1019	XAPPLRESDIR
		1020	Directory where various X resource files are being located.
		1021
		1022	XENVIRONMENT
		1023	If set and accessible, gives the name of a X resource file to be
		1024	loaded by rxvt.
939		1025
940	FILES	1026	FILES
941	/usr/lib/X11/rgb.txt	1027	/usr/lib/X11/rgb.txt
942	Color names.	1028	Color names.
943		1029
…		…
951		1037
952	Click-and-drag doesn't work with X11 mouse report overriding.	1038	Click-and-drag doesn't work with X11 mouse report overriding.
953		1039
954	CURRENT PROJECT COORDINATOR	1040	CURRENT PROJECT COORDINATOR
955	Project Coordinator	1041	Project Coordinator
956	Marc A. Lehmann rxvt@schmorp.de	1042	Marc A. Lehmann <rxvt-unicode@schmorp.de>
957		1043
958	Web page maintainter
959	Marc A. Lehmann rxvt@schmorp.de
960
961	<http://software.schmorp.de/>	1044	<http://software.schmorp.de/#rxvt-unicode>
962		1045
963	AUTHORS	1046	AUTHORS
964	John Bovey	1047	John Bovey
965	University of Kent, 1992, wrote the original Xvt.	1048	University of Kent, 1992, wrote the original Xvt.
966		1049
…		…
980		1063
981	Geoff Wing <gcw@pobox.com>	1064	Geoff Wing <gcw@pobox.com>
982	Rewrote screen display and text selection routines. Project	1065	Rewrote screen display and text selection routines. Project
983	Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1066	Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984		1067
985	Marc Alexander Lehmann <rxvt@schmorp.de>	1068	Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986	Forked rxvt-unicode, rewrote most of the display code and internal	1069	Forked rxvt-unicode, rewrote most of the display code and internal
987	character handling to store text in unicode, improve xterm	1070	character handling to store text in unicode, improve xterm
988	compatibility and apply numerous other bugfixes and extensions.	1071	compatibility and apply numerous other bugfixes and extensions.
989		1072
990	Project Coordinator (Changes 1.0 -)	1073	Project Coordinator (Changes 1.0 -)

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs. Revision 1.16 by root, Wed Feb 16 22:16:30 2005 UTC

Diff Legend

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.16 by root, Wed Feb 16 22:16:30 2005 UTC