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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.37 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.69 by root, Sat Oct 27 12:09:02 2007 UTC

…		…
1	NAME	1	NAME
2	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window	2	rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
3	system)	3	system)
4		4
5	SYNOPSIS	5	SYNOPSIS
6	rxvt [options] [-e command [ args ]]	6	urxvt [options] [-e command [ args ]]
7		7
8	DESCRIPTION	8	DESCRIPTION
9	rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended	9	rxvt-unicode, version 8.4, 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 urxvt(7) (try "man 7 urxvt") for a list of frequently asked
17	and answer to them and some common problems. That document is also	17	questions and answer to them and some common problems. That document is
18	accessible on the World-Wide-Web at	18	also accessible on the World-Wide-Web at
19	<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	19	<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20		20
21	RXVT-UNICODE VS. RXVT	21	RXVT-UNICODE VS. RXVT
22	Unlike the original rxvt, rxvt-unicode stores all text in Unicode	22	Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23	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
24	world. Being a terminal emulator, however, some things are very	24	world. Being a terminal emulator, however, some things are very
25	difficult, especially cursive scripts such as arabic, vertically written	25	difficult, especially cursive scripts such as arabic, vertically written
26	scripts like mongolian or scripts requiring extremely complex combining	26	scripts like mongolian or scripts requiring extremely complex combining
27	rules, like tibetan or devenagari. Don't expect pretty output when using	27	rules, like tibetan or devanagari. Don't expect pretty output when using
28	these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.	28	these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29	should work fine, though. A somewhat difficult case are left-to-right	29	should work fine, though. A somewhat difficult case are right-to-left
30	scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional	30	scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31	algorithms belong into the application, not the terminal emulator (too	31	algorithms belong into the application, not the terminal emulator (too
32	many things -- such as cursor-movement while editing -- break	32	many things -- such as cursor-movement while editing -- break
33	otherwise), but that might change.	33	otherwise), but that might change.
34		34
35	If you are looking for a terminal that supports more exotic scripts, let	35	If you are looking for a terminal that supports more exotic scripts, let
36	me recommend "mlterm", which is a very userfriendly, lean and clean	36	me recommend "mlterm", which is a very user friendly, lean and clean
37	terminal emulator. In fact, the reason rxvt-unicode was born was solely	37	terminal emulator. In fact, the reason rxvt-unicode was born was solely
38	because the author couldn't get "mlterm" to use one font for latin1 and	38	because the author couldn't get "mlterm" to use one font for latin1 and
39	another for japanese.	39	another for japanese.
40		40
41	Therefore another design rationale was the use of multiple fonts to	41	Therefore another design rationale was the use of multiple fonts to
42	display characters: The idea of a single unicode font which many other	42	display characters: The idea of a single unicode font which many other
43	programs force onto it's users never made sense to me: You should be	43	programs force onto its users never made sense to me: You should be able
44	able to choose any font for any script freely.	44	to choose any font for any script freely.
45		45
46	Apart from that, rxvt-unicode is also much better internationalised than	46	Apart from that, rxvt-unicode is also much better internationalised than
47	it's predecessor, supports things such as XFT and ISO 14755 that are	47	its predecessor, supports things such as XFT and ISO 14755 that are
48	handy in i18n-environments, is faster, and has a lot less bugs than the	48	handy in i18n-environments, is faster, and has a lot bugs less than the
49	original rxvt. This all in addition to dozens of other small	49	original rxvt. This all in addition to dozens of other small
50	improvements.	50	improvements.
51		51
52	It is still faithfully following the original rxvt idea of being lean	52	It is still faithfully following the original rxvt idea of being lean
53	and nice on resources: for example, you can still configure rxvt-unicode	53	and nice on resources: for example, you can still configure rxvt-unicode
54	without most of it's features to get a lean binary. It also comes with a	54	without most of its features to get a lean binary. It also comes with a
55	client/daemon pair that lets you open any number of terminal windows	55	client/daemon pair that lets you open any number of terminal windows
56	from within a single process, which makes startup time very fast and	56	from within a single process, which makes startup time very fast and
57	drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)	57	drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(1)
58	(client).	58	(client).
59		59
60	It also makes technical information about escape sequences (which have	60	It also makes technical information about escape sequences (which have
61	been extended) easier accessible: see rxvt(7) for technical reference	61	been extended) more accessible: see urxvt(7) for technical reference
62	documentation (escape sequences etc.).	62	documentation (escape sequences etc.).
63		63
64	OPTIONS	64	OPTIONS
65	The rxvt options (mostly a subset of xterm's) are listed below. In	65	The urxvt options (mostly a subset of xterm's) are listed below. In
66	keeping with the smaller-is-better philosophy, options may be eliminated	66	keeping with the smaller-is-better philosophy, options may be eliminated
67	or default values chosen at compile-time, so options and defaults listed	67	or default values chosen at compile-time, so options and defaults listed
68	may not accurately reflect the version installed on your system. `rxvt	68	may not accurately reflect the version installed on your system. `urxvt
69	-h' gives a list of major compile-time options on the Options line.	69	-h' gives a list of major compile-time options on the Options line.
70	Option descriptions may be prefixed with which compile option each is	70	Option descriptions may be prefixed with which compile option each is
71	dependent upon. e.g. `Compile XIM:' requires XIM on the Options	71	dependent upon. e.g. `Compile XIM:' requires XIM on the Options
72	line. Note: `rxvt -help' gives a list of all command-line options	72	line. Note: `urxvt -help' gives a list of all command-line options
73	compiled into your version.	73	compiled into your version.
74		74
75	Note that rxvt permits the resource name to be used as a long-option	75	Note that urxvt permits the resource name to be used as a long-option
76	(--/++ option) so the potential command-line options are far greater	76	(--/++ option) so the potential command-line options are far greater
77	than those listed. For example: `rxvt --loginShell --color1 Orange'.	77	than those listed. For example: `urxvt --loginShell --color1 Orange'.
78		78
79	The following options are available:	79	The following options are available:
80		80
81	-help, --help	81	-help, --help
82	Print out a message describing available options.	82	Print out a message describing available options.
84	-display displayname	84	-display displayname
85	Attempt to open a window on the named X display (-d still	85	Attempt to open a window on the named X display (-d still
86	respected). In the absence of this option, the display specified by	86	respected). In the absence of this option, the display specified by
87	the DISPLAY environment variable is used.	87	the DISPLAY environment variable is used.
88		88
		89	-depth bitdepth
		90	Compile xft: Attempt to find a visual with the given bit depth;
		91	resource depth.
		92
89	-geometry geom	93	-geometry geom
90	Window geometry (-g still respected); resource geometry.	94	Window geometry (-g still respected); resource geometry.
91		95
92	-rv\|+rv	96	-rv\|+rv
93	Turn on/off simulated reverse video; resource reverseVideo.	97	Turn on/off simulated reverse video; resource reverseVideo.
94		98
95	-j\|+j	99	-j\|+j
96	Turn on/off jump scrolling; resource jumpScroll.	100	Turn on/off jump scrolling (allow multiple lines per refresh);
		101	resource jumpScroll.
97		102
98	-ip\|+ip \| -tr\|+tr	103	-ss\|+ss
99	Turn on/off inheriting parent window's pixmap. Alternative form is	104	Turn on/off skip scrolling (allow multiple screens per refresh);
100	-tr; resource inheritPixmap.	105	resource skipScroll.
		106
		107	-tr\|+tr
		108	Turn on/off illusion of a transparent window background. Obsolete
		109	form of it is -ip and it should not be used anymore; resource
		110	transparent.
		111
		112	*Please note that old resource name of inheritPixmap is obsolete and
		113	should be changed to transparent. Backwards compatibility support
		114	for inheritPixmap will be phased out in future versions of rxvt!*
		115
		116	*Please address all transparency related issues to Sasha Vasko at
		117	sasha@aftercode.net. Read the FAQ (man 7 urxvt)!*
