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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.11 by root, Fri Feb 11 18:14: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.8, is a colour vt102 terminal emulator intended	9	rxvt-unicode, version 5.0, 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
…		…
277		279
278	-im text	280	-im text
279	Compile XIM: input method name. resource inputMethod.	281	Compile XIM: input method name. resource inputMethod.
280		282
281	-imlocale string	283	-imlocale string
282	The locale to use for opening the IM. You can use an LC_CTYPE of	284	The locale to use for opening the IM. You can use an "LC_CTYPE" of
283	e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the	285	e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
284	input extension to be able to input japanese characters while	286	the input extension to be able to input japanese characters while
285	staying in another locale.	287	staying in another locale. resource imLocale.
		288
		289	-imfont fontset
		290	Set the font set to use for the X Input Method, see resource imFont
		291	for more info.
		292
		293	-tcw
		294	Change the meaning of triple-click selection with the left mouse
		295	button. Instead of selecting a full line it will extend the
		296	selection the end of the logical line only. resource
		297	tripleclickwords.
286		298
287	-insecure	299	-insecure
288	Enable "insecure" mode, which currently enables most of the escape	300	Enable "insecure" mode, which currently enables most of the escape
289	sequences that echo strings. See the resource insecure for more	301	sequences that echo strings. See the resource insecure for more
290	info.	302	info.
…		…
299		311
300	-ssr\|+ssr	312	-ssr\|+ssr
301	Turn on/off secondary screen scroll (default enabled); resource	313	Turn on/off secondary screen scroll (default enabled); resource
302	secondaryScroll.	314	secondaryScroll.
303		315
		316	-keysym.sym: string
		317	Remap a key symbol. See resource keysym.
		318
304	-xrm resourcestring	319	-xrm resourcestring
305	No effect on rxvt-unicode. Simply passes through an argument to be	320	No effect on rxvt-unicode. Simply passes through an argument to be
306	made available in the instance's argument list. Appears in	321	made available in the instance's argument list. Appears in
307	WM_COMMAND in some window managers.	322	WM_COMMAND in some window managers.
308		323
…		…
312		327
313	There are two different methods that rxvt can use to get the Xresource	328	There are two different methods that rxvt can use to get the Xresource
314	data: using the X libraries (Xrm*-functions) or internal Xresources	329	data: using the X libraries (Xrm*-functions) or internal Xresources
315	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists	330	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316	XGetDefaults), you can set and change the resources using X11 tools like	331	XGetDefaults), you can set and change the resources using X11 tools like
317	xset. Many distribution do also load settings from the ~/.Xresources	332	xrdb. Many distribution do also load settings from the ~/.Xresources
318	file when X starts.	333	file when X starts. rxvt will consult the following files/resources in
		334	order, with later settings overwriting earlier ones:
		335
		336	1. system-wide app-defaults file, either locale-dependent OR global
		337	2. app-defaults file in $XAPPLRESDIR
		338	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		339	4. SCREEN_RESOURCES for the current screen
		340	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
319		341
320	If compiled with internal Xresources support (i.e. rxvt -h lists	342	If compiled with internal Xresources support (i.e. rxvt -h lists
321	.Xdefaults) then rxvt accepts application defaults set in	343	.Xdefaults) then rxvt accepts application defaults set in
322	XAPPLOADDIR/URxvt (compile-time defined: usually	344	XAPPLOADDIR/URxvt (compile-time defined: usually
323	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or	345	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
…		…
654		676
655	inputMethod: name	677	inputMethod: name
656	name of inputMethod to use; option -im.	678	name of inputMethod to use; option -im.
657		679
658	imLocale: name	680	imLocale: name
659	The locale to use for opening the IM. You can use an LC_CTYPE of	681	The locale to use for opening the IM. You can use an "LC_CTYPE" of
660	e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the	682	e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
661	input extension to be able to input japanese characters while	683	the input extension to be able to input japanese characters while
662	staying in another locale. option -imlocale.	684	staying in another locale. option -imlocale.
		685
		686	imFont: fontset
		687	Specify the font-set used for XIM styles "OverTheSpot" or
		688	"OffTheSpot". It must be a standard X font set (XLFD patterns
		689	separated by commas), i.e. it's not in the same format as the other
		690	font lists used in rxvt. The default will be set-up to chose any
		691	suitable found found, preferably one or two pixels differing in size
		692	to the base font. option -imfont.
		693
		694	tripleclickwords: boolean
		695	Change the meaning of triple-click selection with the left mouse
		696	button. Instead of selecting a full line it will extend the
		697	selection to the end of the logical line only. option -tcw.
663		698
664	insecure: boolean	699	insecure: boolean
665	Enables "insecure" mode. Rxvt-unicode offers some escape sequences	700	Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666	that echo arbitrary strings like the icon name or the locale. This	701	that echo arbitrary strings like the icon name or the locale. This
667	could be abused if somebody gets 8-bit-clean access to your display,	702	could be abused if somebody gets 8-bit-clean access to your display,
…		…
700	Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,	735	Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
701	C, N, S, M, A, L, 1, 2, 3, 4, 5.	736	C, N, S, M, A, L, 1, 2, 3, 4, 5.
702		737
703	The NumLock, Meta and ISOLevel3 modifiers are usually aliased to	738	The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
704	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3	739	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
705	Shift/AltGr keys are being mapped. AppKeypad is a artificial	740	Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
706	modifier mapped to the current application keymap mode state.	741	mapped to the current application keymap mode state.
707		742
708	The spellings of key can be obtained by using xev(1) command or	743	The spellings of key can be obtained by using xev(1) command or
709	searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and	744	searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
710	omitting the prefix XK_. Alternatively you can specify key by its	745	omitting the prefix XK_. Alternatively you can specify key by its
711	hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms	746	hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms
…		…
716	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,	751	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
717	"\000": octal number) or verbatim control characters ("^?": delete,	752	"\000": octal number) or verbatim control characters ("^?": delete,
718	"^@": null, "^A" ...) and may be enclosed with double quotes so that	753	"^@": null, "^A" ...) and may be enclosed with double quotes so that
719	it can start or end with whitespace.	754	it can start or end with whitespace.
720		755
		756	Please note that you need to double the "\" when using
		757	"--enable-xgetdefault", as X itself does it's own de-escaping (you
		758	can use "\033" instead of "\e" (and so on), which will work with
		759	both Xt and rxvt's own processing).
		760
