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.97 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 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
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
97		116
98	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
99		118
100	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
101		120
…		…
103		122
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		124
106	=item B<-j>|B<+j>	125	=item B<-j>|B<+j>
107		126
108	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		128
110	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>	129	=item B<-ss>|B<+ss>
111		130
112	Turn on/off inheriting parent window's pixmap. Alternative form is	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.
114		132
115	=item B<-fade> I<number>	133	=item B<-fade> I<number>
116		134
117	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	137	colour; resource B<fading>.
120		138
121	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
122		140
123	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
125		143
126	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
127		145
128	Tint the transparent background pixmap with the given colour when	146	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	147	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	148	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		149
142	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
143		151
144	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
145		153
146	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
147		155
148	Window foreground colour; resource B<foreground>.	156	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		157
157	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
158		159
159	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
160		161
…		…
177	that are checked in order when trying to find glyphs for characters. The	178	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	179	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	180	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.	181	font list is always appended to it. See resource B<font> for more details.
181		182
182	In short, to specify an X11 core font, just specify it's name or prefix it	183	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:>,	184	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	185	e.g.:
185		186
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	187	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	188	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	207	for details.
207		208
208	=item B<-is>|B<+is>	209	=item B<-is>|B<+is>
209		210
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
212	details.	213	details.
213		214
214	=item B<-name> I<name>	215	=item B<-name> I<name>
215		216
…		…
219		220
220	=item B<-ls>|B<+ls>	221	=item B<-ls>|B<+ls>
221		222
222	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
223		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
224	=item B<-ut>|B<+ut>	229	=item B<-ut>|B<+ut>
225		230
226	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227	B<utmpInhibit>.	232	B<utmpInhibit>.
228		233
…		…
232	B<visualBell>.	237	B<visualBell>.
233		238
234	=item B<-sb>|B<+sb>	239	=item B<-sb>|B<+sb>
235		240
236	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
237		251
238	=item B<-si>|B<+si>	252	=item B<-si>|B<+si>
239		253
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
248	=item B<-sw>|B<+sw>	262	=item B<-sw>|B<+sw>
249		263
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	266	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		267
263	=item B<-ptab>|B<+ptab>	268	=item B<-ptab>|B<+ptab>
264		269
265	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
270		275
271	=item B<-bc>|B<+bc>	276	=item B<-bc>|B<+bc>
272		277
273	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
274		279
		280	=item B<-uc>|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
275	=item B<-iconic>	284	=item B<-iconic>
276		285
277	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
278	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
279		288
…		…
295		304
296	=item B<-bl>	305	=item B<-bl>
297		306
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	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	308	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
		311
		312	=item B<-override-redirect>
		313
		314	Compile I<frills>: Sets override-redirect on the window; resource
		315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
301		321
302	=item B<-sbg>	322	=item B<-sbg>
303		323
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	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	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		328
309	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
310		330
311	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
314		341
315	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
316		343
317	This option specifies the name of the terminal type to be set in the	344	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	345	B<TERM> environment variable. This terminal type must exist in the
…		…
353	=item B<-pt> I<style>	380	=item B<-pt> I<style>
354		381
355	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
356	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
357		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
358	=item B<-im> I<text>	388	=item B<-im> I<text>
359		389
360	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
361		391
362	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
372	for more info.	402	for more info.
373		403
374	=item B<-tcw>	404	=item B<-tcw>
375		405
376	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
		407	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	408	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
379		410
380	=item B<-insecure>	411	=item B<-insecure>
381		412
382	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	436	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	437	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	438	user; resource B<hold>.
408		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
		445
		446	=item B<-xrm> I<string>
		447
		448	Works like the X Toolkit option of the same name, by adding the I<string>
		449	as if it were specified in a resource file. Resource values specified this
		450	way take precedence over all other resource specifications.
		451
		452	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		453	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		454	options can be specified as long-options on the commandline, so use
		455	of B<-xrm> is mostly limited to cases where you want to specify other
		456	resources (e.g. for input methods) or for compatibility with other
		457	programs.
		458
409	=item B<-keysym.>I<sym> I<string>	459	=item B<-keysym.>I<sym> I<string>
410		460
411	Remap a key symbol. See resource B<keysym>.	461	Remap a key symbol. See resource B<keysym>.
412		462
413	=item B<-embed> I<windowid>	463	=item B<-embed> I<windowid>
414		464
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	465	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	466	which enables applications to easily embed a terminal.
417		467
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	468	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	469	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	470	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.	473	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		474
425	It might be useful to know that @@RXVT_NAME@@ will not close file	475	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	476	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	477	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	478	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	479	not.
430		480
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	481	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	482	used (a longer example is in F<doc/embed>):
433		483
…		…
438	});	488	});
439		489
440	=item B<-pty-fd> I<file descriptor>	490	=item B<-pty-fd> I<file descriptor>
441		491
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	492	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	493	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	494	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	495	without having to run a program within it.
446		496
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	497	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	498	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	499	yourself if you want that.
450		500
451	As an extremely special case, specifying C<-1> will completely suppress	501	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
453		504
454	Here is a example in perl that illustrates how this option can be used (a	505	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	506	longer example is in F<doc/pty-fd>):
456		507
457	use IO::Pty;	508	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	522	Comma-separated list of perl extension scripts to use (or not to use) in
472	this terminal instance. See resource B<perl-ext> for details.	523	this terminal instance. See resource B<perl-ext> for details.
473		524
474	=back	525	=back
475		526
476	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
477		528
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
480		532
481	You can set and change the resources using X11 tools like B<xrdb>. Many	533	You can set and change the resources using X11 tools like B<xrdb>. Many
482	distribution do also load settings from the B<~/.Xresources> file when X	534	distribution do also load settings from the B<~/.Xresources> file when X
483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
485		537
486	1. system-wide app-defaults file, either locale-dependent OR global
487	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
489	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
491		544
492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	547	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495	configured, while the class name B<URxvt> allows resources unique to	548	configured, while the class name B<URxvt> allows resources unique to
…		…
500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	553	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501	extensions not documented here):	554	extensions not documented here):
502		555
503	=over 4	556	=over 4
504		557
		558	=item B<depth:> I<bitdepth>
		559
		560	Compile I<xft>: Attempt to find a visual with the given bit depth;
		561	option B<-depth>.
		562
		563	=item B<buffered:> I<boolean>
		564
		565	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		566	On some card/driver combination enabling it slightly decreases
		567	performance, on most it greatly helps it. The slowdown is small, so it
		568	should normally be enabled.
		569
505	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
506		571
507	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
508	option B<-geometry>.	573	option B<-geometry>.
509		574
…		…
522	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
523	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
524	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
525	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
526	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
528		593
529	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
530	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
531		596
532	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
543	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
544		609
545	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
546	foreground colour is the default.	611	foreground colour is the default.
547		612
548	=item B<colorRV:> I<colour>
549
550	Use the specified colour as the background for reverse video
551	characters.
552
553	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
554		614
555	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
556	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
557		627
558	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
559		629
560	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
561	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
568		638
569	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
570		640
571	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
572	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
573	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574		644
575	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
576		646
577	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
578	quickly, fewer screen updates are performed [default]; option B<-j>.	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		649	has been read, resulting in fewer updates while still displaying every
		650	received line; option B<-j>.
		651
579	B<False>: specify that smooth scrolling should be used; option B<+j>.	652	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		653	force a screen refresh on each new line it received; option B<+j>.
580		654
581	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
582		656
583	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
584	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585	pixmap.	659	(around 60 times per second), resulting in far fewer updates. This can
		660	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		661	option B<-ss>.
		662
		663	B<False>: specify that everything is to be displayed, even
		664	if the refresh is too fast for the human eye to read anything (or the
		665	monitor to display anything); option B<+ss>.
586		666
587	=item B<fading:> I<number>	667	=item B<fading:> I<number>
588		668
589	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
590		670
591	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
592		672
593	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
594	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
595		675
596	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
597		677
598	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
599	B<-tint>.
600
601	=item B<shading:> I<number>
602
603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
604	image in addition to tinting it.
605		679
606	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
607		681
608	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
609		683
…		…
614		688
615	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
616		690
617	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
618	and the text.	692	and the text.
619
620	=item B<backgroundPixmap:> I<file[;geom]>
621
622	Use the specified XPM file (note the `.xpm' extension is optional) for
623	the background and also optionally specify its scaling with a geometry
624	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
625	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
626	centre (percent). A scale of 0 displays the image with tiling. A scale
627	of 1 displays the image without any scaling. A scale of 2 to 9
628	specifies an integer number of images in that direction. No image will
629	be magnified beyond 10 times its original size. The maximum permitted
630	scale is 1000. [default 0x0+50+50]
631
632	=item B<path:> I<path>
633
634	Specify the colon-delimited search path for finding XPM files.
635		693
636	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
637		695
638	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
639	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
662	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
663	wide and 15 pixels high.	721	wide and 15 pixels high.
664		722
665	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
666	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
667	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
668	useful supplement.	726	useful supplement.
669		727
670	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
671	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
672	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
696	text font will being used for the given style.	754	text font will being used for the given style.
697		755
698	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
699		757
700	When font styles are not enabled, or this option is enabled (B<True>,	758	When font styles are not enabled, or this option is enabled (B<True>,
701	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
702	intensity foreground/backround colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
703	option B<+is>) disables this behaviour, the high intensity colours are not	761	option B<+is>) disables this behaviour, the high intensity colours are not
704	reachable.	762	reachable.
705
706	=item B<selectstyle:> I<mode>
707
708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709	xterm style with 2.20 old word selection, or anything else which gives
710	xterm style selection.
711
712	=item B<scrollstyle:> I<mode>
713
714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715	the author's favourite.
716		763
717	=item B<title:> I<string>	764	=item B<title:> I<string>
718		765
719	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
720	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
…		…
729	=item B<mapAlert:> I<boolean>	776	=item B<mapAlert:> I<boolean>
730		777
731	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	778	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732	de-iconify (map) on receipt of a bell character [default].	779	de-iconify (map) on receipt of a bell character [default].
733		780
		781	=item B<urgentOnBell:> I<boolean>
		782
		783	B<True>: set the urgency hint for the wm on receipt of a bell character.
		784	B<False>: do not set the urgency hint [default].
		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
734	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
735		789
736	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
738		792
…		…
740		794
741	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
742	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
743	[default]; option B<+ls>.	797	[default]; option B<+ls>.
744		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
745	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
746		805
747	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
748	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
749	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
759	Example:	818	Example:
760		819
761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762		821
763	This creates a new file in your home directory with the screen contents	822	This creates a new file in your home directory with the screen contents
764	everytime you hit C<Print>.	823	every time you hit C<Print>.
		824
		825	=item B<scrollstyle:> I<mode>
		826
		827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		828	the author's favourite.
		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
765		833
766	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
767		835
768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
…		…
789	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
790	B<+si>.	858	B<+si>.
791		859
792	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
793		861
794	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
796	with scrollback buffer when tty recieves new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
797		866
798	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
799		868
800	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
801	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
802	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
803	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
804		873
805	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
806		875
807	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
808	resource is limited on most machines to 65535; option B<-sl>.
809		877
810	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
811		879
812	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
813	option B<-b>.	881	option B<-b>.
…		…
832	=item B<termName:> I<termname>	900	=item B<termName:> I<termname>
833		901
834	Specifies the terminal type name to be set in the B<TERM> environment	902	Specifies the terminal type name to be set in the B<TERM> environment
835	variable; option B<-tn>.	903	variable; option B<-tn>.
836		904
837	=item B<linespace:> I<number>	905	=item B<lineSpace:> I<number>
838		906
839	Specifies number of lines (pixel height) to insert between each row of	907	Specifies number of lines (pixel height) to insert between each row of
840	the display [default 0]; option B<-lsp>.	908	the display [default 0]; option B<-lsp>.
841		909
842	=item B<meta8:> I<boolean>	910	=item B<meta8:> I<boolean>
…		…
856		924
857	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
858		926
859	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	927	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
860	option B<-bc>.	928	option B<-bc>.
		929
		930	=item B<cursorUnderline:> I<boolean>
		931
		932	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		933	option B<-uc>.
861		934
862	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
863		936
864	B<True>: blank the pointer when a key is pressed or after a set number	937	B<True>: blank the pointer when a key is pressed or after a set number
865	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
…		…
871		944
872	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
873		946
874	Mouse pointer background colour.	947	Mouse pointer background colour.
875		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
876	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
877		956
878	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
879	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
880		959
881	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
882		961
883	The string to send when the backspace key is pressed. If set to B<DEC>	962	The string to send when the backspace key is pressed. If set to B<DEC>
884	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	963	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
885	(code 8) - which can be reversed with the appropriate DEC private mode	964	(code 8) - which can be reversed with the appropriate DEC private mode
886	escape sequence.	965	escape sequence.
887		966
888	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
889		968
…		…
891	pressed. If unset it will send the sequence traditionally associated	970	pressed. If unset it will send the sequence traditionally associated
892	with the B<Execute> key.	971	with the B<Execute> key.
893		972
894	=item B<cutchars:> I<string>	973	=item B<cutchars:> I<string>
895		974
896	The characters used as delimiters for double-click word selection. The	975	The characters used as delimiters for double-click word selection
897	built-in default:	976	(whitespace delimiting is added automatically if resource is given).
898		977
		978	When the perl selection extension is in use (the default if compiled
		979	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		980	characters will be created (if the resource exists, otherwise, no regex
		981	will be created). In this mode, characters outside ISO-8859-1 can be used.
		982
		983	When the selection extension is not used, only ISO-8859-1 characters can
		984	be used. If not specified, the built-in default is used:
		985
899	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
900		987
901	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
902		989
903	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904		991
905	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
906		993
907	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
908		995
…		…
952		1039
953	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1040	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954	character is passed through. It may contain escape values as described	1041	character is passed through. It may contain escape values as described
955	in the entry on B<keysym> following.	1042	in the entry on B<keysym> following.
956		1043
957	=item B<secondaryScreen:> I<bool>	1044	=item B<secondaryScreen:> I<boolean>
958		1045
959	Turn on/off secondary screen (default enabled).	1046	Turn on/off secondary screen (default enabled).
960		1047
961	=item B<secondaryScroll:> I<bool>	1048	=item B<secondaryScroll:> I<boolean>
962		1049
963	Turn on/off secondary screen scroll (default enabled). If the this	1050	Turn on/off secondary screen scroll (default enabled). If this
964	option is enabled, scrolls on the secondary screen will change the	1051	option is enabled, scrolls on the secondary screen will change the
965	scrollback buffer and switching to/from the secondary screen will	1052	scrollback buffer and, when secondaryScreen is off, switching
966	instead scroll the screen up.	1053	to/from the secondary screen will instead scroll the screen up.
967		1054
968	=item B<hold>: I<bool>	1055	=item B<hold>: I<boolean>
969		1056
970	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1057	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971	will not immediately destroy its window when the program executed within	1058	will not immediately destroy its window when the program executed within
972	it exits. Instead, it will wait till it is being killed or closed by the	1059	it exits. Instead, it will wait till it is being killed or closed by the
973	user.	1060	user.
974		1061
		1062	=item B<chdir>: I<path>
		1063
		1064	Sets the working directory for the shell (or the command specified via
		1065	B<-e>). The I<path> must be an absolute path and it must exist for
		1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1067	directory will be used; option B<-cd>.
		1068
975	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
976		1070
977	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
978	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
979		1073
980	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
981	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
982	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
983	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
984	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1085	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1086	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1087	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
985		1088
986	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1089	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
987	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1090	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
988	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1091	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
989	current application keymap mode state.	1092	current application keymap mode state.
990		1093
991	The spellings of I<key> can be obtained by using B<xev>(1) command or	1094	Due the the large number of modifier combinations, a key mapping will
992	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1095	match if I<at least> the specified identifiers are being set, and no other
		1096	key mappings with those and more bits are being defined. That means that
		1097	defining a mapping for C<a> will automatically provide definitions for
		1098	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1099	themselves. See the C<builtin:> action, below, for a way to work around
		1100	this when this is a problem.
		1101
		1102	The spelling of I<key> depends on your implementation of X. An easy way to
		1103	find a key name is to use the B<xev>(1) command. You can find a list by
		1104	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
993	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1105	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
994	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1106	value (B<0x0000 - 0xFFFF>).
995	performed in an exact manner; however, the closest match is assured.
996		1107
997	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1108	As with any resource value, the I<action> string may contain backslash
998	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1109	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1110	number), see RESOURCES in C<man 7 X> for further details.
1000	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001	can start or end with whitespace.
1002		1111
1003	Please note that you need to double the C<\> in resource files, as	1112	An action starts with an action prefix that selects a certain type
1004	Xlib itself does it's own de-escaping (you can use C<\033> instead of	1113	of action, followed by a colon. An action string without colons is
1005	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1114	interpreted as a literal string to pass to the tty (as if it was
1006	processing).	1115	prefixed with C<string:>).
1007		1116
1008	You can define a range of keysyms in one shot by providing a I<string>	1117	The following action prefixes are known - extensions can provide
1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1118	additional prefixes:
		1119
		1120	=over 4
		1121
		1122	=item string:STRING
		1123
		1124	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1125	then the remaining C<STRING> will be passed to the program running in the
		1126	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1127	string C<echo rm -rf /> followed by a newline:
		1128
		1129	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1130
		1131	This could in theory be used to completely redefine your keymap.
		1132
		1133	In addition, for actions of this type, you can define a range of
		1134	keysyms in one shot by loading the C<keysym-list> perl extension and
		1135	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1010	should be a character not used by the strings.	1136	the delimiter `/' should be a character not used by the strings.
1011		1137
1012	Its usage can be demonstrated by an example:	1138	Its usage can be demonstrated by an example:
1013		1139
1014	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1140	URxvt.keysym.M-C-0x61: list|\033<|abc|>
1015		1141
1016	The above line is equivalent to the following three lines:	1142	The above line is equivalent to the following three lines:
1017		1143
1018	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1019	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1020	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1021		1147
		1148	=item command:STRING
		1149
1022	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1150	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1023	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1151	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1152	the opposite of C<string:> - instead of sending it to the program running
		1153	in the terminal, it will be treated as if it were program output). This is
		1154	most useful to feed command sequences into @@RXVT_NAME@@.
		1155