101		118
102	-fade number	119	-fade number
103	Fade the text by the given percentage when focus is lost. Small	120	Fade the text by the given percentage when focus is lost. Small
104	values fade a little only, 100 completely replaces all colours by	121	values fade a little only, 100 completely replaces all colours by
105	the fade colour; resource fading.	122	the fade colour; resource fading.
106		123
107	-fadecolor colour	124	-fadecolor colour
108	Fade to this colour when fading is used (see -fade). The default	125	Fade to this colour when fading is used (see -fade). The default
109	colour is black. resource fadeColor.	126	colour is opaque black. resource fadeColor.
110		127
111	-tint colour	128	-tint colour
112	Tint the transparent background pixmap with the given colour when	129	Tint the transparent background pixmap with the given colour when
113	transparency is enabled with -tr or -ip. This only works for	130	transparency is enabled with -tr. This only works for non-tiled
114	non-tiled backgrounds, currently. See also the -sh option that can	131	backgrounds, currently. See also the -sh option that can be used to
115	be used to brighten or darken the image in addition to tinting it;	132	brighten or darken the image in addition to tinting it. Please note
		133	that certain tint colours can be applied on the server-side, thus
		134	yielding performance gain of two orders of magnitude. These colours
		135	are: blue, red, green, cyan, magenta, yellow, and those close to
116	resource tintColor. Example:	136	them; resource tintColor. Example:
117		137
118	rxvt -tr -tint blue -sh 40	138	urxvt -tr -tint blue -sh 40
119		139
		140	-sh number
120	-sh number Darken (0 .. 100) or lighten (-1 .. -100) the transparent	141	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
121	background image in addition to tinting it (i.e. -tint must be	142	image in addition to (or instead of) tinting it; resource shading.
122	specified, too, e.g. "-tint white").	143
		144	-blt string
		145	Specify background blending type. If background pixmap is specified
		146	at the same time as transparency - such pixmap will be blended over
		147	transparency image, using method specified. Supported values are :
		148	add, alphablend, allanon - color values averaging, colorize, darken,
		149	diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
		150	value. The default is alpha-blending. Compile afterimage; resource
		151	blendType.
		152
		153	-blr HxV
		154	Apply Gaussian Blur with the specified radii to the transparent
		155	background image. If single number is specified - both vertical and
		156	horizontal radii are considered to be the same. Setting one of the
		157	radii to 1 and another to a large number creates interesting effects
		158	on some backgrounds. Maximum radius value is 128. Compile
		159	afterimage; resource blurRadius.
123		160
124	-bg colour	161	-bg colour
125	Window background colour; resource background.	162	Window background colour; resource background.
126		163
127	-fg colour	164	-fg colour
128	Window foreground colour; resource foreground.	165	Window foreground colour; resource foreground.
129		166
130	-pixmap file[;geom]	167	-pixmap file[;geom]
131	Compile XPM: Specify XPM file for the background and also	168	Compile afterimage: Specify image file for the background and also
132	optionally specify its scaling with a geometry string. Note you may	169	optionally specify its scaling with a geometry string. Note you may
133	need to add quotes to avoid special shell interpretation of the ";"	170	need to add quotes to avoid special shell interpretation of the ";"
134	in the command-line; resource backgroundPixmap.	171	in the command-line; for more details see resource backgroundPixmap.
135		172
136	-cr colour	173	-cr colour
137	The cursor colour; resource cursorColor.	174	The cursor colour; resource cursorColor.
138		175
139	-pr colour	176	-pr colour
…		…
146	The colour of the border around the text area and between the	183	The colour of the border around the text area and between the
147	scrollbar and the text; resource borderColor.	184	scrollbar and the text; resource borderColor.
148		185
149	-fn fontlist	186	-fn fontlist
150	Select the fonts to be used. This is a comma separated list of font	187	Select the fonts to be used. This is a comma separated list of font
151	names that are used in turn when trying to display Unicode	188	names that are checked in order when trying to find glyphs for
152	characters. The first font defines the cell size for characters;	189	characters. The first font defines the cell size for characters;
153	other fonts might be smaller, but not (in general) larger. A	190	other fonts might be smaller, but not (in general) larger. A
154	(hopefully) reasonable default font list is always appended to it.	191	(hopefully) reasonable default font list is always appended to it.
155	See resource font for more details.	192	See resource font for more details.
156		193
157	In short, to specify an X11 core font, just specify it's name or	194	In short, to specify an X11 core font, just specify its name or
158	prefix it with "x:". To specify an XFT-font, you need to prefix it	195	prefix it with "x:". To specify an XFT-font, you need to prefix it
159	with "xft:", e.g.:	196	with "xft:", e.g.:
160		197
161	rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	198	urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162	rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"	199	urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163		200
164	See also the question "How does rxvt-unicode choose fonts?" in the	201	See also the question "How does rxvt-unicode choose fonts?" in the
165	FAQ section of rxvt(7).	202	FAQ section of urxvt(7).
166		203
167	-fb fontlist	204	-fb fontlist
168	Compile font-styles: The bold font list to use when bold	205	Compile font-styles: The bold font list to use when bold
169	characters are to be printed. See resource boldFont for details.	206	characters are to be printed. See resource boldFont for details.
170		207
…		…
252		289
253	-bl Compile frills: Set MWM hints to request a borderless window, i.e.	290	-bl Compile frills: Set MWM hints to request a borderless window, i.e.
254	if honoured by the WM, the rxvt-unicode window will not have window	291	if honoured by the WM, the rxvt-unicode window will not have window
255	decorations; resource borderLess.	292	decorations; resource borderLess.
256		293
		294	-override-redirect
		295	Compile frills: Sets override-redirect on the window; resource
		296	override-redirect.
		297
257	-sbg	298	-sbg
258	Compile frills: Disable the usage of the built-in block	299	Compile frills: Disable the usage of the built-in block
259	graphics/line drawing characters and just rely on what the specified	300	graphics/line drawing characters and just rely on what the specified
260	fonts provide. Use this if you have a good font and want to use its	301	fonts provide. Use this if you have a good font and want to use its
261	block graphic glyphs; resource skipBuiltinGlyphs.	302	block graphic glyphs; resource skipBuiltinGlyphs.
262		303
263	-lsp number	304	-lsp number
264	Compile frills: Lines (pixel height) to insert between each row of	305	Compile frills: Lines (pixel height) to insert between each row of
265	the display. Useful to work around font rendering problems; resource	306	the display. Useful to work around font rendering problems; resource
266	linespace.	307	lineSpace.
267		308
268	-tn termname	309	-tn termname
269	This option specifies the name of the terminal type to be set in the	310	This option specifies the name of the terminal type to be set in the
270	TERM environment variable. This terminal type must exist in the	311	TERM environment variable. This terminal type must exist in the
271	termcap(5) database and should have li# and co# entries;	312	termcap(5) database and should have li# and co# entries;
272	resource termName.	313	resource termName.
273		314
274	-e command [arguments]	315	-e command [arguments]
275	Run the command with its command-line arguments in the rxvt window;	316	Run the command with its command-line arguments in the urxvt window;
276	also sets the window title and icon name to be the basename of the	317	also sets the window title and icon name to be the basename of the
277	program being executed if neither -title (-T) nor -n are given	318	program being executed if neither -title (-T) nor -n are given
278	on the command line. If this option is used, it must be the last on	319	on the command line. If this option is used, it must be the last on
279	the command-line. If there is no -e option then the default is to	320	the command-line. If there is no -e option then the default is to
280	run the program specified by the SHELL environment variable or,	321	run the program specified by the SHELL environment variable or,
…		…
282		323
283	Please note that you must specify a program with arguments. If you	324	Please note that you must specify a program with arguments. If you
284	want to run shell commands, you have to specify the shell, like	325	want to run shell commands, you have to specify the shell, like
285	this:	326	this:
286		327
287	rxvt -e sh -c "shell commands"	328	urxvt -e sh -c "shell commands"
288		329
289	-title text	330	-title text
290	Window title (-T still respected); the default title is the basename	331	Window title (-T still respected); the default title is the basename
291	of the program specified after the -e option, if any, otherwise the	332	of the program specified after the -e option, if any, otherwise the
292	application name; resource title.	333	application name; resource title.
…		…
315	Set the font set to use for the X Input Method, see resource imFont	356	Set the font set to use for the X Input Method, see resource imFont
316	for more info.	357	for more info.
317		358
318	-tcw	359	-tcw
319	Change the meaning of triple-click selection with the left mouse	360	Change the meaning of triple-click selection with the left mouse
		361	button. Only effective when the original (non-perl) selection code
