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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 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/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
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. 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 right-to-left 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 user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
81	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1	84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
82	Orange'.	85	Orange'.
83		86
84	The following options are available:	87	The following options are available:
85		88
86	=over 4	89	=over
87		90
88	=item B<-help>, B<--help>	91	=item B<-help>, B<--help>
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.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		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.
		116
103	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
104		118
105	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
106		120
107	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
114		128
115	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
116		130
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		132
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	133	=item B<-fps> I<number>
120		134
121	Turn on/off inheriting parent window's pixmap. Alternative form is	135	Compile I<frills>: Set the refresh interval (in frames per second or
122	B<-tr>; resource B<inheritPixmap>.	136	negative seconds); resource B<refreshRate>.
123
124	I<Please address all transparency related issues to Sasha Vasko at
125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
126		137
127	=item B<-fade> I<number>	138	=item B<-fade> I<number>
128		139
129	Fade the text by the given percentage when focus is lost. Small values	140	Fade the text by the given percentage when focus is lost. Small values
130	fade a little only, 100 completely replaces all colours by the fade	141	fade a little only, 100 completely replaces all colours by the fade
…		…
133	=item B<-fadecolor> I<colour>	144	=item B<-fadecolor> I<colour>
134		145
135	Fade to this colour when fading is used (see B<-fade>). The default colour	146	Fade to this colour when fading is used (see B<-fade>). The default colour
136	is opaque black. resource B<fadeColor>.	147	is opaque black. resource B<fadeColor>.
137		148
138	=item B<-tint> I<colour>	149	=item B<-icon> I<file>
139		150
140	Tint the transparent background pixmap with the given colour when	151	Compile I<pixbuf>: Use the specified image as application icon. This
141	transparency is enabled with B<-tr> or B<-ip>. This only works for	152	is used by many window managers, taskbars and pagers to represent the
142	non-tiled backgrounds, currently. See also the B<-sh> option that can be	153	application window; resource I<iconFile>.
143	used to brighten or darken the image in addition to tinting it.
144	Please note that certain tint colours can be applied on the server-side,
145	thus yielding performance gain of two orders of magnitude. These colours are:
146	blue, red, green, cyan, magenta, yellow, and those close to them; resource
147	I<tintColor>. Example:
148
149	@@RXVT_NAME@@ -tr -tint blue -sh 40
150
151	=item B<-sh> I<number>
152
153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
154	background image in addition to (or instead of) tinting it;
155	resource I<shading>.
156
157	=item B<-blt> I<string>
158
159	Specify background blending type. If background pixmap is specified
160	at the same time as transparency - such pixmap will be blended over
161	transparency image, using method specified. Supported values are :
162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165	alpha-blending; resource I<blendType>.
166
167	=item B<-blr> I<HxV>
168
169	Apply Gaussian Blur with the specified radii to the transparent
170	background image. If single number is specified - both vertical and
171	horizontal radii are considered to be the same. Setting one of the
172	radii to 1 and another to a large number creates interesting effects
173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
174		154
175	=item B<-bg> I<colour>	155	=item B<-bg> I<colour>
176		156
177	Window background colour; resource B<background>.	157	Window background colour; resource B<background>.
178		158
179	=item B<-fg> I<colour>	159	=item B<-fg> I<colour>
180		160
181	Window foreground colour; resource B<foreground>.	161	Window foreground colour; resource B<foreground>.
182
183	=item B<-pixmap> I<file[;geom]>
184
185	Compile I<afterimage>: Specify image file for the background and also
186	optionally specify its scaling with a geometry string. Note you may need to
187	add quotes to avoid special shell interpretation of the C<;> in the
188	command-line; for more details see resource B<backgroundPixmap>.
189		162
190	=item B<-cr> I<colour>	163	=item B<-cr> I<colour>
191		164
192	The cursor colour; resource B<cursorColor>.	165	The cursor colour; resource B<cursorColor>.
193		166
…		…
238	italic> >> characters are to be printed. See resource B<boldItalicFont>	211	italic> >> characters are to be printed. See resource B<boldItalicFont>
239	for details.	212	for details.
240		213
241	=item B<-is>\|B<+is>	214	=item B<-is>\|B<+is>
242		215
243	Compile I<font-styles>: Bold/Italic font styles imply high intensity	216	Compile I<font-styles>: Bold/Blink font styles imply high intensity
244	foreground/background (default). See resource B<intensityStyles> for	217	foreground/background (default). See resource B<intensityStyles> for
245	details.	218	details.
246		219
247	=item B<-name> I<name>	220	=item B<-name> I<name>
248		221
…		…
252		225
253	=item B<-ls>\|B<+ls>	226	=item B<-ls>\|B<+ls>
254		227
255	Start as a login-shell/sub-shell; resource B<loginShell>.	228	Start as a login-shell/sub-shell; resource B<loginShell>.
256		229
		230	=item B<-mc> I<milliseconds>
		231
		232	Specify the maximum time between multi-click selections.
		233
257	=item B<-ut>\|B<+ut>	234	=item B<-ut>\|B<+ut>
258		235
259	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	236	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
260	B<utmpInhibit>.	237	B<utmpInhibit>.
261		238
…		…
265	B<visualBell>.	242	B<visualBell>.
266		243
267	=item B<-sb>\|B<+sb>	244	=item B<-sb>\|B<+sb>
268		245
269	Turn on/off scrollbar; resource B<scrollBar>.	246	Turn on/off scrollbar; resource B<scrollBar>.
		247
		248	=item B<-sr>\|B<+sr>
		249
		250	Put scrollbar on right/left; resource B<scrollBar_right>.
		251
		252	=item B<-st>\|B<+st>
		253
		254	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		255	resource B<scrollBar_floating>.
270		256
271	=item B<-si>\|B<+si>	257	=item B<-si>\|B<+si>
272		258
273	Turn on/off scroll-to-bottom on TTY output inhibit; resource	259	Turn on/off scroll-to-bottom on TTY output inhibit; resource
274	B<scrollTtyOutput> has opposite effect.	260	B<scrollTtyOutput> has opposite effect.
…		…
281	=item B<-sw>\|B<+sw>	267	=item B<-sw>\|B<+sw>
282		268
283	Turn on/off scrolling with the scrollback buffer as new lines appear.	269	Turn on/off scrolling with the scrollback buffer as new lines appear.
284	This only takes effect if B<-si> is also given; resource	270	This only takes effect if B<-si> is also given; resource
285	B<scrollWithBuffer>.	271	B<scrollWithBuffer>.
286
287	=item B<-sr>\|B<+sr>
288
289	Put scrollbar on right/left; resource B<scrollBar_right>.
290
291	=item B<-st>\|B<+st>
292
293	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294	resource B<scrollBar_floating>.
295		272
296	=item B<-ptab>\|B<+ptab>	273	=item B<-ptab>\|B<+ptab>
297		274
298	If enabled (default), "Horizontal Tab" characters are being stored as	275	If enabled (default), "Horizontal Tab" characters are being stored as
299	actual wide characters in the screen buffer, which makes it possible to	276	actual wide characters in the screen buffer, which makes it possible to
…		…
303		280
304	=item B<-bc>\|B<+bc>	281	=item B<-bc>\|B<+bc>
305		282
306	Blink the cursor; resource B<cursorBlink>.	283	Blink the cursor; resource B<cursorBlink>.
307		284
		285	=item B<-uc>\|B<+uc>
		286
		287	Make the cursor underlined; resource B<cursorUnderline>.
		288
308	=item B<-iconic>	289	=item B<-iconic>
309		290
310	Start iconified, if the window manager supports that option.	291	Start iconified, if the window manager supports that option.
311	Alternative form is B<-ic>.	292	Alternative form is B<-ic>.
312		293
…		…
328		309
329	=item B<-bl>	310	=item B<-bl>
330		311
331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	312	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
332	if honoured by the WM, the rxvt-unicode window will not have window	313	if honoured by the WM, the rxvt-unicode window will not have window
333	decorations; resource B<borderLess>.	314	decorations; resource B<borderLess>. If the window manager does not
		315	support MWM hints (e.g. kwin), enables override-redirect mode.
