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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs. Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC