ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.229 by root, Sun Apr 27 20:26:28 2014 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<frills>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
97		115
98	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
99		117
100	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
101		119
…		…
103		121
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	122	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		123
106	=item B<-j>|B<+j>	124	=item B<-j>|B<+j>
107		125
108	Turn on/off jump scrolling; resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		127
110	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>	128	=item B<-ss>|B<+ss>
111		129
112	Turn on/off inheriting parent window's pixmap. Alternative form is	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.
114		131
115	=item B<-fade> I<number>	132	=item B<-fade> I<number>
116		133
117	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	136	colour; resource B<fading>.
120		137
121	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
122		139
123	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
125		142
126	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
127		144
128	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	is used by many window managers, taskbars and pagers to represent the
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
131	used to brighten or darken the image in addition to tinting it; resource
132	I<tintColor>. Example:
133
134	@@RXVT_NAME@@ -tr -tint blue -sh 40
135
136	=item B<-sh>
137
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be
140	specified, too, e.g. C<-tint white>).
141		148
142	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
143		150
144	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
145		152
146	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
147		154
148	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
149
150	=item B<-pixmap> I<file[;geom]>
151
152	Compile I<XPM>: Specify XPM file for the background and also optionally
153	specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.
156		156
157	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
158		158
159	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
160		160
…		…
172	resource B<borderColor>.	172	resource B<borderColor>.
173		173
174	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
175		175
176	Select the fonts to be used. This is a comma separated list of font names	176	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	177	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	180	font list is always appended to it. See resource B<font> for more details.
181		181
182	In short, to specify an X11 core font, just specify it's name or prefix it	182	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	184	e.g.:
185		185
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	206	for details.
207		207
208	=item B<-is>|B<+is>	208	=item B<-is>|B<+is>
209		209
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
212	details.	212	details.
213		213
214	=item B<-name> I<name>	214	=item B<-name> I<name>
215		215
…		…
233		233
234	=item B<-sb>|B<+sb>	234	=item B<-sb>|B<+sb>
235		235
236	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
237		237
		238	=item B<-sr>|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
238	=item B<-si>|B<+si>	247	=item B<-si>|B<+si>
239		248
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
242		251
…		…
248	=item B<-sw>|B<+sw>	257	=item B<-sw>|B<+sw>
249		258
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
253
254	=item B<-sr>|B<+sr>
255
256	Put scrollbar on right/left; resource B<scrollBar_right>.
257
258	=item B<-st>|B<+st>
259
260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261	resource B<scrollBar_floating>.
262		262
263	=item B<-ptab>|B<+ptab>	263	=item B<-ptab>|B<+ptab>
264		264
265	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
270		270
271	=item B<-bc>|B<+bc>	271	=item B<-bc>|B<+bc>
272		272
273	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
274		274
		275	=item B<-uc>|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
275	=item B<-iconic>	279	=item B<-iconic>
276		280
277	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
278	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
279		283
…		…
295		299
296	=item B<-bl>	300	=item B<-bl>
297		301
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	303	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
		306
		307	=item B<-override-redirect>
		308
		309	Compile I<frills>: Sets override-redirect on the window; resource
		310	B<override-redirect>.
301		311
302	=item B<-sbg>	312	=item B<-sbg>
303		313
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	314	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	315	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		318
309	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
310		320
311	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	323	B<lineSpace>.
		324
		325	=item B<-letsp> I<number>
		326
		327	Compile I<frills>: Amount to adjust the computed character width by
		328	to control overall letter spacing. Negative values will tighten up the
		329	letter spacing, positive values will space letters out more. Useful to
		330	work around odd font metrics; resource B<letterSpace>.
314		331
315	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
316		333
317	This option specifies the name of the terminal type to be set in the	334	This option specifies the name of the terminal type to be set in the
318	B<TERM> environment variable. This terminal type must exist in the	335	B<TERM> environment variable. This terminal type must exist in the
…		…
372	for more info.	389	for more info.
373		390
374	=item B<-tcw>	391	=item B<-tcw>
375		392
376	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
		394	button. Only effective when the original (non-perl) selection code is
377	button. Instead of selecting a full line it will extend the selection the	395	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
379		397
380	=item B<-insecure>	398	=item B<-insecure>
381		399
382	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	423	will not immediately destroy its window when the program executed within
406	it exits. Instead, it will wait till it is being killed or closed by the	424	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	425	user; resource B<hold>.
408		426
		427	=item B<-cd> I<path>
		428
		429	Sets the working directory for the shell (or the command specified via
		430	B<-e>). The I<path> must be an absolute path and it must exist for
		431	@@RXVT_NAME@@ to start; resource B<chdir>.
		432
		433	=item B<-xrm> I<string>
		434
		435	Works like the X Toolkit option of the same name, by adding the I<string>
		436	as if it were specified in a resource file. Resource values specified this
		437	way take precedence over all other resource specifications.
		438
		439	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		440	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		441	options can be specified as long-options on the commandline, so use
		442	of B<-xrm> is mostly limited to cases where you want to specify other
		443	resources (e.g. for input methods) or for compatibility with other
		444	programs.
		445
409	=item B<-keysym.>I<sym> I<string>	446	=item B<-keysym.>I<sym> I<string>
410		447
411	Remap a key symbol. See resource B<keysym>.	448	Remap a key symbol. See resource B<keysym>.
412		449
413	=item B<-embed> I<windowid>	450	=item B<-embed> I<windowid>
414		451
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	452	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	453	which enables applications to easily embed a terminal.
417		454
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	455	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	456	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	457	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
423	The window will not be destroyed when @@RXVT_NAME@@ exits.	460	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		461
425	It might be useful to know that @@RXVT_NAME@@ will not close file	462	It might be useful to know that @@RXVT_NAME@@ will not close file
426	descriptors passed to it (except for stdin/out/err, of course), so you	463	descriptors passed to it (except for stdin/out/err, of course), so you
427	can use file descriptors to communicate with the programs within the	464	can use file descriptors to communicate with the programs within the
428	terminal. This works regardless of wether the C<-embed> option was used or	465	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	466	not.
430		467
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	468	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	469	used (a longer example is in F<doc/embed>):
433		470
…		…
435	$rxvt->signal_connect_after (realize => sub {	472	$rxvt->signal_connect_after (realize => sub {
436	my $xid = $_[0]->window->get_xid;	473	my $xid = $_[0]->window->get_xid;
437	system "@@RXVT_NAME@@ -embed $xid &";	474	system "@@RXVT_NAME@@ -embed $xid &";
438	});	475	});
439		476
440	=item B<-pty-fd> I<fileno>	477	=item B<-pty-fd> I<file descriptor>
441		478
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	479	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	480	pair but instead use the given file descriptor as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	481	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	482	without having to run a program within it.
446		483
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	484	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	485	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	486	yourself if you want that.
		487
		488	As an extremely special case, specifying C<-1> will completely suppress
		489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
450		491
451	Here is a example in perl that illustrates how this option can be used (a	492	Here is a example in perl that illustrates how this option can be used (a
452	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
453		494
454	use IO::Pty;	495	use IO::Pty;
…		…
463	my $slave = $pty->slave;	504	my $slave = $pty->slave;
464	while (<$slave>) { print $slave "got <$_>\n" }	505	while (<$slave>) { print $slave "got <$_>\n" }
465		506
466	=item B<-pe> I<string>	507	=item B<-pe> I<string>
467		508
468	Colon-separated list of perl extension scripts to use in this terminal	509	Comma-separated list of perl extension scripts to use (or not to use) in
469	instance. See resource B<perl-ext>.	510	this terminal instance. See resource B<perl-ext> for details.
470		511
471	=back	512	=back
472		513
473	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
474		515
475	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
477		519
478	There are two different methods that @@RXVT_NAME@@ can use to get the	520	You can set and change the resources using X11 tools like B<xrdb>. Many
479	Xresource data: using the X libraries (Xrm*-functions) or internal	521	distribution do also load settings from the B<~/.Xresources> file when X
480	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
481	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	523	with later settings overwriting earlier ones:
482	resources using X11 tools like B<xrdb>. Many distribution do also load
483	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484	will consult the following files/resources in order, with later settings
485	overwriting earlier ones:
486		524
487	1. system-wide app-defaults file, either locale-dependent OR global
488	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
489	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
490	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
491	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		530	6. resources specified via -xrm on the commandline
492		531
493	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
494	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
495	set in XAPPLOADDIR/URxvt (compile-time defined: usually
496	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
497	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
498	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
499	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
500	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
501	easily configured, while the class name B<URxvt> allows resources	535	configured, while the class name B<URxvt> allows resources unique to
502	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	536	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
503	shared between different B<@@RXVT_NAME@@> configurations. If no	537	configurations. If no resources are specified, suitable defaults will
504	resources are specified, suitable defaults will be used. Command-line	538	be used. Command-line arguments can be used to override resource
505	arguments can be used to override resource settings. The following	539	settings. The following resources are supported (you might want to
506	resources are allowed:	540	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		541	extensions not documented here):
507		542
508	=over 4	543	=over 4
		544
		545	=item B<depth:> I<bitdepth>
		546
		547	Compile I<xft>: Attempt to find a visual with the given bit depth;
		548	option B<-depth>.
		549
		550	=item B<buffered:> I<boolean>
		551
		552	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		553	On some card/driver combination enabling it slightly decreases
		554	performance, on most it greatly helps it. The slowdown is small, so it
		555	should normally be enabled.
509		556
510	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
511		558
512	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
513	option B<-geometry>.	560	option B<-geometry>.
…		…
527	Use the specified colour for the colour value I<n>, where 0-7	574	Use the specified colour for the colour value I<n>, where 0-7
528	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
529	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
530	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	577	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
531	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	578	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
532	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
533		580
534	Colours higher than 15 cannot be set using resources (yet), but can be	581	Colours higher than 15 cannot be set using resources (yet), but can be
535	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
536		583
537	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	584	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
548	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
549		596
550	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
551	foreground colour is the default.	598	foreground colour is the default.
552		599
553	=item B<colorRV:> I<colour>
554
555	Use the specified colour as the background for reverse video
556	characters.
557
558	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
559		601
560	If set, use the specified colour as the colour for the underline	602	If set, use the specified colour as the colour for the underline
561	itself. If unset, use the foreground colour.	603	itself. If unset, use the foreground colour.
		604
		605	=item B<highlightColor:> I<colour>
		606
		607	If set, use the specified colour as the background for highlighted
		608	characters. If unset, use reverse video.
		609
		610	=item B<highlightTextColor:> I<colour>
		611
		612	If set and highlightColor is set, use the specified colour as the
		613	foreground for highlighted characters.
562		614
563	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
564		616
565	Use the specified colour for the cursor. The default is to use the	617	Use the specified colour for the cursor. The default is to use the
566	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
573		625
574	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
575		627
576	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
577	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
578	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
579		631
580	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
581		633
582	B<True>: specify that jump scrolling should be used. When scrolling	634	B<True>: specify that jump scrolling should be used. When receiving lots
583	quickly, fewer screen updates are performed [default]; option B<-j>.	635	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		636	has been read, resulting in fewer updates while still displaying every
		637	received line; option B<-j>.
		638
584	B<False>: specify that smooth scrolling should be used; option B<+j>.	639	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		640	force a screen refresh on each new line it received; option B<+j>.
585		641
586	=item B<inheritPixmap:> I<boolean>	642	=item B<skipScroll:> I<boolean>
587		643
588	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: (the default) specify that skip scrolling should be used. When
589	artificial transparency. B<False>: do not inherit the parent windows'	645	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590	pixmap.	646	(around 60 times per second), resulting in far fewer updates. This can
		647	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		648	option B<-ss>.
		649
		650	B<False>: specify that everything is to be displayed, even
		651	if the refresh is too fast for the human eye to read anything (or the
		652	monitor to display anything); option B<+ss>.
591		653
592	=item B<fading:> I<number>	654	=item B<fading:> I<number>
593		655
594	Fade the text by the given percentage when focus is lost; option B<-fade>.	656	Fade the text by the given percentage when focus is lost; option B<-fade>.
595		657
596	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
597		659
598	Fade to this colour, when fading is used (see B<fading:>). The default	660	Fade to this colour, when fading is used (see B<fading:>). The default
599	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
600		662
601	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
602		664
603	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
604	B<-tint>.
605
606	=item B<shading:> I<number>
607
608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
609	image in addition to tinting it.
610		666
611	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
612		668
613	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
614		670
…		…
620	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
621		677
622	The colour of the border around the text area and between the scrollbar	678	The colour of the border around the text area and between the scrollbar
623	and the text.	679	and the text.
624		680
625	=item B<backgroundPixmap:> I<file[;geom]>
626
627	Use the specified XPM file (note the `.xpm' extension is optional) for
628	the background and also optionally specify its scaling with a geometry
629	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
630	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
631	centre (percent). A scale of 0 displays the image with tiling. A scale
632	of 1 displays the image without any scaling. A scale of 2 to 9
633	specifies an integer number of images in that direction. No image will
634	be magnified beyond 10 times its original size. The maximum permitted
635	scale is 1000. [default 0x0+50+50]
636
637	=item B<menu:> I<file[;tag]>
638
639	Read in the specified menu file (note the `.menu' extension is
640	optional) and also optionally specify a starting tag to find. See the
641	reference documentation for details on the syntax for the menuBar.
642
643	=item B<path:> I<path>
644
645	Specify the colon-delimited search path for finding files (XPM and
646	menus), in addition to the paths specified by the B<RXVTPATH> and
647	B<PATH> environment variables.
648
649	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
650		682
651	Select the fonts to be used. This is a comma separated list of font	683	Select the fonts to be used. This is a comma separated list of font names
652	names that are used in turn when trying to display Unicode characters.	684	that are checked in order when trying to find glyphs for characters. The
653	The first font defines the cell size for characters; other fonts might	685	first font defines the cell size for characters; other fonts might be
654	be smaller, but not larger. A reasonable default font list is always	686	smaller, but not (in general) larger. A (hopefully) reasonable default
655	appended to it; option B<-fn>.	687	font list is always appended to it; option B<-fn>.
656		688
657	Each font can either be a standard X11 core font (XLFD) name, with	689	Each font can either be a standard X11 core font (XLFD) name, with
658	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	690	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
659		691
660	In addition, each font can be prefixed with additional hints and	692	In addition, each font can be prefixed with additional hints and
…		…
662	hint currently is C<codeset=codeset-name>, and this is only used for Xft	694	hint currently is C<codeset=codeset-name>, and this is only used for Xft
663	fonts.	695	fonts.
664		696
665	For example, this font resource	697	For example, this font resource
666		698
667	URxvt*font: 9x15bold,\	699	URxvt.font: 9x15bold,\
668	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	700	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
669	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	701	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
670	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	702	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
671	xft:Code2000:antialias=false	703	xft:Code2000:antialias=false
672		704
…		…
675	it is named first) and thus defines the character cell grid to be 9 pixels	707	it is named first) and thus defines the character cell grid to be 9 pixels
676	wide and 15 pixels high.	708	wide and 15 pixels high.
677		709
678	The second font is just used to add additional unicode characters not in	710	The second font is just used to add additional unicode characters not in
679	the base font, likewise the third, which is unfortunately non-bold, but	711	the base font, likewise the third, which is unfortunately non-bold, but
680	the bold version of the font does contain less characters, so this is a	712	the bold version of the font does contain fewer characters, so this is a
681	useful supplement.	713	useful supplement.
682		714
683	The third font is an Xft font with aliasing turned off, and the characters	715	The third font is an Xft font with aliasing turned off, and the characters
684	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	716	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
685	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
709	text font will being used for the given style.	741	text font will being used for the given style.
710		742
711	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
712		744
713	When font styles are not enabled, or this option is enabled (B<True>,	745	When font styles are not enabled, or this option is enabled (B<True>,
714	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
715	intensity foreground/backround colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
716	option B<+is>) disables this behaviour, the high intensity colours are not	748	option B<+is>) disables this behaviour, the high intensity colours are not
717	reachable.	749	reachable.
718
719	=item B<selectstyle:> I<mode>
720
721	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
722	xterm style with 2.20 old word selection, or anything else which gives
723	xterm style selection.
724
725	=item B<scrollstyle:> I<mode>
726
727	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
728	the author's favourite.
729		750
730	=item B<title:> I<string>	751	=item B<title:> I<string>
731		752
732	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
733	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
…		…
742	=item B<mapAlert:> I<boolean>	763	=item B<mapAlert:> I<boolean>
743		764
744	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	765	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
745	de-iconify (map) on receipt of a bell character [default].	766	de-iconify (map) on receipt of a bell character [default].
746		767
		768	=item B<urgentOnBell:> I<boolean>
		769
		770	B<True>: set the urgency hint for the wm on receipt of a bell character.
		771	B<False>: do not set the urgency hint [default].
		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
747	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
748		776
749	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	777	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
750	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
751		779
…		…
769		797
770	The string will be interpreted as if typed into the shell as-is.	798	The string will be interpreted as if typed into the shell as-is.
771		799
772	Example:	800	Example:
773		801
774	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775		803
776	This creates a new file in your home directory with the screen contents	804	This creates a new file in your home directory with the screen contents
777	everytime you hit C<Print>.	805	every time you hit C<Print>.
		806
		807	=item B<scrollstyle:> I<mode>
		808
		809	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		810	the author's favourite.
		811
		812	=item B<thickness:> I<number>
		813
		814	Set the scrollbar width in pixels.
778		815
779	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
780		817
781	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
782	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
…		…
802	B<False>: do not scroll to bottom when tty receives output; option	839	B<False>: do not scroll to bottom when tty receives output; option
803	B<+si>.	840	B<+si>.
804		841
805	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
806		843
807	B<True>: scroll with scrollback buffer when tty receives new lines (and	844	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
808	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	845	try to show the same lines) and B<scrollTtyOutput> is False; option
809	with scrollback buffer when tty recieves new lines; option B<+sw>.	846	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		847	new lines; option B<+sw>.
810		848
811	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
812		850
813	B<True>: scroll to bottom when a non-special key is pressed. Special keys	851	B<True>: scroll to bottom when a non-special key is pressed. Special keys
814	are those which are intercepted by rxvt-unicode for special handling and	852	are those which are intercepted by rxvt-unicode for special handling and
…		…
845	=item B<termName:> I<termname>	883	=item B<termName:> I<termname>
846		884
847	Specifies the terminal type name to be set in the B<TERM> environment	885	Specifies the terminal type name to be set in the B<TERM> environment
848	variable; option B<-tn>.	886	variable; option B<-tn>.
849		887
850	=item B<linespace:> I<number>	888	=item B<lineSpace:> I<number>
851		889
852	Specifies number of lines (pixel height) to insert between each row of	890	Specifies number of lines (pixel height) to insert between each row of
853	the display [default 0]; option B<-lsp>.	891	the display [default 0]; option B<-lsp>.
854		892
855	=item B<meta8:> I<boolean>	893	=item B<meta8:> I<boolean>
…		…
869		907
870	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
871		909
872	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	910	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
873	option B<-bc>.	911	option B<-bc>.
		912
		913	=item B<cursorUnderline:> I<boolean>
		914
		915	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		916	option B<-uc>.
874		917
875	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
876		919
877	B<True>: blank the pointer when a key is pressed or after a set number	920	B<True>: blank the pointer when a key is pressed or after a set number
878	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
…		…
892	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
893		936
894	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
895		938
896	The string to send when the backspace key is pressed. If set to B<DEC>	939	The string to send when the backspace key is pressed. If set to B<DEC>
897	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	940	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
898	(code 8) - which can be reversed with the appropriate DEC private mode	941	(code 8) - which can be reversed with the appropriate DEC private mode
899	escape sequence.	942	escape sequence.
900		943
901	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
902		945
…		…
904	pressed. If unset it will send the sequence traditionally associated	947	pressed. If unset it will send the sequence traditionally associated
905	with the B<Execute> key.	948	with the B<Execute> key.
906		949
907	=item B<cutchars:> I<string>	950	=item B<cutchars:> I<string>
908		951
909	The characters used as delimiters for double-click word selection. The	952	The characters used as delimiters for double-click word selection
910	built-in default:	953	(whitespace delimiting is added automatically if resource is given).
911		954
		955	When the perl selection extension is in use (the default if compiled
		956	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		957	characters will be created (if the resource exists, otherwise, no regex
		958	will be created). In this mode, characters outside ISO-8859-1 can be used.
		959
		960	When the selection extension is not used, only ISO-8859-1 characters can
		961	be used. If not specified, the built-in default is used:
		962
912	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	963	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
913		964
914	=item B<preeditType:> I<style>	965	=item B<preeditType:> I<style>
915		966
916	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
917		968
…		…
951	default. (Note that many other terminals, including xterm, have these	1002	default. (Note that many other terminals, including xterm, have these
952	sequences enabled by default, which doesn't make it safer, though).	1003	sequences enabled by default, which doesn't make it safer, though).
953		1004
954	You can enable them by setting this boolean resource or specifying	1005	You can enable them by setting this boolean resource or specifying
955	B<-insecure> as an option. At the moment, this enables display-answer,	1006	B<-insecure> as an option. At the moment, this enables display-answer,
956	locale, findfont, icon label and window title requests as well as dynamic	1007	locale, findfont, icon label and window title requests.
957	menubar dispatch.
958		1008
959	=item B<modifier:> I<modifier>	1009	=item B<modifier:> I<modifier>
960		1010
961	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1011	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
962	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1012	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
966		1016
967	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1017	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
968	character is passed through. It may contain escape values as described	1018	character is passed through. It may contain escape values as described
969	in the entry on B<keysym> following.	1019	in the entry on B<keysym> following.
970		1020
971	=item B<secondaryScreen:> I<bool>	1021	=item B<secondaryScreen:> I<boolean>
972		1022
973	Turn on/off secondary screen (default enabled).	1023	Turn on/off secondary screen (default enabled).
974		1024
975	=item B<secondaryScroll:> I<bool>	1025	=item B<secondaryScroll:> I<boolean>
976		1026
977	Turn on/off secondary screen scroll (default enabled). If the this	1027	Turn on/off secondary screen scroll (default enabled). If this
978	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
979	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
980	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
981		1031
982	=item B<hold>: I<bool>	1032	=item B<hold>: I<boolean>
983		1033
984	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1034	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
986	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
987	user.	1037	user.
988		1038
		1039	=item B<chdir>: I<path>
		1040
		1041	Sets the working directory for the shell (or the command specified via
		1042	B<-e>). The I<path> must be an absolute path and it must exist for
		1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1044	directory will be used; option B<-cd>.
		1045
989	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<action>
990		1047
991	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
992	intervening resource name B<keysym.> cannot be omitted.	1049	resource name B<keysym.> cannot be omitted.
993		1050
994	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1051	Using this resource, you can map key combinations such as
995	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1052	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
996	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1053	string than would normally result from that combination, making the
997	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1054	terminal scroll up or down the way you want it, or any other thing an
998	B<2>, B<3>, B<4>, B<5>.	1055	extension might provide.
		1056
		1057	The key combination that triggers the action, I<sym>, has the following format:
		1058
		1059	(modifiers-)key
		1060
		1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1062	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
999		1065
1000	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1066	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1001	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1067	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1002	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1068	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1003	current application keymap mode state.	1069	current application keymap mode state.
1004		1070
1005	The spellings of I<key> can be obtained by using B<xev>(1) command or	1071	Due the the large number of modifier combinations, a key mapping will
1006	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1072	match if I<at least> the specified identifiers are being set, and no other
		1073	key mappings with those and more bits are being defined. That means that
		1074	defining a mapping for C<a> will automatically provide definitions for
		1075	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1076	themselves. See the C<builtin:> action, below, for a way to work around
		1077	this when this is a problem.
		1078
		1079	The spelling of I<key> depends on your implementation of X. An easy way to
		1080	find a key name is to use the B<xev>(1) command. You can find a list by
		1081	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1007	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1082	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1008	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1083	value (B<0x0000 - 0xFFFF>).
1009	performed in an exact manner; however, the closest match is assured.
1010		1084
1011	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1085	As with any resource value, the I<action> string may contain backslash
1012	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1013	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1087	number), see RESOURCES in C<man 7 X> for further details.
1014	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1015	can start or end with whitespace.
1016		1088
1017	Please note that you need to double the C<\> when using	1089	An action starts with an action prefix that selects a certain type
1018	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1090	of action, followed by a colon. An action strings without colons is
1019	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1091	interpreted as a literal string to pass to the tty (as if they were
1020	@@RXVT_NAME@@'s own processing).	1092	prefixed with C<string:>).
1021		1093
1022	You can define a range of keysyms in one shot by providing a I<string>	1094	The following action prefixes are known - extensions can provide
1023	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1095	additional prefixes:
1024	should be a character not used by the strings.
1025		1096
1026	Its usage can be demonstrated by an example:	1097	=over 4
1027		1098
1028	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1099	=item string:STRING
1029		1100
1030	The above line is equivalent to the following three lines:	1101	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1102	then the remaining C<STRING> will be passed to the program running in the
		1103	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1104	string C<echo rm -rf /> followed by a newline:
1031		1105
1032	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1033	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1034	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1035		1107
		1108	This could in theory be used to completely redefine your keymap.
		1109
		1110	=item command:STRING
		1111
1036	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1037	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1113	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1114	the opposite of C<string:> - instead of sending it to the program running
		1115	in the terminal, it will be treated as if it were program output). This is
		1116	most useful to feed command sequences into @@RXVT_NAME@@.
		1117
1038	example the following means "change the current locale to C<zh_CN.GBK>	1118	For example the following means "change the current locale to C<zh_CN.GBK>
1039	when Control-Meta-c is being pressed":	1119	when Control-Meta-c is being pressed":
1040		1120
1041	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1121	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1042		1122
1043	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1123	The following example will map Control-Meta-1 and Control-Meta-2 to
1044	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1124	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1045	manpage. For example, the F<selection> extension (activated via	1125	font-switching at runtime:
1046	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1047		1126
1048	URxvt.keysym.M-C-c: perl:selection:rot13	1127	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1128	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1049		1129
1050	Due the the large number of modifier combinations, a defined key mapping	1130	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1051	will match if at I<at least> the specified identifiers are being set, and	1131	info):
1052	no other key mappings with those and more bits are being defined. That
1053	means that defining a key map for C<a> will automatically provide
1054	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1055	mappings themselves.
1056		1132
1057	Unfortunately, this will override built-in key mappings. For example	1133	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1134	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1135
		1136	=item builtin:
		1137
		1138	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1139	key binding existed for the key combination. The obvious use is to undo
		1140	the effect of existing bindings. The not so obvious use is to reinstate
		1141	bindings when another binding overrides too many modifiers.
		1142
1058	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1143	For example if you overwrite the C<Insert> key you will disable
1059	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1144	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1060	user-defined keymap using the C<builtin:> replacement:	1145	"holes" into the user-defined keymap using the C<builtin:> replacement:
1061		1146
1062	URxvt.keysym.Insert: <my insert key sequence>	1147	URxvt.keysym.Insert: <my insert key sequence>
1063	URxvt.keysym.S-Insert: builtin:	1148	URxvt.keysym.S-Insert: builtin:
1064		1149
1065	The first line defines a mapping for C<Insert> and I<any> combination	1150	The first line defines a mapping for C<Insert> and I<any> combination
1066	of modifiers. The second line re-establishes the default mapping for	1151	of modifiers. The second line re-establishes the default mapping for
1067	C<Shift-Insert>.	1152	C<Shift-Insert>.
1068		1153
1069	The following example will map Control-Meta-1 and Control-Meta-2 to	1154	=item builtin-string:
1070	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1071	font-switching at runtime:
1072		1155
1073	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1156	This action is mainly useful to restore string mappings for keys that
1074	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1157	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1158	difficult to explain - basically, this action will send the string to the
		1159	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1160	action for it.
1075		1161
1076	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1162	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1077	info):	1163	selection when you press C<Shift-Insert>. With the following bindings, it
		1164	would instead emit the (undocumented, but what applications running in the
		1165	terminal might expect) sequence C<ESC [ 2 $> instead:
1078		1166
1079	URxvt.keysym.M-C-3: command:\033[8;25;80t	1167	URxvt.keysym.S-Insert: builtin-string:
1080	URxvt.keysym.M-C-4: command:\033[8;48;110t	1168	URxvt.keysym.C-S-Insert: builtin:
		1169
		1170	The first line disables the paste functionality for that key
		1171	combination, and the second reinstates the default behaviour for
		1172	C<Control-Shift-Insert>, which would otherwise be overridden.
		1173
		1174	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1175	clipboard) and C<C-M-v> (paste clipboard) key combination, you cna do
		1176	this:
		1177
		1178	URxvt.keysym.C-S-c: builtin-string:
		1179	URxvt.keysym.C-S-v: builtin-string:
		1180
		1181	=item EXTENSION:STRING
		1182
		1183	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
		1184	extension of the same name. The extension will be loaded automatically if
		1185	neccessary.
		1186
		1187	Not all extensions define key actions, but popular extensions that do
		1188	include the I<selection> and I<matcher> extensions (documented in their
		1189	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1190	respectively).
		1191
		1192	From the silly examples department, this will rot13-"encrypt"
		1193	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1194	keyboards:
		1195
		1196	URxvt.keysym.M-C-c: selection:rot13
		1197
		1198	=item perl:STRING
		1199
		1200	This is a deprecated way of passing key mappings to perl extensions. It is
		1201	still supported, but should not be used anymore.
		1202
		1203	=back
		1204
		1205	In addition, you can define a range of keysyms in one shot by loading
		1206	the C<keysym-list> perl extension and providing a I<string> with pattern
		1207	B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
		1208	character not used by the strings.
		1209
		1210	Its usage can be demonstrated by an example:
		1211
		1212	URxvt.keysym.M-C-0x61: list|\033<|abc|>
		1213
		1214	The above line is equivalent to the following three lines:
		1215
		1216	URxvt.keysym.Meta-Control-0x61: \033<a>
		1217	URxvt.keysym.Meta-Control-0x62: \033<b>
		1218	URxvt.keysym.Meta-Control-0x63: \033<c>
1081		1219
1082	=item B<perl-ext-common>: I<string>	1220	=item B<perl-ext-common>: I<string>
1083		1221
1084	=item B<perl-ext>: I<string>	1222	=item B<perl-ext>: I<string>
1085		1223
1086	Colon-separated list(s) of perl extension scripts to use in this terminal	1224	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1225	use in this terminal instance; option B<-pe>.
		1226
		1227	Extension names can be prefixed with a C<-> sign to prohibit using
		1228	them. This can be useful to selectively disable some extensions loaded
		1229	by default, or specified via the C<perl-ext-common> resource. For
		1230	example, C<default,-selection> will use all the default extension except
		1231	C<selection>.
		1232
		1233	Extension names can also be followed by an argument in angle brackets
		1234	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1235	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1236	multiple times with different arguments will pass multiple arguments to
		1237	the extension.
		1238
1087	instance. Each extension is looked up in the library directories, loaded	1239	Each extension is looked up in the library directories, loaded if
1088	if necessary, and bound to the current terminal instance. If this	1240	necessary, and bound to the current terminal instance.
1089	resource is empty or missing, then the perl interpreter will not be	1241
1090	initialized. The idea behind two options is that B<perl-ext-common> will	1242	If both of these resources are the empty string, then the perl
1091	be used for extensions that should be available to all instances, while	1243	interpreter will not be initialized. The idea behind two options is that
1092	B<perl-ext> is used for specific instances; option B<-pe>.	1244	B<perl-ext-common> will be used for extensions that should be available to
		1245	all instances, while B<perl-ext> is used for specific instances.
1093		1246
1094	=item B<perl-eval>: I<string>	1247	=item B<perl-eval>: I<string>
1095		1248
1096	Perl code to be evaluated when all extensions have been registered. See the	1249	Perl code to be evaluated when all extensions have been registered. See
1097	@@RXVT_NAME@@perl(3) manpage.	1250	the @@RXVT_NAME@@perl(3) manpage.
1098		1251
1099	=item B<perl-lib>: I<path>	1252	=item B<perl-lib>: I<path>
1100		1253
1101	Colon-separated list of additional directories that hold extension	1254	Colon-separated list of additional directories that hold extension
1102	scripts. When looking for extensions specified by the C<perl> resource,	1255	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1103	@@RXVT_NAME@@ will first look in these directories and then in	1256	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1104	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1257	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1105		1258
1106	See the @@RXVT_NAME@@perl(3) manpage.	1259	See the @@RXVT_NAME@@perl(3) manpage.
		1260
		1261	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1262
		1263	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1264	details.
		1265
		1266	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1267
		1268	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1269	for details.
		1270
		1271	=item B<searchable-scrollback:> I<keysym>
		1272
		1273	Sets the hotkey that starts the incremental scrollback buffer search
		1274	(default: C<M-s>).
		1275
		1276	=item B<url-launcher>: I<string>
		1277
		1278	Specifies the program to be started with a URL argument. Used by the
		1279	C<selection-popup> and C<matcher> perl extensions.
		1280
		1281	=item B<transient-for>: I<windowid>
		1282
		1283	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1284
		1285	=item B<override-redirect>: I<boolean>
		1286
		1287	Compile I<frills>: Sets override-redirect for the terminal window, making
		1288	it almost invisible to window managers; option B<-override-redirect>.
		1289
		1290	=item B<iso14755:> I<boolean>
		1291
		1292	Turn on/off ISO 14755 (default enabled).
		1293
		1294	=item B<iso14755_52:> I<boolean>
		1295
		1296	Turn on/off ISO 14755 5.2 mode (default enabled).
		1297
		1298	=back
		1299
		1300	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1301
		1302	=over 4
		1303
		1304	=item B<-pixmap> I<file[;oplist]>
		1305
		1306	=item B<backgroundPixmap:> I<file[;oplist]>
		1307
		1308	Compile I<pixbuf>: Use the specified image file as the window's
		1309	background and also optionally specify a colon separated list of
		1310	operations to modify it. Note that you may need to quote the C<;>
		1311	character when using the command line option, as C<;> is usually a
		1312	metacharacter in shells. Supported operations are:
		1313
		1314	=over 4
		1315
		1316	=item B<WxH+X+Y>
		1317
		1318	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1319	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1320	scale of 0 disables scaling.
		1321
		1322	=item B<op=tile>
		1323
		1324	enables tiling
		1325
		1326	=item B<op=keep-aspect>
		1327
		1328	maintain the image aspect ratio when scaling
		1329
		1330	=item B<op=root-align>
		1331
		1332	use the position of the terminal window relative to the root window as
		1333	the image offset, simulating a root window background
		1334
		1335	=back
		1336
		1337	The default scale and position setting is C<100x100+50+50>.
		1338	Alternatively, a predefined set of templates can be used to achieve
		1339	the most common setups:
		1340
		1341	=over 4
		1342
		1343	=item B<style=tiled>
		1344
		1345	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1346
		1347	=item B<style=aspect-stretched>
		1348
		1349	the image is scaled to fill the whole window maintaining the aspect
		1350	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1351
		1352	=item B<style=stretched>
		1353
		1354	the image is scaled to fill the whole window. Equivalent to 100x100
		1355
		1356	=item B<style=centered>
		1357
		1358	the image is centered with no scaling. Equivalent to 0x0+50+50
		1359
		1360	=item B<style=root-tiled>
		1361
		1362	the image is tiled with no scaling and using 'root' positioning.
		1363	Equivalent to 0x0:op=tile:op=root-align
		1364
		1365	=back
		1366
		1367	If multiple templates are specified the last one wins. Note that a
		1368	template overrides all the scale, position and operations settings.
		1369
		1370	If used in conjunction with pseudo-transparency, the specified pixmap
		1371	will be blended over the transparent background using alpha-blending.
		1372
		1373	=item B<-tr>|B<+tr>
		1374
		1375	=item B<transparent:> I<boolean>
		1376
		1377	Turn on/off pseudo-transparency by using the root pixmap as background.
		1378
		1379	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1380	will be removed in future versions.
		1381
		1382	=item B<-tint> I<colour>
		1383
		1384	=item B<tintColor:> I<colour>
		1385
		1386	Tint the transparent background with the given colour. Note that a
		1387	black tint yields a completely black image while a white tint yields
		1388	the image unchanged.
		1389
		1390	=item B<-sh> I<number>
		1391
		1392	=item B<shading:> I<number>
		1393
		1394	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1395	A value of 100 means no shading.
		1396
		1397	=item B<-blr> I<HxV>
		1398
		1399	=item B<blurRadius:> I<HxV>
		1400
		1401	Apply gaussian blur with the specified radius to the transparent
		1402	background. If a single number is specified, the vertical and
		1403	horizontal radii are considered to be the same. Setting one of the
		1404	radii to 1 and the other to a large number creates interesting effects
		1405	on some backgrounds. The maximum radius value is 128. An horizontal or
		1406	vertical radius of 0 disables blurring.
		1407
		1408	=item B<path:> I<path>
		1409
		1410	Specify the colon-delimited search path for finding background image files.
1107		1411
1108	=back	1412	=back
1109		1413
1110	=head1 THE SCROLLBAR	1414	=head1 THE SCROLLBAR
1111		1415
…		…
1130	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1434	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1131	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1435	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1132	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1436	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1133	respectively.	1437	respectively.
1134		1438
1135	=head1 TEXT SELECTION AND INSERTION	1439	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1136		1440
1137	The behaviour of text selection and insertion mechanism is similar to	1441	The behaviour of text selection and insertion/pasting mechanism is similar
1138	I<xterm>(1).	1442	to I<xterm>(1).
1139		1443
1140	=over 4	1444	=over 4
1141		1445
1142	=item B<Selection>:	1446	=item B<Selecting>:
1143		1447
1144	Left click at the beginning of the region, drag to the end of the region	1448	Left click at the beginning of the region, drag to the end of the region
1145	and release; Right click to extend the marked region; Left double-click	1449	and release; Right click to extend the marked region; Left double-click
1146	to select a word; Left triple-click to select the entire logical line	1450	to select a word; Left triple-click to select the entire logical line
1147	(which can span multiple screen lines), unless modified by resource	1451	(which can span multiple screen lines), unless modified by resource
…		…
1151	(Compile: I<frills>) will create a rectangular selection instead of a	1455	(Compile: I<frills>) will create a rectangular selection instead of a
1152	normal one. In this mode, every selected row becomes its own line in the	1456	normal one. In this mode, every selected row becomes its own line in the
1153	selection, and trailing whitespace is visually underlined and removed from	1457	selection, and trailing whitespace is visually underlined and removed from
1154	the selection.	1458	the selection.
1155		1459
1156	=item B<Insertion>:	1460	=item B<Pasting>:
1157		1461
1158	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1462	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1159	an B<@@RXVT_NAME@@> window causes the current text selection to be	1463	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1160	inserted as if it had been typed on the keyboard.	1464	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1465
		1466	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1467	inserted too.
		1468
		1469	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1470	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1471	binding causes the value of the internal selection to be copied to the
		1472	CLIPBOARD selection, while the second binding causes the value of the
		1473	CLIPBOARD selection to be inserted.
1161		1474
1162	=back	1475	=back
1163		1476
1164	=head1 CHANGING FONTS	1477	=head1 CHANGING FONTS
1165		1478
1166	Changing fonts (or font sizes, respectively) via the keypad is not yet	1479	Changing fonts (or font sizes, respectively) via the keypad is not yet
1167	supported in rxvt-unicode. Bug me if you need this.	1480	supported in rxvt-unicode. Bug me if you need this.
1168		1481
1169	You can, however, switch fonts at runtime using escape sequences (and	1482	You can, however, switch fonts at runtime using escape sequences, e.g.:
1170	therefore using the menubar), e.g.:
1171		1483
1172	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1484	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1485
		1486	You can use keyboard shortcuts, too:
		1487
		1488	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1489	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1173		1490
1174	rxvt-unicode will automatically re-apply these fonts to the output so far.	1491	rxvt-unicode will automatically re-apply these fonts to the output so far.
1175		1492
1176	=head1 ISO 14755 SUPPORT	1493	=head1 ISO 14755 SUPPORT
1177		1494
1178	ISO 14755 is a standard for entering and viewing unicode characters	1495	ISO 14755 is a standard for entering and viewing unicode characters
1179	and character codes using the keyboard. It consists of 4 parts. The	1496	and character codes using the keyboard. It consists of 4 parts. The
1180	first part is available rxvt-unicode has been compiled with	1497	first part is available if rxvt-unicode has been compiled with
1181	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1498	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1182	with C<--enable-iso14755>.	1499	with C<--enable-iso14755>.
1183		1500
1184	=over 4	1501	=over 4
1185		1502
…		…
1205	This mode lets you input characters representing the keycap symbols of	1522	This mode lets you input characters representing the keycap symbols of
1206	your keyboard, if representable in the current locale encoding.	1523	your keyboard, if representable in the current locale encoding.
1207		1524
1208	Start by pressing C<Control> and C<Shift> together, then releasing	1525	Start by pressing C<Control> and C<Shift> together, then releasing
1209	them. The next special key (cursor keys, home etc.) you enter will not	1526	them. The next special key (cursor keys, home etc.) you enter will not
1210	invoke it's usual function but instead will insert the corresponding	1527	invoke its usual function but instead will insert the corresponding
1211	keycap symbol. The symbol will only be entered when the key has been	1528	keycap symbol. The symbol will only be entered when the key has been
1212	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1529	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1213	C<ISO Level 2 Switch>, although your intention might have been to enter a	1530	C<ISO Level 2 Switch>, although your intention might have been to enter a
1214	reverse tab (Shift-Tab).	1531	reverse tab (Shift-Tab).
1215		1532
…		…
1243	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1560	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1244	it can be seen via the I<who(1)> command, and can accept messages. To	1561	it can be seen via the I<who(1)> command, and can accept messages. To
1245	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1562	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1246	on some systems or setgid to root or to some other group on others.	1563	on some systems or setgid to root or to some other group on others.
1247		1564
1248	=head1 COLORS AND GRAPHICS	1565	=head1 COLOURS AND GRAPHICS
1249		1566
1250	In addition to the default foreground and background colours,	1567	In addition to the default foreground and background colours,
1251	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1568	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1252	high-intensity bold/blink versions of the same). Here is a list of the	1569	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1253	colours with their B<rgb.txt> names.	1570	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1571	cube plus a 8 (24) colour greyscale ramp.
		1572
		1573	Here is a list of the ANSI colours with their names.
1254		1574
1255	=begin table	1575	=begin table
1256		1576
1257	B<color0> (black) = Black	1577	B<color0> (black) = Black
1258	B<color1> (red) = Red3	1578	B<color1> (red) = Red3
…		…
1278	It is also possible to specify the colour values of B<foreground>,	1598	It is also possible to specify the colour values of B<foreground>,
1279	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1599	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1280	a number 0-15, as a convenient shorthand to reference the colour name of	1600	a number 0-15, as a convenient shorthand to reference the colour name of
1281	color0-color15.	1601	color0-color15.
1282		1602
		1603	The following text gives values for the standard 88 colour mode (and
		1604	values for the 256 colour mode in parentheses).
		1605
		1606	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1607
		1608	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1609	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1610
		1611	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1612	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1613	the RGB cube.
		1614
		1615	Together, all those colours implement the 88 (256) colour xterm
		1616	colours. Only the first 16 can be changed using resources currently, the
		1617	rest can only be changed via command sequences ("escape codes").
		1618
		1619	Applications are advised to use terminfo or command sequences to discover
		1620	number and RGB values of all colours (yes, you can query this...).
		1621
1283	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1622	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1284	always swapping the foreground/background colours. This is in contrast to	1623	always swapping the foreground/background colours. This is in contrast to
1285	I<xterm>(1) where the colours are only swapped if they have not otherwise	1624	I<xterm>(1) where the colours are only swapped if they have not otherwise
1286	been specified. For example,	1625	been specified. For example,
1287		1626
		1627	@@RXVT_NAME@@ -fg Black -bg White -rv
		1628
		1629	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1630	White.
		1631
		1632	=head2 ALPHA CHANNEL SUPPORT
		1633
		1634	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1635	their act together, rxvt-unicode will do its own alpha channel management:
		1636
		1637	You can prefix any colour with an opaqueness percentage enclosed in
		1638	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1639	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1640	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1641	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1642	is the recommended format to specify transparency values, and works with
		1643	all ways to specify a colour.
		1644
		1645	For complete control, rxvt-unicode also supports
		1646	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1647	specifications, where the additional C<aaaa> component specifies opacity
		1648	(alpha) values. The minimum value of C<0000> is completely transparent,
		1649	while C<ffff> is completely opaque). The two example colours from
		1650	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1651	C<rgba:0000/ff00/0000/f332>.
		1652
		1653	You probably need to specify B<"-depth 32">, too, to force a visual with
		1654	alpha channels, and have the luck that your X-server uses ARGB pixel
		1655	layout, as X is far from just supporting ARGB visuals out of the box, and
		1656	rxvt-unicode just fudges around.
		1657
		1658	For example, the following selects an almost completely transparent black
		1659	background, and an almost opaque pink foreground:
		1660
		1661	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1662
		1663	When not using a background image, then the interpretation of the
		1664	alpha channel is up to your compositing manager (most interpret it as
		1665	transparency of course).
		1666
		1667	When using a background pixmap or pseudo-transparency, then the background
		1668	colour will always behave as if it were completely transparent (so the
		1669	background image shows instead), regardless of how it was specified, while
		1670	other colours will either be transparent as specified (the background
		1671	image will show through) on servers supporting the RENDER extension, or
		1672	fully opaque on servers not supporting the RENDER EXTENSION.
		1673
		1674	Please note that due to bugs in Xft, specifying alpha values might result
		1675	in garbage being displayed when the X-server does not support the RENDER
		1676	extension.
		1677
		1678	=head1 ENVIRONMENT
		1679
		1680	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1681
1288	=over 4	1682	=over 4
1289		1683
1290	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1291
1292	would yield White on Black, while on I<xterm>(1) it would yield Black
1293	on White.
1294
1295	=back
1296
1297	=head1 ENVIRONMENT
1298
1299	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1300
1301	=over 4
1302
1303	=item B<TERM>	1684	=item B<TERM>
1304		1685
1305	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1686	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1306	resources or on the commandline.	1687	resources or on the command line.
1307		1688
1308	=item B<COLORTERM>	1689	=item B<COLORTERM>
1309		1690
1310	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1691	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1311	compiled with XPM support, and optionally with the added extension	1692	compiled with background image support, and optionally with the added
1312	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1693	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1694	screen.
1313		1695
1314	=item B<COLORFGBG>	1696	=item B<COLORFGBG>
1315		1697
1316	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1698	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1317	the colour code used as default foreground/text colour (or the string	1699	the colour code used as default foreground/text colour (or the string
1318	C<default> to indicate that the default-colour escape sequence is to be	1700	C<default> to indicate that the default-colour escape sequence is to be
1319	used), C<bg> is the colour code used as default background colour (or the	1701	used), C<bg> is the colour code used as default background colour (or the
1320	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1702	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1321	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1703	was compiled with background image support. Libraries like C<ncurses>
1322	(and do) use this information to optimize screen output.	1704	and C<slang> can (and do) use this information to optimize screen output.
1323		1705
1324	=item B<WINDOWID>	1706	=item B<WINDOWID>
1325		1707
1326	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1708	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1327	window, which usually has subwindows for the scrollbar, the terminal	1709	window, which usually has subwindows for the scrollbar, the terminal
…		…
1333	C<--with-terminfo=PATH>.	1715	C<--with-terminfo=PATH>.
1334		1716
1335	=item B<DISPLAY>	1717	=item B<DISPLAY>
1336		1718
1337	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1719	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1338	display in it's child processes.	1720	display in its child processes if C<-display> isn't used to override. It
		1721	defaults to C<:0> if it doesn't exist.
1339		1722
1340	=item B<SHELL>	1723	=item B<SHELL>
1341		1724
1342	The shell to be used for command execution, defaults to C</bin/sh>.	1725	The shell to be used for command execution, defaults to C</bin/sh>.
1343		1726
1344	=item B<RXVTPATH>
1345
1346	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1347	files.
1348
1349	=item B<PATH>
1350
1351	Used in the same way as C<RXVTPATH>.
1352
1353	=item B<RXVT_SOCKET>	1727	=item B<RXVT_SOCKET> [I<sic>]
1354		1728
1355	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1729	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1356	@@RXVT_NAME@@d(1).	1730	@@RXVT_NAME@@d(1).
1357		1731
1358	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1732	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1733
		1734	=item B<URXVT_PERL_LIB>
		1735
		1736	Additional F<:>-separated library search path for perl extensions. Will be
		1737	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1738	directory.
		1739
		1740	=item B<URXVT_PERL_VERBOSITY>
		1741
		1742	See L<@@RXVT_NAME@@perl>(3).
1359		1743
1360	=item B<HOME>	1744	=item B<HOME>
1361		1745
1362	Used to locate the default directory for the unix domain socket for	1746	Used to locate the default directory for the unix domain socket for
1363	daemon communications and to locate various resource files (such as	1747	daemon communications and to locate various resource files (such as
1364	C<.Xdefaults>)	1748	C<.Xdefaults>)
1365		1749
1366	=item B<XAPPLRESDIR>	1750	=item B<XAPPLRESDIR>
1367		1751
1368	Directory where various X resource files are being located.	1752	Directory where application-specific X resource files are located.
1369		1753
1370	=item B<XENVIRONMENT>	1754	=item B<XENVIRONMENT>
1371		1755
1372	If set and accessible, gives the name of a X resource file to be loaded by	1756	If set and accessible, gives the name of a X resource file to be loaded by
1373	@@RXVT_NAME@@.	1757	@@RXVT_NAME@@.
…		…
1378		1762
1379	=over 4	1763	=over 4
1380		1764
1381	=item B</usr/lib/X11/rgb.txt>	1765	=item B</usr/lib/X11/rgb.txt>
1382		1766
1383	Color names.	1767	Colour names.
1384		1768
1385	=back	1769	=back
1386		1770
1387	=head1 SEE ALSO	1771	=head1 SEE ALSO
1388		1772
		1773	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1389	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1774	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1390		1775
1391	=head1 CURRENT PROJECT COORDINATOR	1776	=head1 CURRENT PROJECT COORDINATOR
1392		1777
1393	=over 4	1778	=over 4
1394		1779
1395	=item Project Coordinator	1780	=item Project Coordinator
1396		1781
1397	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1782	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1398		1783
1399	L<http://software.schmorp.de/#rxvt-unicode>	1784	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1400		1785
1401	=back	1786	=back
1402		1787
1403	=head1 AUTHORS	1788	=head1 AUTHORS
1404		1789
…		…
1406		1791
1407	=item John Bovey	1792	=item John Bovey
1408		1793
1409	University of Kent, 1992, wrote the original Xvt.	1794	University of Kent, 1992, wrote the original Xvt.
1410		1795
1411	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1796	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1412		1797
1413	very heavily modified Xvt and came up with Rxvt	1798	very heavily modified Xvt and came up with Rxvt
1414		1799
1415	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1800	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1416		1801
1417	wrote the Greek Keyboard Input (no longer in code)	1802	wrote the Greek Keyboard Input (no longer in code)
1418		1803
1419	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1804	=item mj olesen <olesen@me.QueensU.CA>
1420		1805
1421	Wrote the menu system.	1806	Wrote the menu system.
1422		1807
1423	Project Coordinator (changes.txt 2.11 to 2.21)	1808	Project Coordinator (changes.txt 2.11 to 2.21)
1424		1809
1425	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1810	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1426		1811
1427	Project Coordinator (changes.txt 2.21a to 2.4.5)	1812	Project Coordinator (changes.txt 2.21a to 2.4.5)
1428		1813
1429	=item Geoff Wing L<< <gcw@pobox.com> >>	1814	=item Geoff Wing <gcw@pobox.com>
1430		1815
1431	Rewrote screen display and text selection routines. Project Coordinator	1816	Rewrote screen display and text selection routines.
		1817
1432	(changes.txt 2.4.6 - rxvt-unicode)	1818	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1433		1819
1434	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1820	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1435		1821
1436	Forked rxvt-unicode, rewrote most of the display code and internal	1822	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1437	character handling to store text in unicode, improve xterm	1823	extension, random hacks, numerous bugfixes and extensions.
1438	compatibility and apply numerous other bugfixes and extensions.
1439		1824
1440	Project Coordinator (Changes 1.0 -)	1825	Project Coordinator (Changes 1.0 -)
1441		1826
		1827	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1828
		1829	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1830
1442	=back	1831	=back
1443		1832

Diff Legend

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