320	button. Instead of selecting a full line it will extend the	362	is in-use. Instead of selecting a full line it will extend the
321	selection the end of the logical line only. resource	363	selection the end of the logical line only. resource
322	tripleclickwords.	364	tripleclickwords.
323		365
324	-insecure	366	-insecure
325	Enable "insecure" mode, which currently enables most of the escape	367	Enable "insecure" mode, which currently enables most of the escape
…		…
337	-ssr\|+ssr	379	-ssr\|+ssr
338	Turn on/off secondary screen scroll (default enabled); resource	380	Turn on/off secondary screen scroll (default enabled); resource
339	secondaryScroll.	381	secondaryScroll.
340		382
341	-hold\|+hold	383	-hold\|+hold
342	Turn on/off hold window after exit support. If enabled, rxvt will	384	Turn on/off hold window after exit support. If enabled, urxvt will
343	not immediately destroy its window when the program executed within	385	not immediately destroy its window when the program executed within
344	it exits. Instead, it will wait till it is being killed or closed by	386	it exits. Instead, it will wait till it is being killed or closed by
345	the user; resource hold.	387	the user; resource hold.
346		388
347	-keysym.sym string	389	-keysym.sym string
348	Remap a key symbol. See resource keysym.	390	Remap a key symbol. See resource keysym.
349		391
350	-embed windowid	392	-embed windowid
351	Tells rxvt to embed it's windows into an already-existing window,	393	Tells urxvt to embed its windows into an already-existing window,
352	which enables applications to easily embed a terminal.	394	which enables applications to easily embed a terminal.
353		395
354	Right now, rxvt will first unmap/map the specified window, so it	396	Right now, urxvt will first unmap/map the specified window, so it
355	shouldn't be a top-level window. rxvt will also reconfigure it quite	397	shouldn't be a top-level window. urxvt will also reconfigure it
356	a bit, so don't expect it to keep some specific state. It's best to	398	quite a bit, so don't expect it to keep some specific state. It's
357	create an extra subwindow for rxvt and leave it alone.	399	best to create an extra subwindow for urxvt and leave it alone.
358		400
359	The window will not be destroyed when rxvt exits.	401	The window will not be destroyed when urxvt exits.
360		402
361	It might be useful to know that rxvt will not close file descriptors	403	It might be useful to know that urxvt will not close file
362	passed to it (except for stdin/out/err, of course), so you can use	404	descriptors passed to it (except for stdin/out/err, of course), so
363	file descriptors to communicate with the programs within the	405	you can use file descriptors to communicate with the programs within
364	terminal. This works regardless of wether the "-embed" option was	406	the terminal. This works regardless of whether the "-embed" option
365	used or not.	407	was used or not.
366		408
367	Here is a short Gtk2-perl snippet that illustrates how this option	409	Here is a short Gtk2-perl snippet that illustrates how this option
368	can be used (a longer example is in doc/embed):	410	can be used (a longer example is in doc/embed):
369		411
370	my $rxvt = new Gtk2::Socket;	412	my $rxvt = new Gtk2::Socket;
371	$rxvt->signal_connect_after (realize => sub {	413	$rxvt->signal_connect_after (realize => sub {
372	my $xid = $_[0]->window->get_xid;	414	my $xid = $_[0]->window->get_xid;
373	system "rxvt -embed $xid &";	415	system "urxvt -embed $xid &";
374	});	416	});
375		417
376	-pty-fd file descriptor	418	-pty-fd file descriptor
377	Tells rxvt NOT to execute any commands or create a new pty/tty pair	419	Tells urxvt NOT to execute any commands or create a new pty/tty pair
378	but instead use the given filehandle as the tty master. This is	420	but instead use the given file descriptor as the tty master. This is
379	useful if you want to drive rxvt as a generic terminal emulator	421	useful if you want to drive urxvt as a generic terminal emulator
380	without having to run a program within it.	422	without having to run a program within it.
381		423
382	If this switch is given, rxvt will not create any utmp/wtmp entries	424	If this switch is given, urxvt will not create any utmp/wtmp entries
383	and will not tinker with pty/tty permissions - you have to do that	425	and will not tinker with pty/tty permissions - you have to do that
384	yourself if you want that.	426	yourself if you want that.
385		427
386	As an extremely special case, specifying -1 will completely suppress	428	As an extremely special case, specifying -1 will completely suppress
387	pty/tty operations.	429	pty/tty operations.
…		…
392	use IO::Pty;	434	use IO::Pty;
393	use Fcntl;	435	use Fcntl;
394		436
395	my $pty = new IO::Pty;	437	my $pty = new IO::Pty;
396	fcntl $pty, F_SETFD, 0; # clear close-on-exec	438	fcntl $pty, F_SETFD, 0; # clear close-on-exec
397	system "rxvt -pty-fd " . (fileno $pty) . "&";	439	system "urxvt -pty-fd " . (fileno $pty) . "&";
398	close $pty;	440	close $pty;
399		441
400	# now communicate with rxvt	442	# now communicate with rxvt
401	my $slave = $pty->slave;	443	my $slave = $pty->slave;
402	while (<$slave>) { print $slave "got <$_>\n" }	444	while (<$slave>) { print $slave "got <$_>\n" }
403		445
404	-pe string	446	-pe string
405	Comma-separated list of perl extension scripts to use in this	447	Comma-separated list of perl extension scripts to use (or not to
406	terminal instance. See resource perl-ext.	448	use) in this terminal instance. See resource perl-ext for details.
407		449
408	RESOURCES (available also as long-options)	450	RESOURCES (available also as long-options)
409	Note: `rxvt --help' gives a list of all resources (long options)	451	Note: `urxvt --help' gives a list of all resources (long options)
410	compiled into your version.	452	compiled into your version.
411		453
412	There are two different methods that rxvt can use to get the Xresource
413	data: using the X libraries (Xrm*-functions) or internal Xresources
414	reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
415	XGetDefaults), you can set and change the resources using X11 tools like	454	You can set and change the resources using X11 tools like xrdb. Many
416	xrdb. Many distribution do also load settings from the ~/.Xresources	455	distribution do also load settings from the ~/.Xresources file when X
417	file when X starts. rxvt will consult the following files/resources in	456	starts. urxvt will consult the following files/resources in order, with
418	order, with later settings overwriting earlier ones:	457	later settings overwriting earlier ones:
419		458
420	1. system-wide app-defaults file, either locale-dependent OR global	459	1. system-wide app-defaults file, either locale-dependent OR global
421	2. app-defaults file in $XAPPLRESDIR	460	2. app-defaults file in $XAPPLRESDIR
422	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	461	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423	4. SCREEN_RESOURCES for the current screen	462	4. SCREEN_RESOURCES for the current screen
424	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	463	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
425		464
426	If compiled with internal Xresources support (i.e. rxvt -h lists	465	Note that when reading X resources, urxvt recognizes two class names:
427	.Xdefaults) then rxvt accepts application defaults set in	466	Rxvt and URxvt. The class name Rxvt allows resources common to both
428	XAPPLOADDIR/URxvt (compile-time defined: usually	467	urxvt and the original rxvt to be easily configured, while the class
429	/usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or	468	name URxvt allows resources unique to urxvt, to be shared between
430	~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
431	resources, rxvt recognizes two class names: XTerm and URxvt. The class
432	name Rxvt allows resources common to both rxvt and the original rxvt
433	to be easily configured, while the class name URxvt allows resources
434	unique to rxvt, notably colours and key-handling, to be shared between
435	different rxvt configurations. If no resources are specified, suitable	469	different urxvt configurations. If no resources are specified, suitable
436	defaults will be used. Command-line arguments can be used to override	470	defaults will be used. Command-line arguments can be used to override
437	resource settings. The following resources are allowed:	471	resource settings. The following resources are supported (you might want
		472	to check the urxvtperl(3) manpage for additional settings by perl
		473	extensions not documented here):
		474
		475	depth: bitdepth
		476	Compile xft: Attempt to find a visual with the given bit depth;
		477	option -depth.
438		478
439	geometry: geom	479	geometry: geom
440	Create the window with the specified X window geometry [default	480	Create the window with the specified X window geometry [default
441	80x24]; option -geometry.	481	80x24]; option -geometry.
442		482
…		…
456	1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but	496	1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
457	the actual colour names used are listed in the COLORS AND GRAPHICS	497	the actual colour names used are listed in the COLORS AND GRAPHICS
458	section.	498	section.
459		499
460	Colours higher than 15 cannot be set using resources (yet), but can	500	Colours higher than 15 cannot be set using resources (yet), but can
461	be changed using an escape command (see rxvt(7)).	501	be changed using an escape command (see urxvt(7)).
462		502
463	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm	503	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
464	with 88 colour support). Colours 80-87 are evenly spaces grey steps.	504	with 88 colour support). Colours 80-87 are evenly spaces grey steps.
465		505
466	colorBD: colour	506	colorBD: colour
…		…
474	Use the specified colour to display underlined characters when the	514	Use the specified colour to display underlined characters when the
475	foreground colour is the default.	515	foreground colour is the default.
476		516
477	colorRV: colour	517	colorRV: colour
478	Use the specified colour as the background for reverse video	518	Use the specified colour as the background for reverse video
479	characters.	519	characters when OPTION_HC is disabled (--disable-frills).
480		520
481	underlineColor: colour	521	underlineColor: colour
482	If set, use the specified colour as the colour for the underline	522	If set, use the specified colour as the colour for the underline
483	itself. If unset, use the foreground colour.	523	itself. If unset, use the foreground colour.
484		524
…		…
495	True: simulate reverse video by foreground and background colours;	535	True: simulate reverse video by foreground and background colours;
496	option -rv. False: regular screen colours [default]; option +rv. See	536	option -rv. False: regular screen colours [default]; option +rv. See
497	note in COLORS AND GRAPHICS section.	537	note in COLORS AND GRAPHICS section.
498		538
499	jumpScroll: boolean	539	jumpScroll: boolean
500	True: specify that jump scrolling should be used. When scrolling	540	True: specify that jump scrolling should be used. When receiving
501	quickly, fewer screen updates are performed [default]; option -j.	541	lots of lines, urxvt will only scroll once a whole screen height of
		542	lines has been read, resulting in fewer updates while still
		543	displaying every received line; option -j.
		544
502	False: specify that smooth scrolling should be used; option +j.	545	False: specify that smooth scrolling should be used. urxvt will
		546	force a screen refresh on each new line it received; option +j.
		547
		548	skipScroll: boolean
		549	True: (the default) specify that skip scrolling should be used. When
		550	receiving lots of lines, urxvt will only scroll once in a while
		551	(around 60 times per second), resulting in far fewer updates. This
		552	can result in urxvt not ever displaying some of the lines it
		553	receives; option -ss.
		554
		555	False: specify that everything is to be displayed, even if the
		556	refresh is too fast for the human eye to read anything (or the
		557	monitor to display anything); option +ss.
503		558
504	inheritPixmap: boolean	559	inheritPixmap: boolean
505	True: make the background inherit the parent windows' pixmap, giving	560	True: make the background inherit the parent windows' pixmap, giving
506	artificial transparency. False: do not inherit the parent windows'	561	artificial transparency. False: do not inherit the parent windows'
507	pixmap.	562	pixmap.
508		563
		564	*Please note that transparency of any kind if completely unsupported
		565	by the author. Don't bug him with installation questions!*
		566
509	fading: number	567	fading: number
510	Fade the text by the given percentage when focus is lost; option	568	Fade the text by the given percentage when focus is lost; option
511	-fade.	569	-fade.
512		570
513	fadeColor: colour	571	fadeColor: colour
…		…
518	Tint the transparent background pixmap with the given colour; option	576	Tint the transparent background pixmap with the given colour; option
519	-tint.	577	-tint.
520		578
521	shading: number	579	shading: number
522	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	580	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
523	image in addition to tinting it.	581	image in addition to tinting it; option -sh.
		582
		583	blendType: string
		584	Specify background blending type; option -blt.
		585
		586	blurRadius: number
		587	Apply Gaussian Blurr with the specified radius to the transparent
		588	background image; option -blr.