334		316
335	=item B<-override-redirect>	317	=item B<-override-redirect>
336		318
337	Compile I<frills>: Sets override-redirect on the window; resource	319	Compile I<frills>: Sets override-redirect on the window; resource
338	B<override-redirect>.	320	B<override-redirect>.
		321
		322	=item B<-dockapp>
		323
		324	Sets the initial state of the window to WithdrawnState, which makes
		325	window managers that support this extension treat it as a dockapp.
339		326
340	=item B<-sbg>	327	=item B<-sbg>
341		328
342	Compile I<frills>: Disable the usage of the built-in block graphics/line	329	Compile I<frills>: Disable the usage of the built-in block graphics/line
343	drawing characters and just rely on what the specified fonts provide. Use	330	drawing characters and just rely on what the specified fonts provide. Use
…		…
347	=item B<-lsp> I<number>	334	=item B<-lsp> I<number>
348		335
349	Compile I<frills>: Lines (pixel height) to insert between each row of	336	Compile I<frills>: Lines (pixel height) to insert between each row of
350	the display. Useful to work around font rendering problems; resource	337	the display. Useful to work around font rendering problems; resource
351	B<lineSpace>.	338	B<lineSpace>.
		339
		340	=item B<-letsp> I<number>
		341
		342	Compile I<frills>: Amount to adjust the computed character width by
		343	to control overall letter spacing. Negative values will tighten up the
		344	letter spacing, positive values will space letters out more. Useful to
		345	work around odd font metrics; resource B<letterSpace>.
352		346
353	=item B<-tn> I<termname>	347	=item B<-tn> I<termname>
354		348
355	This option specifies the name of the terminal type to be set in the	349	This option specifies the name of the terminal type to be set in the
356	B<TERM> environment variable. This terminal type must exist in the	350	B<TERM> environment variable. This terminal type must exist in the
…		…
391	=item B<-pt> I<style>	385	=item B<-pt> I<style>
392		386
393	Compile I<XIM>: input style for input method; B<OverTheSpot>,	387	Compile I<XIM>: input style for input method; B<OverTheSpot>,
394	B<OffTheSpot>, B<Root>; resource B<preeditType>.	388	B<OffTheSpot>, B<Root>; resource B<preeditType>.
395		389
		390	If the perl extension C<xim-onthespot> is used (which is the default),
		391	then additionally the C<OnTheSpot> preedit type is available.
		392
396	=item B<-im> I<text>	393	=item B<-im> I<text>
397		394
398	Compile I<XIM>: input method name. resource B<inputMethod>.	395	Compile I<XIM>: input method name. resource B<inputMethod>.
399		396
400	=item B<-imlocale> I<string>	397	=item B<-imlocale> I<string>
…		…
411		408
412	=item B<-tcw>	409	=item B<-tcw>
413		410
414	Change the meaning of triple-click selection with the left mouse	411	Change the meaning of triple-click selection with the left mouse
415	button. Only effective when the original (non-perl) selection code is	412	button. Only effective when the original (non-perl) selection code is
416	in-use. Instead of selecting a full line it will extend the selection the	413	in-use. Instead of selecting a full line it will extend the selection to
417	end of the logical line only. resource B<tripleclickwords>.	414	the end of the logical line only. resource B<tripleclickwords>.
		415
		416	=item B<-dpb>\|B<+dpb>
		417
		418	Compile frills: Disable (or enable) emitting bracketed paste mode
		419	sequences (default enabled). Bracketed paste mode allows programs
		420	to detect when something is pasted. Since more and more programs
		421	abuse this, these sequences can be disabled. The command sequences to
		422	enable and query paste mode will still work, but the actual bracket
		423	sequences will no longer be emitted. You can also toggle this from the
		424	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
418		425
419	=item B<-insecure>	426	=item B<-insecure>
420		427
421	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
422	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
435		442
436	=item B<-ssr>\|B<+ssr>	443	=item B<-ssr>\|B<+ssr>
437		444
438	Turn on/off secondary screen scroll (default enabled); resource	445	Turn on/off secondary screen scroll (default enabled); resource
439	B<secondaryScroll>.	446	B<secondaryScroll>.
		447
		448	=item B<-rm> I<mode>
		449
		450	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		451	to one of B<auto> (the default), B<always> or B<never>. The latter two
		452	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		453	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		454	B<rewrapMode>.
440		455
441	=item B<-hold>\|B<+hold>	456	=item B<-hold>\|B<+hold>
442		457
443	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	458	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
444	will not immediately destroy its window when the program executed within	459	will not immediately destroy its window when the program executed within
445	it exits. Instead, it will wait till it is being killed or closed by the	460	it exits. Instead, it will wait till it is being killed or closed by the
446	user; resource B<hold>.	461	user; resource B<hold>.
		462
		463	=item B<-cd> I<path>
		464
		465	Sets the working directory for the shell (or the command specified via
		466	B<-e>). The I<path> must be an absolute path and it must exist for
		467	@@RXVT_NAME@@ to start; resource B<chdir>.
		468
		469	=item B<-xrm> I<string>
		470
		471	Works like the X Toolkit option of the same name, by adding the I<string>
		472	as if it were specified in a resource file. Resource values specified this
		473	way take precedence over all other resource specifications.
		474
		475	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		476	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		477	options can be specified as long-options on the commandline, so use
		478	of B<-xrm> is mostly limited to cases where you want to specify other
		479	resources (e.g. for input methods) or for compatibility with other
		480	programs.
447		481
448	=item B<-keysym.>I<sym> I<string>	482	=item B<-keysym.>I<sym> I<string>
449		483
450	Remap a key symbol. See resource B<keysym>.	484	Remap a key symbol. See resource B<keysym>.
451		485
…		…
486	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	520	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
487	entries and will not tinker with pty/tty permissions - you have to do that	521	entries and will not tinker with pty/tty permissions - you have to do that
488	yourself if you want that.	522	yourself if you want that.
489		523
490	As an extremely special case, specifying C<-1> will completely suppress	524	As an extremely special case, specifying C<-1> will completely suppress
491	pty/tty operations.	525	pty/tty operations, which is probably only useful in conjunction with some
		526	perl extension that manages the terminal.
492		527
493	Here is a example in perl that illustrates how this option can be used (a	528	Here is a example in perl that illustrates how this option can be used (a
494	longer example is in F<doc/pty-fd>):	529	longer example is in F<doc/pty-fd>):
495		530
496	use IO::Pty;	531	use IO::Pty;
…		…
503		538
504	# now communicate with rxvt	539	# now communicate with rxvt
505	my $slave = $pty->slave;	540	my $slave = $pty->slave;
506	while (<$slave>) { print $slave "got <$_>\n" }	541	while (<$slave>) { print $slave "got <$_>\n" }
507		542
		543	Note that, despite what the name might imply, the file descriptor does not
		544	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		545	domain or tcp socket). While tty operations cannot be done in this case,
		546	B<@@RXVT_NAME@@> can still be remote controlled with it:
		547
		548	use Socket;
		549	use Fcntl;
		550
		551	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		552	fcntl $slave, Fcntl::F_SETFD, 0;
		553	system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
		554	close $slave;
		555
		556	syswrite $URXVT, "Type a secret password: ";
		557	my $secret = do { local $/ = "\r"; <$URXVT> };
		558	print "Not so secret anymore: $secret\n";
		559
508	=item B<-pe> I<string>	560	=item B<-pe> I<string>
509		561
510	Comma-separated list of perl extension scripts to use (or not to use) in	562	Comma-separated list of perl extension scripts to use (or not to use) in
511	this terminal instance. See resource B<perl-ext> for details.	563	this terminal instance. See resource B<perl-ext> for details.
512		564
513	=back	565	=back
514		566
515	=head1 RESOURCES (available also as long-options)	567	=head1 RESOURCES
516		568
517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	569	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518	options) compiled into your version.	570	options) compiled into your version. All resources are also available as
		571	long-options.
519		572
520	You can set and change the resources using X11 tools like B<xrdb>. Many	573	You can set and change the resources using X11 tools like B<xrdb>. Many
521	distribution do also load settings from the B<~/.Xresources> file when X	574	distribution do also load settings from the B<~/.Xresources> file when X
522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	575	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523	with later settings overwriting earlier ones:	576	with later settings overwriting earlier ones:
524		577
525	1. system-wide app-defaults file, either locale-dependent OR global
526	2. app-defaults file in $XAPPLRESDIR	578	1. app-defaults file in $XAPPLRESDIR
		579	2. $HOME/.Xdefaults
527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	580	3. RESOURCE_MANAGER property on root-window of screen 0
528	4. SCREEN_RESOURCES for the current screen	581	4. SCREEN_RESOURCES property on root-window of the current screen
529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	582	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		583	6. resources specified via -xrm on the commandline
530		584
531	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	585	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
532	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	586	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
533	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	587	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
534	configured, while the class name B<URxvt> allows resources unique to	588	configured, while the class name B<URxvt> allows resources unique to
…		…
537	be used. Command-line arguments can be used to override resource	591	be used. Command-line arguments can be used to override resource
538	settings. The following resources are supported (you might want to	592	settings. The following resources are supported (you might want to
539	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	593	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
540	extensions not documented here):	594	extensions not documented here):
541		595
542	=over 4	596	=over
543		597
544	=item B<depth:> I<bitdepth>	598	=item B<depth:> I<bitdepth>
545		599
546	Compile I<xft>: Attempt to find a visual with the given bit depth;	600	Compile I<xft>: Attempt to find a visual with the given bit depth;
547	option B<-depth>.	601	option B<-depth>.
		602
		603	=item B<buffered:> I<boolean>
		604
		605	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		606	On some card/driver combination enabling it slightly decreases
		607	performance, on most it greatly helps it. The slowdown is small, so it
		608	should normally be enabled.
548		609
549	=item B<geometry:> I<geom>	610	=item B<geometry:> I<geom>
550		611
551	Create the window with the specified X window geometry [default 80x24];	612	Create the window with the specified X window geometry [default 80x24];
552	option B<-geometry>.	613	option B<-geometry>.
…		…
566	Use the specified colour for the colour value I<n>, where 0-7	627	Use the specified colour for the colour value I<n>, where 0-7
567	corresponds to low-intensity (normal) colours and 8-15 corresponds to	628	corresponds to low-intensity (normal) colours and 8-15 corresponds to
568	high-intensity (bold = bright foreground, blink = bright background)	629	high-intensity (bold = bright foreground, blink = bright background)
569	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	630	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
570	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	631	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
571	names used are listed in the B<COLORS AND GRAPHICS> section.	632	names used are listed in the B<COLOURS AND GRAPHICS> section.
572		633
573	Colours higher than 15 cannot be set using resources (yet), but can be	634	Colours higher than 15 cannot be set using resources (yet), but can be
574	changed using an escape command (see @@RXVT_NAME@@(7)).	635	changed using an escape command (see @@RXVT_NAME@@(7)).
575		636
576	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	637	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
587	=item B<colorUL:> I<colour>	648	=item B<colorUL:> I<colour>
588		649
589	Use the specified colour to display underlined characters when the	650	Use the specified colour to display underlined characters when the
590	foreground colour is the default.	651	foreground colour is the default.
591		652
592	=item B<colorRV:> I<colour>
593
594	Use the specified colour as the background for reverse video characters
595	when OPTION_HC is disabled (--disable-frills).
596
597	=item B<underlineColor:> I<colour>	653	=item B<underlineColor:> I<colour>
598		654
599	If set, use the specified colour as the colour for the underline	655	If set, use the specified colour as the colour for the underline
600	itself. If unset, use the foreground colour.	656	itself. If unset, use the foreground colour.
		657
		658	=item B<highlightColor:> I<colour>
		659
		660	If set, use the specified colour as the background for highlighted
		661	characters. If unset, use reverse video.
		662
		663	=item B<highlightTextColor:> I<colour>
		664
		665	If set and highlightColor is set, use the specified colour as the
		666	foreground for highlighted characters.
601		667
602	=item B<cursorColor:> I<colour>	668	=item B<cursorColor:> I<colour>
603		669
604	Use the specified colour for the cursor. The default is to use the	670	Use the specified colour for the cursor. The default is to use the
605	foreground colour; option B<-cr>.	671	foreground colour; option B<-cr>.
…		…
612		678
613	=item B<reverseVideo:> I<boolean>	679	=item B<reverseVideo:> I<boolean>
614		680
615	B<True>: simulate reverse video by foreground and background colours;	681	B<True>: simulate reverse video by foreground and background colours;
616	option B<-rv>. B<False>: regular screen colours [default]; option	682	option B<-rv>. B<False>: regular screen colours [default]; option
617	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	683	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
618		684
619	=item B<jumpScroll:> I<boolean>	685	=item B<jumpScroll:> I<boolean>
620		686
621	B<True>: specify that jump scrolling should be used. When receiving lots	687	B<True>: specify that jump scrolling should be used. When receiving lots
622	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	688	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
636		702
637	B<False>: specify that everything is to be displayed, even	703	B<False>: specify that everything is to be displayed, even
638	if the refresh is too fast for the human eye to read anything (or the	704	if the refresh is too fast for the human eye to read anything (or the
639	monitor to display anything); option B<+ss>.	705	monitor to display anything); option B<+ss>.
640		706
641	=item B<inheritPixmap:> I<boolean>	707	=item B<refreshRate:> I<number>
642		708
643	B<True>: make the background inherit the parent windows' pixmap, giving	709	Compile I<frills>: When positive, sets the maximum refreshes per second
644	artificial transparency. B<False>: do not inherit the parent windows'	710	(the default is C<60>). When zero or negative, sets the minimum interval
645	pixmap.	711	between refreshes, negated. That is, positive numbers limit the number
646		712	of refreshes per second to that number, similar to a fps limiter in
647	I<Please note that transparency of any kind if completely unsupported by	713	games. A negative number gets negated and directly sets the minimum
648	the author. Don't bug him with installation questions!>	714	interval between refreshes, that is, C<10> and C<-0.1> both specify
		715	the same refresh interval (likewise C<50> and C<0.02>). Finally, zero
		716	makes @@RXVT_NAME@@ refresh as fast as possible. Fractional values are
		717	supported; option B<-fps>.
649		718
650	=item B<fading:> I<number>	719	=item B<fading:> I<number>
651		720
652	Fade the text by the given percentage when focus is lost; option B<-fade>.	721	Fade the text by the given percentage when focus is lost; option B<-fade>.
653		722
654	=item B<fadeColor:> I<colour>	723	=item B<fadeColor:> I<colour>
655		724
656	Fade to this colour, when fading is used (see B<fading:>). The default	725	Fade to this colour, when fading is used (see B<fading:>). The default
657	colour is black; option B<-fadecolor>.	726	colour is black; option B<-fadecolor>.
658		727
659	=item B<tintColor:> I<colour>	728	=item B<iconFile:> I<file>
660		729
661	Tint the transparent background pixmap with the given colour; option	730	Set the application icon pixmap; option B<-icon>.
662	B<-tint>.
663
664	=item B<shading:> I<number>
665
666	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
667	in addition to tinting it; option B<-sh>.
668
669	=item B<blendType:> I<string>
670
671	Specify background blending type; option B<-blt>.
672
673	=item B<blurRadius:> I<number>
674
675	Apply Gaussian Blurr with the specified radius to the transparent
676	background image; option B<-blr>.
677		731
678	=item B<scrollColor:> I<colour>	732	=item B<scrollColor:> I<colour>
679		733
680	Use the specified colour for the scrollbar [default #B2B2B2].	734	Use the specified colour for the scrollbar [default #B2B2B2].
681		735
…		…
686		740
687	=item B<borderColor:> I<colour>	741	=item B<borderColor:> I<colour>
688		742
689	The colour of the border around the text area and between the scrollbar	743	The colour of the border around the text area and between the scrollbar
690	and the text.	744	and the text.
691
692	=item B<backgroundPixmap:> I<file[;geom]>
693
694	Use the specified image file for the background and also optionally
695	specify its scaling with a geometry string B<WxH+X+Y>,
696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
697	and B<"X" / "Y"> locate the image centre (percent).
698	A scale of 0 displays the image with tiling. A scale of 1 displays the
699	image without any scaling. A scale of 2 to 9 specifies an integer
700	number of images in that direction. No image will be magnified beyond
701	10 times its original size. The maximum permitted scale is 1000.
702	Special string of B<"auto"> used as a geometry will cause image to be
703	automatically scaled to match window size.
704	If used in conjunction with B<-tr> option - specified pixmap will be
705	blended over transparency image using either alpha-blending, or any
706	other blending type, specified with B<-blt "type"> option.
707	[default 0x0+50+50]
708
709	=item B<path:> I<path>
710
711	Specify the colon-delimited search path for finding background image files.
712		745
713	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
714		747
715	Select the fonts to be used. This is a comma separated list of font names	748	Select the fonts to be used. This is a comma separated list of font names
716	that are checked in order when trying to find glyphs for characters. The	749	that are checked in order when trying to find glyphs for characters. The
…		…
739	it is named first) and thus defines the character cell grid to be 9 pixels	772	it is named first) and thus defines the character cell grid to be 9 pixels
740	wide and 15 pixels high.	773	wide and 15 pixels high.
741		774
742	The second font is just used to add additional unicode characters not in	775	The second font is just used to add additional unicode characters not in
743	the base font, likewise the third, which is unfortunately non-bold, but	776	the base font, likewise the third, which is unfortunately non-bold, but
744	the bold version of the font does contain less characters, so this is a	777	the bold version of the font does contain fewer characters, so this is a
745	useful supplement.	778	useful supplement.
746		779
747	The third font is an Xft font with aliasing turned off, and the characters	780	The third font is an Xft font with aliasing turned off, and the characters
748	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	781	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
749	contains other characters, but we are not interested in them.	782	contains other characters, but we are not interested in them.
…		…
773	text font will being used for the given style.	806	text font will being used for the given style.
774		807
775	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
776		809
777	When font styles are not enabled, or this option is enabled (B<True>,	810	When font styles are not enabled, or this option is enabled (B<True>,
778	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
779	intensity foreground/background colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
780	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
781	reachable.	814	reachable.
782		815
783	=item B<selectstyle:> I<mode>
784
785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
786	is xterm style with 2.20 old word selection, or anything else which
787	gives xterm style selection. Only effective when the original (non-perl)
788	selection code is in use.
789
790	=item B<scrollstyle:> I<mode>
791
792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793	the author's favourite.
794
795	=item B<title:> I<string>	816	=item B<title:> I<string>
796		817
797	Set window title string, the default title is the command-line	818	Set window title string, the default title is the command-line
798	specified after the B<-e> option, if any, otherwise the application	819	specified after the B<-e> option, if any, otherwise the application
799	name; option B<-title>.	820	name; option B<-title>.
…		…
812	=item B<urgentOnBell:> I<boolean>	833	=item B<urgentOnBell:> I<boolean>
813		834
814	B<True>: set the urgency hint for the wm on receipt of a bell character.	835	B<True>: set the urgency hint for the wm on receipt of a bell character.
815	B<False>: do not set the urgency hint [default].	836	B<False>: do not set the urgency hint [default].
816		837
		838	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		839
817	=item B<visualBell:> I<boolean>	840	=item B<visualBell:> I<boolean>
818		841
819	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	842	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
820	B<False>: no visual bell [default]; option B<+vb>.	843	B<False>: no visual bell [default]; option B<+vb>.
821		844
…		…
823		846
824	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	847	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
825	the shell; option B<-ls>. B<False>: start as a normal sub-shell	848	the shell; option B<-ls>. B<False>: start as a normal sub-shell
826	[default]; option B<+ls>.	849	[default]; option B<+ls>.
827		850
		851	=item B<multiClickTime:> I<number>
		852
		853	Specify the maximum time in milliseconds between multi-click select
		854	events. The default is 500 milliseconds; option B<-mc>.
		855
828	=item B<utmpInhibit:> I<boolean>	856	=item B<utmpInhibit:> I<boolean>
829		857
830	B<True>: inhibit writing record into the system log file B<utmp>;	858	B<True>: inhibit writing record into the system log file B<utmp>;
831	option B<-ut>. B<False>: write record into the system log file B<utmp>	859	option B<-ut>. B<False>: write record into the system log file B<utmp>
832	[default]; option B<+ut>.	860	[default]; option B<+ut>.
…		…
844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845		873
846	This creates a new file in your home directory with the screen contents	874	This creates a new file in your home directory with the screen contents
847	every time you hit C<Print>.	875	every time you hit C<Print>.
848		876
		877	=item B<scrollstyle:> I<mode>
		878
		879	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		880	the author's favourite.
		881
		882	=item B<thickness:> I<number>
		883
		884	Set the scrollbar width in pixels.
		885
849	=item B<scrollBar:> I<boolean>	886	=item B<scrollBar:> I<boolean>
850		887
851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	888	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852	disable the scrollbar; option B<+sb>.	889	disable the scrollbar; option B<+sb>.
853		890
…		…
866	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	903	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
867	thumb with the pointer on middle button press/drag.	904	thumb with the pointer on middle button press/drag.
868		905
869	=item B<scrollTtyOutput:> I<boolean>	906	=item B<scrollTtyOutput:> I<boolean>
870		907
871	B<True>: scroll to bottom when tty receives output; option B<-si>.	908	B<True>: scroll to bottom when tty receives output; option B<+si>.
872	B<False>: do not scroll to bottom when tty receives output; option	909	B<False>: do not scroll to bottom when tty receives output; option
873	B<+si>.	910	B<-si>.
874		911
875	=item B<scrollWithBuffer:> I<boolean>	912	=item B<scrollWithBuffer:> I<boolean>
876		913
877	B<True>: scroll with scrollback buffer when tty receives new lines (and	914	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
878	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	915	try to show the same lines) and B<scrollTtyOutput> is False; option
879	with scrollback buffer when tty receives new lines; option B<+sw>.	916	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		917	new lines; option B<+sw>.
880		918
881	=item B<scrollTtyKeypress:> I<boolean>	919	=item B<scrollTtyKeypress:> I<boolean>
882		920
883	B<True>: scroll to bottom when a non-special key is pressed. Special keys	921	B<True>: scroll to bottom when a non-special key is pressed. Special keys
884	are those which are intercepted by rxvt-unicode for special handling and	922	are those which are intercepted by rxvt-unicode for special handling and
885	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	923	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
886	bottom when a non-special key is pressed; option B<+sk>.	924	bottom when a non-special key is pressed; option B<+sk>.
887		925
888	=item B<saveLines:> I<number>	926	=item B<saveLines:> I<number>
889		927
890	Save I<number> lines in the scrollback buffer [default 64]. This	928	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
891	resource is limited on most machines to 65535; option B<-sl>.
892		929
893	=item B<internalBorder:> I<number>	930	=item B<internalBorder:> I<number>
894		931
895	Internal border of I<number> pixels. This resource is limited to 100;	932	Internal border of I<number> pixels. This resource is limited to 100;
896	option B<-b>.	933	option B<-b>.
…		…
940	=item B<cursorBlink:> I<boolean>	977	=item B<cursorBlink:> I<boolean>
941		978
942	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	979	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
943	option B<-bc>.	980	option B<-bc>.
944		981
		982	=item B<cursorUnderline:> I<boolean>
		983
		984	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		985	option B<-uc>.
		986
945	=item B<pointerBlank:> I<boolean>	987	=item B<pointerBlank:> I<boolean>
946		988
947	B<True>: blank the pointer when a key is pressed or after a set number	989	B<True>: blank the pointer when a key is pressed or after a set number
948	of seconds of inactivity. B<False>: the pointer is always visible	990	of seconds of inactivity. B<False>: the pointer is always visible
949	[default].	991	[default].
…		…
954		996
955	=item B<pointerColor2:> I<colour>	997	=item B<pointerColor2:> I<colour>
956		998
957	Mouse pointer background colour.	999	Mouse pointer background colour.
958		1000
		1001	=item B<pointerShape:> I<string>
		1002
		1003	Compile I<frills>: Specifies the name of the mouse pointer shape
		1004	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		1005	file for possible values (omit the C<XC_> prefix).
		1006
959	=item B<pointerBlankDelay:> I<number>	1007	=item B<pointerBlankDelay:> I<number>
960		1008
961	Specifies number of seconds before blanking the pointer [default 2]. Use a	1009	Specifies number of seconds before blanking the pointer [default 2]. Use a
962	large number (e.g. C<987654321>) to effectively disable the timeout.	1010	large number (e.g. C<987654321>) to effectively disable the timeout.
963		1011
964	=item B<backspacekey:> I<string>	1012	=item B<backspacekey:> I<string>
965		1013
966	The string to send when the backspace key is pressed. If set to B<DEC>	1014	The string to send when the backspace key is pressed. If set to B<DEC>
967	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1015	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
968	(code 8) - which can be reversed with the appropriate DEC private mode	1016	(code 8) - which can be reversed with the appropriate DEC private mode
969	escape sequence.	1017	escape sequence.
970		1018
971	=item B<deletekey:> I<string>	1019	=item B<deletekey:> I<string>
972		1020
…		…
985	will be created). In this mode, characters outside ISO-8859-1 can be used.	1033	will be created). In this mode, characters outside ISO-8859-1 can be used.
986		1034
987	When the selection extension is not used, only ISO-8859-1 characters can	1035	When the selection extension is not used, only ISO-8859-1 characters can
988	be used. If not specified, the built-in default is used:	1036	be used. If not specified, the built-in default is used:
989		1037
990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1038	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
991		1039
992	=item B<preeditType:> I<style>	1040	=item B<preeditType:> I<style>
993		1041
994	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1042	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995		1043
996	=item B<inputMethod:> I<name>	1044	=item B<inputMethod:> I<name>
997		1045
998	I<name> of inputMethod to use; option B<-im>.	1046	I<name> of inputMethod to use; option B<-im>.
999		1047
…		…
1017		1065
1018	Change the meaning of triple-click selection with the left mouse	1066	Change the meaning of triple-click selection with the left mouse
1019	button. Instead of selecting a full line it will extend the selection to	1067	button. Instead of selecting a full line it will extend the selection to
1020	the end of the logical line only; option B<-tcw>.	1068	the end of the logical line only; option B<-tcw>.
1021		1069
		1070	=item B<disablePasteBrackets:> I<boolean>
		1071
		1072	Prevent emission of paste bracket sequences; option B<-dpb>.
		1073
1022	=item B<insecure:> I<boolean>	1074	=item B<insecure:> I<boolean>
1023		1075
1024	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1076	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1025	echo arbitrary strings like the icon name or the locale. This could be	1077	echo arbitrary strings like the icon name or the locale. This could be
1026	abused if somebody gets 8-bit-clean access to your display, whether	1078	abused if somebody gets 8-bit-clean access to your display, whether
1027	through a mail client displaying mail bodies unfiltered or through	1079	through a mail client displaying mail bodies unfiltered or through
1028	write(1) or any other means. Therefore, these sequences are disabled by	1080	write(1) or any other means. Therefore, these sequences are disabled by
1029	default. (Note that many other terminals, including xterm, have these	1081	default. (Note that many other terminals, including xterm, have these
…		…
1047		1099
1048	=item B<secondaryScreen:> I<boolean>	1100	=item B<secondaryScreen:> I<boolean>
1049		1101
1050	Turn on/off secondary screen (default enabled).	1102	Turn on/off secondary screen (default enabled).
1051		1103
		1104	=item B<rewrapMode:> I<mode>
		1105
		1106	Sets long line rewrap behaviour on window resize to one of B<auto>
		1107	(default), B<always> or B<never>.
		1108
1052	=item B<secondaryScroll:> I<boolean>	1109	=item B<secondaryScroll:> I<boolean>
1053		1110
1054	Turn on/off secondary screen scroll (default enabled). If this	1111	Turn on/off secondary screen scroll (default enabled). If this
1055	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
1056	scrollback buffer and switching to/from the secondary screen will	1113	scrollback buffer and, when secondaryScreen is off, switching
1057	instead scroll the screen up.	1114	to/from the secondary screen will instead scroll the screen up.
1058		1115
1059	=item B<hold>: I<boolean>	1116	=item B<hold>: I<boolean>
1060		1117
1061	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1118	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1062	will not immediately destroy its window when the program executed within	1119	will not immediately destroy its window when the program executed within
1063	it exits. Instead, it will wait till it is being killed or closed by the	1120	it exits. Instead, it will wait till it is being killed or closed by the
1064	user.	1121	user.
1065		1122
		1123	=item B<chdir>: I<path>
		1124
		1125	Sets the working directory for the shell (or the command specified via
		1126	B<-e>). The I<path> must be an absolute path and it must exist for
		1127	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1128	directory will be used; option B<-cd>.
		1129
1066	=item B<keysym.>I<sym>: I<string>	1130	=item B<keysym.>I<sym>: I<action>
1067		1131
1068	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1132	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1069	intervening resource name B<keysym.> cannot be omitted.	1133	resource name B<keysym.> cannot be omitted.
1070		1134
1071	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1135	Using this resource, you can map key combinations such as
1072	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1136	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1073	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1137	string than would normally result from that combination, making the
1074	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1138	terminal scroll up or down the way you want it, or any other thing an
1075	B<2>, B<3>, B<4>, B<5>.	1139	extension might provide.
		1140
		1141	The key combination that triggers the action, I<sym>, has the following format:
		1142
		1143	(modifiers-)key
		1144
		1145	Where I<modifiers> can be any combination of the following full or
		1146	abbreviated modifier names:
		1147
		1148	=begin table
		1149
		1150	B<ISOLevel3> B<I>
		1151	B<AppKeypad> B<K>
		1152	B<Control> B<C>
		1153	B<NumLock> B<N>
		1154	B<Shift> B<S>
		1155	B<Meta> B<M> I<or> B<A>
		1156	B<Lock> B<L>
		1157	B<Mod1> B<1>
		1158	B<Mod2> B<2>
		1159	B<Mod3> B<3>
		1160	B<Mod4> B<4>
		1161	B<Mod5> B<5>
		1162
		1163	=end table
1076		1164
1077	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1165	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1078	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1166	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1079	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1167	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1080	current application keymap mode state.	1168	current application keymap mode state.
1081		1169
1082	The spellings of I<key> can be obtained by using B<xev>(1) command or	1170	Due the the large number of modifier combinations, a key mapping will
1083	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1171	match if I<at least> the specified identifiers are being set, and no other
		1172	key mappings with those and more bits are being defined. That means that
		1173	defining a mapping for C<a> will automatically provide definitions for
		1174	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1175	themselves. See the C<builtin:> action, below, for a way to work around
		1176	this when this is a problem.
		1177
		1178	The spelling of I<key> depends on your implementation of X. An easy way to
		1179	find a key name is to use the B<xev>(1) command. You can find a list by
		1180	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1084	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1181	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1085	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1182	value (B<0x0000 - 0xFFFF>).
1086	performed in an exact manner; however, the closest match is assured.
1087		1183
1088	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1184	As with any resource value, the I<action> string may contain backslash
		1185	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1089	number), see RESOURCES in C<man 7 X> for futher details.	1186	number), see RESOURCES in C<man 7 X> for further details.