1024	example the following means "change the current locale to C<zh_CN.GBK>	1156	For example the following means "change the current locale to C<zh_CN.GBK>
1025	when Control-Meta-c is being pressed":	1157	when Control-Meta-c is being pressed":
1026		1158
1027	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1159	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028		1160
1029	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1161	The following example will map Control-Meta-1 and Control-Meta-2 to
1030	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1162	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1031	manpage. For example, the F<selection> extension (activated via	1163	font-switching at runtime:
1032	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033		1164
1034	URxvt.keysym.M-C-c: perl:selection:rot13	1165	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1166	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1035		1167
1036	Due the the large number of modifier combinations, a defined key mapping	1168	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1037	will match if at I<at least> the specified identifiers are being set, and	1169	info):
1038	no other key mappings with those and more bits are being defined. That
1039	means that defining a key map for C<a> will automatically provide
1040	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041	mappings themselves.
1042		1170
1043	Unfortunately, this will override built-in key mappings. For example	1171	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1172	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1173
		1174	=item builtin:
		1175
		1176	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1177	key binding existed for the key combination. The obvious use is to undo
		1178	the effect of existing bindings. The not so obvious use is to reinstate
		1179	bindings when another binding overrides too many modifiers.
		1180
1044	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1181	For example if you overwrite the C<Insert> key you will disable
1045	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1182	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1046	user-defined keymap using the C<builtin:> replacement:	1183	"holes" into the user-defined keymap using the C<builtin:> replacement:
1047		1184
1048	URxvt.keysym.Insert: <my insert key sequence>	1185	URxvt.keysym.Insert: <my insert key sequence>
1049	URxvt.keysym.S-Insert: builtin:	1186	URxvt.keysym.S-Insert: builtin:
1050		1187
1051	The first line defines a mapping for C<Insert> and I<any> combination	1188	The first line defines a mapping for C<Insert> and I<any> combination
1052	of modifiers. The second line re-establishes the default mapping for	1189	of modifiers. The second line re-establishes the default mapping for
1053	C<Shift-Insert>.	1190	C<Shift-Insert>.
1054		1191
1055	The following example will map Control-Meta-1 and Control-Meta-2 to	1192	=item builtin-string:
1056	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1057	font-switching at runtime:
1058		1193
1059	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1194	This action is mainly useful to restore string mappings for keys that
1060	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1195	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1196	difficult to explain - basically, this action will send the string to the
		1197	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1198	action for it.
1061		1199
1062	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1200	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1063	info):	1201	selection when you press C<Shift-Insert>. With the following bindings, it
		1202	would instead emit the (undocumented, but what applications running in the
		1203	terminal might expect) sequence C<ESC [ 2 $> instead:
1064		1204
1065	URxvt.keysym.M-C-3: command:\033[8;25;80t	1205	URxvt.keysym.S-Insert: builtin-string:
1066	URxvt.keysym.M-C-4: command:\033[8;48;110t	1206	URxvt.keysym.C-S-Insert: builtin:
		1207
		1208	The first line disables the paste functionality for that key
		1209	combination, and the second reinstates the default behaviour for
		1210	C<Control-Shift-Insert>, which would otherwise be overridden.
		1211
		1212	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1213	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1214	this:
		1215
		1216	URxvt.keysym.C-M-c: builtin-string:
		1217	URxvt.keysym.C-M-v: builtin-string:
		1218
		1219	=item EXTENSION:STRING
		1220
		1221	An action of this form invokes the action B<STRING>, if any, provided
		1222	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1223	be loaded automatically if necessary.
		1224
		1225	Not all extensions define actions, but popular extensions that do
		1226	include the I<selection> and I<matcher> extensions (documented in their
		1227	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1228	respectively).
		1229
		1230	From the silly examples department, this will rot13-"encrypt"
		1231	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1232	keyboards:
		1233
		1234	URxvt.keysym.M-C-c: selection:rot13
		1235
		1236	=item perl:STRING *DEPRECATED*
		1237
		1238	This is a deprecated way of invoking commands provided by perl
		1239	extensions. It is still supported, but should not be used anymore.
		1240
		1241	=back
1067		1242
1068	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1069		1244
1070	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1071		1246
…		…
1073	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1074		1249
1075	Extension names can be prefixed with a C<-> sign to prohibit using	1250	Extension names can be prefixed with a C<-> sign to prohibit using
1076	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1077	by default, or specified via the C<perl-ext-common> resource. For	1252	by default, or specified via the C<perl-ext-common> resource. For
1078	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1079	C<selection>.	1254	C<selection>.
1080		1255
1081	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1082	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1083	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1084	multiple times with different arguments will pass multiple arguments to	1259
1085	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1086		1262
1087	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1088	necessary, and bound to the current terminal instance.	1264	necessary, and bound to the current terminal instance. When the library
		1265	search path contains multiple extension files of the same name, then the
		1266	first one found will be used.
1089		1267
1090	If both of these resources are the empty string, then the perl	1268	If both of these resources are the empty string, then the perl interpreter
1091	interpreter will not be initialized. The idea behind two options is that	1269	will not be initialized. The rationale for having two options is that
1092	B<perl-ext-common> will be used for extensions that should be available to	1270	B<perl-ext-common> will be used for extensions that should be available to
1093	all instances, while B<perl-ext> is used for specific instances.	1271	all instances, while B<perl-ext> is used for specific instances.
1094		1272
1095	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1096		1274
1097	Perl code to be evaluated when all extensions have been registered. See	1275	Perl code to be evaluated when all extensions have been registered. See
1098	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1276	the @@RXVT_NAME@@perl(3) manpage.
1099	will be ignored when running setuid/setgid.
1100		1277
1101	=item B<perl-lib>: I<path>	1278	=item B<perl-lib>: I<path>
1102		1279
1103	Colon-separated list of additional directories that hold extension	1280	Colon-separated list of additional directories that hold extension
1104	scripts. When looking for extensions specified by the C<perl> resource,	1281	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1105	@@RXVT_NAME@@ will first look in these directories and then in	1282	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1106	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1283	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1107	will be ignored when running setuid/setgid.
1108		1284
1109	See the @@RXVT_NAME@@perl(3) manpage.	1285	See the @@RXVT_NAME@@perl(3) manpage.
1110		1286
1111	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1287	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112		1288
…		…
1116	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1117		1293
1118	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1119	for details.	1295	for details.
1120		1296
1121	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1122		1298
1123	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1124	(default: C<M-s>).	1300	instead, e.g.:
1125		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
		1303
1126	=item B<urlLauncher>: I<string>	1304	=item B<url-launcher>: I<string>
1127		1305
1128	Specifies the program to be started with a URL argument. Used by the	1306	Specifies the program to be started with a URL argument. Used by the
1129	C<selection-popup> and C<mark-urls> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
1130		1308
1131	=item B<transient-for>: I<windowid>	1309	=item B<transient-for>: I<windowid>
1132		1310
1133	Sets the WM_TRANSIENT_FOR property to the given window iw.	1311	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1312
		1313	=item B<override-redirect>: I<boolean>
		1314
		1315	Compile I<frills>: Sets override-redirect for the terminal window, making
		1316	it almost invisible to window managers; option B<-override-redirect>.
		1317
		1318	=item B<iso14755:> I<boolean>
		1319
		1320	Turn on/off ISO 14755 (default enabled).
		1321
		1322	=item B<iso14755_52:> I<boolean>
		1323
		1324	Turn on/off ISO 14755 5.2 mode (default enabled).
		1325
		1326	=back
		1327
		1328	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1329
		1330	=over 4
		1331
		1332	=item B<-pixmap> I<file[;oplist]>
		1333
		1334	=item B<backgroundPixmap:> I<file[;oplist]>
		1335
		1336	Compile I<pixbuf>: Use the specified image file as the window's
		1337	background and also optionally specify a colon separated list of
		1338	operations to modify it. Note that you may need to quote the C<;>
		1339	character when using the command line option, as C<;> is usually a
		1340	metacharacter in shells. Supported operations are:
		1341
		1342	=over 4
		1343
		1344	=item B<WxH+X+Y>
		1345
		1346	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1347	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1348	scale of 0 disables scaling.
		1349
		1350	=item B<op=tile>
		1351
		1352	enables tiling
		1353
		1354	=item B<op=keep-aspect>
		1355
		1356	maintain the image aspect ratio when scaling
		1357
		1358	=item B<op=root-align>
		1359
		1360	use the position of the terminal window relative to the root window as
		1361	the image offset, simulating a root window background
		1362
		1363	=back
		1364
		1365	The default scale and position setting is C<100x100+50+50>.
		1366	Alternatively, a predefined set of templates can be used to achieve
		1367	the most common setups:
		1368
		1369	=over 4
		1370
		1371	=item B<style=tiled>
		1372
		1373	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1374
		1375	=item B<style=aspect-stretched>
		1376
		1377	the image is scaled to fill the whole window maintaining the aspect
		1378	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1379
		1380	=item B<style=stretched>
		1381
		1382	the image is scaled to fill the whole window. Equivalent to 100x100
		1383
		1384	=item B<style=centered>
		1385
		1386	the image is centered with no scaling. Equivalent to 0x0+50+50
		1387
		1388	=item B<style=root-tiled>
		1389
		1390	the image is tiled with no scaling and using 'root' positioning.
		1391	Equivalent to 0x0:op=tile:op=root-align
		1392
		1393	=back
		1394
		1395	If multiple templates are specified the last one wins. Note that a
		1396	template overrides all the scale, position and operations settings.
		1397
		1398	If used in conjunction with pseudo-transparency, the specified pixmap
		1399	will be blended over the transparent background using alpha-blending.
		1400
		1401	=item B<-tr>|B<+tr>
		1402
		1403	=item B<transparent:> I<boolean>
		1404
		1405	Turn on/off pseudo-transparency by using the root pixmap as background.
		1406
		1407	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1408	will be removed in future versions.
		1409
		1410	=item B<-tint> I<colour>
		1411
		1412	=item B<tintColor:> I<colour>
		1413
		1414	Tint the transparent background with the given colour. Note that a
		1415	black tint yields a completely black image while a white tint yields
		1416	the image unchanged.
		1417
		1418	=item B<-sh> I<number>
		1419
		1420	=item B<shading:> I<number>
		1421
		1422	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1423	A value of 100 means no shading.
		1424
		1425	=item B<-blr> I<HxV>
		1426
		1427	=item B<blurRadius:> I<HxV>
		1428
		1429	Apply gaussian blur with the specified radius to the transparent
		1430	background. If a single number is specified, the vertical and
		1431	horizontal radii are considered to be the same. Setting one of the
		1432	radii to 1 and the other to a large number creates interesting effects
		1433	on some backgrounds. The maximum radius value is 128. An horizontal or
		1434	vertical radius of 0 disables blurring.
		1435
		1436	=item B<path:> I<path>
		1437
		1438	Specify the colon-delimited search path for finding background image files.
1134		1439
1135	=back	1440	=back
1136		1441
1137	=head1 THE SCROLLBAR	1442	=head1 THE SCROLLBAR
1138		1443
…		…
1157	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1462	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1463	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1464	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160	respectively.	1465	respectively.
1161		1466
1162	=head1 TEXT SELECTION AND INSERTION	1467	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163		1468
1164	The behaviour of text selection and insertion mechanism is similar to	1469	The behaviour of text selection and insertion/pasting mechanism is similar
1165	I<xterm>(1).	1470	to I<xterm>(1).
1166		1471
1167	=over 4	1472	=over 4
1168		1473
1169	=item B<Selection>:	1474	=item B<Selecting>:
1170		1475
1171	Left click at the beginning of the region, drag to the end of the region	1476	Left click at the beginning of the region, drag to the end of the region
1172	and release; Right click to extend the marked region; Left double-click	1477	and release; Right click to extend the marked region; Left double-click
1173	to select a word; Left triple-click to select the entire logical line	1478	to select a word; Left triple-click to select the entire logical line
1174	(which can span multiple screen lines), unless modified by resource	1479	(which can span multiple screen lines), unless modified by resource
…		…
1178	(Compile: I<frills>) will create a rectangular selection instead of a	1483	(Compile: I<frills>) will create a rectangular selection instead of a
1179	normal one. In this mode, every selected row becomes its own line in the	1484	normal one. In this mode, every selected row becomes its own line in the
1180	selection, and trailing whitespace is visually underlined and removed from	1485	selection, and trailing whitespace is visually underlined and removed from
1181	the selection.	1486	the selection.
1182		1487
1183	=item B<Insertion>:	1488	=item B<Pasting>:
1184		1489
1185	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1490	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186	an B<@@RXVT_NAME@@> window causes the current text selection to be	1491	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187	inserted as if it had been typed on the keyboard.	1492	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1493
		1494	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1495	inserted too.
		1496
		1497	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1498	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1499	binding causes the value of the internal selection to be copied to the
		1500	CLIPBOARD selection, while the second binding causes the value of the
		1501	CLIPBOARD selection to be inserted.
1188		1502
1189	=back	1503	=back
1190		1504
1191	=head1 CHANGING FONTS	1505	=head1 CHANGING FONTS
1192		1506
…		…
1206		1520
1207	=head1 ISO 14755 SUPPORT	1521	=head1 ISO 14755 SUPPORT
1208		1522
1209	ISO 14755 is a standard for entering and viewing unicode characters	1523	ISO 14755 is a standard for entering and viewing unicode characters
1210	and character codes using the keyboard. It consists of 4 parts. The	1524	and character codes using the keyboard. It consists of 4 parts. The
1211	first part is available rxvt-unicode has been compiled with	1525	first part is available if rxvt-unicode has been compiled with
1212	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1526	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213	with C<--enable-iso14755>.	1527	with C<--enable-iso14755>.
1214		1528
1215	=over 4	1529	=over 4
1216		1530
…		…
1236	This mode lets you input characters representing the keycap symbols of	1550	This mode lets you input characters representing the keycap symbols of
1237	your keyboard, if representable in the current locale encoding.	1551	your keyboard, if representable in the current locale encoding.
1238		1552
1239	Start by pressing C<Control> and C<Shift> together, then releasing	1553	Start by pressing C<Control> and C<Shift> together, then releasing
1240	them. The next special key (cursor keys, home etc.) you enter will not	1554	them. The next special key (cursor keys, home etc.) you enter will not
1241	invoke it's usual function but instead will insert the corresponding	1555	invoke its usual function but instead will insert the corresponding
1242	keycap symbol. The symbol will only be entered when the key has been	1556	keycap symbol. The symbol will only be entered when the key has been
1243	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1557	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244	C<ISO Level 2 Switch>, although your intention might have been to enter a	1558	C<ISO Level 2 Switch>, although your intention might have been to enter a
1245	reverse tab (Shift-Tab).	1559	reverse tab (Shift-Tab).
1246		1560
…		…
1274	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1588	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1275	it can be seen via the I<who(1)> command, and can accept messages. To	1589	it can be seen via the I<who(1)> command, and can accept messages. To
1276	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1590	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1277	on some systems or setgid to root or to some other group on others.	1591	on some systems or setgid to root or to some other group on others.
1278		1592
1279	=head1 COLORS AND GRAPHICS	1593	=head1 COLOURS AND GRAPHICS
1280		1594
1281	In addition to the default foreground and background colours,	1595	In addition to the default foreground and background colours,
1282	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1596	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1283	high-intensity bold/blink versions of the same). Here is a list of the	1597	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1284	colours with their B<rgb.txt> names.	1598	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1599	cube plus a 8 (24) colour greyscale ramp.
		1600
		1601	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1602	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1603	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1604	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1605	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1606	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1607	use many similar 24-bit colours. It's typically not a problem in common
		1608	scenarios.
		1609
		1610	Here is a list of the ANSI colours with their names.
1285		1611
1286	=begin table	1612	=begin table
1287		1613
1288	B<color0> (black) = Black	1614	B<color0> (black) = Black
1289	B<color1> (red) = Red3	1615	B<color1> (red) = Red3
…		…
1309	It is also possible to specify the colour values of B<foreground>,	1635	It is also possible to specify the colour values of B<foreground>,
1310	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1636	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311	a number 0-15, as a convenient shorthand to reference the colour name of	1637	a number 0-15, as a convenient shorthand to reference the colour name of
1312	color0-color15.	1638	color0-color15.
1313		1639
		1640	The following text gives values for the standard 88 colour mode (and
		1641	values for the 256 colour mode in parentheses).
		1642
		1643	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1644
		1645	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1646	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1647
		1648	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1649	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1650	the RGB cube.
		1651
		1652	Together, all those colours implement the 88 (256) colour xterm
		1653	colours. Only the first 16 can be changed using resources currently, the
		1654	rest can only be changed via command sequences ("escape codes").
		1655
		1656	Applications are advised to use terminfo or command sequences to discover
		1657	number and RGB values of all colours (yes, you can query this...).
		1658
1314	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1659	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315	always swapping the foreground/background colours. This is in contrast to	1660	always swapping the foreground/background colours. This is in contrast to
1316	I<xterm>(1) where the colours are only swapped if they have not otherwise	1661	I<xterm>(1) where the colours are only swapped if they have not otherwise
1317	been specified. For example,	1662	been specified. For example,
1318		1663
		1664	@@RXVT_NAME@@ -fg Black -bg White -rv
		1665
		1666	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1667	White.
		1668
		1669	=head2 ALPHA CHANNEL SUPPORT
		1670
		1671	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1672	their act together, rxvt-unicode will do its own alpha channel management:
		1673
		1674	You can prefix any colour with an opaqueness percentage enclosed in
		1675	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1676	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1677	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1678	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1679	is the recommended format to specify transparency values, and works with
		1680	all ways to specify a colour.
		1681
		1682	For complete control, rxvt-unicode also supports
		1683	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1684	specifications, where the additional C<aaaa> component specifies opacity
		1685	(alpha) values. The minimum value of C<0000> is completely transparent,
		1686	while C<ffff> is completely opaque). The two example colours from
		1687	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1688	C<rgba:0000/ff00/0000/f332>.
		1689
		1690	You probably need to specify B<"-depth 32">, too, to force a visual with
		1691	alpha channels, and have the luck that your X-server uses ARGB pixel
		1692	layout, as X is far from just supporting ARGB visuals out of the box, and
		1693	rxvt-unicode just fudges around.
		1694
		1695	For example, the following selects an almost completely transparent black
		1696	background, and an almost opaque pink foreground:
		1697
		1698	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1699
		1700	When not using a background image, then the interpretation of the
		1701	alpha channel is up to your compositing manager (most interpret it as
		1702	transparency of course).
		1703
		1704	When using a background pixmap or pseudo-transparency, then the background
		1705	colour will always behave as if it were completely transparent (so the
		1706	background image shows instead), regardless of how it was specified, while
		1707	other colours will either be transparent as specified (the background
		1708	image will show through) on servers supporting the RENDER extension, or
		1709	fully opaque on servers not supporting the RENDER EXTENSION.
		1710
		1711	Please note that due to bugs in Xft, specifying alpha values might result
		1712	in garbage being displayed when the X-server does not support the RENDER
		1713	extension.
		1714
		1715	=head1 ENVIRONMENT
		1716
		1717	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1718
1319	=over 4	1719	=over 4
1320		1720
1321	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1322
1323	would yield White on Black, while on I<xterm>(1) it would yield Black
1324	on White.
1325
1326	=back
1327
1328	=head1 ENVIRONMENT
1329
1330	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331
1332	=over 4
1333
1334	=item B<TERM>	1721	=item B<TERM>
1335		1722
1336	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1723	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337	resources or on the commandline.	1724	resources or on the command line.
1338		1725
1339	=item B<COLORTERM>	1726	=item B<COLORTERM>
1340		1727
1341	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1728	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342	compiled with XPM support, and optionally with the added extension	1729	compiled with background image support, and optionally with the added
1343	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1730	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1731	screen.
1344		1732
1345	=item B<COLORFGBG>	1733	=item B<COLORFGBG>
1346		1734
1347	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1735	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348	the colour code used as default foreground/text colour (or the string	1736	the colour code used as default foreground/text colour (or the string
1349	C<default> to indicate that the default-colour escape sequence is to be	1737	C<default> to indicate that the default-colour escape sequence is to be
1350	used), C<bg> is the colour code used as default background colour (or the	1738	used), C<bg> is the colour code used as default background colour (or the
1351	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1739	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1740	was compiled with background image support. Libraries like C<ncurses>
1353	(and do) use this information to optimize screen output.	1741	and C<slang> can (and do) use this information to optimize screen output.
1354		1742
1355	=item B<WINDOWID>	1743	=item B<WINDOWID>
1356		1744
1357	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1745	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358	window, which usually has subwindows for the scrollbar, the terminal	1746	window, which usually has subwindows for the scrollbar, the terminal
…		…
1364	C<--with-terminfo=PATH>.	1752	C<--with-terminfo=PATH>.
1365		1753
1366	=item B<DISPLAY>	1754	=item B<DISPLAY>
1367		1755
1368	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1756	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369	display in it's child processes.	1757	display in its child processes if C<-display> isn't used to override. It
		1758	defaults to C<:0> if it doesn't exist.
1370		1759
1371	=item B<SHELL>	1760	=item B<SHELL>
1372		1761
1373	The shell to be used for command execution, defaults to C</bin/sh>.	1762	The shell to be used for command execution, defaults to C</bin/sh>.
1374		1763
1375	=item B<RXVTPATH>
1376
1377	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1378	files.
1379
1380	=item B<PATH>
1381
1382	Used in the same way as C<RXVTPATH>.
1383
1384	=item B<RXVT_SOCKET>	1764	=item B<RXVT_SOCKET> [I<sic>]
1385		1765
1386	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1766	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1387	@@RXVT_NAME@@d(1).	1767	@@RXVT_NAME@@d(1).
1388		1768
1389	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1769	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1770
		1771	=item B<URXVT_PERL_LIB>
		1772
		1773	Additional F<:>-separated library search path for perl extensions. Will be
		1774	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1775	directory.
		1776
		1777	=item B<URXVT_PERL_VERBOSITY>
		1778
		1779	See L<@@RXVT_NAME@@perl>(3).
1390		1780
1391	=item B<HOME>	1781	=item B<HOME>
1392		1782
1393	Used to locate the default directory for the unix domain socket for	1783	Used to locate the default directory for the unix domain socket for
1394	daemon communications and to locate various resource files (such as	1784	daemon communications and to locate various resource files (such as
1395	C<.Xdefaults>)	1785	C<.Xdefaults>)
1396		1786
1397	=item B<XAPPLRESDIR>	1787	=item B<XAPPLRESDIR>
1398		1788
1399	Directory where various X resource files are being located.	1789	Directory where application-specific X resource files are located.
1400		1790
1401	=item B<XENVIRONMENT>	1791	=item B<XENVIRONMENT>
1402		1792
1403	If set and accessible, gives the name of a X resource file to be loaded by	1793	If set and accessible, gives the name of a X resource file to be loaded by
1404	@@RXVT_NAME@@.	1794	@@RXVT_NAME@@.
…		…
1409		1799
1410	=over 4	1800	=over 4
1411		1801
1412	=item B</usr/lib/X11/rgb.txt>	1802	=item B</usr/lib/X11/rgb.txt>
1413		1803
1414	Color names.	1804	Colour names.
1415		1805
1416	=back	1806	=back
1417		1807
1418	=head1 SEE ALSO	1808	=head1 SEE ALSO
1419		1809
		1810	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1420	@@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)	1811	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1421		1812
1422	=head1 CURRENT PROJECT COORDINATOR	1813	=head1 CURRENT PROJECT COORDINATOR
1423		1814
1424	=over 4	1815	=over 4
1425		1816
1426	=item Project Coordinator	1817	=item Project Coordinator
1427		1818
1428	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1819	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1429		1820
1430	L<http://software.schmorp.de/#rxvt-unicode>	1821	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1431		1822
1432	=back	1823	=back
1433		1824
1434	=head1 AUTHORS	1825	=head1 AUTHORS
1435		1826
…		…
1437		1828
1438	=item John Bovey	1829	=item John Bovey
1439		1830
1440	University of Kent, 1992, wrote the original Xvt.	1831	University of Kent, 1992, wrote the original Xvt.
1441		1832
1442	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1833	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1443		1834
1444	very heavily modified Xvt and came up with Rxvt	1835	very heavily modified Xvt and came up with Rxvt
1445		1836
1446	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1837	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1447		1838
1448	wrote the Greek Keyboard Input (no longer in code)	1839	wrote the Greek Keyboard Input (no longer in code)
1449		1840
1450	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1841	=item mj olesen <olesen@me.QueensU.CA>
1451		1842
1452	Wrote the menu system.	1843	Wrote the menu system.
1453		1844
1454	Project Coordinator (changes.txt 2.11 to 2.21)	1845	Project Coordinator (changes.txt 2.11 to 2.21)
1455		1846
1456	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1847	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1457		1848
1458	Project Coordinator (changes.txt 2.21a to 2.4.5)	1849	Project Coordinator (changes.txt 2.21a to 2.4.5)
1459		1850
1460	=item Geoff Wing L<< <gcw@pobox.com> >>	1851	=item Geoff Wing <gcw@pobox.com>
1461		1852
1462	Rewrote screen display and text selection routines. Project Coordinator	1853	Rewrote screen display and text selection routines.
		1854
1463	(changes.txt 2.4.6 - rxvt-unicode)	1855	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1464		1856
1465	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1857	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1466		1858
1467	Forked rxvt-unicode, rewrote most of the display code and internal	1859	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1468	character handling to store text in unicode, improve xterm	1860	extension, random hacks, numerous bugfixes and extensions.
1469	compatibility and apply numerous other bugfixes and extensions.
1470		1861
1471	Project Coordinator (Changes 1.0 -)	1862	Project Coordinator (Changes 1.0 -)
1472		1863
		1864	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1865
		1866	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1867
1473	=back	1868	=back
1474		1869

Diff Legend

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