[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.18 by root, Fri Feb 18 12:15:07 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.
		335
		336	Here is a short Gtk2-perl snippet that illustrates how this option
		337	can be used (a longer example is in doc/embed):
		338
		339	my $rxvt = new Gtk2::DrawingArea;
		340	$...->add ($rxvt); # important to add it somewhere first
		341	$rxvt->realize; # now it can be realized
		342	my $xid = $rxvt->window->get_xid;
		343
		344	system "rxvt -embed $xid &";
		345
		346	-pty-fd fileno
		347	Tells rxvt NOT to execute any commands or create a new pty/tty pair
		348	but instead use the given filehandle as the tty master. This is
		349	useful if you want to drive rxvt as a generic terminal emulator
		350	without having to run a program within it.
		351
		352	If this switch is given, rxvt will not create any utmp/wtmp entries
		353	and will not tinker with pty/tty permissions - you have to do that
		354	yourself if you want that.
		355
		356	Here is a example in perl that illustrates how this option can be
		357	used (a longer example is in doc/pty-fd):
		358
		359	use IO::Pty;
		360	use Fcntl;
		361
		362	my $pty = new IO::Pty;
		363	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		364	system "rxvt -pty-fd " . (fileno $pty) . "&";
		365	close $pty;
		366
		367	# now communicate with rxvt
		368	my $slave = $pty->slave;
		369	while (<$slave>) { print $slave "got <$_>\n" }
318		370
319	RESOURCES (available also as long-options)	371	RESOURCES (available also as long-options)
320	Note: `rxvt --help' gives a list of all resources (long options)	372	Note: `rxvt --help' gives a list of all resources (long options)
321	compiled into your version.	373	compiled into your version.
322		374
323	There are two different methods that rxvt can use to get the Xresource	375	There are two different methods that rxvt can use to get the Xresource
324	data: using the X libraries (Xrm*-functions) or internal Xresources	376	data: using the X libraries (Xrm*-functions) or internal Xresources
325	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists	377	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326	XGetDefaults), you can set and change the resources using X11 tools like	378	XGetDefaults), you can set and change the resources using X11 tools like
327	xset. Many distribution do also load settings from the ~/.Xresources	379	xrdb. Many distribution do also load settings from the ~/.Xresources
328	file when X starts.	380	file when X starts. rxvt will consult the following files/resources in
		381	order, with later settings overwriting earlier ones:
		382
		383	1. system-wide app-defaults file, either locale-dependent OR global
		384	2. app-defaults file in $XAPPLRESDIR
		385	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		386	4. SCREEN_RESOURCES for the current screen
		387	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329		388
330	If compiled with internal Xresources support (i.e. rxvt -h lists	389	If compiled with internal Xresources support (i.e. rxvt -h lists
331	.Xdefaults) then rxvt accepts application defaults set in	390	.Xdefaults) then rxvt accepts application defaults set in
332	XAPPLOADDIR/URxvt (compile-time defined: usually	391	XAPPLOADDIR/URxvt (compile-time defined: usually
333	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or	392	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
…		…
576	True: scroll to bottom when tty receives output; option -si. False:	635	True: scroll to bottom when tty receives output; option -si. False:
577	do not scroll to bottom when tty receives output; option +si.	636	do not scroll to bottom when tty receives output; option +si.
578		637
579	scrollWithBuffer: boolean	638	scrollWithBuffer: boolean
580	True: scroll with scrollback buffer when tty receives new lines (and	639	True: scroll with scrollback buffer when tty receives new lines (and
581	scrollTtyOutput is False); option +sw. False: do not scroll with	640	scrollTtyOutput is False); option -sw. False: do not scroll with
582	scrollback buffer when tty recieves new lines; option -sw.	641	scrollback buffer when tty recieves new lines; option +sw.
583		642
584	scrollTtyKeypress: boolean	643	scrollTtyKeypress: boolean
585	True: scroll to bottom when a non-special key is pressed. Special	644	True: scroll to bottom when a non-special key is pressed. Special
586	keys are those which are intercepted by rxvt-unicode for special	645	keys are those which are intercepted by rxvt-unicode for special
587	handling and are not passed onto the shell; option -sk. False: do	646	handling and are not passed onto the shell; option -sk. False: do
…		…
739	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,	798	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740	"\000": octal number) or verbatim control characters ("^?": delete,	799	"\000": octal number) or verbatim control characters ("^?": delete,
741	"^@": null, "^A" ...) and may be enclosed with double quotes so that	800	"^@": null, "^A" ...) and may be enclosed with double quotes so that
742	it can start or end with whitespace.	801	it can start or end with whitespace.
743		802
		803	Please note that you need to double the "\" when using
		804	"--enable-xgetdefault", as X itself does it's own de-escaping (you
		805	can use "\033" instead of "\e" (and so on), which will work with
		806	both Xt and rxvt's own processing).
		807