721	You can define a range of keysyms in one shot by providing a	761	You can define a range of keysyms in one shot by providing a
722	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter	762	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
723	`/' should be a character not used by the strings.	763	`/' should be a character not used by the strings.
724		764
725	Its usage can be demonstrated by an example:	765	Its usage can be demonstrated by an example:
726		766
727	URxvt.keysym.M-C-0x61: list\|\e<M-C-\|abc\|>	767	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
728		768
729	The above line is equivalent to the following three lines:	769	The above line is equivalent to the following three lines:
730		770
731	URxvt.keysym.Meta-Control-0x61: \e<M-C-a>	771	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
732	URxvt.keysym.Meta-Control-0x62: \e<M-C-b>	772	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
733	URxvt.keysym.Meta-Control-0x63: \e<M-C-c>	773	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
734		774
735	If string takes the form of "proto:STRING", the specified STRING	775	If string takes the form of "command:STRING", the specified STRING
736	is interpreted and executed as rxvt's control sequence. For example,	776	is interpreted and executed as rxvt's control sequence. For example
737	"proto:\033]701;zh_CN.GBK\007" means: change the current locale to	777	the following means "change the current locale to "zh_CN.GBK" when
738	"zh_CN.GBK".	778	Control-Meta-c is being pressed":
		779
		780	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		781
		782	The following example will map Control-Meta-1 and Control-Meta-2 to
		783	the fonts "suxuseuro" and "9x15bold", so you can have some limited
		784	font-switching at runtime:
		785
		786	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		787	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		788
		789	Other things are possible, e.g. resizing (see rxvt(7) for more
		790	info):
		791
		792	URxvt.keysym.M-C-3: command:\033[8;25;80t
		793	URxvt.keysym.M-C-4: command:\033[8;48;110t
739		794
740	THE SCROLLBAR	795	THE SCROLLBAR
741	Lines of text that scroll off the top of the rxvt window (resource:	796	Lines of text that scroll off the top of the rxvt window (resource:
742	saveLines) and can be scrolled back using the scrollbar or by	797	saveLines) and can be scrolled back using the scrollbar or by
743	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is	798	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
…		…
753	normal text selection/insertion, hold either the Shift or the Meta (Alt)	808	normal text selection/insertion, hold either the Shift or the Meta (Alt)
754	key while performing the desired mouse action.	809	key while performing the desired mouse action.
755		810
756	If mouse reporting mode is active, the normal scrollbar actions are	811	If mouse reporting mode is active, the normal scrollbar actions are
757	disabled -- on the assumption that we are using a fullscreen	812	disabled -- on the assumption that we are using a fullscreen
758	application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next)	813	application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
759	and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down	814	(Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
760	arrows sends ESC[A (Up) and ESC[B (Down), respectively.	815	up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
761		816
762	TEXT SELECTION AND INSERTION	817	TEXT SELECTION AND INSERTION
763	The behaviour of text selection and insertion mechanism is similar to	818	The behaviour of text selection and insertion mechanism is similar to
764	xterm(1).	819	xterm(1).
765		820
766	Selection:	821	Selection:
767	Left click at the beginning of the region, drag to the end of the	822	Left click at the beginning of the region, drag to the end of the
768	region and release; Right click to extend the marked region; Left	823	region and release; Right click to extend the marked region; Left
769	double-click to select a word; Left triple-click to select the	824	double-click to select a word; Left triple-click to select the
770	entire line.	825	entire logical line (which can span multiple screen lines), unless
		826	modified by resource tripleclickwords.
771		827
772	Starting a selection while pressing the Meta key (or Meta+Ctrl keys)	828	Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
773	(Compile: frills) will create a rectangular selection instead of a	829	(Compile: frills) will create a rectangular selection instead of a
774	normal one.	830	normal one.
775		831
…		…
795	character codes using the keyboard. It consists of 4 parts. The first	851	character codes using the keyboard. It consists of 4 parts. The first
796	part is available rxvt-unicode has been compiled with "--enable-frills",	852	part is available rxvt-unicode has been compiled with "--enable-frills",
797	the rest is available when rxvt-unicode was compiled with	853	the rest is available when rxvt-unicode was compiled with
798	"--enable-iso14755".	854	"--enable-iso14755".
799		855
800	5.1: Basic method	856	* 5.1: Basic method
801	This allows you to enter unicode characters using their hexcode.	857	This allows you to enter unicode characters using their hexcode.
802		858
803	Start by pressing and holding both "Control" and "Shift", then enter	859	Start by pressing and holding both "Control" and "Shift", then enter
804	hex-digits (between one and six). Releasing "Control" and "Shift"	860	hex-digits (between one and six). Releasing "Control" and "Shift"
805	will commit the character as if it were typed directly. While	861	will commit the character as if it were typed directly. While
…		…
811	address, which you cannot type. Fortunately, the card has the e-mail	867	address, which you cannot type. Fortunately, the card has the e-mail
812	address printed as hexcodes, e.g. "671d 65e5". You can enter this	868	address printed as hexcodes, e.g. "671d 65e5". You can enter this
813	easily by pressing "Control" and "Shift", followed by	869	easily by pressing "Control" and "Shift", followed by
814	"6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.	870	"6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
815		871
816	5.2: Keyboard symbols entry method	872	* 5.2: Keyboard symbols entry method
817	This mode lets you input characters representing the keycap symbols	873	This mode lets you input characters representing the keycap symbols
818	of your keyboard, if representable in the current locale encoding.	874	of your keyboard, if representable in the current locale encoding.
819		875
820	Start by pressing "Control" and "Shift" together, then releasing	876	Start by pressing "Control" and "Shift" together, then releasing
821	them. The next special key (cursor keys, home etc.) you enter will	877	them. The next special key (cursor keys, home etc.) you enter will
…		…
823	corresponding keycap symbol. The symbol will only be entered when	879	corresponding keycap symbol. The symbol will only be entered when
824	the key has been released, otherwise pressing e.g. "Shift" would	880	the key has been released, otherwise pressing e.g. "Shift" would
825	enter the symbol for "ISO Level 2 Switch", although your intention	881	enter the symbol for "ISO Level 2 Switch", although your intention
826	might have been to enter a reverse tab (Shift-Tab).	882	might have been to enter a reverse tab (Shift-Tab).
827		883
828	5.3: Screen-selection entry method	884	* 5.3: Screen-selection entry method
829	While this is implemented already (it's basically the selection	885	While this is implemented already (it's basically the selection
830	mechanism), it could be extended by displaying a unicode character	886	mechanism), it could be extended by displaying a unicode character
831	map.	887	map.
832		888
833	5.4: Feedback method for identifying displayed characters for later	889	* 5.4: Feedback method for identifying displayed characters for later
834	input	890	input
835	This method lets you display the unicode character code associated	891	This method lets you display the unicode character code associated
836	with characters already displayed.	892	with characters already displayed.
837		893
838	You enter this mode by holding down "Control" and "Shift" together,	894	You enter this mode by holding down "Control" and "Shift" together,
…		…
850	both scenario A and B of ISO 14755, including part 5.2.	906	both scenario A and B of ISO 14755, including part 5.2.
851		907
852	LOGIN STAMP	908	LOGIN STAMP
853	rxvt tries to write an entry into the utmp(5) file so that it can be	909	rxvt tries to write an entry into the utmp(5) file so that it can be
854	seen via the who(1) command, and can accept messages. To allow this	910	seen via the who(1) command, and can accept messages. To allow this
855	feature, rxvt must be installed setuid root on some systems.	911	feature, rxvt may need to be installed setuid root on some systems or
		912	setgid to root or to some other group on others.
856		913
857	COLORS AND GRAPHICS	914	COLORS AND GRAPHICS
858	In addition to the default foreground and background colours, rxvt can	915	In addition to the default foreground and background colours, rxvt can
859	display up to 16 colours (8 ANSI colours plus high-intensity bold/blink	916	display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
860	versions of the same). Here is a list of the colours with their rgb.txt	917	versions of the same). Here is a list of the colours with their rgb.txt
…		…
892	rxvt -fg Black -bg White -rv	949	rxvt -fg Black -bg White -rv
893	would yield White on Black, while on xterm(1) it would yield Black	950	would yield White on Black, while on xterm(1) it would yield Black
894	on White.	951	on White.
895		952
896	ENVIRONMENT	953	ENVIRONMENT
897	rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The	954	rxvt sets and/or uses the following environment variables:
898	environment variable WINDOWID is set to the X window id number of the	955
899	rxvt window and it also uses and sets the environment variable DISPLAY	956	TERM
900	to specify which display terminal to use. rxvt uses the environment	957	Normally set to "rxvt-unicode", unless overwritten at configure
901	variables RXVTPATH and PATH to find XPM files.	958	time, via resources or on the commandline.
		959
		960	COLORTERM
		961	Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
		962	with XPM support, and optionally with the added extension "-mono" to
		963	indicate that rxvt-unicode runs on a monochrome screen.
		964
		965	COLORFGBG
		966	Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
		967	the colour code used as default foreground/text colour (or the
		968	string "default" to indicate that the default-colour escape sequence
		969	is to be used), "bg" is the colour code used as default background
		970	colour (or the string "default"), and "xpm" is the string "default"
		971	if rxvt was compiled with XPM support. Libraries like "slang" can
		972	(and do) use this information to optimize screen output.
		973
		974	WINDOWID
		975	Set to the (decimal) X Window ID of the rxvt window (the toplevel
		976	window, which usually has subwindows for the scrollbar, the terminal
		977	window and so on).
		978
		979	TERMINFO
		980	Set to the terminfo directory iff rxvt was configured with
		981	"--with-terminfo=PATH".
		982
		983	DISPLAY
		984	Used by rxvt to connect to the display and set to the correct
		985	display in it's child processes.
		986
		987	SHELL
		988	The shell to be used for command execution, defaults to "/bin/sh".
		989
		990	RXVTPATH
		991	The path where rxvt looks for support files such as menu and xpm
		992	files.
		993
		994	PATH
		995	Used in the same way as "RXVTPATH".
		996
		997	RXVT_SOCKET
		998	The unix domain socket path used by rxvtc(1) and rxvtd(1).
		999
		1000	Default "$HOME/.rxvt-unicode-<nodename".
		1001
		1002	HOME
		1003	Used to locate the default directory for the unix domain socket for
		1004	daemon communications and to locate various resource files (such as
		1005	".Xdefaults")
		1006
		1007	XAPPLRESDIR
		1008	Directory where various X resource files are being located.
		1009
		1010	XENVIRONMENT
		1011	If set and accessible, gives the name of a X resource file to be
		1012	loaded by rxvt.
902		1013
903	FILES	1014	FILES
904	/etc/utmp
905	System file for login records.
906
907	/usr/lib/X11/rgb.txt	1015	/usr/lib/X11/rgb.txt
908	Color names.	1016	Color names.
909		1017
910	SEE ALSO	1018	SEE ALSO
911	rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1019	rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
…		…
917		1025
918	Click-and-drag doesn't work with X11 mouse report overriding.	1026	Click-and-drag doesn't work with X11 mouse report overriding.
919		1027
920	CURRENT PROJECT COORDINATOR	1028	CURRENT PROJECT COORDINATOR
921	Project Coordinator	1029	Project Coordinator
922	Marc A. Lehmann rxvt@schmorp.de
923
924	Web page maintainter
925	Marc A. Lehmann rxvt@schmorp.de	1030	Marc A. Lehmann rxvt@schmorp.de
926		1031
927	<http://software.schmorp.de/>	1032	<http://software.schmorp.de/>
928		1033
929	AUTHORS	1034	AUTHORS

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs. Revision 1.11 by root, Fri Feb 11 18:14:07 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.11 by root, Fri Feb 11 18:14:07 2005 UTC