524		589
525	scrollColor: colour	590	scrollColor: colour
526	Use the specified colour for the scrollbar [default #B2B2B2].	591	Use the specified colour for the scrollbar [default #B2B2B2].
527		592
528	troughColor: colour	593	troughColor: colour
…		…
532	borderColor: colour	597	borderColor: colour
533	The colour of the border around the text area and between the	598	The colour of the border around the text area and between the
534	scrollbar and the text.	599	scrollbar and the text.
535		600
536	backgroundPixmap: file[;geom]	601	backgroundPixmap: file[;geom]
537	Use the specified XPM file (note the `.xpm' extension is optional)	602	Use the specified image file for the background and also optionally
538	for the background and also optionally specify its scaling with a	603	specify its scaling with a geometry string WxH+X+Y, in which "W" /
539	geometry string WxH+X+Y, in which "W" / "H" specify the
540	horizontal/vertical scale (percent) and "X" / "Y" locate the image	604	"H" specify the horizontal/vertical scale (percent), and "X" / "Y"
541	centre (percent). A scale of 0 displays the image with tiling. A	605	locate the image centre (percent). A scale of 0 displays the image
542	scale of 1 displays the image without any scaling. A scale of 2 to 9	606	with tiling. A scale of 1 displays the image without any scaling. A
543	specifies an integer number of images in that direction. No image	607	scale of 2 to 9 specifies an integer number of images in that
544	will be magnified beyond 10 times its original size. The maximum	608	direction. No image will be magnified beyond 10 times its original
545	permitted scale is 1000. [default 0x0+50+50]	609	size. The maximum permitted scale is 1000. Special string of "auto"
546		610	used as a geometry will cause image to be automatically scaled to
547	menu: file[;tag]	611	match window size. If used in conjunction with -tr option -
548	Read in the specified menu file (note the `.menu' extension is	612	specified pixmap will be blended over transparency image using
549	optional) and also optionally specify a starting tag to find. See	613	either alpha-blending, or any other blending type, specified with
550	the reference documentation for details on the syntax for the	614	-blt "type" option. [default 0x0+50+50]
551	menuBar.
552		615
553	path: path	616	path: path
554	Specify the colon-delimited search path for finding files (XPM and	617	Specify the colon-delimited search path for finding background image
555	menus), in addition to the paths specified by the RXVTPATH and PATH	618	files.
556	environment variables.
557		619
558	font: fontlist	620	font: fontlist
559	Select the fonts to be used. This is a comma separated list of font	621	Select the fonts to be used. This is a comma separated list of font
560	names that are used in turn when trying to display Unicode	622	names that are checked in order when trying to find glyphs for
561	characters. The first font defines the cell size for characters;	623	characters. The first font defines the cell size for characters;
562	other fonts might be smaller, but not larger. A reasonable default	624	other fonts might be smaller, but not (in general) larger. A
563	font list is always appended to it; option -fn.	625	(hopefully) reasonable default font list is always appended to it;
		626	option -fn.
564		627
565	Each font can either be a standard X11 core font (XLFD) name, with	628	Each font can either be a standard X11 core font (XLFD) name, with
566	optional prefix "x:" or a Xft font (Compile xft), prefixed with	629	optional prefix "x:" or a Xft font (Compile xft), prefixed with
567	"xft:".	630	"xft:".
568		631
…		…
571	available hint currently is "codeset=codeset-name", and this is only	634	available hint currently is "codeset=codeset-name", and this is only
572	used for Xft fonts.	635	used for Xft fonts.
573		636
574	For example, this font resource	637	For example, this font resource
575		638
576	URxvt*font: 9x15bold,\	639	URxvt.font: 9x15bold,\
577	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	640	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
578	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	641	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
579	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	642	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
580	xft:Code2000:antialias=false	643	xft:Code2000:antialias=false
581		644
…		…
617	normal text font will being used for the given style.	680	normal text font will being used for the given style.
618		681
619	intensityStyles: boolean	682	intensityStyles: boolean
620	When font styles are not enabled, or this option is enabled (True,	683	When font styles are not enabled, or this option is enabled (True,
621	option -is, the default), bold and italic font styles imply high	684	option -is, the default), bold and italic font styles imply high
622	intensity foreground/backround colours. Disabling this option	685	intensity foreground/background colours. Disabling this option
623	(False, option +is) disables this behaviour, the high intensity	686	(False, option +is) disables this behaviour, the high intensity
624	colours are not reachable.	687	colours are not reachable.
625		688
626	selectstyle: mode	689	selectstyle: mode
627	Set mouse selection style to old which is 2.20, oldword which is	690	Set mouse selection style to old which is 2.20, oldword which is
628	xterm style with 2.20 old word selection, or anything else which	691	xterm style with 2.20 old word selection, or anything else which
629	gives xterm style selection.	692	gives xterm style selection. Only effective when the original
		693	(non-perl) selection code is in use.
630		694
631	scrollstyle: mode	695	scrollstyle: mode
632	Set scrollbar style to rxvt, plain, next or xterm. plain is the	696	Set scrollbar style to rxvt, plain, next or xterm. plain is the
633	author's favourite.	697	author's favourite.
634		698
…		…
644		708
645	mapAlert: boolean	709	mapAlert: boolean
646	True: de-iconify (map) on receipt of a bell character. False: no	710	True: de-iconify (map) on receipt of a bell character. False: no
647	de-iconify (map) on receipt of a bell character [default].	711	de-iconify (map) on receipt of a bell character [default].
648		712
		713	urgentOnBell: boolean
		714	True: set the urgency hint for the wm on receipt of a bell
		715	character. False: do not set the urgency hint [default].
		716
649	visualBell: boolean	717	visualBell: boolean
650	True: use visual bell on receipt of a bell character; option -vb.	718	True: use visual bell on receipt of a bell character; option -vb.
651	False: no visual bell [default]; option +vb.	719	False: no visual bell [default]; option +vb.
652		720
653	loginShell: boolean	721	loginShell: boolean
…		…
667		735
668	The string will be interpreted as if typed into the shell as-is.	736	The string will be interpreted as if typed into the shell as-is.
669		737
670	Example:	738	Example:
671		739
672	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	740	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673		741
674	This creates a new file in your home directory with the screen	742	This creates a new file in your home directory with the screen
675	contents everytime you hit "Print".	743	contents every time you hit "Print".
676		744
677	scrollBar: boolean	745	scrollBar: boolean
678	True: enable the scrollbar [default]; option -sb. False: disable the	746	True: enable the scrollbar [default]; option -sb. False: disable the
679	scrollbar; option +sb.	747	scrollbar; option +sb.
680		748
…		…
695	do not scroll to bottom when tty receives output; option +si.	763	do not scroll to bottom when tty receives output; option +si.
696		764
697	scrollWithBuffer: boolean	765	scrollWithBuffer: boolean
698	True: scroll with scrollback buffer when tty receives new lines (and	766	True: scroll with scrollback buffer when tty receives new lines (and
699	scrollTtyOutput is False); option -sw. False: do not scroll with	767	scrollTtyOutput is False); option -sw. False: do not scroll with
700	scrollback buffer when tty recieves new lines; option +sw.	768	scrollback buffer when tty receives new lines; option +sw.
701		769
702	scrollTtyKeypress: boolean	770	scrollTtyKeypress: boolean
703	True: scroll to bottom when a non-special key is pressed. Special	771	True: scroll to bottom when a non-special key is pressed. Special
704	keys are those which are intercepted by rxvt-unicode for special	772	keys are those which are intercepted by rxvt-unicode for special
705	handling and are not passed onto the shell; option -sk. False: do	773	handling and are not passed onto the shell; option -sk. False: do
…		…
730		798
731	termName: termname	799	termName: termname
732	Specifies the terminal type name to be set in the TERM environment	800	Specifies the terminal type name to be set in the TERM environment
733	variable; option -tn.	801	variable; option -tn.
734		802
735	linespace: number	803	lineSpace: number
736	Specifies number of lines (pixel height) to insert between each row	804	Specifies number of lines (pixel height) to insert between each row
737	of the display [default 0]; option -lsp.	805	of the display [default 0]; option -lsp.
738		806
739	meta8: boolean	807	meta8: boolean
740	True: handle Meta (Alt) + keypress to set the 8th bit. False: handle	808	True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
…		…
778	The string to send when the delete key (not the keypad delete key)	846	The string to send when the delete key (not the keypad delete key)
779	is pressed. If unset it will send the sequence traditionally	847	is pressed. If unset it will send the sequence traditionally
780	associated with the Execute key.	848	associated with the Execute key.
781		849
782	cutchars: string	850	cutchars: string
783	The characters used as delimiters for double-click word selection.	851	The characters used as delimiters for double-click word selection
784	The built-in default:	852	(whitespace delimiting is added automatically if resource is given).
		853
		854	When the perl selection extension is in use (the default if compiled
		855	in, see the urxvtperl(3) manpage), a suitable regex using these
		856	characters will be created (if the resource exists, otherwise, no
		857	regex will be created). In this mode, characters outside ISO-8859-1
		858	can be used.
		859
		860	When the selection extension is not used, only ISO-8859-1 characters
		861	can be used. If not specified, the built-in default is used:
785		862
786	BACKSLASH `"'&()*,;<=>?@[]{\|}	863	BACKSLASH `"'&()*,;<=>?@[]{\|}
787		864
788	preeditType: style	865	preeditType: style
789	OverTheSpot, OffTheSpot, Root; option -pt.	866	OverTheSpot, OffTheSpot, Root; option -pt.
…		…
799		876
800	imFont: fontset	877	imFont: fontset
801	Specify the font-set used for XIM styles "OverTheSpot" or	878	Specify the font-set used for XIM styles "OverTheSpot" or
802	"OffTheSpot". It must be a standard X font set (XLFD patterns	879	"OffTheSpot". It must be a standard X font set (XLFD patterns
803	separated by commas), i.e. it's not in the same format as the other	880	separated by commas), i.e. it's not in the same format as the other
804	font lists used in rxvt. The default will be set-up to chose any	881	font lists used in urxvt. The default will be set-up to chose any
805	suitable found found, preferably one or two pixels differing in size	882	suitable found found, preferably one or two pixels differing in size
806	to the base font. option -imfont.	883	to the base font. option -imfont.
807		884
808	tripleclickwords: boolean	885	tripleclickwords: boolean
809	Change the meaning of triple-click selection with the left mouse	886	Change the meaning of triple-click selection with the left mouse
…		…
820	xterm, have these sequences enabled by default, which doesn't make	897	xterm, have these sequences enabled by default, which doesn't make
821	it safer, though).	898	it safer, though).
822		899
823	You can enable them by setting this boolean resource or specifying	900	You can enable them by setting this boolean resource or specifying
824	-insecure as an option. At the moment, this enables display-answer,	901	-insecure as an option. At the moment, this enables display-answer,
825	locale, findfont, icon label and window title requests as well as	902	locale, findfont, icon label and window title requests.
826	dynamic menubar dispatch.
827		903
828	modifier: modifier	904	modifier: modifier
829	Set the key to be interpreted as the Meta key to: alt, meta, hyper,	905	Set the key to be interpreted as the Meta key to: alt, meta, hyper,
830	super, mod1, mod2, mod3, mod4, mod5; option -mod.	906	super, mod1, mod2, mod3, mod4, mod5; option -mod.
831		907
832	answerbackString: string	908	answerbackString: string
833	Specify the reply rxvt-unicode sends to the shell when an ENQ	909	Specify the reply rxvt-unicode sends to the shell when an ENQ
834	(control-E) character is passed through. It may contain escape	910	(control-E) character is passed through. It may contain escape
835	values as described in the entry on keysym following.	911	values as described in the entry on keysym following.
836		912
837	secondaryScreen: bool	913	secondaryScreen: boolean
838	Turn on/off secondary screen (default enabled).	914	Turn on/off secondary screen (default enabled).
839		915
840	secondaryScroll: bool	916	secondaryScroll: boolean
841	Turn on/off secondary screen scroll (default enabled). If the this	917	Turn on/off secondary screen scroll (default enabled). If this
842	option is enabled, scrolls on the secondary screen will change the	918	option is enabled, scrolls on the secondary screen will change the
843	scrollback buffer and switching to/from the secondary screen will	919	scrollback buffer and switching to/from the secondary screen will
844	instead scroll the screen up.	920	instead scroll the screen up.
845		921
846	hold: bool	922	hold: boolean
847	Turn on/off hold window after exit support. If enabled, rxvt will	923	Turn on/off hold window after exit support. If enabled, urxvt will
848	not immediately destroy its window when the program executed within	924	not immediately destroy its window when the program executed within
849	it exits. Instead, it will wait till it is being killed or closed by	925	it exits. Instead, it will wait till it is being killed or closed by
850	the user.	926	the user.
851		927
852	keysym.sym: string	928	keysym.sym: string
…		…
868	omitting the prefix XK_. Alternatively you can specify key by its	944	omitting the prefix XK_. Alternatively you can specify key by its
869	hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms	945	hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms
870	is not performed in an exact manner; however, the closest match is	946	is not performed in an exact manner; however, the closest match is
871	assured.	947	assured.
872		948
873	string may contain escape values ("\a": bell, "\b": backspace,	949	string may contain escape values ("\n": newline, "\000": octal
874	"\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,	950	number), see RESOURCES in "man 7 X" for futher details.
875	"\000": octal number) or verbatim control characters ("^?": delete,
876	"^@": null, "^A" ...) and may be enclosed with double quotes so that
877	it can start or end with whitespace.
878
879	Please note that you need to double the "\" when using
880	"--enable-xgetdefault", as X itself does it's own de-escaping (you
881	can use "\033" instead of "\e" (and so on), which will work with
882	both Xt and rxvt's own processing).
883		951
884	You can define a range of keysyms in one shot by providing a	952	You can define a range of keysyms in one shot by providing a
885	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter	953	string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
886	`/' should be a character not used by the strings.	954	`/' should be a character not used by the strings.
887		955
888	Its usage can be demonstrated by an example:	956	Its usage can be demonstrated by an example:
889		957
890	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	958	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
894	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	962	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
895	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	963	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
896	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	964	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
897		965
898	If string takes the form of "command:STRING", the specified STRING	966	If string takes the form of "command:STRING", the specified STRING
899	is interpreted and executed as rxvt's control sequence. For example	967	is interpreted and executed as urxvt's control sequence. For example
900	the following means "change the current locale to "zh_CN.GBK" when	968	the following means "change the current locale to "zh_CN.GBK" when
901	Control-Meta-c is being pressed":	969	Control-Meta-c is being pressed":
902		970
903	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	971	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
904		972
905	If string takes the form "perl:STRING", then the specified STRING	973	If string takes the form "perl:STRING", then the specified STRING
906	is passed to the "on_keyboard_command" perl handler. See the	974	is passed to the "on_keyboard_command" perl handler. See the
907	rxvtperl(3) manpage. For example, the selection extension (activated	975	urxvtperl(3) manpage. For example, the selection extension
908	via "rxvt -pe selection") listens for "selection:rot13" events:	976	(activated via "urxvt -pe selection") listens for "selection:rot13"
		977	events:
909		978
910	URxvt.keysym.M-C-c: perl:selection:rot13	979	URxvt.keysym.M-C-c: perl:selection:rot13
911		980
912	Due the the large number of modifier combinations, a defined key	981	Due the the large number of modifier combinations, a defined key
913	mapping will match if at at least the specified identifiers are	982	mapping will match if at at least the specified identifiers are
…		…
915	being defined. That means that defining a key map for "a" will	984	being defined. That means that defining a key map for "a" will
916	automatically provide definitions for "Meta-a", "Shift-a" and so on,	985	automatically provide definitions for "Meta-a", "Shift-a" and so on,
917	unless some of those are defined mappings themselves.	986	unless some of those are defined mappings themselves.
918		987
919	Unfortunately, this will override built-in key mappings. For example	988	Unfortunately, this will override built-in key mappings. For example
920	if you overwrite the "Insert" key you will disable rxvt's	989	if you overwrite the "Insert" key you will disable urxvt's
921	"Shift-Insert" mapping. To re-enable that, you can poke "holes" into	990	"Shift-Insert" mapping. To re-enable that, you can poke "holes" into
922	the user-defined keymap using the "builtin:" replacement:	991	the user-defined keymap using the "builtin:" replacement:
923		992
924	URxvt.keysym.Insert: <my insert key sequence>	993	URxvt.keysym.Insert: <my insert key sequence>
925	URxvt.keysym.S-Insert: builtin:	994	URxvt.keysym.S-Insert: builtin:
…		…
933	font-switching at runtime:	1002	font-switching at runtime:
934		1003
935	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1004	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
936	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1005	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
937		1006
938	Other things are possible, e.g. resizing (see rxvt(7) for more	1007	Other things are possible, e.g. resizing (see urxvt(7) for more
939	info):	1008	info):
940		1009
941	URxvt.keysym.M-C-3: command:\033[8;25;80t	1010	URxvt.keysym.M-C-3: command:\033[8;25;80t
942	URxvt.keysym.M-C-4: command:\033[8;48;110t	1011	URxvt.keysym.M-C-4: command:\033[8;48;110t
943		1012
944	perl-ext-common: string	1013	perl-ext-common: string
945	perl-ext: string	1014	perl-ext: string
946	Comma-separated list(s) of perl extension scripts to use in this	1015	Comma-separated list(s) of perl extension scripts (default:
947	terminal instance. Each extension is looked up in the library	1016	"default") to use in this terminal instance; option -pe.
		1017
		1018	Extension names can be prefixed with a "-" sign to prohibit using
		1019	them. This can be useful to selectively disable some extensions
		1020	loaded by default, or specified via the "perl-ext-common" resource.
		1021	For example, "default,-selection" will use all the default extension
		1022	except "selection".
		1023
		1024	Extension names can also be followed by an argument in angle
		1025	brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
		1026	for searchable scrollback to Alt/Meta-s). Mentioning the same
		1027	extension multiple times with different arguments will pass multiple
		1028	arguments to the extension.
		1029
		1030	Each extension is looked up in the library directories, loaded if
948	directories, loaded if necessary, and bound to the current terminal	1031	necessary, and bound to the current terminal instance.
949	instance. If this resource is empty or missing, then the perl	1032
		1033	If both of these resources are the empty string, then the perl
950	interpreter will not be initialized. The idea behind two options is	1034	interpreter will not be initialized. The idea behind two options is
951	that perl-ext-common will be used for extensions that should be	1035	that perl-ext-common will be used for extensions that should be
952	available to all instances, while perl-ext is used for specific	1036	available to all instances, while perl-ext is used for specific
953	instances; option -pe.	1037	instances.
954		1038
955	perl-eval: string	1039	perl-eval: string
956	Perl code to be evaluated when all extensions have been registered.	1040	Perl code to be evaluated when all extensions have been registered.
957	See the rxvtperl(3) manpage.	1041	See the urxvtperl(3) manpage. Due to security reasons, this resource
		1042	will be ignored when running setuid/setgid.
958		1043
959	perl-lib: path	1044	perl-lib: path
960	Colon-separated list of additional directories that hold extension	1045	Colon-separated list of additional directories that hold extension
961	scripts. When looking for extensions specified by the "perl"	1046	scripts. When looking for extensions specified by the "perl"
962	resource, rxvt will first look in these directories and then in	1047	resource, urxvt will first look in these directories and then in
963	/opt/rxvt/lib/urxvt/perl/.	1048	/usr/local/lib/urxvt/perl/. Due to security reasons, this resource
		1049	will be ignored when running setuid/setgid.
964		1050
965	See the rxvtperl(3) manpage.	1051	See the urxvtperl(3) manpage.
		1052
		1053	selection.pattern-idx: perl-regex
		1054	Additional selection patterns, see the urxvtperl(3) manpage for
		1055	details.
		1056
		1057	selection-autotransform.idx: perl-transform
		1058	Selection auto-transform patterns, see the urxvtperl(3) manpage for
		1059	details.
		1060
		1061	searchable-scrollback: keysym
		1062	Sets the hotkey that starts the incremental scrollback buffer search
		1063	(default: "M-s").
		1064
		1065	urlLauncher: string
		1066	Specifies the program to be started with a URL argument. Used by the
		1067	"selection-popup" and "matcher" perl extensions.
		1068
		1069	transient-for: windowid
		1070	Compile frills: Sets the WM_TRANSIENT_FOR property to the given
		1071	window id.
		1072
		1073	override-redirect: boolean
		1074	Compile frills: Sets override-redirect for the terminal window,
		1075	making it almost invisible to window managers; option
		1076	-override-redirect.
		1077
		1078	iso14755_52: boolean
		1079	Turn on/off ISO 14755 5.2 mode (default enabled).
966		1080
967	THE SCROLLBAR	1081	THE SCROLLBAR
968	Lines of text that scroll off the top of the rxvt window (resource:	1082	Lines of text that scroll off the top of the urxvt window (resource:
969	saveLines) and can be scrolled back using the scrollbar or by	1083	saveLines) and can be scrolled back using the scrollbar or by
970	keystrokes. The normal rxvt scrollbar has arrows and its behaviour is	1084	keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
971	fairly intuitive. The xterm-scrollbar is without arrows and its	1085	fairly intuitive. The xterm-scrollbar is without arrows and its
972	behaviour mimics that of xterm	1086	behaviour mimics that of xterm
973		1087
974	Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with	1088	Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
975	Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with	1089	Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
…		…
984	disabled -- on the assumption that we are using a fullscreen	1098	disabled -- on the assumption that we are using a fullscreen
985	application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~	1099	application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
986	(Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the	1100	(Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
987	up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.	1101	up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
988		1102
989	TEXT SELECTION AND INSERTION	1103	THE SELECTION: SELECTING AND PASTING TEXT
990	The behaviour of text selection and insertion mechanism is similar to	1104	The behaviour of text selection and insertion/pasting mechanism is
991	xterm(1).	1105	similar to xterm(1).
992		1106
993	Selection:	1107	Selecting:
994	Left click at the beginning of the region, drag to the end of the	1108	Left click at the beginning of the region, drag to the end of the
995	region and release; Right click to extend the marked region; Left	1109	region and release; Right click to extend the marked region; Left
996	double-click to select a word; Left triple-click to select the	1110	double-click to select a word; Left triple-click to select the
997	entire logical line (which can span multiple screen lines), unless	1111	entire logical line (which can span multiple screen lines), unless
998	modified by resource tripleclickwords.	1112	modified by resource tripleclickwords.
…		…
1001	(Compile: frills) will create a rectangular selection instead of a	1115	(Compile: frills) will create a rectangular selection instead of a
1002	normal one. In this mode, every selected row becomes its own line in	1116	normal one. In this mode, every selected row becomes its own line in
1003	the selection, and trailing whitespace is visually underlined and	1117	the selection, and trailing whitespace is visually underlined and
1004	removed from the selection.	1118	removed from the selection.
1005		1119
1006	Insertion:	1120	Pasting:
1007	Pressing and releasing the Middle mouse button (or Shift-Insert) in	1121	Pressing and releasing the Middle mouse button in an urxvt window
1008	an rxvt window causes the current text selection to be inserted as	1122	causes the value of the PRIMARY selection (or CLIPBOARD with the
1009	if it had been typed on the keyboard.	1123	Meta modifier) to be inserted as if it had been typed on the
		1124	keyboard.
		1125
		1126	Pressing Shift-Insert causes the value of the PRIMARY selection to
		1127	be inserted too.
1010		1128
1011	CHANGING FONTS	1129	CHANGING FONTS
1012	Changing fonts (or font sizes, respectively) via the keypad is not yet	1130	Changing fonts (or font sizes, respectively) via the keypad is not yet
1013	supported in rxvt-unicode. Bug me if you need this.	1131	supported in rxvt-unicode. Bug me if you need this.
1014		1132
1015	You can, however, switch fonts at runtime using escape sequences (and	1133	You can, however, switch fonts at runtime using escape sequences, e.g.:
1016	therefore using the menubar), e.g.:
1017		1134
1018	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1135	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1136
		1137	You can use keyboard shortcuts, too:
		1138
		1139	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1140	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1019		1141
1020	rxvt-unicode will automatically re-apply these fonts to the output so	1142	rxvt-unicode will automatically re-apply these fonts to the output so
1021	far.	1143	far.
1022		1144
1023	ISO 14755 SUPPORT	1145	ISO 14755 SUPPORT
1024	ISO 14755 is a standard for entering and viewing unicode characters and	1146	ISO 14755 is a standard for entering and viewing unicode characters and
1025	character codes using the keyboard. It consists of 4 parts. The first	1147	character codes using the keyboard. It consists of 4 parts. The first
1026	part is available rxvt-unicode has been compiled with "--enable-frills",	1148	part is available if rxvt-unicode has been compiled with
1027	the rest is available when rxvt-unicode was compiled with	1149	"--enable-frills", the rest is available when rxvt-unicode was compiled
1028	"--enable-iso14755".	1150	with "--enable-iso14755".
1029		1151
1030	* 5.1: Basic method	1152	* 5.1: Basic method
1031	This allows you to enter unicode characters using their hexcode.	1153	This allows you to enter unicode characters using their hexcode.
1032		1154
1033	Start by pressing and holding both "Control" and "Shift", then enter	1155	Start by pressing and holding both "Control" and "Shift", then enter
…		…
1047	This mode lets you input characters representing the keycap symbols	1169	This mode lets you input characters representing the keycap symbols
1048	of your keyboard, if representable in the current locale encoding.	1170	of your keyboard, if representable in the current locale encoding.
1049		1171
1050	Start by pressing "Control" and "Shift" together, then releasing	1172	Start by pressing "Control" and "Shift" together, then releasing
1051	them. The next special key (cursor keys, home etc.) you enter will	1173	them. The next special key (cursor keys, home etc.) you enter will
1052	not invoke it's usual function but instead will insert the	1174	not invoke its usual function but instead will insert the
1053	corresponding keycap symbol. The symbol will only be entered when	1175	corresponding keycap symbol. The symbol will only be entered when
1054	the key has been released, otherwise pressing e.g. "Shift" would	1176	the key has been released, otherwise pressing e.g. "Shift" would
1055	enter the symbol for "ISO Level 2 Switch", although your intention	1177	enter the symbol for "ISO Level 2 Switch", although your intention
1056	might have been to enter a reverse tab (Shift-Tab).	1178	might have been to enter a reverse tab (Shift-Tab).
1057		1179
…		…
1078		1200
1079	With respect to conformance, rxvt-unicode is supposed to be compliant to	1201	With respect to conformance, rxvt-unicode is supposed to be compliant to
1080	both scenario A and B of ISO 14755, including part 5.2.	1202	both scenario A and B of ISO 14755, including part 5.2.
1081		1203
1082	LOGIN STAMP	1204	LOGIN STAMP
1083	rxvt tries to write an entry into the utmp(5) file so that it can be	1205	urxvt tries to write an entry into the utmp(5) file so that it can be
1084	seen via the who(1) command, and can accept messages. To allow this	1206	seen via the who(1) command, and can accept messages. To allow this
1085	feature, rxvt may need to be installed setuid root on some systems or	1207	feature, urxvt may need to be installed setuid root on some systems or
1086	setgid to root or to some other group on others.	1208	setgid to root or to some other group on others.
1087		1209
1088	COLORS AND GRAPHICS	1210	COLORS AND GRAPHICS
1089	In addition to the default foreground and background colours, rxvt can	1211	In addition to the default foreground and background colours, urxvt can
1090	display up to 16 colours (8 ANSI colours plus high-intensity bold/blink	1212	display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1091	versions of the same). Here is a list of the colours with their rgb.txt	1213	versions of the same). Here is a list of the colours with their names.
1092	names.
1093		1214
1094	color0 (black) = Black	1215	color0 (black) = Black
1095	color1 (red) = Red3	1216	color1 (red) = Red3
1096	color2 (green) = Green3	1217	color2 (green) = Green3
1097	color3 (yellow) = Yellow3	1218	color3 (yellow) = Yellow3
…		…
1113	It is also possible to specify the colour values of foreground,	1234	It is also possible to specify the colour values of foreground,
1114	background, cursorColor, cursorColor2, colorBD, colorUL as a number	1235	background, cursorColor, cursorColor2, colorBD, colorUL as a number
1115	0-15, as a convenient shorthand to reference the colour name of	1236	0-15, as a convenient shorthand to reference the colour name of
1116	color0-color15.	1237	color0-color15.
1117		1238
		1239	In addition to the colours defined above, urxvt offers an additional 72
		1240	colours. The first 64 of those (with indices 16 to 79) consist of a
		1241	444 RGB colour cube (i.e. index = r 16 + g * 4 + b + 16*), followed
		1242	by 8 additional shades of gray (with indices 80 to 87).
		1243
		1244	Together, all those colours implement the 88 colour xterm colours. Only
		1245	the first 16 can be changed using resources currently, the rest can only
		1246	be changed via command sequences ("escape codes").
		1247
1118	Note that -rv ("reverseVideo: True") simulates reverse video by always	1248	Note that -rv ("reverseVideo: True") simulates reverse video by always
1119	swapping the foreground/background colours. This is in contrast to	1249	swapping the foreground/background colours. This is in contrast to
1120	xterm(1) where the colours are only swapped if they have not otherwise	1250	xterm(1) where the colours are only swapped if they have not otherwise
1121	been specified. For example,	1251	been specified. For example,
1122		1252
1123	rxvt -fg Black -bg White -rv	1253	urxvt -fg Black -bg White -rv
1124	would yield White on Black, while on xterm(1) it would yield Black	1254	would yield White on Black, while on xterm(1) it would yield Black
1125	on White.	1255	on White.
1126		1256
		1257	ALPHA CHANNEL SUPPORT
		1258	If Xft support has been compiled in and as long as Xft/Xrender/X don't
		1259	get their act together, rxvt-unicode will support
		1260	"rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
		1261	digits/component) colour specifications, in addition to the ones
		1262	provided by X, where the additional A component specifies opacity
		1263	(alpha) values. The minimum value of 0 is completely transparent). You
		1264	can also prefix any color with "[percent]", where "percent" is a decimal
		1265	percentage (0-100) that specifies the opacity of the color, where 0 is
		1266	completely transparent and 100 is completelxy opaque.
		1267
		1268	You probably need to specify "-depth 32", too, and have the luck that
		1269	your X-server uses ARGB pixel layout, as X is far from just supporting
		1270	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1271
		1272	For example, the following selects an almost completely transparent red
		1273	background, and an almost opaque pink foreground:
		1274
		1275	urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1276
		1277	*Please note that transparency of any kind if completely unsupported by
		1278	the author. Don't bug him with installation questions!*
		1279
1127	ENVIRONMENT	1280	ENVIRONMENT
1128	rxvt sets and/or uses the following environment variables:	1281	urxvt sets and/or uses the following environment variables:
1129		1282
1130	TERM	1283	TERM
1131	Normally set to "rxvt-unicode", unless overwritten at configure	1284	Normally set to "rxvt-unicode", unless overwritten at configure
1132	time, via resources or on the commandline.	1285	time, via resources or on the command line.
1133		1286
1134	COLORTERM	1287	COLORTERM
1135	Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled	1288	Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1136	with XPM support, and optionally with the added extension "-mono" to	1289	with background image support, and optionally with the added
1137	indicate that rxvt-unicode runs on a monochrome screen.	1290	extension "-mono" to indicate that rxvt-unicode runs on a monochrome
		1291	screen.
1138		1292
1139	COLORFGBG	1293	COLORFGBG
1140	Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is	1294	Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1141	the colour code used as default foreground/text colour (or the	1295	the colour code used as default foreground/text colour (or the
1142	string "default" to indicate that the default-colour escape sequence	1296	string "default" to indicate that the default-colour escape sequence
1143	is to be used), "bg" is the colour code used as default background	1297	is to be used), "bg" is the colour code used as default background
1144	colour (or the string "default"), and "xpm" is the string "default"	1298	colour (or the string "default"), and "xpm" is the string "default"
1145	if rxvt was compiled with XPM support. Libraries like "ncurses" and	1299	if urxvt was compiled with background image support. Libraries like
1146	"slang" can (and do) use this information to optimize screen output.	1300	"ncurses" and "slang" can (and do) use this information to optimize
		1301	screen output.
1147		1302
1148	WINDOWID	1303	WINDOWID
1149	Set to the (decimal) X Window ID of the rxvt window (the toplevel	1304	Set to the (decimal) X Window ID of the urxvt window (the toplevel
1150	window, which usually has subwindows for the scrollbar, the terminal	1305	window, which usually has subwindows for the scrollbar, the terminal
1151	window and so on).	1306	window and so on).
1152		1307
1153	TERMINFO	1308	TERMINFO
1154	Set to the terminfo directory iff rxvt was configured with	1309	Set to the terminfo directory iff urxvt was configured with
1155	"--with-terminfo=PATH".	1310	"--with-terminfo=PATH".
1156		1311
1157	DISPLAY	1312	DISPLAY
1158	Used by rxvt to connect to the display and set to the correct	1313	Used by urxvt to connect to the display and set to the correct
1159	display in it's child processes.	1314	display in its child processes.
1160		1315
1161	SHELL	1316	SHELL
1162	The shell to be used for command execution, defaults to "/bin/sh".	1317	The shell to be used for command execution, defaults to "/bin/sh".
1163		1318
1164	RXVTPATH
1165	The path where rxvt looks for support files such as menu and xpm
1166	files.
1167
1168	PATH
1169	Used in the same way as "RXVTPATH".
1170
1171	RXVT_SOCKET	1319	RXVT_SOCKET
1172	The unix domain socket path used by rxvtc(1) and rxvtd(1).	1320	The unix domain socket path used by urxvtc(1) and urxvtd(1).
1173		1321
1174	Default $HOME/.rxvt-unicode-<nodename.	1322	Default $HOME/.rxvt-unicode-<nodename.
1175		1323
1176	HOME	1324	HOME
1177	Used to locate the default directory for the unix domain socket for	1325	Used to locate the default directory for the unix domain socket for
…		…
1181	XAPPLRESDIR	1329	XAPPLRESDIR
1182	Directory where various X resource files are being located.	1330	Directory where various X resource files are being located.
1183		1331
1184	XENVIRONMENT	1332	XENVIRONMENT
1185	If set and accessible, gives the name of a X resource file to be	1333	If set and accessible, gives the name of a X resource file to be
1186	loaded by rxvt.	1334	loaded by urxvt.
1187		1335
1188	FILES	1336	FILES
1189	/usr/lib/X11/rgb.txt	1337	/usr/lib/X11/rgb.txt
1190	Color names.	1338	Color names.
1191		1339
1192	SEE ALSO	1340	SEE ALSO
1193	rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),	1341	urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1194	tty(4), utmp(5)	1342	pty(4), tty(4), utmp(5)
1195		1343
1196	CURRENT PROJECT COORDINATOR	1344	CURRENT PROJECT COORDINATOR
1197	Project Coordinator	1345	Project Coordinator
1198	Marc A. Lehmann <rxvt-unicode@schmorp.de>	1346	Marc A. Lehmann <rxvt-unicode@schmorp.de>
1199		1347
1200	<http://software.schmorp.de/#rxvt-unicode>	1348	<http://software.schmorp.de/pkg/rxvt-unicode.html>
1201		1349
1202	AUTHORS	1350	AUTHORS
1203	John Bovey	1351	John Bovey
1204	University of Kent, 1992, wrote the original Xvt.	1352	University of Kent, 1992, wrote the original Xvt.
1205		1353
…		…
1216		1364
1217	Oezguer Kesim <kesim@math.fu-berlin.de>	1365	Oezguer Kesim <kesim@math.fu-berlin.de>
1218	Project Coordinator (changes.txt 2.21a to 2.4.5)	1366	Project Coordinator (changes.txt 2.21a to 2.4.5)
1219		1367
1220	Geoff Wing <gcw@pobox.com>	1368	Geoff Wing <gcw@pobox.com>
1221	Rewrote screen display and text selection routines. Project	1369	Rewrote screen display and text selection routines.
		1370
1222	Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1371	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1223		1372
1224	Marc Alexander Lehmann <rxvt-unicode@schmorp.de>	1373	Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1225	Forked rxvt-unicode, rewrote most of the display code and internal	1374	Forked rxvt-unicode, unicode support, rewrote almost all the code,
1226	character handling to store text in unicode, improve xterm	1375	perl extension, random hacks, numerous bugfixes and extensions.
1227	compatibility and apply numerous other bugfixes and extensions.
1228		1376
1229	Project Coordinator (Changes 1.0 -)	1377	Project Coordinator (Changes 1.0 -)
1230		1378
		1379	Emanuele Giaquinta <e.giaquinta@glauco.it>
		1380	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1381

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.37 by root, Sat Jan 7 04:19:43 2006 UTC vs. Revision 1.69 by root, Sat Oct 27 12:09:02 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.37 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.69 by root, Sat Oct 27 12:09:02 2007 UTC