744	You can define a range of keysyms in one shot by providing a	808	You can define a range of keysyms in one shot by providing a
745	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter	809	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746	`/' should be a character not used by the strings.	810	`/' should be a character not used by the strings.
747		811
748	Its usage can be demonstrated by an example:	812	Its usage can be demonstrated by an example:
749		813
750	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>	814	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
751		815
752	The above line is equivalent to the following three lines:	816	The above line is equivalent to the following three lines:
753		817
754	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>	818	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>	819	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>	820	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757		821
758	If string takes the form of "proto:STRING", the specified STRING	822	If string takes the form of "command:STRING", the specified STRING
759	is interpreted and executed as rxvt's control sequence. For example	823	is interpreted and executed as rxvt's control sequence. For example
760	the following means "change the current locale to "zh_CN.GBK" when	824	the following means "change the current locale to "zh_CN.GBK" when
761	Control-Meta-c is being pressed":	825	Control-Meta-c is being pressed":
762		826
763	URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007	827	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
764		828
765	The following example will map Control-Meta-1 and Control-Meta-2 to	829	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	830	the fonts "suxuseuro" and "9x15bold", so you can have some limited
767	font-switching at runtime:	831	font-switching at runtime:
768		832
769	URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007	833	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770	URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007	834	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771		835
772	"proto:\033]701;zh_CN.GBK\007" means: change the current locale to	836	Other things are possible, e.g. resizing (see rxvt(7) for more
773	"zh_CN.GBK".	837	info):
		838
		839	URxvt.keysym.M-C-3: command:\033[8;25;80t
		840	URxvt.keysym.M-C-4: command:\033[8;48;110t
774		841
775	THE SCROLLBAR	842	THE SCROLLBAR
776	Lines of text that scroll off the top of the rxvt window (resource:	843	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	844	saveLines) and can be scrolled back using the scrollbar or by
778	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is	845	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
…		…
788	normal text selection/insertion, hold either the Shift or the Meta (Alt)	855	normal text selection/insertion, hold either the Shift or the Meta (Alt)
789	key while performing the desired mouse action.	856	key while performing the desired mouse action.
790		857
791	If mouse reporting mode is active, the normal scrollbar actions are	858	If mouse reporting mode is active, the normal scrollbar actions are
792	disabled -- on the assumption that we are using a fullscreen	859	disabled -- on the assumption that we are using a fullscreen
793	application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next)	860	application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794	and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down	861	(Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795	arrows sends ESC[A (Up) and ESC[B (Down), respectively.	862	up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796		863
797	TEXT SELECTION AND INSERTION	864	TEXT SELECTION AND INSERTION
798	The behaviour of text selection and insertion mechanism is similar to	865	The behaviour of text selection and insertion mechanism is similar to
799	xterm(1).	866	xterm(1).
800		867
…		…
929	rxvt -fg Black -bg White -rv	996	rxvt -fg Black -bg White -rv
930	would yield White on Black, while on xterm(1) it would yield Black	997	would yield White on Black, while on xterm(1) it would yield Black
931	on White.	998	on White.
932		999
933	ENVIRONMENT	1000	ENVIRONMENT
934	rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The	1001	rxvt sets and/or uses the following environment variables:
935	environment variable WINDOWID is set to the X window id number of the	1002
936	rxvt window and it also uses and sets the environment variable DISPLAY	1003	TERM
937	to specify which display terminal to use. rxvt uses the environment	1004	Normally set to "rxvt-unicode", unless overwritten at configure
938	variables RXVTPATH and PATH to find XPM files.	1005	time, via resources or on the commandline.
		1006
		1007	COLORTERM
		1008	Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
		1009	with XPM support, and optionally with the added extension "-mono" to
		1010	indicate that rxvt-unicode runs on a monochrome screen.
		1011
		1012	COLORFGBG
		1013	Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
		1014	the colour code used as default foreground/text colour (or the
		1015	string "default" to indicate that the default-colour escape sequence
		1016	is to be used), "bg" is the colour code used as default background
		1017	colour (or the string "default"), and "xpm" is the string "default"
		1018	if rxvt was compiled with XPM support. Libraries like "ncurses" and
		1019	"slang" can (and do) use this information to optimize screen output.
		1020
		1021	WINDOWID
		1022	Set to the (decimal) X Window ID of the rxvt window (the toplevel
		1023	window, which usually has subwindows for the scrollbar, the terminal
		1024	window and so on).
		1025
		1026	TERMINFO
		1027	Set to the terminfo directory iff rxvt was configured with
		1028	"--with-terminfo=PATH".
		1029
		1030	DISPLAY
		1031	Used by rxvt to connect to the display and set to the correct
		1032	display in it's child processes.
		1033
		1034	SHELL
		1035	The shell to be used for command execution, defaults to "/bin/sh".
		1036
		1037	RXVTPATH
		1038	The path where rxvt looks for support files such as menu and xpm
		1039	files.
		1040
		1041	PATH
		1042	Used in the same way as "RXVTPATH".
		1043
		1044	RXVT_SOCKET
		1045	The unix domain socket path used by rxvtc(1) and rxvtd(1).
		1046
		1047	Default "$HOME/.rxvt-unicode-<nodename".
		1048
		1049	HOME
		1050	Used to locate the default directory for the unix domain socket for
		1051	daemon communications and to locate various resource files (such as
		1052	".Xdefaults")
		1053
		1054	XAPPLRESDIR
		1055	Directory where various X resource files are being located.
		1056
		1057	XENVIRONMENT
		1058	If set and accessible, gives the name of a X resource file to be
		1059	loaded by rxvt.
939		1060
940	FILES	1061	FILES
941	/usr/lib/X11/rgb.txt	1062	/usr/lib/X11/rgb.txt
942	Color names.	1063	Color names.
943		1064
…		…
951		1072
952	Click-and-drag doesn't work with X11 mouse report overriding.	1073	Click-and-drag doesn't work with X11 mouse report overriding.
953		1074
954	CURRENT PROJECT COORDINATOR	1075	CURRENT PROJECT COORDINATOR
955	Project Coordinator	1076	Project Coordinator
956	Marc A. Lehmann rxvt@schmorp.de	1077	Marc A. Lehmann <rxvt-unicode@schmorp.de>
957		1078
958	Web page maintainter
959	Marc A. Lehmann rxvt@schmorp.de
960
961	<http://software.schmorp.de/>	1079	<http://software.schmorp.de/#rxvt-unicode>
962		1080
963	AUTHORS	1081	AUTHORS
964	John Bovey	1082	John Bovey
965	University of Kent, 1992, wrote the original Xvt.	1083	University of Kent, 1992, wrote the original Xvt.
966		1084
…		…
980		1098
981	Geoff Wing <gcw@pobox.com>	1099	Geoff Wing <gcw@pobox.com>
982	Rewrote screen display and text selection routines. Project	1100	Rewrote screen display and text selection routines. Project
983	Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1101	Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984		1102
985	Marc Alexander Lehmann <rxvt@schmorp.de>	1103	Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986	Forked rxvt-unicode, rewrote most of the display code and internal	1104	Forked rxvt-unicode, rewrote most of the display code and internal
987	character handling to store text in unicode, improve xterm	1105	character handling to store text in unicode, improve xterm
988	compatibility and apply numerous other bugfixes and extensions.	1106	compatibility and apply numerous other bugfixes and extensions.
989		1107
990	Project Coordinator (Changes 1.0 -)	1108	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.18 by root, Fri Feb 18 12:15:07 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.18 by root, Fri Feb 18 12:15:07 2005 UTC