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.92 by root, Wed Jan 11 02:13:55 2006 UTC vs.
Revision 1.241 by root, Wed Dec 17 15:22:10 2014 UTC

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

Diff Legend

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