1090		1187
1091	You can define a range of keysyms in one shot by providing a I<string>	1188	An action starts with an action prefix that selects a certain type
1092	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1189	of action, followed by a colon. An action string without colons is
		1190	interpreted as a literal string to pass to the tty (as if it was
		1191	prefixed with C<string:>).
		1192
		1193	The following action prefixes are known - extensions can provide
		1194	additional prefixes:
		1195
		1196	=over
		1197
		1198	=item string:STRING
		1199
		1200	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1201	then the remaining C<STRING> will be passed to the program running in the
		1202	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1203	string C<echo rm -rf /> followed by a newline:
		1204
		1205	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1206
		1207	This could in theory be used to completely redefine your keymap.
		1208
		1209	In addition, for actions of this type, you can define a range of
		1210	keysyms in one shot by loading the C<keysym-list> perl extension and
		1211	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1093	should be a character not used by the strings.	1212	the delimiter `/' should be a character not used by the strings.
1094		1213
1095	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1096		1215
1097	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1098		1217
1099	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1100		1219
1101	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1102	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1103	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1104		1223
		1224	=item command:STRING
		1225
1105	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1226	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1106	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1227	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1228	the opposite of C<string:> - instead of sending it to the program running
		1229	in the terminal, it will be treated as if it were program output). This is
		1230	most useful to feed command sequences into @@RXVT_NAME@@.
		1231
1107	example the following means "change the current locale to C<zh_CN.GBK>	1232	For example the following means "change the current locale to C<zh_CN.GBK>
1108	when Control-Meta-c is being pressed":	1233	when Control-Meta-c is being pressed":
1109		1234
1110	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1235	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1111		1236
1112	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1237	The following example will map Control-Meta-1 and Control-Meta-2 to
1113	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1238	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1114	manpage. For example, the F<selection> extension (activated via	1239	font-switching at runtime:
1115	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1116		1240
1117	URxvt.keysym.M-C-c: perl:selection:rot13	1241	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1242	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1118		1243
1119	Due the the large number of modifier combinations, a defined key mapping	1244	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1120	will match if at I<at least> the specified identifiers are being set, and	1245	info):
1121	no other key mappings with those and more bits are being defined. That
1122	means that defining a key map for C<a> will automatically provide
1123	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1124	mappings themselves.
1125		1246
1126	Unfortunately, this will override built-in key mappings. For example	1247	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1248	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1249
		1250	=item builtin:
		1251
		1252	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1253	key binding existed for the key combination. The obvious use is to undo
		1254	the effect of existing bindings. The not so obvious use is to reinstate
		1255	bindings when another binding overrides too many modifiers.
		1256
1127	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1257	For example if you overwrite the C<Insert> key you will disable
1128	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1258	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1129	user-defined keymap using the C<builtin:> replacement:	1259	"holes" into the user-defined keymap using the C<builtin:> replacement:
1130		1260
1131	URxvt.keysym.Insert: <my insert key sequence>	1261	URxvt.keysym.Insert: <my insert key sequence>
1132	URxvt.keysym.S-Insert: builtin:	1262	URxvt.keysym.S-Insert: builtin:
1133		1263
1134	The first line defines a mapping for C<Insert> and I<any> combination	1264	The first line defines a mapping for C<Insert> and I<any> combination
1135	of modifiers. The second line re-establishes the default mapping for	1265	of modifiers. The second line re-establishes the default mapping for
1136	C<Shift-Insert>.	1266	C<Shift-Insert>.
1137		1267
1138	The following example will map Control-Meta-1 and Control-Meta-2 to	1268	=item builtin-string:
1139	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1140	font-switching at runtime:
1141		1269
1142	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1270	This action is mainly useful to restore string mappings for keys that
1143	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1271	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1272	difficult to explain - basically, this action will send the string to the
		1273	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1274	action for it.
1144		1275
1145	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1276	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1146	info):	1277	selection when you press C<Shift-Insert>. With the following bindings, it
		1278	would instead emit the (undocumented, but what applications running in the
		1279	terminal might expect) sequence C<ESC [ 2 $> instead:
1147		1280
1148	URxvt.keysym.M-C-3: command:\033[8;25;80t	1281	URxvt.keysym.S-Insert: builtin-string:
1149	URxvt.keysym.M-C-4: command:\033[8;48;110t	1282	URxvt.keysym.C-S-Insert: builtin:
		1283
		1284	The first line disables the paste functionality for that key
		1285	combination, and the second reinstates the default behaviour for
		1286	C<Control-Shift-Insert>, which would otherwise be overridden.
		1287
		1288	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1289	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1290	this:
		1291
		1292	URxvt.keysym.C-M-c: builtin-string:
		1293	URxvt.keysym.C-M-v: builtin-string:
		1294
		1295	=item EXTENSION:STRING
		1296
		1297	An action of this form invokes the action B<STRING>, if any, provided
		1298	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1299	be loaded automatically if necessary.
		1300
		1301	Not all extensions define actions, but popular extensions that do
		1302	include the I<selection> and I<matcher> extensions (documented in their
		1303	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1304	respectively).
		1305
		1306	From the silly examples department, this will rot13-"encrypt"
		1307	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1308	keyboards:
		1309
		1310	URxvt.keysym.M-C-c: selection:rot13
		1311
		1312	=item perl:STRING DEPRECATED
		1313
		1314	This is a deprecated way of invoking commands provided by perl
		1315	extensions. It is still supported, but should not be used anymore.
		1316
		1317	=back
1150		1318
1151	=item B<perl-ext-common>: I<string>	1319	=item B<perl-ext-common>: I<string>
1152		1320
1153	=item B<perl-ext>: I<string>	1321	=item B<perl-ext>: I<string>
1154		1322
1155	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1323	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1156	use in this terminal instance; option B<-pe>.	1324	use in this terminal instance; option B<-pe>.
1157		1325
1158	Extension names can be prefixed with a C<-> sign to prohibit using	1326	Extension names can be prefixed with a C<-> sign to remove them again, in
1159	them. This can be useful to selectively disable some extensions loaded	1327	case they had been specified earlier. This can be useful to selectively
1160	by default, or specified via the C<perl-ext-common> resource. For	1328	disable some extensions loaded by default, or specified via the
1161	example, C<default,-selection> will use all the default extension except	1329	C<perl-ext-common> resource. For example, C<default,-selection> will use
1162	C<selection>.	1330	all the default extensions except C<selection>.
1163		1331
1164	Extension names can also be followed by an argument in angle brackets	1332	To prohibit autoloading of extensions, you can prefix them with C</>,
1165	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1333	which will make urxvt refuse to automatically load them (this can be
1166	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1334	overridden, however, by specifying the extension name again without a
1167	multiple times with different arguments will pass multiple arguments to	1335	prefix, though). This does not prohibit extensions themselves loading
1168	the extension.	1336	other extensions. For example, C<default,/background> will keep the
		1337	C<background> extension from being loaded when a background OSC sequence
		1338	is received.
		1339
		1340	The default set includes the C<selection>, C<option-popup>,
		1341	C<selection-popup>, C<readline>, C<searchable-scrollback> and
		1342	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1343	in B<keysym> resources.
		1344
		1345	Any extension such that a corresponding resource is given on the
		1346	command line is automatically appended to B<perl-ext>.
1169		1347
1170	Each extension is looked up in the library directories, loaded if	1348	Each extension is looked up in the library directories, loaded if
1171	necessary, and bound to the current terminal instance.	1349	necessary, and bound to the current terminal instance. When the library
		1350	search path contains multiple extension files of the same name, then the
		1351	first one found will be used.
1172		1352
1173	If both of these resources are the empty string, then the perl	1353	If both of these resources are the empty string, then the perl interpreter
1174	interpreter will not be initialized. The idea behind two options is that	1354	will not be initialized. The rationale for having two options is that
1175	B<perl-ext-common> will be used for extensions that should be available to	1355	B<perl-ext-common> will be used for extensions that should be available to
1176	all instances, while B<perl-ext> is used for specific instances.	1356	all instances, while B<perl-ext> is used for specific instances.
1177		1357
1178	=item B<perl-eval>: I<string>	1358	=item B<perl-eval>: I<string>
1179		1359
1180	Perl code to be evaluated when all extensions have been registered. See	1360	Perl code to be evaluated when all extensions have been registered. See
1181	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1361	the @@RXVT_NAME@@perl(3) manpage.
1182	will be ignored when running setuid/setgid.
1183		1362
1184	=item B<perl-lib>: I<path>	1363	=item B<perl-lib>: I<path>
1185		1364
1186	Colon-separated list of additional directories that hold extension	1365	Colon-separated list of additional directories that hold extension
1187	scripts. When looking for extensions specified by the C<perl> resource,	1366	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1188	@@RXVT_NAME@@ will first look in these directories and then in	1367	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1189	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1368	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1190	will be ignored when running setuid/setgid.
1191		1369
1192	See the @@RXVT_NAME@@perl(3) manpage.	1370	See the @@RXVT_NAME@@perl(3) manpage.
1193		1371
1194	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1372	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1195		1373
…		…
1199	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1377	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1200		1378
1201	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1379	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1202	for details.	1380	for details.
1203		1381
1204	=item B<searchable-scrollback:> I<keysym>	1382	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1205		1383
1206	Sets the hotkey that starts the incremental scrollback buffer search	1384	This resource is deprecated and will be removed. Use a B<keysym> resource
1207	(default: C<M-s>).	1385	instead, e.g.:
1208		1386
		1387	URxvt.keysym.M-s: searchable-scrollback:start
		1388
1209	=item B<urlLauncher>: I<string>	1389	=item B<url-launcher>: I<string>
1210		1390
1211	Specifies the program to be started with a URL argument. Used by the	1391	Specifies the program to be started with a URL argument. Used by the
1212	C<selection-popup> and C<matcher> perl extensions.	1392	C<selection-popup> and C<matcher> perl extensions.
1213		1393
1214	=item B<transient-for>: I<windowid>	1394	=item B<transient-for>: I<windowid>
…		…
1217		1397
1218	=item B<override-redirect>: I<boolean>	1398	=item B<override-redirect>: I<boolean>
1219		1399
1220	Compile I<frills>: Sets override-redirect for the terminal window, making	1400	Compile I<frills>: Sets override-redirect for the terminal window, making
1221	it almost invisible to window managers; option B<-override-redirect>.	1401	it almost invisible to window managers; option B<-override-redirect>.
		1402
		1403	=item B<iso14755:> I<boolean>
		1404
		1405	Turn on/off ISO 14755 (default enabled).
1222		1406
1223	=item B<iso14755_52:> I<boolean>	1407	=item B<iso14755_52:> I<boolean>
1224		1408
1225	Turn on/off ISO 14755 5.2 mode (default enabled).	1409	Turn on/off ISO 14755 5.2 mode (default enabled).
1226		1410
…		…
1254	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1438	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1255		1439
1256	The behaviour of text selection and insertion/pasting mechanism is similar	1440	The behaviour of text selection and insertion/pasting mechanism is similar
1257	to I<xterm>(1).	1441	to I<xterm>(1).
1258		1442
1259	=over 4	1443	=over
1260		1444
1261	=item B<Selecting>:	1445	=item B<Selecting>:
1262		1446
1263	Left click at the beginning of the region, drag to the end of the region	1447	Left click at the beginning of the region, drag to the end of the region
1264	and release; Right click to extend the marked region; Left double-click	1448	and release; Right click to extend the marked region; Left double-click
…		…
1279	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1463	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1280		1464
1281	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1465	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1282	inserted too.	1466	inserted too.
1283		1467
		1468	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1469	B<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1470	binding causes the value of the internal selection to be copied to the
		1471	CLIPBOARD selection, while the second binding causes the value of the
		1472	CLIPBOARD selection to be inserted.
		1473
1284	=back	1474	=back
1285		1475
1286	=head1 CHANGING FONTS	1476	=head1 CHANGING FONTS
1287		1477
1288	Changing fonts (or font sizes, respectively) via the keypad is not yet	1478	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1305	and character codes using the keyboard. It consists of 4 parts. The	1495	and character codes using the keyboard. It consists of 4 parts. The
1306	first part is available if rxvt-unicode has been compiled with	1496	first part is available if rxvt-unicode has been compiled with
1307	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1497	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1308	with C<--enable-iso14755>.	1498	with C<--enable-iso14755>.
1309		1499
1310	=over 4	1500	=over
1311		1501
1312	=item * 5.1: Basic method	1502	=item * 5.1: Basic method
1313		1503
1314	This allows you to enter unicode characters using their hexcode.	1504	This allows you to enter unicode characters using their hexcode.
1315		1505
…		…
1369	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1559	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1370	it can be seen via the I<who(1)> command, and can accept messages. To	1560	it can be seen via the I<who(1)> command, and can accept messages. To
1371	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1561	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1372	on some systems or setgid to root or to some other group on others.	1562	on some systems or setgid to root or to some other group on others.
1373		1563
1374	=head1 COLORS AND GRAPHICS	1564	=head1 COLOURS AND GRAPHICS
1375		1565
1376	In addition to the default foreground and background colours,	1566	In addition to the default foreground and background colours,
1377	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1567	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1378	high-intensity bold/blink versions of the same). Here is a list of the	1568	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1379	colours with their names.	1569	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1570	cube plus a 8 (24) colour greyscale ramp.
		1571
		1572	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1573	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1574	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1575	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1576	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1577	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1578	use many similar 24-bit colours. It's typically not a problem in common
		1579	scenarios.
		1580
		1581	Here is a list of the ANSI colours with their names.
1380		1582
1381	=begin table	1583	=begin table
1382		1584
1383	B<color0> (black) = Black	1585	B<color0> (black) = Black
1384	B<color1> (red) = Red3	1586	B<color1> (red) = Red3
…		…
1404	It is also possible to specify the colour values of B<foreground>,	1606	It is also possible to specify the colour values of B<foreground>,
1405	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1607	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1406	a number 0-15, as a convenient shorthand to reference the colour name of	1608	a number 0-15, as a convenient shorthand to reference the colour name of
1407	color0-color15.	1609	color0-color15.
1408		1610
1409	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1611	The following text gives values for the standard 88 colour mode (and
1410	additional 72 colours. The first 64 of those (with indices 16 to 79)	1612	values for the 256 colour mode in parentheses).
1411	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1412	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1413		1613
		1614	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1615
		1616	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1617	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1618
		1619	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1620	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1621	the RGB cube.
		1622
1414	Together, all those colours implement the 88 colour xterm colours. Only	1623	Together, all those colours implement the 88 (256) colour xterm
1415	the first 16 can be changed using resources currently, the rest can only	1624	colours. Only the first 16 can be changed using resources currently, the
1416	be changed via command sequences ("escape codes").	1625	rest can only be changed via command sequences ("escape codes").
		1626
		1627	Applications are advised to use terminfo or command sequences to discover
		1628	number and RGB values of all colours (yes, you can query this...).
1417		1629
1418	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1630	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1419	always swapping the foreground/background colours. This is in contrast to	1631	always swapping the foreground/background colours. This is in contrast to
1420	I<xterm>(1) where the colours are only swapped if they have not otherwise	1632	I<xterm>(1) where the colours are only swapped if they have not otherwise
1421	been specified. For example,	1633	been specified. For example,
1422		1634
1423	=over 4
1424
1425	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1635	@@RXVT_NAME@@ -fg Black -bg White -rv
1426		1636
1427	would yield White on Black, while on I<xterm>(1) it would yield Black	1637	would yield White on Black, while on I<xterm>(1) it would yield Black on
1428	on White.	1638	White.
1429
1430	=back
1431		1639
1432	=head2 ALPHA CHANNEL SUPPORT	1640	=head2 ALPHA CHANNEL SUPPORT
1433		1641
1434	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1642	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1435	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1643	their act together, rxvt-unicode will do its own alpha channel management:
1436	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1644
1437	in addition to the ones provided by X, where the additional A component	1645	You can prefix any colour with an opaqueness percentage enclosed in
		1646	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1647	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1648	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1649	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1650	is the recommended format to specify transparency values, and works with
		1651	all ways to specify a colour.
		1652
		1653	For complete control, rxvt-unicode also supports
		1654	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1655	specifications, where the additional C<aaaa> component specifies opacity
1438	specifies opacity (alpha) values. The minimum value of C<0> is completely	1656	(alpha) values. The minimum value of C<0000> is completely transparent,
1439	transparent). You can also prefix any color with C<[percent]>, where	1657	while C<ffff> is completely opaque). The two example colours from
1440	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1658	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1441	the color, where C<0> is completely transparent and C<100> is completelxy	1659	C<rgba:0000/ff00/0000/f332>.
1442	opaque.
1443		1660
1444	You probably need to specify B<"-depth 32">, too, and have the luck that	1661	You probably need to specify B<"-depth 32">, too, to force a visual with
1445	your X-server uses ARGB pixel layout, as X is far from just supporting	1662	alpha channels, and have the luck that your X-server uses ARGB pixel
1446	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1663	layout, as X is far from just supporting ARGB visuals out of the box, and
		1664	rxvt-unicode just fudges around.
1447		1665
1448	For example, the following selects an almost completely transparent red	1666	For example, the following selects an almost completely transparent black
1449	background, and an almost opaque pink foreground:	1667	background, and an almost opaque pink foreground:
1450		1668
1451	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1669	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1452		1670
1453	I<Please note that transparency of any kind if completely unsupported by	1671	When not using a background image, then the interpretation of the
1454	the author. Don't bug him with installation questions!>	1672	alpha channel is up to your compositing manager (most interpret it as
		1673	transparency of course).
		1674
		1675	When using a background pixmap or pseudo-transparency, then the background
		1676	colour will always behave as if it were completely transparent (so the
		1677	background image shows instead), regardless of how it was specified, while
		1678	other colours will either be transparent as specified (the background
		1679	image will show through) on servers supporting the RENDER extension, or
		1680	fully opaque on servers not supporting the RENDER EXTENSION.
		1681
		1682	Please note that due to bugs in Xft, specifying alpha values might result
		1683	in garbage being displayed when the X-server does not support the RENDER
		1684	extension.
1455		1685
1456	=head1 ENVIRONMENT	1686	=head1 ENVIRONMENT
1457		1687
1458	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1688	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1459		1689
1460	=over 4	1690	=over
1461		1691
1462	=item B<TERM>	1692	=item B<TERM>
1463		1693
1464	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1694	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1465	resources or on the command line.	1695	resources or on the command line.
1466		1696
1467	=item B<COLORTERM>	1697	=item B<COLORTERM>
1468		1698
1469	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1699	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1470	compiled with background image support, and optionally with the added	1700	compiled with background image support, and optionally with the added
1471	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1701	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472	screen.	1702	screen.
1473		1703
1474	=item B<COLORFGBG>	1704	=item B<COLORFGBG>
1475		1705
1476	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1706	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1477	the colour code used as default foreground/text colour (or the string	1707	the colour code used as default foreground/text colour (or the string
1478	C<default> to indicate that the default-colour escape sequence is to be	1708	C<default> to indicate that the default-colour escape sequence is to be
1479	used), C<bg> is the colour code used as default background colour (or the	1709	used), C<bg> is the colour code used as default background colour (or the
1480	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1710	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1481	was compiled with background image support. Libraries like C<ncurses>	1711	was compiled with background image support. Libraries like C<ncurses>
1482	and C<slang> can (and do) use this information to optimize screen output.	1712	and C<slang> can (and do) use this information to optimize screen output.
1483		1713
1484	=item B<WINDOWID>	1714	=item B<WINDOWID>
1485		1715
1486	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1716	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1493	C<--with-terminfo=PATH>.	1723	C<--with-terminfo=PATH>.
1494		1724
1495	=item B<DISPLAY>	1725	=item B<DISPLAY>
1496		1726
1497	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1727	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1498	display in its child processes.	1728	display in its child processes if C<-display> isn't used to override. It
		1729	defaults to C<:0> if it doesn't exist.
1499		1730
1500	=item B<SHELL>	1731	=item B<SHELL>
1501		1732
1502	The shell to be used for command execution, defaults to C</bin/sh>.	1733	The shell to be used for command execution, defaults to C</bin/sh>.
1503		1734
1504	=item B<RXVT_SOCKET>	1735	=item B<RXVT_SOCKET> [I<sic>]
1505		1736
1506	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1737	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1507	@@RXVT_NAME@@d(1).	1738	@@RXVT_NAME@@d(1).
1508		1739
1509	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1740	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1741
		1742	=item B<URXVT_PERL_LIB>
		1743
		1744	Additional F<:>-separated library search path for perl extensions. Will be
		1745	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1746	directory.
		1747
		1748	=item B<URXVT_PERL_VERBOSITY>
		1749
		1750	See L<@@RXVT_NAME@@perl>(3).
1510		1751
1511	=item B<HOME>	1752	=item B<HOME>
1512		1753
1513	Used to locate the default directory for the unix domain socket for	1754	Used to locate the default directory for the unix domain socket for
1514	daemon communications and to locate various resource files (such as	1755	daemon communications and to locate various resource files (such as
1515	C<.Xdefaults>)	1756	C<.Xdefaults>)
1516		1757
1517	=item B<XAPPLRESDIR>	1758	=item B<XAPPLRESDIR>
1518		1759
1519	Directory where various X resource files are being located.	1760	Directory where application-specific X resource files are located.
1520		1761
1521	=item B<XENVIRONMENT>	1762	=item B<XENVIRONMENT>
1522		1763
1523	If set and accessible, gives the name of a X resource file to be loaded by	1764	If set and accessible, gives the name of a X resource file to be loaded by
1524	@@RXVT_NAME@@.	1765	@@RXVT_NAME@@.
1525		1766
1526	=back	1767	=back
1527		1768
1528	=head1 FILES	1769	=head1 FILES
1529		1770
1530	=over 4	1771	=over
1531		1772
1532	=item B</usr/lib/X11/rgb.txt>	1773	=item B</usr/lib/X11/rgb.txt>
1533		1774
1534	Color names.	1775	Colour names.
1535		1776
1536	=back	1777	=back
1537		1778
1538	=head1 SEE ALSO	1779	=head1 SEE ALSO
1539		1780
		1781	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1540	@@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)	1782	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1541		1783
1542	=head1 CURRENT PROJECT COORDINATOR	1784	=head1 CURRENT PROJECT COORDINATOR
1543		1785
1544	=over 4	1786	=over
1545		1787
1546	=item Project Coordinator	1788	=item Project Coordinator
1547		1789
1548	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1790	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1549		1791
1550	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1792	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1551		1793
1552	=back	1794	=back
1553		1795
1554	=head1 AUTHORS	1796	=head1 AUTHORS
1555		1797
1556	=over 4	1798	=over
1557		1799
1558	=item John Bovey	1800	=item John Bovey
1559		1801
1560	University of Kent, 1992, wrote the original Xvt.	1802	University of Kent, 1992, wrote the original Xvt.
1561		1803
1562	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1804	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1563		1805
1564	very heavily modified Xvt and came up with Rxvt	1806	very heavily modified Xvt and came up with Rxvt
1565		1807
1566	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1808	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1567		1809
1568	wrote the Greek Keyboard Input (no longer in code)	1810	wrote the Greek Keyboard Input (no longer in code)
1569		1811
1570	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1812	=item mj olesen <olesen@me.QueensU.CA>
1571		1813
1572	Wrote the menu system.	1814	Wrote the menu system.
1573		1815
1574	Project Coordinator (changes.txt 2.11 to 2.21)	1816	Project Coordinator (changes.txt 2.11 to 2.21)
1575		1817
1576	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1818	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1577		1819
1578	Project Coordinator (changes.txt 2.21a to 2.4.5)	1820	Project Coordinator (changes.txt 2.21a to 2.4.5)
1579		1821
1580	=item Geoff Wing L<< <gcw@pobox.com> >>	1822	=item Geoff Wing <gcw@pobox.com>
1581		1823
1582	Rewrote screen display and text selection routines.	1824	Rewrote screen display and text selection routines.
1583		1825
1584	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1826	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1585		1827
1586	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1828	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1587		1829
1588	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1830	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1589	extension, random hacks, numerous bugfixes and extensions.	1831	extension, random hacks, numerous bugfixes and extensions.
1590		1832
1591	Project Coordinator (Changes 1.0 -)	1833	Project Coordinator (Changes 1.0 -)
1592		1834
1593	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1835	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1594		1836
1595	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1837	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1596		1838
1597	=back	1839	=back
1598		1840

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs. Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC